[fix] Fixed broken skipped Selenium tests in Django parallel runner #619

Fixes #619

Co-authored-by: Federico Capoano <f.capoano@openwisp.io>

Author: czarflix

openwisp_utils/tests/selenium.py

@@ -54,11 +54,16 @@ def _setup_and_call(self, result, debug=False):
             )
             super()._setup_and_call(result, debug)
             # IMPORTANT: a skip is not a success; propagate it as a skip and stop.
-            if getattr(result, "skipped", None):
-                for _, reason in result.skipped:
+            if hasattr(result, "events"):
+                skip_reasons = [
+                    event[2] for event in result.events if event[0] == "addSkip"
+                ]
+            else:
+                skip_reasons = [reason for _, reason in getattr(result, "skipped", [])]
+            if skip_reasons:
+                for reason in skip_reasons:
                     original_result.addSkip(self, reason)
-                if hasattr(original_result, "events") and hasattr(result, "events"):
-                    original_result.events = result.events
+                original_result.stopTest(self)
                 return
             if result.wasSuccessful():
                 if attempt == 0:

tests/test_project/tests/test_selenium_skip.py

@@ -0,0 +1,69 @@
+from unittest import TestResult, TestSuite, skip
+
+from django.test import SimpleTestCase
+from django.test.runner import RemoteTestRunner
+from openwisp_utils.tests.selenium import SeleniumTestMixin
+
+
+class TestSeleniumMixinSkipHandling(SimpleTestCase):
+    def _run_skipped_standard_test(self):
+        class SkippedSeleniumTest(SeleniumTestMixin, SimpleTestCase):
+            retry_max = 0
+            retry_delay = 0
+
+            @skip("skip propagation regression test")
+            def test_skip(self):
+                pass
+
+        test = SkippedSeleniumTest("test_skip")
+        result = TestResult()
+        test._setup_and_call(result)
+        return result
+
+    def _run_skipped_remote_suite(self):
+        class DummyWebDriver:
+            def quit(self):
+                pass
+
+        class SkippedSeleniumTest(SeleniumTestMixin, SimpleTestCase):
+            retry_max = 0
+            retry_delay = 0
+
+            @classmethod
+            def get_webdriver(cls):
+                return DummyWebDriver()
+
+            @skip("first skip propagation regression test")
+            def test_first_skip(self):
+                pass
+
+            @skip("second skip propagation regression test")
+            def test_second_skip(self):
+                pass
+
+        suite = TestSuite(
+            [
+                SkippedSeleniumTest("test_first_skip"),
+                SkippedSeleniumTest("test_second_skip"),
+            ]
+        )
+        return RemoteTestRunner().run(suite)
+
+    def test_setup_and_call_propagates_skip_to_standard_result(self):
+        result = self._run_skipped_standard_test()
+        self.assertEqual(len(result.skipped), 1)
+        self.assertEqual(result.skipped[0][1], "skip propagation regression test")
+
+    def test_setup_and_call_preserves_remote_skip_events_for_multiple_tests(self):
+        result = self._run_skipped_remote_suite()
+        self.assertEqual(
+            result.events,
+            [
+                ("startTest", 0),
+                ("addSkip", 0, "first skip propagation regression test"),
+                ("stopTest", 0),
+                ("startTest", 1),
+                ("addSkip", 1, "second skip propagation regression test"),
+                ("stopTest", 1),
+            ],
+        )