1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
|
from copy import deepcopy
from django.conf import settings as django_settings
from django.core.exceptions import ImproperlyConfigured
from django.test import override_settings
import pytest
from django_guid.config import Settings
def test_missing_identifier(monkeypatch):
"""
Tests that an exception is raised when identifier is missing.
"""
from django_guid.integrations import SentryIntegration
monkeypatch.setattr(SentryIntegration, 'identifier', None)
with pytest.raises(ImproperlyConfigured, match='`identifier` cannot be None'):
SentryIntegration()
def test_missing_run_method(monkeypatch, client):
"""
Tests that an exception is raised when the run method has not been defined.
"""
from django_guid.integrations import SentryIntegration
monkeypatch.delattr(SentryIntegration, 'run')
mocked_settings = deepcopy(django_settings.DJANGO_GUID)
mocked_settings['INTEGRATIONS'] = [SentryIntegration()]
with override_settings(DJANGO_GUID=mocked_settings):
settings = Settings()
monkeypatch.setattr('django_guid.middleware.settings', settings)
with pytest.raises(ImproperlyConfigured, match='The integration `SentryIntegration` is missing a `run` method'):
client.get('/api')
def test_run_method_not_accepting_kwargs(client):
"""
Tests that an exception is raised when the run method doesn't accept kwargs.
"""
from django_guid.config import Settings
from django_guid.integrations import SentryIntegration
class BadIntegration(SentryIntegration):
def run(self, guid): # pragma: no cover
pass
mocked_settings = deepcopy(django_settings.DJANGO_GUID)
mocked_settings['INTEGRATIONS'] = [BadIntegration()]
with override_settings(DJANGO_GUID=mocked_settings):
with pytest.raises(ImproperlyConfigured, match='Integration method `run` must accept keyword arguments '):
Settings().validate()
def test_cleanup_method_not_accepting_kwargs(client):
"""
Tests that an exception is raised when the run method doesn't accept kwargs.
"""
from django_guid.config import Settings
from django_guid.integrations import SentryIntegration
class BadIntegration(SentryIntegration):
def cleanup(self, guid): # pragma: no cover
pass
mocked_settings = deepcopy(django_settings.DJANGO_GUID)
mocked_settings['INTEGRATIONS'] = [BadIntegration()]
with override_settings(DJANGO_GUID=mocked_settings):
with pytest.raises(ImproperlyConfigured, match='Integration method `cleanup` must accept keyword arguments '):
Settings().validate()
def test_non_callable_methods(monkeypatch, subtests):
"""
Tests that an exception is raised when any of the integration base methods are non-callable.
"""
from django_guid.config import Settings
from django_guid.integrations import SentryIntegration
mock_integration = SentryIntegration()
to_test = [
{
'function_name': 'cleanup',
'error': 'Integration method `cleanup` needs to be made callable for `SentryIntegration`',
},
{
'function_name': 'run',
'error': 'Integration method `run` needs to be made callable for `SentryIntegration`',
},
{
'function_name': 'setup',
'error': 'Integration method `setup` needs to be made callable for `SentryIntegration`',
},
]
for test in to_test:
setattr(mock_integration, test.get('function_name'), 'test')
mocked_settings = deepcopy(django_settings.DJANGO_GUID)
mocked_settings['INTEGRATIONS'] = [mock_integration]
with override_settings(DJANGO_GUID=mocked_settings):
with subtests.test(msg=f'Testing function {test.get("function_name")}'):
with pytest.raises(ImproperlyConfigured, match=test.get('error')):
Settings().validate()
def test_base_class():
"""
Test that a basic implementation of an integration works as expected.
"""
from django_guid.integrations import Integration
class MyCustomIntegration(Integration):
identifier = 'My custom integration'
def run(self, guid, **kwargs):
pass
def cleanup(self, **kwargs):
pass
stub_integration = MyCustomIntegration()
assert stub_integration.setup() is None
assert stub_integration.run('test') is None
assert stub_integration.cleanup() is None
|
