Merge branch 'master' into dependabot/pip/selenium-gte-4.10-and-lt-4.30

Author: nemesifier

openwisp_utils/admin_theme/static/admin/js/menu.js

@@ -13,6 +13,11 @@ const MenuTransitionTime = "0.1s";
 var wasActiveGroupOpen = false;
 
 (function () {
+  // popup page or other pages
+  // where menu is not displayed
+  if (!owMenu) {
+    return;
+  }
   setMenu();
   initGroupViewHandlers();
   initToggleMenuHandlers();

openwisp_utils/test_selenium_mixins.py

@@ -3,7 +3,7 @@
 from django.conf import settings
 from selenium import webdriver
 from selenium.webdriver.common.by import By
-from selenium.webdriver.common.desired_capabilities import DesiredCapabilities
+from selenium.webdriver.firefox.options import Options
 from selenium.webdriver.support import expected_conditions as EC
 from selenium.webdriver.support.ui import WebDriverWait
 
@@ -21,33 +21,27 @@ class SeleniumTestMixin:
     @classmethod
     def setUpClass(cls):
         super().setUpClass()
-
-        chrome_options = webdriver.ChromeOptions()
-        chrome_options.page_load_strategy = 'eager'
+        firefox_options = Options()
+        firefox_options.page_load_strategy = 'eager'
         if getattr(settings, 'SELENIUM_HEADLESS', True):
-            chrome_options.add_argument('--headless')
-        CHROME_BIN = os.environ.get('CHROME_BIN', None)
-        if CHROME_BIN:
-            chrome_options.binary_location = CHROME_BIN
-        chrome_options.add_argument('--window-size=1366,768')
-        chrome_options.add_argument('--ignore-certificate-errors')
-        # When running Selenium tests with the "--parallel" flag,
-        # each TestCase class requires its own browser instance.
-        # If the same "remote-debugging-port" is used for all
-        # TestCase classes, it leads to failed test cases.
-        # Therefore, it is necessary to utilize different remote
-        # debugging ports for each TestCase. To accomplish this,
-        # we can leverage the randomized live test server port to
-        # generate a unique port for each browser instance.
-        chrome_options.add_argument(
-            f'--remote-debugging-port={cls.server_thread.port + 100}'
+            firefox_options.add_argument('--headless')
+        GECKO_BIN = os.environ.get('GECKO_BIN', None)
+        if GECKO_BIN:
+            firefox_options.binary_location = GECKO_BIN
+        firefox_options.set_preference(
+            'network.stricttransportsecurity.preloadlist', False
         )
-        capabilities = DesiredCapabilities.CHROME
-        capabilities['goog:loggingPrefs'] = {'browser': 'ALL'}
-        chrome_options.set_capability('cloud:options', capabilities)
-        cls.web_driver = webdriver.Chrome(
-            options=chrome_options,
+        # Enable detailed GeckoDriver logging
+        firefox_options.set_capability(
+            'moz:firefoxOptions', {'log': {'level': 'trace'}}
         )
+        kwargs = dict(options=firefox_options)
+        # Optional: Store logs in a file
+        # Pass GECKO_LOG=1 when running tests
+        GECKO_LOG = os.environ.get('GECKO_LOG', None)
+        if GECKO_LOG:
+            kwargs['service'] = webdriver.FirefoxService(log_output='geckodriver.log')
+        cls.web_driver = webdriver.Firefox(**kwargs)
 
     @classmethod
     def tearDownClass(cls):

tests/test_project/tests/test_selenium.py

@@ -158,27 +158,22 @@ def _test_menu_dropdown(self, is_narrow=False, is_medium=False):
         if is_narrow:
             # Do not test when menu is not visible
             return
-        with self.subTest('Test menu dropdown when menu is close'):
+        with self.subTest('Test menu dropdown when menu is closed'):
             self._close_menu()
             # Test mg_dropdown is not visible
             self.assertEqual(mg_dropdown.is_displayed(), False)
             self.assertEqual(mg_label.is_displayed(), False)
             self.assertEqual(mg_icon.is_displayed(), True)
             # Test mg dropdown gets visible on clicking mg head
             mg_head.click()
-            is_visible = True
             try:
                 WebDriverWait(self.web_driver, 2).until(
                     EC.visibility_of_element_located(
                         (By.CSS_SELECTOR, '#mg-dropdown-32')
                     )
                 )
             except TimeoutException:
-                is_visible = False
-            self.assertEqual(
-                is_visible,
-                True,
-            )
+                self.fail('drop down not visible')
             self.assertEqual(mg_dropdown_label.is_displayed(), True)
             # Test mg dropdown gets invisible on clicking mg head
             mg_head.click()
@@ -188,12 +183,16 @@ def _test_menu_dropdown(self, is_narrow=False, is_medium=False):
             main_content.click()
             self.assertEqual(mg_dropdown.is_displayed(), False)
 
-        with self.subTest('Test visibilty of menu label when menu close'):
+        with self.subTest('Test visibilty of menu label when menu is closed'):
             self._close_menu()
             actions = ActionChains(self.web_driver)
             actions.move_to_element(mg_head)
+            # clicking twice forces the hover action
+            # to work consistently, without this it may
+            # yield inconsistent results in automated tests
+            actions.click(mg_head)
+            actions.click(mg_head)
             actions.perform()
-            is_visible = True
             try:
                 WebDriverWait(self.web_driver, 2).until(
                     EC.visibility_of_element_located(
@@ -204,8 +203,7 @@ def _test_menu_dropdown(self, is_narrow=False, is_medium=False):
                     )
                 )
             except TimeoutException:
-                is_visible = False
-            self.assertEqual(is_visible, True)
+                self.fail('label not visible')
             mg_head.click()
             actions.move_to_element(mg_head)
             actions.perform()
@@ -731,18 +729,47 @@ def test_autocomplete_shelf_filter(self):
             ),
             self.web_driver.page_source,
         )
-        self.web_driver.find_element(By.CSS_SELECTOR, filter_css_selector).click()
-        self.web_driver.find_element(By.CSS_SELECTOR, '.select2-container--open')
-        WebDriverWait(self.web_driver, 10).until(
-            EC.presence_of_element_located(
-                (By.XPATH, f'//*[contains(text(), "{horror_shelf.name}")]')
+        try:
+            WebDriverWait(self.web_driver, 2).until(
+                EC.presence_of_element_located((By.CSS_SELECTOR, filter_css_selector))
             )
-        )
+        except TimeoutException:
+            self.fail(f'{filter_css_selector} not available as expected')
+        else:
+            self.web_driver.find_element(By.CSS_SELECTOR, filter_css_selector).click()
+        try:
+            WebDriverWait(self.web_driver, 2).until(
+                EC.presence_of_element_located(
+                    (By.CSS_SELECTOR, '.select2-container--open')
+                )
+            )
+        except TimeoutException:
+            self.fail('select2 widget did not open as expected')
+        try:
+            WebDriverWait(self.web_driver, 2).until(
+                EC.presence_of_element_located(
+                    (By.XPATH, f'//*[contains(text(), "{horror_shelf.name}")]')
+                )
+            )
+        except TimeoutException:
+            self.fail(f'"{horror_shelf.name}" not found')
         self.assertIn(horror_shelf.name, self.web_driver.page_source)
         self.assertIn(factual_shelf.name, self.web_driver.page_source)
-        self.web_driver.find_element(By.XPATH, filter_option_xpath).click()
+        try:
+            WebDriverWait(self.web_driver, 2).until(
+                EC.presence_of_element_located((By.XPATH, filter_option_xpath))
+            )
+        except TimeoutException:
+            self.fail(f'"{filter_option_xpath}" not found')
+        else:
+            self.web_driver.find_element(By.XPATH, filter_option_xpath).click()
         self.assertIn(str(factual_shelf.id), self.web_driver.current_url)
-        self.web_driver.find_element(By.CSS_SELECTOR, filter_css_selector)
+        try:
+            WebDriverWait(self.web_driver, 2).until(
+                EC.presence_of_element_located((By.CSS_SELECTOR, filter_css_selector))
+            )
+        except TimeoutException:
+            self.fail(f'"{filter_css_selector}" not found')
         self.assertNotIn(horror_shelf.name, self.web_driver.page_source)
         self.assertIn(factual_shelf.name, self.web_driver.page_source)
         with self.assertRaises(NoSuchElementException):
@@ -778,11 +805,32 @@ def test_autocomplete_owner_filter(self):
             ),
             self.web_driver.page_source,
         )
-        self.web_driver.find_element(By.CSS_SELECTOR, filter_css_selector).click()
-        self.web_driver.find_element(By.CSS_SELECTOR, '.select2-container--open')
+        try:
+            WebDriverWait(self.web_driver, 2).until(
+                EC.presence_of_element_located((By.CSS_SELECTOR, filter_css_selector))
+            )
+        except TimeoutException:
+            self.fail(f'{filter_css_selector} not available as expected')
+        else:
+            self.web_driver.find_element(By.CSS_SELECTOR, filter_css_selector).click()
+        try:
+            WebDriverWait(self.web_driver, 2).until(
+                EC.presence_of_element_located(
+                    (By.CSS_SELECTOR, '.select2-container--open')
+                )
+            )
+        except TimeoutException:
+            self.fail('select2 widget did not open as expected')
         self.assertIn(self.admin.username, self.web_driver.page_source)
         self.assertIn(user.username, self.web_driver.page_source)
-        self.web_driver.find_element(By.XPATH, filter_null_option_xpath).click()
+        try:
+            WebDriverWait(self.web_driver, 2).until(
+                EC.presence_of_element_located((By.XPATH, filter_null_option_xpath))
+            )
+        except TimeoutException:
+            self.fail(f'{filter_null_option_xpath} not available as expected')
+        else:
+            self.web_driver.find_element(By.XPATH, filter_null_option_xpath).click()
         self._get_filter_button().click()
         self.assertIn('owner_id__isnull=true', self.web_driver.current_url)
         with self.assertRaises(NoSuchElementException):