初探 Pytest:编写并运行你的第一个测试用例
概述
当我们你完成了项目的搭建和结构设计,是时候开始编写你的第一个测试用例了。本文将引导你一步步完成这个过程,帮助你熟悉 Pytest 的基本使用方法。
项目的搭建和结构设计可参考 :从零开始搭建 Pytest 测试框架(Python 3.8 + PyCharm 版)
编写第一个测试用例
假设我们有一个简单的加法函数,位于 utils/common.py
文件中:
def add(a, b):return a + b
我们的目标是验证这个加法函数的行为是否正确。接下来,我们将编写一个测试用例来检查这个函数的输出是否符合预期。
第一步:创建测试文件
在之前搭建的项目结构中,你应该已经有了一个 tests
文件夹。我们现在要在这个文件夹内创建一个新的 Python 文件,比如命名为 test_sample.py
第二步:导入被测函数
打开 tests/test_sample.py
文件,并导入你在 utils/common.py
中定义的 add
函数:
from utils.common import add
第三步:编写测试逻辑
定义一个测试函数,根据 Pytest 的命名约定,测试函数的名字应该以 test_
开头。这里我们定义一个名为 test_add
的函数,用于验证 add
函数的行为:
def test_add():assert add(2, 3) == 5assert add(-1, 1) == 0assert add(0, 0) == 0
这段代码包含了几条断言(assertions),用来验证 add
函数返回的结果是否符合预期。
运行测试
编写完测试用例后,就可以运行它们了。有几种方法可以运行 Pytest 测试:
方法一:使用终端运行
- 打开终端或命令提示符。
- 导航到你的项目根目录(即包含
tests
文件夹的那个目录)。 - 输入以下命令来运行所有测试:
pytest
你会看到类似如下的输出:
============================= test session starts =============================
collected 1 itemtests/test_sample.py . [100%]============================== 1 passed in 0.01s ==============================
这说明你的测试通过了!
方法二:使用 PyCharm 运行
如果你使用的是 PyCharm,可以通过以下步骤运行测试:
- 打开
tests/test_sample.py
文件。 - 右键点击编辑器中的任意位置,选择
Run 'pytest in test_sample.py'
PyCharm 会自动调用 pytest 并显示运行结果
总结
在这篇文章中,我们一起完成了以下内容:
- 编写了第一个测试用例,验证了一个简单的加法函数。
- 学习了如何使用终端和 PyCharm 来运行测试