• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1#!/usr/bin/python2
2#
3# Copyright (c) 2012 The Chromium OS Authors. All rights reserved.
4# Use of this source code is governed by a BSD-style license that can be
5# found in the LICENSE file.
6
7"""Tool for enumerating the tests in a given suite.
8
9Given an autotest root directory and a suite name (e.g., bvt, regression), this
10tool will print out the name of each test in that suite, one per line.
11
12Example:
13$ ./site_utils/suite_enumerator.py -a /usr/local/autotest bvt 2>/dev/null
14login_LoginSuccess
15logging_CrashSender
16login_BadAuthentication
17
18This is intended for use only with Chrome OS test suits that leverage the
19dynamic suite infrastructure in server/cros/dynamic_suite.py.
20"""
21
22import logging
23import optparse, os, sys
24
25# Silence messages relating to imports of missing, unneeded
26# modules.
27logging.basicConfig(level=logging.INFO)
28
29import common
30import autotest_lib.client.common_lib.cros as cros_lib
31import autotest_lib.server.cros.dynamic_suite.suite as suite_lib
32
33
34def parse_options():
35    """Parse command line for arguments including autotest directory, suite
36    name, if to list stable tests only, and if to list all available suites.
37    """
38    usage = "usage: %prog [options] suite_name"
39    parser = optparse.OptionParser(usage=usage)
40    parser.add_option('-a', '--autotest_dir', dest='autotest_dir',
41                      default=os.path.abspath(
42                          os.path.join(os.path.dirname(__file__),
43                                       os.pardir)),
44                      help='Directory under which to search for tests.'\
45                           ' (e.g. /usr/local/autotest)')
46    parser.add_option('-l', '--listall',
47                      action='store_true', default=False,
48                      help='Print a listing of all suites. Ignores all args.')
49    options, args = parser.parse_args()
50    return parser, options, args
51
52
53def main():
54    """Entry point to run the suite enumerator command."""
55    parser, options, args = parse_options()
56    if options.listall:
57        if args:
58            print 'Cannot use suite_name with --listall'
59            parser.print_help()
60    elif not args or len(args) != 1:
61        parser.print_help()
62        return
63
64    fs_getter = suite_lib.create_fs_getter(options.autotest_dir)
65    devserver = cros_lib.dev_server.ImageServer('')
66    if options.listall:
67        for suite in suite_lib.list_all_suites('', devserver, fs_getter):
68            print suite
69        return
70
71    suite = suite_lib.Suite.create_from_name(args[0], {}, '', devserver,
72                                             fs_getter)
73    # If in test list, print firmware_FAFTSetup before other tests
74    # NOTE: the test.name value can be *different* from the directory
75    # name that appears in test.path
76    PRETEST_LIST = ['firmware_FAFTSetup',]
77    for test in filter(lambda test: test.name in \
78                              PRETEST_LIST, suite.tests):
79        print test.path
80    for test in filter(lambda test: test.name not in \
81                       PRETEST_LIST, suite.tests):
82        print test.path
83
84    # Check if test_suites/control.suite_name exists.
85    control_path = os.path.join(options.autotest_dir, 'test_suites',
86                                'control.' + args[0])
87    if not os.path.exists(control_path):
88        print >> sys.stderr, ('Warning! control file is missing: %s' %
89                              control_path)
90
91
92if __name__ == "__main__":
93    sys.exit(main())
94