Question

我有一个Python项目，该项目使用pytest-cov进行单元测试和代码覆盖率测量。

我的项目的目录结构是：

rift-python
+- rift                        # The package under test
|  +- __init__.py
|  +- __main__.py
|  +- cli_listen_handler.py
|  +- cli_session_handler.py
|  +- table.py
|  +- ...lots more...
+- tests                       # The tests 
|  +- test_table.py
|  +- test_sys_2n_l0_l1.py
|  +- ...more...
+- README.md
+- .travis.yml
+- ...

我使用Travis在每次签入时运行pytest --cov=rift tests，并使用codecov查看代码覆盖率结果。

被测试的软件包提供了一个命令行界面（CLI），该界面可从stdin读取命令并在stdout上生成输出。它以python rift开头。

tests目录包含两种类型的测试。

第一类测试是测试单个类的传统单元测试。例如，test test_table.py导入table.py，并执行传统的pytest测试（使用assert等）。代码覆盖率测量按预期在这些测试中起作用：codecov准确报告rift包中的哪些行未被测试。

# test_table.py (codecov works)

import table

def test_simple_table():
    tab = table.Table()
    tab.add_row(['Animal', 'Legs'])
    tab.add_rows([['Ant', 6]])
    ...
    tab_str = tab.to_string()
    assert (tab_str == "+--------+------+\n"
                       "| Animal | Legs |\n"
                       "+--------+------+\n"
                       "| Ant    | 6    |\n"
                       "+--------+------+\n"
                       ...
                       "+--------+------+\n")

第二种测试使用pexpect：它使用pexpect.spawn("python rift")启动rift程序包。然后，它使用pexpect.sendline将命令注入CLI（stdin），并使用pexpect.expect检查CLI（stdout）上命令的输出。测试功能运行良好，但是codecov没有报告这些测试的代码覆盖率。

# test_sys_2n_l0_l1.py (codecov does not pick up coverage of rift package)
# Greatly simplified example

import pexpect

def test_basic():
    rift = pexpect.spawn("python rift")
    rift.sendline("cli command")
    rift.expect("expected output")  # Throws exception if expected output not seen

问题：如何使用pexpect获得代码覆盖率度量以报告生成的裂痕包中第二种类型测试的覆盖线？

注意：我省略了一些我认为无关的细节，完整的源代码位于https://github.com/brunorijsman/rift-python（更新：此仓库现在包含答案中建议的可行解决方案）

Answer 1

使用coverage run运行您的pexpect程序并收集数据：

如果您通常这样做：

pexpect.spawn("python rift")

然后改为：

pexpect.spawn("coverage run rift.py")

（Source）

测试后，您可能希望将预期结果与“常规”单元测试结果结合起来。 coverage.py可以将多个文件合并为一个文件。

一旦创建了许多这些文件，就可以将它们全部复制到一个目录中，并使用combine命令将它们组合成一个.coverage数据文件：

$ coverage combine

（Source）

测试中的另外两个细节：

在此示例中的测试程序（test_sys_2n_l0_l1.py）中，必须确保在终止pexpect生成点与终止测试本身之间存在延迟。否则，coverage将没有时间将结果写入.coverage。我增加了一个睡眠（1.0）。
使用了“ coverage run --parallel-mode rift”。需要这样做（a）确保.coverage不会被以后的运行所覆盖，并且（b）使“ coverage Combine”工作（由“ pytest --cov”自动运行）

Answer 2

您基本上必须启用subprocess coverage tracking。

我建议使用https://pypi.org/project/coverage_enable_subprocess/轻松启用此功能。

然后建议/要求使用parallel = 1，并且您必须导出COVERAGE_PROCESS_START，例如export COVERAGE_PROCESS_START="$PWD/.coveragerc"。

pytest-cov如何报告由于pexpect.spawn执行的python代码的覆盖率？

2 个答案: