『德不孤』Pytest框架 — 3、Pytest的基础说明

目录

• 1、Pytest参数介绍
• 2、Pytest框架用例命名规则
• 3、Pytest Exit Code说明
• 4、pytest.ini全局配置文件
• 5、Pytest执行测试用例的顺序

1、Pytest参数介绍

• -v：打印用例执行的详细过程。
• -q：只显示整体测试结果。（显示简略过程）
• -s：用于显示输出调试信息，包括测试函数中print()函数输出的信息。
• -x，--exitfirst：在第一个错误或测试失败时立即退出。
  
  示例：在第N个用例失败以后，结束测试执行。
  
  第1次失败，就停止测试：pytest -x ./test_a.py
• --maxfail=num：表示出现几个用例失败就停止执行测试。
  
  出现两个失败就终止测试：pytest --maxfail=2 ./test_a.py
• -h：帮助。
• -n：支持多线程或者分布式运行测试用例。
  
  例如：pytest -vs /testcase/test_login.py -n 2

-n 2表示支持分布式运行测试用例，并且分配两个线程来执行。
  
  或者pytest.main(['-vs','test_a.py'],'-n=2')
• --reruns NUM：失败用例重跑。
  
  示例：
  
  pytest.main(['-vs','test_a.py'],'--reruns=2')
  
  表示如果一个用例测试失败了，再重新执行两次，也就是一共执行三次该用例。
• -k args：根据测试用例的名字，搜索匹配字符串，来执行匹配上的测试用例。
  
  例如：pytest -vs ./test_a.py -k "ao"
• --collect-only ：收集将要执行的用例，但不会执行用例。
  
  例如：pytest --collcet-onty
• -r option：生成简略的指定需求的报告。

提示：

以上功能直接带参数执行启动命令就能够实现，而且还是很多其他的参数，以后在实际工作中好好总结，这里就不一一演示了。

前提要安装好前面提到的Pytest插件要安装好。

• pytest-rerunfailures：失败case重复执行。
• pytest-xdist：测试用例分布式执行，也可以说是多CPU分发。

2、Pytest框架用例命名规则

Pytest可以在不同的函数中、包中发现用例，发现的规则如下：

• 测试文件名以 test_’开头，以 _test’结尾.py文件。（必须有下划线）
• 以test_开头的函数。（以下有没有下划线都可以）
• 以test_开头的方法。
• 测试类以 Test 开头，并且类中不能带有init方法。

要注意的是所有的包必须要有init.py文件，在使用PyCharm编辑器时会自动生成。

3、Pytest Exit Code说明

• Exit Code 0：所有用例执行完毕，全部通过。
• Exit Code 1：所有用例执行完毕，存在Failed的测试用例。
• Exit Code 2：用户中断测试执行。
• Exit Code 3：测试执行过程中发生了内部错误。
• Exit Code 4：Pytest命令行使用错误。
• Exit Code 5：未采集到可用测试用例文件。

提示：

Exit Code是公共API的一部分，可以使用以下方法直接导入和访问：

也就是在编写测试用例的时候，我们也可以通过枚举的方式获取Exit Code进行判断或者断言。

步骤1：导入

from pytest import ExitCode

步骤2：调用（都是常量）

pytest.ExitCode.OK

4、pytest.ini全局配置文件

通过全局的配置文件运行测试用例，这种方式才是在实际企业自动化中的应用方式。（前面三种方式是自己测试的时候使用）

pytest.ini文件是Pytest的主配置文件，可以改变Pytest的运行方式，pytest.ini文件的名字是固定的，不能改动。

pytest.ini文件可以改变Pytest测试框架默认的行为（查找执行测试用例的行为），Pytest会读取pytest.ini文件中配置信息，按指定的方式去运行测试用例。

pytest.ini文件要注意：

1. 存放位置：一般放在项目的根目录（即当前项目的顶级文件夹下）。
2. 编码格式：必须是ANSI编码格式，可以使用notpad++修改编码格式。
3. pytest.ini文件中不能使用任何中文符号（也可以用，最好少用）。
4. 配置了pytest.ini文件后，不管是主函数模式运行用例，还是命令行模式运行用例，都会去读取pytest.ini配置文件中的内容。
5. CMD命令行中执行pytest -h命令，可以查看pytest.ini的设置选项。

下面是最基础的pytest.ini文件的编写，如下：

[pytest]
# 命令行的参数，用空格分隔
addopts = -s --alluredir report
# 测试用例的路径
testpaths = scripts
# 模块名的规则
python_files = test_parametrize.py
# 类名的规则
python_classes = Test*
# 方法名的规则
python_functions = test*

提示：用的时候把中文全部删除掉。

5、Pytest执行测试用例的顺序

Unittest测试框架，默认是以用例名的ascll大小，来决定测试用例的执行的顺序。

Pytest测试框架：默认从上到下顺序执行测试用例，也就是文件中先写的谁，谁就先执行。

我们可以通过函数装饰器的方式，标记被测试函数来决定用例执行的顺序。

需要使用pytest-ordering插件。

安装⽅式：pip install pytest-ordering

使用方法：

1. 标记于被测试函数之上，@pytest.mark.run(order=x)。
2. 根据order传入的参数来解决运行顺序。
3. order值全为正数或全为负数时，运行顺序：值越小，优先级越高。
4. 正数和负数同时存在：正数优先级高。

示例：

"""
1.学习目标
    掌握pytest中用例执行顺序的控制
2.操作步骤
    pytest框架下用例执行的默认顺序: 是按照书写顺序从上到下执行
    控制测试用例执行顺序，需要安装pytest-ordering库（插件）
        pip install pytest-ordering

    控制用例执行顺序方法:
        在测试用例前添加一个装饰
        @pytest.mark.run(order=数字)

    执行顺序问题:order=数字
        0 > 较小的正数 > 较大正数 > 不使用order > 较小负数 > 较大负数

3.需求
"""
# 1.导入pytest
import pytest

# 2.编写测试用例
@pytest.mark.run(order=2)
def test_login():
    """登录用例"""
    print("登录步骤")
    assert "abcd" in "abcdefg"

@pytest.mark.run(order=1)
def test_register():
    """注册用例"""
    print("注册步骤")
    assert True

@pytest.mark.run(order=4)
def test_shopping():
    """购物下单"""
    print("购物流程")
    assert True

@pytest.mark.run(order=3)
def test_cart():
    """购物车用例"""
    print("购物车流程")
    assert True

if __name__ == '__main__':
    pytest.main()

"""
执行结果：
test_order.py::test_register PASSED                                      [ 25%]注册步骤

test_order.py::test_login PASSED                                         [ 50%]登录步骤

test_order.py::test_cart PASSED                                          [ 75%]购物车流程

test_order.py::test_shopping PASSED                                      [100%]购物流程

============================== 4 passed in 0.06s ==============================

Process finished with exit code 0
"""