chore: modernize ci and lint config

Author: nirtal85

.github/workflows/monthly.yml

@@ -55,13 +55,11 @@ jobs:
         uses: astral-sh/setup-uv@v8.2.0
         with:
           enable-cache: true
-      - name: Create venv & install dependencies
-        run: |
-          uv venv
-          uv sync --all-extras --dev
+      - name: Install dependencies
+        run: uv sync --locked --all-extras --dev
       - name: Run Tests
         run: >
-          xvfb-run .venv/bin/python -m pytest
+          xvfb-run uv run pytest
           ${{ github.event.inputs.pytest_command || '-m "not devRun"' }}
           --base-url ${{ vars.BASE_URL }}
           --splits ${{ github.event.inputs.parallelism || 2 }}

.github/workflows/devRun.yml .github/workflows/pr.yml.github/workflows/devRun.yml renamed to .github/workflows/pr.yml

@@ -1,4 +1,4 @@
-name: Pre merge test
+name: Pull Request Tests
 
 on:
   pull_request:
@@ -7,7 +7,7 @@ on:
       - "**/*.py"
       - "**/*.toml"
       - "**/*.lock"
-      - ".github/workflows/devRun.yml"
+      - ".github/workflows/pr.yml"
 
 env:
   FLAKINESS_PROJECT: nirtal85/Selenium-Python-Example
@@ -33,15 +33,17 @@ jobs:
         uses: astral-sh/setup-uv@v8.2.0
         with:
           enable-cache: true
-      - name: Create venv & install dependencies
-        run: |
-          uv venv
-          uv sync --all-extras --dev
+      - name: Install dependencies
+        run: uv sync --locked --all-extras --dev
+      - name: Ruff check
+        run: uv run ruff check .
+      - name: Ruff format check
+        run: uv run ruff format --check .
       - name: Test with pytest
         env:
           EMAIL: ${{ secrets.EMAIL }}
           PASSWORD: ${{ secrets.PASSWORD }}
-        run: xvfb-run .venv/bin/python -m pytest -m devRun --base-url ${{ vars.BASE_URL }}
+        run: xvfb-run uv run pytest -m devRun --base-url ${{ vars.BASE_URL }}
       - name: Auto-assign reviewers
         uses: kentaro-m/auto-assign-action@v2.0.2
         if: success()

README.md

