Merge branch 'dev' into ca-fdp-changes

Author: Harsh-Microsoft

tests/e2e-test/README.md

@@ -23,7 +23,7 @@ Installing Playwright Pytest from Virtual Environment
 - Install the required browsers "playwright install"
 
 Run test cases
-- To run test cases from your 'tests' folder : "pytest --headed --html=report/report.html"
+- To run test cases from your 'tests/e2e-test' folder : "pytest --headed --html=report/report.html"
 
 Steps need to be followed to enable Access Token and Client Credentials 
 - Go to App Service from the resource group and select the Access Tokens check box in 'Manage->Authentication' tab

tests/e2e-test/requirements.txt

@@ -1,3 +1,7 @@
 pytest-playwright
 pytest-html
-python-dotenv
+python-dotenv
+pytest-check
+pytest-reporter-html1
+py
+beautifulsoup4

tests/e2e-test/tests/conftest.py

@@ -1,59 +1,98 @@
-from pathlib import Path
+from bs4 import BeautifulSoup
 import pytest
 from playwright.sync_api import sync_playwright
 from config.constants import *
-from slugify import slugify
-from pages.homePage import HomePage
-from pages.loginPage import LoginPage
-from dotenv import load_dotenv
+import logging
+import atexit
 import os
+import io
 
-
+# Playwright session-scoped login/logout fixture
 @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)
         context = browser.new_context()
         context.set_default_timeout(80000)
         page = context.new_page()
-        # Navigate to the login URL
         page.goto(URL)
-        # Wait for the login form to appear
         page.wait_for_load_state('networkidle')
         page.wait_for_timeout(5000)
-        # # login to web url with username and password
+        # Optional login steps
         # login_page = LoginPage(page)
         # load_dotenv()
         # login_page.authenticate(os.getenv('user_name'), os.getenv('pass_word'))
 
         yield page
 
-        # perform close the browser
         browser.close()
 
-
+# Change HTML report title
 @pytest.hookimpl(tryfirst=True)
 def pytest_html_report_title(report):
     report.title = "Automation_BYOc_ClientAdvisor"
 
+log_streams = {}
+
+# Capture logs per test
+@pytest.hookimpl(tryfirst=True)
+def pytest_runtest_setup(item):
+    stream = io.StringIO()
+    handler = logging.StreamHandler(stream)
+    handler.setLevel(logging.INFO)
+    logger = logging.getLogger()
+    logger.addHandler(handler)
+    log_streams[item.nodeid] = (handler, stream)
 
