forked from marselester/json-log-formatter
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathtests.py
266 lines (221 loc) · 8.92 KB
/
tests.py
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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
from datetime import datetime
from decimal import Decimal
from io import BytesIO
import unittest
import logging
import json
from django.core.handlers.wsgi import WSGIRequest
from django.conf import settings
import ujson
import simplejson
try:
from cStringIO import StringIO
except ImportError:
from io import StringIO
from json_log_formatter import JSONFormatter
log_buffer = StringIO()
json_handler = logging.StreamHandler(log_buffer)
logger = logging.getLogger('test')
logger.addHandler(json_handler)
logger.setLevel(logging.DEBUG)
logging.propagate = False
DATETIME = datetime(2015, 9, 1, 6, 9, 42, 797203)
DATETIME_ISO = u'2015-09-01T06:09:42.797203'
settings.configure(DEBUG=True)
class TestCase(unittest.TestCase):
def tearDown(self):
log_buffer.seek(0)
log_buffer.truncate()
class JSONFormatterTest(TestCase):
def setUp(self):
json_handler.setFormatter(JSONFormatter())
def test_given_time_is_used_in_log_record(self):
logger.info('Sign up', extra={'time': DATETIME})
expected_time = '"time": "2015-09-01T06:09:42.797203"'
self.assertIn(expected_time, log_buffer.getvalue())
def test_current_time_is_used_by_default_in_log_record(self):
logger.info('Sign up', extra={'fizz': 'bazz'})
self.assertNotIn(DATETIME_ISO, log_buffer.getvalue())
def test_message_and_time_are_in_json_record_when_extra_is_blank(self):
logger.info('Sign up')
json_record = json.loads(log_buffer.getvalue())
expected_fields = set([
'message',
'time',
])
self.assertEqual(set(json_record), expected_fields)
def test_message_and_time_and_extra_are_in_json_record_when_extra_is_provided(self):
logger.info('Sign up', extra={'fizz': 'bazz'})
json_record = json.loads(log_buffer.getvalue())
expected_fields = set([
'message',
'time',
'fizz',
])
self.assertEqual(set(json_record), expected_fields)
def test_exc_info_is_logged(self):
try:
raise ValueError('something wrong')
except ValueError:
logger.error('Request failed', exc_info=True)
json_record = json.loads(log_buffer.getvalue())
self.assertIn(
'Traceback (most recent call last)',
json_record['exc_info']
)
class MutatingFormatter(JSONFormatter):
def mutate_json_record(self, json_record):
new_record = {}
for k, v in json_record.items():
if isinstance(v, datetime):
v = v.isoformat()
new_record[k] = v
return new_record
class MutatingFormatterTest(TestCase):
def setUp(self):
json_handler.setFormatter(MutatingFormatter())
def test_new_record_accepted(self):
logger.info('Sign up', extra={'fizz': DATETIME})
json_record = json.loads(log_buffer.getvalue())
self.assertEqual(json_record['fizz'], DATETIME_ISO)
class JsonLibTest(TestCase):
def setUp(self):
json_handler.setFormatter(JSONFormatter())
def test_builtin_types_are_serialized(self):
logger.log(level=logging.ERROR, msg='Payment was sent', extra={
'first_name': 'bob',
'amount': 0.00497265,
'context': {
'tags': ['fizz', 'bazz'],
},
'things': ('a', 'b'),
'ok': True,
'none': None,
})
json_record = json.loads(log_buffer.getvalue())
self.assertEqual(json_record['first_name'], 'bob')
self.assertEqual(json_record['amount'], 0.00497265)
self.assertEqual(json_record['context'], {'tags': ['fizz', 'bazz']})
self.assertEqual(json_record['things'], ['a', 'b'])
self.assertEqual(json_record['ok'], True)
self.assertEqual(json_record['none'], None)
def test_decimal_is_serialized_as_string(self):
logger.log(level=logging.ERROR, msg='Payment was sent', extra={
'amount': Decimal('0.00497265')
})
expected_amount = '"amount": "0.00497265"'
self.assertIn(expected_amount, log_buffer.getvalue())
def test_django_wsgi_request_is_serialized_as_dict(self):
request = WSGIRequest({
'PATH_INFO': 'bogus',
'REQUEST_METHOD': 'bogus',
'CONTENT_TYPE': 'text/html; charset=utf8',
'wsgi.input': BytesIO(b''),
})
logger.log(level=logging.ERROR, msg='Django response error', extra={
'status_code': 500,
'request': request
})
json_record = json.loads(log_buffer.getvalue())
self.assertEqual(json_record['status_code'], 500)
self.assertEqual(json_record['request']['path'], '/bogus')
self.assertEqual(json_record['request']['method'], 'BOGUS')
class UjsonLibTest(TestCase):
def setUp(self):
formatter = JSONFormatter()
formatter.json_lib = ujson
json_handler.setFormatter(formatter)
def test_builtin_types_are_serialized(self):
logger.log(level=logging.ERROR, msg='Payment was sent', extra={
'first_name': 'bob',
'amount': 0.00497265,
'context': {
'tags': ['fizz', 'bazz'],
},
'things': ('a', 'b'),
'ok': True,
'none': None,
})
json_record = json.loads(log_buffer.getvalue())
self.assertEqual(json_record['first_name'], 'bob')
self.assertEqual(json_record['amount'], 0.00497265)
self.assertEqual(json_record['context'], {'tags': ['fizz', 'bazz']})
self.assertEqual(json_record['things'], ['a', 'b'])
self.assertEqual(json_record['ok'], True)
self.assertEqual(json_record['none'], None)
def test_decimal_is_serialized_as_number(self):
logger.info('Payment was sent', extra={
'amount': Decimal('0.00497265')
})
expected_amount = '"amount":0.00497265'
self.assertIn(expected_amount, log_buffer.getvalue())
def test_zero_expected_when_decimal_is_in_scientific_notation(self):
logger.info('Payment was sent', extra={
'amount': Decimal('0E-8')
})
expected_amount = '"amount":0.0'
self.assertIn(expected_amount, log_buffer.getvalue())
def test_django_wsgi_request_is_serialized_as_empty_list(self):
request = WSGIRequest({
'PATH_INFO': 'bogus',
'REQUEST_METHOD': 'bogus',
'CONTENT_TYPE': 'text/html; charset=utf8',
'wsgi.input': BytesIO(b''),
})
logger.log(level=logging.ERROR, msg='Django response error', extra={
'status_code': 500,
'request': request
})
json_record = json.loads(log_buffer.getvalue())
self.assertEqual(json_record['status_code'], 500)
self.assertEqual(json_record['request'], [])
class SimplejsonLibTest(TestCase):
def setUp(self):
formatter = JSONFormatter()
formatter.json_lib = simplejson
json_handler.setFormatter(formatter)
def test_builtin_types_are_serialized(self):
logger.log(level=logging.ERROR, msg='Payment was sent', extra={
'first_name': 'bob',
'amount': 0.00497265,
'context': {
'tags': ['fizz', 'bazz'],
},
'things': ('a', 'b'),
'ok': True,
'none': None,
})
json_record = json.loads(log_buffer.getvalue())
self.assertEqual(json_record['first_name'], 'bob')
self.assertEqual(json_record['amount'], 0.00497265)
self.assertEqual(json_record['context'], {'tags': ['fizz', 'bazz']})
self.assertEqual(json_record['things'], ['a', 'b'])
self.assertEqual(json_record['ok'], True)
self.assertEqual(json_record['none'], None)
def test_decimal_is_serialized_as_number(self):
logger.info('Payment was sent', extra={
'amount': Decimal('0.00497265')
})
expected_amount = '"amount": 0.00497265'
self.assertIn(expected_amount, log_buffer.getvalue())
def test_decimal_is_serialized_as_it_is_when_it_is_in_scientific_notation(self):
logger.info('Payment was sent', extra={
'amount': Decimal('0E-8')
})
expected_amount = '"amount": 0E-8'
self.assertIn(expected_amount, log_buffer.getvalue())
def test_django_wsgi_request_is_serialized_as_dict(self):
request = WSGIRequest({
'PATH_INFO': 'bogus',
'REQUEST_METHOD': 'bogus',
'CONTENT_TYPE': 'text/html; charset=utf8',
'wsgi.input': BytesIO(b''),
})
logger.log(level=logging.ERROR, msg='Django response error', extra={
'status_code': 500,
'request': request
})
json_record = json.loads(log_buffer.getvalue())
self.assertEqual(json_record['status_code'], 500)
self.assertEqual(json_record['request']['path'], '/bogus')
self.assertEqual(json_record['request']['method'], 'BOGUS')