[tests] Capture browser console logs in Firefox

Firefox does not support the WebDriver.get_log API. To work around this,
we inject JavaScript into the page to override window.console within the
browser's JS runtime. This allows us to capture and retrieve console errors
directly from the page.

Author: pandafy

openwisp_utils/firefox-extensions/console_capture_extension/content.js

@@ -0,0 +1,42 @@
+(function () {
+  const script = document.createElement("script");
+  script.textContent = `
+        (function() {
+            if (window._console_logs) return;  // Prevent multiple injections
+
+            window._console_logs = [];
+
+            function mapLogLevel(method) {
+                const levelMapping = {
+                    log: "INFO",
+                    info: "INFO",
+                    debug: "DEBUG",
+                    warn: "WARNING",
+                    error: "SEVERE",
+                    trace: "DEBUG",
+                    assert: "SEVERE"
+                };
+                return levelMapping[method] || "INFO"; // Default to INFO
+            }
+
+            function captureConsole(method) {
+                const original = console[method];
+                console[method] = function(...args) {
+                    const logLevel = mapLogLevel(method);
+                    window._console_logs.push({
+                        level: logLevel,
+                        message: args.map(arg => (typeof arg === "object" ? JSON.stringify(arg) : String(arg))).join(" ")
+                    });
+                    original.apply(console, args);
+                };
+            }
+
+            const methods = ["log", "info", "debug", "warn", "error", "trace", "assert"];
+            methods.forEach(captureConsole);
+        })();
+    `;
+
+  // Ensure script runs in page context
+  const head = document.head || document.documentElement;
+  head.appendChild(script);
+})();

openwisp_utils/firefox-extensions/console_capture_extension/manifest.json

@@ -0,0 +1,13 @@
+{
+    "manifest_version": 2,
+    "name": "Console Capture Extension",
+    "version": "1.0",
+    "description": "Captures console logs before any script runs.",
+    "content_scripts": [
+      {
+        "matches": ["<all_urls>"],
+        "js": ["content.js"],
+        "run_at": "document_start"
+      }
+    ]
+  }

openwisp_utils/test_selenium_mixins.py

@@ -44,12 +44,29 @@ def setUpClass(cls):
         if GECKO_LOG:
             kwargs['service'] = webdriver.FirefoxService(log_output='geckodriver.log')
         cls.web_driver = webdriver.Firefox(**kwargs)
+        # Firefox does not support the WebDriver.get_log API. To work around this,
+        # we inject JavaScript into the page to override window.console within the
+        # browser's JS runtime. This allows us to capture and retrieve console errors
+        # directly from the page.
+        extension_path = os.path.abspath(
+            os.path.join(
+                os.path.dirname(__file__),
+                "firefox-extensions",
+                "console_capture_extension",
+            )
+        )
+        cls.web_driver.install_addon(extension_path, temporary=True)
 
     @classmethod
     def tearDownClass(cls):
         cls.web_driver.quit()
         super().tearDownClass()
 
+    def setUp(self):
+        self.admin = self._create_admin(
+            username=self.admin_username, password=self.admin_password
+        )
+
     def open(self, url, driver=None, timeout=5):
         """Opens a URL.
 
@@ -68,6 +85,9 @@ def open(self, url, driver=None, timeout=5):
             EC.presence_of_element_located((By.CSS_SELECTOR, '#main-content'))
         )
 
+    def get_browser_logs(self):
+        return self.web_driver.execute_script('return window._console_logs')
+
     def login(self, username=None, password=None, driver=None):
         """Log in to the admin dashboard.
 
@@ -96,6 +116,11 @@ def find_element(self, by, value, timeout=2, wait_for='visibility'):
         getattr(self, method)(by, value, timeout)
         return self.web_driver.find_element(by=by, value=value)
 
+    def find_elements(self, by, value, timeout=2, wait_for='visibility'):
+        method = f'wait_for_{wait_for}'
+        getattr(self, method)(by, value, timeout)
+        return self.web_driver.find_elements(by=by, value=value)
+
     def wait_for_visibility(self, by, value, timeout=2):
         return self.wait_for('visibility_of_element_located', by, value)
 
@@ -111,4 +136,5 @@ def wait_for(self, method, by, value, timeout=2):
                 getattr(EC, method)(((by, value)))
             )
         except TimeoutException as e:
+            print(self.get_browser_logs())
             self.fail(f'{method} of "{value}" failed: {e}')

tests/test_project/tests/test_selenium.py

@@ -10,9 +10,6 @@
 
 
 class TestMenu(SeleniumTestMixin, StaticLiveServerTestCase):
-    def setUp(self):
-        self.admin = self._create_admin()
-
     def tearDown(self):
         # Clear local storage
         self.web_driver.execute_script('window.localStorage.clear()')
@@ -369,7 +366,7 @@ def setUpClass(cls):
         super().setUpClass()
 
     def setUp(self):
-        self.admin = self._create_admin()
+        super().setUp()
         self.web_driver.set_window_size(1600, 768)
         self._create_test_data()
 
@@ -516,10 +513,6 @@ class TestInputFilters(SeleniumTestMixin, CreateMixin, StaticLiveServerTestCase)
     def setUpClass(cls):
         super().setUpClass()
 
-    def setUp(self):
-        super().setUp()
-        self.admin = self._create_admin()
-
     def test_input_filters(self):
         url = reverse('admin:test_project_shelf_changelist')
         user = self._create_user()
@@ -613,7 +606,7 @@ def setUpClass(cls):
         super().setUpClass()
 
     def setUp(self):
-        self.admin = self._create_admin()
+        super().setUp()
         self.web_driver.set_window_size(1600, 768)
 
     def test_pie_chart_zero_annotation(self):
@@ -639,7 +632,6 @@ def setUpClass(cls):
 
     def setUp(self):
         super().setUp()
-        self.admin = self._create_admin()
         self.login()
 
     def test_autocomplete_shelf_filter(self):