[tests] Updated tests and CI

Author: pandafy

.github/workflows/ci.yml

@@ -46,6 +46,19 @@ jobs:
       with:
         ref: ${{ github.event.pull_request.head.sha }}
 
+    - name: Cache APT packages
+      uses: actions/cache@v4
+      with:
+        path: /var/cache/apt/archives
+        key: apt-${{ runner.os }}-${{ hashFiles('.github/workflows/ci.yml') }}
+        restore-keys: |
+          apt-${{ runner.os }}-
+
+    - name: Disable man page auto-update
+      run: |
+        echo 'set man-db/auto-update false' | sudo debconf-communicate >/dev/null
+        sudo dpkg-reconfigure man-db
+
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v5
       with:
@@ -68,6 +81,10 @@ jobs:
         pip install -UI --no-deps https://github.com/openwisp/openwisp-utils/tarball/browser-logs
         pip install ${{ matrix.django-version }}
 
+    - name: Start postgres and redis
+      if: ${{ !cancelled() && steps.deps.conclusion == 'success' }}
+      run: docker compose up -d postgres redis
+
     - name: QA checks
       run: ./run-qa-checks
 
@@ -84,6 +101,11 @@ jobs:
         coverage xml
       env:
         SELENIUM_HEADLESS: 1
+        GECKO_LOG: 1
+
+    - name: Show gecko web driver log on failures
+      if: ${{ failure() }}
+      run: cat geckodriver.log
 
     - name: Upload Coverage
       if: ${{ success() }}

openwisp_controller/config/tests/test_selenium.py

@@ -10,17 +10,16 @@
 from selenium.webdriver.support.ui import Select, WebDriverWait
 from swapper import load_model
 
-from openwisp_utils.test_selenium_mixins import SeleniumTestMixin
+from openwisp_utils.tests import SeleniumTestMixin
 
-from ...tests.utils import DeviceAdminSeleniumTextMixin
 from .utils import CreateConfigTemplateMixin, TestWireguardVpnMixin
 
 Device = load_model('config', 'Device')
 
 
 @tag('selenium_tests')
 class TestDeviceAdmin(
-    DeviceAdminSeleniumTextMixin,
+    SeleniumTestMixin,
     CreateConfigTemplateMixin,
     StaticLiveServerTestCase,
 ):
@@ -97,6 +96,7 @@ def test_device_preview_keyboard_shortcuts(self):
         self.open(reverse('admin:config_device_changelist'))
         try:
             self.open(reverse('admin:config_device_change', args=[device.id]))
+            self.hide_loading_overlay()
         except TimeoutException:
             self.fail('Device detail page did not load in time')
 
@@ -140,6 +140,7 @@ def test_multiple_organization_templates(self):
             reverse('admin:config_device_change', args=[org1_device.id])
             + '#config-group'
         )
