Avoid duplication

Author: soncuteanca

modules/browser_object_navigation.py

@@ -1,4 +1,5 @@
 import logging
+from typing import Literal
 
 from selenium.common.exceptions import TimeoutException
 from selenium.webdriver import ActionChains, Firefox
@@ -659,10 +660,40 @@ def expect_bookmarks_toolbar_visibility(self, expected: bool) -> None:
             self.bookmarks_toolbar, "collapsed", expected_value
         )
 
-    def open_audio_video_permission(self) -> BasePage:
-        """Open the Site information panel and select "Allow Audio and Video" """
+    #
+    def set_site_autoplay_permission(self, settings: Literal["allow-audio-video", "block-audio-video", "allow-audio-only"]) -> BasePage:
+        """
+        Open the Site audio-video permission panel and set a specific autoplay setting.
+
+        Arguments: 
+            settings: "allow-audio-video" → Allow Audio and Video, "block-audio-video" → Block Audio and Video, 
+            "allow-audio-only" → Allow Audio but block Video
+        """
         self.click_on("autoplay-icon-blocked")
-        self.element_clickable("permission-popup-audio-blocked")
-        self.click_on("permission-popup-audio-blocked")
-        self.click_and_hide_menu("allow-audio-video-menuitem")
+
+        if settings == "allow-audio-video":
+            self.element_clickable("permission-popup-audio-blocked")
+            self.click_on("permission-popup-audio-blocked")
+            self.click_and_hide_menu("allow-audio-video-menuitem")
+
+        elif settings == "block-audio-video":
+            self.element_clickable("permission-popup-audio-video-allowed")
+            self.click_and_hide_menu("block-audio-video-menuitem")
+
+        elif settings == "allow-audio-only":
+            self.element_clickable("permission-popup-audio-video-allowed")
+            self.click_and_hide_menu("allow-audio-only-menuitem")
         return self
+
+    def verify_autoplay_state(self, expected: Literal["allow", "block"]) -> None:
+        """ Verify the current state of the autoplay permission panel and icon.
+            Arguments:
+                expected: "allow" → Allow Audio and Video, "block" → Block Audio and Video
+        """
+        if expected == "allow":
+            self.element_visible("permission-popup-audio-video-allowed")
+            self.element_not_visible("autoplay-icon-blocked")
+        else:
+            self.element_visible("permission-popup-audio-video-blocked")
+            self.element_visible("autoplay-icon-blocked")
+

modules/page_object_prefs.py

@@ -561,7 +561,7 @@ def get_manage_data_site_element(self, site: str) -> WebElement:
         element = self.get_element("manage-cookies-site", labels=[site])
         return element
 
-    def open_autopaly_modal(self) -> BasePage:
+    def open_autoplay_modal(self) -> BasePage:
         """
         Opens the Autoplay settings modal dialog from the about:preferences#privacy page.
         """
@@ -571,23 +571,15 @@ def open_autopaly_modal(self) -> BasePage:
         self.click_on("autoplay-settings")
         return self
 
-    def set_autoplay_setting(
-        self,
-        settings: Literal[
-            "allow-audio-video",
-            "block-audio-video",
-            "allow-audio-only",
-        ],
-    ) -> "AboutPrefs":
+    def set_autoplay_setting_in_preferences(
+            self, settings: Literal["allow-audio-video", "block-audio-video", "allow-audio-only"]) -> BasePage:
         """
-        Open the Autoplay settings panel and choose a policy for all sites.
+        Open the Autoplay settings panel and choose a setting for all sites.
         Arguments:
-        policy : Literal["allow-audio-video", "block-audio-video", "allow-audio-only"]
-            - "allow-audio-video": Allow both audio and video autoplay
-            - "block-audio-video": Block both audio and video autoplay
-            - "allow-audio-only": Allow audio but block video autoplay
+            settings: "allow-audio-video" → Allow Audio and Video, "block-audio-video" → Block Audio and Video,
+            "allow-audio-only" → Allow Audio but block Video
         """
