added support for other chromium-based browsers

Author: ndepaola

autofill/autofill.py

@@ -1,20 +1,29 @@
-import argparse
 import os
 
+import click
+
+from src.constants import browsers
 from src.driver import AutofillDriver
 from src.utils import TEXT_BOLD, TEXT_END
 
 # https://stackoverflow.com/questions/12492810/python-how-can-i-make-the-ansi-escape-codes-to-work-also-in-windows
 os.system("")  # enables ansi escape characters in terminal
 
-command_line_argument_parser = argparse.ArgumentParser(description="MPC Autofill")
-command_line_argument_parser.add_argument("--skipsetup", action="store_true", default=False, help="Skip Setup")
-command_line_args = command_line_argument_parser.parse_args()
-
 
-def main():
+@click.command()
+@click.option(
+    "--skipsetup", default=False, help="Skip project setup to continue editing an existing MPC project.", is_flag=True
+)
+@click.option(
+    "-b",
+    "--browser",
+    default="chrome",
+    type=click.Choice(sorted(browsers.keys()), case_sensitive=False),
+    help="Web browser to automate.",
+)
+def main(skipsetup, browser):
     try:
-        AutofillDriver().execute(command_line_args.skipsetup)
+        AutofillDriver(driver_callable=browsers[browser]).execute(skipsetup)
     except Exception as e:
         print(f"An uncaught exception occurred: {TEXT_BOLD}{e}{TEXT_END}")
         input("Press Enter to exit.")

autofill/readme.md

@@ -33,6 +33,9 @@ Some notes on how editing an existing project with `--skipsetup` works:
 * Any slots which have already been filled will not be refilled,
 * If an image is now allocated to more slots, the tool will fill the unfilled slots with the image from the first filled slot for that image.
 
+## Specifying Browser
+By default, the tool will configure a driver for Google Chrome. The three major Chromium-based browsers are supported (Chrome, Edge, and Brave), and you can specify which browser should be used to configure the driver with the `--browser` command line argument.
+
 ## Developer Guide
 ### Running the Source Code
 From the base repo directory:

autofill/requirements.txt

@@ -1,4 +1,5 @@
 attrs
+click
 colorama
 coverage
 defusedxml

autofill/src/constants.py

