django-server-errors 1.0.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,176 @@
1
+ from datetime import timedelta
2
+ from importlib.util import find_spec
3
+ from unittest import skipIf
4
+
5
+ from django.conf import settings
6
+ from django.test import Client, TestCase, override_settings
7
+ from django.utils import timezone
8
+
9
+ from errors.models import Error, ErrorTrace
10
+ from errors.recorder import record
11
+ from errors.tests.mixins import TestsAreProjectCode
12
+
13
+ try:
14
+ from celery import shared_task
15
+ except ImportError: # Celery is optional
16
+ shared_task = None
17
+
18
+ MASK = '********************'
19
+ WITHOUT_DRF = find_spec('rest_framework') is None
20
+
21
+ if shared_task is not None:
22
+ @shared_task
23
+ def failing_task(order_id, password):
24
+ raise RuntimeError(f'no order {order_id}')
25
+
26
+
27
+ def frame_vars(trace, function):
28
+ frame = next(frame for frame in trace.frames if frame['function'] == function)
29
+ return dict(frame['vars'])
30
+
31
+
32
+ @override_settings(ROOT_URLCONF='errors.tests.urls')
33
+ class RequestErrorTests(TestsAreProjectCode, TestCase):
34
+ def setUp(self):
35
+ super().setUp()
36
+ self.client = Client(raise_request_exception=False)
37
+
38
+ def test_same_error_at_same_place_is_one_group(self):
39
+ self.assertEqual(self.client.get('/boom/?n=1').status_code, 500)
40
+ self.assertEqual(self.client.get('/boom/?n=2').status_code, 500)
41
+
42
+ error = Error.objects.get()
43
+ self.assertEqual(error.kind, Error.Kind.REQUEST)
44
+ self.assertEqual(error.name, 'ValueError')
45
+ self.assertEqual(error.message, 'bad 2')
46
+ self.assertEqual(error.source, 'GET boom')
47
+ self.assertEqual(error.location, 'errors/tests/urls.py in boom')
48
+ self.assertEqual(error.count, 2)
49
+ self.assertLess(error.first_seen, error.last_seen)
50
+ self.assertEqual([trace.message for trace in error.traces.all()], ['bad 2', 'bad 1'])
51
+ trace = error.traces.first()
52
+ self.assertIn('raise ValueError', trace.traceback)
53
+ self.assertEqual(trace.context['query'], {'n': '2'})
54
+ self.assertEqual(trace.context['status'], 500)
55
+ self.assertEqual(trace.context['view'], 'errors.tests.urls.boom')
56
+
57
+ def test_other_place_or_method_is_another_group(self):
58
+ self.client.get('/boom/')
59
+ self.client.get('/other/')
60
+ self.client.post('/boom/')
61
+
62
+ self.assertEqual(
63
+ sorted(Error.objects.values_list('source', 'location')),
64
+ [
65
+ ('GET boom', 'errors/tests/urls.py in boom'),
66
+ ('GET other', 'errors/tests/urls.py in other_boom'),
67
+ ('POST boom', 'errors/tests/urls.py in boom'),
68
+ ],
69
+ )
70
+
71
+ def test_5xx_response_without_exception(self):
72
+ self.client.get('/unavailable/')
73
+
74
+ error = Error.objects.get()
75
+ self.assertEqual((error.name, error.message, error.location), ('HTTP 503', 'Service Unavailable', ''))
76
+ self.assertEqual(error.traces.get().frames, [])
77
+
78
+ def test_4xx_are_not_recorded(self):
79
+ self.assertEqual(self.client.get('/missing/').status_code, 404)
80
+ self.assertEqual(self.client.get('/bad/').status_code, 400)
81
+ self.assertEqual(self.client.get('/nowhere/').status_code, 404)
82
+
83
+ self.assertFalse(Error.objects.exists())
84
+
85
+ def test_exception_in_middleware(self):
86
+ middleware = list(settings.MIDDLEWARE)
87
+ middleware.insert(middleware.index('errors.middleware.ErrorCaptureMiddleware') + 1, 'errors.tests.urls.FailingMiddleware')
88
+ with self.settings(MIDDLEWARE=middleware):
89
+ self.assertEqual(self.client.get('/middleware/').status_code, 500)
90
+
91
+ error = Error.objects.get()
92
+ self.assertEqual(error.name, 'RuntimeError')
93
+ self.assertEqual(error.source, 'GET middleware') # resolved, though the view was never reached
94
+ self.assertEqual(error.location, 'errors/tests/urls.py in FailingMiddleware.__call__')
95
+ self.assertIn('middleware failed', error.traces.get().traceback)
96
+
97
+ def test_locals(self):
98
+ self.client.get('/boom/?n=1&token=qwerty-token&password=hunter2')
99
+
100
+ trace = ErrorTrace.objects.get()
101
+ self.assertEqual(trace.context['query'], {'n': '1', 'token': MASK, 'password': MASK})
102
+ frame = next(frame for frame in trace.frames if frame['function'] == 'boom')
103
+ self.assertTrue(frame['in_app'])
104
+ self.assertIn([frame['lineno'], " raise ValueError(f\"bad {request.GET.get('n')}\")"], frame['lines'])
105
+ variables = dict(frame['vars'])
106
+ self.assertEqual(variables['password'], MASK)
107
+ self.assertEqual(variables['data'], f"{{'name': 'Ann', 'token': '{MASK}'}}")
108
+ self.assertEqual(variables['pending'], '<QuerySet of Error, not evaluated>')
109
+ self.assertTrue(variables['long_text'].startswith("'xxx"))
110
+ self.assertTrue(variables['long_text'].endswith('<trimmed 5002 bytes string>'))
111
+ self.assertEqual(variables['request'], "<WSGIRequest: GET '/boom/'>")
112
+ self.assertFalse(next(frame for frame in trace.frames if frame['file'].startswith('django/'))['in_app'])
113
+ self.assertNotIn('qwerty-token', str(trace.frames))
114
+ self.assertNotIn('hunter2', str(trace.frames))
115
+
116
+ def test_sensitive_variables_hide_called_frames_too(self):
117
+ self.client.get('/secret/')
118
+
119
+ trace = ErrorTrace.objects.get()
120
+ self.assertEqual(frame_vars(trace, 'secret'), {'code': MASK, 'request': MASK})
121
+ self.assertEqual(frame_vars(trace, 'send_code'), {'code': MASK, 'text': MASK})
122
+ self.assertNotIn('1234', str(trace.frames))
123
+
124
+ @skipIf(WITHOUT_DRF, 'Django REST framework is not installed')
125
+ def test_drf_view(self):
126
+ self.client.get('/api/boom/?token=qwerty-token')
127
+
128
+ error = Error.objects.get()
129
+ self.assertEqual((error.name, error.source), ('KeyError', 'GET api-boom'))
130
+ self.assertEqual(error.location, 'errors/tests/urls.py in ApiBoom.get')
131
+ self.assertEqual(frame_vars(error.traces.get(), 'get')['request'], "<Request: GET '/api/boom/'>")
132
+
133
+ @skipIf(WITHOUT_DRF, 'Django REST framework is not installed')
134
+ def test_drf_api_exception(self):
135
+ self.assertEqual(self.client.get('/api/handled/').status_code, 500)
136
+
137
+ error = Error.objects.get()
138
+ self.assertEqual((error.name, error.message, error.source), ('HTTP 500', 'no such model', 'GET api-handled'))
139
+
140
+
141
+ @skipIf(shared_task is None, 'Celery is not installed')
142
+ class TaskErrorTests(TestsAreProjectCode, TestCase):
143
+ def test_failed_task(self):
144
+ failing_task.apply(args=(5, 'hunter2'))
145
+
146
+ error = Error.objects.get()
147
+ self.assertEqual(error.kind, Error.Kind.TASK)
148
+ self.assertEqual(error.name, 'RuntimeError')
149
+ self.assertEqual(error.source, 'errors.tests.test_recording.failing_task')
150
+ self.assertEqual(error.location, 'errors/tests/test_recording.py in failing_task')
151
+ trace = error.traces.get()
152
+ self.assertEqual(trace.message, 'no order 5')
153
+ self.assertEqual(set(trace.context), {'task_id', 'retries', 'hostname'})
154
+ self.assertEqual(frame_vars(trace, 'failing_task'), {'order_id': '5', 'password': MASK})
155
+
156
+
157
+ class RecordTests(TestCase):
158
+ @override_settings(ERRORS_MAX_TRACES=3)
159
+ def test_only_latest_traces_are_kept(self):
160
+ for n in range(5):
161
+ record(Error.Kind.TASK, 'task', 'ValueError', f'bad {n}', 'here.py in f')
162
+
163
+ error = Error.objects.get()
164
+ self.assertEqual(error.count, 5)
165
+ self.assertEqual([trace.message for trace in error.traces.all()], ['bad 4', 'bad 3', 'bad 2'])
166
+
167
+ def test_nul_is_escaped(self):
168
+ record(Error.Kind.REQUEST, 'GET boom', 'ValueError', 'bad \x00', context={'query': {'q': '\x00'}})
169
+
170
+ trace = ErrorTrace.objects.get()
171
+ self.assertEqual((trace.message, trace.context['query']['q']), ('bad \\x00', '\\x00'))
172
+
173
+ def test_frequency_per_day(self):
174
+ now = timezone.now()
175
+ self.assertAlmostEqual(Error(count=10, first_seen=now - timedelta(days=2)).frequency, 5, places=3)
176
+ self.assertEqual(Error(count=3, first_seen=now - timedelta(hours=1)).frequency, 3)
errors/tests/urls.py ADDED
@@ -0,0 +1,90 @@
1
+ """
2
+ Views that fail in different ways, and the admin to render errors in
3
+ """
4
+ from django.contrib import admin
5
+ from django.core.exceptions import BadRequest
6
+ from django.http import Http404, HttpResponse
7
+ from django.urls import path
8
+ from django.views.decorators.debug import sensitive_variables
9
+
10
+ from errors.models import Error
11
+
12
+ try:
13
+ from rest_framework.exceptions import APIException
14
+ from rest_framework.views import APIView
15
+ except ImportError: # Django REST framework is optional
16
+ APIView = None
17
+
18
+
19
+ def boom(request):
20
+ password = request.GET.get('password') # noqa: F841, the locals are what the tests look at
21
+ data = {'name': 'Ann', 'token': 'abc'} # noqa: F841
22
+ pending = Error.objects.filter(name='never') # noqa: F841
23
+ long_text = 'x' * 5000 # noqa: F841
24
+ raise ValueError(f"bad {request.GET.get('n')}")
25
+
26
+
27
+ def other_boom(request):
28
+ raise ValueError('bad')
29
+
30
+
31
+ def unavailable(request):
32
+ return HttpResponse('down', status=503)
33
+
34
+
35
+ def missing(request):
36
+ raise Http404()
37
+
38
+
39
+ def bad_request(request):
40
+ raise BadRequest()
41
+
42
+
43
+ def send_code(code):
44
+ text = f'code {code}' # noqa: F841
45
+ raise ConnectionError('gateway is down')
46
+
47
+
48
+ @sensitive_variables()
49
+ def secret(request):
50
+ code = str(1000 + 234)
51
+ send_code(code)
52
+
53
+
54
+ class FailingMiddleware:
55
+ def __init__(self, get_response):
56
+ self.get_response = get_response
57
+
58
+ def __call__(self, request):
59
+ if request.path == '/middleware/':
60
+ raise RuntimeError('middleware failed')
61
+ return self.get_response(request)
62
+
63
+
64
+ urlpatterns = [
65
+ path('boom/', boom, name='boom'),
66
+ path('other/', other_boom, name='other'),
67
+ path('unavailable/', unavailable, name='unavailable'),
68
+ path('missing/', missing, name='missing'),
69
+ path('bad/', bad_request, name='bad'),
70
+ path('secret/', secret, name='secret'),
71
+ path('middleware/', unavailable, name='middleware'),
72
+ path('admin/', admin.site.urls),
73
+ ]
74
+
75
+ if APIView is not None:
76
+ class ApiBoom(APIView):
77
+ authentication_classes = []
78
+ permission_classes = []
79
+
80
+ def get(self, request):
81
+ raise KeyError(request.query_params.get('n'))
82
+
83
+ class ApiHandled(ApiBoom):
84
+ def get(self, request):
85
+ raise APIException('no such model')
86
+
87
+ urlpatterns += [
88
+ path('api/boom/', ApiBoom.as_view(), name='api-boom'),
89
+ path('api/handled/', ApiHandled.as_view(), name='api-handled'),
90
+ ]