Merge branch 'dev' of https://github.com/microsoft/content-processing-solution-accelerator into dev

Author: Prajwal-Microsoft

docs/DeploymentGuide.md

@@ -173,9 +173,16 @@ Once you've opened the project in [Codespaces](#github-codespaces), [Dev Contain
     - This deployment will take *4-6 minutes* to provision the resources in your account and set up the solution with sample data.
     - If you encounter an error or timeout during deployment, changing the location may help, as there could be availability constraints for the resources.
 
-5. Once the deployment has completed successfully, open the [Azure Portal](https://portal.azure.com/), go to the deployed resource group, find the App Service, and get the app URL from `Default domain`.
+5. Once the deployment has completed successfully:
+    > Please check the terminal or console output for details of the successful deployment. It will display the Name, Endpoint (Application URL), and Azure Portal URL for both the Web and API Azure Container Apps.
 
-6. If you are done trying out the application, you can delete the resources by running `azd down`.
+    ![](./images/cp-post-deployment.png)
+
+    - You can find the Azure portal link in the screenshot above. Click on it to navigate to the corresponding resource group in the Azure portal.
+
+    > #### Important Note : Before accessing the application, ensure that all **[Post Deployment Steps](#post-deployment-steps)** are fully completed, as they are critical for the proper configuration of **Data Ingestion** and **Authentication** functionalities.
+
+7. If you are done trying out the application, you can delete the resources by running `azd down`.
 
 ### Publishing Local Build Container to Azure Container Registry
 

docs/images/cp-post-deployment.png

@@ -3,4 +3,5 @@ log_cli = true
 log_cli_level = INFO
 log_file = logs/tests.log
 log_file_level = INFO
-addopts = -p no:warnings
+addopts = -p no:warnings --tb=short
+

tests/e2e-test/pytest.ini

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

tests/e2e-test/readme.MD

@@ -3,4 +3,5 @@ pytest-reporter-html1
 python-dotenv
 pytest-check
 pytest-html
-py
+py
+beautifulsoup4

tests/e2e-test/requirements.txt

@@ -1,53 +1,121 @@
-import os
+"""
+Pytest configuration for browser-based testing with Playwright and HTML report customization.
+"""
+
+import io
+import atexit
+import logging
+from pathlib import Path
+from venv import logger
 
 import pytest
-from config.constants import URL
+from bs4 import BeautifulSoup
 from playwright.sync_api import sync_playwright
-from py.xml import html  # type: ignore
+
+from config.constants import URL
+
+# Global dictionary to store log streams for each test
+LOG_STREAMS = {}
 
 
 @pytest.fixture(scope="session")
 def login_logout():
-    # perform login and browser close once in a session
-    with sync_playwright() as p:
-        browser = p.chromium.launch(headless=False, args=["--start-maximized"])
+    """
+    Fixture to launch the browser, log in, and yield the page object.
+    Closes the browser after the session ends.
+    """
+    with sync_playwright() as playwright:
+        browser = playwright.chromium.launch(headless=False, args=["--start-maximized"])
         context = browser.new_context(no_viewport=True)
         context.set_default_timeout(80000)
         page = context.new_page()
-        # Navigate to the login URL
+
         page.goto(URL, wait_until="domcontentloaded")
-        # login to web url with username and password
+
+        # Uncomment and complete the following to enable login
         # login_page = LoginPage(page)
         # load_dotenv()
-        # login_page.authenticate(os.getenv('user_name'), os.getenv('pass_word'))
+        # login_page.authenticate(os.getenv("user_name"), os.getenv("pass_word"))
 
         yield page
-        # perform close the browser
+
         browser.close()
 
 
 @pytest.hookimpl(tryfirst=True)
-def pytest_html_report_title(report):
-    report.title = "Automation_Content_Processing"
-
+def pytest_runtest_setup(item):
+    """
+    Pytest hook to set up a log capture for each test.
+    """
+    stream = io.StringIO()
+    handler = logging.StreamHandler(stream)
+    handler.setLevel(logging.INFO)
 
-# Add a column for descriptions
-def pytest_html_results_table_header(cells):
-    cells.insert(1, html.th("Description"))
+    logger = logging.getLogger()
+    logger.addHandler(handler)
 
+    LOG_STREAMS[item.nodeid] = (handler, stream)
 
-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 hook to add captured logs to the test report.
+    """
     outcome = yield
     report = outcome.get_result()
-    report.description = str(item.function.__doc__)
-    os.makedirs("logs", exist_ok=True)
-    extra = getattr(report, "extra", [])
-    report.extra = extra
+
+    handler, stream = LOG_STREAMS.get(item.nodeid, (None, None))
+
+    if handler and stream:
+        handler.flush()
+        log_output = stream.getvalue()
+
+        logger = logging.getLogger()
+        logger.removeHandler(handler)
+
+        report.description = f"<pre>{log_output.strip()}</pre>"
+
+        LOG_STREAMS.pop(item.nodeid, None)
+    else:
+        report.description = ""
+
+
+def pytest_collection_modifyitems(items):
+    """
+    Modify test node IDs based on the test's parameterized 'prompt' value.
+    """
+    for item in items:
+        if hasattr(item, "callspec"):
+            prompt = item.callspec.params.get("prompt")
+            if prompt:
+                item._nodeid = prompt
+
+
+def rename_duration_column():
+    """
+    Modify the HTML report to rename 'Duration' column to 'Execution Time'.
+    Runs automatically after the test session.
+    """
+    report_path = Path("report.html")
+    if not report_path.exists():
+        logger.info("Report file not found, skipping column rename.")
+        return
+
+    with report_path.open("r", encoding="utf-8") as file:
+        soup = BeautifulSoup(file, "html.parser")
+
+    headers = soup.select("table#results-table thead th")
+    for th in headers:
+        if th.text.strip() == "Duration":
+            th.string = "Execution Time"
+            break
+    else:
+        print("'Duration' column not found in report.")
+
+    with report_path.open("w", encoding="utf-8") as file:
+        file.write(str(soup))
+
+
+# Register HTML report column modification
+atexit.register(rename_duration_column)

tests/e2e-test/tests/conftest.py

@@ -1,41 +1,72 @@
 import logging
-
+import time
 import pytest
 from pages.HomePage import HomePage
 
 logger = logging.getLogger(__name__)
 
+# Define step-wise test actions for Golden Path
+golden_path_steps = [
+    ("Validate home page is loaded", lambda home: home.validate_home_page()),
+    ("Select Invoice Schema", lambda home: home.select_schema("Invoice")),
+    ("Upload Invoice documents", lambda home: home.upload_files("Invoice")),
+    ("Refreshing the page until the 'Invoice' file status is updated to 'Completed'", lambda home: home.refresh()),
+    (
+        "Validate extracted result for Invoice",
+        lambda home: home.validate_invoice_extracted_result(),
+    ),
+    (
+        "Modify Extracted Data JSON & submit comments",
+        lambda home: home.modify_and_submit_extracted_data(),
+    ),
+    ("Validate process steps for Invoice", lambda home: home.validate_process_steps()),
+    (
+        "Select Property Loss Damage Claim Form Schema",
+        lambda home: home.select_schema("Property"),
+    ),
+    (
+        "Upload Property Loss Damage Claim Form documents",
+        lambda home: home.upload_files("Property"),
+    ),
+    ("Refreshing the page until the 'Claim Form' status is updated to 'Completed'", lambda home: home.refresh()),
+    (
+        "Validate extracted result for Property Loss Damage Claim Form",
+        lambda home: home.validate_property_extracted_result(),
+    ),
+    (
+        "Validate process steps for Property Loss Damage Claim Form",
+        lambda home: home.validate_process_steps(),
+    ),
+    ("Validate user able to delete file", lambda home: home.delete_files()),
+]
+
+# Generate readable test step IDs
+golden_path_ids = [
+    f"{i+1:02d}. {desc}" for i, (desc, _) in enumerate(golden_path_steps)
+]
+
 
-@pytest.mark.testcase_id("TC001")
-def test_ContentProcessing_Golden_path_test(login_logout):
-    """Validate Golden path test case for Content Processing Accelerator"""
+@pytest.mark.parametrize("description, action", golden_path_steps, ids=golden_path_ids)
+def test_content_processing_steps(login_logout, description, action, request):
+    """
+    Executes Golden Path content processing steps with individual log entries.
+    """
+    request.node._nodeid = description
     page = login_logout
-    home_page = HomePage(page)
-    logger.info("Step 1: Validate home page is loaded.")
-    home_page.validate_home_page()
-    logger.info("Step 2: Select Invoice Schema.")
-    home_page.select_schema("Invoice")
-    logger.info("Step 3: Upload Invoice documents.")
-    home_page.upload_files("Invoice")
-    logger.info("Step 4: Refresh page till status is updated to Completed.")
-    home_page.refresh()
-    logger.info("Step 5: Validate extracted result for Invoice.")
-    home_page.validate_invoice_extracted_result()
-    logger.info("Step 6: Modify Extracted Data JSON & submit comments.")
-    home_page.modify_and_submit_extracted_data()
-    logger.info("Step 7: Validate process steps for Invoice")
-    home_page.validate_process_steps()
-    logger.info("Step 8: Select Property Loss Damage Claim Form Schema.")
-    home_page.select_schema("Property")
-    logger.info("Step 9: Upload Property Loss Damage Claim Form documents.")
-    home_page.upload_files("Property")
-    logger.info("Step 10: Refresh page till status is updated to Completed.")
-    home_page.refresh()
-    logger.info(
-        "Step 11: Validate extracted result for Property Loss Damage Claim Form."
-    )
-    home_page.validate_property_extracted_result()
-    logger.info("Step 12: Validate process steps for Property Loss Damage Claim Form.")
-    home_page.validate_process_steps()
-    logger.info("Step 13: Validate Delete files.")
-    home_page.delete_files()
+    home = HomePage(page)
+
+    logger.info(f"Running test step: {description}")
+
+    start_time = time.time()
+    try:
+        action(home)
+        duration = time.time() - start_time
+        message = "Step passed: %s (Duration: %.2f seconds)" % (description, duration)
+        logger.info(message)
+        request.node._report_sections.append(("call", "log", message))
+
+    except Exception:
+        duration = time.time() - start_time
+        logger.error("Step failed: %s (Duration: %.2f seconds)", description, duration, exc_info=True)
+        raise
+    request.node._report_sections.append(("call", "log", f"Step passed: {description}"))