在上一篇的 hooks 函数分享中,开发了一个本地插件示例,其实已经算是在编写插件了。今天继续跟着官方文档学习更多知识点。

一个插件包含一个或多个钩子函数,pytest 正是通过调用各种钩子组成的插件,实现了配置、搜集、运行和报告的所有方面的功能。

通常 pytes t中的插件有如下 3 类:

  • 内置插件 : 从 pytest 内部的_pytest目录加载
  • 外部插件 : 通过setuptools入口发现的模块
  • conftest.py: 在测试目录中自动发现的模块

第一个内置插件的路径在/Lib/site-packages/_pytest这里,有兴趣的可以看下。

第三个conftest.py我们也很熟悉了,像之前写fixture函数以及本地hooks函数插件,都是在conftest.py中。

第二个外部插件中提到的setuptools是什么呢?

其实这是 pytest 的一个特性库,通过这个setuptools,我们的插件代码可以通过pip安装并上传到PyPI。

本章就来开发一个可以 pip 安装的第三方插件

一、cookiecutter-pytest-plugin

但是在开发之前,先来了解下cookiecutter-pytest-plugin这个项目。这是官方文档中强烈推荐的,可以帮助我们快速生成一个规范标准的插件项目。

项目地址:https://github.com/pytest-dev/cookiecutter-pytest-plugin

跟着项目介绍的文档一步步来就行。

先安装该项目:

$ pip install cookiecutter

然后可以使用这个工具开始创建我们自己的插件项目了。

$ cookiecutter https://github.com/pytest-dev/cookiecutter-pytest-plugin

一步步跟着出现的指令提示,输入对应的项目信息即可。

最后的输入的一个测试插件项目是这样的。

二、开发第三方插件

重新写一个插件,可以通过命令行,来输出搜集到的测试用例的相关信息并保存到csv文件中去。

可以直接在上面生成好的插件项目模板里写我们自己的代码。

  • 红色文件,就是我们插件代码的主体部分
  • 绿色部分,是我们自测插件代码的地方

最后还有个重要文件setup.py,因为插件模板项目自动生成了,里面就是插件项目的相关信息,以及依赖。

1. 插件主体代码

import pytest
import csv
import re pytest_plugins = 'pytester' def pytest_addoption(parser):
group = parser.getgroup("testplan")
group.addoption("--testplan",
action="store",
default=None,
help="生成包含测试元数据的CSV并退出,而不运行测试"
) def pytest_collection_modifyitems(session, config, items):
path = config.getoption('testplan')
if path:
with open(path, mode='w') as fd:
writer = csv.writer(fd, delimiter=',', quotechar='"',
quoting=csv.QUOTE_MINIMAL)
writer.writerow(["title", "description", "markers"]) for item in items:
title = item.nodeid
description = re.sub('\n\s+', '\n', item.obj.__doc__.strip())
markers = ','.join([m.name for m in item.iter_markers()])
writer.writerow([title, description, markers]) pytest.exit(f"测试计划已生成: {path}")
  • pytest_addoption: 添加命令行参数
  • pytest_collection_modifyitems: 重写搜集用例的这个钩子函数

主要就是把搜集到的case的标题,描述和markers这3样写到 csv 文件中。

2. 测试插件代码

插件主体代码写好了,我们需要自测一下。

按之前的话,可以直接把插件代码写到本地conftest文件里作为本地代码直接调用测试即可。

不过 Pytest 附带一个名为pytester的插件,它可以帮助我们为插件代码编写测试。这个插件在默认情况下是禁用的,所以在使用之前要先开启。

在 test 目录下的 conftest 文件中声明即可。

接下来上插件测试代码,然后讲解一下相关用法:

import pytest

def test_pingguo(pytester):
"""Make sure that our plugin works."""
pytester.makeini(
"""
[pytest]
markers =
nightly
performance
integration
high
medium
low
"""
) pytester.makepyfile(
"""
import pytest @pytest.mark.performance
def test_one():
\"""test_one\"""
assert False @pytest.mark.high
def test_two():
\"""test_two\"""
assert True def test_three():
\"""test_three\"""
assert True class TestPingGuo():
@pytest.mark.high
@pytest.mark.performance
def test_a(self):
\"""
TestPingGuo.test_a,测试
\"""
assert False def test_b(self):
\"""
TestPingGuo.test_b
测试
\"""
assert True
"""
) # run all tests with pytest
result = pytester.runpytest("--testplan=testplan.csv")

这里最重要的就是pytester提供的方法,比如上面用到的:

  • pytester.makeini:因为我的测试case上加了不同的 marker,这些是需要注册在 ini 文件里的
  • pytester.makepyfile: 这里就是写的测试用例代码了

其实就是在对应的方法里,写上我们的原生代码,只是需要被""" """包起来,当做字符串,然后 pytest 会自行解析我们的代码,在临时目录里创建对应的文件然后运行。

不仅如此,还可以创建其他的文件,比如conftest。这是源码,有兴趣的可以进去一探究竟。

pytester.runpytest("--testplan=testplan.csv")这里可以添加要执行的命令行参数。

运行测试

直接运行测试代码,看下结果。

注意我这里的文件也是被生成在了临时目录里,打开控制台输出的路径就可以找到。

打开 csv 文件验证一下结果,输出正确。

3. 打包

回到项目根目录,命令行输入:

python setup.py sdist build

完成后会生成dist目录,下面就有对应的包。

4. 上传 pypi

没有账号的要先注册登录一下,记得要去对应填写的邮箱里点击激活认证才可以。

接着安装twine,我能使用这个工具来上传。

pip install twine

安装完成后就可以执行了上传:

