Pytest框架

介绍

1.简介

pytest是纯python编写的自动化测试框架，可以支持python语法编写测试用例，是一个非常成熟的全功能的Python测试框架。

主要有以下几个特点：

简单灵活，容易上手；支持参数化；能够支持简单的单元测试和复杂的功能测试，还可以结合selenium、requests做自动化测试；pytest具有很多第三方插件，并且可以自定义扩展。

安装：<code>pip install pytest

官方文档：https://docs.pytest.org

2.第一个pytest用例

def test_01():

assert 1 == 1

3.pytest命名规范

测试模块：以 test_ 开头命名，如：test_login.py，或以 _test 结尾；

测试类：必须以Test开头命名，且测试类中不能有 __init__ 方法；

测试方法/测试函数：必须以test开头。

4.常用参数

可以通过pytest -h来查看所有可用参数。pytest的参数有很多，下面是归纳一些常用的参数：

无参数：读取路径下符合条件的所有类、函数、方法全部执行；

-v：打印详细运行日志；

-s：输出调试信息，包括print打印的信息；命令行输入：pytest -s;

-x：运行用例失败立即停止运行

–maxfail

用例失败数达到某个设定的值停止运行

pytest --maxfail=[num]

-m 运行所有@pytest.mark.[标记名] 标记的用例

比如：用例标记 @pytest.mark.high

pytest -m=hign 或者 pytest -m hign。# 表示只执行有此标记hight的case。

pytest -m="hign or smoke" 或者 pytest -m "hign or smoke" # 表示两种标记都执行

–reruns=num：失败用例重跑num次。需要安装 pytest-rerunfailures 插件模块。

-n参数，启用多线程或分布式运行测试用例。需要安装pip install pytest-xdist 插件模块。

命令行输入：pytest -vs -n=2

-k： ​指定运行某个或某些用例

pytest -k ‘类名’

pytest -k ‘方法名’

pytest -k ‘类名 and not 方法名’ # 运行类里所有方法，不包含某个方法

命令行输入：pytest -vs -k=01

python程序运行pytest：

caseNameString = " or ".join(caseNameList)

cmd = f"python -m pytest -k \"{caseNameString}\" --alluredir ./allure --clean-alluredir"

os.system(cmd)

-k的值支持中文的哟~

参数-n，启用多线程或分布式运行测试用例。需要安装pip install pytest-xdist 插件模块。

命令行输入：pytest -vs -n=2

5.实现数据驱动

Pytest 测试框架的数据驱动是由 pytest 自带的pytest.mark.parametrize()来实现的。

@pytest.mark.parametrize() 装饰器接收两个参数：

第一个参数以字符串的形式存在，它代表能被测试函数所能接受的参数，如果被测试函数有多个参数，则以逗号分隔；

第二个参数用于保存测试数据。如果只有一组数据，以列表的形式存在，如果有多组数据，以列表嵌套元组的形式存在（例如： [1,1]或者[(1,1), (2,2)]）。

实例

<code>class Test01:

@pytest.mark.parametrize('a,b,expect',[(1,1,1),(2,3,5)])

def test_001(self,a,b,expect):

print('测试a+b的结果')

assert a+b==expect

@pytest.mark.parametrize('c,d,expect', [(2, 4, 2), (9, 10, 1)])

def test_002(self,c,d,expect):

assert d-c==expect

if __name__ == '__main__':

pytest.main([__file__, '-k','test_001'])

6.pytest fixtures

6.1 fixture用途

fixture主要用来做初始化环境以及测试结束后的数据清除。pytest fixture与setup,teardown功能一样，但比之更加灵活，完全可以代替setup,teardown。

 6.2 fixture参数详解

@pytest.fixture(scope='function',params=None,autouse=False,ids=None,name=None)

yield

fixture装饰器，相当于setup，测试用例的前置

* scope: 有四个级别参数'function（默认）'、'class'、'module'、'session'。

* params：一个可选的参数列表，列表中每个数据都可以作为用例的输入。也就说有多少数据，就会形成多少用例。可以通过request.param来获取该次调用的参数。

* autouse：如果True，自动调用fixture功能。如果为False则需要调用fixture。

* ids：每个字符串id的列表，每个字符串对应于params这样他们就是测试ID的一部分。如果没有提供ID它们将从params自动生成。

* name：fixture的名称。这默认为装饰函数的名称。如果fixture在定义它的统一模块。

yield：这个关键字之后的代码相当于teardown，测试用例的后置。

6.3 fixture的作用范围

fixture里面有个scope参数可以控制fixture的作用范围：session>module>class>function

-function：每一个函数或方法都会调用

-class：每一个类调用一次，一个类中可以有多个方法

