Pytest + Allure 实现高大上的测试报告

Pytest 是 Python 第三方的测试库。提供了比 unittest 更强大更灵活的测试机制。同时有众多的插件可以实现更多测试场景。

对于 Pytest 的使用不展开来谈,以后会写关于 Pytest 库的使用教程。这里主要展示通过 pytest 和 allure 结合实现漂亮的测试报告。

一份酷炫的报告,有助于提升自动化测试逼格。

先来看看效果:


allure 报告

但是这玩意用起来比较麻烦,在使用过程中有很多的坑。

首先如果你没有安装 pytest 库的话,先使用 pip 安装一下:

pip install pytest

另外还需要安装 pytest 支持 allure 报告的插件库:

pip install allure-pytest

接下来在运行测试时,使用 pytest 命令运行:

pytest <测试目录> --alluredir <测试结果存放目录>

比如,我的文件夹目录如下


文件目录

那么这个命令就应该写为:

pytest tests --alluredir report/allure_raw
  • tests 为测试用例存放目录,告诉 pytest 应该去哪里找用例;
  • report 是存放测试报告的,allure 收集 pytest 运行后产出的结果放在 allure_raw 文件夹中。

注意:这里的 allure_raw 文件夹只存放的是测试运行结果,还不是报告!报告还需要调用 allure 命令去生成。

结果是像这样的:


allure测试结果

还是一堆 txt 和 json 文件。

我们要生成漂亮的报告还需要一步,从 allure 官网上下载最新的 allure 。下载后是一个 zip 文件,把该文件解压后放到我们目录中的 lib 文件夹中。

可以把解压后的 bin 目录添加到环境变量的 PATH 中,可以直接使用 allure 命令

allure

allure 是由 allure 官方提供的命令行工具,用来将测试结果生成测试报告,启动一个服务查看报告等等。是一个必须的命令行工具。

在生成报告前,你可以使用命令先预览报告的内容:

allure serve report/allure_raw

接下来我们就继续使用 allure 密令来生成测试报告。

命令如下:

lib\allure-2.12.1\bin> allure generate <allure测试结果目录> -o <存放报告的目录> --clean
  • allure测试结果目录,是上面运行 pytest 命令后存放结果的地方,我们这里的目录是 report 下的 allure_raw 文件夹;
  • 存放报告的目录,是最终生成的测试报告存放的目录,我打算把生成出的报告放在 report 下的 allure_report文件夹中;
  • --clean参数用来清空已有的报告,避免覆盖时出错。

以我们的例子来生成报告的命令如下:

lib\allure-2.12.1\bin> allure generate report/allure_raw -o report/allure_report --clean

通过上面的命令运行后,就会从 allure_raw 目录中将 pytest 运行的结果生成一个漂亮的报告,存放在 allure_report 中。

allure 报告

然后在 pycharm 中可以通过右键选择index.html就可以看到报告了。

右键浏览器打开

如果你不是用 Pycharm 的话,可以通过 allure 命令生成服务,然后查看。

>allure  open /report/allure_report

运行后会启动一个 web 服务,用于展示报告:


启动一个服务来展示报告

实际跑自动化用例的时候呢,可以和 Jenkins 结合后在 Jenkins 中查看报告。

当然上面的命令很杂,我封装了一个函数,把 pytest 常用的几个插件的用法都加进去了。

  • pytest-xdist 多并发运行,保证测试用例的运行效率。 参数为 -n 并发数,如果并发数为 auto,表示自动根据当前机器的 CPU 内核数量确定并发数;
  • pytest-rerunfailures 测试用例出错后,自动重试。在实际测试过程中,很多时候用例失败可能是因为网络问题,临时的环境问题,而并非真正的 Bug。为了减少(注意是减少不是避免)这种乌龙情况的发生,可以多运行几次用例。参数为--reruns 重试次数

需要安装上述两个库

pip install pytest-xdist
pip install pytest-rerunfailures

点击这里下载示例代码

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

友情链接更多精彩内容