80 lines
2.3 KiB
Python
80 lines
2.3 KiB
Python
"""Helpers for tests related to emitting events to the tracking logs."""
|
|
|
|
|
|
from datetime import datetime
|
|
|
|
from django.test import TestCase
|
|
from django.test.utils import override_settings
|
|
from eventtracking import tracker
|
|
from eventtracking.django import DjangoTracker
|
|
from freezegun import freeze_time
|
|
from pytz import UTC
|
|
|
|
FROZEN_TIME = datetime(2013, 10, 3, 8, 24, 55, tzinfo=UTC)
|
|
IN_MEMORY_BACKEND_CONFIG = {
|
|
'mem': {
|
|
'ENGINE': 'common.djangoapps.track.tests.InMemoryBackend'
|
|
}
|
|
}
|
|
|
|
|
|
class InMemoryBackend:
|
|
"""A backend that simply stores all events in memory"""
|
|
|
|
def __init__(self):
|
|
super().__init__() # lint-amnesty, pylint: disable=super-with-arguments
|
|
self.events = []
|
|
|
|
def send(self, event):
|
|
"""Store the event in a list"""
|
|
self.events.append(event)
|
|
|
|
|
|
@override_settings(
|
|
EVENT_TRACKING_BACKENDS=IN_MEMORY_BACKEND_CONFIG
|
|
)
|
|
class EventTrackingTestCase(TestCase):
|
|
"""
|
|
Supports capturing of emitted events in memory and inspecting them.
|
|
|
|
Each test gets a "clean slate" and can retrieve any events emitted during their execution.
|
|
|
|
"""
|
|
|
|
# Make this more robust to the addition of new events that the test doesn't care about.
|
|
|
|
def setUp(self):
|
|
freezer = freeze_time(FROZEN_TIME)
|
|
freezer.start()
|
|
self.addCleanup(freezer.stop)
|
|
|
|
super().setUp() # lint-amnesty, pylint: disable=super-with-arguments
|
|
|
|
self.recreate_tracker()
|
|
|
|
def recreate_tracker(self):
|
|
"""
|
|
Re-initialize the tracking system using updated django settings.
|
|
|
|
Use this if you make use of the @override_settings decorator to customize the tracker configuration.
|
|
"""
|
|
self.tracker = DjangoTracker()
|
|
tracker.register_tracker(self.tracker)
|
|
|
|
@property
|
|
def backend(self):
|
|
"""A reference to the in-memory backend that stores the events."""
|
|
return self.tracker.backends['mem']
|
|
|
|
def get_event(self, idx=0):
|
|
"""Retrieve an event emitted up to this point in the test."""
|
|
return self.backend.events[idx]
|
|
|
|
def assert_no_events_emitted(self):
|
|
"""Ensure no events were emitted at this point in the test."""
|
|
assert len(self.backend.events) == 0
|
|
|
|
def assert_events_emitted(self):
|
|
"""Ensure at least one event has been emitted at this point in the test."""
|
|
assert len(self.backend.events) >= 1
|