Rewrite the whole thing as a Formatter
Having a complete `Logger` class for this purpose is a bit of an overkill.
This commit is contained in:
@@ -1,9 +1,9 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
"""
|
||||
Unit tests for Flask-Logging-Extras
|
||||
"""Unit tests for Flask-Logging-Extras
|
||||
"""
|
||||
|
||||
import logging
|
||||
from logging.config import dictConfig
|
||||
import sys
|
||||
from unittest import TestCase
|
||||
|
||||
@@ -11,203 +11,124 @@ from flask import Flask, Blueprint, current_app
|
||||
|
||||
import flask_logging_extras
|
||||
|
||||
class ListStream(object):
|
||||
"""
|
||||
Primitive stream that stores its input lines in a list
|
||||
"""
|
||||
|
||||
class ListHandler(logging.StreamHandler):
|
||||
def __init__(self, *args, **kwargs):
|
||||
self.lines = []
|
||||
super(ListHandler, self).__init__(*args, **kwargs)
|
||||
|
||||
super(ListStream, self).__init__(*args, **kwargs)
|
||||
self.logs = []
|
||||
|
||||
def write(self, data):
|
||||
if len(self.lines) == 0 or self.lines[-1].endswith('\n'):
|
||||
self.lines.append(data)
|
||||
else:
|
||||
self.lines[-1] += data
|
||||
def emit(self, record):
|
||||
try:
|
||||
msg = self.format(record)
|
||||
except (KeyError, IndexError) as exc:
|
||||
msg = (exc.__class__.__name__, str(exc))
|
||||
|
||||
self.logs.append(msg)
|
||||
|
||||
|
||||
class TestingStreamHandler(logging.StreamHandler):
|
||||
def handleError(self, record):
|
||||
exc, exc_msg, trace = sys.exc_info()
|
||||
def configure_loggers(extra_var):
|
||||
dictConfig({
|
||||
'version': 1,
|
||||
'disable_existing_loggers': True,
|
||||
'formatters': {
|
||||
'selftest': {
|
||||
'class': 'flask_logging_extras.FlaskExtraLoggerFormatter',
|
||||
'format': '%(message)s %({extra_var})s'.format(extra_var=extra_var),
|
||||
},
|
||||
},
|
||||
'handlers': {
|
||||
'selftest': {
|
||||
'class': 'test_logger_keywords.ListHandler',
|
||||
'formatter': 'selftest',
|
||||
},
|
||||
},
|
||||
'loggers': {
|
||||
'selftest': {
|
||||
'handlers': ['selftest'],
|
||||
'level': 'INFO',
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
super(logging.StreamHandler, self).handleError(record)
|
||||
formatter = flask_logging_extras.FlaskExtraLoggerFormatter(
|
||||
fmt='%(message)s %({extra_var})s'.format(extra_var=extra_var))
|
||||
|
||||
raise(exc(exc_msg))
|
||||
logger = logging.getLogger('selftest')
|
||||
handlers = [handler for handler in logger.handlers if isinstance(handler, ListHandler)]
|
||||
handler = handlers[0]
|
||||
# TODO: Why doesn’t this happen automatically in Python 2.7?
|
||||
handler.setFormatter(formatter)
|
||||
|
||||
return logger, handler
|
||||
|
||||
|
||||
class LoggerKeywordsTestCase(TestCase):
|
||||
def setUp(self):
|
||||
self.original_logger_class = logging.getLoggerClass()
|
||||
self.logger, self.handler = configure_loggers('extra_keyword')
|
||||
self.app = Flask('test_app')
|
||||
self.app.config['FLASK_LOGGING_EXTRAS_KEYWORDS'] = {
|
||||
'extra_keyword': 'placeholder',
|
||||
}
|
||||
|
||||
def tearDown(self):
|
||||
logging.setLoggerClass(self.original_logger_class)
|
||||
# Make sure we don’t try to log the current blueprint for this test case
|
||||
self.app.config['FLASK_LOGGING_EXTRAS_BLUEPRINT'] = (None, '', '')
|
||||
|
||||
def test_logger_registration(self):
|
||||
class NotLoggerClass(object):
|
||||
pass
|
||||
def test_keywords_no_app_ctx(self):
|
||||
"""With the current formatter, the last log line must be a just the message
|
||||
"""
|
||||
|
||||
with self.assertRaises(TypeError):
|
||||
flask_logging_extras.register_logger_class(cls=NotLoggerClass)
|
||||
self.logger.info('message')
|
||||
self.assertIn(('KeyError', "'extra_keyword'"), self.handler.logs)
|
||||
|
||||
original_logging_class = logging.getLoggerClass()
|
||||
|
||||
old_class = flask_logging_extras.register_logger_class()
|
||||
|
||||
# If no class is specified, FlaskExtraLogger should be registered
|
||||
self.assertEqual(logging.getLoggerClass(),
|
||||
flask_logging_extras.FlaskExtraLogger)
|
||||
# The return value of this function should be the old default
|
||||
self.assertEqual(original_logging_class, old_class)
|
||||
|
||||
class MyLogger(logging.Logger):
|
||||
pass
|
||||
|
||||
# Calling register_logger_class() with any subclass of
|
||||
# logging.Logger should succeed
|
||||
flask_logging_extras.register_logger_class(cls=MyLogger)
|
||||
|
||||
def test_logger_class(self):
|
||||
# If app is present during __init__, and is not None, we should get
|
||||
# a TypeError
|
||||
with self.assertRaises(TypeError):
|
||||
flask_logging_extras.FlaskExtraLogger('test_logger',
|
||||
app='test value')
|
||||
|
||||
# If app is present, but is None, no exception should be raised
|
||||
flask_logging_extras.FlaskExtraLogger('test_logger', app=None)
|
||||
|
||||
def test_logger_class_init_app(self):
|
||||
logger = flask_logging_extras.FlaskExtraLogger('test')
|
||||
app = Flask('test_app')
|
||||
|
||||
logger.init_app(app)
|
||||
|
||||
self.assertEqual({}, logger._valid_keywords)
|
||||
|
||||
app.config['FLASK_LOGGING_EXTRAS_KEYWORDS'] = {'exc_info': None}
|
||||
|
||||
with self.assertRaises(ValueError):
|
||||
logger.init_app(app)
|
||||
|
||||
app.config['FLASK_LOGGING_EXTRAS_KEYWORDS'] = {'my_keyword': '<unset>'}
|
||||
|
||||
logger.init_app(app)
|
||||
self.assertEqual({'my_keyword': '<unset>'}, logger._valid_keywords)
|
||||
|
||||
# Without registration first, app.logger should not be of class
|
||||
# FlaskExtraLogger (even though logger.init_app() succeeded without
|
||||
# it.)
|
||||
self.assertNotIsInstance(app.logger,
|
||||
flask_logging_extras.FlaskExtraLogger)
|
||||
|
||||
flask_logging_extras.register_logger_class()
|
||||
|
||||
# Even after registratiiion, existing apps are (obviously) not
|
||||
# tampered with
|
||||
|
||||
self.assertNotIsInstance(app.logger,
|
||||
flask_logging_extras.FlaskExtraLogger)
|
||||
|
||||
app = Flask('test_app')
|
||||
|
||||
# Newly created apps, though, should be made with this class
|
||||
self.assertIsInstance(app.logger,
|
||||
flask_logging_extras.FlaskExtraLogger)
|
||||
|
||||
def _create_app_with_logger(self, fmt, keywords=[]):
|
||||
app = Flask('test_app')
|
||||
|
||||
self.assertIsInstance(app.logger,
|
||||
flask_logging_extras.FlaskExtraLogger)
|
||||
|
||||
app.config['FLASK_LOGGING_EXTRAS_KEYWORDS'] = keywords
|
||||
app.logger.init_app(app)
|
||||
|
||||
formatter = logging.Formatter(fmt)
|
||||
stream = ListStream()
|
||||
|
||||
handler = TestingStreamHandler(stream=stream)
|
||||
handler.setLevel(logging.DEBUG)
|
||||
handler.setFormatter(formatter)
|
||||
|
||||
app.logger.addHandler(handler)
|
||||
app.logger.setLevel(logging.DEBUG)
|
||||
|
||||
return app, stream
|
||||
|
||||
def test_keywords(self):
|
||||
# Register our logger class as the default
|
||||
old_logger_class = flask_logging_extras.register_logger_class()
|
||||
|
||||
app, log_stream = self._create_app_with_logger('%(message)s')
|
||||
|
||||
app.logger.info('message')
|
||||
# With the current formatter, the last log line must be a just the
|
||||
# message
|
||||
self.assertEqual(log_stream.lines[-1], 'message\n')
|
||||
|
||||
app, log_stream = self._create_app_with_logger(
|
||||
'%(message)s %(extra_keyword)s')
|
||||
|
||||
# If we don’t register 'extra_keyword' in the app config, we get a
|
||||
def test_keywords_app_ctx_assign_value(self):
|
||||
"""If we don’t register 'extra_keyword' in the app config, we get a
|
||||
# KeyError. We set logging.raiseExceptions to False here; the
|
||||
# reason is that this doesn’t mean an actual exception is raised,
|
||||
# but our TestingStreamHandler does that for us (which we need for
|
||||
# testing purposes)
|
||||
old_raiseExceptions = logging.raiseExceptions
|
||||
logging.raiseExceptions = False
|
||||
with self.assertRaises(KeyError):
|
||||
app.logger.info('message')
|
||||
logging.raiseExceptions = old_raiseExceptions
|
||||
"""
|
||||
|
||||
app, log_stream = self._create_app_with_logger(
|
||||
'%(message)s [%(extra_keyword)s]',
|
||||
keywords={'extra_keyword': '<unset>'})
|
||||
with self.app.app_context():
|
||||
self.logger.info('message', extra=dict(extra_keyword='test'))
|
||||
|
||||
app.logger.info('message', extra_keyword='test')
|
||||
self.assertEqual('message [test]\n', log_stream.lines[-1])
|
||||
self.assertIn('message test', self.handler.logs)
|
||||
|
||||
# If we don’t provide a value for a registered extra keyword, the
|
||||
def test_keywords_app_ctx_no_value(self):
|
||||
"""If we don’t provide a value for a registered extra keyword, the
|
||||
# string "<unset>" will be assigned.
|
||||
app.logger.info('message')
|
||||
self.assertEqual('message [<unset>]\n', log_stream.lines[-1])
|
||||
"""
|
||||
|
||||
with self.app.app_context():
|
||||
self.logger.info('message')
|
||||
|
||||
self.assertIn('message placeholder', self.handler.logs)
|
||||
|
||||
|
||||
class LoggerBlueprintTestCase(TestCase):
|
||||
def setUp(self):
|
||||
# Register our logger class
|
||||
self.original_logger_class = logging.getLoggerClass()
|
||||
flask_logging_extras.register_logger_class()
|
||||
|
||||
app = Flask('test_app')
|
||||
self.app = app
|
||||
app.config['FLASK_LOGGING_EXTRAS_BLUEPRINT'] = (
|
||||
'bp', '<app>', '<norequest>')
|
||||
app.logger.init_app(app)
|
||||
app.config['FLASK_LOGGING_EXTRAS_BLUEPRINT'] = ('bp', '<app>', '<norequest>')
|
||||
|
||||
fmt = '%(bp)s %(message)s'
|
||||
self.stream = ListStream()
|
||||
configure_loggers('bp')
|
||||
self.logger = logging.getLogger('selftest')
|
||||
handlers = [handler for handler in self.logger.handlers if isinstance(handler, ListHandler)]
|
||||
self.handler = handlers[0]
|
||||
|
||||
formatter = logging.Formatter(fmt)
|
||||
self.handler = TestingStreamHandler(stream=self.stream)
|
||||
self.handler.setLevel(logging.DEBUG)
|
||||
self.handler.setFormatter(formatter)
|
||||
app.logger.addHandler(self.handler)
|
||||
app.logger.setLevel(logging.DEBUG)
|
||||
|
||||
bp = Blueprint('test_blueprint', 'test_bpg13')
|
||||
bp = Blueprint('test_blueprint', 'test_bp')
|
||||
|
||||
@app.route('/app')
|
||||
def route_1():
|
||||
current_app.logger.info('Message')
|
||||
self.logger.info('Message')
|
||||
|
||||
return ''
|
||||
|
||||
@bp.route('/blueprint')
|
||||
def route_2():
|
||||
current_app.logger.info('Message')
|
||||
self.logger.info('Message')
|
||||
|
||||
return ''
|
||||
|
||||
@@ -215,26 +136,16 @@ class LoggerBlueprintTestCase(TestCase):
|
||||
|
||||
self.client = app.test_client()
|
||||
|
||||
def tearDown(self):
|
||||
logging.setLoggerClass(self.original_logger_class)
|
||||
|
||||
def test_autoconfig(self):
|
||||
logger = logging.getLogger('test')
|
||||
logger.addHandler(self.handler)
|
||||
|
||||
with self.app.app_context():
|
||||
logger.warning('Hello')
|
||||
|
||||
self.assertEqual('<norequest> Hello\n', self.stream.lines[-1])
|
||||
|
||||
def test_request_log(self):
|
||||
def test_blueprint_log_no_blueprint(self):
|
||||
self.client.get('/app')
|
||||
self.assertEqual('<app> Message\n', self.stream.lines[-1])
|
||||
self.assertIn('Message <app>', self.handler.logs)
|
||||
|
||||
page = self.client.get('/blueprint')
|
||||
self.assertEqual('test_blueprint Message\n', self.stream.lines[-1])
|
||||
def test_blueprint_log_blueprint(self):
|
||||
self.client.get('/blueprint')
|
||||
self.assertIn('Message test_blueprint', self.handler.logs)
|
||||
|
||||
def test_blueprint_log_no_request(self):
|
||||
with self.app.app_context():
|
||||
current_app.logger.info('Message')
|
||||
self.logger.info('Message')
|
||||
|
||||
self.assertEqual('<norequest> Message\n', self.stream.lines[-1])
|
||||
self.assertIn('Message <norequest>', self.handler.logs)
|
||||
|
||||
Reference in New Issue
Block a user