modules/ts/misc/run.py

   1 #!/usr/bin/env python
   2
   3 import os
   4 import argparse
   5 import logging
   6 import datetime
   7 from run_utils import Err, CMakeCache, log, execute
   8 from run_suite import TestSuite
   9 from run_android import AndroidTestSuite
  10
  11 epilog = '''
  12 NOTE:
  13 Additional options starting with "--gtest_" and "--perf_" will be passed directly to the test executables.
  14 '''
  15
  16 if __name__ == "__main__":
  17
  18     # log.basicConfig(format='[%(levelname)s] %(message)s', level = log.DEBUG)
  19     # log.basicConfig(format='[%(levelname)s] %(message)s', level = log.INFO)
  20
  21     parser = argparse.ArgumentParser(
  22         description='OpenCV test runner script',
  23         epilog=epilog,
  24         formatter_class=argparse.RawDescriptionHelpFormatter)
  25     parser.add_argument("build_path", nargs='?', default=".", help="Path to build directory (should contain CMakeCache.txt, default is current) or to directory with tests (all platform checks will be disabled in this case)")
  26     parser.add_argument("-t", "--tests", metavar="MODULES", default="", help="Comma-separated list of modules to test (example: -t core,imgproc,java)")
  27     parser.add_argument("-b", "--blacklist", metavar="MODULES", default="", help="Comma-separated list of modules to exclude from test (example: -b java)")
  28     parser.add_argument("-a", "--accuracy", action="store_true", default=False, help="Look for accuracy tests instead of performance tests")
  29     parser.add_argument("--check", action="store_true", default=False, help="Shortcut for '--perf_min_samples=1 --perf_force_samples=1'")
  30     parser.add_argument("-w", "--cwd", metavar="PATH", default=".", help="Working directory for tests (default is current)")
  31     parser.add_argument("--list", action="store_true", default=False, help="List available tests (executables)")
  32     parser.add_argument("--list_short", action="store_true", default=False, help="List available tests (aliases)")
  33     parser.add_argument("--list_short_main", action="store_true", default=False, help="List available tests (main repository, aliases)")
  34     parser.add_argument("--configuration", metavar="CFG", default=None, help="Force Debug or Release configuration (for Visual Studio and Java tests build)")
  35     parser.add_argument("-n", "--dry_run", action="store_true", help="Do not run the tests")
  36     parser.add_argument("-v", "--verbose", action="store_true", default=False, help="Print more debug information")
  37
  38     # Valgrind
  39     parser.add_argument("--valgrind", action="store_true", default=False, help="Run C++ tests in valgrind")
  40     parser.add_argument("--valgrind_supp", metavar="FILE", action='append', help="Path to valgrind suppression file (example: --valgrind_supp opencv/platforms/scripts/valgrind.supp)")
  41     parser.add_argument("--valgrind_opt", metavar="OPT", action="append", default=[], help="Add command line option to valgrind (example: --valgrind_opt=--leak-check=full)")
  42
  43     # QEMU
  44     parser.add_argument("--qemu", default="", help="Specify qemu binary and base parameters")
  45
  46     # Android
  47     parser.add_argument("--android", action="store_true", default=False, help="Android: force all tests to run on device")
  48     parser.add_argument("--android_sdk", metavar="PATH", help="Android: path to SDK to use adb and aapt tools")
  49     parser.add_argument("--android_test_data_path", metavar="PATH", default="/sdcard/opencv_testdata/", help="Android: path to testdata on device")
  50     parser.add_argument("--android_env", action='append', help="Android: add environment variable (NAME=VALUE)")
  51     parser.add_argument("--android_propagate_opencv_env", action="store_true", default=False, help="Android: propagate OPENCV* environment variables")
  52     parser.add_argument("--serial", metavar="serial number", default="", help="Android: directs command to the USB device or emulator with the given serial number")
  53     parser.add_argument("--package", metavar="package", default="", help="Java: run JUnit tests for specified module or Android package")
  54     parser.add_argument("--java_test_exclude", metavar="java_test_exclude", default="", help="Java: Filter out specific JUnit tests")
  55
  56     parser.add_argument("--trace", action="store_true", default=False, help="Trace: enable OpenCV tracing")
  57     parser.add_argument("--trace_dump", metavar="trace_dump", default=-1, help="Trace: dump highlight calls (specify max entries count, 0 - dump all)")
  58
  59     args, other_args = parser.parse_known_args()
  60
  61     log.setLevel(logging.DEBUG if args.verbose else logging.INFO)
  62
  63     test_args = [a for a in other_args if a.startswith("--perf_") or a.startswith("--test_") or a.startswith("--gtest_")]
  64     bad_args = [a for a in other_args if a not in test_args]
  65     if len(bad_args) > 0:
  66         log.error("Error: Bad arguments: %s", bad_args)
  67         exit(1)
  68
  69     args.mode = "test" if args.accuracy else "perf"
  70
  71     android_env = []
  72     if args.android_env:
  73         android_env.extend([entry.split("=", 1) for entry in args.android_env])
  74     if args.android_propagate_opencv_env:
  75         android_env.extend([entry for entry in os.environ.items() if entry[0].startswith('OPENCV')])
  76     android_env = dict(android_env)
  77     if args.android_test_data_path:
  78         android_env['OPENCV_TEST_DATA_PATH'] = args.android_test_data_path
  79
  80     if args.valgrind:
  81         try:
  82             ver = execute(["valgrind", "--version"], silent=True)
  83             log.debug("Using %s", ver)
  84         except OSError as e:
  85             log.error("Failed to run valgrind: %s", e)
  86             exit(1)
  87
  88     if len(args.build_path) != 1:
  89         test_args = [a for a in test_args if not a.startswith("--gtest_output=")]
  90
  91     if args.check:
  92         if not [a for a in test_args if a.startswith("--perf_min_samples=")]:
  93             test_args.extend(["--perf_min_samples=1"])
  94         if not [a for a in test_args if a.startswith("--perf_force_samples=")]:
  95             test_args.extend(["--perf_force_samples=1"])
  96         if not [a for a in test_args if a.startswith("--perf_verify_sanity")]:
  97             test_args.extend(["--perf_verify_sanity"])
  98
  99     if bool(os.environ.get('BUILD_PRECOMMIT', None)):
 100         test_args.extend(["--skip_unstable=1"])
 101
 102     ret = 0
 103     logs = []
 104     stamp = datetime.datetime.now().strftime("%Y%m%d-%H%M%S")
 105     path = args.build_path
 106     try:
 107         if not os.path.isdir(path):
 108             raise Err("Not a directory (should contain CMakeCache.txt to test executables)")
 109         cache = CMakeCache(args.configuration)
 110         fname = os.path.join(path, "CMakeCache.txt")
 111
 112         if os.path.isfile(fname):
 113             log.debug("Reading cmake cache file: %s", fname)
 114             cache.read(path, fname)
 115         else:
 116             log.debug("Assuming folder contains tests: %s", path)
 117             cache.setDummy(path)
 118
 119         if args.android or cache.getOS() == "android":
 120             log.debug("Creating Android test runner")
 121             suite = AndroidTestSuite(args, cache, stamp, android_env)
 122         else:
 123             log.debug("Creating native test runner")
 124             suite = TestSuite(args, cache, stamp)
 125
 126         if args.list or args.list_short or args.list_short_main:
 127             suite.listTests(args.list_short or args.list_short_main, args.list_short_main)
 128         else:
 129             log.debug("Running tests in '%s', working dir: '%s'", path, args.cwd)
 130
 131             def parseTests(s):
 132                 return [o.strip() for o in s.split(",") if o]
 133             logs, ret = suite.runTests(parseTests(args.tests), parseTests(args.blacklist), args.cwd, test_args)
 134     except Err as e:
 135         log.error("ERROR: test path '%s' ==> %s", path, e.msg)
 136         ret = -1
 137
 138     if logs:
 139         log.warning("Collected: %s", logs)
 140
 141     if ret != 0:
 142         log.error("ERROR: some tests have failed")
 143     exit(ret)