运行带有典型测试目录结构的unittest

对于一个简单的Python模块来说，非常常见的目录结构似乎是将单元测试分离到它们自己的测试目录中:

new_project/
    antigravity/
        antigravity.py
    test/
        test_antigravity.py
    setup.py
    etc.

我的问题很简单，实际运行测试的通常方式是什么?我怀疑这对每个人来说都是显而易见的，除了我，但你不能只是从测试目录运行python test_antigravity.py，因为它的导入antigravity将失败，因为模块不在路径上。

我知道我可以修改PYTHONPATH和其他与搜索路径相关的技巧，但我不能相信这是最简单的方法——如果您是开发人员，这很好，但如果用户只是想检查测试是否通过，那么期望他们使用这种方法是不现实的。

另一种替代方法是将测试文件复制到另一个目录中，但这似乎有点愚蠢，并且没有注意到将它们放在一个单独的目录中。

那么，如果您刚刚下载源代码到我的新项目，您将如何运行单元测试?我更喜欢这样的答案:“要运行单元测试，请执行x。”

当前回答

如果没有一些巫术，就不能从父目录导入。下面是另一种至少适用于Python 3.6的方法。

首先，创建一个包含以下内容的test/context.py文件:

import sys
import os
sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))

然后在test/test_antigravity.py文件中导入如下内容:

import unittest
try:
    import context
except ModuleNotFoundError:
    import test.context    
import antigravity

请注意，这个try-except子句的原因是

导入测试。当使用“python test_antigravity.py”运行时，上下文将失败在new_project目录下使用"python -m unittest"运行时导入context失败。

通过这种诡计，他们都成功了。

现在你可以运行test目录下的所有测试文件:

$ pwd
/projects/new_project
$ python -m unittest

或者运行一个单独的测试文件:

$ cd test
$ python test_antigravity

好吧，这并不比在test_antigravity。py中包含context。py的内容漂亮多少，但也许会漂亮一点。欢迎提出建议。

2018-10-20 16:25:34

其他回答

可以使用包装器来运行选定的或所有测试。

例如:

./run_tests antigravity/*.py

或者递归地运行所有测试使用globbing (tests/**/*.py)(通过shop -s globstar启用)。

包装器基本上可以使用argparse来解析参数，比如:

parser = argparse.ArgumentParser()
parser.add_argument('files', nargs='*')

然后加载所有测试:

for filename in args.files:
    exec(open(filename).read())

然后将它们添加到你的测试套件中(使用inspect):

alltests = unittest.TestSuite()
for name, obj in inspect.getmembers(sys.modules[__name__]):
    if inspect.isclass(obj) and name.startswith("FooTest"):
        alltests.addTest(unittest.makeSuite(obj))

并运行它们:

result = unittest.TextTestRunner(verbosity=2).run(alltests)

查看这个示例了解更多细节。

请参见:如何在一个目录中运行所有Python单元测试?

2015-06-07 11:45:51

你真的应该使用pip工具。

使用pip install -e。以开发模式安装包。这是pytest推荐的一种非常好的实践(请参阅他们的良好实践文档，其中还可以找到两种可以遵循的项目布局)。

2014-03-07 07:51:46

同样的问题我已经有很长时间了。我最近选择的目录结构是这样的:

project_path
├── Makefile
├── src
│   ├── script_1.py
│   ├── script_2.py
│   └── script_3.py
└── tests
    ├── __init__.py
    ├── test_script_1.py
    ├── test_script_2.py
    └── test_script_3.py

在test文件夹的__init__.py脚本中，我写了以下内容:

import os
import sys
PROJECT_PATH = os.getcwd()
SOURCE_PATH = os.path.join(
    PROJECT_PATH,"src"
)
sys.path.append(SOURCE_PATH)

对于共享项目来说，Makefile非常重要，因为它强制正确地运行脚本。下面是我放在Makefile中的命令:

run_tests:
    python -m unittest discover .

The Makefile is important not just because of the command it runs but also because of where it runs it from. If you would cd in tests and do python -m unittest discover ., it wouldn't work because the init script in unit_tests calls os.getcwd(), which would then point to the incorrect absolute path (that would be appended to sys.path and you would be missing your source folder). The scripts would run since discover finds all the tests, but they wouldn't run properly. So the Makefile is there to avoid having to remember this issue.

我真的很喜欢这种方法，因为我不需要触及我的src文件夹，我的单元测试或我的环境变量，一切都运行顺利。

2020-01-14 11:15:05

这个BASH脚本将从文件系统中的任何位置执行python unittest test目录，无论您在哪个工作目录中。

当你在。/src或。/example工作目录下，并且你需要一个快速的单元测试时，这是很有用的:

#!/bin/bash

this_program="$0"
dirname="`dirname $this_program`"
readlink="`readlink -e $dirname`"

python -m unittest discover -s "$readlink"/test -v

在生产过程中，不需要test/__init__.py文件来增加包/内存开销。

2018-08-13 00:50:04