将py.test的日志消息、测试结果/断言记录到单个文件中。
将py.test的日志消息、测试结果/断言记录到单个文件中。
我目前正在使用py.test来进行一个新项目的工作。我们正在配置Linux服务器,并且我需要编写一个脚本来检查这些服务器的设置和配置。我认为使用py.test来实现这些测试是一个很好的方式,到目前为止它运行得很好。\n我目前面临的问题是,我需要在这些测试结束时有一个日志文件,显示每个测试的一些日志信息和测试的结果。对于日志信息,我使用logger:\n
logging.basicConfig(filename='config_check.log', level=logging.INFO) pytest.main() logging.info('all done')
\n作为一个示例测试,我有这样一个测试:\n
def test_taintedKernel(): logging.info('checking for tainted kernel') output = runcmd('cat /proc/sys/kernel/tainted') assert output == '0', 'tainted kernel found'
\n所以在我的日志文件中,我希望有这样的输出:\n
INFO:root:checking for tainted kernel ERROR:root:tainted kernel found INFO:root:next test INFO:root:successful INFO:root:all done
\n但是我无法将测试结果写入日志文件中,而是在测试之后将标准输出写入stdout:\n
======================================= test session starts ======================================= platform linux2 -- Python 2.6.8 -- py-1.4.22 -- pytest-2.6.0 collected 14 items test_basicLinux.py .............F ============================================ FAILURES ============================================= _______________________________________ test_taintedKernel ________________________________________ def test_taintedKernel(): logging.info('checking for tainted kernel') output = runcmd('cat /proc/sys/kernel/tainted') > assert output == '0', 'tainted kernel found' E AssertionError: tainted kernel found test_basicLinux.py:107: AssertionError =============================== 1 failed, 13 passed in 6.07 seconds ===============================
\n这可能会让我的脚本的用户感到困惑。我尝试研究logger和pytest_capturelog,因为它们在这里经常被提到,但我肯定是做错了什么,因为我就是无法理解它们。也许只是对它是如何工作的缺乏理解。希望你们能给我一些提示。如果有什么遗漏,请告诉我。\n提前感谢你的帮助,\nStephan
自从版本3.3起,pytest支持将日志实时记录到终端和文件中。示例测试模块如下:
import logging
import os
def test_taintedKernel():
logging.info('checking for tainted kernel')
output = os.system('cat /proc/sys/kernel/tainted')
assert output == 0, 'tainted kernel found'
可以通过pytest.ini配置将日志记录到文件中,配置内容如下:
[pytest]
log_file = my.log
log_file_level = DEBUG
log_file_format = %(asctime)s [%(levelname)8s] %(message)s (%(filename)s:%(lineno)s)
log_file_date_format=%Y-%m-%d %H:%M:%S
运行测试如下:
$ pytest
======================================================= test session starts ========================================================
...
collected 1 item
test_spam.py . [100%]
===================================================== 1 passed in 0.01 seconds =====================================================
然后检查写入的日志文件:
$ cat my.log
2019-07-12 23:51:41 [ INFO] checking for tainted kernel (test_spam.py:6)
我们也可以参考Logging within py.test tests中的例子,将日志实时记录到终端和日志文件中。
参考链接:pytest文档中的Live Logs章节。
pytest的工作是捕获输出并呈现给操作员。因此,不要试图使pytest按照您想要的方式记录日志,而是可以将日志构建到您的测试中。
Python的assert命令只接受一个真值和一条消息。因此,您可以编写一个小函数,在值为false时记录日志(这与触发assert失败的条件相同),然后调用assert,这样您就可以获得所需的日志和由assert驱动的控制台输出行为。
以下是使用这样一个函数的小测试文件:
# test_foo.py import logging def logAssert(test, msg): if not test: logging.error(msg) assert test, msg def test_foo(): logging.info("testing foo") logAssert('foo' == 'foo', "foo is not foo") def test_foobar(): logging.info("testing foobar") logAssert('foobar' == 'foo', "foobar is not foo")
以下是与您的非常相似的测试运行器:
# runtests.py import logging import pytest logging.basicConfig(filename='config_check.log', level=logging.INFO) logging.info('start') pytest.main() logging.info('done')
以下是输出:
# python runtests.py ==== test session starts ======================== platform linux2 -- Python 2.6.6 -- py-1.4.22 -- pytest-2.6.0 collected 2 items test_foo.py .F ========== FAILURES ============================ ________ test_foobar __________________________ def test_foobar(): logging.info("testing foobar") > logAssert( 'foobar' == 'foo', "foobar is not foo") test_foo.py:14: _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ test = False, msg = 'foobar is not foo' def logAssert(test,msg): if not test: logging.error(msg) > assert test,msg E AssertionError: foobar is not foo test_foo.py:6: AssertionError ==== 1 failed, 1 passed in 0.02 seconds =======
以下是写入的日志:
# cat config_check.log INFO:root:start INFO:root:testing foo INFO:root:testing foobar ERROR:root:foobar is not foo INFO:root:done
问题的原因是pytest无法以您想要的方式记录日志消息和测试结果/断言。通过将日志记录构建到测试中,可以解决这个问题。