[Password manager tests] Provide default config values

components/test/data/password_manager/automated_tests/run_tests.py

 # -*- coding: utf-8 -*-
 # Copyright 2014 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.
 
 """This file allows the bots to be easily configure and run the tests.

[engedy, 2015/03/04 13:20:30]

nit: configured

[vabr (Chromium), 2015/03/04 13:25:34]

Done.

 
 Running this script requires passing --config-path with a path to a config file
 of the following structure:

[engedy, 2015/03/04 13:20:31]

nit: Add newline here.

[vabr (Chromium), 2015/03/04 13:25:34]

Done.

   [data_files]
   passwords_path=<path to a file with passwords>
   [binaries]
   chrome-path=<chrome binary path>
   chromedriver-path=<chrome driver path>
   [run_options]
+  # |write_to_sheet| is optional, the default value is false.
   write_to_sheet=[false|true]
-  tests_in_parrallel=<number of parallel tests>
+  # |tests_in_parallel| is optional, the default value is 1.
+  tests_in_parallel=<number of parallel tests>
   # |tests_to_runs| field is optional, if it is absent all tests will be run.
   tests_to_run=<test names to run, comma delimited>
   [output]
+  # |save-path| is optional, the default value is /dev/null.
   save-path=<file where to save result>
   [sheet_info]
   # This section is required only when write_to_sheet=true
   pkey=full_path
   client_email=email_assigned_by_google_dev_console
   sheet_key=sheet_key_from_sheet_url
 """
 from datetime import datetime
 import ConfigParser
 import sys
@@ skipping 139 matching lines @@
     except Exception:
       pass
     try:
       shutil.rmtree(self.profile_path)
     except Exception:
       pass
     self.max_test_runs_left -= 1
     print "Run of test %s started" % self.test_name
     self.runner_process = subprocess.Popen(self.test_cmd)
 
+def _apply_defaults(config, defaults):
+  """Adds default values from |defaults| to |config|.
+
+  Note: This differs from ConfigParser's mechanism for providing defaults in
+  two points:

[engedy, 2015/03/04 13:20:31]

nit: s/points/aspects/

[vabr (Chromium), 2015/03/04 13:25:34]

Done.

+    * The "defaults" here become explicit, and are associated with sections.
+    * Sections get created for the added defaults where needed, they need not

[engedy, 2015/03/04 13:20:31]

nit: ..., that is, if

[vabr (Chromium), 2015/03/04 13:25:34]

Done.

+      exist before.
+
+  Args:
+    config: A ConfigParser instance to be updated
+    defaults: A dictionary with keys (section_string, option_string) and

[engedy, 2015/03/04 13:20:30]

Phrasing suggestion: A dictionary mapping (section_string, option_string) pairs
to string values...

[vabr (Chromium), 2015/03/04 13:25:34]

Done.

+      string values. For every section/option combination not already
+      contained in |config|, the value from |defaults| is stored in |config|.
+  """
+  for (section, option) in defaults:
+    if not config.has_section(section):
+      config.add_section(section)
+    if not config.has_option(section, option):
+      config.set(section, option, defaults[(section, option)])
+
 def run_tests(config_path):
   """ Runs automated tests. """
   environment = Environment("", "", "", None, False)
   tests.Tests(environment)
+  defaults = { ("output", "save-path"): "/dev/null",
+               ("run_options", "tests_in_parallel"): "1",
+               ("run_options", "write_to_sheet"): "false" }
   config = ConfigParser.ConfigParser()
+  _apply_defaults(config, defaults)
   config.read(config_path)
   date = datetime.now().strftime('%Y-%m-%dT%H:%M:%S')
-  max_tests_in_parrallel = config.getint("run_options", "tests_in_parrallel")
+  max_tests_in_parallel = config.getint("run_options", "tests_in_parallel")
   sheet_writer = SheetWriter(config)
   full_path = os.path.realpath(__file__)
   tests_dir = os.path.dirname(full_path)
   tests_path = os.path.join(tests_dir, "tests.py")
   general_test_cmd =  ["python", tests_path, "test_name_placeholder",
      "--chrome-path", config.get("binaries", "chrome-path"),
      "--chromedriver-path", config.get("binaries", "chromedriver-path"),
      "--passwords-path", config.get("data_files", "passwords_path")]
   runners = []
   tests_to_run = [test.name for test in environment.websitetests]
   if config.has_option("run_options", "tests_to_run"):
     user_selected_tests = config.get("run_options", "tests_to_run").split(',')
     # TODO((dvadym) Validate the user selected tests are available.
     tests_to_run = list(set(tests_to_run) & set(user_selected_tests))
 
   with open(config.get("output", "save-path"), 'w') as savefile:
     print "Tests to run %d\nTests: %s" % (len(tests_to_run), tests_to_run)
     while len(runners) + len(tests_to_run) > 0:
       i = 0
       while i < len(runners):
         result = runners[i].get_test_result()
         if result:  # This test run is finished.
           status, log = result
           testinfo = [runners[i].test_name, status, date, " | ".join(log)]
           sheet_writer.write_line_to_sheet(testinfo)
           print>>savefile, " ".join(testinfo)
           del runners[i]
         else:
           i += 1
-      while len(runners) < max_tests_in_parrallel and len(tests_to_run) > 0:
+      while len(runners) < max_tests_in_parallel and len(tests_to_run) > 0:
         runners.append(TestRunner(general_test_cmd, tests_to_run.pop()))
       time.sleep(1)  # Let us wait for worker process to finish.
 
 if __name__ == "__main__":
   if len(sys.argv) != 2:
     print "Synopsis:\n python run_tests.py <config_path>"
   config_path = sys.argv[1]
   run_tests(config_path)