improved project structure and added logging

Author: dmy.berezovskyi

config/caps.yaml

@@ -0,0 +1,14 @@
+# config/capabilities.yaml
+chrome:
+  browserName: "chrome"
+  version: "latest"
+  platform: "MAC"
+  enableVNC: true
+  enableVideo: false
+
+firefox:
+  browserName: "firefox"
+  version: "latest"
+  platform: "MAC"
+  enableVNC: true
+  enableVideo: false

conftest.py

@@ -1,12 +1,11 @@
 import pytest
-import sys
 import os
 
 from dotenv import load_dotenv
 from selenium.webdriver.support.event_firing_webdriver import EventFiringWebDriver
 
-from utils.event_listener import EventListener
-from driver.driver_factory import WebDriverFactory
+from core.event_listener import EventListener
+from core.driver_factory import WebDriverFactory
 from utils.logger import Logger, LogLevel
 
 log = Logger(log_lvl=LogLevel.INFO).get_instance()

driver/driver.py core/driver.pydriver/driver.py renamed to core/driver.py

@@ -2,12 +2,12 @@
 from abc import ABC, abstractmethod
 
 from selenium import webdriver
-from selenium.common import WebDriverException
 from selenium.webdriver.chrome.service import Service as ChromeService
 from selenium.webdriver.remote.remote_connection import RemoteConnection
 from webdriver_manager.chrome import ChromeDriverManager
 
-from driver.driver_options import _init_driver_options
+from core.driver_options import _init_driver_options
+from utils.error_handler import ErrorHandler, ErrorType
 from utils.logger import Logger, LogLevel
 from properties import Properties
 from utils.yaml_reader import YamlReader
@@ -16,21 +16,15 @@
 
 
 def _get_driver_path(driver_type=None):
-    # Check if driver_type is provided
     if driver_type is None:
-        raise ValueError("Driver type must be specified.")
+        ErrorHandler.raise_error(ErrorType.UNSUPPORTED_DRIVER_TYPE)
 
     project_dir = os.path.dirname(
-        os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
-    )
+        os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
     driver_path = os.path.join(project_dir, "resources", driver_type)
 
-    # Check if the driver file exists
     if not os.path.exists(driver_path):
-        raise WebDriverException(
-            f"WebDriver binary not found at {driver_path}. "
-            f"Please ensure it exists the driver {driver_type} in directory."
-        )
+        ErrorHandler.raise_error(ErrorType.DRIVER_NOT_FOUND, driver_type)
 
     return driver_path
 
@@ -57,11 +51,13 @@ def create_driver(self, environment=None, dr_type=None):
         """Tries to use ChromeDriverManager to install the latest driver,
         and if it fails, it falls back to a locally stored driver in resources."""
         try:
-            driver_path = ChromeDriverManager().install()  # No need for ChromeType
+            log.info(f"Run local chrome driver")
+            driver_path = ChromeDriverManager().install()
             driver = webdriver.Chrome(
-                service=ChromeService(executable_path=driver_path))
+                service=ChromeService(executable_path=driver_path),
+                options=_init_driver_options(dr_type=dr_type))
         except Exception as e:
-            log.error(f"Run local driver: {e}")
+            log.info(f"Run local driver: {e}")
             driver = webdriver.Chrome(
                 service=ChromeService(_get_driver_path(dr_type)),
                 options=_init_driver_options(dr_type=dr_type),

driver/driver_factory.py core/driver_factory.pydriver/driver_factory.py renamed to core/driver_factory.py

@@ -1,5 +1,8 @@
-from driver.driver import ChromeRemoteDriver, FirefoxDriver, LocalDriver
+from core.driver import ChromeRemoteDriver, FirefoxDriver, LocalDriver
 from utils.error_handler import ErrorHandler, ErrorType
+from utils.logger import Logger, LogLevel
+
+log = Logger(log_lvl=LogLevel.INFO).get_instance()
 
 
 class WebDriverFactory:
@@ -11,6 +14,7 @@ class WebDriverFactory:
 
     @staticmethod
     def create_driver(environment=None, driver_type="local"):
+        log.info(f"Creating driver {driver_type}")
         driver_type = driver_type.lower()
         if driver_type in WebDriverFactory.DRIVER_MAPPING:
             driver_class = WebDriverFactory.DRIVER_MAPPING[driver_type]

driver/driver_options.py core/driver_options.pydriver/driver_options.py renamed to core/driver_options.py

@@ -33,4 +33,5 @@ def _init_driver_options(dr_type=None):
         )
 
     _shared_driver_options(options)
+    log.info(f"Driver options {options.arguments}")
     return options

core/event_listener.py

@@ -0,0 +1,14 @@
+from selenium.webdriver.support.abstract_event_listener import (
+    AbstractEventListener
+)
+
+
+class EventListener(AbstractEventListener):
+    """Custom event listener for WebDriver"""
+
+    def after_click(self, element, driver):
+        print(f"Clicked on {element.tag_name} at location {element.location}")
+
+    def on_exception(self, exception, driver):
+        print(f"Exception occurred: {exception}")
+        driver.save_screenshot("exception.png")

pyproject.toml

@@ -7,7 +7,7 @@ readme = "README.md"
 packages = [
     { include = "utils" },
     { include = "scraper" },
-    { include = "driver" },
+    { include = "core" }
 ]
 [tool.poetry.dependencies]
 python = "^3.12"

resources/caps.yaml

@@ -8,7 +8,7 @@ def read_caps(browser="chrome", filename="caps.yaml"):
         try:
             # Get the path to the resources folder from the script's directory
             resources_path = (
-                Path(__file__).resolve().parent.parent.parent / "resources"
+                Path(__file__).resolve().parent.parent.parent / "config"
             )
             abs_path = resources_path / filename