twine upload dist/*

提示需要输入注册的账号和密码,最后完成上传。

上传完成后就可以在pypi中打开自己的插件主页了,现在其他小伙伴也可以安装插件了。

【pytest官方文档】解读- 开发可pip安装的第三方插件的更多相关文章

  1. 【pytest官方文档】解读fixtures - 1.什么是fixtures

    在深入了解fixture之前,让我们先看看什么是测试. 一.测试的构成 其实说白了,测试就是在特定的环境.特定的场景下.执行特定的行为,然后确认结果与期望的是否一致. 就拿最常见的登录来说,完成一次正 ...

  2. 【pytest官方文档】解读fixtures - 2. fixtures的调用方式

    既然fixtures是给执行测试做准备工作的,那么pytest如何知道哪些测试函数 或者 fixtures要用到哪一个fixtures呢? 说白了,就是fixtures的调用. 一.测试函数声明传参请 ...

  3. 【pytest官方文档】解读fixtures - 3. fixtures调用别的fixtures、以及fixture的复用性

    pytest最大的优点之一就是它非常灵活. 它可以将复杂的测试需求简化为更简单和有组织的函数,然后这些函数可以根据自身的需求去依赖别的函数. fixtures可以调用别的fixtures正是灵活性的体 ...

  4. Cuda 9.2 CuDnn7.0 官方文档解读

    目录 Cuda 9.2 CuDnn7.0 官方文档解读 准备工作(下载) 显卡驱动重装 CUDA安装 系统要求 处理之前安装的cuda文件 下载的deb安装过程 下载的runfile的安装过程 安装完 ...

  5. 【pytest官方文档】解读- 插件开发之hooks 函数(钩子)

    上一节讲到如何安装和使用第三方插件,用法很简单.接下来解读下如何自己开发pytest插件. 但是,由于一个插件包含一个或多个钩子函数开发而来,所以在具体开发插件之前还需要先学习hooks函数. 一.什 ...

  6. 【pytest官方文档】解读fixtures - 8. yield和addfinalizer的区别(填坑)

    在上一章中,文末留下了一个坑待填补,疑问是这样的: 目前从官方文档中看到的是 We have to be careful though, because pytest will run that fi ...

  7. 【pytest官方文档】解读fixtures - 7. Teardown处理,yield和addfinalizer

    当我们运行测试函数时,我们希望确保测试函数在运行结束后,可以自己清理掉对环境的影响. 这样的话,它们就不会干扰任何其他的测试函数,更不会日积月累的留下越来越多的测试数据. 用过unittest的朋友相 ...

  8. 【pytest官方文档】解读fixtures - 10. fixture有效性、跨文件共享fixtures

    一.fixture有效性 fixture有效性,说白了就是fixture函数只有在它定义的使用范围内,才可以被请求到.比如,在类里面定义了一个fixture, 那么就只能是这个类中的测试函数才可以请求 ...

  9. FluentValidation:C#后端输入验证框架的官方文档解读

    参照 FluentValidation 的官方文档写的例子,方便日后查看和使用. 原文:https://github.com/JeremySkinner/FluentValidation/wiki H ...

随机推荐

  1. 多环境配置 - SpringBoot 2.7.2 实战基础

    优雅哥 SpringBoot 2.7.2 实战基础 - 06 -多环境配置 在一个项目的开发过程中,通常伴随着多套环境:本地环境 local.开发环境 dev.集成测试环境 test.用户接受测试环境 ...

  2. Spring源码 14 IOC refresh方法9

    参考源 https://www.bilibili.com/video/BV1tR4y1F75R?spm_id_from=333.337.search-card.all.click https://ww ...

  3. Navicat的使用与python中使用MySQL的基本方法

    Navicat的使用与python中使用MySQL的基本方法 Navicat的下载及安装 下载地址 http://www.navicat.com.cn/download/navicat-premium ...

  4. 逐层阅读 research paper:Dmitry Berenson 的方法论

    本博客翻译了 这篇文章,包含很实用的 读论文的方法论. 读论文的四个 layers 在读论文之前,要首先搞清楚,自己读论文的目的是什么,或者 希望读到什么程度. 下表列出了常见的读论文目的,以及相应的 ...

  5. identity4 系列————持久化配置篇[五]

    前言 上面已经介绍了3个例子了,并且介绍了如何去使用identity. 但是在前面的例子中,我们使用的都是在内存中操作,那么正式上线可能需要持久到数据库中. 这里值得说明的是,并不一定一定要持久化到数 ...

  6. angr原理与实践(二)—— 各类图的生成(CFG CG ACFG DDG等)

    ​  本文系原创,转载请说明出处 Please Subscribe Wechat Official Account:信安科研人,获取更多的原创安全资讯 上一篇文章介绍了angr的原理,自此篇文章开始, ...

  7. 【ASP.NET Core】自定义Session的存储方式

    在开始今天的表演之前,老周先跟大伙伴们说一句:"中秋节快乐". 今天咱们来聊一下如何自己动手,实现会话(Session)的存储方式.默认是存放在分布式内存中.由于HTTP消息是无状 ...

  8. java项目中VO、DTO以及Entity,各自是在什么情况下应用的

    按照标准来说: entity里的每一个字段,与数据库相对应 vo里的每一个字段,是和你前台页面相对应 dto,这是用来转换从entity到dto,或者从dto到entity的中间的东西 举个例子: h ...

  9. 尝试阅读理解一份linux shell脚本

    以下内容为本人的学习笔记,如需要转载,请声明原文链接微信公众号「englyf」https://www.cnblogs.com/englyf/p/16721350.html 从头一二去阅读语法和命令说明 ...

  10. 使用kubectl命令删除某个目录下所有的yaml文件

    kubectl delete -f .