Merge pull request #6726 from emilghittasv/playwright-update-aaq

emilghittasv · web-flow · commit 107ead7af476 · 2025-06-18T21:19:02.000+03:00
Playwright: Extend coverage to related documents functionality
diff --git a/playwright_tests/flows/explore_articles_flows/article_flows/edit_article_meta_flow.py b/playwright_tests/flows/explore_articles_flows/article_flows/edit_article_meta_flow.py
@@ -6,6 +6,8 @@
 from playwright_tests.pages.explore_help_articles.articles.kb_article_page import KBArticlePage
 from playwright_tests.pages.explore_help_articles.articles.kb_edit_article_meta import (
     KBArticleEditMetadata)
+from playwright_tests.pages.explore_help_articles.articles.kb_edit_article_page import \
+    EditKBArticlePage
 from playwright_tests.pages.explore_help_articles.articles.submit_kb_article_page import \
     SubmitKBArticlePage
 
@@ -17,6 +19,7 @@ def __init__(self, page: Page):
         self.kb_article_edit_metadata_page = KBArticleEditMetadata(page)
         self.submit_kb_article_page = SubmitKBArticlePage(page)
         self.kb_article_page = KBArticlePage(page)
+        self.edit_kb_article_page = EditKBArticlePage(page)
 
     def edit_article_metadata(self, **kwargs):
         return self.utilities.re_call_function_on_error(
@@ -33,11 +36,15 @@ def _edit_article_metadata(self, title=None,
                                needs_change=False,
                                needs_change_comment=False,
                                restricted_to_groups: list[str] = None,
+                               related_documents: list[str] = None,
                                single_group=""):
 
         if KBArticleRevision.KB_EDIT_METADATA not in self.utilities.get_page_url():
             self.kb_article_page.click_on_edit_article_metadata()
 
+        if self.edit_kb_article_page.is_edit_anyway_option_visible():
+            self.edit_kb_article_page.click_on_edit_anyway_option()
+
         if restricted_to_groups:
             for group in restricted_to_groups:
                 (self.kb_article_edit_metadata_page
@@ -101,17 +108,23 @@ def _edit_article_metadata(self, title=None,
             if self.kb_article_edit_metadata_page.is_needs_change_checkbox():
                 self.kb_article_edit_metadata_page.click_needs_change_checkbox()
 
+        if related_documents:
+            for document in related_documents:
+                self.kb_article_edit_metadata_page.add_related_documents(document)
+
         self.kb_article_edit_metadata_page.click_on_save_changes_button()
 
     def remove_a_restricted_visibility_group(self, **kwargs):
         return self.utilities.re_call_function_on_error(
             lambda: self._remove_a_restricted_visibility_group(**kwargs)
         )
 
-    def _remove_a_restricted_visibility_group(self, group_name=''):
+    def _remove_a_restricted_visibility_group(self, group_name=""):
         if KBArticleRevision.KB_EDIT_METADATA not in self.utilities.get_page_url():
             self.kb_article_page.click_on_edit_article_metadata()
 
+        if self.edit_kb_article_page.is_edit_anyway_option_visible():
+            self.edit_kb_article_page.click_on_edit_anyway_option()
         self.kb_article_edit_metadata_page.delete_a_restricted_visibility_group_metadata(
             group_name)
         self.kb_article_edit_metadata_page.click_on_save_changes_button()
diff --git a/playwright_tests/pages/explore_help_articles/articles/kb_article_page.py b/playwright_tests/pages/explore_help_articles/articles/kb_article_page.py
@@ -42,7 +42,7 @@ def __init__(self, page: Page):
         self.editing_tools_show_history_option = page.get_by_role("link", name="Show History",
                                                                   exact=True)
 
-        # Helpfulness widget
+        # Helpfulness widget section locators.
         self.helpfulness_widget = page.locator("form[class='document-vote--form helpful']")
         self.helpful_button = page.locator("button[class='btn helpful-button']")
         self.unhelpful_button = page.locator("button[class='btn not-helpful-button']")
@@ -54,6 +54,14 @@ def __init__(self, page: Page):
             "//div[@class='sumo-button-wrap align-full']/button[normalize-space(text())='Submit']")
         self.survey_message = page.locator("div[class='survey-message']")
 
+        # Related Articles section locators.
+        self.related_articles_section = page.locator("section#related-documents")
+        self.related_article_cards = page.locator("section#related-documents h3.card--title a")
+        self.related_article = lambda article_title: page.locator(
+            f'//section[@id="related-documents"]//h3[@class="card--title"]/a[normalize-space('
+            f'text())="{article_title}"]'
+        )
+
     # KB Article page content actions.
     def click_on_a_particular_breadcrumb(self, breadcrumb_name: str):
         self._click(self.article_breadcrumb(breadcrumb_name))
@@ -158,3 +166,13 @@ def click_on_helpfulness_submit_button(self):
 
     def get_survey_message_text(self) -> str:
         return self._get_text_of_element(self.survey_message)
+
+    def is_related_articles_section_displayed(self) -> bool:
+        return self._is_element_visible(self.related_articles_section)
+
+    def get_list_of_related_articles(self) -> list[str]:
+        return [article.strip() for article in self._get_text_of_elements(
+            self.related_article_cards)]
+
+    def click_on_related_article_card(self, article_title: str):
+        self._click(self.related_article(article_title))
diff --git a/playwright_tests/pages/explore_help_articles/articles/kb_edit_article_meta.py b/playwright_tests/pages/explore_help_articles/articles/kb_edit_article_meta.py
@@ -24,6 +24,17 @@ def __init__(self, page: Page):
         self.allow_discussion_checkbox = page.locator("input#id_allow_discussion")
         self.needs_change_checkbox = page.locator("input#id_needs_change")
         self.needs_change_textarea = page.locator("textarea#id_needs_change_comment")
+        self.related_documents_field = page.locator("input#search-related-ts-control")
+        self.related_documents_search_result = lambda search_term : page.locator(
+            f'//div[@id="search-related-ts-dropdown"]/div[normalize-space(.)="{search_term}"]'
+        )
+        self.related_documents_search_results = page.locator(
+            "div#search-related-ts-dropdown div")
+        self.added_related_documents = page.locator("div.ts-control div.item")
+        self.remove_related_documents_button = lambda related_document: page.locator(
+            f'//div[@class="item" and text()="{related_document}"]/a')
+        self.no_results_found_related_documents_message = page.locator(
+            "div#search-related-ts-dropdown div.no-results")
         self.save_changes_button = page.get_by_role("button", name="Save", exact=True)
         self.delete_group = lambda chosen_group: page.locator(
             f"//input[@id='id_restrict_to_groups-selectized']/../div[text()='{chosen_group}']/a")
@@ -102,6 +113,25 @@ def click_needs_change_checkbox(self):
     def fill_needs_change_textarea(self, text: str):
         self._fill(self.needs_change_textarea, text)
 
+    def add_related_documents(self, document_name: str, submit: bool = True):
+        self._fill(self.related_documents_field, document_name)
+        if submit:
+            self._wait_for_locator(self.related_documents_search_result(document_name), 5000)
+            self._click(self.related_documents_search_result(document_name))
+
+    def is_no_related_documents_displayed(self) -> bool:
+        return self._is_element_visible(self.no_results_found_related_documents_message)
+
+    def get_related_documents_search_options(self) -> list[str]:
+        return self._get_text_of_elements(self.related_documents_search_results)
+
+    def get_related_documents(self) -> list[str]:
+        return [text.replace("\n×", "").strip() for text in self._get_text_of_elements(
+            self.added_related_documents)]
+
+    def remove_related_document(self, document_name: str):
+        self._click(self.remove_related_documents_button(document_name))
+
     def click_on_save_changes_button(self):
         self._click(self.save_changes_button)
         self.wait_for_page_to_load()
diff --git a/playwright_tests/pages/explore_help_articles/articles/kb_edit_article_page.py b/playwright_tests/pages/explore_help_articles/articles/kb_edit_article_page.py
@@ -42,6 +42,9 @@ def get_edit_article_warning_message(self) -> str:
     def click_on_edit_anyway_option(self):
         self._click(self.edit_by_another_user_edit_anyway_option)
 
+    def is_edit_anyway_option_visible(self) -> bool:
+        return self._is_element_visible(self.edit_by_another_user_edit_anyway_option)
+
     # Edit kb article page field actions.
     def get_edit_article_keywords_field_value(self) -> str:
         return self._get_element_input_value(self.edit_article_keywords_field)
diff --git a/playwright_tests/test_data/aaq_question.json b/playwright_tests/test_data/aaq_question.json
@@ -1,10 +1,10 @@
 {
   "valid_firefox_question": {
-    "subject": "Test Question ",
-    "subject_updated": "Test Question Updated",
+    "subject": "NVDA does not work with Firefox ",
+    "subject_updated": "NVDA does not work with Firefox Updated",
     "topic_value": "Accessibility",
-    "question_body": "'''I have a problem''' when I ''access'', the following link: [https://www.mediafax.ro adipiscing], the Firefox browser is not performing is unable to output the messages coming from the screen reader. I've tried reading the following article: [[Stage test owl|sed]] but it doesn't help me understand what is the root cause and how can I fixed the missing content. Can somebody please help me?",
-    "body_updated": "Updated body",
+    "question_body": "'''I have a problem''' when I ''access'', the following link: [https://www.mediafax.ro adipiscing], the Firefox browser is unable to output the messages coming from the screen reader. I've tried reading the following article: [[Stage test owl|sed]] but it doesn't help me understand what is the root cause and how can I fix the missing content. Can somebody please help me with this accessibility issue?",
+    "body_updated": "I have a problem when I access, any links on the internet, the Firefox browser is unable to output the messages coming from the screen reader. I've tried reading an article but it doesn't help me understand what is the root cause and how can I fix the missing content. Can somebody please help me with this accessibility issue? Updated",
     "simple_body_text": "Firefox doesn't work in combination with the NVDA screen reader",
     "image_name": "test.image.jpg",
     "image_path": "test_data/test-image.png",
diff --git a/playwright_tests/tests/ask_a_question_tests/aaq_tests/test_aaq_form_page.py b/playwright_tests/tests/ask_a_question_tests/aaq_tests/test_aaq_form_page.py
@@ -265,11 +265,11 @@ def test_post_aaq_questions_for_all_freemium_products_topics(page: Page):
             for topic in sumo_pages.aaq_form_page.get_aaq_form_topic_options():
                 with allure.step(f"Submitting question for {product} product"):
                     question_info = sumo_pages.aaq_flow.submit_an_aaq_question(
-                        subject=utilities.aaq_question_test_data["valid_firefox_question"]
-                        ["subject"],
+                        subject=f"Issue related to the {topic} topic",
                         topic_name=topic,
-                        body=f"I have a problem with {topic}. It doesn't seem to work whatever I"
-                             f" try to do... Can you please help me?",
+                        body=f"I have a problem related to {topic}. But I don't know how to "
+                             f"explain it properly. I need some guidance in debugging this so "
+                             f"that I can provide more information.",
                         attach_image=False,
                         expected_locator=sumo_pages.question_page.questions_header
                     )
diff --git a/playwright_tests/tests/explore_help_articles_tests/articles/test_kb_article_creation_and_access.py b/playwright_tests/tests/explore_help_articles_tests/articles/test_kb_article_creation_and_access.py
@@ -2130,3 +2130,189 @@ def test_voting_the_same_article_twice_is_not_possible(page: Page, context: Brow
             utilities.user_secrets_accounts["TEST_ACCOUNT_MODERATOR"]
         ))
         sumo_pages.kb_article_deletion_flow.delete_kb_article()
+
+
+# C3065908 C3065909
+@pytest.mark.kbArticleCreationAndAccess
+def test_adding_and_removing_related_documents(page: Page):
+    utilities = Utilities(page)
+    sumo_pages = SumoPages(page)
+    test_articles_url = []
+    test_article_titles = []
+
+    with allure.step("Signing in with an admin account"):
+        utilities.start_existing_session(utilities.username_extraction_from_email(
+            utilities.user_secrets_accounts["TEST_ACCOUNT_MODERATOR"]
+        ))
+
+    with allure.step("Creating 3 test articles"):
+        counter = 1
+        while counter <= 3:
+            article_info = sumo_pages.submit_kb_article_flow.kb_article_creation_via_api(
+                page=page, product="19", topic="507", approve_revision=True)
+            test_article_titles.append(article_info["article_title"])
+            test_articles_url.append(article_info["article_url"])
+            counter += 1
+
+    with allure.step("Wait for ~1 minute until the kb article is available in search"):
+        utilities.wait_for_given_timeout(90000)
+
+    with allure.step(f"Navigating to the f{test_article_titles[0]} and adding the rest as related "
+                     f"documents"):
+        utilities.navigate_to_link(test_articles_url[0])
+        sumo_pages.edit_article_metadata_flow.edit_article_metadata(
+            related_documents=test_article_titles[1:]
+        )
+
+    with check, allure.step("Verifying that the related documents are successfully displayed "
+                            "inside the 'Related Articles' section"):
+        check.equal(
+            set(test_article_titles[1:]),
+            set(sumo_pages.kb_article_page.get_list_of_related_articles())
+        )
+
+    with check, allure.step(f"Clicking on the f{test_article_titles[1]} related document and "
+                            f"verifying that the article is listed inside the 'Related Articles' "
+                            f"section"):
+        sumo_pages.kb_article_page.click_on_related_article_card(test_article_titles[1])
+        check.is_in(
+            test_article_titles[0],
+            sumo_pages.kb_article_page.get_list_of_related_articles()
+        )
+
+    with allure.step(f"Navigating back to the f{test_article_titles[0]}, clicking on the "
+                     f"'Edit Article Metadata' and removing one of the related documents"):
+        sumo_pages.kb_article_page.click_on_related_article_card(test_article_titles[0])
+        sumo_pages.kb_article_page.click_on_edit_article_metadata()
+        sumo_pages.kb_article_edit_article_metadata_page.remove_related_document(
+            test_article_titles[1])
+        sumo_pages.kb_article_edit_article_metadata_page.click_on_save_changes_button()
+
+    with allure.step(f"Verifying that the f{test_article_titles[1]} is no longer listed inside "
+                     "'Related Articles' section"):
+        check.is_not_in(
+            test_article_titles[1],
+            sumo_pages.kb_article_page.get_list_of_related_articles()
+        )
+
+    with check, allure.step(f"Navigating to the f{test_article_titles[1]} page and verifying that "
+                            f"the f{test_article_titles[0]} is not listed inside the "
+                            f"'Related documents' section"):
+        utilities.navigate_to_link(test_articles_url[1])
+        check.is_false(
+            sumo_pages.kb_article_page.is_related_articles_section_displayed()
+        )
+
+    with allure.step("Deleting all test articles"):
+        for article in test_articles_url:
+            utilities.navigate_to_link(article)
+            sumo_pages.kb_article_deletion_flow.delete_kb_article()
+
+
+# C3059081
+@pytest.mark.kbArticleCreationAndAccess
+def test_same_article_cannot_be_added_as_related_article(page: Page):
+    utilities = Utilities(page)
+    sumo_pages = SumoPages(page)
+
+    with allure.step("Signing in with an admin account"):
+        utilities.start_existing_session(utilities.username_extraction_from_email(
+            utilities.user_secrets_accounts["TEST_ACCOUNT_MODERATOR"]
+        ))
+
+    with allure.step("Creating a new KB article"):
+        article_info = sumo_pages.submit_kb_article_flow.kb_article_creation_via_api(
+            page=page, product="19", topic="507", approve_revision=True)
+
+    with allure.step("Wait for ~1 minute until the kb article is available in search"):
+        utilities.wait_for_given_timeout(90000)
+
+    with check, allure.step("Clicking on the 'Edit Article Metadata' option and verifying that "
+                            "the same article cannot be added inside the 'Related documents' "
+                            "field"):
+        sumo_pages.kb_article_page.click_on_edit_article_metadata()
+        sumo_pages.kb_article_edit_article_metadata_page.add_related_documents(
+            article_info["article_title"], submit=False)
+        utilities.wait_for_given_timeout(2000)
+        check.is_true(
+            sumo_pages.kb_article_edit_article_metadata_page.is_no_related_documents_displayed()
+        )
+
+    with allure.step("Deleting the KB article"):
+        utilities.navigate_to_link(article_info["article_url"])
+        sumo_pages.kb_article_deletion_flow.delete_kb_article()
+
+
+#  C3065910
+@pytest.mark.kbArticleCreationAndAccess
+def test_restricted_visibility_related_document_in_article_page(page: Page):
+    utilities = Utilities(page)
+    sumo_pages = SumoPages(page)
+    test_articles_url = []
+    test_article_titles = []
+
+    with allure.step("Signing in with an admin account"):
+        utilities.start_existing_session(utilities.username_extraction_from_email(
+            utilities.user_secrets_accounts["TEST_ACCOUNT_MODERATOR"]
+        ))
+
+    with allure.step("Creating 3 new articles"):
+        counter = 1
+        while counter <= 3:
+            article_info = sumo_pages.submit_kb_article_flow.kb_article_creation_via_api(
+                page=page, product="19", topic="507", approve_revision=True)
+            test_article_titles.append(article_info["article_title"])
+            test_articles_url.append(article_info["article_url"])
+            counter += 1
+
+    with allure.step("Wait for ~1 minute until the kb article is available in search"):
+        utilities.wait_for_given_timeout(90000)
+
+    with allure.step(f"Navigating to the article: f{test_article_titles[1]} and "
+                     f"restricting the visibility of the article to 'Mobile' group"):
+        utilities.navigate_to_link(test_articles_url[1])
+        sumo_pages.edit_article_metadata_flow.edit_article_metadata(single_group="Mobile")
+
+    with allure.step(f"Navigating to the: f{test_article_titles[0]} article and adding the rest "
+                     f"of test articles as related documents"):
+        utilities.navigate_to_link(test_articles_url[0])
+        sumo_pages.kb_article_page.click_on_edit_article_metadata()
+        sumo_pages.edit_article_metadata_flow.edit_article_metadata(
+            related_documents=test_article_titles[1:]
+        )
+
+    with allure.step("Signing in with a users that doesn't belong to the 'Mobile' group"):
+        utilities.start_existing_session(utilities.username_extraction_from_email(
+            utilities.user_secrets_accounts["TEST_ACCOUNT_12"]
+        ))
+
+    with check, allure.step("Verifying that the article is not displayed inside the 'Related "
+                            "Documents' section"):
+        utilities.navigate_to_link(test_articles_url[0])
+        check.is_not_in(
+            test_article_titles[1],
+            sumo_pages.kb_article_page.get_list_of_related_articles()
+        )
+
+    with check, allure.step(f"Signing in with the account that is part of the 'Mobile' group"
+                            f"group, navigating to the f{test_article_titles[0]} article and "
+                            f"verifying that the restricted visibility article is now visible in "
+                            f"the 'Related Documents' section"):
+        utilities.start_existing_session(utilities.username_extraction_from_email(
+            utilities.user_secrets_accounts["TEST_ACCOUNT_13"]
+        ))
+        utilities.navigate_to_link(test_articles_url[0])
+        check.is_in(
+            test_article_titles[1],
+            sumo_pages.kb_article_page.get_list_of_related_articles()
+        )
+
+    with allure.step("Deleting all test articles"):
+        with allure.step("Signing in with an admin account"):
+            utilities.start_existing_session(utilities.username_extraction_from_email(
+                utilities.user_secrets_accounts["TEST_ACCOUNT_MODERATOR"]
+            ))
+
+        for article in test_articles_url:
+            utilities.navigate_to_link(article)
+            sumo_pages.kb_article_deletion_flow.delete_kb_article()
