Merge pull request #98 from mozilla/tw/persist-search-term

Create test for persistence of search terms

Author: Tracy-Walker

modules/browser_object_navigation.py

@@ -37,6 +37,15 @@ def get_awesome_bar(self) -> WebElement:
         self.set_awesome_bar()
         return self.awesome_bar
 
+    def get_awesome_bar_text(self):
+        """
+        Get the text directly from the awesome bar.
+        This is different from 'driver.current_url' which pulls from href
+        """
+        self.set_chrome_context()
+        awesome_bar = self.get_element("awesome-bar").get_attribute("value")
+        return awesome_bar
+
     def clear_awesome_bar(self) -> BasePage:
         """Clear the Awesome Bar. Prefer this over get_element("awesome-bar").clear()"""
         self.set_awesome_bar()

modules/browser_object_tabbar.py

@@ -106,6 +106,13 @@ def expect_tab_sound_status(
             )
         return self
 
+    def expect_title_contains(self, text: str) -> BasePage:
+        """
+        Check if the page title contains given text
+        """
+        self.expect(EC.title_contains(text))
+        return self
+
     def open_all_tabs_list(self) -> BasePage:
         """Click the Tab Visibility / List All Tabs button"""
         with self.driver.context(self.driver.CONTEXT_CHROME):

tests/address_bar_and_search/test_search_bar_result.py

@@ -1,9 +1,8 @@
 import pytest
 from selenium.webdriver import Firefox
 from selenium.webdriver.common.by import By
-from selenium.webdriver.support import expected_conditions as EC
 
-from modules.browser_object import Navigation
+from modules.browser_object import Navigation, TabBar
 from modules.page_object import AboutConfig
 
 
@@ -14,6 +13,11 @@ def add_prefs():
     ]
 
 
+# Set constants
+SEARCH_BAR_PREF = "browser.search.widget.inNavBar"
+SEARCH_TERM = "saxophone"
+
+
 def test_search_bar_results(driver: Firefox):
     """
     C1365213 - The Search Bar provides valid results for specific search terms
@@ -22,21 +26,19 @@ def test_search_bar_results(driver: Firefox):
     # Create objects
     nav = Navigation(driver).open()
     ac = AboutConfig(driver)
-
-    search_term = "saxophone"
+    tab = TabBar(driver)
 
     # Check Google results from a Search bar search
     # First enable search bar via about:config
-    pref = "browser.search.widget.inNavBar"
-    ac.toggle_true_false_config(pref)
+    ac.toggle_true_false_config(SEARCH_BAR_PREF)
     nav.clear_awesome_bar()
 
     # Then run search and check the results
-    nav.search_bar_search(search_term)
+    nav.search_bar_search(SEARCH_TERM)
     nav.set_content_context()
-    nav.expect_in_content(EC.title_contains("Google Search"))
+    tab.expect_title_contains("Google Search")
     search_url = driver.current_url
-    assert search_term in search_url
+    assert SEARCH_TERM in search_url
     content_searchbar = nav.find_element(By.NAME, "q")
     content_searchbar_text = content_searchbar.get_attribute("value")
-    assert content_searchbar_text == search_term
+    assert content_searchbar_text == SEARCH_TERM

tests/address_bar_and_search/test_search_code_google_non_us.py

@@ -1,9 +1,8 @@
 import pytest
 from selenium.webdriver import Firefox
 from selenium.webdriver.common.by import By
-from selenium.webdriver.support import expected_conditions as ec
 
-from modules.browser_object import ContextMenu, Navigation
+from modules.browser_object import ContextMenu, Navigation, TabBar
 from modules.page_object import AboutConfig
 
 
@@ -15,6 +14,11 @@ def add_prefs():
     ]
 
 
+# Set constants
+FX_SEARCH_CODE = "client=firefox-b-d"
+SEARCH_BAR_PREF = "browser.search.widget.inNavBar"
+
+
 def test_search_code_google_us(driver: Firefox):
     """
     C1365269 - Default Search Code: Google - non-US
@@ -26,29 +30,28 @@ def test_search_code_google_us(driver: Firefox):
     nav = Navigation(driver).open()
     ac = AboutConfig(driver)
     context_menu = ContextMenu(driver)
+    tab = TabBar(driver)
 
     def search_code_assert():
         # Function to check the search code of a Google search in US region
-        fx_code = "client=firefox-b-d"
         nav.set_content_context()
         search_url = driver.current_url
-        assert fx_code in search_url
+        assert FX_SEARCH_CODE in search_url
         nav.clear_awesome_bar()
 
     # Check code generated from the Awesome bar search
     nav.search("soccer")
-    nav.expect(ec.title_contains("Google Search"))
+    tab.expect_title_contains("Google Search")
     search_code_assert()
 
     # Check code generated from the Search bar search
     # First enable search bar via about:config
-    pref = "browser.search.widget.inNavBar"
-    ac.toggle_true_false_config(pref)
+    ac.toggle_true_false_config(SEARCH_BAR_PREF)
     nav.clear_awesome_bar()
 
     # Then run the code check
     nav.search_bar_search("soccer")
-    nav.expect(ec.title_contains("Google Search"))
+    tab.expect_title_contains("Google Search")
     search_code_assert()
 
     # Check code generated from the context click of selected text
@@ -64,5 +67,5 @@ def search_code_assert():
     # Switch to the newly opened tab and run the code check
     window_handles = driver.window_handles
     driver.switch_to.window(window_handles[-1])
