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
|
# fixtures: Fixtures with cleanups for testing and convenience.
#
# Copyright (c) 2011, Robert Collins <robertc@robertcollins.net>
#
# Licensed under either the Apache License, Version 2.0 or the BSD 3-clause
# license at the users choice. A copy of both licenses are available in the
# project source as Apache-2.0 and BSD. You may not use this file except in
# compliance with one of these two licences.
#
# Unless required by applicable law or agreed to in writing, software
# distributed under these licenses is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# license you chose for the specific language governing permissions and
# limitations under that license.
import io
import logging
import time
import testtools
from testtools import TestCase
from fixtures import (
FakeLogger,
LogHandler,
TestWithFixtures,
)
# A simple custom formatter that prepends Foo to all log messages, for
# testing formatter overrides.
class FooFormatter(logging.Formatter):
def format(self, record):
self._style = logging.PercentStyle("Foo " + self._style._fmt)
self._fmt = self._style._fmt
return logging.Formatter.format(self, record)
class FakeLoggerTest(TestCase, TestWithFixtures):
def setUp(self):
super(FakeLoggerTest, self).setUp()
self.logger = logging.getLogger()
self.addCleanup(self.removeHandlers, self.logger)
def removeHandlers(self, logger):
for handler in logger.handlers:
logger.removeHandler(handler)
def test_output_property_has_output(self):
fixture = self.useFixture(FakeLogger())
logging.info("some message")
self.assertEqual("some message\n", fixture.output)
def test_replace_and_restore_handlers(self):
stream = io.StringIO()
logger = logging.getLogger()
logger.addHandler(logging.StreamHandler(stream))
logger.setLevel(logging.INFO)
logging.info("one")
fixture = FakeLogger()
with fixture:
logging.info("two")
logging.info("three")
self.assertEqual("two\n", fixture.output)
self.assertEqual("one\nthree\n", stream.getvalue())
def test_preserving_existing_handlers(self):
stream = io.StringIO()
self.logger.addHandler(logging.StreamHandler(stream))
self.logger.setLevel(logging.INFO)
fixture = FakeLogger(nuke_handlers=False)
with fixture:
logging.info("message")
self.assertEqual("message\n", fixture.output)
self.assertEqual("message\n", stream.getvalue())
def test_logging_level_restored(self):
self.logger.setLevel(logging.DEBUG)
fixture = FakeLogger(level=logging.WARNING)
with fixture:
# The fixture won't capture this, because the DEBUG level
# is lower than the WARNING one
logging.debug("debug message")
self.assertEqual(logging.WARNING, self.logger.level)
self.assertEqual("", fixture.output)
self.assertEqual(logging.DEBUG, self.logger.level)
def test_custom_format(self):
fixture = FakeLogger(format="%(module)s")
self.useFixture(fixture)
logging.info("message")
self.assertEqual("test_logger\n", fixture.output)
def test_custom_datefmt(self):
fixture = FakeLogger(format="%(asctime)s %(module)s", datefmt="%Y")
self.useFixture(fixture)
logging.info("message")
self.assertEqual(
time.strftime("%Y test_logger\n", time.localtime()), fixture.output
)
def test_custom_formatter(self):
fixture = FakeLogger(
format="%(asctime)s %(module)s",
formatter=FooFormatter,
datefmt="%Y",
)
self.useFixture(fixture)
logging.info("message")
self.assertEqual(
time.strftime("Foo %Y test_logger\n", time.localtime()),
fixture.output,
)
def test_logging_output_included_in_details(self):
fixture = FakeLogger()
detail_name = "pythonlogging:''"
with fixture:
content = fixture.getDetails()[detail_name]
# Output after getDetails is called is included.
logging.info('some message')
self.assertEqual("some message\n", content.as_text())
# The old content object returns the old usage after cleanUp (not
# strictly needed but convenient). Note that no guarantee is made that
# it will work after setUp is called again. [It does on Python 2.x, not
# on 3.x]
self.assertEqual("some message\n", content.as_text())
with fixture:
# A new one returns new output:
self.assertEqual("", fixture.getDetails()[detail_name].as_text())
# The original content object may either fail, or return the old
# content (it must not have been reset..).
try:
self.assertEqual("some message\n", content.as_text())
except AssertionError:
raise
except BaseException:
pass
def test_exceptionraised(self):
with FakeLogger():
with testtools.ExpectedException(TypeError):
logging.info("Some message", "wrongarg")
def test_output_can_be_reset(self):
fixture = FakeLogger()
with fixture:
logging.info("message")
fixture.reset_output()
self.assertEqual("", fixture.output)
class LogHandlerTest(TestCase, TestWithFixtures):
class CustomHandler(logging.Handler):
def __init__(self, *args, **kwargs):
"""Create the instance, and add a records attribute."""
logging.Handler.__init__(self, *args, **kwargs)
self.msgs = []
def emit(self, record):
self.msgs.append(record.msg)
def setUp(self):
super(LogHandlerTest, self).setUp()
self.logger = logging.getLogger()
self.addCleanup(self.removeHandlers, self.logger)
def removeHandlers(self, logger):
for handler in logger.handlers:
logger.removeHandler(handler)
def test_captures_logging(self):
fixture = self.useFixture(LogHandler(self.CustomHandler()))
logging.info("some message")
self.assertEqual(["some message"], fixture.handler.msgs)
def test_replace_and_restore_handlers(self):
stream = io.StringIO()
logger = logging.getLogger()
logger.addHandler(logging.StreamHandler(stream))
logger.setLevel(logging.INFO)
logging.info("one")
fixture = LogHandler(self.CustomHandler())
with fixture:
logging.info("two")
logging.info("three")
self.assertEqual(["two"], fixture.handler.msgs)
self.assertEqual("one\nthree\n", stream.getvalue())
def test_preserving_existing_handlers(self):
stream = io.StringIO()
self.logger.addHandler(logging.StreamHandler(stream))
self.logger.setLevel(logging.INFO)
fixture = LogHandler(self.CustomHandler(), nuke_handlers=False)
with fixture:
logging.info("message")
self.assertEqual(["message"], fixture.handler.msgs)
self.assertEqual("message\n", stream.getvalue())
def test_logging_level_restored(self):
self.logger.setLevel(logging.DEBUG)
fixture = LogHandler(self.CustomHandler(), level=logging.WARNING)
with fixture:
# The fixture won't capture this, because the DEBUG level
# is lower than the WARNING one
logging.debug("debug message")
self.assertEqual(logging.WARNING, self.logger.level)
self.assertEqual([], fixture.handler.msgs)
self.assertEqual(logging.DEBUG, self.logger.level)
|
