test: DocGen-fixed pylint issues

Ritesh-Microsoft · Ritesh-Microsoft · commit af95d756c97d · 2025-06-26T16:16:02.000+05:30
diff --git a/tests/e2e-test/base/base.py b/tests/e2e-test/base/base.py
@@ -45,4 +45,33 @@ def validate_response_status(self, question_api=""):
             "response code is " + str(response.status) + " " + str(response.json())
         )
 
-  
+
+    def validate_generate_response_status(self, question_api=""):
+        load_dotenv()  # Ensure environment variables are loaded
+        # URL of the API endpoint
+        url = f"{URL}/history/generate"
+
+        # Prepare headers
+        headers = {
+            "Content-Type": "application/json",
+            "Accept": "*/*",
+        }
+
+        # Payload (data) to be sent in the POST request
+        payload = {
+            "chat_type": "browse",
+            "messages": [
+                {
+                    "role": "user",
+                    "content": question_api,  # Use the passed question
+                }
+            ],
+        }
+
+        # Make the POST request
+        response = self.page.request.post(
+            url, headers=headers, data=json.dumps(payload), timeout=120000
+        )
+        assert response.status == 200, (
+            "response code is " + str(response.status) + " " + str(response.json())
+        )
diff --git a/tests/e2e-test/config/constants.py b/tests/e2e-test/config/constants.py
@@ -29,3 +29,4 @@
 
 # Response Text Data
 invalid_response = "I was unable to find content related to your query and could not generate a template. Please try again."
+invalid_response1 = "An error occurred. Answers can't be saved at this time. If the problem persists, please contact the site administrator."
diff --git a/tests/e2e-test/pages/draftPage.py b/tests/e2e-test/pages/draftPage.py
@@ -1,7 +1,5 @@
 from base.base import BasePage
 from pytest_check import check
-import time
-from collections import defaultdict
 
 
 class DraftPage(BasePage):