-module：每一个.py文件调用一次，该文件内又有多个function和class

-session：是多个文件调用一次，可以跨.py文件调用，每个.py文件就是module

6.4 调用fixture的三种方法 

方式1：函数或类里直接传fixture的函数名称 

<code> @pytest.fixture()

def test_fixture(self):

print('\n用例开始执行fix1\n')

yield

print('\n用例执行结束fix1\n')

def test_a(self, test_fixture):

print('runing')

assert 1 == 1

执行结果：

方式2： 使用装饰器@pytest.mark.usefixtures()修饰需要运行的用例（可以叠加使用多个装饰器）

<code> @pytest.fixture()

def test_fixture(self):

print('\n用例开始执行fix1\n')

yield

print('\n用例执行结束fix1\n')

@pytest.fixture()

def test_fixture2(self):

print('\n用例开始执行fix2\n')

yield

print('\n用例执行结束fix2\n')

@pytest.mark.usefixtures('test_fixture')

@pytest.mark.usefixtures('test_fixture2')

def test_b(self):

assert 1==1

执行结果

7.skip – 跳过测试 

7.1 pytest.skip() 用于函数内，跳过测试用例

<code>@pytest.mark.parametrize('a,b,expect',[(1,1,1),(2,3,5)])

def test_001(self,test1,a,b,expect):

pytest.skip('跳过此测试用例')

assert a+b==expect

用于函数外，跳过测试用例

@pytest.mark.skip(reason="功能未实现")code>

@pytest.mark.parametrize('a,b,expect',[(1,1,1),(2,3,5)])

def test_001(self,test1,a,b,expect):

assert a+b==expect

 用在函数外，条件condition为True时，跳过用例

@pytest.mark.skipif(condition=True,reason="功能未实现")code>

@pytest.mark.parametrize('a,b,expect',[(1,1,1),(2,3,5)])

def test_001(self,test1,a,b,expect):

assert a+b==expect

8.rerunfailure–失败重跑，插件pytest-rerunfailures

执行用例，并指定生成allure报告路径，命令如下：

pytest Test_demo02.py -s -q --alluredir=./result

alluredir 指定<code>存放allure报告的路径

如图，生成两个文件夹：pytest_cache/result

result文件夹中三个json文件，对应用例中的三条case。

5.查看报告方式两种

方式一：可以通过allure解析json文件，使用命令查看报告

allure serve ./result （指定result文件夹路径）

会自动打开浏览器，展示allure报告

方式二：通过结果生成报告

allure generate  ./allure -o ./allure-report --clean

        ./allure： pytest执行测试报告生成的数据文件路径

        -o ./allure-report： 输出报告到此路径

        --clean：<code>--clean 参数的作用是在生成新报告之前清理目标目录（也就是报告输出目录）。这意味着如果目标目录 ( ./allure-report) 中已经存在旧的报告文件，使用 --clean 参数会先删除这些旧文件，然后再生成新的报告。

打开报告

allure open -h 127.0.0.1 -p 8883 ./report/

6.QA-allure serve ./result/报错的解决思路

pycharm的终端输入：allure serve ./result/

allure报错：‘allure‘ 不是内部或外部命令，也不是可运行的程序 或批处理文件

解决思路：

没有下载allure，只是安装了allure-pytest插件安装allure后，检查是否配置allure的环境变量到path配置环境变量后，需要重启pycharm，可能是环境变量没有同步过来导致。关闭防火墙开关。

7.allure常用注解

实例如下

<code>import allure

import pytest

from allure_commons.types import LinkType, Severity

@allure.parent_suite('我是parent_suite')

@allure.suite('我是suite')

@allure.sub_suite('我是sub_suite')

@allure.epic('我是epic')

@allure.feature('我是feature')

@allure.story('我是story')

class TestAllureDemo:

@allure.step('我是断言')

def assert_one(self, a, b):

assert a == b

@allure.id('我是id')

@allure.title('我是title')

@allure.link('https://www.baidu.com/', LinkType.ISSUE, '我是link_ISSUE')

@allure.label('我是label')

@allure.issue('https://www.baidu.com/', '我是issue')

@allure.description('我是description')

@allure.severity(Severity.BLOCKER)

@allure.tag('我是tag')

@allure.testcase('https://www.baidu.com/', 'testcase')

def test_01(self):

self.assert_one(1, 1)

@allure.id('我是id')

@allure.title('我是title')

@allure.link('https://www.baidu.com/', LinkType.LINK, '我是link')

@allure.label('我是label')

@allure.issue('https://www.baidu.com/', '我是issue')

@allure.description('我是description')

@allure.severity('我是severity')

@allure.tag('我是tag')

@allure.testcase('https://www.baidu.com/', '我是testcase')

