setup-selenium-testing 0.2.0__py3-none-any.whl → 1.0.0__py3-none-any.whl

setup_selenium/setup_selenium.py

@@ -2,14 +2,12 @@
 
 from __future__ import annotations
 
-import errno
 import logging
 import os as os
 from enum import Enum
 from typing import TYPE_CHECKING, Optional, Union
 
 from selenium import __version__, webdriver
-from selenium.common.exceptions import NoSuchWindowException, WebDriverException
 from selenium.webdriver.chrome.service import Service as ChromeService
 from selenium.webdriver.common.selenium_manager import SeleniumManager
 from selenium.webdriver.edge.service import Service as EdgeService
@@ -18,7 +16,6 @@ from semantic_version import Version  # type: ignore[import-untyped]
 from typing_extensions import TypeAlias
 
 if TYPE_CHECKING:
-    from collections.abc import Mapping
 
     from selenium.webdriver import Chrome, Edge, Firefox
     from selenium.webdriver.common.options import ArgOptions
@@ -68,27 +65,10 @@ class Browser(str, Enum):
 ################################################################################
 ################################################################################
 class SetupSelenium:
-    DIMENSIONS: Mapping[str, tuple[int, int]] = {
-        # ratio 4:3
-        "1024": (1024, 768),
-        "1280": (1280, 960),
-        "1600": (1600, 1200),
-        "1920": (1920, 1440),
-        # ratio 16:9
-        "720": (1280, 720),
-        "1080": (1920, 1080),
-        "1440": (2560, 1440),
-        "2160": (3840, 2160),  # 4k
-        "4320": (7680, 4320),  # 8k
-    }
-
     def __init__(
         self,
         browser: Browser = Browser.CHROME,
-        baseurl: str = "",
-        timeout: int = 15,
         headless: bool = False,
-        window_size: str = "720",
         enable_log_performance: bool = False,
         enable_log_console: bool = False,
         enable_log_driver: bool = False,
@@ -99,11 +79,6 @@ class SetupSelenium:
         browser_path: str | None = None,
     ) -> None:
         log_path = os.path.abspath(os.path.expanduser(log_path))
-        self.main_window_handle: str = ""
-        self.screenshot_path: str = self.make_screenshot_path(log_path)
-        self.log_path: str = log_path
-        self.timeout: int = timeout
-        self.baseurl: str = baseurl
 
         if driver_path:
             driver_path = os.path.abspath(os.path.expanduser(driver_path))
@@ -131,35 +106,11 @@ class SetupSelenium:
             driver_path=driver_path,
         )
 
-        # driver must be setup before the following
-        self.driver.set_window_position(0, 0)
-        self.set_window_size(window_size)
-        self.set_main_window_handle()
-
-    ############################################################################
-    @staticmethod
-    def make_screenshot_path(
-        output_dir: str = "./logs", screenshots: str = "screenshots"
-    ) -> str:
-        """Set the output directory for where screenshots should go."""
-        output_dir = os.path.abspath(os.path.expanduser(output_dir))
-        if os.path.split(output_dir)[-1].lower() != screenshots:
-            output_dir = os.path.join(output_dir, screenshots)
-
-        try:
-            os.makedirs(output_dir)
-        except OSError as e:
-            if e.errno == errno.EEXIST and os.path.isdir(output_dir):
-                pass
-            else:
-                raise
-
-        return output_dir
-
     ############################################################################
     @staticmethod
     def log_options(options: ArgOptions) -> None:
         """Logs the browser option in clean format"""
+        # logger.debug(f"{json.dumps(options.capabilities, indent=2)}")  # noqa: ERA001
         opts = "\n".join(options.arguments)
         logger.debug(f"{opts}")
 
@@ -282,6 +233,24 @@ class SetupSelenium:
         options.set_preference(
             "extensions.formautofill.addresses.capture.enabled", False
         )
