Update how python finds the driver and browser in tests

Author: shs96c

py/BUILD.bazel

@@ -72,6 +72,7 @@ BROWSER_VERSIONS = [
 
 TEST_DEPS = [
     requirement("attrs"),
+    requirement("bazel_runfiles"),
     requirement("debugpy"),
     requirement("filetype"),
     requirement("idna"),

py/conftest.py

@@ -20,6 +20,7 @@
 import socket
 import subprocess
 import time
+from runfiles import Runfiles
 from test.selenium.webdriver.common.network import get_lan_ip
 from test.selenium.webdriver.common.webserver import SimpleWebServer
 from urllib.request import urlopen
@@ -191,6 +192,16 @@ def get_options(driver_class, config):
     bidi = bool(config.option.bidi)
     options = None
 
+    # Check to see if the `browser_path` exists
+    if browser_path:
+        if not os.path.exists(browser_path):
+            # Maybe it's hiding in the runfiles
+            r = Runfiles.Create()
+            rlocation_path = r.Rlocation(browser_path)
+            if not os.path.exists(rlocation_path):
+                raise Exception("Unable to find browser at " + browser_path)
+            browser_path = rlocation_path
+
     if browser_path or browser_args:
         if not options:
             options = getattr(webdriver, f"{driver_class}Options")()
@@ -226,6 +237,14 @@ def get_service(driver_class, executable):
     if not executable:
         return None
 
+    # Make sure the executable exists
+    if not os.path.exists(executable):
+        r = Runfiles.Create()
+        rlocation_path = r.Rlocation(executable)
+        if not os.path.exists(rlocation_path):
+            raise Exception("Unable to find driver executable: " + executable)
+        executable = rlocation_path
+
     module = getattr(webdriver, driver_class.lower())
     service = module.service.Service(executable_path=executable)
 

py/private/browsers.bzl

@@ -15,40 +15,40 @@ headless_args = select({
 
 chrome_args = select({
     "@selenium//common:use_pinned_linux_chrome": [
-        "--driver-binary=$(location @linux_chromedriver//:chromedriver)",
-        "--browser-binary=$(location @linux_chrome//:chrome-linux64/chrome)",
+        "--driver-binary=$(rlocationpath @linux_chromedriver//:chromedriver)",
+        "--browser-binary=$(rlocationpath @linux_chrome//:chrome-linux64/chrome)",
         "--browser-args=--disable-dev-shm-usage",
         "--browser-args=--no-sandbox",
     ],
     "@selenium//common:use_pinned_macos_chrome": [
-        "--driver-binary=$(location @mac_chromedriver//:chromedriver)",
-        "--browser-binary=$(location @mac_chrome//:Chrome.app)/Contents/MacOS/Chrome",
+        "--driver-binary=$(rlocationpath @mac_chromedriver//:chromedriver)",
+        "--browser-binary=$(rlocationpath @mac_chrome//:Chrome.app)/Contents/MacOS/Chrome",
     ],
     "//conditions:default": [],
 }) + headless_args
 
 edge_args = select({
     "@selenium//common:use_pinned_linux_edge": [
-        "--driver-binary=$(location @linux_edgedriver//:msedgedriver)",
-        "--browser-binary=$(location @linux_edge//:opt/microsoft/msedge/microsoft-edge)",
+        "--driver-binary=$(rlocationpath @linux_edgedriver//:msedgedriver)",
+        "--browser-binary=$(rlocationpath @linux_edge//:opt/microsoft/msedge/microsoft-edge)",
         "--browser-args=--disable-dev-shm-usage",
         "--browser-args=--no-sandbox",
     ],
     "@selenium//common:use_pinned_macos_edge": [
-        "--driver-binary=$(location @mac_edgedriver//:msedgedriver)",
-        "--browser-binary='$(location @mac_edge//:Edge.app)/Contents/MacOS/Microsoft Edge'",
+        "--driver-binary=$(rlocationpath @mac_edgedriver//:msedgedriver)",
+        "--browser-binary='$(rlocationpath @mac_edge//:Edge.app)/Contents/MacOS/Microsoft Edge'",
     ],
     "//conditions:default": [],
 }) + headless_args
 
 firefox_args = select({
     "@selenium//common:use_pinned_linux_firefox": [
-        "--driver-binary=$(location @linux_geckodriver//:geckodriver)",
-        "--browser-binary=$(location @linux_firefox//:firefox/firefox)",
+        "--driver-binary=$(rlocationpath @linux_geckodriver//:geckodriver)",
+        "--browser-binary=$(rlocationpath @linux_firefox//:firefox/firefox)",
     ],
     "@selenium//common:use_pinned_macos_firefox": [
-        "--driver-binary=$(location @mac_geckodriver//:geckodriver)",
-        "--browser-binary=$(location @mac_firefox//:Firefox.app)/Contents/MacOS/firefox",
+        "--driver-binary=$(rlocationpath @mac_geckodriver//:geckodriver)",
+        "--browser-binary=$(rlocationpath @mac_firefox//:Firefox.app)/Contents/MacOS/firefox",
     ],
     "//conditions:default": [],
 }) + headless_args

py/requirements.txt

@@ -1,5 +1,6 @@
 async-generator==1.10
 attrs==23.2.0
+bazel_runfiles==1.2.0
 certifi==2023.11.17
 cffi==1.16.0
 cryptography==42.0.8

py/requirements_lock.txt

@@ -18,6 +18,9 @@ attrs==23.2.0 \
     #   -r py/requirements.txt
     #   outcome
     #   trio
+bazel-runfiles==1.2.0 \
+    --hash=sha256:08cb0c7e43c260fa5b1a6ab88ddba79d0e6f85c365483bf26aab74713bbdb2df
+    # via -r py/requirements.txt
 certifi==2023.11.17 \
     --hash=sha256:9b469f3a900bf28dc19b8cfbf8019bf47f7fdd1a65a1d4ffb98fc14166beb4d1 \
     --hash=sha256:e036ab49d5b79556f99cfc2d9320b34cfbe5be05c5871b51de9329f0603b0474
@@ -288,9 +291,7 @@ jaraco-classes==3.3.0 \
 jeepney==0.8.0 \
     --hash=sha256:5efe48d255973902f6badc3ce55e2aa6c5c3b3bc642059ef3a91247bcfcc5806 \
     --hash=sha256:c0a454ad016ca575060802ee4d590dd912e35c122fa04e70306de3d076cce755
-    # via
-    #   keyring
-    #   secretstorage
+    # via secretstorage
 keyring==24.3.0 \
     --hash=sha256:4446d35d636e6a10b8bce7caa66913dd9eca5fd222ca03a3d42c38608ac30836 \
     --hash=sha256:e730ecffd309658a08ee82535a3b5ec4b4c8669a9be11efb66249d8e0aeb9a25
@@ -518,9 +519,7 @@ rich==13.7.0 \
 secretstorage==3.3.3 \
     --hash=sha256:2403533ef369eca6d2ba81718576c5e0f564d5cca1b58f73a8b23e7d4eeebd77 \
     --hash=sha256:f356e6628222568e3af06f2eba8df495efa13b3b63081dafd4f7d9a7b7bc9f99
-    # via
-    #   -r py/requirements.txt
-    #   keyring
+    # via -r py/requirements.txt
 sniffio==1.3.1 \
     --hash=sha256:2f6da418d1f1e0fddd844478f41680e794e6051915791a034ff65e5f100525a2 \
     --hash=sha256:f4324edc670a0f49750a81b895f35c3adb843cca46f0530f79fc1babb23789dc