def test_modal_for_unsaved_notes_appears_on_clicking_search_result_different_page(
selenium, base_url, book_slug, page_slug
):
"""Discard modal appears when unsaved notes are present & selecting search result in different page."""
# GIVEN: Login book page
book = Content(selenium, base_url, book_slug=book_slug, page_slug=page_slug).open()
toolbar = book.toolbar
search_sidebar = book.search_sidebar
while book.notification_present:
book.notification.got_it()
book.navbar.click_login()
name, email = Signup(selenium).register()
book.wait_for_page_to_load()
while book.notification_present:
book.notification.got_it()
# AND: Search results are displayed in sidebar
search_term = get_search_term(book_slug)
toolbar.search_for(search_term)
book.wait_for_page_to_load()
search_results = search_sidebar.search_results(search_term)
# AND: Highlight a paragraph, add a note & do not save
paragraph = random.sample(book.content.paragraphs, 1)
book.content.highlight(target=paragraph[0], offset=Highlight.ENTIRE, close_box=False)
note = Utilities.random_string()
book.content.highlight_box.note = note
id_1 = book.content.highlight_ids[0]
# WHEN: Click on a search result in different page
Utilities.click_option(selenium, element=search_results[2])
# THEN: Discard modal is displayed
assert book.discard_changes_modal_displayed
assert book.discard_modal.content == "You have an unsaved note on this page."
assert book.discard_modal.title == "Discard unsaved changes?"
# WHEN: Click Cancel
book.discard_modal.click_cancel_changes()
# 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_box.note == note
# WHEN: Click the same search result again
Utilities.click_option(selenium, element=search_results[2])
# AND: Click Discard changes in the modal
book.click_and_wait_for_load(book.discard_modal.discard_button)
# THEN: The selected search result is highlighted in the new page
phrase_searched = book.content.find_elements(By.XPATH, XPATH_SEARCH.format(term=search_term))
assert phrase_searched, f"the highlight phrase ('{search_term}') was not found on the page"
assert "focus" in phrase_searched[0].get_attribute(
"class"
), "search phrase does not have the search focus highlight"
# AND: No highlight box is open in the new page
with pytest.raises(NoSuchElementException) as e:
book.content.highlight_box
assert "No open highlight boxes found" in str(e.value), "highlight box is open in the new page"
# AND: No existing highlights present in the new page
try:
assert not book.content.highlights
except NoSuchElementException:
pytest.fail("existing highlight present in the page")
# WHEN: Navigate back to the initial page
book.click_and_wait_for_load(search_results[0])
# THEN: The unsaved note in the initial page is not saved
id_1 = book.content.highlight_ids[0]
highlight = book.content.get_highlight(by_id=id_1)[0]
assert not selenium.execute_script(HAS_INDICATOR, highlight), "note is saved for the highlight"
def test_modal_for_unsaved_notes_appears_on_page_navigation_using_toc(
selenium, base_url, book_slug, page_slug
):
"""Discard modal appears when unsaved notes are present & clicking TOC link."""
# GIVEN: Login book page
book = Content(selenium, base_url, book_slug=book_slug, page_slug=page_slug).open()
toc = book.sidebar.toc
while book.notification_present:
book.notification.got_it()
book.navbar.click_login()
name, email = Signup(selenium).register()
book.wait_for_page_to_load()
while book.notification_present:
book.notification.got_it()
# AND: Highlight a paragraph, add a note & do not save
paragraphs = random.sample(book.content.paragraphs, 1)
book.content.highlight(target=paragraphs[0], offset=Highlight.ENTIRE, close_box=False)
note = Utilities.random_string()
book.content.highlight_box.note = note
highlight_id = book.content.highlight_ids[0]
# WHEN: Click on a TOC link
book.offscreen_click(toc.sections[3].root)
# THEN: Discard modal is displayed
assert book.discard_changes_modal_displayed
assert book.discard_modal.content == "You have an unsaved note on this page."
assert book.discard_modal.title == "Discard unsaved changes?"
# WHEN: Click Cancel on the modal
book.discard_modal.click_cancel_changes()
# 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_box.note == note
# WHEN: Click the TOC link again
book.offscreen_click(toc.sections[3].root)
# AND: click Discard changes in the modal
book.click_and_wait_for_load(book.discard_modal.discard_button)
# THEN: New page is loaded
assert toc.sections[3].is_active
# AND: No highlight box is open in the new page
with pytest.raises(NoSuchElementException) as e:
book.content.highlight_box
assert "No open highlight boxes found" in str(e.value), "highlight box is open in the new page"
# AND: No existing highlights present in the new page
try:
assert not book.content.highlights
except NoSuchElementException:
pytest.fail("existing highlight present in the page")
# WHEN: Navigate back to the initial page
book.click_and_wait_for_load(toc.sections[1].root)
# THEN: The unsaved note in the initial page is not saved
highlight = book.content.get_highlight(by_id=highlight_id)[0]
assert not selenium.execute_script(HAS_INDICATOR, highlight), "note is saved for the highlight"
def test_modal_for_unsaved_notes_appears_on_clicking_book_title(
selenium, base_url, book_slug, page_slug
):
"""Discard modal appears when unsaved notes are present & book title is clicked."""
# GIVEN: Login book page
book = Content(selenium, base_url, book_slug=book_slug, page_slug=page_slug).open()
book_banner = book.bookbanner
while book.notification_present:
book.notification.got_it()
book.navbar.click_login()
name, email = Signup(selenium).register()
book.wait_for_page_to_load()
while book.notification_present:
book.notification.got_it()
# AND: Highlight a paragraph, add a note & do not save
paragraphs = random.sample(book.content.paragraphs, 1)
book.content.highlight(target=paragraphs[0], offset=Highlight.ENTIRE, close_box=False)
note = Utilities.random_string()
book.content.highlight_box.note = note
highlight_id = book.content.highlight_ids[0]
# WHEN: Click on book title
book_banner.book_title.click()
# THEN: Discard modal is displayed
assert book.discard_changes_modal_displayed
assert book.discard_modal.content == "You have an unsaved note on this page."
assert book.discard_modal.title == "Discard unsaved changes?"
# WHEN: Click Cancel on the modal
book.discard_modal.click_cancel_changes()
# 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_box.note == note
# WHEN: Click on book title again
book_banner.book_title.click()
# AND: click Discard changes in the modal
book.discard_modal.click_discard_changes()
# THEN: The page navigates to osweb book details page
osweb = WebBase(selenium)
osweb.wait_for_page_to_load()
expected_page_url = base_url + "/details/books/" + book_slug
assert expected_page_url == osweb.current_url
# WHEN: Click the view online link in osweb book detail page
osweb.fix_view_online_url(base_url)
book.click_and_wait_for_load(osweb.view_online)
# THEN: The unsaved note in the initial page is not saved
highlight = book.content.get_highlight(by_id=highlight_id)[0]
assert not selenium.execute_script(HAS_INDICATOR, highlight), "note is saved for the highlight"
# AND: No highlight box is open in the page
with pytest.raises(NoSuchElementException) as e:
book.content.highlight_box
assert "No open highlight boxes found" in str(e.value), "highlight box is open in the page"