Pytest是一个功能强大且易于使用的Python测试框架,它提供了丰富的功能和灵活的用法,使得编写和运行测试变得简单而高效。
一、Pytest的特点
- 简单灵活:Pytest的语法简洁清晰,容易上手,并且支持复杂的测试场景。
- 自动发现测试:Pytest能够自动发现项目中的测试文件和测试函数,无需手动编写繁琐的配置。
- 丰富的断言库:Pytest内置了丰富的断言库,可以方便地进行测试结果的判断。
- 支持参数化测试:Pytest支持参数化测试,允许对多组输入进行测试,提高测试效率。
- 插件丰富:Pytest拥有丰富的插件生态系统,如pytest-selenium(集成selenium)、pytest-html(生成HTML测试报告)、pytest-rerunfailures(失败case重复执行)、pytest-xdist(多CPU分发)等,可以通过插件扩展各种功能。
- 可以与Jenkins集成:Pytest能够很好地与Jenkins等持续集成工具集成,方便自动化测试流程的构建。
二、Pytest的安装
Pytest的安装非常简单,可以使用pip命令进行安装:
pip install -U pytest
安装完成后,可以通过运行pytest --version
来验证安装是否成功,如果看到版本号则说明安装成功。
三、Pytest的基本使用
- 测试文件命名 :测试文件应该以
test_
开头或以_test
结尾,例如test_login.py
或user_test.py
。 - 测试函数命名 :测试函数应该以
test
开头,例如def test_login_success():
。 - 测试类命名 :如果使用类来组织测试用例,测试类应该以
Test
开头,且不能有__init__
方法。测试类中的测试函数同样需要以test
开头。 - 执行测试 :可以通过命令行直接运行
pytest
命令来执行测试,或者通过编写Python代码调用pytest.main()
函数来执行测试。
四、Pytest的运行参数
Pytest提供了丰富的运行参数,以支持不同的测试需求。以下是一些常用的运行参数:
-v
:打印详细运行日志。-s
:打印测试中的print输出。-k
:通过关键字表达式过滤要执行的测试用例。-x
:运行用例失败后立即停止执行。--maxfail=num
:当用例失败数达到某个设定的值时停止运行。-m
:运行所有被特定标记装饰的测试用例。
五、Pytest的fixture
Pytest的fixture是一个非常强大的功能,它主要用于测试环境的初始化和清理工作。fixture可以代替传统的setup和teardown函数,提供更加灵活和强大的功能。
fixture通过@pytest.fixture()
装饰器进行定义,可以使用scope
参数控制fixture的作用范围(如function、class、module、session)。在测试用例中,可以通过函数参数的形式传入fixture,以便在测试前后进行环境的初始化和清理。
六、Pytest的断言
Pytest的断言主要使用Python的原生断言方法,如==
、in
、is
等。此外,Pytest还提供了assert
语句的扩展功能,可以方便地生成断言失败的详细信息。
七、Pytest的skip和xfail
Pytest支持在测试用例中跳过某些不需要执行的测试,或者将某些预期会失败的测试标记为xfail(expected failure)。这有助于在开发过程中管理那些尚未实现或存在已知问题的功能。
八、Pytest的示例
这里的Python项目的结构很简单,如下所示:
project/
├── src/
│ ├── module1.py
│ └── module2.py
└── tests/
├── test_module1.py
└── test_module2.py
这里以实现斐波那契函数及对其进行测试为例:
斐波那契函数是一个有趣的古典数学问题,著名意大利数学家Fibonacci曾提出一个问题:有一对小兔子,从出生后第3个月起每个月都生一对兔子。小兔子长到第3个月后每个月又生一对兔子。按此规律,假设没有兔子死亡,第一个月有一对刚出生的小兔子,问第n个月有多少对兔子?
在src目录下新增 fibonacci.py , 内容如下:
def fibonacci(n):
if n <= 0:
return 0
elif n == 1:
return 1
a, b = 0, 1
for _ in range(2, n + 1):
a, b = b, a + b
return b
在tests目录下新增测试文件:test_fibonacci.py,内容如下:
import pytest
import sys
import os
# 获取当前文件的目录
current_dir = os.path.dirname(os.path.abspath(__file__))
# 获取当前文件的父目录路径
parent_dir = os.path.dirname(current_dir)
# 假设src目录与当前文件(test_fibonacci.py)在同一级别
src_dir = os.path.join(parent_dir, 'src')
# 将src目录添加到sys.path中,以便可以导入其中的模块
sys.path.insert(0, src_dir)
# 现在可以导入src目录下的fibonacci模块了
from fibonacci import fibonacci
def test_fibonacci_zero():
assert fibonacci(0) == 0
def test_fibonacci_one():
assert fibonacci(1) == 1
def test_fibonacci_two():
assert fibonacci(2) == 1
def test_fibonacci_three():
assert fibonacci(3) == 2
def test_fibonacci_four():
assert fibonacci(4) == 3
def test_fibonacci_large_number():
# 选择一个较大的数字进行测试,确保算法在较大输入时也能正确工作
# 这里选择了第10个斐波那契数,因为55是一个相对容易验证的结果
assert fibonacci(10) == 55
def test_fibonacci_negative_number():
# 假设我们想要函数对于负数的输入抛出异常或者返回特定的值
# 这里我们假设它应该返回0(或者你可以根据需求修改)
assert fibonacci(-1) == 0
在项目目录运行 pytest
命令,运行成功的结果如下图: