wpt: Properly process the --headless argument (servo#40289)

Instead of ignoring the `--headless` argument to the WPT test runner,
properly use it to turno on headless mode in Servo when its provided.
Additionally, when more than a single test is run, turn on headless mode
automatically to preserve existing behavior.

Although this change is for the legacy test driver, this will allow the
WebDriver test runner to run properly without providing the `--headless`
argument.

Testing: This modifies the way the test harness works, but the test
harness is untested.

Signed-off-by: Martin Robinson <[email protected]>

Author: mrobinson

python/wpt/run.py

@@ -110,6 +110,8 @@ def run_tests(default_binary_path: str, **kwargs: Any) -> int:
         file_ext = os.path.splitext(kwargs["test_list"][0])[1].lower()
         if file_ext in [".htm", ".html", ".js", ".xhtml", ".xht", ".py"]:
             use_mach_logging = True
+    else:
+        kwargs["headless"] = True
 
     if use_mach_logging:
         logger = wptrunner.setup_logging(kwargs, {"mach": sys.stdout})

tests/wpt/meta/MANIFEST.json

@@ -533229,7 +533229,7 @@
         ]
        },
        "servo.py": [
-        "2928ffb7f1d483cff60dd17ffd92a53c9b1c3148",
+        "b8cfd54ef61e5cdde9bef4e3673e508759adc566",
         []
        ],
        "servodriver.py": [
@@ -533295,7 +533295,7 @@
         []
        ],
        "executorservo.py": [
-        "d983cf048ed6dfe1c07fdcac4f3465f116a00c58",
+        "9571b4d6e379ff08aefd2025c42245c6819ac50a",
         []
        ],
        "executorservodriver.py": [

tests/wpt/tests/tools/wptrunner/wptrunner/browsers/servo.py

@@ -51,6 +51,7 @@ def executor_kwargs(logger, test_type, test_environment, run_info_data,
                     **kwargs):
     rv = base_executor_kwargs(test_type, test_environment, run_info_data, **kwargs)
     rv["pause_after_test"] = kwargs["pause_after_test"]
+    rv["headless"] = kwargs.get("headless", False)
     if test_type == "wdspec":
         rv["capabilities"] = {}
     return rv

tests/wpt/tests/tools/wptrunner/wptrunner/executors/executorservo.py

@@ -28,7 +28,8 @@
 
 
 class ServoExecutor(ProcessTestExecutor):
-    def __init__(self, logger, browser, server_config, timeout_multiplier, debug_info,
+    def __init__(self, logger, browser, server_config, headless: bool,
+                timeout_multiplier, debug_info,
                  pause_after_test, reftest_screenshot="unexpected"):
         ProcessTestExecutor.__init__(self, logger, browser, server_config,
                                      timeout_multiplier=timeout_multiplier,
@@ -37,6 +38,7 @@ def __init__(self, logger, browser, server_config, timeout_multiplier, debug_inf
         self.pause_after_test = pause_after_test
         self.environment = {}
         self.protocol = ConnectionlessProtocol(self, browser)
+        self.headless = headless
 
         self.wpt_prefs_path = self.find_wpt_prefs()
 
@@ -87,8 +89,10 @@ def build_servo_command(self, test, extra_args=None):
             # For some reason rustls does not like the certificate generated by the WPT tooling.
             "--ignore-certificate-errors",
             "--enable-experimental-web-platform-features",
-            "-z", self.test_url(test),
+            self.test_url(test),
         ]
+        if self.headless:
+            args += ["-z"]
         for stylesheet in self.browser.user_stylesheets:
             args += ["--user-stylesheet", stylesheet]
         for pref, value in self.environment.get('prefs', {}).items():
@@ -100,17 +104,16 @@ def build_servo_command(self, test, extra_args=None):
             args += extra_args
         args += self.browser.binary_args
         debug_args, command = browser_command(self.binary, args, self.debug_info)
-        if self.pause_after_test:
-            command.remove("-z")
         return debug_args + command
 
 
 class ServoTestharnessExecutor(ServoExecutor):
     convert_result = testharness_result_converter
 
-    def __init__(self, logger, browser, server_config, timeout_multiplier=1, debug_info=None,
+    def __init__(self, logger, browser, server_config, headless,
+                 timeout_multiplier=1, debug_info=None,
                  pause_after_test=False, **kwargs):
-        ServoExecutor.__init__(self, logger, browser, server_config,
+        ServoExecutor.__init__(self, logger, browser, server_config, headless,
                                timeout_multiplier=timeout_multiplier,
                                debug_info=debug_info,
                                pause_after_test=pause_after_test)
@@ -211,6 +214,7 @@ def __init__(self, logger, browser, server_config, binary=None, timeout_multipli
                                logger,
                                browser,
                                server_config,
+                               headless=True,
                                timeout_multiplier=timeout_multiplier,
                                debug_info=debug_info,
                                reftest_screenshot=reftest_screenshot,
@@ -300,13 +304,14 @@ def set_timeout(self):
 class ServoCrashtestExecutor(ServoExecutor):
     convert_result = crashtest_result_converter
 
-    def __init__(self, logger, browser, server_config, binary=None, timeout_multiplier=1,
-                 screenshot_cache=None, debug_info=None, pause_after_test=False,
-                 **kwargs):
+    def __init__(self, logger, browser, server_config, headless,
+                 binary=None, timeout_multiplier=1, screenshot_cache=None,
+                 debug_info=None, pause_after_test=False):
         ServoExecutor.__init__(self,
                                logger,
                                browser,
                                server_config,
+                               headless,
                                timeout_multiplier=timeout_multiplier,
                                debug_info=debug_info,
                                pause_after_test=pause_after_test)