| #!/bin/env python |
| # Copyright (c) 2006-2008 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. |
| |
| # chrome_tests.py |
| |
| ''' Runs various chrome tests through purify_test.py |
| ''' |
| |
| import glob |
| import logging |
| import optparse |
| import os |
| import stat |
| import sys |
| |
| import google.logging_utils |
| import google.path_utils |
| import google.platform_utils |
| |
| import common |
| |
| |
| class TestNotFound(Exception): pass |
| |
| |
| class ChromeTests: |
| |
| def __init__(self, options, args, test): |
| # the known list of tests |
| self._test_list = {"test_shell": self.TestTestShell, |
| "unit": self.TestUnit, |
| "net": self.TestNet, |
| "ipc": self.TestIpc, |
| "base": self.TestBase, |
| "layout": self.TestLayout, |
| "dll": self.TestDll, |
| "layout_all": self.TestLayoutAll, |
| "ui": self.TestUI, |
| "v8": self.TestV8} |
| |
| if test not in self._test_list: |
| raise TestNotFound("Unknown test: %s" % test) |
| |
| self._options = options |
| self._args = args |
| self._test = test |
| |
| script_dir = google.path_utils.ScriptDir() |
| utility = google.platform_utils.PlatformUtility(script_dir) |
| |
| # Compute the top of the tree (the "source dir") from the script dir (where |
| # this script lives). We assume that the script dir is in tools/purify |
| # relative to the top of the tree. |
| self._source_dir = os.path.dirname(os.path.dirname(script_dir)) |
| |
| # since this path is used for string matching, make sure it's always |
| # an absolute Windows-style path |
| self._source_dir = utility.GetAbsolutePath(self._source_dir) |
| |
| self._report_dir = options.report_dir |
| if not self._report_dir: |
| if not options.buildbot: |
| self._report_dir = os.path.join(script_dir, "latest", test) |
| else: |
| # On the buildbot, we archive to a specific location on chrome-web |
| # with a directory based on the test name and the current svn revision. |
| # NOTE: These modules are located in trunk/tools/buildbot, which is not |
| # in the default config. You'll need to check this out and add |
| # scripts/* to your PYTHONPATH to test outside of the buildbot. |
| import slave_utils |
| import chromium_config |
| chrome_web_dir = chromium_config.Archive.purify_test_result_archive |
| current_version = str(slave_utils.SubversionRevision(self._source_dir)) |
| # This line is how the buildbot master figures out our directory. |
| print "last change:", current_version |
| self._report_dir = os.path.join(chrome_web_dir, test, current_version) |
| if not os.path.exists(self._report_dir): |
| os.makedirs(self._report_dir) |
| |
| purify_test = os.path.join(script_dir, "purify_test.py") |
| self._command_preamble = ["python.exe", purify_test, "--echo_to_stdout", |
| "--source_dir=%s" % (self._source_dir), |
| "--save_cache"] |
| |
| def ComputeBuildDir(self, module, exe=None): |
| ''' Computes the build dir for the given module / exe ''' |
| if self._options.build_dir: |
| self._build_dir = self._options.build_dir |
| return self._build_dir |
| # Recompute _build_dir since the module and exe might have changed from |
| # a previous call (we might be running multiple tests). |
| module_dir = os.path.join(self._source_dir, module) |
| dir_chrome = os.path.join(self._source_dir, "chrome", "Release") |
| dir_module = os.path.join(module_dir, "Release") |
| if exe: |
| exe_chrome = os.path.join(dir_chrome, exe) |
| exe_module = os.path.join(dir_module, exe) |
| if os.path.isfile(exe_chrome) and not os.path.isfile(exe_module): |
| self._build_dir = dir_chrome |
| elif os.path.isfile(exe_module) and not os.path.isfile(exe_chrome): |
| self._build_dir = dir_module |
| elif os.stat(exe_module)[stat.ST_MTIME] > os.stat(exe_chrome)[stat.ST_MTIME]: |
| self._build_dir = dir_module |
| else: |
| self._build_dir = dir_chrome |
| else: |
| if os.path.isdir(dir_chrome) and not os.path.isdir(dir_module): |
| self._build_dir = dir_chrome |
| elif os.path.isdir(dir_module) and not os.path.isdir(dir_chrome): |
| self._build_dir = dir_module |
| elif os.stat(dir_module)[stat.ST_MTIME] > os.stat(dir_chrome)[stat.ST_MTIME]: |
| self._build_dir = dir_module |
| else: |
| self._build_dir = dir_chrome |
| return self._build_dir; |
| |
| def _DefaultCommand(self, module, exe=None): |
| '''Generates the default command array that most tests will use.''' |
| module_dir = os.path.join(self._source_dir, module) |
| if module == "chrome": |
| # unfortunately, not all modules have the same directory structure |
| self._data_dir = os.path.join(module_dir, "test", "data", "purify") |
| else: |
| self._data_dir = os.path.join(module_dir, "data", "purify") |
| |
| cmd = list(self._command_preamble) |
| cmd.append("--data_dir=%s" % self._data_dir) |
| cmd.append("--report_dir=%s" % self._report_dir) |
| if self._options.baseline: |
| cmd.append("--baseline") |
| if self._options.verbose: |
| cmd.append("--verbose") |
| self.ComputeBuildDir(module, exe); |
| if exe: |
| cmd.append(os.path.join(self._build_dir, exe)) |
| return cmd |
| |
| def Run(self): |
| ''' Runs the test specified by command-line argument --test ''' |
| logging.info("running test %s" % (self._test)) |
| return self._test_list[self._test]() |
| |
| def _ReadGtestFilterFile(self, name, cmd): |
| '''Read a file which is a list of tests to filter out with --gtest_filter |
| and append the command-line option to cmd. |
| ''' |
| filters = [] |
| filename = os.path.join(self._data_dir, name + ".gtest.txt") |
| if os.path.exists(filename): |
| logging.info("using gtest filter from %s" % filename) |
| f = open(filename, 'r') |
| for line in f.readlines(): |
| if line.startswith("#") or line.startswith("//") or line.isspace(): |
| continue |
| line = line.rstrip() |
| filters.append(line) |
| gtest_filter = self._options.gtest_filter |
| if len(filters): |
| if gtest_filter: |
| gtest_filter += ":" |
| if gtest_filter.find("-") < 0: |
| gtest_filter += "-" |
| else: |
| gtest_filter = "-" |
| gtest_filter += ":".join(filters) |
| if gtest_filter: |
| cmd.append("--gtest_filter=%s" % gtest_filter) |
| |
| def SimpleTest(self, module, name): |
| cmd = self._DefaultCommand(module, name) |
| if not self._options.run_singly: |
| self._ReadGtestFilterFile(name, cmd) |
| cmd.append("--gtest_print_time") |
| return common.RunSubprocess(cmd, 0) |
| else: |
| exe = cmd[-1] |
| script = ["python.exe", "test_runner.py", exe] |
| return self.ScriptedTest(module, exe, name, script, multi=True) |
| |
| def ScriptedTest(self, module, exe, name, script, multi=False, cmd_args=None, |
| out_dir_extra=None): |
| '''Purify a target exe, which will be executed one or more times via a |
| script or driver program. |
| Args: |
| module - which top level component this test is from (webkit, base, etc.) |
| exe - the name of the exe (it's assumed to exist in build_dir) |
| name - the name of this test (used to name output files) |
| script - the driver program or script. If it's python.exe, we use |
| search-path behavior to execute, otherwise we assume that it is in |
| build_dir. |
| multi - a boolean hint that the exe will be run multiple times, generating |
| multiple output files (without this option, only the last run will be |
| recorded and analyzed) |
| cmd_args - extra arguments to pass to the purify_test.py script |
| ''' |
| if out_dir_extra: |
| self._report_dir = os.path.join(self._report_dir, out_dir_extra) |
| cmd = self._DefaultCommand(module) |
| exe = os.path.join(self._options.build_dir, exe) |
| cmd.append("--exe=%s" % exe) |
| cmd.append("--name=%s" % name) |
| if multi: |
| if out_dir_extra: |
| if os.path.exists(self._report_dir): |
| old_files = glob.glob(os.path.join(self._report_dir, "*.txt")) |
| for f in old_files: |
| os.remove(f) |
| else: |
| os.makedirs(self._report_dir) |
| out_file = os.path.join(self._report_dir, "%s%%5d.txt" % name) |
| cmd.append("--out_file=%s" % out_file) |
| if cmd_args: |
| cmd.extend(cmd_args) |
| if script[0] != "python.exe" and not os.path.exists(script[0]): |
| script[0] = os.path.join(self._options.build_dir, script[0]) |
| cmd.extend(script) |
| self._ReadGtestFilterFile(name, cmd) |
| return common.RunSubprocess(cmd, 0) |
| |
| def InstrumentDll(self): |
| '''Does a blocking Purify instrumentation of chrome.dll.''' |
| # TODO(paulg): Make this code support any DLL. |
| cmd = self._DefaultCommand("chrome") |
| cmd.append("--instrument_only") |
| cmd.append(os.path.join(self._options.build_dir, "chrome.dll")) |
| result = common.RunSubprocess(cmd, 0) |
| if result: |
| logging.error("Instrumentation error: %d" % result) |
| return result |
| |
| def TestDll(self): |
| return self.InstrumentDll() |
| |
| def TestBase(self): |
| return self.SimpleTest("base", "base_unittests.exe") |
| |
| def TestIpc(self): |
| return self.SimpleTest("chrome", "ipc_tests.exe") |
| |
| def TestNet(self): |
| return self.SimpleTest("net", "net_unittests.exe") |
| |
| def TestTestShell(self): |
| return self.SimpleTest("webkit", "test_shell_tests.exe") |
| |
| def TestUnit(self): |
| return self.SimpleTest("chrome", "unit_tests.exe") |
| |
| def TestLayoutAll(self): |
| return self.TestLayout(run_all=True) |
| |
| def TestLayout(self, run_all=False): |
| # A "chunk file" is maintained in the local directory so that each test |
| # runs a slice of the layout tests of size chunk_size that increments with |
| # each run. Since tests can be added and removed from the layout tests at |
| # any time, this is not going to give exact coverage, but it will allow us |
| # to continuously run small slices of the layout tests under purify rather |
| # than having to run all of them in one shot. |
| chunk_num = 0 |
| # Tests currently seem to take about 20-30s each. |
| chunk_size = 120 # so about 40-60 minutes per run |
| chunk_file = os.path.join(os.environ["TEMP"], "purify_layout_chunk.txt") |
| if not run_all: |
| try: |
| f = open(chunk_file) |
| if f: |
| str = f.read() |
| if len(str): |
| chunk_num = int(str) |
| # This should be enough so that we have a couple of complete runs |
| # of test data stored in the archive (although note that when we loop |
| # that we almost guaranteed won't be at the end of the test list) |
| if chunk_num > 10000: |
| chunk_num = 0 |
| f.close() |
| except IOError, (errno, strerror): |
| logging.error("error reading from file %s (%d, %s)" % (chunk_file, |
| errno, strerror)) |
| |
| script = os.path.join(self._source_dir, "webkit", "tools", "layout_tests", |
| "run_webkit_tests.py") |
| script_cmd = ["python.exe", script, "--run-singly", "-v", |
| "--noshow-results", "--time-out-ms=200000", |
| "--nocheck-sys-deps"] |
| if not run_all: |
| script_cmd.append("--run-chunk=%d:%d" % (chunk_num, chunk_size)) |
| |
| if len(self._args): |
| # if the arg is a txt file, then treat it as a list of tests |
| if os.path.isfile(self._args[0]) and self._args[0][-4:] == ".txt": |
| script_cmd.append("--test-list=%s" % self._args[0]) |
| else: |
| script_cmd.extend(self._args) |
| |
| if run_all: |
| ret = self.ScriptedTest("webkit", "test_shell.exe", "layout", |
| script_cmd, multi=True, cmd_args=["--timeout=0"]) |
| return ret |
| |
| # store each chunk in its own directory so that we can find the data later |
| chunk_dir = os.path.join("chunk_%05d" % chunk_num) |
| ret = self.ScriptedTest("webkit", "test_shell.exe", "layout", |
| script_cmd, multi=True, cmd_args=["--timeout=0"], |
| out_dir_extra=chunk_dir) |
| |
| # Wait until after the test runs to completion to write out the new chunk |
| # number. This way, if the bot is killed, we'll start running again from |
| # the current chunk rather than skipping it. |
| try: |
| f = open(chunk_file, "w") |
| chunk_num += 1 |
| f.write("%d" % chunk_num) |
| f.close() |
| except IOError, (errno, strerror): |
| logging.error("error writing to file %s (%d, %s)" % (chunk_file, errno, |
| strerror)) |
| # Since we're running small chunks of the layout tests, it's important to |
| # mark the ones that have errors in them. These won't be visible in the |
| # summary list for long, but will be useful for someone reviewing this bot. |
| #return ret |
| # For now, since a fair number of layout tests are still red, we'll use the |
| # magic orange indicator return code to avoid making the tree look red when |
| # nothing has changed. When We get the layout tests into a stable green, |
| # this code should be undone. |
| # BUG=7516 |
| if ret: |
| return 88 |
| return 0 |
| |
| def TestUIAll(self): |
| if not self._options.no_reinstrument: |
| instrumentation_error = self.InstrumentDll() |
| if instrumentation_error: |
| return instrumentation_error |
| return self.ScriptedTest("chrome", "chrome.exe", "ui_tests", |
| ["ui_tests.exe", |
| "--single-process", |
| "--ui-test-timeout=180000", |
| "--ui-test-action-timeout=80000", |
| "--ui-test-action-max-timeout=180000", |
| "--ui-test-sleep-timeout=40000"], |
| multi=True) |
| |
| def TestUI(self): |
| # Similar to layout test, we run a slice of UI tests with each run. |
| # This is achieved by using --batch-count (total number of slices) and |
| # --batch-index (current slice index) command line switches of UI tests. |
| # A "batch index file" is maintained in the local directory so that each |
| # test runs the kth slice of UI tests and increments k for next run. |
| # Note: a full cycle of UI tests is finished in batch_count runs. |
| # If new test cases are added in the middle of a cycle, some tests |
| # may get skipped in the current cycle. For more discussion on this issue, |
| # see http://codereview.chromium.org/149600. |
| |
| # Break UI tests into 16 slices so we have about 30-40 minutes per run. |
| batch_count = 16 |
| batch_index = 0 |
| batch_index_file = os.path.join(os.environ["TEMP"], |
| "purify_ui_batch_index.txt") |
| try: |
| f = open(batch_index_file) |
| if f: |
| str = f.read() |
| if len(str): |
| batch_index = int(str) |
| if batch_index >= batch_count: |
| batch_index = 0 |
| f.close() |
| except IOError, (errno, strerror): |
| logging.error("error reading from file %s (%d, %s)" % (batch_index_file, |
| errno, strerror)) |
| |
| script_cmd = ["ui_tests.exe", "--single-process", |
| "--ui-test-timeout=180000", |
| "--ui-test-action-timeout=80000", |
| "--ui-test-action-max-timeout=180000", |
| "--ui-test-sleep-timeout=40000", |
| "--batch-count=%s" % batch_count, |
| "--batch-index=%s" % batch_index] |
| |
| ret = self.ScriptedTest("chrome", "chrome.exe", "ui_tests", |
| script_cmd, multi=True) |
| |
| # Wait until after the test runs to completion to write out the new batch |
| # index. This way, if the bot is killed, we'll start running again from |
| # the current chunk rather than skipping it. |
| try: |
| f = open(batch_index_file, "w") |
| batch_index += 1 |
| if batch_index == batch_count: |
| batch_index = 0 |
| f.write("%d" % batch_index) |
| f.close() |
| except IOError, (errno, strerror): |
| logging.error("error writing to file %s (%d, %s)" % (batch_index_file, |
| errno, strerror)) |
| |
| # As we just started to run full pass UI test under purify, there are a |
| # fair number of test errors. |
| if ret: |
| return 88 |
| return 0 |
| |
| def TestV8(self): |
| shell = "v8_shell.exe" |
| # We need to compute _build_dir early to in order to pass in the |
| # shell path as an argument to the test script. |
| self.ComputeBuildDir("chrome", shell) |
| script = os.path.join(self._source_dir, "v8", "tools", "test.py") |
| shell_path = os.path.join(self._options.build_dir, shell) |
| return self.ScriptedTest("chrome", shell, "v8", |
| ["python.exe", |
| script, |
| "--no-build", |
| "--progress=dots", |
| "--shell=" + shell_path], |
| multi = True) |
| |
| def _main(argv): |
| parser = optparse.OptionParser("usage: %prog -b <dir> -t <test> " |
| "[-t <test> ...]") |
| parser.disable_interspersed_args() |
| parser.add_option("-b", "--build_dir", |
| help="the location of the output of the compiler output") |
| parser.add_option("-t", "--test", action="append", |
| help="which test to run") |
| parser.add_option("", "--baseline", action="store_true", default=False, |
| help="generate baseline data instead of validating") |
| parser.add_option("", "--gtest_filter", |
| help="additional arguments to --gtest_filter") |
| parser.add_option("-v", "--verbose", action="store_true", default=False, |
| help="verbose output - enable debug log messages") |
| parser.add_option("", "--no-reinstrument", action="store_true", default=False, |
| help="Don't force a re-instrumentation for ui_tests") |
| parser.add_option("", "--run-singly", action="store_true", default=False, |
| help="run tests independently of each other so that they " |
| "don't interfere with each other and so that errors " |
| "can be accurately attributed to their source"); |
| parser.add_option("", "--report_dir", |
| help="path where report files are saved") |
| parser.add_option("", "--buildbot", action="store_true", default=False, |
| help="whether we're being run in a buildbot environment") |
| options, args = parser.parse_args() |
| |
| if options.verbose: |
| google.logging_utils.config_root(logging.DEBUG) |
| else: |
| google.logging_utils.config_root() |
| |
| if not options.test or not len(options.test): |
| parser.error("--test not specified") |
| |
| for t in options.test: |
| tests = ChromeTests(options, args, t) |
| ret = tests.Run() |
| if ret: return ret |
| return 0 |
| |
| |
| if __name__ == "__main__": |
| ret = _main(sys.argv) |
| sys.exit(ret) |
