|
| 1 | +""" |
| 2 | +Tests for openedx_events/testing.py. |
| 3 | +""" |
| 4 | +from django.test import TestCase |
| 5 | + |
| 6 | +from openedx_events.testing import FreezeSignalCacheMixin, OpenEdxEventsTestMixin |
| 7 | +from openedx_events.tooling import OpenEdxPublicSignal, load_all_signals |
| 8 | + |
| 9 | + |
| 10 | +class OpenEdxEventsTestMixinIsolationTest(FreezeSignalCacheMixin, TestCase): |
| 11 | + """ |
| 12 | + Tests that OpenEdxEventsTestMixin does not leak disabled event state. |
| 13 | +
|
| 14 | + The key regression: setUpClass disables all events, but before the fix |
| 15 | + there was no tearDownClass to re-enable them. Any test class that ran |
| 16 | + *after* a mixin class with ENABLED_OPENEDX_EVENTS=[] would find every |
| 17 | + event still disabled. |
| 18 | + """ |
| 19 | + |
| 20 | + def setUp(self): |
| 21 | + super().setUp() |
| 22 | + load_all_signals() |
| 23 | + |
| 24 | + def _all_events_enabled(self): |
| 25 | + return all(e._allow_events for e in OpenEdxPublicSignal.all_events()) # pylint: disable=protected-access |
| 26 | + |
| 27 | + def _all_events_disabled(self): |
| 28 | + return all(not e._allow_events for e in OpenEdxPublicSignal.all_events()) # pylint: disable=protected-access |
| 29 | + |
| 30 | + def test_teardown_re_enables_all_events(self): |
| 31 | + """ |
| 32 | + After tearDownClass runs, every event should be enabled. |
| 33 | +
|
| 34 | + Simulate the lifecycle of a mixin class with no enabled events: |
| 35 | + setUpClass disables everything, tearDownClass must restore it. |
| 36 | + """ |
| 37 | + class EmptyEnabledEvents(OpenEdxEventsTestMixin, TestCase): |
| 38 | + ENABLED_OPENEDX_EVENTS = [] |
| 39 | + |
| 40 | + # Before the class runs all events should be enabled. |
| 41 | + self.assertTrue(self._all_events_enabled()) |
| 42 | + |
| 43 | + EmptyEnabledEvents.setUpClass() |
| 44 | + # After setUpClass, all events are disabled. |
| 45 | + self.assertTrue(self._all_events_disabled()) |
| 46 | + |
| 47 | + EmptyEnabledEvents.tearDownClass() |
| 48 | + # After tearDownClass, all events must be re-enabled. |
| 49 | + self.assertTrue( |
| 50 | + self._all_events_enabled(), |
| 51 | + "tearDownClass should re-enable all events so subsequent test " |
| 52 | + "classes are not affected by this class's event isolation.", |
| 53 | + ) |
| 54 | + |
| 55 | + def test_teardown_re_enables_events_after_subset_enabled(self): |
| 56 | + """ |
| 57 | + The tearDownClass re-enables all events even when only a subset was enabled. |
| 58 | + """ |
| 59 | + all_event_types = [e.event_type for e in OpenEdxPublicSignal.all_events()] |
| 60 | + one_event_type = all_event_types[0] |
| 61 | + |
| 62 | + class OneEnabledEvent(OpenEdxEventsTestMixin, TestCase): |
| 63 | + ENABLED_OPENEDX_EVENTS = [one_event_type] |
| 64 | + |
| 65 | + OneEnabledEvent.setUpClass() |
| 66 | + # Only one event should be enabled at this point. |
| 67 | + enabled = [e for e in OpenEdxPublicSignal.all_events() if e._allow_events] # pylint: disable=protected-access |
| 68 | + self.assertEqual(len(enabled), 1) |
| 69 | + self.assertEqual(enabled[0].event_type, one_event_type) |
| 70 | + |
| 71 | + OneEnabledEvent.tearDownClass() |
| 72 | + self.assertTrue( |
| 73 | + self._all_events_enabled(), |
| 74 | + "tearDownClass should re-enable all events regardless of how many were enabled.", |
| 75 | + ) |
0 commit comments