@@ -9,25 +9,25 @@
 [![Twitter Follow](https://img.shields.io/twitter/follow/NirTal2?style=social)](https://twitter.com/NirTal2)
 [![YouTube](https://img.shields.io/youtube/channel/subscribers/UCQjS-eoKl0a1nuP_dvpLsjQ?style=social)](https://www.youtube.com/channel/UCQjS-eoKl0a1nuP_dvpLsjQ)
 [![Architecture by TestShift](https://raw.githubusercontent.com/nirtal85/TestShift-AI/main/assets/testshift-architecture-badge.svg)](https://www.test-shift.com/)
-![CI Status](https://github.com/nirtal85/Selenium-Python-Example/actions/workflows/devRun.yml/badge.svg)
+![CI Status](https://github.com/nirtal85/Selenium-Python-Example/actions/workflows/pr.yml/badge.svg)
 ![Monthly Build](https://github.com/nirtal85/Selenium-Python-Example/actions/workflows/monthly.yml/badge.svg)
 [![Tests](https://img.shields.io/endpoint?url=https%3A%2F%2Fflakiness.io%2Fapi%2Fbadge%3Finput%3D%257B%2522badgeToken%2522%253A%2522badge-AlsJROG5SIAxYaV68SL8K%2522%257D)](https://flakiness.io/nirtal85/Selenium-Python-Example)
 [![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 
-[View Live Report](https://nirtal85.github.io/Selenium-Python-Example/) • [Read The Docs](https://www.test-shift.com) • [Report Bug](https://github.com/nirtal85/Selenium-Python-Example/issues)
+[View Live Report](https://nirtal85.github.io/Selenium-Python-Example/) - [Read The Docs](https://www.test-shift.com) - [Report Bug](https://github.com/nirtal85/Selenium-Python-Example/issues)
 
 </div>
 
 ---
 
-## 🚀 About The Project
+## About The Project
 
 This repository serves as a **Production-Ready Reference Architecture** for building high-scale automated testing frameworks using Python.
 
 It demonstrates advanced design patterns, seamless CI/CD integration, and rich reporting capabilities that define modern Quality Engineering.
 
-### ✨ Key Features
+### Key Features
 
 * **Modern Python Tooling:** Built with `uv` for lightning-fast dependency management and `Ruff` for linting.
 * **Robust Reporting:** Full integration with **Allure Report**, including screenshots, logs, and video.
@@ -36,7 +36,7 @@ It demonstrates advanced design patterns, seamless CI/CD integration, and rich r
 
 ---
 
-## 📃 Articles written about this project
+## Articles written about this project
 
 This project implements the concepts discussed in the following **TestShift** articles:
 
@@ -52,11 +52,11 @@ This project implements the concepts discussed in the following **TestShift** ar
 * [Test Automation - How to Use Dynamic Base URLs with Selenium And Playwright Python in GitHub Actions](https://www.linkedin.com/pulse/test-automation-how-use-dynamic-base-urls-selenium-playwright-tal-klq5f/)
 * [Test Automation Best Practices: Pinning Browser Version in Selenium Python for Stability](https://www.linkedin.com/pulse/test-automation-best-practices-pinning-browser-version-nir-tal-b5b8f/)
 * [Test Automation - Capturing Console Logs and JavaScript Errors with Selenium WebDriver BiDi in Python](https://www.linkedin.com/pulse/test-automation-capturing-console-logs-javascript-errors-nir-tal-g3zgf/)
-* [Allure 3 Isn’t Just an Upgrade. It’s the Final Piece of the Quality Gate Architecture](https://www.test-shift.com/posts/allure-3-leave-the-swamp-ride-the-dragon)
+* [Allure 3 Isn't Just an Upgrade. It's the Final Piece of the Quality Gate Architecture](https://www.test-shift.com/posts/allure-3-leave-the-swamp-ride-the-dragon)
 
 ---
 
-## 🛠️ Tech Stack
+## Tech Stack
 
 | Tool                                                                             | Description & Why We Use It                                           |
 |----------------------------------------------------------------------------------|-----------------------------------------------------------------------|
@@ -72,7 +72,7 @@ This project implements the concepts discussed in the following **TestShift** ar
 
 ---
 
-## ⚙️ Getting Started
+## Getting Started
 
 ### 1. Clone
 
@@ -90,7 +90,7 @@ Windows:
 ```bash
 pip install uv
 uv venv
-.\env\Scripts\activate
+.\.venv\Scripts\activate
 uv sync --all-extras --dev
 ```
 
@@ -113,33 +113,33 @@ PASSWORD="your_secret_password"
 # ... add other variables as needed (see .env.example)
 ```
 
-## 🏃‍♂️ Execution
+## Execution
 Run all tests (Headless Chrome by default):
 
 ```bash
-pytest
+uv run pytest
 ```
 
 Run with specific browser:
 
 ```bash
-pytest --driver firefox
+uv run pytest --driver firefox
 ```
 
 Run specific suite (Tags):
 
 ```bash
-pytest -m sanity
+uv run pytest -m sanity
 ```
 
-## 📊 Results & Reporting
+## Results & Reporting
 We use Allure for reporting. To generate and open the report locally:
 
 ```bash
 npx -y allure generate allure-results --output allure-report --open
 ```
 
-👉 [See a Live Example of the Report Here](https://nirtal85.github.io/Selenium-Python-Example/)
+[See a Live Example of the Report Here](https://nirtal85.github.io/Selenium-Python-Example/)
 
 ---
 

pyproject.toml

@@ -9,6 +9,9 @@ dev = [
 name = "selenium-python-example"
 description = "Selenium Python example project with pytest and Allure report"
 version = "0.1.0"
+readme = "README.md"
+license = "MIT"
+authors = [{ name = "Nir Tal" }]
 dependencies = [
   "allure-pytest==2.16.0",
   "assertpy==1.1",
@@ -51,22 +54,27 @@ addopts = [
 base_url = 'https://www.involve.me/'
 markers = [
   "security: marks security tests",
-  "devRun: marks tests that run before merge to the main branch"
+  "devRun: marks tests that run before merge to the main branch",
+  "flaky: marks tests that may be rerun",
+  "run: marks ordered test execution",
+  "sanity: marks sanity tests"
 ]
 testpaths = [
   "tests"
 ]
 
 [tool.ruff]
 exclude = [".venv", "env"]
+line-length = 100
+target-version = "py311"
+
+[tool.ruff.lint]
 ignore = [
   "D203",  # One blank line required before class docstring (conflicts with D211)
   "D213",  # Multi-line docstring summary should start at the second line
   "COM812"
 ]
-line-length = 100
-select = ["ALL"]
-target-version = "py311"
+select = ["E", "F", "B", "I", "UP", "SIM", "PT"]
 
 [tool.ruff.format]
 docstring-code-format = true

src/pages/base_page.py

@@ -46,7 +46,8 @@ def set_geo_location(self, latitude: float, longitude: float) -> None:
 
         Note:
         This method uses the Chrome DevTools Protocol (CDP) to override the geolocation
-        in the web browser, allowing simulation of a specific geographic location for testing purposes.
+        in the web browser, allowing simulation of a specific geographic location for
+        testing purposes.
         The accuracy is set to 1 for simplicity in this method.
 
         """
@@ -99,15 +100,21 @@ def is_elem_displayed(self, webelement: WebElement) -> bool:
     def _highlight_element(self, webelement: WebElement, color: str) -> None:
         original_style = webelement.get_attribute("style")
         new_style = f"background-color:yellow;border: 1px solid {color}{original_style}"
+        set_style_script = (
+            "var tmpArguments = arguments;"
+            "setTimeout(function () {"
+            "tmpArguments[0].setAttribute('style', tmpArguments[1]);"
+            "}, tmpArguments[2]);"
+        )
         self.driver.execute_script(
-            "var tmpArguments = arguments;setTimeout(function () {tmpArguments[0].setAttribute('style', '"
-            + new_style
-            + "');},0);",
+            set_style_script,
             webelement,
+            new_style,
+            0,
         )
         self.driver.execute_script(
-            "var tmpArguments = arguments;setTimeout(function () {tmpArguments[0].setAttribute('style', '"
-            + original_style
-            + "');},400);",
+            set_style_script,
             webelement,
+            original_style,
+            400,
         )

src/utilities/excel_parser.py

@@ -19,7 +19,7 @@ def read_from_excel(self, sheet_name):
         num_cols = sheet.ncols  # Number of columns
         for row_idx, col_idx in itertools.product(range(1, sheet.nrows), range(num_cols)):
             cell_obj = sheet.cell(row_idx, col_idx)  # Get cell object by row, col
-            # Convert cell to string,split it according to "'" and take the second cell in the array created
-            # e.g.: cell_obj == "text:'something'" --> after convert and splitting == "something"
+            # Convert cell to string, split on "'" and take the value segment.
+            # e.g.: cell_obj == "text:'something'" --> "something"
             rows_val.append(str(cell_obj).split("'")[1])
         return rows_val

src/utilities/mailinator_helper.py

@@ -55,8 +55,8 @@ def __get_message_id(self, user_email: str, email_subject: str) -> str:
             email_subject (str): The subject of the email to wait for.
 
         Returns:
-            str or None: The message ID of the email with the specified subject, or None if the email
-            is not found within the inbox.
+            str or None: The message ID of the email with the specified subject, or
+            None if the email is not found within the inbox.
 
         Raises:
             Any exceptions raised by the underlying `self.mailinator.request` method when
@@ -66,13 +66,13 @@ def __get_message_id(self, user_email: str, email_subject: str) -> str:
         messages = self.mailinator.request(
             GetInboxRequest(
                 domain=self.mailinator_domain,
-                inbox=user_email.split("@")[0],
+                inbox=user_email.split("@", maxsplit=1)[0],
             )
         ).msgs
         filtered_messages: list[Message] = [
             message
             for message in messages
-            if message.to == user_email.split("@")[0]
+            if message.to == user_email.split("@", maxsplit=1)[0]
             and message.subject.casefold() == email_subject.casefold()
         ]
         return filtered_messages[0].id if filtered_messages else None
@@ -160,7 +160,7 @@ def count_messages_by_subject(self, user_email: str) -> dict[str, int]:
         messages = self.mailinator.request(
             GetInboxRequest(
                 domain=self.mailinator_domain,
-                inbox=user_email.split("@")[0],
+                inbox=user_email.split("@", maxsplit=1)[0],
             )
         ).msgs
         # Use a list comprehension to extract the subjects from each message

src/utilities/vrt_helper.py

@@ -57,7 +57,9 @@ def shoot_page(self, baseline_name: str) -> None:
             TestRunStatus.OK.name,
         )
 
-    def shoot_page_ang_ignore_elements(self, baseline_name: str, elements: list[WebElement]) -> None:
+    def shoot_page_ang_ignore_elements(
+        self, baseline_name: str, elements: list[WebElement]
+    ) -> None:
         """Capture a screenshot of the current page, define areas to be ignored
         within the screenshot, compare the captured screenshot with a baseline
         image stored in Visual Regression tracker.

tests/conftest.py

@@ -16,6 +16,7 @@
 from mysql.connector import MySQLConnection
 from requests_toolbelt.utils import dump
 from selenium import webdriver
+from selenium.common.exceptions import WebDriverException
 from selenium.webdriver.support.event_firing_webdriver import EventFiringWebDriver
 from selenium.webdriver.support.wait import WebDriverWait
 from visual_regression_tracker import VisualRegressionTracker
@@ -28,11 +29,11 @@
 from src.pages.projects_page import ProjectsPage
 from src.pages.templates_page import TemplatesPage
 from src.utilities.constants import Constants
-from src.utilities.mailinator_helper import MailinatorHelper
-from src.utilities.web_driver_listener import DriverEventListener
-from src.utilities.excel_parser import ExcelParser
 from src.utilities.data import Data
+from src.utilities.excel_parser import ExcelParser
+from src.utilities.mailinator_helper import MailinatorHelper
 from src.utilities.vrt_helper import VrtHelper
+from src.utilities.web_driver_listener import DriverEventListener
 
 drivers = ("chrome", "firefox", "chrome_headless", "remote")
 
@@ -158,8 +159,8 @@ def pytest_runtest_setup(item: Item) -> None:
             },
         )
         chrome_options.enable_bidi = True
-        # https://forum.robotframework.org/t/maximize-window-chromedriver-133/8416/3
-        chrome_options.browser_version = "132"
+        if chrome_browser_version := os.getenv("CHROME_BROWSER_VERSION"):
+            chrome_options.browser_version = chrome_browser_version
         chrome_options.add_argument("disable-dev-shm-usage")
         chrome_options.add_argument("no-sandbox")
         chrome_options.add_argument("allow-file-access-from-files")
@@ -194,7 +195,6 @@ def pytest_runtest_setup(item: Item) -> None:
         # https://stackoverflow.com/questions/76430192/getting-typeerror-webdriver-init-got-an-unexpected-keyword-argument-desi
         case "remote":
             chrome_options = webdriver.ChromeOptions()
-            # https://aerokube.com/images/latest/#_chrome
             chrome_options.browser_version = "128.0"
             chrome_options.set_capability(
                 "selenoid:options",
@@ -215,7 +215,10 @@ def pytest_runtest_setup(item: Item) -> None:
             else:
                 driver = webdriver.Chrome(options=chrome_options)
     item.cls.driver = driver
-    driver.maximize_window()
+    try:
+        driver.maximize_window()
+    except WebDriverException:
+        driver.set_window_size(1920, 1080)
     driver.get(base_url)
     wait = WebDriverWait(driver, 10)
     if browser != "remote":
@@ -268,9 +271,9 @@ def pytest_sessionstart() -> None:
 def pytest_exception_interact(node: Item) -> None:
     """Pytest hook for interacting with exceptions during test execution.
 
-    If the 'driver' variable is present in the local or global namespace, this function performs various
-    actions for reporting using the 'allure' reporting framework. If 'driver' is not present, the function
-    returns without taking any action.
+    If the 'driver' variable is present, this function performs reporting actions
+    using the 'allure' reporting framework. If 'driver' is not present, the
+    function returns without taking any action.
 
     Args:
         node (Item): The pytest Item representing the test item.

tests/dependency_class_test.py

@@ -11,7 +11,7 @@ class TestDependencyExample(BaseTest):
     """
 
     def test_e(self) -> None:
-        """Placeholder test function with the dependency name "e" and depends on "TestDependencyExample::b".
+        """Placeholder with dependency name "e" and depends on "TestDependencyExample::b".
 
         This test case is designed for demonstration purposes only.
         """