@@ -23,10 +21,10 @@ def check_draft_sections(self, timeout: float = 180.0, poll_interval: float = 0.
         Scrolls into view if needed, retries until timeout.
         Raises clear errors if validation fails.
         """
-        from collections import defaultdict
         import time
-        start_time = time.time()
+        from collections import defaultdict
 
+        start_time = time.time()
 
         while time.time() - start_time < timeout:
             section_elements = self.page.locator(self.Draft_Sections)
@@ -55,7 +53,10 @@ def check_draft_sections(self, timeout: float = 180.0, poll_interval: float = 0.
 
                     if not section_text:
                         failed_sections[i] = "Empty"
-                    elif section_text in (self.invalid_response, self.invalid_response1):
+                    elif section_text in (
+                        self.invalid_response,
+                        self.invalid_response1,
+                    ):
                         failed_sections[i] = f"Invalid: {repr(section_text[:30])}"
 
                 except Exception as e:
@@ -68,7 +69,9 @@ def check_draft_sections(self, timeout: float = 180.0, poll_interval: float = 0.
                 time.sleep(poll_interval)
 
         else:
-            raise TimeoutError(f"❌ Timeout: These sections did not load valid content: {failed_sections}")
+            raise TimeoutError(
+                f"❌ Timeout: These sections did not load valid content: {failed_sections}"
+            )
 
         # ✅ Final validations after loading
         for i in range(section_count):
@@ -81,10 +84,20 @@ def check_draft_sections(self, timeout: float = 180.0, poll_interval: float = 0.
             heading_text = heading.inner_text(timeout=3000).strip()
             content = section.input_value().strip()
 
-            print(f"[VALIDATING] Section {i}: '{heading_text}' → {repr(content[:60])}...")
+            print(
+                f"[VALIDATING] Section {i}: '{heading_text}' → {repr(content[:60])}..."
+            )
 
             with check:
                 check.is_not_none(content, f"❌ Section '{heading_text}' is None")
                 check.not_equal(content, "", f"❌ Section '{heading_text}' is empty")
-                check.not_equal(content, self.invalid_response, f"❌ '{heading_text}' has invalid response")
-                check.not_equal(content, self.invalid_response1, f"❌ '{heading_text}' has invalid response")
+                check.not_equal(
+                    content,
+                    self.invalid_response,
+                    f"❌ '{heading_text}' has invalid response",
+                )
+                check.not_equal(
+                    content,
+                    self.invalid_response1,
+                    f"❌ '{heading_text}' has invalid response",
+                )
diff --git a/tests/e2e-test/pages/generatePage.py b/tests/e2e-test/pages/generatePage.py
@@ -1,12 +1,14 @@
+from asyncio.log import logger
+
 from base.base import BasePage
 from playwright.sync_api import expect
-from asyncio.log import logger
+
 
 class GeneratePage(BasePage):
     GENERATE_DRAFT = "//button[@title='Generate Draft']"
     TYPE_QUESTION = "//textarea[@placeholder='Type a new question...']"
     SEND_BUTTON = "//div[@aria-label='Ask question button']"
-    SHOW_CHAT_HISTORY_BUTTON="//span[text()='Show template history']"
+    SHOW_CHAT_HISTORY_BUTTON = "//span[text()='Show template history']"
     HIDE_CHAT_HISTORY_BUTTON = "//span[text()='Hide Chat History']"
     CHAT_HISTORY_ITEM = "//body//div[@id='root']//div[@role='presentation']//div[@role='presentation']//div[1]//div[1]//div[1]//div[1]//div[1]//div[1]"
     SHOW_CHAT_HISTORY = "//span//i"
@@ -28,7 +30,25 @@ def enter_a_question(self, text):
     def click_send_button(self):
         # Type a question in the text area
         self.page.locator(self.SEND_BUTTON).click()
-        self.page.wait_for_timeout(10000)
+        locator = self.page.locator("//p[contains(text(),'Generating template...this may take up to 30 secon')]")
+        stop_button = self.page.locator("//div[@aria-label='Stop generating']")
+
+        try:
+            # Wait up to 60s for the element to become **hidden**
+            locator.wait_for(state="hidden", timeout=60000)
+        except TimeoutError:
+            # Raise a custom failure if it's still visible after 60s
+            raise AssertionError("❌ TIMED-OUT: Not recieved response within specific time limit.")
+        
+        finally:
+        # Always attempt to click the stop button after test fail
+            if stop_button.is_visible():
+                stop_button.click()
+                print("Clicked on 'Stop generating' button after timeout.")
+            else:
+                print("'Stop generating' button not visible.")
+
+        self.page.wait_for_timeout(5000)
 
     def click_generate_draft_button(self):
         # Type a question in the text area
@@ -52,15 +72,20 @@ def close_chat_history(self):
             hide_button.click()
             self.page.wait_for_timeout(2000)
         else:
-            logger.info("Hide button not visible. Chat history might already be closed.")
+            logger.info(
+                "Hide button not visible. Chat history might already be closed."
+            )
 
     def delete_chat_history(self):
 
         self.page.locator(self.SHOW_CHAT_HISTORY_BUTTON).click()
+        self.page.wait_for_timeout(4000)
         chat_history = self.page.locator("//span[contains(text(),'No chat history.')]")
         if chat_history.is_visible():
             self.page.wait_for_load_state("networkidle")
-            self.page.locator("button[title='Hide']").wait_for(state="visible", timeout=5000)
+            self.page.locator("button[title='Hide']").wait_for(
+                state="visible", timeout=5000
+            )
             self.page.locator("button[title='Hide']").click()
 
         else:
@@ -71,4 +96,3 @@ def delete_chat_history(self):
             self.page.locator(self.CHAT_HISTORY_CLOSE).click()
             self.page.wait_for_load_state("networkidle")
             self.page.wait_for_timeout(2000)
-
diff --git a/tests/e2e-test/tests/conftest.py b/tests/e2e-test/tests/conftest.py
@@ -1,15 +1,11 @@
-from pathlib import Path
-import pytest
-from playwright.sync_api import sync_playwright
-from config.constants import *
-from slugify import slugify
-from dotenv import load_dotenv
-import os
-from py.xml import html # type: ignore
+import atexit
 import io
 import logging
+import os
+import pytest
 from bs4 import BeautifulSoup
-import atexit
+from config.constants import URL
+from playwright.sync_api import sync_playwright
 
 
 @pytest.fixture(scope="session")
@@ -26,11 +22,10 @@ def login_logout():
         # Wait for the login form to appear
         # page.wait_for_load_state('networkidle')
         # login to web url with username and password
-        #login_page = LoginPage(page)
-        #load_dotenv()
-        #login_page.authenticate(os.getenv('user_name'),os.getenv('pass_word'))
+        # 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()
 
@@ -42,6 +37,7 @@ def pytest_html_report_title(report):
 
 log_streams = {}
 
+
 @pytest.hookimpl(tryfirst=True)
 def pytest_runtest_setup(item):
     # Prepare StringIO for capturing logs
@@ -80,34 +76,39 @@ def pytest_runtest_makereport(item, call):
     else:
         report.description = ""
 
+
 def pytest_collection_modifyitems(items):
     for item in items:
-        if hasattr(item, 'callspec'):
+        if hasattr(item, "callspec"):
             prompt = item.callspec.params.get("prompt")
             if prompt:
-                item._nodeid = prompt  # This controls how the test name appears in the report
+                item._nodeid = (
+                    prompt  # This controls how the test name appears in the report
+                )
+
 
 def rename_duration_column():
     report_path = os.path.abspath("report.html")  # or your report filename
     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')
+    with open(report_path, "r", encoding="utf-8") as f:
+        soup = BeautifulSoup(f, "html.parser")
 
     # Find and rename the header
-    headers = soup.select('table#results-table thead th')
+    headers = soup.select("table#results-table thead th")
     for th in headers:
-        if th.text.strip() == 'Duration':
-            th.string = 'Execution Time'
-            #print("Renamed 'Duration' to 'Execution Time'")
+        if th.text.strip() == "Duration":
+            th.string = "Execution Time"
+            # print("Renamed 'Duration' to 'Execution Time'")
             break
     else:
         print("'Duration' column not found in report.")
 
-    with open(report_path, 'w', encoding='utf-8') as f:
+    with open(report_path, "w", encoding="utf-8") as f:
         f.write(str(soup))
 
+
 # Register this function to run after everything is done
-atexit.register(rename_duration_column)
+atexit.register(rename_duration_column)
diff --git a/tests/e2e-test/tests/test_gp_docgen.py b/tests/e2e-test/tests/test_gp_docgen.py
@@ -1,19 +1,14 @@
 import logging
 import time
-import pytest
-from pytest_check import check
 
-from config.constants import (
-    add_section,
-    browse_question1,
-    browse_question2,
-    generate_question1,
-    invalid_response,
-)
+import pytest
+from config.constants import (add_section, browse_question1, browse_question2,
+                              generate_question1, invalid_response, invalid_response1)
 from pages.browsePage import BrowsePage
 from pages.draftPage import DraftPage
 from pages.generatePage import GeneratePage
 from pages.homePage import HomePage
+from pytest_check import check
 
 logger = logging.getLogger(__name__)
 
@@ -31,6 +26,7 @@ def setup_pages(login_logout):
 
 # ---------- INDIVIDUAL TEST CASES ----------
 
+
 def test_load_home_and_navigate_to_browse_page(setup_pages, request):
     request.node._nodeid = "Validate Home Page is loaded and navigating to Browse Page"
     _, home, browse, *_ = setup_pages
@@ -45,7 +41,9 @@ def test_load_home_and_navigate_to_browse_page(setup_pages, request):
         raise
 
     duration = time.time() - start
-    logger.info(f"Test 'Home to Browse Page Navigation' completed in {duration:.2f} seconds.")
+    logger.info(
+        f"Test 'Home to Browse Page Navigation' completed in {duration:.2f} seconds."
+    )
 
 
 @pytest.mark.parametrize("question", [browse_question1])
@@ -80,6 +78,7 @@ def test_browse_prompt2(setup_pages, question, request):
         logger.info(f"Entering Browse Question 2: {question}")
         browse.enter_a_question(question)
         browse.click_send_button()
+        browse.validate_response_status(question_api=question)
         browse.click_expand_reference_in_response()
         browse.click_reference_link_in_response()
         browse.close_citation()
@@ -113,6 +112,7 @@ def test_delete_chat_history_before_generate_prompt1(setup_pages, request):
 MAX_RETRIES = 3
 RETRY_DELAY = 3  # seconds
 
+
 @pytest.mark.parametrize("question", [generate_question1])
 def test_generate_prompt(setup_pages, question, request):
     request.node._nodeid = f"Validate response for GENERATE Prompt1 : {question}"
@@ -128,22 +128,24 @@ def test_generate_prompt(setup_pages, question, request):
             logger.info(f"Attempt {attempt}: Entering Generate Question: {question}")
             generate.enter_a_question(question)
             generate.click_send_button()
+            generate.validate_generate_response_status(question_api=question)
+
 
             time.sleep(2)
             response_text = page.locator("//p")
-            latest_response = response_text.nth(response_text.count() - 1).text_content()
+            latest_response = response_text.nth(
+                response_text.count() - 1
+            ).text_content()
 
-            if latest_response != invalid_response:
-                logger.info(f"Valid response received on attempt {attempt}")
-                generate.validate_response_status(question_api=question)
+            if latest_response not in [invalid_response, invalid_response1]:
+                logger.info(f"Valid response received on attempt {attempt}")       
                 break
             else:
                 logger.warning(f"Invalid response received on attempt {attempt}")
                 if attempt == MAX_RETRIES:
                     check.not_equal(
-                        invalid_response,
-                        latest_response,
-                        f"FAILED: Invalid response received after {MAX_RETRIES} attempts for: {question}"
+                        latest_response not in [invalid_response, invalid_response1],
+                        f"FAILED: Invalid response received after {MAX_RETRIES} attempts for: {question}",
                     )
                 else:
                     time.sleep(RETRY_DELAY)
@@ -166,7 +168,7 @@ def test_add_section_prompt(setup_pages, question, request):
         logger.info(f"Entering Add Section Question: {question}")
         generate.enter_a_question(question)
         generate.click_send_button()
-        browse.validate_response_status(question_api=question)
+        browse.validate_generate_response_status(question_api=question)
     except Exception as e:
         logger.error(f"FAILED while validating Add Section Prompt '{question}': {e}")
         raise
@@ -191,7 +193,9 @@ def test_generate_draft_from_section_prompt(setup_pages, request):
         raise
 
     duration = time.time() - start
-    logger.info(f"Test 'Generate Draft and Validate Sections' completed in {duration:.2f} seconds.")
+    logger.info(
+        f"Test 'Generate Draft and Validate Sections' completed in {duration:.2f} seconds."
+    )
 
 
 def test_show_chat_history_at_end(setup_pages, request):

Original file line number	Diff line number	Diff line change
`@@ -29,3 +29,4 @@`
`29`	`29`
`30`	`30`	`# Response Text Data`
`31`	`31`	`invalid_response = "I was unable to find content related to your query and could not generate a template. Please try again."`
	`32`	`+invalid_response1 = "An error occurred. Answers can't be saved at this time. If the problem persists, please contact the site administrator."`