Merge pull request #192 from chilli-axe/switch-to-selenium-built-in-webdriver-manager

Switch to selenium's built-in webdriver manager from `webdriver_manager`

Author: ndepaola

.github/workflows/test-desktop-tool.yml

@@ -7,7 +7,13 @@ on:
 jobs:
   test-backend:
     name: Desktop tool tests
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        include:
+          - os: macos-latest
+          - os: windows-latest
+          - os: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
       - uses: ./.github/actions/test-desktop-tool

.github/workflows/tests.yml

@@ -28,7 +28,13 @@ jobs:
           google-drive-api-key: ${{ secrets.GOOGLE_DRIVE_API_KEY }}
   test-desktop-tool:
     name: Desktop tool tests
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        include:
+          - os: macos-latest
+          - os: windows-latest
+          - os: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
       - uses: ./.github/actions/test-desktop-tool

.pre-commit-config.yaml

@@ -38,7 +38,6 @@ repos:
             "pytest~=7.3",
             "ratelimit~=2.2",
             # desktop tool
-            "aenum~=3.1.15",
             "attrs~=23.1",
             "click==8.0.4",
             "enlighten~=1.11",

MPCAutofill/requirements.txt

@@ -29,7 +29,7 @@ pytest-elasticsearch~=3.0
 python-dotenv~=1.0.0
 ratelimit~=2.2.1
 requests~=2.31.0
-selenium~=4.11.0
+selenium~=4.14.0
 sentry-sdk~=1.30.0
 syrupy~=3.0
 tqdm~=4.65.0

desktop-tool/requirements.txt

@@ -14,6 +14,5 @@ pytest-retry~=1.5
 ratelimit~=2.2.1
 requests~=2.31.0
 sanitize-filename~=1.2.0
-selenium~=4.11.0
-webdriver-manager==4.0.1
+selenium~=4.14.0
 wakepy==0.6.0

desktop-tool/src/webdrivers/brave.py

@@ -1,10 +1,8 @@
+import sys
 from typing import Optional
 
 from selenium.webdriver import Chrome
 from selenium.webdriver.chrome.options import Options
-from selenium.webdriver.chrome.service import Service
-from webdriver_manager.chrome import ChromeDriverManager, ChromeType
-from webdriver_manager.core.os_manager import OperationSystemManager, OSType
 
 
 def get_brave_driver(headless: bool = False, binary_location: Optional[str] = None) -> Chrome:
