added ability to create screenshot on test fail

Author: dmy.berezovskyi

.github/workflows/run_tests.yaml

@@ -3,7 +3,7 @@ name: Selenium Tests
 on:
   workflow_dispatch: # Allows running manually
   schedule:
-    - cron: '0 0 * * *' # Run each day on 00:00 UTC
+    - cron: '0 0 * * *' # Run each day at 00:00 UTC
 
 jobs:
   selenium-tests:
@@ -44,7 +44,7 @@ jobs:
 
       - name: Run tests
         run: |
-          poetry run pytest --verbose --junit-xml=test-results.xml
+          poetry run pytest --verbose --junit-xml=test-results.xml --capture=tee-sys
 
       - name: Publish Test Report
         uses: mikepenz/action-junit-report@v3
@@ -53,3 +53,10 @@ jobs:
           report_paths: '**/test-results.xml'
           detailed_summary: true
           include_passed: true
+
+      - name: Upload Screenshots
+        if: failure()
+        uses: actions/upload-artifact@v3
+        with:
+          name: screenshots
+          path: reports/screenshots/*

conftest.py

@@ -61,3 +61,23 @@ def pytest_addoption(parser):
                      help="Run browser in headless mode")
     parser.addoption("--type", action="store", default='local',
                      help="Run browser in os type")
+
+
+def pytest_runtest_makereport(item, call):
+    """Capture screenshot on test failure."""
+    if call.excinfo is not None:
+        # Make sure the driver is being captured correctly
+        driver = item.funcargs.get('make_driver', None)
+
+        if driver is not None:
+            screenshot_dir = "reports/screenshots"
+            os.makedirs(screenshot_dir, exist_ok=True)  # Create directory if it does not exist
+            screenshot_path = os.path.join(screenshot_dir, f"{item.name}.png")
+
+            try:
+                driver.save_screenshot(screenshot_path)
+                log.info(f"Screenshot saved to: {screenshot_path}")
+            except Exception as e:
+                log.error(f"Failed to save screenshot: {e}")
+        else:
+            log.error("Driver instance is not available for capturing screenshot.")

tests/test_main_page.py

@@ -13,3 +13,7 @@ def test_main5(self, make_driver):
 
     def test_main6(self, make_driver):
         make_driver
+
+    def test_example(self, make_driver):
+        driver = make_driver
+        assert driver.title == "Example sad as Domain"  # This will fail to demonstrate screenshot capture