+        self.hide_loading_overlay()
         # org2 templates should not be visible
         self.wait_for_invisibility(
             By.XPATH, f'//*[@value="{org2_required_template.id}"]'
@@ -163,6 +164,7 @@ def test_change_config_backend(self):
         self.open(
             reverse('admin:config_device_change', args=[device.id]) + '#config-group'
         )
+        self.hide_loading_overlay()
         self.find_element(by=By.XPATH, value=f'//*[@value="{template.id}"]')
         # Change config backed to
         config_backend_select = Select(
@@ -183,6 +185,7 @@ def test_template_context_variables(self):
         self.open(
             reverse('admin:config_device_change', args=[device.id]) + '#config-group'
         )
+        self.hide_loading_overlay()
         try:
             WebDriverWait(self.web_driver, 2).until(
                 EC.text_to_be_present_in_element_value(
@@ -216,6 +219,7 @@ def test_force_delete_device_with_deactivating_config(self):
 
         self.login()
         self.open(reverse('admin:config_device_change', args=[device.id]))
+        self.hide_loading_overlay()
         # The webpage has two "submit-row" sections, each containing a "Deactivate"
         # button. The first (top) "Deactivate" button is hidden, causing
         # `wait_for_visibility` to fail. To avoid this issue, we use
@@ -232,6 +236,7 @@ def test_force_delete_device_with_deactivating_config(self):
         self.assertEqual(config.is_deactivating(), True)
 
         self.open(reverse('admin:config_device_change', args=[device.id]))
+        self.hide_loading_overlay()
         # Use `presence` instead of `visibility` for `wait_for`,
         # as the same issue described above applies here.
         self.find_elements(
@@ -282,7 +287,7 @@ def test_force_delete_multiple_devices_with_deactivating_config(self):
 
 @tag('selenium_tests')
 class TestDeviceAdminUnsavedChanges(
-    DeviceAdminSeleniumTextMixin,
+    SeleniumTestMixin,
     CreateConfigTemplateMixin,
     StaticLiveServerTestCase,
 ):
@@ -297,9 +302,10 @@ def test_unsaved_changes(self):
         self.login()
         device = self._create_config(organization=self._get_org()).device
         path = reverse('admin:config_device_change', args=[device.id])
-        self.open(path)
+
         with self.subTest('Alert should not be displayed without any change'):
             self.open(path)
+            self.hide_loading_overlay()
             try:
                 WebDriverWait(self.web_driver, 1).until(EC.alert_is_present())
             except TimeoutException:

openwisp_controller/connection/tests/test_selenium.py

@@ -4,7 +4,8 @@
 from selenium.webdriver.common.by import By
 from swapper import load_model
 
-from ...tests.utils import DeviceAdminSeleniumTextMixin
+from openwisp_utils.tests import SeleniumTestMixin
+
 from .utils import CreateConnectionsMixin
 
 Command = load_model('connection', 'Command')
@@ -13,7 +14,7 @@
 @tag('selenium_tests')
 class TestDeviceAdmin(
     CreateConnectionsMixin,
-    DeviceAdminSeleniumTextMixin,
+    SeleniumTestMixin,
     StaticLiveServerTestCase,
 ):
     config_app_label = 'config'
@@ -36,12 +37,14 @@ def test_command_widget_on_device(self):
         self.login()
         path = reverse(f'admin:{self.config_app_label}_device_change', args=[device.id])
         self.open(path)
+        self.hide_loading_overlay()
         # The "Send Command" widget is not visible on devices which do
         # not have a DeviceConnection object
         self.wait_for_invisibility(By.CSS_SELECTOR, 'ul.object-tools a#send-command')
         self._create_device_connection(device=device, credentials=creds)
         self.assertEqual(device.deviceconnection_set.count(), 1)
         self.open(path)
+        self.hide_loading_overlay()
         # Send reboot command to the device
         self.find_element(
             by=By.CSS_SELECTOR, value='ul.object-tools a#send-command', timeout=5

openwisp_controller/tests/test_selenium.py

@@ -13,7 +13,7 @@
 
 from openwisp_controller.connection.tests.utils import CreateConnectionsMixin
 from openwisp_controller.geo.tests.utils import TestGeoMixin
-from openwisp_utils.test_selenium_mixins import SeleniumTestMixin
+from openwisp_utils.tests import SeleniumTestMixin
 
 Device = load_model('config', 'Device')
 DeviceConnection = load_model('connection', 'DeviceConnection')

openwisp_controller/tests/utils.py

@@ -4,13 +4,8 @@
 from django.db.utils import DEFAULT_DB_ALIAS
 from django.test.testcases import _AssertNumQueriesContext
 from django.urls import reverse
-from selenium.common.exceptions import TimeoutException, UnexpectedAlertPresentException
-from selenium.webdriver.common.by import By
-from selenium.webdriver.support import expected_conditions as EC
-from selenium.webdriver.support.ui import WebDriverWait
 
 from openwisp_users.tests.utils import TestMultitenantAdminMixin
-from openwisp_utils.test_selenium_mixins import SeleniumTestMixin
 
 user_model = get_user_model()
 
@@ -54,34 +49,3 @@ def assertNumQueries(self, num, func=None, *args, using=DEFAULT_DB_ALIAS, **kwar
 
         with context:
             func(*args, **kwargs)
-
-
-class DeviceAdminSeleniumTextMixin(SeleniumTestMixin):
-    def tearDown(self):
-        super().tearDown()
-        # Dismiss any unsaved changes alert to prevent it from blocking
-        # navigation in subsequent tests. If left unresolved, this could
-        # cause test failures by preventing the browser from loading new pages.
-        # Ensuring a clean browser state before the next test runs.
-        try:
-            self.web_driver.refresh()
-        except UnexpectedAlertPresentException:
-            self.web_driver.switch_to_alert().accept()
-            self.web_driver.switch_to_alert.accept()
-        else:
-            try:
-                WebDriverWait(self.web_driver, 1).until(EC.alert_is_present())
-            except TimeoutException:
-                pass
-            else:
-                self.web_driver.switch_to_alert().accept()
-        self.web_driver.refresh()
-        self.wait_for_visibility(By.XPATH, '//*[@id="site-name"]')
-
-    def open(self, url, driver=None):
-        super().open(url, driver)
-        driver = driver or self.web_driver
-        self._assert_loading_overlay_hidden()
-
-    def _assert_loading_overlay_hidden(self):
-        self.wait_for_invisibility(By.CSS_SELECTOR, '#loading-overlay')