Pytest 的高级用法之插件开发_pytest getoption

44 阅读2分钟

–runTask : 指定并发执行的最小任务可传以下几个参数值
mod: 测试文件为并发最小执行任务(可以保证测试文件中的用例执行先后顺序)

case: 测试用例为并发最小执行任务

–current: 最大的并发执行数

2、需求分析

1、需求一:在测试执行的阶段

pytest执行负责用例执行的钩子函数:

https://www.osgeo.cn/pytest/reference.html#test-running-runtest-hooks

def pytest_runtestloop(session):

 for item in session.items:
     item.ihook.pytest_runtest_protocol(item=item, nextitem=None)
 return True

2、需求二:实现自己写自定义参数,在初始化阶段,需要使用的钩子函数为:pytest_addoption

pytest添加运行参数的钩子函数:
https://www.osgeo.cn/pytest/writing_plugins.html#writing-hook-functions

def pytest_addoption(parser):
 # 添加参数分组
 group = parser.getgroup('pytest-thread')
 # 添加参数信息
 group.addoption('--current', default=None, help='运行的线程数量')

pytest中的更多的钩子函数文档:
https://www.osgeo.cn/pytest/reference.html#hooks

参数的获取:在pytest钩子函数中,可以通过session.config.getoption(‘–current’)去获取参数

3、代码实现

def pytest_addoption(parser):
    """添加参数名称"""
    # 添加参数分组
    group = parser.getgroup('pytest-current')
    # 添加参数和帮助信息
    group.addoption('--unit', default=None, help='并发执行的任务单位',type="string")
    group.addoption('--current', default=None, help='运行的并发数量',type="int")

def pytest_runtestloop(session):
    # 获取并发数量      
    Count = session.config.getoption('--current')
    # 并发执行的任务单位
    unit = session.config.getoption('--unit')
    # 将测试用例按模块进行拆分
    dictCase = {}
    for item in session.items:
        # 获取用例所属模块
        mod = item.module
        # 判断dictCase是否有该测试模块
        if dictCase.get(mod):
            dictCase[mod].append(item)
        else:
            dictCase[mod] = []
            dictCase[mod].append(item)
          
    # 开启协程并发执行
    gs = []
    for cases in dictCase.values():
        g = gevent.spawn(run_test_mod, cases)
        gs.append(g)
    gevent.joinall(gs)
    return True


def run_test_mod(cases):
    """
    :param cases: 用例列表
    :return:
    """
    for item in cases:
        item.ihook.pytest_runtest_protocol(item=item, nextitem=None)

五 插件打包和上传

参照官方文档:
https://packaging.python.org/en/latest/tutorials/packaging-projects/#packaging-your-project

1、创建一个pytest插件项目

源码目录:(编写插件源码)

readme.md (说明文档)

setup.py(打包配置文件)

LICENSE:开源许可协议

2、编写插件功能代码

在src目录下创建py文件,编写插件核心代码

def pytest_addoption(parser):
    """添加参数名称"""
    # 添加参数分组
    group = parser.getgroup('pytest-current')
    # 添加参数和帮助信息
    group.addoption('--unit', default=None, help='并发执行的任务单位',type="string")
    group.addoption('--current', default=None, help='运行的并发数量',type="int")

def pytest_runtestloop(session):
    # 获取并发数量      
    Count = session.config.getoption('--current')
    # 并发执行的任务单位
    unit = session.config.getoption('--unit')
    # 将测试用例按模块进行拆分
    dictCase = {}
    for item in session.items:
        # 获取用例所属模块
        mod = item.module
        # 判断dictCase是否有该测试模块
        if dictCase.get(mod):
            dictCase[mod].append(item)
        else:
            dictCase[mod] = []
            dictCase[mod].append(item)

    # 开启协程并发执行
    gs = []
    for cases in dictCase.values():
        g = gevent.spawn(run_test_mod, cases)
        gs.append(g)
    gevent.joinall(gs)
    return True


def run_test_mod(cases):
    """
    :param cases: 用例列表
    :return:
    """
    for item in cases:
        item.ihook.pytest_runtest_protocol(item=item, nextitem=None)

3、配置打包信息

1、在项目目录下创建setup.py文件,

from setuptools import setup

setup(
    name="pytest-musen",
    version='0.0.1',
    packages=["pytest_musen"],
    # 指定插件文件
    entry_points={"pytest11": ["pytest-lemon = pytest_musen.musen"]},
    # pypi插件分类器
    classifiers=["Framework :: Pytest"],
)

注意点:pytest 查找插件是根据pytest11入口来查找的安装的第三方包的
Writing plugins — pytest documentation

2、对项目进行打包