Merge pull request #149 from mozilla/sl/reader-view-close-sidebar

Reader View Close From Sidebar

Author: sarinali

modules/browser_object.py

@@ -8,6 +8,7 @@
 from modules.browser_object_image_context_menu import *
 from modules.browser_object_navigation import *
 from modules.browser_object_panel_ui import *
+from modules.browser_object_reader_view import *
 from modules.browser_object_search_bar_context_menu import *
 from modules.browser_object_tab_context_menu import *
 from modules.browser_object_tabbar import *

modules/browser_object_reader_view.py

@@ -1,3 +1,5 @@
+from selenium.webdriver import Keys
+
 from modules.page_base import BasePage
 
 
@@ -7,3 +9,71 @@ class ReaderView(BasePage):
     """
 
     URL_TEMPLATE = ""
+
+    def open_reader_view_searchbar(self) -> BasePage:
+        """
+        Opens the reader view using the search bar
+        """
+        before_page_source = self.driver.page_source
+        with self.driver.context(self.driver.CONTEXT_CHROME):
+            self.get_element("reader-view-button").click()
+        self.wait.until(lambda _: self.driver.page_source != before_page_source)
+        self.wait_for_reader_view_open()
+        return self
+
+    def open_reader_view_keys(self) -> BasePage:
+        """
+        Opens the reader view using keys
+        """
+        before_page_source = self.driver.page_source
+        with self.driver.context(self.driver.CONTEXT_CHROME):
+            if self.sys_platform() == "Darwin":
+                self.perform_key_combo(Keys.COMMAND, Keys.ALT, "r")
+            elif self.sys_platform() == "Linux":
+                self.perform_key_combo(Keys.CONTROL, Keys.ALT, "r")
+            else:
+                self.perform_key_combo(Keys.F9)
+        self.wait.until(lambda _: self.driver.page_source != before_page_source)
+        self.wait_for_reader_view_open()
+        return self
+
+    def close_reader_view_searchbar(self) -> BasePage:
+        """
+        Closes the reader view using the search bar
+        """
+        before_page_source = self.driver.page_source
+        with self.driver.context(self.driver.CONTEXT_CHROME):
+            self.get_element("reader-view-button").click()
+        self.wait.until(lambda _: self.driver.page_source != before_page_source)
+        self.wait_for_reader_view_closed()
+        return self
+
+    def close_reader_view_keys(self) -> BasePage:
+        """
+        Closes the reader view using keys
+        """
+        before_page_source = self.driver.page_source
+        with self.driver.context(self.driver.CONTEXT_CHROME):
+            if self.sys_platform() == "Darwin":
+                self.perform_key_combo(Keys.COMMAND, Keys.ALT, "r")
+            elif self.sys_platform() == "Linux":
+                self.perform_key_combo(Keys.CONTROL, Keys.ALT, "r")
+            else:
+                self.perform_key_combo(Keys.F9)
+        self.wait.until(lambda _: self.driver.page_source != before_page_source)
+        self.wait_for_reader_view_closed()
+        return self
+
+    def wait_for_reader_view_open(self) -> BasePage:
+        """
+        Checks to see if the reader view toolbar is present demonstrating that the reader view is open.
+        """
+        self.element_exists("reader-toolbar")
+        return self
+
+    def wait_for_reader_view_closed(self) -> BasePage:
+        """
+        Checks to see if the reader view toolbar is not present, demonstrating that reader view is not open.
+        """
+        self.element_does_not_exist("reader-toolbar")
+        return self

modules/data/reader_view.components.json

@@ -1 +1,19 @@
-{}
+{
+    "reader-view-button": {
+        "selectorData": "reader-mode-button",
+        "strategy": "id",
+        "groups": []
+    },
+
+    "reader-toolbar": {
+        "selectorData": "div[class='toolbar reader-toolbar']",
+        "strategy": "css",
+        "groups": []
+    },
+
+    "reader-toolbar-close": {
+        "selectorData": "button[class='close-button toolbar-button']",
+        "strategy": "css",
+        "groups": []
+    }
+}

tests/reader_view/test_reader_view_close_sidebar.py

@@ -0,0 +1,20 @@
+from selenium.webdriver import Firefox
+
+from modules.browser_object import ReaderView
+from modules.page_object import GenericPage
+
+READER_VIEW_URL = (
+    "https://support.mozilla.org/en-US/kb/firefox-reader-view-clutter-free-web-pages"
+)
+
+
+def test_reader_view_close_from_sidebar(driver: Firefox):
+    """
+    C130912: Ensures that the reader view can be closed from the sidebar toolbar.
+    """
+    wiki_page = GenericPage(driver, url=READER_VIEW_URL)
+    reader_view = ReaderView(driver)
+
+    wiki_page.open()
+    reader_view.open_reader_view_searchbar()
+    reader_view.close_reader_view_searchbar()