Configuration file for Chrome perf and endure tests.

chrome/test/functional/perf.py

 #!/usr/bin/env python
 # Copyright (c) 2012 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 """Basic pyauto performance tests.
 
 For tests that need to be run for multiple iterations (e.g., so that average
 and standard deviation values can be reported), the default number of iterations
 run for each of these tests is specified by |_DEFAULT_NUM_ITERATIONS|.
@@ skipping 579 matching lines @@
                        self._num_iterations, elapsed_time)
       self.assertTrue(self._timeout_count <= self._max_timeout_count,
                       msg='Test exceeded automation timeout threshold.')
       self.assertEqual(1 + num_tabs, self.GetTabCount(),
                        msg='Did not open %d new tab(s).' % num_tabs)
       for _ in range(num_tabs):
         self.CloseTab(tab_index=1)
 
     self._PrintSummaryResults(description, timings, 'milliseconds', graph_name)
 
+  def _GetConfig(self):

[fdeng1, 2012/08/11 00:11:27]

I just moved the changes to perf.py so that the credential configuration will
work for perf.py. How do you think?

[dennis_jeffrey, 2012/08/15 01:21:17]

Good, now we can let the user change the login credentials for the tests that
need to log into a google account.  This will allow external users to more
easily run the tests.

+    """Load endure configuration file."""

[dennis_jeffrey, 2012/08/15 01:21:17]

'endure' --> 'perf test'

[dennis_jeffrey, 2012/08/15 01:21:17]

Add a "Returns:" section to this docstring to mention that a dictionary is
returned that represents the config information.

[fdeng1, 2012/08/16 17:42:49]

Done.

[fdeng1, 2012/08/16 17:42:49]

Done.

+    config_file = os.path.join(os.path.dirname(__file__), 'perf.cfg')
+    config = {'google_account_url': 'https://accounts.google.com/',
+              'gmail_url': 'https://www.gmail.com',
+              'plus_url': 'http://plus.google.com',
+              'docs_url': 'http://docs.google.com'}
+    if os.path.exists(config_file):
+      try:
+        config.update(pyauto.PyUITest.EvalDataFrom(config_file))

[dennis_jeffrey, 2012/08/15 01:21:17]

If you address my comment from the .cfg file that asks to explicitly put all
config options in the dictionary there, we'll probably have to adjust the
implementation here to handle it.  We need to make sure we use the default
values whenever a config option in the config file has value None.

[fdeng1, 2012/08/16 17:42:49]

Done.

+      except SyntaxError:
+        logging.info('Could not read %s', config_file)

[dennis_jeffrey, 2012/08/15 01:21:17]

maybe you can also log the text that comes along with the SyntaxError too

[fdeng1, 2012/08/16 17:42:49]

Done.

+    return config
+
   def _LoginToGoogleAccount(self, account_key='test_google_account'):
     """Logs in to a test Google account.
 
+    Try to use the url and credential specified in perf.cfg.
+    If it fails to load valid information, try to login via public
+    google account url with credential in
+    src/data/pyauto_private/private_tests_info.txt.

[dennis_jeffrey, 2012/08/15 01:21:17]

We can shorten this description to something like this:

"Login with user-defined credentials if they exist.  Else login with private
test credentials if they exist.  Else fail."

[fdeng1, 2012/08/16 17:42:49]

Done.

+
     Args:
-      account_key: The string key associated with the test account login
-          credentials to use.
+      account_key: The string key in private_tests_info.txt which is associated
+                   with the test account login credentials to use. It will only
+                   be used when fail to load credential from perf.cfg
+
+    Raises:
+      RuntimeError: if could not get credential information.
     """
-    creds = self.GetPrivateInfo()[account_key]
-    test_utils.GoogleAccountsLogin(self, creds['username'], creds['password'])
+    config_file = os.path.join(os.path.dirname(__file__), 'perf.cfg')
+    config = self._GetConfig()
+    google_account_url = config.get('google_account_url')
+    username = config.get('username')
+    password = config.get('password')
+    if not username or not password:
+      private_file = os.path.join(pyauto.PyUITest.DataDir(), 'pyauto_private',
+                                  'private_tests_info.txt')
+      if os.path.exists(private_file):
+        google_account_url = 'https://accounts.google.com/'
+        creds = self.GetPrivateInfo()[account_key]
+        username = creds['username']
+        password = creds['password']
+        logging.info(
+            'Google account credential not defined in %s, using %s',
+            config_file, private_file)
+      else:
+        message = \
+            'Please sepecify credential information in %s.\n' \
+            'Format:\n\t{\n' \
+            '\t "username": "my_username",\n' \
+            '\t "password": "my_password",\n' \
+            '\t "google_account_url": "https://my-google-account-server/",\n' \
+            '\t "gmail_url: "https://my-gmail-server",\n' \
+            '\t "plus_url": "https://my-plus-server",\n' \
+            '\t "docs_url": "https://my-docs-server",\n\t}\n' \
+            % config_file
+        raise RuntimeError('Could not get credential information.\n' + message)
+    else:

[dennis_jeffrey, 2012/08/15 01:21:17]

I think it would be simpler to re-arrange the logic here:

if username and password:
  log a message saying we're using the user-specified credentials
else if the private test info file exists:
  log a message saying we're using the private test credentials
else:
  raise a runtime error

[fdeng1, 2012/08/16 17:42:49]

Done.

+      logging.info(
+          'Using google account credential from %s',
+          os.path.join(os.path.dirname(__file__), 'perf.cfg'))
+    test_utils.GoogleAccountsLogin(
+        self, username, password, url=google_account_url)
     self.NavigateToURL('about:blank')  # Clear the existing tab.
 
   def _GetCPUUsage(self):
     """Returns machine's CPU usage.
 
     This function uses /proc/stat to identify CPU usage, and therefore works
     only on Linux/ChromeOS.
 
     Returns:
       A dictionary with 'user', 'nice', 'system' and 'idle' values.
@@ skipping 1993 matching lines @@
     """Identifies the port number to which the server is currently bound.
 
     Returns:
       The numeric port number to which the server is currently bound.
     """
     return self._server.server_address[1]
 
 
 if __name__ == '__main__':
   pyauto_functional.Main()