@@ -37,7 +37,16 @@
 """
 
 
+import os
 from enum import Enum
+from typing import Callable
+
+from selenium.webdriver.remote.webdriver import WebDriver
+
+import src.webdrivers as wd
+
+# Disable logging messages for webdriver_manager
+os.environ["WDM_LOG_LEVEL"] = "0"
 
 
 class States(str, Enum):
@@ -85,6 +94,15 @@ class CardTags(str, Enum):
     query = "query"
 
 
+browsers: dict[str, Callable[[bool], WebDriver]] = {
+    "chrome": wd.get_chrome_driver,
+    "brave": wd.get_brave_driver,
+    # "firefox": wd.get_firefox_driver,  # TODO: this driver is a bit buggy with the rest of the code - test thoroughly
+    "edge": wd.get_edge_driver,
+    # "opera": wd.get_opera_driver,  # TODO: this driver is a bit buggy with the rest of the code - test thoroughly
+}
+
+
 class GoogleScriptsAPIs(str, Enum):
     image_name = "https://script.google.com/macros/s/AKfycbw90rkocSdppkEuyVdsTuZNslrhd5zNT3XMgfucNMM1JjhLl-Q/exec"
     image_content = (

autofill/src/driver.py

@@ -1,21 +1,18 @@
-import os
 import textwrap
 import time
 from concurrent.futures import ThreadPoolExecutor
 from contextlib import contextmanager
-from typing import Any, Optional
+from typing import Any, Callable, Optional
 
 import attr
 import enlighten
 from selenium import webdriver
 from selenium.common import exceptions as sl_exc
 from selenium.common.exceptions import NoAlertPresentException, NoSuchElementException
-from selenium.webdriver.chrome.options import Options
-from selenium.webdriver.chrome.service import Service
 from selenium.webdriver.common.by import By
+from selenium.webdriver.remote.webdriver import WebDriver
 from selenium.webdriver.support.expected_conditions import invisibility_of_element
 from selenium.webdriver.support.ui import Select, WebDriverWait
-from webdriver_manager.chrome import ChromeDriverManager
 
 from src.constants import THREADS, States
 from src.order import CardImage, CardImageCollection, CardOrder
@@ -26,14 +23,13 @@
     alert_handler,
     time_to_hours_minutes_seconds,
 )
-
-# Disable logging messages for webdriver_manager
-os.environ["WDM_LOG_LEVEL"] = "0"
+from src.webdrivers import get_chrome_driver
 
 
 @attr.s
 class AutofillDriver:
     driver: webdriver.Chrome = attr.ib(default=None)  # delay initialisation until XML is selected and parsed
+    driver_callable: Callable[[bool], WebDriver] = attr.ib(default=get_chrome_driver)
     headless: bool = attr.ib(default=False)
     starting_url: str = attr.ib(
         init=False,
@@ -50,20 +46,14 @@ class AutofillDriver:
     # region initialisation
     def initialise_driver(self) -> None:
         try:
-            chrome_options = Options()
-            chrome_options.add_argument("--log-level=3")
-            if self.headless:
-                chrome_options.add_argument("--headless")
-            chrome_options.add_experimental_option("excludeSwitches", ["enable-logging"])
-            chrome_options.add_experimental_option("detach", True)
-            driver = webdriver.Chrome(service=Service(ChromeDriverManager().install()), options=chrome_options)
+            driver = self.driver_callable(self.headless)
             driver.set_window_size(1200, 900)
             driver.implicitly_wait(5)
-            driver.set_network_conditions(offline=False, latency=5, throughput=5 * 125000)
+            print(f"Successfully initialised {TEXT_BOLD}{driver.name}{TEXT_END} driver.")
         except ValueError as e:
             raise Exception(
-                f"An error occurred while attempting to configure Chrome webdriver. Please make sure you have "
-                f"installed Chrome and that it is up to date: {e}"
+                f"An error occurred while attempting to configure the webdriver for {self.driver.name}. "
+                f"Please make sure you have installed {self.driver.name} and that it is up to date: {e}"
             )
 
         self.driver = driver

autofill/src/webdrivers/__init__.py

@@ -0,0 +1,5 @@
+from .brave import get_brave_driver
+from .chrome import get_chrome_driver
+from .edge import get_edge_driver
+from .firefox import get_firefox_driver
+from .opera import get_opera_driver

autofill/src/webdrivers/brave.py

@@ -0,0 +1,16 @@
+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
+
+
+def get_brave_driver(headless: bool = False) -> Chrome:
+    options = Options()
+    options.add_argument("--log-level=3")
+    if headless:
+        options.add_argument("--headless")
+    options.add_experimental_option("excludeSwitches", ["enable-logging"])
+    options.add_experimental_option("detach", True)
+    driver = Chrome(service=Service(ChromeDriverManager(chrome_type=ChromeType.BRAVE).install()), options=options)
+    driver.set_network_conditions(offline=False, latency=5, throughput=5 * 125000)
+    return driver

autofill/src/webdrivers/chrome.py

@@ -0,0 +1,16 @@
+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
+
+
+def get_chrome_driver(headless: bool = False) -> Chrome:
+    options = Options()
+    options.add_argument("--log-level=3")
+    if headless:
+        options.add_argument("--headless")
+    options.add_experimental_option("excludeSwitches", ["enable-logging"])
+    options.add_experimental_option("detach", True)
+    driver = Chrome(service=Service(ChromeDriverManager().install()), options=options)
+    driver.set_network_conditions(offline=False, latency=5, throughput=5 * 125000)
+    return driver

autofill/src/webdrivers/edge.py

@@ -0,0 +1,16 @@
+from selenium.webdriver import Edge
+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) -> Edge:
+    options = Options()
+    options.add_argument("--log-level=3")
+    if headless:
+        options.add_argument("--headless")
+    options.add_experimental_option("excludeSwitches", ["enable-logging"])
+    options.add_experimental_option("detach", True)
+    driver = Edge(service=Service(EdgeChromiumDriverManager().install()), options=options)
+    driver.set_network_conditions(offline=False, latency=5, throughput=5 * 125000)
+    return driver

autofill/src/webdrivers/firefox.py

@@ -0,0 +1,13 @@
+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
+
+
+def get_firefox_driver(headless: bool = False) -> Firefox:
+    options = Options()
+    options.add_argument("--log-level=3")
+    if headless:
+        options.add_argument("--headless")
+    driver = Firefox(service=Service(GeckoDriverManager().install()), options=options)
+    return driver

autofill/src/webdrivers/opera.py

@@ -0,0 +1,12 @@
+from selenium.webdriver import Opera
+from selenium.webdriver.opera.options import Options
+from webdriver_manager.opera import OperaDriverManager
+
+
+def get_opera_driver(headless: bool = False) -> Opera:
+    options = Options()
+    options.add_argument("--log-level=3")
+    if headless:
+        options.add_argument("--headless")
+    driver = Opera(executable_path=OperaDriverManager().install(), options=options)
+    return driver