add screenshot capture on test failure and create screenshots directory

Author: Harsh-Microsoft

tests/e2e-test/tests/conftest.py

@@ -9,6 +9,12 @@
 import logging
 from bs4 import BeautifulSoup
 import atexit
+from datetime import datetime
+
+# Create screenshots directory if it doesn't exist
+SCREENSHOTS_DIR = os.path.join(os.path.dirname(__file__), "screenshots")
+os.makedirs(SCREENSHOTS_DIR, exist_ok=True)
+print(f"Screenshots will be saved to: {SCREENSHOTS_DIR}")  # Debug line
 
 @pytest.fixture(scope="session")
 def login_logout():
@@ -51,9 +57,45 @@ def pytest_html_report_title(report):
 
 @pytest.hookimpl(hookwrapper=True)
 def pytest_runtest_makereport(item, call):
+    """Generate test report with logs, subtest details, and screenshots on failure"""
     outcome = yield
     report = outcome.get_result()
 
+    # Capture screenshot on failure
+    if report.when == "call" and report.failed:
+        # Get the page fixture if it exists
+        if "login_logout" in item.fixturenames:
+            page = item.funcargs.get("login_logout")
+            if page:
+                try:
+                    # Generate screenshot filename with timestamp
+                    timestamp = datetime.now().strftime("%Y%m%d_%H%M%S")
+                    test_name = item.name.replace(" ", "_").replace("/", "_")
+                    screenshot_name = f"screenshot_{test_name}_{timestamp}.png"
+                    screenshot_path = os.path.join(SCREENSHOTS_DIR, screenshot_name)
+
+                    # Take screenshot
+                    page.screenshot(path=screenshot_path)
+
+                    # Add screenshot link to report
+                    if not hasattr(report, 'extra'):
+                        report.extra = []
+
+                    # Add screenshot as a link in the Links column
+                    # Use relative path from report.html location
+                    relative_path = os.path.relpath(
+                        screenshot_path,
+                        os.path.dirname(os.path.abspath("report.html"))
+                    )
+
+                    # pytest-html expects this format for extras
+                    from pytest_html import extras
+                    report.extra.append(extras.url(relative_path, name='Screenshot'))
+
+                    logging.info("Screenshot saved: %s", screenshot_path)
+                except Exception as exc:  # pylint: disable=broad-exception-caught
+                    logging.error("Failed to capture screenshot: %s", str(exc))
+
     handler, stream = log_streams.get(item.nodeid, (None, None))
 
     if handler and stream:
@@ -65,8 +107,44 @@ def pytest_runtest_makereport(item, call):
         logger = logging.getLogger()
         logger.removeHandler(handler)
 
-        # Store the log output on the report object for HTML reporting
-        report.description = f"<pre>{log_output.strip()}</pre>"
+        # Check if there are subtests
+        subtests_html = ""
+        if hasattr(item, 'user_properties'):
+            item_subtests = [
+                prop[1] for prop in item.user_properties if prop[0] == "subtest"
+            ]
+            if item_subtests:
+                subtests_html = (
+                    "<div style='margin-top: 10px;'>"
+                    "<strong>Step-by-Step Details:</strong>"
+                    "<ul style='list-style: none; padding-left: 0;'>"
+                )
+                for idx, subtest in enumerate(item_subtests, 1):
+                    status = "✅ PASSED" if subtest.get('passed') else "❌ FAILED"
+                    status_color = "green" if subtest.get('passed') else "red"
+                    subtests_html += (
+                        f"<li style='margin: 10px 0; padding: 10px; "
+                        f"border-left: 3px solid {status_color}; "
+                        f"background-color: #f9f9f9;'>"
+                    )
+                    subtests_html += (
+                        f"<div style='font-weight: bold; color: {status_color};'>"
+                        f"{status} - {subtest.get('msg', f'Step {idx}')}</div>"
+                    )
+                    if subtest.get('logs'):
+                        subtests_html += (
+                            f"<pre style='margin: 5px 0; padding: 5px; "
+                            f"background-color: #fff; border: 1px solid #ddd; "
+                            f"font-size: 11px;'>{subtest.get('logs').strip()}</pre>"
+                        )
+                    subtests_html += "</li>"
+                subtests_html += "</ul></div>"
+
+        # Combine main log output with subtests
+        if subtests_html:
+            report.description = f"<pre>{log_output.strip()}</pre>{subtests_html}"
+        else:
+            report.description = f"<pre>{log_output.strip()}</pre>"
 
         # Clean up references
         log_streams.pop(item.nodeid, None)