+# Add captured logs 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.extras = 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 = ""
+
+# Optional: simplify test display names if using `prompt`
+def pytest_collection_modifyitems(items):
+    for item in items:
+        # Retain only the readable part after the last `[` and before the closing `]`
+        if "[" in item.nodeid and "]" in item.nodeid:
+            pretty_name = item.nodeid.split("[", 1)[1].rsplit("]", 1)[0]
+            item._nodeid = pretty_name
+        else:
+            # Use function name as fallback
+            item._nodeid = item.name
+
+
+# Rename 'Duration' column in HTML report
+def rename_duration_column():
+    report_path = os.path.abspath("report.html")
+    if not os.path.exists(report_path):
+        print("Report file not found, skipping column rename.")
+        return
+
+    with open(report_path, 'r', encoding='utf-8') as f:
+        soup = BeautifulSoup(f, '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 open(report_path, 'w', encoding='utf-8') as f:
+        f.write(str(soup))
+
+# Run after tests complete
+atexit.register(rename_duration_column)

tests/e2e-test/tests/test_poc_byoc_client_advisor.py

@@ -1,141 +1,86 @@
+import logging
+import time
+import pytest
 from config.constants import *
 from pages.homePage import HomePage
 
+logger = logging.getLogger(__name__)
 
-# def test_chatbot_responds_with_upcoming_meeting_schedule_date(login_logout):
-#     page = login_logout
-#     home_page = HomePage(page)
-#     # validate page title
-#     assert homepage_title == page.locator(home_page.HOME_PAGE_TITLE).text_content()
-#     # select a client
-#     home_page.select_a_client(client_name)
-#     # validate selected client name
-#     assert client_name == page.locator(home_page.SELECTED_CLIENT_NAME_LABEL).text_content()
-#     # ask a question
-#     home_page.enter_a_question(next_meeting_question)
-#     # click send button
-#     home_page.click_send_button()
-#     # Validate response status code
-#     home_page.validate_response_status()
-#     # validate the upcoming meeting date-time in both side panel and response
-#     home_page.validate_next_meeting_date_time()
+def validate_home_and_client(home):
+    assert homepage_title == home.page.locator(home.HOME_PAGE_TITLE).text_content()
+    home.select_a_client(client_name)
+    assert client_name == home.page.locator(home.SELECTED_CLIENT_NAME_LABEL).text_content()
 
-def test_save_chat_confirmation_popup(login_logout):
-    page = login_logout
-    home_page = HomePage(page)
-    # validate page title
-    assert homepage_title == page.locator(home_page.HOME_PAGE_TITLE).text_content()
-    # select a client
-    home_page.select_a_client(client_name)
-    # validate selected client name
-    assert client_name == page.locator(home_page.SELECTED_CLIENT_NAME_LABEL).text_content()
-    # clear the chat if any
-    home_page.click_clear_chat_icon()
-    # ask a question
-    home_page.enter_a_question(golden_path_question1)
-    # click send button
-    home_page.click_send_button()
-    # Validate response status code
-    home_page.validate_response_status()
-    #click on the plus button
-    home_page.click_on_save_chat_plus_icon()
-    assert page.locator(home_page.SAVE_CHAT_CONFIRMATION_POPUPTEXT).is_visible()
+def save_chat_confirmation_popup(home):
+    home.click_clear_chat_icon()
+    home.enter_a_question(golden_path_question1)
+    home.click_send_button()
+    home.validate_response_status()
+    home.click_on_save_chat_plus_icon()
+    assert home.page.locator(home.SAVE_CHAT_CONFIRMATION_POPUPTEXT).is_visible()
 
-def test_delete_chat_history_during_response(login_logout):
-    page = login_logout
-    home_page = HomePage(page)
-    # validate page title
-    assert homepage_title == page.locator(home_page.HOME_PAGE_TITLE).text_content()
-    # select a client
-    home_page.select_a_client(client_name)
-    # validate selected client name
-    assert client_name == page.locator(home_page.SELECTED_CLIENT_NAME_LABEL).text_content()
-    # ask a question
-    home_page.enter_a_question(golden_path_question1)
-    # click send button
-    home_page.click_send_button()
-    #click on the plus button
-    home_page.click_on_save_chat_plus_icon()
-    assert page.locator(home_page.SAVE_CHAT_CONFIRMATION_POPUPTEXT).is_visible()
-    #click on show chat history button
-    home_page.click_on_show_chat_history_button()
-    #click on saved chat history
-    home_page.click_on_saved_chat()
-    #ask the question 
-    home_page.enter_a_question(golden_path_question1)
-    #click on click_send_button_for_chat_history_response 
-    home_page.click_send_button_for_chat_history_response()
-    # validate the delete icon disabled
-    assert page.locator(home_page.SHOW_CHAT_HISTORY_DELETE_ICON).is_disabled()
-    # click on  hide chat history button
-    home_page.click_hide_chat_history_button()
-    # clear the chat
-    home_page.click_clear_chat_icon()
-    
-def test_golden_path_demo_script(login_logout):
+def delete_chat_history_during_response(home):
+    home.enter_a_question(golden_path_question1)
+    home.click_send_button()
+    home.click_on_save_chat_plus_icon()
+    assert home.page.locator(home.SAVE_CHAT_CONFIRMATION_POPUPTEXT).is_visible()
+    home.click_on_show_chat_history_button()
+    home.click_on_saved_chat()
+    home.enter_a_question(golden_path_question1)
+    home.click_send_button_for_chat_history_response()
+    assert home.page.locator(home.SHOW_CHAT_HISTORY_DELETE_ICON).is_disabled()
+    home.click_hide_chat_history_button()
+    home.click_clear_chat_icon()
+
+def golden_path_full_demo(home):
+    _validate_golden_path_response(home, golden_path_question1)
+    _validate_golden_path_response(home, golden_path_question2)
+    _validate_golden_path_response(home, golden_path_question3)
+    _validate_golden_path_response(home, golden_path_question4)
+    _validate_golden_path_response(home, golden_path_question5)
+    _validate_client_info_absence(home, golden_path_question7)
+
+# Define test steps and actions
+test_cases = [
+    ("Validate homepage and select client", validate_home_and_client),
+    ("Save chat confirmation popup", save_chat_confirmation_popup),
+    ("Delete chat history during response", delete_chat_history_during_response),
+    ("Golden path full demo", golden_path_full_demo),
+]
+
+# Create readable test IDs
+test_ids = [f"{i+1:02d}. {desc}" for i, (desc, _) in enumerate(test_cases)]
+
+def _validate_golden_path_response(home, question):
+    home.enter_a_question(question)
+    home.click_send_button()
+    home.validate_response_status()
+    response_text = home.page.locator(home.ANSWER_TEXT)
+    assert response_text.nth(response_text.count() - 1).text_content() != invalid_response, \
+        f"Incorrect response for question: {question}"
+
+def _validate_client_info_absence(home, question):
+    home.enter_a_question(question)
+    home.click_send_button()
+    home.validate_response_status()
+    response_text = home.page.locator(home.ANSWER_TEXT).nth(home.page.locator(home.ANSWER_TEXT).count() - 1).text_content().lower()
+    assert "arun sharma" not in response_text, "Other client information appeared in response."
+    assert client_name.lower() not in response_text, f"Client name '{client_name}' should not be in response for question: {question}"
+
+@pytest.mark.parametrize("desc, action", test_cases, ids=test_ids)
+def test_home_page_cases(login_logout, desc, action, request):
+    """
+    Parametrized test for home page scenarios including chat flows and validations.
+    """
     page = login_logout
     home_page = HomePage(page)
-    # validate page title
-    assert homepage_title == page.locator(home_page.HOME_PAGE_TITLE).text_content()
-    # select a client
-    home_page.select_a_client(client_name)
-    # validate selected client name
-    assert client_name == page.locator(home_page.SELECTED_CLIENT_NAME_LABEL).text_content()
-    # ask a question
-    home_page.enter_a_question(golden_path_question1)
-    # click send button
-    home_page.click_send_button()
-    # Validate response status code
-    home_page.validate_response_status()
-    response_text = page.locator(home_page.ANSWER_TEXT)
-    # validate the response
-    assert response_text.nth(response_text.count()-1).text_content() != invalid_response,"Incorrect response for question: "+golden_path_question1
-    # ask a question
-    home_page.enter_a_question(golden_path_question2)
-    # click send button
-    home_page.click_send_button()
-    # Validate response status code
-    home_page.validate_response_status()
-    # validate the response
-    assert response_text.nth(response_text.count() - 1).text_content() != invalid_response,"Incorrect response for question: "+golden_path_question2
-    # ask a question
-    home_page.enter_a_question(golden_path_question3)
-    # click send button
-    home_page.click_send_button()
-    # Validate response status code
-    home_page.validate_response_status()
-    # validate the response
-    assert response_text.nth(response_text.count() - 1).text_content() != invalid_response,"Incorrect response for question: "+golden_path_question3
-    # ask a question
-    home_page.enter_a_question(golden_path_question4)
-    # click send button
-    home_page.click_send_button()
-    # Validate response status code
-    home_page.validate_response_status()
-    # validate the response
-    assert response_text.nth(response_text.count() - 1).text_content() != invalid_response,"Incorrect response for question: "+golden_path_question4
-    # ask a question
-    home_page.enter_a_question(golden_path_question5)
-    # click send button
-    home_page.click_send_button()
-    # Validate response status code
-    home_page.validate_response_status()
-    # validate the response
-    assert response_text.nth(response_text.count() - 1).text_content() != invalid_response,"Incorrect response for question: "+golden_path_question5
-    # # ask a question
-    # home_page.enter_a_question(golden_path_question6)
-    # # click send button
-    # home_page.click_send_button()
-    # # Validate response status code
-    # home_page.validate_response_status()
-    # # validate the response
-    # assert response_text.nth(response_text.count() - 1).text_content() != invalid_response,"Incorrect response for question: "+golden_path_question6
-    # ask a question
-    home_page.enter_a_question(golden_path_question7)
-    # click send button
-    home_page.click_send_button()
-    # Validate response status code
-    home_page.validate_response_status()
-    # validate the response
-    assert (response_text.nth(response_text.count() - 1).text_content().lower()).find("arun sharma") == -1,"Other client information in response for client: "+client_name
-    assert (response_text.nth(response_text.count() - 1).text_content().lower()).find(client_name) == -1,"Response is generated for selected client "+client_name+" even client name is different in question: "+golden_path_question7
+    home_page.page = page  # Required for locator access in helper functions
+    logger.info(f"Running step: {desc}")
+
+    start = time.time()
+    action(home_page)
+    end = time.time()
+
+    duration = end - start
+    logger.info(f"Execution Time for '{desc}': {duration:.2f}s")
+    request.node._report_sections.append(("call", "log", f"Execution time: {duration:.2f}s"))