def test_02(self):

allure.dynamic.mro()

allure.dynamic.title('我是修改后的title')

allure.dynamic.link('https://www.baidu.com/', LinkType.LINK, '我是修改后的link')

allure.dynamic.label('我是修改后的label')

allure.dynamic.issue('https://www.baidu.com/', '我是修改后的issue')

allure.dynamic.description('我是修改后的description')

allure.dynamic.severity('我是修改后的severity')

allure.dynamic.tag('我是修改后的tag')

allure.dynamic.testcase('https://www.baidu.com/', '我是修改后的testcase')

assert 1 > 1

生成的报告如下

case1: test_01

 case2: test_02

遇到的问题

问题1：pytest执行的case，如果返回结果有中文，获取数据显示unicode编码格式

原因：是pytest默认将输出报告 视为ASCII字符串，并在测试报告中按原样显示。由于中文字符不属于ASCII字符范围，因此pytest会将其转换为Unicode编码表示。

解码后，pytest的执行报告才能正常显示中文。

使用语句：result = response.content.decode("unicode-escape")

问题2：在pycharm/idea中，执行程序运行：pytest 命令执行用例时， 提示：PermissionError: [Errno 13] Permission denied: 'C:\\Program Files\\Python310\\lib\\site-packages\\comtypes\\gen\\_944DE083_8FB8_45CF_BCB7_C477ACB2F897_0_1_0.py'

<code>Program Files 目录通常是一个系统受保护的目录，在默认情况下，普通用户可能没有足够的权限去读取或修改其中的文件。这可能是为什么 pytest 会遇到权限拒绝的原因。

以下是你可以尝试的一些解决方案：

1. 使用管理员权限运行 pytest

在 Windows 上，你可以尝试以管理员身份运行命令提示符或 PowerShell，然后重新运行你的测试。

打开命令提示符或 PowerShell。

右键点击选择“以管理员身份运行”。

在命令提示符中运行 pytest 命令。

2. 检查 Python 安装路径

如果你的 Python 安装在 Program Files 目录下，考虑将 Python 重装到一个不需要管理员权限的目录，比如 C:\Python310。

3. 虚拟环境

使用虚拟环境可以避免直接在系统级别的 Python 安装上进行操作。这样可以减少权限问题，并且让你的项目依赖更加隔离。

创建一个新的虚拟环境。

激活虚拟环境。

在虚拟环境中安装所需的包。

在虚拟环境中运行你的测试。

问题2.1：为什么之前执行pytest，没有提示权限问题

如果你之前能够正常执行 pytest 测试，而现在出现了权限错误，可能有几个潜在的原因导致这一变化。这里有一些可能性：

系统更新或安全策略变化：

最近是否有过系统更新？有时操作系统或防病毒软件的更新会改变某些文件的权限设置。是否启用了新的安全策略或防火墙规则，限制了对某些文件的访问？

Python 版本或依赖库更新：

你是否更新了 Python 版本或 comtypes 库？新版本可能改变了某些行为或文件生成的位置。更新依赖库可能导致一些文件的生成位置或方式发生变化，从而影响到权限。

虚拟环境的变化：

如果你在虚拟环境中工作，是否有任何环境的变化？例如激活了不同的虚拟环境，或者虚拟环境的权限设置发生了变化。

测试代码的变更：

最近是否修改了测试代码或相关依赖？某些修改可能会触发不同的文件访问逻辑。如果你的测试代码或框架最近有所更新，这些更新可能会引入新的行为或依赖。

文件系统缓存或锁定状态：

有时候文件系统的缓存或锁定状态可能导致暂时性的权限问题。重启计算机或清理缓存可能会解决这类问题。

并发操作：

如果你的测试是在并发环境下运行的（例如多线程或多进程），其他进程可能正在使用或锁定这些文件。

环境变量或配置文件：

检查是否有环境变量或配置文件的更改，这些更改可能会影响文件的访问权限。

IDE 或构建工具的更改：

如果你是通过 IDE 或者构建工具（如 Jenkins）运行测试，这些工具的更新或配置更改也可能导致此类问题。

结论：由于pycharm中环境变化导致，pytest引用的python环境不是预期的环境，修改为预期环境后，问题解决。

        pytest引用错误的python环境为：C:\Program Files\python310,通过控制面板>程序和软件，没有查询到python310，直接手动删除C:\Program Files\python310文件夹后。

在pycharm>termianl，使用pip命令查看，可以正常引用到预期的环境了

C:/Users/sjy/AppData/Local/Programs/Python/Python39/python.exe

此时，执行程序运行：pytest 命令执行用例时，功能正常。

参考文档：pytest框架详解_pytest框架 cllections.abc-CSDN博客