-        self.open_autopaly_modal()
+        self.open_autoplay_modal()
         self.click_on(settings)
         self.click_on("spacer")
         self.click_on("autoplay-save-changes")

tests/audio_video/test_allow_audio_video_functionality.py

@@ -33,7 +33,7 @@ def test_allow_audio_video_functionality(driver: Firefox):
     page = GenericPage(driver, url=TEST_URL)
 
     # Open privacy and click on the "Settings" button from Autoplay
-    about_prefs.set_autoplay_setting("allow-audio-video")
+    about_prefs.set_autoplay_setting_in_preferences("allow-audio-video")
 
     # Open the website and check if the video starts playing with sound
     page.open()

tests/audio_video/test_block_audio_video_functionality.py

@@ -24,9 +24,9 @@ def test_block_audio_video_functionality(driver: Firefox):
     page = GenericPage(driver, url=TEST_URL)
 
     # Open privacy and click on the "Settings" button from Autoplay
-    about_prefs.set_autoplay_setting("block-audio-video")
+    about_prefs.set_autoplay_setting_in_preferences("block-audio-video")
 
     # Open test website and check the site is loaded and the featured video is not playing
     page.open()
     nav.click_on("autoplay-icon-blocked")
-    nav.element_visible("permission-popup-audio-video-blocked")
+    nav.verify_autoplay_state("block")

tests/audio_video/test_users_actions_saved_on_reload.py

@@ -31,39 +31,31 @@ def test_users_actions_saved_on_reload(driver: Firefox):
     about_prefs = AboutPrefs(driver, category="privacy")
     page = GenericPage(driver, url=TEST_URL)
 
-    # Open Test page
+    # Open the test page
     page.open()
 
     # Open the Audio-Video Permission panel and check "Allow Audio and Video"
-    nav.open_audio_video_permission()
+    nav.set_site_autoplay_permission("allow-audio-video")
 
-    # Refresh test page and check the site information panel shows "Allow Audio and Video"
+    # Refresh test page and check the Audio-Video Permission panel shows "Allow Audio and Video" and the crossed off
+    # Play icon is no longer displayed
     driver.get(driver.current_url)
-    nav.element_visible("permission-popup-audio-video-allowed")
-
-    # Check the Crossed off Play icon is no longer displayed
-    nav.element_not_visible("autoplay-icon-blocked")
+    nav.verify_autoplay_state("allow")
 
     # Check the website is added to the exceptions list in about:preferences#privacy
-    about_prefs.open_autopaly_modal()
+    about_prefs.open_autoplay_modal()
     about_prefs.element_visible("mlb-allow-audio-video-settings")
 
-    # # Open Test page
+    # # Open the test page
     page.open()
 
-    # Open the Site information panel and check "Block Audio and Video"
-    nav.click_on("autoplay-icon-blocked")
-    nav.click_on("permission-popup-audio-video-allowed")
-    nav.click_and_hide_menu("block-audio-video-menuitem")
+    # Open the Audio-Video Permission panel and check "Block Audio and Video"
+    nav.set_site_autoplay_permission("block-audio-video")
 
-    # Refresh test page and check the site information panel shows "Block Audio and Video"
+    # Refresh test page and check the Audio-Video Permission panel shows "Block Audio and Video"
     driver.get(driver.current_url)
-    nav.element_visible("permission-popup-audio-video-blocked")
-    nav.element_visible("autoplay-icon-blocked")
+    nav.verify_autoplay_state("block")
 
     # Revisit test page and check Site information panel shows "Block Audio and Video"
     page.open()
-    nav.element_visible("permission-popup-audio-video-blocked")
-
-    # Check the Crossed off Play icon is displayed
-    nav.element_visible("autoplay-icon-blocked")
+    nav.verify_autoplay_state("block")