test_log_helper.py
5.57 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
""" 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
"""
from __future__ import print_function
import unittest
import sys
import json
import re
from tests.util.log_helper import log_helper_test_main
from tests.util.log_helper import log_helper_test_imported
from os.path import dirname, join, relpath, abspath
from subprocess import check_output, STDOUT, CalledProcessError
# this is the common base of "tests" and "oletools" dirs
ROOT_DIRECTORY = dirname(dirname(dirname(dirname(abspath(__file__)))))
TEST_FILE = relpath(join(dirname(__file__), 'log_helper_test_main.py'), ROOT_DIRECTORY)
PYTHON_EXECUTABLE = sys.executable
REGEX = re.compile('<#(.*)(:?#>|Traceback)', re.MULTILINE | re.DOTALL)
MAIN_LOG_MESSAGES = [
log_helper_test_main.DEBUG_MESSAGE,
log_helper_test_main.INFO_MESSAGE,
log_helper_test_main.WARNING_MESSAGE,
log_helper_test_main.ERROR_MESSAGE,
log_helper_test_main.CRITICAL_MESSAGE
]
class TestLogHelper(unittest.TestCase):
def test_default_logging_to_stderr(self):
"""
Basic test for simple logging
"""
output = self._run_test(['default'])
self.assertIn(log_helper_test_main.WARNING_MESSAGE, output)
def test_logging_silently(self):
"""
Test that nothing will be logged when logging is not enabled
and we are using a silent logger (uses the NullHandler)
"""
output = self._run_test(['silent'])
self.assertTrue(len(output) == 0)
def test_setting_level_in_main_module(self):
"""
Make sure that the level set in the main module is kept when
logging from imported modules.
"""
output = self._run_test(['debug'])
expected_messages = MAIN_LOG_MESSAGES + [
log_helper_test_imported.DEBUG_MESSAGE,
log_helper_test_imported.INFO_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_logging_at_current_level(self):
"""
Test that logging at current level will always print a message
"""
output = self._run_test(['current_level'])
self.assertIn(log_helper_test_main.DEBUG_MESSAGE, output)
def test_logging_as_json(self):
"""
Basic test for json logging
"""
output = self._run_test(['critical', '-j'])
try:
json_data = json.loads(output)
self._assert_json_messages(json_data, [
log_helper_test_main.CRITICAL_MESSAGE,
log_helper_test_imported.CRITICAL_MESSAGE
])
except ValueError:
self.fail('Invalid json:\n' + output)
self.assertNotEqual(len(json_data), 0, msg='Output was empty')
def test_logging_dictionary_as_json(self):
"""
Test support for passing a dictionary to the logger
and have it logged as JSON
"""
output = self._run_test(['dictionary'])
try:
json_data = json.loads(output)
self._assert_json_messages(json_data, [
log_helper_test_main.DEBUG_MESSAGE
])
except ValueError:
self.fail('Invalid json:\n' + output)
self.assertNotEqual(len(json_data), 0, msg='Output was empty')
def test_json_correct_on_exceptions(self):
"""
Test that even on unhandled exceptions our JSON is always correct
"""
output = self._run_test(['critical', 'throw', '-j'], True)
try:
json_data = json.loads(output)
self._assert_json_messages(json_data, [
log_helper_test_main.CRITICAL_MESSAGE,
log_helper_test_imported.CRITICAL_MESSAGE
])
except ValueError:
self.fail('Invalid json:\n' + output)
self.assertNotEqual(len(json_data), 0, msg='Output was empty')
def _assert_json_messages(self, json_data, messages):
self.assertEquals(len(json_data), len(messages))
for i in range(len(messages)):
self.assertEquals(messages[i], json_data[i]['msg'])
@staticmethod
def _run_test(args, ignore_exceptions=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)
"""
try:
output = check_output(
[PYTHON_EXECUTABLE, TEST_FILE] + args,
shell=False,
cwd=ROOT_DIRECTORY,
stderr=STDOUT,
universal_newlines=True
)
if not isinstance(output, str):
output = output.decode('utf-8')
except CalledProcessError as ex:
if ignore_exceptions:
output = ex.output
else:
# we want tests to fail if an exception occur
print('Caught unexpected error. Print output and re-raise')
for line in ex.output.splitlines():
print('error output: {}'.format(line.rstrip()))
print('(If you have errors about imports, try unsetting PYTHONPATH)')
raise ex
return REGEX.search(output).group(1).strip()
# just in case somebody calls this file as a script
if __name__ == '__main__':
unittest.main()