如何测试Python CLI程序与点击，coverage.py和毒性？

Question

我正在使用click开发一个CLI程序，我想开始添加一些测试，使用coverage进行代码覆盖率分析。皮耶。

我认为实现测试的一个好方法是使用子流程运行CLI本身。但是，保险范围有限。py报告零代码覆盖率，可能是因为子流程生成的Python实例没有覆盖率。py仪器。

我找到了这个链接，上面写着我可以删除一个站点自定义。PYTHONPATH中的py文件始终强制Python启动覆盖率测量，但我使用Tox创建一个venv并运行测试。我找不到任何处理这个问题的毒素设置。

我发现这个答案说我应该通过覆盖率运行来运行我的CLI，但是看起来只有当给一个Python脚本的路径时才有效，我正试图通过<-plhd--0/>.我必须改变我所有的命令行在测试代码从myProgram到覆盖运行myProgram/cli/cli.py。我宁愿不这样做，因为这不是我期望用户运行程序的方式。

因此，似乎有两种选择：

>

想办法让sitecustomize.py在Tox环境中工作，或者

测试代码中的所有命令行都使用脚本路径而不是入口点（从长远来看可能更容易，但会使测试更脆弱，更难理解）。不知道我还缺什么。

Answer 1

CliRunner和一个合适的单元测试框架是应该走的路。下面是使用PyTest Coverage插件的PyTest示例设置

from click.testing import CliRunner

from click_prog import hello


def test_hello_world():

    runner = CliRunner()
    result = runner.invoke(hello, ['--opt', 'An Option', 'An Arg'])
    assert result.exit_code == 0
    assert result.output == 'Opt: An Option  Arg: An Arg\n'

    result = runner.invoke(hello, ['An Arg'])
    assert result.exit_code == 0
    assert result.output == 'Opt: None  Arg: An Arg\n'


if __name__ == '__main__':
    test_hello_world()

import click
import sys


@click.command()
@click.option('--opt')
@click.argument('arg')
def hello(arg, opt):
    """A Simple program"""
    click.echo('Opt: {}  Arg: {}'.format(opt, arg))


if __name__ == '__main__':
    hello(sys.argv[1:])

[pytest]

# -- recommended but optional:
# python_files = tests.py test_*.py *_tests.py

===================== test session starts =====================
platform darwin -- Python 3.6.5, pytest-3.7.1, py-1.5.4, pluggy-0.7.1
rootdir: /Users/strauch/dev/fix_windows, inifile: pytest.ini
plugins: xdist-1.22.5, forked-0.2, cov-2.6.0
collected 1 item

test_click.py .                                         [100%]

---------- coverage: platform darwin, python 3.6.5-final-0 -----------
Name             Stmts   Miss  Cover
------------------------------------
click_prog.py        8      1    88%
test_click.py       12      1    92%
------------------------------------
TOTAL               20      2    90%


================== 1 passed in 0.07 seconds ===================