chore: enhance Python Selenium CI workflow with Xvfb setup and improved screenshot handling

Author: 02loveslollipop

.github/workflows/python-selenium-ci-workflow.yaml

@@ -43,15 +43,17 @@ jobs:
       APP_URL: http://localhost:3000
       DISPLAY: :99
 
-    services:
-      xvfb:
-        image: xvfb-run
-        options: --entrypoint /usr/bin/Xvfb -- :99 -screen 0 1280x1024x24 -ac
-
     steps:
     - name: Checkout code
       uses: actions/checkout@v3
 
+    - name: Setup Xvfb
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y xvfb
+        Xvfb :99 -screen 0 1280x1024x24 > /dev/null 2>&1 &
+        echo "DISPLAY=:99" >> $GITHUB_ENV
+
     - name: Set up Node.js
       uses: actions/setup-node@v3
       with:
@@ -100,8 +102,14 @@ jobs:
 
     - name: Install Python dependencies
       run: |
+        # Check if tests directory exists, if not create it
+        mkdir -p tests
         cd tests
         python -m pip install --upgrade pip
+        # Check if requirements.txt exists, if not create one
+        if [ ! -f requirements.txt ]; then
+          echo "pytest\nselenium\nwebdriver-manager" > requirements.txt
+        fi
         pip install -r requirements.txt
 
     - name: Run Selenium tests
@@ -117,4 +125,4 @@ jobs:
       with:
         name: test-results
         path: tests/screenshots/
-        retention-days: 7
+        retention-days: 5

tests/conftest.py

@@ -1,42 +1,37 @@
-# General imports
 import pytest
+import os
 from selenium import webdriver
-
-# Imports to get chrome driver working
+from selenium.webdriver.chrome.options import Options
 from selenium.webdriver.chrome.service import Service
 from webdriver_manager.chrome import ChromeDriverManager
 
-# Imports to get firefox driver working
-from selenium.webdriver.firefox.service import Service as FirefoxService
-from webdriver_manager.firefox import GeckoDriverManager
-
-# Import options for headless mode
-from selenium.webdriver.chrome.options import Options
-
-
-def pytest_addoption(parser):
-    parser.addoption(
-        "--browser", action="store", default="chrome", help="Send 'chrome' or 'firefox' as parameter for execution"
+@pytest.fixture(scope="function")
+def driver():
+    # Setup Chrome options
+    chrome_options = Options()
+    
+    # Check if running in GitHub Actions
+    if os.environ.get('GITHUB_ACTIONS') == 'true':
+        chrome_options.add_argument('--headless')
+        chrome_options.add_argument('--no-sandbox')
+        chrome_options.add_argument('--disable-dev-shm-usage')
+    
+    chrome_options.add_argument('--window-size=1920,1080')
+    
+    # Initialize Chrome driver
+    driver = webdriver.Chrome(
+        service=Service(ChromeDriverManager().install()),
+        options=chrome_options
     )
-
-
-@pytest.fixture()
-def driver(request):
-    browser = request.config.getoption("--browser")
-    # Default driver value
-    driver = ""
-    # Option setup to run in headless mode (in order to run this in GH Actions)
-    options = Options()
-    options.add_argument('--headless')
-    # Setup
-    print(f"\nSetting up: {browser} driver")
-    if browser == "chrome":
-        driver = webdriver.Chrome(service=Service(ChromeDriverManager().install()), options=options)
-    elif browser == "firefox":
-        driver = webdriver.Firefox(service=FirefoxService(GeckoDriverManager().install()))
-    # Implicit wait setup for our framework
-    driver.implicitly_wait(10)
+    
+    # Create screenshots directory if it doesn't exist
+    os.makedirs("screenshots", exist_ok=True)
+    
     yield driver
-    # Tear down
-    print(f"\nTear down: {browser} driver")
+    
+    # Take screenshot on test failure
+    if pytest.item and hasattr(pytest, '_funcargs'):
+        test_name = pytest._funcargs.get('request', pytest._funcargs.get('fspath', pytest)).node.name
+        driver.save_screenshot(f"screenshots/{test_name}.png")
+    
     driver.quit()