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