-    nav.expect(ec.title_contains("Google Search"))
+    tab.expect_title_contains("Google Search")
     search_code_assert()

tests/address_bar_and_search/test_search_code_google_us.py

@@ -3,7 +3,7 @@
 from selenium.webdriver.common.by import By
 from selenium.webdriver.support import expected_conditions as EC
 
-from modules.browser_object import ContextMenu, Navigation
+from modules.browser_object import ContextMenu, Navigation, TabBar
 from modules.page_object import AboutConfig
 
 
@@ -15,6 +15,11 @@ def add_prefs():
     ]
 
 
+# Set constant
+FX_SEARCH_CODE = "client=firefox-b-1-d"
+SEARCH_BAR_PREF = "browser.search.widget.inNavBar"
+
+
 def test_search_code_google_us(driver: Firefox):
     """
     C1365268 - Default Search Code: Google - US
@@ -26,13 +31,13 @@ def test_search_code_google_us(driver: Firefox):
     nav = Navigation(driver).open()
     ac = AboutConfig(driver)
     context_menu = ContextMenu(driver)
+    tab = TabBar(driver)
 
     def search_code_assert():
         # Function to check the search code of a Google search in US region
-        fx_code = "client=firefox-b-1-d"
         nav.set_content_context()
         search_url = driver.current_url
-        assert fx_code in search_url
+        assert FX_SEARCH_CODE in search_url
         nav.clear_awesome_bar()
 
     # Check code generated from the Awesome bar search
@@ -42,13 +47,12 @@ def search_code_assert():
 
     # Check code generated from the Search bar search
     # First enable search bar via about:config
-    pref = "browser.search.widget.inNavBar"
-    ac.toggle_true_false_config(pref)
+    ac.toggle_true_false_config(SEARCH_BAR_PREF)
     nav.clear_awesome_bar()
 
     # Then run the code check
     nav.search_bar_search("soccer")
-    nav.expect(EC.title_contains("Google Search"))
+    tab.expect_title_contains("Google Search")
     search_code_assert()
 
     # Check code generated from the context click of selected text
@@ -64,5 +68,5 @@ def search_code_assert():
     # Switch to the newly opened tab and run the code check
     window_handles = driver.window_handles
     driver.switch_to.window(window_handles[-1])
-    nav.expect(EC.title_contains("Google Search"))
+    tab.expect_title_contains("Google Search")
     search_code_assert()

tests/address_bar_and_search/test_search_term_persists.py

@@ -0,0 +1,81 @@
+import pytest
+from selenium.webdriver import Firefox
+
+from modules.browser_object import Navigation, TabBar
+from modules.page_object import AboutConfig
+
+
+# Set search region
+@pytest.fixture()
+def add_prefs():
+    return [
+        ("browser.search.region", "US"),
+        ("browser.urlbar.showSearchTerms.enabled", True),
+        ("browser.urlbar.showSearchTerms.featureGate", True),
+    ]
+
+
+# Set constants
+FIRST_SEARCH = "cheetah"
+FIRST_RESULT = "https://www.google.com/search?client=firefox-b-1-d&q=cheetah"
+SECOND_SEARCH = "lion"
+SECOND_RESULT = "https://www.google.com/search?client=firefox-b-1-d&q=lion"
+SEARCH_BAR_PREF = "browser.search.widget.inNavBar"
+
+
+def test_search_term_persists(driver: Firefox):
+    """
+    C2153943 - Persist search term basic functionality
+    """
+
+    # Create objects
+    nav = Navigation(driver).open()
+    tab = TabBar(driver)
+
+    def toggle_legacy_search_bar():
+        # This test requires that the old search bar is added while retaining search results.
+        # First, open a new tab and switch to it
+        tab.new_tab_by_button()
+        window_handles = driver.window_handles
+        driver.switch_to.window(window_handles[-1])
+        # Then, toggle the old search bar via about:config
+        ac = AboutConfig(driver)
+        ac.toggle_true_false_config(SEARCH_BAR_PREF)
+        # Finally, close the about:config tab and switch context back to the original tab
+        nav.set_chrome_context()
+        x_icon = tab.get_element("tab-x-icon", multiple=True)
+        x_icon[1].click()
+        driver.switch_to.window(window_handles[0])
+
+    # Perform a search using the URL bar.
+    nav.search(FIRST_SEARCH)
+    tab.expect_title_contains("Google Search")
+    address_bar_text = nav.get_awesome_bar_text()
+    assert FIRST_SEARCH == address_bar_text
+
+    # Add the search bar to toolbar
+    toggle_legacy_search_bar()
+
+    # Search term should be replaced with full url
+    address_bar_text = nav.get_awesome_bar_text()
+    assert FIRST_RESULT == address_bar_text
+    nav.clear_awesome_bar()
+
+    # Perform a new awesome bar search, full url should be present
+    # First, navigate away from Google
+    nav.set_content_context()
+    driver.get("about:robots")
+    # Then perform another search
+    nav.search(SECOND_SEARCH)
+    tab.expect_title_contains("Google Search")
+    address_bar_text = nav.get_awesome_bar_text()
+    assert SECOND_RESULT == address_bar_text
+
+    # Disable the old search bar
+    toggle_legacy_search_bar()
+
+    # Again, perform a search using the URL bar.
+    nav.search(FIRST_SEARCH)
+    tab.expect_title_contains("Google Search")
+    address_bar_text = nav.get_awesome_bar_text()
+    assert FIRST_SEARCH == address_bar_text