对于一个简单的Python模块来说，非常常见的目录结构似乎是将单元测试分离到它们自己的测试目录中:
new_project/
antigravity/
antigravity.py
test/
test_antigravity.py
setup.py
etc.
我的问题很简单，实际运行测试的通常方式是什么?我怀疑这对每个人来说都是显而易见的，除了我，但你不能只是从测试目录运行python test_antigravity.py，因为它的导入antigravity将失败，因为模块不在路径上。
我知道我可以修改PYTHONPATH和其他与搜索路径相关的技巧，但我不能相信这是最简单的方法——如果您是开发人员，这很好，但如果用户只是想检查测试是否通过，那么期望他们使用这种方法是不现实的。
另一种替代方法是将测试文件复制到另一个目录中，但这似乎有点愚蠢，并且没有注意到将它们放在一个单独的目录中。
那么，如果您刚刚下载源代码到我的新项目，您将如何运行单元测试?我更喜欢这样的答案:“要运行单元测试，请执行x。”
当前回答
同样的问题我已经有很长时间了。我最近选择的目录结构是这样的:
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文件夹，我的单元测试或我的环境变量，一切都运行顺利。
其他回答
使用cwd作为根项目的目录(在你的例子中是new_project)，你可以在任何目录中不使用__init__.py运行以下命令:
python -m unittest discover -s test
但是你需要在test_antigravity.py中导入如下:
from antigravity import antigravity.your_object
而不是:
import antigravity.your_object
如果你不喜欢反重力条款，你可能会喜欢艾伦L的答案。
项目中的单元测试有setup.py文件。试一试:
python3 setup.py build
and
python3 setup.py develop --user
做配置路径之类的工作。试一试!
我注意到，如果您从“src”目录运行unittest命令行接口，那么导入可以正常工作，无需修改。
python -m unittest discover -s ../test
如果你想把它放在项目目录下的批处理文件中，你可以这样做:
setlocal & cd src & python -m unittest discover -s ../test
可以使用包装器来运行选定的或所有测试。
例如:
./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单元测试?
以下是我的项目结构:
ProjectFolder:
- project:
- __init__.py
- item.py
- tests:
- test_item.py
我发现最好在setUp()方法中导入:
import unittest
import sys
class ItemTest(unittest.TestCase):
def setUp(self):
sys.path.insert(0, "../project")
from project import item
# further setup using this import
def test_item_props(self):
# do my assertions
if __name__ == "__main__":
unittest.main()
