Added BOM for getting awesome bar text. Also addressed additional review comments

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()

tests/address_bar_and_search/test_search_code_google_non_us.py

@@ -1,7 +1,6 @@
 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, TabBar
 from modules.page_object import AboutConfig
@@ -15,8 +14,9 @@ def add_prefs():
     ]
 
 
-# Set constant
+# Set constants
 FX_SEARCH_CODE = "client=firefox-b-d"
+SEARCH_BAR_PREF = "browser.search.widget.inNavBar"
 
 
 def test_search_code_google_us(driver: Firefox):
@@ -46,8 +46,7 @@ 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

tests/address_bar_and_search/test_search_code_google_us.py

@@ -17,6 +17,7 @@ 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):
@@ -46,8 +47,7 @@ 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

tests/address_bar_and_search/test_search_term_persists.py

@@ -20,6 +20,7 @@ def add_prefs():
 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):
@@ -31,13 +32,16 @@ def test_search_term_persists(driver: Firefox):
     nav = Navigation(driver).open()
     tab = TabBar(driver)
 
-    def toggle_old_search_bar():
+    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)
-        pref = "browser.search.widget.inNavBar"
-        ac.toggle_true_false_config(pref)
+        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()
@@ -47,14 +51,14 @@ def toggle_old_search_bar():
     nav.search(FIRST_SEARCH)
     tab.expect_title_contains("Google Search")
     nav.set_chrome_context()
-    address_bar_text = nav.get_element("awesome-bar").get_attribute("value")
+    address_bar_text = nav.get_awesome_bar_text()
     assert FIRST_SEARCH == address_bar_text
 
     # Add the search bar to toolbar
-    toggle_old_search_bar()
+    toggle_legacy_search_bar()
 
     # Search term should be replaced with full url
-    address_bar_text = nav.get_element("awesome-bar").get_attribute("value")
+    address_bar_text = nav.get_awesome_bar_text()
     assert FIRST_RESULT == address_bar_text
     nav.clear_awesome_bar()
 
@@ -65,16 +69,15 @@ def toggle_old_search_bar():
     # Then perform another search
     nav.search(SECOND_SEARCH)
     tab.expect_title_contains("Google Search")
-    nav.set_chrome_context()
-    address_bar_text = nav.get_element("awesome-bar").get_attribute("value")
+    address_bar_text = nav.get_awesome_bar_text()
     assert SECOND_RESULT == address_bar_text
 
     # Disable the old search bar
-    toggle_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")
     nav.set_chrome_context()
-    address_bar_text = nav.get_element("awesome-bar").get_attribute("value")
+    address_bar_text = nav.get_awesome_bar_text()
     assert FIRST_SEARCH == address_bar_text