test: add citation link interaction support to e2e tests (#1821)

Co-authored-by: Harmanpreet Kaur <[email protected]>

Author: Harmanpreet-Microsoft

tests/e2e-test/pages/webUserPage.py

@@ -20,6 +20,10 @@ class WebUserPage(BasePage):
     CHAT_HISTORY_OPTIONS = "//button[@id='moreButton']"
     CHAT_HISTORY_DELETE = "//button[@role='menuitem']"
 
+    TOGGLE_CITATIONS_LIST = "[data-testid='toggle-citations-list']"
+    CITATIONS_CONTAINER = "[data-testid='citations-container']"
+    CITATION_BLOCK = "[data-testid='citation-block']"
+
     def __init__(self, page):
         self.page = page
         self.soft_assert_errors = []
@@ -76,3 +80,47 @@ def delete_chat_history(self):
             self.page.get_by_label("hide button").click()
             self.page.wait_for_load_state("networkidle")
             self.page.wait_for_timeout(2000)
+
+    def click_reference_link_in_response(self):
+        response_blocks = self.page.locator(self.ANSWER_TEXT)
+        last_response = response_blocks.nth(response_blocks.count() - 1)
+        toggle_button = last_response.locator(self.TOGGLE_CITATIONS_LIST)
+        citations_container = last_response.locator(self.CITATIONS_CONTAINER)
+
+
+        if not citations_container.is_visible():
+            toggle_button.click()
+            self.page.wait_for_timeout(1000)
+
+        citation = citations_container.locator(self.CITATION_BLOCK).first
+
+
+        citation.click()
+        self.page.wait_for_load_state('networkidle')
+        self.page.wait_for_timeout(2000)
+
+    def close_citation(self):
+        self.page.wait_for_timeout(3000)
+        close_btn = self.page.locator(self.CLOSE_CITATIONS)
+        close_btn.wait_for(state="attached", timeout=5000)
+        close_btn.scroll_into_view_if_needed()
+        close_btn.click(force=True)
+        self.page.wait_for_timeout(5000)
+
+    def has_reference_link(self):
+        response_blocks = self.page.locator(self.ANSWER_TEXT)
+
+        count = response_blocks.count()
+        if count == 0:
+            return False
+        last_response = response_blocks.nth(count - 1)
+        toggle_button = last_response.locator(self.TOGGLE_CITATIONS_LIST)
+        if toggle_button.count() > 0:
+            toggle_button.click()
+
+
+        citations_container = last_response.locator(self.CITATIONS_CONTAINER)
+        citation_blocks = citations_container.locator(self.CITATION_BLOCK)
+        citation_count = citation_blocks.count()
+
+        return citation_count > 0

tests/e2e-test/tests/test_poc_chat_with_your_data.py

@@ -39,6 +39,12 @@ def ask_question_and_check(question, attempt):
         response_text = page.locator(home_page.ANSWER_TEXT)
         response_count = response_text.count()
 
+        if home_page.has_reference_link():
+            logger.info("Step 6.1: Reference link found. Opening citation.")
+            home_page.click_reference_link_in_response()
+            logger.info("Step 6.2: Closing citation.")
+            home_page.close_citation()
+
         if response_count == 0:
             return False  # no response found