我正在使用一个简单的基于单元测试的测试运行器来测试我的Django应用程序。
我的应用程序本身被配置为在settings.py中使用一个基本的日志记录器:
logging.basicConfig(level=logging.DEBUG)
并在我的应用程序代码使用:
logger = logging.getLogger(__name__)
logger.setLevel(getattr(settings, 'LOG_LEVEL', logging.DEBUG))
但是，在运行单元测试时，我想禁用日志记录，这样它就不会使测试结果输出混乱。有没有一种简单的方法以全局方式关闭日志记录，这样当我运行测试时，特定于应用程序的日志记录器就不会把东西写到控制台了?
当前回答
我的一些测试包含关于日志输出的断言，因此更改日志级别会破坏它们。相反，我改变了Django LOGGING设置，在运行测试时使用NullHandler:
if 'test' in sys.argv:
_LOG_HANDLERS = ['null']
else:
_LOG_HANDLERS = ['console']
LOGGING = {
'version': 1,
'disable_existing_loggers': False,
'formatters': {
'simple': {
'format': '%(levelname)s %(message)s'
},
},
'handlers': {
'null': {
'level': 'DEBUG',
'class': 'logging.NullHandler',
},
'console': {
'level': 'DEBUG',
'class': 'logging.StreamHandler',
'formatter': 'simple',
},
},
'loggers': {
'django': {
'handlers': _LOG_HANDLERS,
'propagate': True,
'level': 'INFO',
},
}
}
其他回答
我发现，对于在unittest或类似框架中的测试，在单元测试中安全禁用不必要的日志记录的最有效方法是在特定测试用例的setUp/tearDown方法中启用/禁用。这样就可以明确地锁定应该禁用日志的位置。您也可以在测试类的记录器上显式地执行此操作。
import unittest
import logging
class TestMyUnitTest(unittest.TestCase):
def setUp(self):
logging.disable(logging.CRITICAL)
def tearDown(self):
logging.disable(logging.NOTSET)
禁用整个模块的日志记录:
import logging
def setUpModule():
"""Disable logging while doing these tests."""
logging.disable()
def tearDownModule():
"""Re-enable logging after doing these tests."""
logging.disable(logging.NOTSET)
class TestFoo(unittest.TestCase):
def test_foo(self):
pass
使用unittest.mock.patch方法有一些漂亮而干净的方法来暂停测试中的登录。
foo.py:
import logging
logger = logging.getLogger(__name__)
def bar():
logger.error('There is some error output here!')
return True
tests.py:
from unittest import mock, TestCase
from foo import bar
class FooBarTestCase(TestCase):
@mock.patch('foo.logger', mock.Mock())
def test_bar(self):
self.assertTrue(bar())
而python3 -m unittest测试将不会产生日志输出。
我们使用structlog，禁用它有点复杂:
from structlog import DropEvent
def disable_logging_in_tests(_, __, event_dict):
if len(sys.argv) > 1 and sys.argv[1] == 'test':
raise DropEvent
return event_dict
structlog.configure(
processors=[
...
disable_logging_in_tests,
]
...
)
如果你正在使用pytest:
由于pytest捕获日志消息，并且仅在失败的测试中显示它们，因此通常不希望禁用任何日志记录。相反，使用一个单独的settings.py文件进行测试(例如test_settings.py)，并添加到它:
LOGGING_CONFIG = None
这告诉Django完全跳过日志配置。LOGGING设置将被忽略，并可以从设置中删除。
使用这种方法，您不会获得通过测试的任何日志记录，而会获得失败测试的所有可用日志记录。
测试将使用pytest设置的日志运行。它可以在pytest设置中根据您的喜好进行配置(例如，tox.ini)。要包含调试级别的日志消息，请使用log_level = debug(或相应的命令行参数)。
