FE Selenium test: Updates to smoke tests (#2237)

* update search results

* discard modal updates

* correct typos

pytest-selenium/pages/content.py

@@ -28,6 +28,7 @@
 BOUNDING_RECTANGLE = "return arguments[0].getBoundingClientRect();"
 COMPUTED_STYLES = "return window.getComputedStyle(arguments[0]){field};"
 ELEMENT_SELECT = "return document.querySelector('{selector}');"
+FOCUSED_HIGHLIGHT_LOCATOR = "[data-highlight-id='{n}'][aria-current=true]"
 
 
 class ContentError(Exception):
@@ -746,6 +747,18 @@ def highlight_ids(self) -> List[str]:
                 set([highlight.get_attribute("data-highlight-id") for highlight in self.highlights])
             )
 
+        def highlight_focused(self, highlight_id) -> bool:
+            """Return True if the highlight is focused.
+
+            :return: ``True`` if the highlight is focused
+            :rtype: bool
+
+            """
+            focused_highlight_locator = self.find_elements(
+                By.CSS_SELECTOR, FOCUSED_HIGHLIGHT_LOCATOR.format(n=highlight_id)
+            )
+            return bool(focused_highlight_locator)
+
         @property
         def images(self) -> List[WebElement]:
             """Return the content images.

pytest-selenium/tests/test_highlighting_56.py

@@ -66,8 +66,7 @@ def test_modal_for_unsaved_notes_appears_on_clicking_another_highlight(
 
     assert book.content.highlight_box.is_open, "Highlight box not open"
     assert book.content.highlight_box.is_edit_box
-    highlight = book.content.get_highlight(by_id=id_2)[0]
-    assert "focus" in highlight.get_attribute("class"), "highlight is not in focus"
+    assert book.content.highlight_focused(id_2), "highlight is not in focus"
     assert book.content.highlight_box.note == note
 
     # WHEN: click the 1st highlight again
@@ -79,8 +78,7 @@ def test_modal_for_unsaved_notes_appears_on_clicking_another_highlight(
 
     # THEN: Unsaved note is abandoned and the highlight box is opened for the 1st highlight
     assert book.content.highlight_box.is_open, "Highlight box not open"
-    highlight = book.content.get_highlight(by_id=id_1)[0]
-    assert "focus" in highlight.get_attribute("class"), "highlight is not in focus"
+    assert book.content.highlight_focused(id_1), "highlight is not in focus"
     assert book.content.highlight_box.note == ""
 
 
@@ -127,8 +125,7 @@ def test_modal_for_unsaved_notes_appears_on_page_navigation_using_toc(
     # THEN: The modal is closed and the unsaved note is retained on the page
     assert book.content.highlight_box.is_open, "Highlight box not open"
     assert book.content.highlight_box.is_edit_box
-    highlight = book.content.get_highlight(by_id=highlight_id)[0]
-    assert "focus" in highlight.get_attribute("class"), "highlight is not in focus"
+    assert book.content.highlight_focused(highlight_id), "highlight is not in focus"
     assert book.content.highlight_box.note == note
 
     # WHEN: Click the TOC link again
@@ -202,8 +199,7 @@ def test_modal_for_unsaved_notes_appears_on_page_navigation_using_prev_link(
     # THEN: The modal is closed and the unsaved note is retained on the page
     assert book.content.highlight_box.is_open, "Highlight box not open"
     assert book.content.highlight_box.is_edit_box
-    highlight = book.content.get_highlight(by_id=highlight_id)[0]
-    assert "focus" in highlight.get_attribute("class"), "highlight is not in focus"
+    assert book.content.highlight_focused(highlight_id), "highlight is not in focus"
     assert book.content.highlight_box.note == note
 
     # WHEN: Click previous link again
@@ -277,8 +273,7 @@ def test_modal_for_unsaved_notes_appears_on_page_navigation_using_next_link(
     # THEN: The modal is closed and the unsaved note is retained on the page
     assert book.content.highlight_box.is_open, "Highlight box not open"
     assert book.content.highlight_box.is_edit_box
-    highlight = book.content.get_highlight(by_id=highlight_id)[0]
-    assert "focus" in highlight.get_attribute("class"), "highlight is not in focus"
+    assert book.content.highlight_focused(highlight_id), "highlight is not in focus"
     assert book.content.highlight_box.note == note
 
     # WHEN: Click next link again
@@ -351,8 +346,7 @@ def test_modal_for_unsaved_notes_appears_on_clicking_book_title(
     # THEN: The modal is closed and the unsaved note is retained on the page
     assert book.content.highlight_box.is_open, "Highlight box not open"
     assert book.content.highlight_box.is_edit_box
-    highlight = book.content.get_highlight(by_id=highlight_id)[0]
-    assert "focus" in highlight.get_attribute("class"), "highlight is not in focus"
+    assert book.content.highlight_focused(highlight_id), "highlight is not in focus"
     assert book.content.highlight_box.note == note
 
     # WHEN: Click on book title again
@@ -424,8 +418,7 @@ def test_modal_for_unsaved_notes_appears_on_selecting_new_text(
     # THEN: The modal is closed and the unsaved note is retained in the page
     assert book.content.highlight_box.is_open, "Highlight box not open"
     assert book.content.highlight_box.is_edit_box
-    highlight = book.content.get_highlight(by_id=id_1)[0]
-    assert "focus" in highlight.get_attribute("class"), "highlight is not in focus"
+    assert book.content.highlight_focused(id_1), "highlight is not in focus"
     assert book.content.highlight_box.note == note
 
     # WHEN: Select some text in the page again
@@ -500,8 +493,7 @@ def test_modal_for_unsaved_notes_appears_on_clicking_search_result_same_page(
     # THEN: The modal is closed and the unsaved note is retained in the page
     assert book.content.highlight_box.is_open, "Highlight box not open"
     assert book.content.highlight_box.is_edit_box
-    highlight = book.content.get_highlight(by_id=id_1)[0]
-    assert "focus" in highlight.get_attribute("class"), "highlight is not in focus"
+    assert book.content.highlight_focused(id_1), "highlight is not in focus"
     assert book.content.highlight_box.note == note
 
     # WHEN: Click the same search result again
@@ -512,6 +504,7 @@ def test_modal_for_unsaved_notes_appears_on_clicking_search_result_same_page(
     book.wait_for_page_to_load()
 
     # THEN: Unsaved note of the user highlight is abandoned
+    highlight = book.content.get_highlight(by_id=id_1)[0]
     assert not selenium.execute_script(HAS_INDICATOR, highlight), "note is saved for the highlight"
 
     # AND: The selected search result is highlighted
@@ -573,8 +566,7 @@ def test_modal_for_unsaved_notes_appears_on_clicking_search_result_different_pag
     # THEN: The modal is closed and the unsaved note is retained in the page
     assert book.content.highlight_box.is_open, "Highlight box not open"
     assert book.content.highlight_box.is_edit_box
-    highlight = book.content.get_highlight(by_id=id_1)[0]
-    assert "focus" in highlight.get_attribute("class"), "highlight is not in focus"
+    assert book.content.highlight_focused(id_1), "highlight is not in focus"
     assert book.content.highlight_box.note == note
 
     # WHEN: Click the same search result again
@@ -654,7 +646,7 @@ def test_modal_for_unsaved_notes_appears_on_clicking_content_links(
     assert book.content.highlight_box.is_open, "Highlight box not open"
     assert book.content.highlight_box.is_edit_box
     highlight = book.content.get_highlight(by_id=id_1)[0]
-    assert "focus" in highlight.get_attribute("class"), "highlight is not in focus"
+    assert book.content.highlight_focused(id_1), "highlight is not in focus"
     assert book.content.highlight_box.note == note
 
     # WHEN: Click the same link again