fix: update test cases and configuration for improved logging and report generation

Author: Harsh-Microsoft

playwright-tests/.gitignore

@@ -164,3 +164,5 @@ cython_debug/
 archive/
 report/
 screenshots/
+
+report.html

playwright-tests/README.md

@@ -24,7 +24,7 @@ Installing Playwright Pytest from Virtual Environment
 
 Run test cases
 
-- To run test cases from your 'tests' folder : "pytest --headed --html=report/report.html"
+- To run test cases from your 'tests' folder : "pytest --html=report.html --self-contained-html"
 
 Create .env file in project root level with web app url and client credentials
 

playwright-tests/pytest.ini

@@ -0,0 +1,6 @@
+[pytest]
+log_cli = true
+log_cli_level = INFO
+log_file = logs/tests.log
+log_file_level = INFO
+addopts = -p no:warnings

playwright-tests/requirements.txt

@@ -1,4 +1,6 @@
 pytest-playwright
-pytest-html
+pytest-reporter-html1
 python-dotenv
-pytest-check
+pytest-check
+pytest-html
+py

playwright-tests/tests/conftest.py

@@ -1,8 +1,8 @@
-from pathlib import Path
+import os
 
 import pytest
 from playwright.sync_api import sync_playwright
-from slugify import slugify
+from py.xml import html  # type: ignore
 
 from config.constants import URL
 
@@ -11,9 +11,9 @@
 def login_logout():
     # perform login and browser close once in a session
     with sync_playwright() as p:
-        browser = p.chromium.launch(headless=False)
-        context = browser.new_context()
-        context.set_default_timeout(80000)
+        browser = p.chromium.launch(headless=False, args=["--start-maximized"])
+        context = browser.new_context(no_viewport=True)
+        context.set_default_timeout(120000)
         page = context.new_page()
         # Navigate to the login URL
         page.goto(URL)
@@ -27,25 +27,24 @@ def login_logout():
 
 @pytest.hookimpl(tryfirst=True)
 def pytest_html_report_title(report):
-    report.title = "Automation_DOCGEN"
+    report.title = "Automation_DocGen"
 
 
+# Add a column for descriptions
+def pytest_html_results_table_header(cells):
+    cells.insert(1, html.th("Description"))
+
+
+def pytest_html_results_table_row(report, cells):
+    cells.insert(1, html.td(report.description if hasattr(report, "description") else ""))
+
+
+# Add logs and docstring to report
 @pytest.hookimpl(hookwrapper=True)
 def pytest_runtest_makereport(item, call):
-    pytest_html = item.config.pluginmanager.getplugin("html")
     outcome = yield
-    screen_file = ""
     report = outcome.get_result()
-    extra = getattr(report, "extra", [])
-    if report.when == "call":
-        if report.failed and "page" in item.funcargs:
-            page = item.funcargs["page"]
-            screenshot_dir = Path("screenshots")
-            screenshot_dir.mkdir(exist_ok=True)
-            screen_file = str(screenshot_dir / f"{slugify(item.nodeid)}.png")
-            page.screenshot(path=screen_file)
-        xfail = hasattr(report, "wasxfail")
-        if (report.skipped and xfail) or (report.failed and not xfail):
-            # add the screenshots to the html report
-            extra.append(pytest_html.extras.png(screen_file))
-        report.extra = extra
+    report.description = str(item.function.__doc__)
+    os.makedirs("logs", exist_ok=True)
+    extra = getattr(report, 'extra', [])
+    report.extra = extra

playwright-tests/tests/test_poc_docgen.py

@@ -1,16 +1,25 @@
-from config.constants import browse_question1, browse_question2, generate_question1
+import logging
+
+from config.constants import (browse_question1, browse_question2,
+                              generate_question1)
 from pages.browsePage import BrowsePage
 from pages.draftPage import DraftPage
 from pages.generatePage import GeneratePage
 from pages.homePage import HomePage
 
+logger = logging.getLogger(__name__)
+
+
+def test_DocGen_GOLDENPATH(login_logout):
+    """Validate Golden path test case for Doc Gen Accelerator """
 
-def test_DKM_GOLDENPATH(login_logout):
     page = login_logout
+    logger.info("Step 1: Validate home page is loaded.")
     home_page = HomePage(page)
-    # validate page title
+    logger.info("Step 2: Validate Browse page is loaded.")
     home_page.click_browse_button()
     browse_page = BrowsePage(page)
+    logger.info("Step 3: Validate Browse- Prompts response.")
     browse_page.enter_a_question(browse_question1)
     browse_page.click_send_button()
     # validate response
@@ -24,13 +33,16 @@ def test_DKM_GOLDENPATH(login_logout):
     browse_page.click_expand_reference_in_response()
     browse_page.click_reference_link_in_response()
     browse_page.close_citation()
-    # # validate response
+    logger.info("Step 4: Validate Generate Page is loaded.")
     browse_page.click_generate_button()
+    logger.info("Step 5: Validate Generate- Prompts response.")
     browse_page.validate_response_status(question_api=browse_question2)
     generate_page = GeneratePage(page)
     generate_page.enter_a_question(generate_question1)
     generate_page.click_send_button()
     generate_page.validate_response_status(question_api=generate_question1)
     generate_page.click_generate_draft_button()
+    logger.info("Step 6: Validate Generate Page is loaded.")
     draft_page = DraftPage(page)
+    logger.info("Step 7: Validate Draft sections generated properly.")
     draft_page.check_draft_Sections()