[Password manager tests automation] Refactor test_runner.

components/test/data/password_manager/automated_tests/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.
 
 """Automated tests for many websites"""
 
 import argparse
 
 from environment import Environment
 from websitetest import WebsiteTest
 
 
+TEST_CASES = ("PromptFailTest", "PromptSuccessTest", "SaveAndAutofillTest")
+
+
 class Alexa(WebsiteTest):
 
   def Login(self):
     self.GoTo("https://www.alexa.com/secure/login")
     self.FillUsernameInto("#email")
     self.FillPasswordInto("#pwd")
     self.Submit("#pwd")
 
 class Dropbox(WebsiteTest):
 
@@ skipping 475 matching lines @@
     xml = "<result>"
     for (name, test_type, success, failure_log) in environment_tests_results:
       if not (save_only_fails and success):
         xml += (
             "<test name='{0}' successful='{1}' type='{2}'>{3}</test>".format(
                 name, success, test_type, failure_log))
     xml += "</result>"
     with open(environment_save_path, "w") as save_file:
       save_file.write(xml)
 
+

[melandory, 2015/04/16 08:48:00]

This is intentional: there are two empty lines between functions across this
file.

[vabr (Chromium), 2015/04/16 10:48:16]

Acknowledged.

 def RunTest(chrome_path, chromedriver_path, profile_path,
-            environment_passwords_path, website_test_name, test_case_name):
+            environment_passwords_path, website_test_name,
+            test_case_name):
   """Runs the test for the specified website.
 
   Args:
     chrome_path: The chrome binary file.
     chromedriver_path: The chromedriver binary file.
     profile_path: The chrome testing profile folder.
     environment_passwords_path: The usernames and passwords file.
     website_test_name: Name of the website to test (refer to keys in
         all_tests above).
 
   Returns:
     The results of the test as list of TestResults.
 
   Raises:
     Exception: An exception is raised if one of the tests for the website
         fails, or if the website name is not known.
   """
 
   enable_automatic_password_saving = (test_case_name == "SaveAndAutofillTest")
   environment = Environment(chrome_path, chromedriver_path, profile_path,
                             environment_passwords_path,
                             enable_automatic_password_saving)
+  try:
+    if website_test_name in all_tests:
+      environment.AddWebsiteTest(all_tests[website_test_name])
+    else:
+      raise Exception("Test name {} is unknown.".format(website_test_name))
 
-  if website_test_name in all_tests:
-    environment.AddWebsiteTest(all_tests[website_test_name])
-  else:
-    raise Exception("Test name {} is unknown.".format(website_test_name))
-
-  environment.RunTestsOnSites(test_case_name)
-  environment.Quit()
-  return environment.tests_results
+    environment.RunTestsOnSites(test_case_name)
+    return environment.tests_results
+  finally:
+    environment.Quit()
 
 def main():
   parser = argparse.ArgumentParser(
       description="Password Manager automated tests help.")
 
   parser.add_argument(
       "--chrome-path", action="store", dest="chrome_path",
       help="Set the chrome path (required).", required=True)
   parser.add_argument(
       "--chromedriver-path", action="store", dest="chromedriver_path",
@@ skipping 20 matching lines @@
   parser.add_argument("--test-cases-to-run", help="Names of test cases which"
                       "should be run. Currently supported test cases are:"
                       "PromptFailTest, PromptSuccessTest, SaveAndAutofillTest",
                       dest="test_cases_to_run", action="store", nargs="*")
   args = parser.parse_args()
 
   save_path = None
   if args.save_path:
     save_path = args.save_path
 
-  test_cases_to_run = args.test_cases_to_run or\
-      ("PromptFailTest", "PromptSuccessTest", "SaveAndAutofillTest")
-
+  test_cases_to_run = args.test_cases_to_run or TEST_CASES

[vabr (Chromium), 2015/04/16 10:48:16]

nit: Could you please add a TODO about validating the supplied test case names?
I know you had plans for using the decorators, that's likely worth pointing out
in the TODO.

[melandory, 2015/04/16 14:38:29]

TODO is in this CL:
https://codereview.chromium.org/1084553003/diff/40001/components/test/data/pa...

Current CL depends on it, so I'll land them one after another. Sorry for not
mentioning it.

[vabr (Chromium), 2015/04/16 14:55:43]

Acknowledged. I should have remembered that, thanks for reminding me.

   for test_case in test_cases_to_run:
     tests_results = RunTest(
         args.chrome_path, args.chromedriver_path, args.profile_path,
         args.passwords_path, args.website, test_case)
 
 
   SaveResults(tests_results, save_path, save_only_fails=args.save_only_fails)
 
 if __name__ == "__main__":
   main()