@@ -13,23 +11,25 @@ def get_brave_driver(headless: bool = False, binary_location: Optional[str] = No
     options.add_argument("--log-level=3")
     options.add_argument("--disable-dev-shm-usage")
     if headless:
-        options.headless = True
+        options.add_argument("--headless=new")
     options.add_experimental_option("excludeSwitches", ["enable-logging"])
     options.add_experimental_option("detach", True)
 
-    # the binary location for brave must be manually specified
-    # the below code block is partially borrowed from webdriver-manager tests:
-    # https://github.com/SergeyPirogov/webdriver_manager/blob/master/tests/test_brave_driver.py
+    # the binary location for brave must be manually specified (otherwise chrome will open instead)
     if binary_location is not None:
         options.binary_location = binary_location
     else:
-        default_binary_location = {
-            OSType.LINUX: "/usr/bin/brave-browser",
-            OSType.MAC: "/Applications/Brave Browser.app/Contents/MacOS/Brave Browser",
-            OSType.WIN: "C:\\Program Files\\BraveSoftware\\Brave-Browser\\Application\\brave.exe",
-        }[OperationSystemManager.get_os_name()]
-        options.binary_location = default_binary_location
+        default_binary_locations = {
+            "linux": "/usr/bin/brave-browser",
+            "darwin": "/Applications/Brave Browser.app/Contents/MacOS/Brave Browser",
+            "win32": "C:\\Program Files\\BraveSoftware\\Brave-Browser\\Application\\brave.exe",
+        }
+        if sys.platform not in default_binary_locations.keys():
+            raise KeyError(
+                f"Cannot determine the default Brave binary location for the operating system {sys.platform}!"
+            )
+        options.binary_location = default_binary_locations[sys.platform]
 
-    driver = Chrome(service=Service(ChromeDriverManager(chrome_type=ChromeType.BRAVE).install()), options=options)  # type: ignore
+    driver = Chrome(options=options)
     driver.set_network_conditions(offline=False, latency=5, throughput=5 * 125000)
     return driver

desktop-tool/src/webdrivers/chrome.py

@@ -2,9 +2,6 @@
 
 from selenium.webdriver import Chrome
 from selenium.webdriver.chrome.options import Options
-from selenium.webdriver.chrome.service import Service
-from webdriver_manager.chrome import ChromeDriverManager
-from webdriver_manager.core.os_manager import OperationSystemManager, OSType
 
 
 def get_chrome_driver(headless: bool = False, binary_location: Optional[str] = None) -> Chrome:
@@ -13,19 +10,11 @@ def get_chrome_driver(headless: bool = False, binary_location: Optional[str] = N
     options.add_argument("--log-level=3")
     options.add_argument("--disable-dev-shm-usage")
     if headless:
-        options.headless = True
+        options.add_argument("--headless=new")
     options.add_experimental_option("excludeSwitches", ["enable-logging"])
     options.add_experimental_option("detach", True)
     if binary_location is not None:
         options.binary_location = binary_location
-    else:
-        # here, we specifically hardcode the binary location in macOS to work around this issue:
-        # https://github.com/seleniumHQ/selenium/issues/12381, which is caused by
-        # https://github.com/GoogleChromeLabs/chrome-for-testing/issues/30
-        # the issue is marked as resolved in the selenium repository but still occurs for me on selenium==4.11.2
-        # perhaps something is broken on the webdriver_manager side here
-        if OperationSystemManager.get_os_name() == OSType.MAC:
-            options.binary_location = "/Applications/Google Chrome.app/Contents/MacOS/Google Chrome"
-    driver = Chrome(service=Service(ChromeDriverManager().install()), options=options)  # type: ignore
+    driver = Chrome(options=options)
     driver.set_network_conditions(offline=False, latency=5, throughput=5 * 125000)
     return driver

desktop-tool/src/webdrivers/edge.py

@@ -4,8 +4,6 @@
 from selenium.webdriver.chromium.options import ChromiumOptions
 from selenium.webdriver.chromium.webdriver import ChromiumDriver
 from selenium.webdriver.edge.options import Options
-from selenium.webdriver.edge.service import Service
-from webdriver_manager.microsoft import EdgeChromiumDriverManager
 
 
 def get_edge_driver(headless: bool = False, binary_location: Optional[str] = None) -> ChromiumDriver:
@@ -14,11 +12,11 @@ def get_edge_driver(headless: bool = False, binary_location: Optional[str] = Non
     options.add_argument("--log-level=3")
     options.add_argument("--disable-dev-shm-usage")
     if headless:
-        options.headless = True
+        options.add_argument("--headless=new")
     options.add_experimental_option("excludeSwitches", ["enable-logging"])
     options.add_experimental_option("detach", True)
     if binary_location is not None:
         options.binary_location = binary_location
-    driver: ChromiumDriver = Edge(service=Service(EdgeChromiumDriverManager().install()), options=options)  # type: ignore
+    driver: ChromiumDriver = Edge(options=options)  # type: ignore
     driver.set_network_conditions(offline=False, latency=5, throughput=5 * 125000)
     return driver

desktop-tool/src/webdrivers/firefox.py

@@ -2,8 +2,6 @@
 
 from selenium.webdriver import Firefox
 from selenium.webdriver.firefox.options import Options
-from selenium.webdriver.firefox.service import Service
-from webdriver_manager.firefox import GeckoDriverManager
 
 
 # note: firefox is not currently supported
@@ -14,5 +12,5 @@ def get_firefox_driver(headless: bool = False, binary_location: Optional[str] =
         options.add_argument("--headless")
     if binary_location is not None:
         options.binary_location = binary_location
-    driver = Firefox(service=Service(GeckoDriverManager().install()), options=options)  # type: ignore
+    driver = Firefox(options=options)
     return driver

desktop-tool/tests/test_desktop_client.py

@@ -890,7 +890,7 @@ def do_nothing(_):
 
 
 @pytest.mark.flaky(retries=3, delay=1)
-@pytest.mark.parametrize("browser", [constants.Browsers.chrome])
+@pytest.mark.parametrize("browser", [constants.Browsers.chrome, constants.Browsers.edge])
 @pytest.mark.parametrize(
     "site",
     [