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 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
|
#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""
test_logzero
----------------------------------
Tests for `logzero` module.
"""
import os
import tempfile
import logging
import logzero
import locale
def test_write_to_logfile_and_stderr(capsys):
"""
When using `logfile=`, should by default log to a file and stderr.
"""
logzero.reset_default_logger()
temp = tempfile.NamedTemporaryFile()
try:
logger = logzero.setup_logger('test_write_to_logfile_and_stderr', logfile=temp.name)
logger.info("test log output")
_out, err = capsys.readouterr()
assert " test_logzero:" in err
assert err.endswith("test log output\n")
with open(temp.name) as f:
content = f.read()
assert " test_logzero:" in content
assert content.endswith("test log output\n")
finally:
temp.close()
def test_custom_formatter():
"""
Should work with a custom formatter.
"""
logzero.reset_default_logger()
temp = tempfile.NamedTemporaryFile()
try:
log_format = '%(color)s[%(levelname)1.1s %(asctime)s customnametest:%(lineno)d]%(end_color)s %(message)s'
formatter = logzero.LogFormatter(fmt=log_format)
logger = logzero.setup_logger(logfile=temp.name, formatter=formatter)
logger.info("test log output")
with open(temp.name) as f:
content = f.read()
assert " customnametest:" in content
assert content.endswith("test log output\n")
finally:
temp.close()
def test_loglevel():
"""
Should not log any debug messages if minimum level is set to INFO
"""
logzero.reset_default_logger()
temp = tempfile.NamedTemporaryFile()
try:
logger = logzero.setup_logger(logfile=temp.name, level=logging.INFO)
logger.debug("test log output")
with open(temp.name) as f:
content = f.read()
assert len(content.strip()) == 0
finally:
temp.close()
def test_bytes():
"""
Should properly log bytes
"""
logzero.reset_default_logger()
temp = tempfile.NamedTemporaryFile()
try:
logger = logzero.setup_logger(logfile=temp.name)
testbytes = os.urandom(20)
logger.debug(testbytes)
logger.debug(None)
# with open(temp.name) as f:
# content = f.read()
# # assert str(testbytes) in content
finally:
temp.close()
def test_unicode():
"""
Should log unicode
"""
logzero.reset_default_logger()
temp = tempfile.NamedTemporaryFile()
try:
logger = logzero.setup_logger(logfile=temp.name)
logger.debug("😄 😁 😆 😅 😂")
with open(temp.name, "rb") as f:
content = f.read()
if (locale.getdefaultlocale()[1]=='UTF-8'):
assert "\\xf0\\x9f\\x98\\x84 \\xf0\\x9f\\x98\\x81 \\xf0\\x9f\\x98\\x86 \\xf0\\x9f\\x98\\x85 \\xf0\\x9f\\x98\\x82\\n" in repr(content)
finally:
temp.close()
def test_multiple_loggers_one_logfile():
"""
Should properly log bytes
"""
logzero.reset_default_logger()
temp = tempfile.NamedTemporaryFile()
try:
logger1 = logzero.setup_logger(name="logger1", logfile=temp.name)
logger2 = logzero.setup_logger(name="logger2", logfile=temp.name)
logger3 = logzero.setup_logger(name="logger3", logfile=temp.name)
logger1.info("logger1")
logger2.info("logger2")
logger3.info("logger3")
with open(temp.name) as f:
content = f.read().strip()
assert "logger1" in content
assert "logger2" in content
assert "logger3" in content
assert len(content.split("\n")) == 3
finally:
temp.close()
def test_default_logger(disableStdErrorLogger=False):
"""
Default logger should work and be able to be reconfigured.
"""
logzero.reset_default_logger()
temp = tempfile.NamedTemporaryFile()
try:
logzero.setup_default_logger(logfile=temp.name, disableStderrLogger=disableStdErrorLogger)
logzero.logger.debug("debug1") # will be logged
# Reconfigure with loglevel INFO
logzero.setup_default_logger(logfile=temp.name, level=logging.INFO, disableStderrLogger=disableStdErrorLogger)
logzero.logger.debug("debug2") # will not be logged
logzero.logger.info("info1") # will be logged
# Reconfigure with a different formatter
log_format = '%(color)s[xxx]%(end_color)s %(message)s'
formatter = logzero.LogFormatter(fmt=log_format)
logzero.setup_default_logger(logfile=temp.name, level=logging.INFO, formatter=formatter, disableStderrLogger=disableStdErrorLogger)
logzero.logger.info("info2") # will be logged with new formatter
logzero.logger.debug("debug3") # will not be logged
with open(temp.name) as f:
content = f.read()
_test_default_logger_output(content)
finally:
temp.close()
def _test_default_logger_output(content):
assert "] debug1" in content
assert "] debug2" not in content
assert "] info1" in content
assert "xxx] info2" in content
assert "] debug3" not in content
def test_setup_logger_reconfiguration():
"""
Should be able to reconfigure without loosing custom handlers
"""
logzero.reset_default_logger()
temp = tempfile.NamedTemporaryFile()
temp2 = tempfile.NamedTemporaryFile()
try:
logzero.setup_default_logger(logfile=temp.name)
# Add a custom file handler
filehandler = logging.FileHandler(temp2.name)
filehandler.setLevel(logging.DEBUG)
filehandler.setFormatter(logzero.LogFormatter(color=False))
logzero.logger.addHandler(filehandler)
# First debug message goes to both files
logzero.logger.debug("debug1")
# Reconfigure logger to remove logfile
logzero.setup_default_logger()
logzero.logger.debug("debug2")
# Reconfigure logger to add logfile
logzero.setup_default_logger(logfile=temp.name)
logzero.logger.debug("debug3")
# Reconfigure logger to set minimum loglevel to INFO
logzero.setup_default_logger(logfile=temp.name, level=logging.INFO)
logzero.logger.debug("debug4")
logzero.logger.info("info1")
# Reconfigure logger to set minimum loglevel back to DEBUG
logzero.setup_default_logger(logfile=temp.name, level=logging.DEBUG)
logzero.logger.debug("debug5")
with open(temp.name) as f:
content = f.read()
assert "] debug1" in content
assert "] debug2" not in content
assert "] debug3" in content
assert "] debug4" not in content
assert "] info1" in content
assert "] debug5" in content
with open(temp2.name) as f:
content = f.read()
assert "] debug1" in content
assert "] debug2" in content
assert "] debug3" in content
assert "] debug4" not in content
assert "] info1" in content
assert "] debug5" in content
finally:
temp.close()
def test_setup_logger_logfile_custom_loglevel(capsys):
"""
setup_logger(..) with filelogger and custom loglevel
"""
logzero.reset_default_logger()
temp = tempfile.NamedTemporaryFile()
try:
logger = logzero.setup_logger(logfile=temp.name, fileLoglevel=logging.WARN)
logger.info("info1")
logger.warning("warn1")
with open(temp.name) as f:
content = f.read()
assert "] info1" not in content
assert "] warn1" in content
finally:
temp.close()
def test_log_function_call():
@logzero.log_function_call
def example():
"""example doc"""
pass
assert example.__name__ == "example"
assert example.__doc__ == "example doc"
def test_default_logger_logfile_only(capsys):
"""
Run the ``test_default_logger`` with ``disableStdErrorLogger`` set to ``True`` and
confirm that no data is written to stderr
"""
test_default_logger(disableStdErrorLogger=True)
out, err = capsys.readouterr()
assert err == ''
def test_default_logger_stderr_output(capsys):
"""
Run the ``test_default_logger`` and confirm that the proper data is written to stderr
"""
test_default_logger()
out, err = capsys.readouterr()
_test_default_logger_output(err)
def test_default_logger_syslog_only(capsys):
"""
Run a test logging to ``syslog`` and confirm that no data is written to stderr.
Note that the output in syslog is not currently being captured or checked.
"""
logzero.reset_default_logger()
logzero.syslog()
logzero.logger.error('debug')
out, err = capsys.readouterr()
assert out == '' and err == ''
def test_logfile_lower_loglevel(capsys):
"""
logzero.logfile(..) should work with a lower loglevel than the StreamHandler
"""
logzero.reset_default_logger()
temp = tempfile.NamedTemporaryFile()
try:
logzero.loglevel(level=logging.INFO)
logzero.logfile(temp.name, loglevel=logging.DEBUG)
logzero.logger.debug("debug")
logzero.logger.info("info")
with open(temp.name) as f:
content = f.read()
assert "] debug" in content
assert "] info" in content
finally:
temp.close()
def test_logfile_lower_loglevel_setup_logger(capsys):
"""
logzero.setup_logger(..) should work with a lower loglevel than the StreamHandler
"""
temp = tempfile.NamedTemporaryFile()
try:
logger = logzero.setup_logger(level=logging.INFO, logfile=temp.name, fileLoglevel=logging.DEBUG)
logger.debug("debug")
logger.info("info")
with open(temp.name) as f:
content = f.read()
assert "] debug" in content
assert "] info" in content
finally:
temp.close()
def test_root_logger(capsys):
"""
Test creating a root logger
"""
logzero.reset_default_logger()
logger1 = logzero.setup_logger()
assert logger1.name == 'logzero'
logger2 = logzero.setup_logger(isRootLogger=True)
assert logger2.name == 'root'
logger3 = logzero.setup_logger(name='')
assert logger3.name == 'root'
|