test_log_helper.py
12.1 KB
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
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
""" Test the log helper
This tests the generic log helper.
Check if it handles imported modules correctly
and that the default silent logger won't log when nothing is enabled
"""
import unittest
import sys
import json
import subprocess
from tests.common.log_helper import log_helper_test_main
from tests.common.log_helper import log_helper_test_imported
import os
from os.path import dirname, join, relpath, abspath
from tests.test_utils import PROJECT_ROOT
# test file we use as "main" module
TEST_FILE = join(dirname(abspath(__file__)), 'log_helper_test_main.py')
# test file simulating a third party main module that only imports oletools
TEST_FILE_3RD_PARTY = relpath(join(dirname(abspath(__file__)),
'third_party_importer.py'),
PROJECT_ROOT)
PYTHON_EXECUTABLE = sys.executable
PERCENT_FORMAT_OUTPUT = 'The answer is 47.'
class TestLogHelper(unittest.TestCase):
def test_it_doesnt_log_when_not_enabled(self):
output = self._run_test(['debug'])
self.assertTrue(len(output) == 0)
def test_it_doesnt_log_json_when_not_enabled(self):
output = self._run_test(['as-json', 'debug'])
self.assertTrue(len(output) == 0)
def test_logs_when_enabled(self):
output = self._run_test(['enable', 'warning'])
expected_messages = [
log_helper_test_main.WARNING_MESSAGE,
log_helper_test_main.ERROR_MESSAGE,
log_helper_test_main.CRITICAL_MESSAGE,
log_helper_test_imported.WARNING_MESSAGE,
log_helper_test_imported.ERROR_MESSAGE,
log_helper_test_imported.CRITICAL_MESSAGE
]
for msg in expected_messages:
self.assertIn(msg, output)
def test_logs_json_when_enabled(self):
output = self._run_test(['enable', 'as-json', 'critical'])
self._assert_json_messages(output, [
log_helper_test_main.CRITICAL_MESSAGE,
log_helper_test_imported.CRITICAL_MESSAGE
])
def test_logs_type_ignored(self):
"""Run test script with logging enabled at info level. Want no type."""
output = self._run_test(['enable', 'info'])
expect = '\n'.join([
'INFO ' + log_helper_test_main.INFO_MESSAGE,
'WARNING ' + log_helper_test_main.WARNING_MESSAGE,
'ERROR ' + log_helper_test_main.ERROR_MESSAGE,
'CRITICAL ' + log_helper_test_main.CRITICAL_MESSAGE,
'INFO ' + log_helper_test_main.RESULT_MESSAGE,
'INFO ' + log_helper_test_imported.INFO_MESSAGE,
'WARNING ' + log_helper_test_imported.WARNING_MESSAGE,
'ERROR ' + log_helper_test_imported.ERROR_MESSAGE,
'CRITICAL ' + log_helper_test_imported.CRITICAL_MESSAGE,
'INFO ' + log_helper_test_imported.RESULT_MESSAGE,
])
self.assertEqual(output, expect)
def test_logs_type_in_json(self):
"""Check type field is contained in json log."""
output = self._run_test(['enable', 'as-json', 'info'])
# convert to json preserving order of output
jout = json.loads(output)
jexpect = [
dict(type='msg', level='INFO',
msg=log_helper_test_main.INFO_MESSAGE),
dict(type='msg', level='WARNING',
msg=log_helper_test_main.WARNING_MESSAGE),
dict(type='msg', level='ERROR',
msg=log_helper_test_main.ERROR_MESSAGE),
dict(type='msg', level='CRITICAL',
msg=log_helper_test_main.CRITICAL_MESSAGE),
# this is the important entry (has a different "type" field):
dict(type=log_helper_test_main.RESULT_TYPE, level='INFO',
msg=log_helper_test_main.RESULT_MESSAGE),
dict(type='msg', level='INFO',
msg=log_helper_test_imported.INFO_MESSAGE),
dict(type='msg', level='WARNING',
msg=log_helper_test_imported.WARNING_MESSAGE),
dict(type='msg', level='ERROR',
msg=log_helper_test_imported.ERROR_MESSAGE),
dict(type='msg', level='CRITICAL',
msg=log_helper_test_imported.CRITICAL_MESSAGE),
# ... and this:
dict(type=log_helper_test_imported.RESULT_TYPE, level='INFO',
msg=log_helper_test_imported.RESULT_MESSAGE),
]
self.assertEqual(jout, jexpect)
def test_percent_autoformat(self):
"""Test that auto-formatting of log strings with `%` works."""
output = self._run_test(['enable', '%-autoformat', 'info'])
self.assertIn(PERCENT_FORMAT_OUTPUT, output)
def test_json_correct_on_exceptions(self):
"""
Test that even on unhandled exceptions our JSON is always correct
"""
output = self._run_test(['enable', 'as-json', 'throw', 'critical'], False)
self._assert_json_messages(output, [
log_helper_test_main.CRITICAL_MESSAGE,
log_helper_test_imported.CRITICAL_MESSAGE
])
def test_import_by_third_party_disabled(self):
"""Test that when imported by third party, logging is still disabled."""
output = self._run_test([], run_third_party=True).splitlines()
self.assertEqual(len(output), 2)
self.assertEqual(output[0],
'INFO:root:Start message from 3rd party importer')
self.assertEqual(output[1],
'INFO:root:End message from 3rd party importer')
def test_import_by_third_party_enabled(self):
"""Test that when imported by third party, logging can be enabled."""
output = self._run_test(['enable', ], run_third_party=True).splitlines()
self.assertEqual(len(output), 12)
self.assertIn('INFO:test_main:main: info log', output)
self.assertIn('INFO:test_imported:imported: info log', output)
def test_json_correct_on_warnings(self):
"""
Test that even on warnings our JSON is always correct
"""
output = self._run_test(['enable', 'as-json', 'warn', 'warning'])
expected_messages = [
log_helper_test_main.WARNING_MESSAGE,
log_helper_test_main.ERROR_MESSAGE,
log_helper_test_main.CRITICAL_MESSAGE,
log_helper_test_imported.WARNING_MESSAGE,
log_helper_test_imported.ERROR_MESSAGE,
log_helper_test_imported.CRITICAL_MESSAGE,
]
for msg in expected_messages:
self.assertIn(msg, output)
# last two entries of output should be warnings
jout = json.loads(output)
self.assertEqual(jout[-2]['level'], 'WARNING')
self.assertEqual(jout[-1]['level'], 'WARNING')
self.assertEqual(jout[-2]['type'], 'warning')
self.assertEqual(jout[-1]['type'], 'warning')
self.assertIn(log_helper_test_main.ACTUAL_WARNING, jout[-2]['msg'])
self.assertIn(log_helper_test_imported.ACTUAL_WARNING, jout[-1]['msg'])
def test_warnings(self):
"""Check that warnings are captured and printed correctly"""
output = self._run_test(['enable', 'warn', 'warning'])
# find out which line contains the call to warnings.warn:
warnings_line = None
with open(TEST_FILE, 'rt') as reader:
for line_idx, line in enumerate(reader):
if 'warnings.warn' in line:
warnings_line = line_idx + 1
break
self.assertNotEqual(warnings_line, None)
imported_file = join(dirname(abspath(__file__)),
'log_helper_test_imported.py')
imported_line = None
with open(imported_file, 'rt') as reader:
for line_idx, line in enumerate(reader):
if 'warnings.warn' in line:
imported_line = line_idx + 1
break
self.assertNotEqual(imported_line, None)
expect = '\n'.join([
'WARNING ' + log_helper_test_main.WARNING_MESSAGE,
'ERROR ' + log_helper_test_main.ERROR_MESSAGE,
'CRITICAL ' + log_helper_test_main.CRITICAL_MESSAGE,
'WARNING ' + log_helper_test_imported.WARNING_MESSAGE,
'ERROR ' + log_helper_test_imported.ERROR_MESSAGE,
'CRITICAL ' + log_helper_test_imported.CRITICAL_MESSAGE,
'WARNING {0}:{1}: UserWarning: {2}'
.format(TEST_FILE, warnings_line, log_helper_test_main.ACTUAL_WARNING),
' warnings.warn(ACTUAL_WARNING)', # warnings include source line
'',
'WARNING {0}:{1}: UserWarning: {2}'
.format(imported_file, imported_line, log_helper_test_imported.ACTUAL_WARNING),
' warnings.warn(ACTUAL_WARNING)', # warnings include source line
])
self.assertEqual(output.strip(), expect)
def test_json_percent_formatting(self):
"""Test that json-output has formatting args included in output."""
output = self._run_test(['enable', 'as-json', '%-autoformat', 'info'])
json.loads(output) # check that this does not raise, so json is valid
self.assertIn(PERCENT_FORMAT_OUTPUT, output)
def test_json_exception_formatting(self):
"""Test that json-output has formatted exception info in output"""
output = self._run_test(['enable', 'as-json', 'exc-info', 'info'])
json.loads(output) # check that this does not raise, so json is valid
self.assertIn('Caught exception', output) # actual log message
self.assertIn('This is an exception', output) # message of caught exception
self.assertIn('Traceback (most recent call last)', output) # start of trace
self.assertIn(TEST_FILE.replace('\\', '\\\\'), output) # part of trace
def test_json_wrong_args(self):
"""Test that too many or missing args do not raise exceptions inside logger"""
output = self._run_test(['enable', 'as-json', 'wrong-log-args', 'info'])
json.loads(output) # check that this does not raise, so json is valid
# do not care about actual contents of output
def _assert_json_messages(self, output, messages):
try:
json_data = json.loads(output)
self.assertEqual(len(json_data), len(messages))
for i in range(len(messages)):
self.assertEqual(messages[i], json_data[i]['msg'])
except ValueError:
self.fail('Invalid json:\n' + output)
self.assertNotEqual(len(json_data), 0, msg='Output was empty')
def _run_test(self, args, should_succeed=True, run_third_party=False):
"""
Use subprocess to better simulate the real scenario and avoid
logging conflicts when running multiple tests (since logging depends on singletons,
we might get errors or false positives between sequential tests runs)
When arg `run_third_party` is `True`, we do not run the `TEST_FILE` as
main module but the `TEST_FILE_3RD_PARTY` and return contents of
`stderr` instead of `stdout`.
TODO: use tests.utils.call_and_capture
"""
all_args = [PYTHON_EXECUTABLE, ]
if run_third_party:
all_args.append(TEST_FILE_3RD_PARTY)
else:
all_args.append(TEST_FILE)
all_args.extend(args)
env = os.environ.copy()
env['PYTHONPATH'] = PROJECT_ROOT
child = subprocess.Popen(
all_args,
shell=False,
env=env,
universal_newlines=True,
cwd=PROJECT_ROOT,
stdin=None,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE
)
(output, output_err) = child.communicate()
if False: # DEBUG
print()
for line in output_err.splitlines():
print('ERR: {}'.format(line.rstrip()))
for line in output.splitlines():
print('OUT: {}'.format(line.rstrip()))
if run_third_party:
output = output_err
if not isinstance(output, str):
output = output.decode('utf-8')
self.assertEqual(child.returncode == 0, should_succeed)
return output.strip()
# just in case somebody calls this file as a script
if __name__ == '__main__':
unittest.main()