Skip to content

E
event-tracking
Commit 2ee5aceb by Gabe Mulley
Options

Change Django settings prefix to EVENT_TRACKING 

This will prevent conflicts with the existing edx-platform settings.

Change-Id: I0ea1a2b19d1097963a9faead43b7aa0480c41ef2
parent 402d3e7a
Showing with 23 additions and 22 deletions
eventtracking/django/__init__.py
......@@ -11,8 +11,9 @@ from eventtracking.tracker import Tracker
from eventtracking.locator import ThreadLocalContextLocator
DJANGO_BACKEND_SETTING_NAME = 'TRACKING_BACKENDS'
DJANGO_PROCESSOR_SETTING_NAME = 'TRACKING_PROCESSORS'
DJANGO_BACKEND_SETTING_NAME = 'EVENT_TRACKING_BACKENDS'
DJANGO_PROCESSOR_SETTING_NAME = 'EVENT_TRACKING_PROCESSORS'
DJANGO_ENABLED_SETTING_NAME = 'EVENT_TRACKING_ENABLED'
class DjangoTracker(Tracker):
......@@ -28,12 +29,12 @@ class DjangoTracker(Tracker):
def create_backends_from_settings(self):
"""
Expects the Django setting "TRACKING_BACKENDS" to be defined and point
Expects the Django setting "EVENT_TRACKING_BACKENDS" to be defined and point
to a dictionary of backend engine configurations.
Example::
TRACKING_BACKENDS = {
EVENT_TRACKING_BACKENDS = {
'default': {
'ENGINE': 'some.arbitrary.Backend',
'OPTIONS': {
......@@ -87,12 +88,12 @@ class DjangoTracker(Tracker):
def create_processors_from_settings(self):
"""
Expects the Django setting "TRACKING_PROCESSORS" to be defined and
Expects the Django setting "EVENT_TRACKING_PROCESSORS" to be defined and
point to a list of backend engine configurations.
Example::
TRACKING_PROCESSORS = [
EVENT_TRACKING_PROCESSORS = [
{
'ENGINE': 'some.arbitrary.Processor'
},
......@@ -117,7 +118,7 @@ class DjangoTracker(Tracker):
def override_default_tracker():
"""Sets the default tracker to a DjangoTracker"""
if getattr(settings, 'TRACKING_ENABLED', False):
if getattr(settings, DJANGO_ENABLED_SETTING_NAME, False):
tracker.register_tracker(DjangoTracker())
......
eventtracking/django/tests/settings.py
......@@ -24,4 +24,4 @@ INSTALLED_APPS = [
TEST_RUNNER = 'django_nose.NoseTestSuiteRunner'
TRACKING_ENABLED = True
EVENT_TRACKING_ENABLED = True
eventtracking/django/tests/test_configuration.py
......@@ -21,7 +21,7 @@ class TestConfiguration(TestCase):
def setUp(self):
self.tracker = tracker.get_tracker()
@override_settings(TRACKING_BACKENDS={
@override_settings(EVENT_TRACKING_BACKENDS={
"fake": {
'ENGINE': 'eventtracking.django.tests.test_configuration.TrivialFakeBackend'
}
......@@ -35,7 +35,7 @@ class TestConfiguration(TestCase):
"""Reads the tracker configuration from the Django settings"""
self.tracker = django.DjangoTracker()
@override_settings(TRACKING_BACKENDS={
@override_settings(EVENT_TRACKING_BACKENDS={
"no_engine": {
'OPTIONS': {}
}
......@@ -45,7 +45,7 @@ class TestConfiguration(TestCase):
with self.assertRaises(KeyError):
self.tracker.get_backend('no_engine')
@override_settings(TRACKING_BACKENDS={
@override_settings(EVENT_TRACKING_BACKENDS={
"empty_engine": {
'ENGINE': ''
}
......@@ -61,7 +61,7 @@ class TestConfiguration(TestCase):
with self.assertRaises(error):
self.configure_tracker()
@override_settings(TRACKING_BACKENDS={
@override_settings(EVENT_TRACKING_BACKENDS={
"invalid_package": {
'ENGINE': 'foo.BarBackend'
}
......@@ -69,7 +69,7 @@ class TestConfiguration(TestCase):
def test_configure_invalid_package(self):
self.assert_fails_to_configure_with_error()
@override_settings(TRACKING_BACKENDS={
@override_settings(EVENT_TRACKING_BACKENDS={
"no_package_invalid_class": {
'ENGINE': 'BarBackend'
}
......@@ -77,7 +77,7 @@ class TestConfiguration(TestCase):
def test_configure_no_package_invalid_class(self):
self.assert_fails_to_configure_with_error()
@override_settings(TRACKING_BACKENDS={
@override_settings(EVENT_TRACKING_BACKENDS={
"invalid_class": {
'ENGINE': 'eventtracking.django.tests.test_configuration.BarBackend'
}
......@@ -85,7 +85,7 @@ class TestConfiguration(TestCase):
def test_configure_invalid_class(self):
self.assert_fails_to_configure_with_error()
@override_settings(TRACKING_BACKENDS={
@override_settings(EVENT_TRACKING_BACKENDS={
'with_options': {
'ENGINE': 'eventtracking.django.tests.test_configuration.FakeBackendWithOptions',
'OPTIONS': {
......@@ -97,7 +97,7 @@ class TestConfiguration(TestCase):
self.configure_tracker()
self.assertEquals(self.tracker.get_backend('with_options').option, sentinel.option_value)
@override_settings(TRACKING_BACKENDS={
@override_settings(EVENT_TRACKING_BACKENDS={
'without_options': {
'ENGINE': 'eventtracking.django.tests.test_configuration.FakeBackendWithOptions'
}
......@@ -106,7 +106,7 @@ class TestConfiguration(TestCase):
self.configure_tracker()
self.assertEquals(self.tracker.get_backend('without_options').option, None)
@override_settings(TRACKING_BACKENDS={
@override_settings(EVENT_TRACKING_BACKENDS={
'extra_options': {
'ENGINE': 'eventtracking.django.tests.test_configuration.FakeBackendWithOptions',
'OPTIONS': {
......@@ -119,7 +119,7 @@ class TestConfiguration(TestCase):
self.configure_tracker()
self.assertEquals(self.tracker.get_backend('extra_options').option, sentinel.option_value)
@override_settings(TRACKING_BACKENDS={
@override_settings(EVENT_TRACKING_BACKENDS={
'extra_options': {
'ENGINE': 'eventtracking.django.tests.test_configuration.NotABackend'
}
......@@ -127,17 +127,17 @@ class TestConfiguration(TestCase):
def test_configure_class_not_a_backend(self):
self.assert_fails_to_configure_with_error()
@override_settings(TRACKING_ENABLED=True)
@override_settings(EVENT_TRACKING_ENABLED=True)
def test_overrides_default_tracker(self):
django.override_default_tracker()
self.assertTrue(isinstance(tracker.get_tracker(), django.DjangoTracker))
@override_settings(TRACKING_ENABLED=False)
@override_settings(EVENT_TRACKING_ENABLED=False)
def test_leaves_default_tracker_alone(self):
django.override_default_tracker()
self.assertTrue(isinstance(tracker.get_tracker(), tracker.Tracker))
@override_settings(TRACKING_PROCESSORS=[
@override_settings(EVENT_TRACKING_PROCESSORS=[
{
'ENGINE': 'eventtracking.django.tests.test_configuration.NopProcessor'
}
......@@ -147,7 +147,7 @@ class TestConfiguration(TestCase):
self.assertEquals(len(self.tracker.processors), 1)
self.assertTrue(isinstance(self.tracker.processors[0], NopProcessor))
@override_settings(TRACKING_PROCESSORS=[
@override_settings(EVENT_TRACKING_PROCESSORS=[
{}
])
def test_missing_processor_engine(self):
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment