Add --test_filter with * wildcard functionality for classname and

tools/chrome_proxy/webdriver/common.py

 # Copyright 2016 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.
 
 import argparse
 import json
 import logging
 import os
 import re
 import socket
 import shlex
 import sys
 import time
 import traceback
 import unittest
 import urlparse
 
 sys.path.append(os.path.join(os.path.dirname(__file__), os.pardir, os.pardir,
   os.pardir, 'third_party', 'webdriver', 'pylib'))
 from selenium import webdriver
 from selenium.webdriver.chrome.options import Options
 
 def ParseFlags():
   """Parses the given command line arguments.
 
   Returns:
     A new Namespace object with class properties for each argument added below.
     See pydoc for argparse.
   """
+  def TestFilter(v):
+    try:
+      # The filtering here allows for any number of * wildcards with a required
+      # . separator between classname and methodname, but no other special
+      # characters.
+      return re.match('^[A-Za-z_0-9\*]+\.[A-Za-z_0-9\*]+$', v).group(0)

[RyanSturm, 2017/01/11 17:42:10]

This should accept TestClass* in addition to TestClass.TestCase*, so maybe
^([A-Za-z_0-9\*]+\.)?[A-Za-z_0-9\*]+$ (writing TestClass*.* is annoying and not
the behavior of gtest_filter)

Alternatively, I'm somewhat confident that gtest_filter has to have an exact
starting match with an optional trailing * (no intermediary *), so a very weak
form of regex. If you want to do that behavior, nobody will complain I believe.

In that case you would want to match ^([A-Za-z_0-9\.]+*?$.

[Robert Ogden, 2017/01/11 19:19:44]

Took the first option. It seems cleaner to me.

+    except:
+      raise argparse.ArgumentTypeError('Test filter "%s" is not a valid filter'
+        % v)
   parser = argparse.ArgumentParser()
   parser.add_argument('--browser_args', type=str, help='Override browser flags '
     'in code with these flags')
   parser.add_argument('--via_header_value',
     default='1.1 Chrome-Compression-Proxy', help='What the via should match to '
     'be considered valid')
   parser.add_argument('--android', help='If given, attempts to run the test on '
     'Android via adb. Ignores usage of --chrome_exec', action='store_true')
   parser.add_argument('--android_package',
     default='com.android.chrome', help='Set the android package for Chrome')
   parser.add_argument('--chrome_exec', type=str, help='The path to '
     'the Chrome or Chromium executable')
   parser.add_argument('chrome_driver', type=str, help='The path to '
     'the ChromeDriver executable. If not given, the default system chrome '
     'will be used.')
   parser.add_argument('--disable_buffer', help='Causes stdout and stderr from '
     'tests to output normally. Otherwise, the standard output and standard '
     'error streams are buffered during the test run, and output from a '
     'passing test is discarded. Output will always be echoed normally on test '
     'fail or error and is added to the failure messages.', action='store_true')
   parser.add_argument('-c', '--catch', help='Control-C during the test run '
     'waits for the current test to end and then reports all the results so '
     'far. A second Control-C raises the normal KeyboardInterrupt exception.',
     action='store_true')
   parser.add_argument('-f', '--failfast', help='Stop the test run on the first '
     'error or failure.', action='store_true')
+  parser.add_argument('--test_filter', '--gtest_filter', type=TestFilter,
+    help='The filter to use when discovering tests to run, in the form '
+    '<class name>.<method name> Wildcards (*) are accepted. Default=*.*',
+    default='*.test*')
   parser.add_argument('--logging_level', choices=['DEBUG', 'INFO', 'WARN',
     'ERROR', 'CRIT'], default='WARN', help='The logging verbosity for log '
     'messages, printed to stderr. To see stderr logging output during a '
     'successful test run, also pass --disable_buffer. Default=ERROR')
   parser.add_argument('--log_file', help='If given, write logging statements '
     'to the given file instead of stderr.')
   return parser.parse_args(sys.argv[1:])
 
 def GetLogger(name='common'):
   """Creates a Logger instance with the given name and returns it.
@@ skipping 467 matching lines @@
     Args:
       run_all_tests: If True, all tests in the directory will be run, Otherwise
         only the tests in the file given on the command line will be run.
     """
     flags = ParseFlags()
     logger = GetLogger()
     logger.debug('Command line args: %s', str(sys.argv))
     logger.info('sys.argv parsed to %s', str(flags))
     if flags.catch:
       unittest.installHandler()
+    # Use python's test discovery to locate tests files that have subclasses of
+    # unittest.TestCase and methods beginning with 'test'.
     pattern = '*.py' if run_all_tests else os.path.basename(sys.argv[0])
     loader = unittest.TestLoader()
-    tests = loader.discover(os.path.dirname(__file__), pattern=pattern)
+    test_suite_iter = loader.discover(os.path.dirname(__file__),
+      pattern=pattern)
+    # Match class and method name on the given test filter from --test_filter.
+    tests = unittest.TestSuite()
+    test_filter_re = flags.test_filter.replace('.', r'\.').replace('*', '.*')

[RyanSturm, 2017/01/11 17:42:10]

See comment above. I think if you do the last approach, this should still work.

[Robert Ogden, 2017/01/11 19:19:44]

Acknowledged.

+    for test_suite in test_suite_iter:
+      for test_case in test_suite:
+        for test in test_case:
+          # Drop the file name in the form <filename>.<classname>.<methodname>
+          test_id = test.id()[test.id().find('.') + 1:]
+          if re.match(test_filter_re, test_id):
+            tests.addTest(test)
     testRunner = unittest.runner.TextTestRunner(verbosity=2,
       failfast=flags.failfast, buffer=(not flags.disable_buffer))
     testRunner.run(tests)