py.test将消息和测试结果/断言记录到单个文件中

时间:2014-07-22 16:07:08

标签: python testing logging pytest

我现在开始使用py.test进行新项目。我们正在配置Linux服务器,我需要编写一个脚本来检查这些服务器的设置和配置。我认为py.test是实现这些测试的好方法,直到现在它才能正常工作。

我现在面临的问题是,在这些测试结束时我需要一个日志文件,显示每个测试的一些日志消息和测试结果。对于日志消息,我使用logger:

logging.basicConfig(filename='config_check.log', level=logging.INFO)
pytest.main()
logging.info('all done')

作为一个例子测试,我有这个:

def test_taintedKernel():
    logging.info('checking for tainted kernel')
    output = runcmd('cat /proc/sys/kernel/tainted')
    assert output == '0', 'tainted kernel found'

所以在我的日志文件中我想要一个类似的输出:

INFO:root:checking for tainted kernel
ERROR:root:tainted kernel found
INFO:root:next test
INFO:root:successful
INFO:root:all done

但是我无法将测试结果输入到日志文件中,而是在测试后得到stdout上的标准输出:

======================================= 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 ===============================

对于我的脚本用户来说,这可能会让人感到困惑。我试图进入logger和pytest_capturelog,因为这里经常提到它,但我确实做错了,因为我没有得到它。也许只是缺乏理解这是如何工作的。希望你能给我一些暗示。如果有任何遗漏,请告诉我。

先谢谢你的帮助,

斯蒂芬

2 个答案:

答案 0 :(得分:8)

pytest的工作是捕获输出并将其呈现给运营商。因此,不是试图让pytest以你想要的方式进行日志记录,而是可以在测试中构建日志。

Python的assert命令只需要一个真值和一条消息。因此,如果值为false(这与触发断言失败的条件相同),则可以编写一个小函数来执行日志记录,而不是在测试中使用裸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

答案 1 :(得分:0)

从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部分。