+        # By default, headless Firefox runs as though no pointers capabilities
+        # are available.
+        # https://github.com/microsoft/playwright/issues/7769#issuecomment-966098074
+        #
+        # This impacts React Spectrum which uses an '(any-pointer: fine)'
+        # media query to determine font size. It also causes certain chart
+        # elements to always be visible that should only be visible on
+        # hover.
+        #
+        # Available values for pointer capabilities:
+        # NO_POINTER             0x00
+        # COARSE_POINTER         0x01
+        # FINE_POINTER           0x02
+        # HOVER_CAPABLE_POINTER  0x04
+        #
+        # Setting to 0x02 | 0x04 says the system supports a mouse
+        options.set_preference("ui.primaryPointerCapabilities", 0x02 | 0x04)
+        options.set_preference("ui.allPointerCapabilities", 0x02 | 0x04)
         return options
 
     @staticmethod
@@ -338,9 +307,29 @@ class SetupSelenium:
     def chrome_options() -> webdriver.ChromeOptions:
         """Default options for chrome"""
         logger.debug("Setting up chrome options")
+        # the ultimate list of flags (created by the chromium dev group)
+        # https://peter.sh/experiments/chromium-command-line-switches/
+
         # The list of options set below mostly came from this StackOverflow post
         # https://stackoverflow.com/q/48450594/2532408
         opts = (
+            # "--disable-features=ImprovedCookieControls,LazyFrameLoading,GlobalMediaControls,DestroyProfileOnBrowserClose,MediaRouter,DialMediaRouteProvider,AcceptCHFrame,AutoExpandDetailsElement,CertificateTransparencyComponentUpdater,AvoidUnnecessaryBeforeUnloadCheckSync",  # noqa: ERA001
+            "--disable-back-forward-cache",
+            "--disable-background-timer-throttling",
+            "--disable-breakpad",
+            "--disable-component-extensions-with-background-pages",
+            "--disable-ipc-flooding-protection",
+            "--enable-features=NetworkService,NetworkServiceInProcess",
+            "--enable-logging",
+            "--export-tagged-pdf",
+            "--force-color-profile=srgb",
+            "--metrics-recording-only",
+            "--mute-audio",
+            "--remote-debugging-pipe",
+            # fixes MUI fade issue
+            "--disable-renderer-backgrounding",
+            # fixes actionchains in headless
+            "--disable-backgrounding-occluded-windows",
             "--disable-extensions",
             "--allow-running-insecure-content",
             "--ignore-certificate-errors",
@@ -378,7 +367,7 @@ class SetupSelenium:
             options.binary_location = binary
 
         if headless:
-            options.add_argument("--headless")
+            options.add_argument("--headless=new")
 
         logging_prefs = {"browser": "OFF", "performance": "OFF", "driver": "OFF"}
 
@@ -475,9 +464,29 @@ class SetupSelenium:
     def edge_options() -> webdriver.EdgeOptions:
         """Default options for edgedriver"""
         logger.debug("Setting up edge options")
+        # the ultimate list of flags (created by the chromium dev group)
+        # https://peter.sh/experiments/chromium-command-line-switches/
+
         # The list of options set below mostly came from this StackOverflow post
         # https://stackoverflow.com/q/48450594/2532408
         opts = (
+            # "--disable-features=ImprovedCookieControls,LazyFrameLoading,GlobalMediaControls,DestroyProfileOnBrowserClose,MediaRouter,DialMediaRouteProvider,AcceptCHFrame,AutoExpandDetailsElement,CertificateTransparencyComponentUpdater,AvoidUnnecessaryBeforeUnloadCheckSync",  # noqa: ERA001
+            "--disable-back-forward-cache",
+            "--disable-background-timer-throttling",
+            "--disable-breakpad",
+            "--disable-component-extensions-with-background-pages",
+            "--disable-ipc-flooding-protection",
+            "--enable-features=NetworkService,NetworkServiceInProcess",
+            "--enable-logging",
+            "--export-tagged-pdf",
+            "--force-color-profile=srgb",
+            "--metrics-recording-only",
+            "--mute-audio",
+            "--remote-debugging-pipe",
+            # fixes MUI fade issue
+            "--disable-renderer-backgrounding",
+            # fixes actionchains in headless
+            "--disable-backgrounding-occluded-windows",
             "--disable-extensions",
             "--allow-running-insecure-content",
             "--ignore-certificate-errors",
@@ -523,12 +532,11 @@ class SetupSelenium:
         # by default performance is disabled.
         if enable_log_performance:
             logging_prefs["performance"] = "ALL"
-            options.set_capability(
+            options.add_experimental_option(
                 "perfLoggingPrefs",
                 {
                     "enableNetwork": True,
                     "enablePage": False,
-                    "enableTimeline": False,
                 },
             )
 
@@ -579,42 +587,3 @@ class SetupSelenium:
             logger.info(bsrmsg)
         SetupSelenium.log_options(options)
         return driver
-
-    ############################################################################
-    def set_window_size(self, size: str = "720") -> None:
-        """Helper to set the window size after driver has been instantiated."""
-        if size == "max":
-            self.driver.maximize_window()
-            return
-
-        width, height = SetupSelenium.DIMENSIONS.get(
-            size, SetupSelenium.DIMENSIONS.get(size, (1280, 720))
-        )
-        self.driver.set_window_size(width, height)
-
-    def set_main_window_handle(self, window: str | None = None) -> str:
-        """
-        Maintains the initial window handle as an attribute
-
-        Most users will never utilize this. It's part of a legacy requirement for
-        an old test suite
-        """
-        # does the main_window_handle exist and point to an available window?
-        if not window and not self.main_window_handle:
-            try:
-                window = self.driver.current_window_handle
-            except NoSuchWindowException:
-                try:
-                    window = self.driver.window_handles[0]
-                except WebDriverException:  # noqa: TRY203
-                    # Have we closed all the windows?
-                    raise
-        if window:
-            self.main_window_handle = window
-        return self.main_window_handle
-
-    ############################################################################
-    def __repr__(self) -> str:
-        browser = self.driver.name if self.driver is not None else "NoBrowserSet"
-        url = self.baseurl
-        return f"{self.__class__.__name__} :: {browser} -> {url}"

{setup_selenium_testing-0.2.0.dist-info → setup_selenium_testing-1.0.0.dist-info}/METADATA

@@ -1,18 +1,16 @@
 Metadata-Version: 2.3
 Name: setup-selenium-testing
-Version: 0.2.0
+Version: 1.0.0
 Summary: Setup Selenium for automation testing
-Home-page: https://github.com/bandophahita/setup_selenium
 License: MIT
 Author: Marcel Wilson
 Author-email: trenchrats+pypi@gmail.com
-Requires-Python: >=3.8,<4.0
+Requires-Python: >=3.9,<4.0
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
@@ -52,7 +50,42 @@ in every project.  Time to consolidate.
 [![Build Status](https://github.com/bandophahita/setup_selenium/actions/workflows/lint.yml/badge.svg)](https://github.com/bandophahita/setup_selenium/actions/workflows/lint.yml)
 
 
-# Basic usage
+# Instantiating SetupSelenium
+
+This will automatically handle any downloading of drivers or browsers via `SeleniumManager`
+
+```python
+from setup_selenium import SetupSelenium
+
+s = SetupSelenium(headless=True)
+assert s.driver.service.is_connectable()
+```
+
+Advanced usage:
+
+```python
+from setup_selenium import Browser, SetupSelenium
+
+s = SetupSelenium(Browser.FIREFOX, headless=True, driver_version="118.0.5993.70")
+s = SetupSelenium(Browser.CHROME, headless=True, driver_version="118.0.5993.70",
+                  driver_path="/path/to/webdriver"
+                  )
+```
+
+> [!NOTE] 
+> Version and path arguments follow the logic of 
+> [SeleniumManager](https://www.selenium.dev/documentation/selenium_manager/). 
+> Caution is advised in cases where version and path do not match. 
+> See their documentation.
+
+# Install Driver only
+```python
+from setup_selenium import Browser, SetupSelenium
+
+driver_path, browser_path = SetupSelenium.install_driver(Browser.CHROME, driver_version="118.0.5993.70")
+```
+
+# Create driver only
 
 ```python
 from setup_selenium import Browser, SetupSelenium
@@ -60,7 +93,8 @@ from setup_selenium import Browser, SetupSelenium
 driver = SetupSelenium.create_driver(browser=Browser.CHROME, headless=True)
 ```
 
-# Advanced usage
+Advanced usage:
+
 ```python
 from setup_selenium import Browser, SetupSelenium
 
@@ -77,19 +111,11 @@ driver = SetupSelenium.create_driver(
 ```
 
 > [!NOTE]
-> It is possible to enable the performance and console logging 
+> It is possible to enable the performance and console logging
 > but only for chrome based browsers. This only enables the browser ability.
 > It is up to the tester to handle logging the messages.
 
 
-
-# Driver installation
-```python
-from setup_selenium import Browser, SetupSelenium
-
-driver_path, browser_path = SetupSelenium.install_driver(Browser.CHROME, "118.0.5993.70")
-```
-
 # Custom logger
 ```python
 import logging
@@ -99,18 +125,6 @@ set_logger(logging.getLogger("your_custom_logger"))
 driver = SetupSelenium.create_driver(browser=Browser.CHROME, headless=True)
 ```
 
-# Instantiating SetupSelenium
-While it is possible to use the class directly caution is advised; as the class
-will create the driver upon instantiation. 
-
-```python
-from setup_selenium import SetupSelenium
-
-s = SetupSelenium(headless=True)
-assert s.driver.service.is_connectable()
-```
-
-
 # Automatic driver and browser installation
 This package not only handles setup of the webdriver but also will
 automatically install the webdriver and/or browser depending on your

setup_selenium_testing-1.0.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+setup_selenium/__init__.py,sha256=-w9Vvo72ZLaEyIEfc_Nh0bDDJz9W0pOy4rkRXurIJHI,63
+setup_selenium/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+setup_selenium/setup_selenium.py,sha256=6IijZ0maMo7t3_W1vUyn0l2SnEi8vsZoVZRUeQmu5kA,21834
+setup_selenium_testing-1.0.0.dist-info/LICENSE,sha256=KGdE-1D1chm3UNFtfE8x-EpVxhmv2zFx8oltbO8M1qE,1070
+setup_selenium_testing-1.0.0.dist-info/METADATA,sha256=N0t4a2Zf4wGPcc6lVTtdpFDlSDQ2QsgCUF1lhsP6Kjs,5847
+setup_selenium_testing-1.0.0.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
+setup_selenium_testing-1.0.0.dist-info/RECORD,,

{setup_selenium_testing-0.2.0.dist-info → setup_selenium_testing-1.0.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 2.0.0
+Generator: poetry-core 2.1.1
 Root-Is-Purelib: true
 Tag: py3-none-any

setup_selenium_testing-0.2.0.dist-info/RECORD

@@ -1,7 +0,0 @@
-setup_selenium/__init__.py,sha256=-w9Vvo72ZLaEyIEfc_Nh0bDDJz9W0pOy4rkRXurIJHI,63
-setup_selenium/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-setup_selenium/setup_selenium.py,sha256=asqQhE6fXcivb2MK3PL90TcQcCBVr_2Mgx-_CULxfUk,21921
-setup_selenium_testing-0.2.0.dist-info/LICENSE,sha256=KGdE-1D1chm3UNFtfE8x-EpVxhmv2zFx8oltbO8M1qE,1070
-setup_selenium_testing-0.2.0.dist-info/METADATA,sha256=0asqR9fuACtsQwpq_LcFCI38lB6ALuCtS7LcCFn_l8M,5413
-setup_selenium_testing-0.2.0.dist-info/WHEEL,sha256=RaoafKOydTQ7I_I3JTrPCg6kUmTgtm4BornzOqyEfJ8,88
-setup_selenium_testing-0.2.0.dist-info/RECORD,,