Bug 1908788 - Correctly locate geckodriver binary for mach wpt on Android, r=webdriver-reviewers,whimboo

The functional change here is searching the host binary directory as
well as the dist directory.

The code is also refactored a bit to split the firefox_android
processing into its own function, like for desktop Firefox, and to
share the geckodriver search code through a helper.

Differential Revision: https://phabricator.services.mozilla.com/D217978

Author: jgraham

testing/web-platform/mach_commands.py

@@ -33,48 +33,12 @@ def kwargs_common(self, kwargs):
 
         tests_src_path = os.path.join(self._here, "tests")
 
-        if (
-            kwargs["product"] in {"firefox", "firefox_android"}
-            and kwargs["specialpowers_path"] is None
-        ):
-            kwargs["specialpowers_path"] = os.path.join(
-                self.distdir, "xpi-stage", "[email protected]"
-            )
-
-        if kwargs["product"] == "firefox_android":
-            # package_name may be different in the future
-            package_name = kwargs["package_name"]
-            if not package_name:
-                kwargs[
-                    "package_name"
-                ] = package_name = "org.mozilla.geckoview.test_runner"
-
-            # Note that this import may fail in non-firefox-for-android trees
-            from mozrunner.devices.android_device import (
-                InstallIntent,
-                get_adb_path,
-                verify_android_device,
-            )
-
-            kwargs["adb_binary"] = get_adb_path(self)
-            install = (
-                InstallIntent.NO if kwargs.pop("no_install") else InstallIntent.YES
-            )
-            verify_android_device(
-                self, install=install, verbose=False, xre=True, app=package_name
-            )
-
-            if kwargs["certutil_binary"] is None:
-                kwargs["certutil_binary"] = os.path.join(
-                    os.environ.get("MOZ_HOST_BIN"), "certutil"
+        if kwargs["product"] in {"firefox", "firefox_android"}:
+            if kwargs["specialpowers_path"] is None:
+                kwargs["specialpowers_path"] = os.path.join(
+                    self.distdir, "xpi-stage", "[email protected]"
                 )
 
-            if kwargs["install_fonts"] is None:
-                kwargs["install_fonts"] = True
-
-            if not kwargs["device_serial"]:
-                kwargs["device_serial"] = ["emulator-5554"]
-
         if kwargs["config"] is None:
             kwargs["config"] = os.path.join(
                 self.topobjdir, "_tests", "web-platform", "wptrunner.local.ini"
@@ -118,27 +82,11 @@ def kwargs_firefox(self, kwargs):
         if kwargs["binary"] is None:
             kwargs["binary"] = self.get_binary_path()
 
-        if kwargs["certutil_binary"] is None:
-            kwargs["certutil_binary"] = self.get_binary_path("certutil")
-
         if kwargs["webdriver_binary"] is None:
-            try_paths = [self.get_binary_path("geckodriver", validate_exists=False)]
-            ext = ".exe" if sys.platform in ["win32", "msys", "cygwin"] else ""
-            for build_type in ["release", "debug"]:
-                try_paths.append(
-                    os.path.join(
-                        self.topsrcdir, "target", build_type, f"geckodriver{ext}"
-                    )
-                )
-            found_paths = []
-            for path in try_paths:
-                if os.path.exists(path):
-                    found_paths.append(path)
+            kwargs["webdriver_binary"] = self.find_webdriver_binary()
 
-            if found_paths:
-                # Pick the most recently modified version
-                found_paths.sort(key=os.path.getmtime)
-                kwargs["webdriver_binary"] = found_paths[-1]
+        if kwargs["certutil_binary"] is None:
+            kwargs["certutil_binary"] = self.get_binary_path("certutil")
 
         if kwargs["install_fonts"] is None:
             kwargs["install_fonts"] = True
@@ -156,6 +104,47 @@ def kwargs_firefox(self, kwargs):
 
         return kwargs
 
+    def kwargs_firefox_android(self, kwargs):
+        from wptrunner import wptcommandline
+
+        kwargs = self.kwargs_common(kwargs)
+
+        # package_name may be different in the future
+        package_name = kwargs["package_name"]
+        if not package_name:
+            kwargs["package_name"] = package_name = "org.mozilla.geckoview.test_runner"
+
+        # Note that this import may fail in non-firefox-for-android trees
+        from mozrunner.devices.android_device import (
+            InstallIntent,
+            get_adb_path,
+            verify_android_device,
+        )
+
+        kwargs["adb_binary"] = get_adb_path(self)
+        install = InstallIntent.NO if kwargs.pop("no_install") else InstallIntent.YES
+        verify_android_device(
+            self, install=install, verbose=False, xre=True, app=package_name
+        )
+
+        if kwargs["webdriver_binary"] is None:
+            kwargs["webdriver_binary"] = self.find_webdriver_binary()
+
+        if kwargs["certutil_binary"] is None:
+            kwargs["certutil_binary"] = os.path.join(
+                os.environ.get("MOZ_HOST_BIN"), "certutil"
+            )
+
+        if kwargs["install_fonts"] is None:
+            kwargs["install_fonts"] = True
+
+        if not kwargs["device_serial"]:
+            kwargs["device_serial"] = ["emulator-5554"]
+
+        kwargs = wptcommandline.check_args(kwargs)
+
+        return kwargs
+
     def kwargs_wptrun(self, kwargs):
         """Setup kwargs for wpt-run which is only used for non-gecko browser products"""
         from tools.wpt import run, virtualenv
@@ -233,6 +222,27 @@ def setup_fonts_firefox(self):
             with open(ahem_src, "rb") as src, open(ahem_dest, "wb") as dest:
                 dest.write(src.read())
 
+    def find_webdriver_binary(self):
+        ext = ".exe" if sys.platform in ["win32", "msys", "cygwin"] else ""
+        try_paths = [
+            self.get_binary_path("geckodriver", validate_exists=False),
+            os.path.join(self.topobjdir, "dist", "host", "bin", f"geckodriver{ext}"),
+        ]
+
+        for build_type in ["release", "debug"]:
+            try_paths.append(
+                os.path.join(self.topsrcdir, "target", build_type, f"geckodriver{ext}")
+            )
+        found_paths = []
+        for path in try_paths:
+            if os.path.exists(path):
+                found_paths.append(path)
+
+        if found_paths:
+            # Pick the most recently modified version
+            found_paths.sort(key=os.path.getmtime)
+            return found_paths[-1]
+
 
 class WebPlatformTestsServeRunner(MozbuildObject):
     def run(self, **kwargs):

testing/web-platform/mach_commands_base.py

@@ -50,9 +50,7 @@ def run(self, logger, **kwargs):
                 logger.info(e.help())
                 return 1
         elif kwargs["product"] == "firefox_android":
-            from wptrunner import wptcommandline
-
-            kwargs = wptcommandline.check_args(self.setup.kwargs_common(kwargs))
+            kwargs = self.setup.kwargs_firefox_android(kwargs)
         else:
             kwargs = self.setup.kwargs_wptrun(kwargs)