151bd13666
* Generate common/djangoapps import shims for LMS * Generate common/djangoapps import shims for Studio * Stop appending project root to sys.path * Stop appending common/djangoapps to sys.path * Import from common.djangoapps.course_action_state instead of course_action_state * Import from common.djangoapps.course_modes instead of course_modes * Import from common.djangoapps.database_fixups instead of database_fixups * Import from common.djangoapps.edxmako instead of edxmako * Import from common.djangoapps.entitlements instead of entitlements * Import from common.djangoapps.pipline_mako instead of pipeline_mako * Import from common.djangoapps.static_replace instead of static_replace * Import from common.djangoapps.student instead of student * Import from common.djangoapps.terrain instead of terrain * Import from common.djangoapps.third_party_auth instead of third_party_auth * Import from common.djangoapps.track instead of track * Import from common.djangoapps.util instead of util * Import from common.djangoapps.xblock_django instead of xblock_django * Add empty common/djangoapps/__init__.py to fix pytest collection * Fix pylint formatting violations * Exclude import_shims/ directory tree from linting
120 lines
3.6 KiB
Python
120 lines
3.6 KiB
Python
|
|
|
|
from django.conf import settings
|
|
from django.test import TestCase
|
|
from django.test.utils import override_settings
|
|
from six.moves import range
|
|
|
|
from common.djangoapps.track import tracker
|
|
from common.djangoapps.track.backends import BaseBackend
|
|
|
|
SIMPLE_SETTINGS = {
|
|
'default': {
|
|
'ENGINE': 'common.djangoapps.track.tests.test_tracker.DummyBackend',
|
|
'OPTIONS': {
|
|
'flag': True
|
|
}
|
|
}
|
|
}
|
|
|
|
MULTI_SETTINGS = {
|
|
'first': {
|
|
'ENGINE': 'common.djangoapps.track.tests.test_tracker.DummyBackend',
|
|
},
|
|
'second': {
|
|
'ENGINE': 'common.djangoapps.track.tests.test_tracker.DummyBackend',
|
|
}
|
|
}
|
|
|
|
|
|
class TestTrackerInstantiation(TestCase):
|
|
"""Test that a helper function can instantiate backends from their name."""
|
|
def setUp(self):
|
|
# pylint: disable=protected-access
|
|
super(TestTrackerInstantiation, self).setUp()
|
|
self.get_backend = tracker._instantiate_backend_from_name
|
|
|
|
def test_instatiate_backend(self):
|
|
name = 'common.djangoapps.track.tests.test_tracker.DummyBackend'
|
|
options = {'flag': True}
|
|
backend = self.get_backend(name, options)
|
|
|
|
self.assertIsInstance(backend, DummyBackend)
|
|
self.assertTrue(backend.flag)
|
|
|
|
def test_instatiate_backends_with_invalid_values(self):
|
|
def get_invalid_backend(name, parameters):
|
|
return self.get_backend(name, parameters)
|
|
|
|
options = {}
|
|
name = 'common.djangoapps.track.backends.logger'
|
|
self.assertRaises(ValueError, get_invalid_backend, name, options)
|
|
|
|
name = 'common.djangoapps.track.backends.logger.Foo'
|
|
self.assertRaises(ValueError, get_invalid_backend, name, options)
|
|
|
|
name = 'this.package.does.not.exists'
|
|
self.assertRaises(ValueError, get_invalid_backend, name, options)
|
|
|
|
name = 'unittest.TestCase'
|
|
self.assertRaises(ValueError, get_invalid_backend, name, options)
|
|
|
|
|
|
class TestTrackerDjangoInstantiation(TestCase):
|
|
"""Test if backends are initialized properly from Django settings."""
|
|
|
|
@override_settings(TRACKING_BACKENDS=SIMPLE_SETTINGS.copy())
|
|
def test_django_simple_settings(self):
|
|
"""Test configuration of a simple backend"""
|
|
|
|
backends = self._reload_backends()
|
|
|
|
self.assertEqual(len(backends), 1)
|
|
|
|
tracker.send({})
|
|
|
|
self.assertEqual(list(backends.values())[0].count, 1)
|
|
|
|
@override_settings(TRACKING_BACKENDS=MULTI_SETTINGS.copy())
|
|
def test_django_multi_settings(self):
|
|
"""Test if multiple backends can be configured properly."""
|
|
|
|
backends = list(self._reload_backends().values())
|
|
|
|
self.assertEqual(len(backends), 2)
|
|
|
|
event_count = 10
|
|
for _ in range(event_count):
|
|
tracker.send({})
|
|
|
|
self.assertEqual(backends[0].count, event_count)
|
|
self.assertEqual(backends[1].count, event_count)
|
|
|
|
@override_settings(TRACKING_BACKENDS=MULTI_SETTINGS.copy())
|
|
def test_django_remove_settings(self):
|
|
"""Test if a backend can be remove by setting it to None."""
|
|
|
|
settings.TRACKING_BACKENDS.update({'second': None})
|
|
|
|
backends = self._reload_backends()
|
|
|
|
self.assertEqual(len(backends), 1)
|
|
|
|
def _reload_backends(self):
|
|
# pylint: disable=protected-access
|
|
|
|
# Reset backends
|
|
tracker._initialize_backends_from_django_settings()
|
|
|
|
return tracker.backends
|
|
|
|
|
|
class DummyBackend(BaseBackend):
|
|
def __init__(self, **options):
|
|
super(DummyBackend, self).__init__(**options)
|
|
self.flag = options.get('flag', False)
|
|
self.count = 0
|
|
|
|
def send(self, event):
|
|
self.count += 1
|