| # Copyright (C) 2010 Google Inc. All rights reserved. |
| # Copyright (C) 2010 Gabor Rapcsanyi (rgabor@inf.u-szeged.hu), University of Szeged |
| # Copyright (C) 2011, 2016, 2019 Apple Inc. All rights reserved. |
| # |
| # Redistribution and use in source and binary forms, with or without |
| # modification, are permitted provided that the following conditions are |
| # met: |
| # |
| # * Redistributions of source code must retain the above copyright |
| # notice, this list of conditions and the following disclaimer. |
| # * Redistributions in binary form must reproduce the above |
| # copyright notice, this list of conditions and the following disclaimer |
| # in the documentation and/or other materials provided with the |
| # distribution. |
| # * Neither the name of Google Inc. nor the names of its |
| # contributors may be used to endorse or promote products derived from |
| # this software without specific prior written permission. |
| # |
| # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| |
| from __future__ import print_function |
| import logging |
| import optparse |
| import os |
| import sys |
| import traceback |
| |
| from webkitpy.common.host import Host |
| from webkitpy.common.interrupt_debugging import log_stack_trace_on_ctrl_c, log_stack_trace_on_term |
| from webkitpy.layout_tests.controllers.manager import Manager |
| from webkitpy.layout_tests.models.test_run_results import INTERRUPTED_EXIT_STATUS |
| from webkitpy.port import configuration_options, platform_options |
| from webkitpy.layout_tests.views import buildbot_results |
| from webkitpy.layout_tests.views import printing |
| from webkitpy.results.options import upload_options |
| |
| |
| _log = logging.getLogger(__name__) |
| |
| |
| # This is a randomly chosen exit code that can be tested against to |
| # indicate that an unexpected exception occurred. |
| EXCEPTIONAL_EXIT_STATUS = 254 |
| |
| |
| def main(argv, stdout, stderr): |
| options, args = parse_args(argv) |
| |
| if options.platform and 'test' in options.platform: |
| # It's a bit lame to import mocks into real code, but this allows the user |
| # to run tests against the test platform interactively, which is useful for |
| # debugging test failures. |
| from webkitpy.common.host_mock import MockHost |
| host = MockHost() |
| else: |
| host = Host() |
| |
| if options.lint_test_files: |
| from webkitpy.layout_tests.lint_test_expectations import lint |
| return lint(host, options, stderr) |
| |
| try: |
| port = host.port_factory.get(options.platform, options) |
| except NotImplementedError as e: |
| # FIXME: is this the best way to handle unsupported port names? |
| print(str(e), file=stderr) |
| return EXCEPTIONAL_EXIT_STATUS |
| |
| stack_trace_path = host.filesystem.join(port.results_directory(), 'python_stack_trace.txt') |
| log_stack_trace_on_ctrl_c(output_file=stack_trace_path) |
| log_stack_trace_on_term(output_file=stack_trace_path) |
| |
| if options.print_expectations: |
| return _print_expectations(port, options, args, stderr) |
| |
| try: |
| # Force all tests to use a smaller stack so that stack overflow tests can run faster. |
| stackSizeInBytes = int(1.5 * 1024 * 1024) |
| options.additional_env_var.append('JSC_maxPerThreadStackUsage=' + str(stackSizeInBytes)) |
| options.additional_env_var.append('__XPC_JSC_maxPerThreadStackUsage=' + str(stackSizeInBytes)) |
| run_details = run(port, options, args, stderr) |
| if run_details.exit_code != -1 and not run_details.initial_results.keyboard_interrupted: |
| bot_printer = buildbot_results.BuildBotPrinter(stdout, options.debug_rwt_logging) |
| bot_printer.print_results(run_details) |
| |
| return run_details.exit_code |
| # We still need to handle KeyboardInterrupt, at least for webkitpy unittest cases. |
| except KeyboardInterrupt: |
| return INTERRUPTED_EXIT_STATUS |
| except BaseException as e: |
| if isinstance(e, Exception): |
| print('\n%s raised: %s' % (e.__class__.__name__, str(e)), file=stderr) |
| traceback.print_exc(file=stderr) |
| return EXCEPTIONAL_EXIT_STATUS |
| |
| |
| def parse_args(args): |
| option_group_definitions = [] |
| |
| option_group_definitions.append(("Platform options", platform_options())) |
| option_group_definitions.append(("Configuration options", configuration_options())) |
| option_group_definitions.append(("Printing Options", printing.print_options())) |
| |
| option_group_definitions.append(("Feature Switches", [ |
| optparse.make_option("--complex-text", action="store_true", default=False, |
| help="Use the complex text code path for all text (OS X and Windows only)"), |
| optparse.make_option("--accelerated-drawing", action="store_true", default=False, |
| help="Use accelerated drawing (OS X only)"), |
| optparse.make_option("--remote-layer-tree", action="store_true", default=False, |
| help="Use the remote layer tree drawing model (OS X WebKit2 only)"), |
| optparse.make_option("--internal-feature", type="string", action="append", |
| default=[], help="Enable internal feature"), |
| optparse.make_option("--experimental-feature", type="string", action="append", |
| default=[], help="Enable experimental feature"), |
| ])) |
| |
| option_group_definitions.append(("WebKit Options", [ |
| optparse.make_option("--gc-between-tests", action="store_true", default=False, |
| help="Force garbage collection between each test"), |
| optparse.make_option("-l", "--leaks", action="store_true", default=False, |
| help="Enable leaks checking (OS X and Gtk+ only)"), |
| optparse.make_option("-g", "--guard-malloc", action="store_true", default=False, |
| help="Enable Guard Malloc (OS X only)"), |
| optparse.make_option("--threaded", action="store_true", default=False, |
| help="Run a concurrent JavaScript thread with each test"), |
| optparse.make_option("--dump-render-tree", "-1", action="store_false", default=True, dest="webkit_test_runner", |
| help="Use DumpRenderTree rather than WebKitTestRunner."), |
| # FIXME: We should merge this w/ --build-directory and only have one flag. |
| optparse.make_option("--root", action="store", |
| help="Path to a directory containing the executables needed to run tests."), |
| ])) |
| |
| option_group_definitions.append(("Results Options", [ |
| optparse.make_option("-p", "--pixel", "--pixel-tests", action="store_true", |
| dest="pixel_tests", help="Enable pixel-to-pixel PNG comparisons"), |
| optparse.make_option("--no-pixel", "--no-pixel-tests", action="store_false", |
| dest="pixel_tests", help="Disable pixel-to-pixel PNG comparisons"), |
| optparse.make_option("--no-sample-on-timeout", action="store_false", default=True, |
| dest="sample_on_timeout", help="Don't run sample on timeout (OS X only)"), |
| optparse.make_option("--no-ref-tests", action="store_true", |
| dest="no_ref_tests", help="Skip all ref tests"), |
| optparse.make_option("--tolerance", |
| help="Ignore image differences less than this percentage (some " |
| "ports may ignore this option)", type="float"), |
| optparse.make_option("--results-directory", help="Location of test results"), |
| optparse.make_option("--build-directory", |
| help="Path to the directory under which build files are kept (should not include configuration)"), |
| optparse.make_option("--add-platform-exceptions", action="store_true", default=False, |
| help="Save generated results into the *most-specific-platform* directory rather than the *generic-platform* directory"), |
| optparse.make_option("--new-baseline", action="store_true", |
| default=False, help="Save generated results as new baselines " |
| "into the *most-specific-platform* directory, overwriting whatever's " |
| "already there. Equivalent to --reset-results --add-platform-exceptions"), |
| optparse.make_option("--reset-results", action="store_true", |
| default=False, help="Reset expectations to the " |
| "generated results in their existing location."), |
| optparse.make_option("--no-new-test-results", action="store_false", |
| dest="new_test_results", default=True, |
| help="Don't create new baselines when no expected results exist"), |
| optparse.make_option("--treat-ref-tests-as-pixel-tests", action="store_true", default=False, |
| help="Run ref tests, but treat them as if they were traditional pixel tests"), |
| |
| #FIXME: we should support a comma separated list with --pixel-test-directory as well. |
| optparse.make_option("--pixel-test-directory", action="append", default=[], dest="pixel_test_directories", |
| help="A directory where it is allowed to execute tests as pixel tests. " |
| "Specify multiple times to add multiple directories. " |
| "This option implies --pixel-tests. If specified, only those tests " |
| "will be executed as pixel tests that are located in one of the " |
| "directories enumerated with the option. Some ports may ignore this " |
| "option while others can have a default value that can be overridden here."), |
| |
| optparse.make_option("--skip-failing-tests", action="store_true", |
| default=False, help="Skip tests that are expected to fail. " |
| "Note: When using this option, you might miss new crashes " |
| "in these tests."), |
| optparse.make_option("--additional-drt-flag", action="append", |
| default=[], help="Additional command line flag to pass to DumpRenderTree " |
| "Specify multiple times to add multiple flags."), |
| optparse.make_option("--driver-name", type="string", |
| help="Alternative DumpRenderTree binary to use"), |
| optparse.make_option("--additional-platform-directory", action="append", |
| default=[], help="Additional directory where to look for test " |
| "baselines (will take precendence over platform baselines). " |
| "Specify multiple times to add multiple search path entries."), |
| optparse.make_option("--additional-expectations", action="append", default=[], |
| help="Path to a test_expectations file that will override previous expectations. " |
| "Specify multiple times for multiple sets of overrides."), |
| optparse.make_option("--compare-port", action="store", default=None, |
| help="Use the specified port's baselines first"), |
| optparse.make_option("--no-show-results", action="store_false", |
| default=True, dest="show_results", |
| help="Don't launch a browser with results after the tests " |
| "are done"), |
| optparse.make_option("--full-results-html", action="store_true", |
| default=False, |
| help="Show all failures in results.html, rather than only regressions"), |
| optparse.make_option("--clobber-old-results", action="store_true", |
| default=False, help="Clobbers test results from previous runs."), |
| optparse.make_option("--http", action="store_true", dest="http", |
| default=True, help="Run HTTP and WebSocket tests (default)"), |
| optparse.make_option("--no-http", action="store_false", dest="http", |
| help="Don't run HTTP and WebSocket tests"), |
| optparse.make_option("--no-http-servers", action="store_false", dest="start_http_servers_if_needed", |
| default=True, help="Don't start HTTP servers"), |
| optparse.make_option("--ignore-metrics", action="store_true", dest="ignore_metrics", |
| default=False, help="Ignore rendering metrics related information from test " |
| "output, only compare the structure of the rendertree."), |
| optparse.make_option("--nocheck-sys-deps", action="store_true", |
| default=False, |
| help="Don't check the system dependencies (themes)"), |
| optparse.make_option("--java", action="store_true", |
| default=False, |
| help="Build java support files"), |
| optparse.make_option("--layout-tests-directory", action="store", default=None, |
| help="Override the default layout test directory.", dest="layout_tests_dir") |
| ])) |
| |
| option_group_definitions.append(("Testing Options", [ |
| optparse.make_option("--build", dest="build", |
| action="store_true", default=True, |
| help="Check to ensure the DumpRenderTree build is up-to-date " |
| "(default)."), |
| optparse.make_option("--no-build", dest="build", |
| action="store_false", help="Don't check to see if the " |
| "DumpRenderTree build is up-to-date."), |
| optparse.make_option("-n", "--dry-run", action="store_true", |
| default=False, |
| help="Do everything but actually run the tests or upload results."), |
| optparse.make_option("--wrapper", |
| help="wrapper command to insert before invocations of " |
| "DumpRenderTree or WebKitTestRunner; option is split on whitespace before " |
| "running. (Example: --wrapper='valgrind --smc-check=all')"), |
| optparse.make_option("-i", "--ignore-tests", action="append", default=[], |
| help="directories or test to ignore (may specify multiple times)"), |
| optparse.make_option("--test-list", action="append", |
| help="read list of tests to run from file", metavar="FILE"), |
| optparse.make_option("--skipped", action="store", default="default", |
| help=("control how tests marked SKIP are run. " |
| "'default' == Skip tests unless explicitly listed on the command line, " |
| "'ignore' == Run them anyway, " |
| "'only' == only run the SKIP tests, " |
| "'always' == always skip, even if listed on the command line.")), |
| optparse.make_option("--force", action="store_true", default=False, |
| help="Run all tests with PASS as expected result, even those marked SKIP in the test list or " + \ |
| "those which are device-specific (implies --skipped=ignore)"), |
| optparse.make_option("--time-out-ms", "--timeout", |
| help="Set the timeout for each test in milliseconds"), |
| optparse.make_option("--order", action="store", default="natural", |
| help=("determine the order in which the test cases will be run. " |
| "'none' == use the order in which the tests were listed either in arguments or test list, " |
| "'natural' == use the natural order (default), " |
| "'random' == randomize the test order.")), |
| optparse.make_option("--run-chunk", |
| help=("Run a specified chunk (n:l), the nth of len l, " |
| "of the layout tests")), |
| optparse.make_option("--run-part", help=("Run a specified part (n:m), " |
| "the nth of m parts, of the layout tests")), |
| optparse.make_option("--batch-size", |
| help=("Run a the tests in batches (n), after every n tests, " |
| "DumpRenderTree is relaunched."), type="int", default=None), |
| optparse.make_option("--run-singly", action="store_true", |
| default=False, help="run a separate DumpRenderTree for each test (implies --verbose)"), |
| optparse.make_option("--child-processes", |
| help="Number of DumpRenderTrees to run in parallel."), |
| # FIXME: Display default number of child processes that will run. |
| optparse.make_option("-f", "--fully-parallel", action="store_true", |
| help="run all tests in parallel"), |
| optparse.make_option("--exit-after-n-failures", type="int", default=None, |
| help="Exit after the first N failures instead of running all " |
| "tests"), |
| optparse.make_option("--exit-after-n-crashes-or-timeouts", type="int", |
| default=None, help="Exit after the first N crashes instead of " |
| "running all tests"), |
| optparse.make_option("--iterations", type="int", default=1, help="Number of times to run the set of tests (e.g. ABCABCABC)"), |
| optparse.make_option("--repeat-each", type="int", default=1, help="Number of times to run each test (e.g. AAABBBCCC)"), |
| optparse.make_option("--retry-failures", action="store_true", |
| default=True, |
| help="Re-try any tests that produce unexpected results (default)"), |
| optparse.make_option("--no-retry-failures", action="store_false", |
| dest="retry_failures", |
| help="Don't re-try any tests that produce unexpected results."), |
| optparse.make_option("--max-locked-shards", type="int", default=0, |
| help="Set the maximum number of locked shards"), |
| optparse.make_option("--additional-env-var", type="string", action="append", default=[], |
| help="Passes that environment variable to the tests (--additional-env-var=NAME=VALUE)"), |
| optparse.make_option("--profile", action="store_true", |
| help="Output per-test profile information."), |
| optparse.make_option("--profiler", action="store", |
| help="Output per-test profile information, using the specified profiler."), |
| optparse.make_option("--no-timeout", action="store_true", default=False, help="Disable test timeouts"), |
| optparse.make_option('--display-server', choices=['xvfb', 'xorg', 'weston', 'wayland'], default='xvfb', |
| help='"xvfb": Use a virtualized X11 server. "xorg": Use the current X11 session. ' |
| '"weston": Use a virtualized Weston server. "wayland": Use the current wayland session.'), |
| optparse.make_option("--world-leaks", action="store_true", default=False, help="Check for world leaks (currently, only documents). Differs from --leaks in that this uses internal instrumentation, rather than external tools."), |
| ])) |
| |
| option_group_definitions.append(("iOS Options", [ |
| optparse.make_option('--no-install', action='store_const', const=False, default=True, dest='install', |
| help='Skip install step for device and simulator testing'), |
| optparse.make_option('--version', help='Specify the version of iOS to be used. By default, this will adopt the runtime for iOS Simulator.'), |
| optparse.make_option('--device-type', help='iOS Simulator device type identifier (default: i386 -> iPhone 5, x86_64 -> iPhone SE)'), |
| optparse.make_option('--dedicated-simulators', action="store_true", default=False, |
| help="If set, dedicated iOS simulators will always be created. If not set, the script will attempt to use any currently running simulator."), |
| optparse.make_option('--show-touches', action="store_true", default=False, help="If set, a small dot will be shown where the generated touches are. Helpful for debugging touch tests."), |
| ])) |
| |
| option_group_definitions.append(("Miscellaneous Options", [ |
| optparse.make_option( |
| "--lint-test-files", action="store_true", default=False, |
| help=("Makes sure the test files parse for all configurations. Does not run any tests.")), |
| optparse.make_option( |
| "--print-expectations", action="store_true", default=False, |
| help=("Print the expected outcome for the given test, or all tests listed in TestExpectations. Does not run any tests.")), |
| optparse.make_option( |
| "--webgl-test-suite", action="store_true", default=False, |
| help=("Run exhaustive webgl list, including test ordinarily skipped for performance reasons. Equivalent to '--additional-expectations=LayoutTests/webgl/TestExpectations webgl'")), |
| ])) |
| |
| option_group_definitions.append(("Web Platform Test Server Options", [ |
| optparse.make_option("--wptserver-doc-root", type="string", help=("Set web platform server document root, relative to LayoutTests directory")), |
| ])) |
| |
| # FIXME: Remove this group once the old results dashboards are deprecated. |
| option_group_definitions.append(("Legacy Result Options", [ |
| optparse.make_option("--master-name", help="The name of the buildbot master."), |
| optparse.make_option("--build-name", default="DUMMY_BUILD_NAME", |
| help=("The name of the builder used in its path, e.g. webkit-rel.")), |
| optparse.make_option("--build-slave", default="DUMMY_BUILD_SLAVE", |
| help=("The name of the buildslave used. e.g. apple-macpro-6.")), |
| optparse.make_option("--test-results-server", action="append", default=[], |
| help=("If specified, upload results json files to this appengine server.")), |
| optparse.make_option("--results-server-host", action="append", default=[], |
| help=("If specified, upload results JSON file to this results server.")), |
| optparse.make_option("--additional-repository-name", |
| help=("The name of an additional subversion or git checkout")), |
| optparse.make_option("--additional-repository-path", |
| help=("The path to an additional subversion or git checkout (requires --additional-repository-name)")), |
| optparse.make_option("--allowed-host", type="string", action="append", default=[], |
| help=("If specified, tests are allowed to make requests to the specified hostname.")) |
| ])) |
| |
| option_group_definitions.append(('Upload Options', upload_options())) |
| |
| option_parser = optparse.OptionParser(usage="%prog [options] [<path>...]") |
| |
| for group_name, group_options in option_group_definitions: |
| option_group = optparse.OptionGroup(option_parser, group_name) |
| option_group.add_options(group_options) |
| option_parser.add_option_group(option_group) |
| |
| options, args = option_parser.parse_args(args) |
| if options.webgl_test_suite: |
| if not args: |
| args.append('webgl') |
| host = Host() |
| host.initialize_scm() |
| options.additional_expectations.insert(0, host.filesystem.join(host.scm().checkout_root, 'LayoutTests/webgl/TestExpectations')) |
| return options, args |
| |
| |
| def _print_expectations(port, options, args, logging_stream): |
| logger = logging.getLogger() |
| logger.setLevel(logging.DEBUG if options.debug_rwt_logging else logging.INFO) |
| try: |
| printer = printing.Printer(port, options, logging_stream, logger=logger) |
| |
| _set_up_derived_options(port, options) |
| manager = Manager(port, options, printer) |
| |
| exit_code = manager.print_expectations(args) |
| _log.debug("Printing expectations completed, Exit status: %d", exit_code) |
| return exit_code |
| except Exception as error: |
| _log.error('Error printing expectations: {}'.format(error)) |
| finally: |
| printer.cleanup() |
| return -1 |
| |
| |
| def _set_up_derived_options(port, options): |
| """Sets the options values that depend on other options values.""" |
| if not options.child_processes: |
| options.child_processes = os.environ.get('WEBKIT_TEST_CHILD_PROCESSES') |
| |
| if not options.configuration: |
| options.configuration = port.default_configuration() |
| |
| if options.pixel_tests is None: |
| options.pixel_tests = port.default_pixel_tests() |
| |
| if not options.time_out_ms: |
| options.time_out_ms = str(port.default_timeout_ms()) |
| |
| options.slow_time_out_ms = str(5 * int(options.time_out_ms)) |
| |
| if options.additional_platform_directory: |
| additional_platform_directories = [] |
| for path in options.additional_platform_directory: |
| additional_platform_directories.append(port.host.filesystem.abspath(path)) |
| options.additional_platform_directory = additional_platform_directories |
| |
| if options.force: |
| if options.skipped not in ('ignore', 'default'): |
| _log.warning("--force overrides --skipped=%s" % (options.skipped)) |
| options.skipped = 'ignore' |
| |
| if not options.http and options.skipped in ('ignore', 'only'): |
| _log.warning("--force/--skipped=%s overrides --no-http." % (options.skipped)) |
| options.http = True |
| |
| if options.ignore_metrics and (options.new_baseline or options.reset_results): |
| _log.warning("--ignore-metrics has no effect with --new-baselines or with --reset-results") |
| |
| if options.new_baseline: |
| options.reset_results = True |
| options.add_platform_exceptions = True |
| |
| if options.pixel_test_directories: |
| options.pixel_tests = True |
| varified_dirs = set() |
| pixel_test_directories = options.pixel_test_directories |
| for directory in pixel_test_directories: |
| # FIXME: we should support specifying the directories all the ways we support it for additional |
| # arguments specifying which tests and directories to run. We should also move the logic for that |
| # to Port. |
| filesystem = port.host.filesystem |
| if not filesystem.isdir(filesystem.join(port.layout_tests_dir(), directory)): |
| _log.warning("'%s' was passed to --pixel-test-directories, which doesn't seem to be a directory" % str(directory)) |
| else: |
| varified_dirs.add(directory) |
| |
| options.pixel_test_directories = list(varified_dirs) |
| |
| if options.run_singly: |
| options.verbose = True |
| |
| # The GTK+ and WPE ports only support WebKit2 so they always use WKTR. |
| if options.platform in ["gtk", "wpe"]: |
| options.webkit_test_runner = True |
| |
| if options.leaks: |
| options.additional_env_var.append("JSC_usePoisoning=0") |
| options.additional_env_var.append("__XPC_JSC_usePoisoning=0") |
| |
| def run(port, options, args, logging_stream): |
| logger = logging.getLogger() |
| logger.setLevel(logging.DEBUG if options.debug_rwt_logging else logging.INFO) |
| |
| try: |
| printer = printing.Printer(port, options, logging_stream, logger=logger) |
| |
| _set_up_derived_options(port, options) |
| manager = Manager(port, options, printer) |
| printer.print_config(port.results_directory()) |
| |
| run_details = manager.run(args) |
| _log.debug("Testing completed, Exit status: %d" % run_details.exit_code) |
| return run_details |
| finally: |
| printer.cleanup() |
| |
| if __name__ == '__main__': |
| sys.exit(main(sys.argv[1:], sys.stdout, sys.stderr)) |
