unittest_suite.py revision 36f4c1edb43cb273e4327ad77ba69787179f20f2 
1#!/usr/bin/python -u
2
3import os, sys, unittest, optparse
4import common
5from autotest_lib.utils import parallel
6from autotest_lib.client.common_lib.test_utils import unittest as custom_unittest
7
8parser = optparse.OptionParser()
9parser.add_option("-r", action="store", type="string", dest="start",
10                  default='',
11                  help="root directory to start running unittests")
12parser.add_option("--full", action="store_true", dest="full", default=False,
13                  help="whether to run the shortened version of the test")
14parser.add_option("--debug", action="store_true", dest="debug", default=False,
15                  help="run in debug mode")
16parser.add_option("--skip-tests", dest="skip_tests",  default=[],
17                  help="A space separated list of tests to skip")
18
19parser.set_defaults(module_list=None)
20
21# Following sets are used to define a collection of modules that are optional
22# tests and do not need to be executed in unittest suite for various reasons.
23# Each entry can be file name or relative path that's relative to the parent
24# folder of the folder containing this file (unittest_suite.py). The list
25# will be used to filter any test file with matching name or matching full
26# path. If a file's name is too general and has a chance to collide with files
27# in other folder, it is recommended to specify its relative path here, e.g.,
28# using 'mirror/trigger_unittest.py', instead of 'trigger_unittest.py' only.
29
30REQUIRES_DJANGO = set((
31        'monitor_db_unittest.py',
32        'monitor_db_functional_test.py',
33        'monitor_db_cleanup_test.py',
34        'frontend_unittest.py',
35        'csv_encoder_unittest.py',
36        'rpc_interface_unittest.py',
37        'models_test.py',
38        'scheduler_models_unittest.py',
39        'metahost_scheduler_unittest.py',
40        'site_metahost_scheduler_unittest.py',
41        'rpc_utils_unittest.py',
42        'site_rpc_utils_unittest.py',
43        'execution_engine_unittest.py',
44        'service_proxy_lib_test.py',
45        ))
46
47REQUIRES_MYSQLDB = set((
48        'migrate_unittest.py',
49        'db_utils_unittest.py',
50        ))
51
52REQUIRES_GWT = set((
53        'client_compilation_unittest.py',
54        ))
55
56REQUIRES_SIMPLEJSON = set((
57        'resources_test.py',
58        'serviceHandler_unittest.py',
59        ))
60
61REQUIRES_AUTH = set ((
62    'trigger_unittest.py',
63    ))
64
65REQUIRES_HTTPLIB2 = set((
66        ))
67
68REQUIRES_PROTOBUFS = set((
69        'job_serializer_unittest.py',
70        ))
71
72REQUIRES_SELENIUM = set((
73        'ap_configurator_factory_unittest.py',
74        'ap_batch_locker_unittest.py'
75    ))
76
77LONG_RUNTIME = set((
78    'auth_server_unittest.py',
79    'base_barrier_unittest.py',
80    'logging_manager_test.py',
81    'task_loop_unittest.py'  # crbug.com/254030
82    ))
83
84
85SKIP = set((
86    # This particular KVM autotest test is not a unittest
87    'guest_test.py',
88    'ap_configurator_test.py',
89    'chaos_base_test.py',
90    'chaos_interop_test.py',
91    'monitor_db_functional_test.py',
92    # crbug.com/251395
93    'dev_server_test.py',
94    'full_release_test.py',
95    ))
96
97LONG_TESTS = (REQUIRES_MYSQLDB |
98              REQUIRES_GWT |
99              REQUIRES_HTTPLIB2 |
100              REQUIRES_AUTH |
101              REQUIRES_PROTOBUFS |
102              REQUIRES_SELENIUM |
103              LONG_RUNTIME)
104
105ROOT = os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))
106
107# The set of files in LONG_TESTS with its full path
108LONG_TESTS_FULL_PATH = {os.path.join(ROOT, t) for t in LONG_TESTS}
109
110class TestFailure(Exception):
111    """Exception type for any test failure."""
112    pass
113
114
115def run_test(mod_names, options):
116    """
117    @param mod_names: A list of individual parts of the module name to import
118            and run as a test suite.
119    @param options: optparse options.
120    """
121    if not options.debug:
122        parallel.redirect_io()
123
124    print "Running %s" % '.'.join(mod_names)
125    mod = common.setup_modules.import_module(mod_names[-1],
126                                             '.'.join(mod_names[:-1]))
127    for ut_module in [unittest, custom_unittest]:
128        test = ut_module.defaultTestLoader.loadTestsFromModule(mod)
129        suite = ut_module.TestSuite(test)
130        runner = ut_module.TextTestRunner(verbosity=2)
131        result = runner.run(suite)
132        if result.errors or result.failures:
133            msg = '%s had %d failures and %d errors.'
134            msg %= '.'.join(mod_names), len(result.failures), len(result.errors)
135            raise TestFailure(msg)
136
137
138def scan_for_modules(start, options):
139    """Scan folders and find all test modules that are not included in the
140    blacklist (defined in LONG_TESTS).
141
142    @param start: The absolute directory to look for tests under.
143    @param options: optparse options.
144    @return a list of modules to be executed.
145    """
146    modules = []
147
148    skip_tests = SKIP
149    if options.skip_tests:
150        skip_tests.update(options.skip_tests.split())
151    skip_tests_full_path = {os.path.join(ROOT, t) for t in skip_tests}
152
153    for dir_path, sub_dirs, file_names in os.walk(start):
154        # Only look in and below subdirectories that are python modules.
155        if '__init__.py' not in file_names:
156            if options.full:
157                for file_name in file_names:
158                    if file_name.endswith('.pyc'):
159                        os.unlink(os.path.join(dir_path, file_name))
160            # Skip all subdirectories below this one, it is not a module.
161            del sub_dirs[:]
162            if options.debug:
163                print 'Skipping', dir_path
164            continue  # Skip this directory.
165
166        # Look for unittest files.
167        for file_name in file_names:
168            if (file_name.endswith('_unittest.py') or
169                file_name.endswith('_test.py')):
170                file_path = os.path.join(dir_path, file_name)
171                if (not options.full and
172                    (file_name in LONG_TESTS or
173                     file_path in LONG_TESTS_FULL_PATH)):
174                    continue
175                if (file_name in skip_tests or
176                    file_path in skip_tests_full_path):
177                    continue
178                path_no_py = os.path.join(dir_path, file_name).rstrip('.py')
179                assert path_no_py.startswith(ROOT)
180                names = path_no_py[len(ROOT)+1:].split('/')
181                modules.append(['autotest_lib'] + names)
182                if options.debug:
183                    print 'testing', path_no_py
184    return modules
185
186def find_and_run_tests(start, options):
187    """
188    Find and run Python unittest suites below the given directory.  Only look
189    in subdirectories of start that are actual importable Python modules.
190
191    @param start: The absolute directory to look for tests under.
192    @param options: optparse options.
193    """
194    if options.module_list:
195        modules = []
196        for m in options.module_list:
197            modules.append(m.split('.'))
198    else:
199        modules = scan_for_modules(start, options)
200
201    if options.debug:
202        print 'Number of test modules found:', len(modules)
203
204    functions = {}
205    for module_names in modules:
206        # Create a function that'll test a particular module.  module=module
207        # is a hack to force python to evaluate the params now.  We then
208        # rename the function to make error reporting nicer.
209        run_module = lambda module=module_names: run_test(module, options)
210        name = '.'.join(module_names)
211        run_module.__name__ = name
212        functions[run_module] = set()
213
214    try:
215        dargs = {}
216        if options.debug:
217            dargs['max_simultaneous_procs'] = 1
218        pe = parallel.ParallelExecute(functions, **dargs)
219        pe.run_until_completion()
220    except parallel.ParallelError, err:
221        return err.errors
222    return []
223
224
225def main():
226    """Entry point for unittest_suite.py"""
227    options, args = parser.parse_args()
228    if args:
229        options.module_list = args
230
231    # Strip the arguments off the command line, so that the unit tests do not
232    # see them.
233    del sys.argv[1:]
234
235    absolute_start = os.path.join(ROOT, options.start)
236    errors = find_and_run_tests(absolute_start, options)
237    if errors:
238        print "%d tests resulted in an error/failure:" % len(errors)
239        for error in errors:
240            print "\t%s" % error
241        print "Rerun", sys.argv[0], "--debug to see the failure details."
242        sys.exit(1)
243    else:
244        print "All passed!"
245        sys.exit(0)
246
247
248if __name__ == "__main__":
249    main()
250