#!/usr/bin/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 valgrind_test.py. This file is a copy of ../purify/chrome_tests.py. Eventually, it would be nice to merge these two files. ''' import glob import logging import optparse import os import stat import sys import google.logging_utils import google.path_utils # Import the platform_utils up in the layout tests which have been modified to # work under non-Windows platforms instead of the ones that are in the # tools/python/google directory. (See chrome_tests.sh which sets PYTHONPATH # correctly.) # # TODO(erg): Copy/Move the relevant functions from the layout_package version # of platform_utils back up to google.platform_utils # package. http://crbug.com/6164 import layout_package.platform_utils import common class TestNotFound(Exception): pass class ChromeTests: '''This class is derived from the chrome_tests.py file in ../purify/. ''' def __init__(self, options, args, test): # The known list of tests. # Recognise the original abbreviations as well as full executable names. self._test_list = { "base": self.TestBase, "base_unittests": self.TestBase, "googleurl": self.TestGURL, "googleurl_unittests": self.TestGURL, "ipc": self.TestIpc, "ipc_tests": self.TestIpc, "layout": self.TestLayout, "layout_tests": self.TestLayout, "media": self.TestMedia, "media_unittests": self.TestMedia, "net": self.TestNet, "net_unittests": self.TestNet, "printing": self.TestPrinting, "printing_unittests": self.TestPrinting, "startup": self.TestStartup, "startup_tests": self.TestStartup, "test_shell": self.TestTestShell, "test_shell_tests": self.TestTestShell, "ui": self.TestUI, "ui_tests": self.TestUI, "unit": self.TestUnit, "unit_tests": self.TestUnit, } 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 = layout_package.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/valgrind/ # 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) valgrind_test = os.path.join(script_dir, "valgrind_test.py") self._command_preamble = ["python", valgrind_test, "--source_dir=%s" % (self._source_dir)] def _DefaultCommand(self, module, exe=None, valgrind_test_args=None): '''Generates the default command array that most tests will use.''' module_dir = os.path.join(self._source_dir, module) # We need multiple data dirs, the current script directory and a module # specific one. The global suppression file lives in our directory, and the # module specific suppression file lives with the module. self._data_dirs = [google.path_utils.ScriptDir()] if module == "chrome": # unfortunately, not all modules have the same directory structure self._data_dirs.append(os.path.join(module_dir, "test", "data", "valgrind")) else: self._data_dirs.append(os.path.join(module_dir, "data", "valgrind")) if not self._options.build_dir: builddir = { 'darwin': 'xcodebuild', 'linux2': 'sconsbuild' }[sys.platform] dir_chrome = os.path.join(self._source_dir, builddir, "Debug") dir_module = os.path.join(module_dir, "Debug") 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._options.build_dir = dir_chrome elif os.path.isfile(exe_module) and not os.path.isfile(exe_chrome): self._options.build_dir = dir_module elif (os.stat(exe_module)[stat.ST_MTIME] > os.stat(exe_chrome)[stat.ST_MTIME]): self._options.build_dir = dir_module else: self._options.build_dir = dir_chrome else: if os.path.isdir(dir_chrome) and not os.path.isdir(dir_module): self._options.build_dir = dir_chrome elif os.path.isdir(dir_module) and not os.path.isdir(dir_chrome): self._options.build_dir = dir_module elif (os.stat(dir_module)[stat.ST_MTIME] > os.stat(dir_chrome)[stat.ST_MTIME]): self._options.build_dir = dir_module else: self._options.build_dir = dir_chrome cmd = list(self._command_preamble) for directory in self._data_dirs: suppression_file = os.path.join(directory, "suppressions.txt") if os.path.exists(suppression_file): cmd.append("--suppressions=%s" % suppression_file) # Platform specific suppression suppression_platform = { 'darwin': 'mac', 'linux2': 'linux' }[sys.platform] suppression_file_platform = \ os.path.join(directory, 'suppressions_%s.txt' % suppression_platform) if os.path.exists(suppression_file_platform): cmd.append("--suppressions=%s" % suppression_file_platform) if self._options.baseline: cmd.append("--baseline") if self._options.verbose: cmd.append("--verbose") if self._options.show_all_leaks: cmd.append("--show_all_leaks") if self._options.track_origins: cmd.append("--track_origins") if self._options.generate_dsym: cmd.append("--generate_dsym") if self._options.generate_suppressions: cmd.append("--generate_suppressions") if self._options.custom_valgrind_command: cmd.append("--custom_valgrind_command=%s" % self._options.custom_valgrind_command) if valgrind_test_args != None: for arg in valgrind_test_args: cmd.append(arg) if exe: cmd.append(os.path.join(self._options.build_dir, exe)) # Valgrind runs tests slowly, so slow tests hurt more; show elapased time # so we can find the slowpokes. cmd.append("--gtest_print_time") 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 = [] for directory in self._data_dirs: filename = os.path.join(directory, name + ".gtest.txt") if os.path.exists(filename): logging.info("reading gtest filters 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, valgrind_test_args=None, cmd_args=None): cmd = self._DefaultCommand(module, name, valgrind_test_args) self._ReadGtestFilterFile(name, cmd) if cmd_args: cmd.extend(["--"]) cmd.extend(cmd_args) return common.RunSubprocess(cmd, 0) def TestBase(self): return self.SimpleTest("base", "base_unittests") def TestGURL(self): return self.SimpleTest("chrome", "googleurl_unittests") def TestMedia(self): return self.SimpleTest("chrome", "media_unittests") def TestPrinting(self): return self.SimpleTest("chrome", "printing_unittests") def TestIpc(self): return self.SimpleTest("chrome", "ipc_tests", valgrind_test_args=["--trace_children"]) def TestNet(self): return self.SimpleTest("net", "net_unittests") def TestStartup(self): # We don't need the performance results, we're just looking for pointer # errors, so set number of iterations down to the minimum. os.putenv("STARTUP_TESTS_NUMCYCLES", "1") logging.info("export STARTUP_TESTS_NUMCYCLES=1"); return self.SimpleTest("chrome", "startup_tests", valgrind_test_args=[ "--trace_children", "--indirect"]) def TestTestShell(self): return self.SimpleTest("webkit", "test_shell_tests") def TestUnit(self): return self.SimpleTest("chrome", "unit_tests") def TestUI(self): return self.SimpleTest("chrome", "ui_tests", valgrind_test_args=[ "--timeout=120000", "--trace_children", "--indirect"], cmd_args=[ "--ui-test-timeout=120000", "--ui-test-action-timeout=80000", "--ui-test-action-max-timeout=180000"]) def TestLayoutChunk(self, chunk_num, chunk_size): # Run tests [chunk_num*chunk_size .. (chunk_num+1)*chunk_size) from the # list of tests. Wrap around to beginning of list at end. # If chunk_size is zero, run all tests in the list once. # If a text file is given as argument, it is used as the list of tests. # # Build the ginormous commandline in 'cmd'. # It's going to be roughly # python valgrind_test.py ... python run_webkit_tests.py ... # but we'll use the --indirect flag to valgrind_test.py # to avoid valgrinding python. # Start by building the valgrind_test.py commandline. cmd = self._DefaultCommand("webkit") cmd.append("--trace_children") cmd.append("--indirect") # Now build script_cmd, the run_webkits_tests.py commandline # Store each chunk in its own directory so that we can find the data later chunk_dir = os.path.join("layout", "chunk_%05d" % chunk_num) test_shell = os.path.join(self._options.build_dir, "test_shell") out_dir = os.path.join(google.path_utils.ScriptDir(), "latest") out_dir = os.path.join(out_dir, chunk_dir) if os.path.exists(out_dir): old_files = glob.glob(os.path.join(out_dir, "*.txt")) for f in old_files: os.remove(f) else: os.makedirs(out_dir) script = os.path.join(self._source_dir, "webkit", "tools", "layout_tests", "run_webkit_tests.py") script_cmd = ["python", script, "--run-singly", "-v", "--noshow-results", "--time-out-ms=200000", "--nocheck-sys-deps"] # Pass build mode to run_webkit_tests.py. We aren't passed it directly, # so parse it out of build_dir. run_webkit_tests.py can only handle # the two values "Release" and "Debug". # TODO(Hercules): unify how all our scripts pass around build mode # (--mode / --target / --build_dir / --debug) if self._options.build_dir.endswith("Debug"): script_cmd.append("--debug"); if (chunk_size > 0): 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) self._ReadGtestFilterFile("layout", script_cmd) # Now run script_cmd with the wrapper in cmd cmd.extend(["--"]) cmd.extend(script_cmd) ret = common.RunSubprocess(cmd, 0) return ret def TestLayout(self): # 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_size = self._options.num_tests if (chunk_size == 0): return self.TestLayoutChunk(0, 0) chunk_num = 0 chunk_file = os.path.join("valgrind_layout_chunk.txt") logging.info("Reading state from " + chunk_file) 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)) ret = self.TestLayoutChunk(chunk_num, chunk_size) # 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. logging.info("Saving state to " + chunk_file) 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 def _main(_): parser = optparse.OptionParser("usage: %prog -b -t " "[-t ...]") 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("", "--show_all_leaks", action="store_true", default=False, help="also show even less blatant leaks") parser.add_option("", "--track_origins", action="store_true", default=False, help="Show whence uninit bytes came. 30% slower.") parser.add_option("", "--generate_dsym", action="store_true", default=False, help="Generate .dSYM file on Mac if needed. Slow!") parser.add_option("", "--generate_suppressions", action="store_true", default=False, help="Skip analysis and generate suppressions") parser.add_option("", "--custom_valgrind_command", help="Use custom valgrind command and options") # My machine can do about 120 layout tests/hour in release mode. # Let's do 30 minutes worth per run. # The CPU is mostly idle, so perhaps we can raise this when # we figure out how to run them more efficiently. parser.add_option("-n", "--num_tests", default=60, type="int", help="for layout tests: # of subtests per run. 0 for all.") 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)