用 Pytest+Allure 生成漂亮的 HTML 图形化测试报告

简介: 本篇文章将介绍如何使用开源的测试报告生成框架 Allure 生成规范、格式统一、美观的测试报告。通过这篇文章的介绍,你将能够:- 将 Allure 与 Pytest 测试框架相结合;- 如何定制化测试报告内容- 执行测试之后,生成 Allure 格式的测试报告。Allure 是一款非常轻量级并且非常灵活的开源测试报告生成框架。它支持绝大多数测试框架, 例如 TestNG、Pytest、

本篇文章将介绍如何使用开源的测试报告生成框架 Allure 生成规范、格式统一、美观的测试报告。
通过这篇文章的介绍,你将能够:

  • 将 Allure 与 Pytest 测试框架相结合;
  • 如何定制化测试报告内容
  • 执行测试之后,生成 Allure 格式的测试报告。

Allure 是一款非常轻量级并且非常灵活的开源测试报告生成框架。它支持绝大多数测试框架, 例如 TestNG、Pytest、JUint 等。它简单易用,易于集成。下面就 Pytest 如何与 Allure 集成做详细介绍。
Pytest 是 Python 的单元测试框架,非常方便和易用。强烈推荐对于用 Python 进行测试工作的小伙伴使用这个测试框架,相比与 Python 自带的 UnitTest 好用太多太多。今天我们主要是介绍如何将测试报告生成工具 Allure 集成到 Pytest 中。
Allure Pytest Adaptor 是 Pytest 的一个插件,通过它我们可以生成 Allure 所需要的用于生成测试报告的数据。安装 pytest-allure-adaptor 插件方法:
pytest-allure-adaptor 官网中详细介绍了 pytest-allure-adaptor 所具有的功能。本篇文章不会再翻译一遍,而是从实际入手,给大家介绍如何将其应用到自己的框架中。
为了使用 Allure 生成报告,需要在 conftest.py 和测试脚本中加入 Allure 特性。
首先,conftest.py 中可以通过 allure.environment 方法将测试环境的信息输出到报告中,比如将测试时用的 host 和测试用的 browser 添加到测试报告中:
接着,在测试脚本中,添加 allure 特性,直接看下面的脚本,我通过在脚本中添加注释的方式给大家解释 allure 特性的用途。比如测试脚本是
test_shopping_trolley.py:
上面使用了Allure的几个特性:

  • @allure.feature # 用于定义被测试的功能,被测产品的需求点
  • @allure.story # 用于定义被测功能的用户场景,即子功能点
  • with allure.step # 用于将一个测试用例,分成几个步骤在报告中输出
  • allure.attach # 用于向测试报告中输入一些附加的信息,通常是一些测试数据信息
  • @pytest.allure.step # 用于将一些通用的函数作为测试步骤输出到报告,调用此函数的地方会向报告中输出步骤

测试脚本中添加了 Allure 特性之后,在执行测试的时候需要先生成 Allure 报告所需要的测试结果数据。在 py.test 执行测试的时候,指定 –alluredir 选项及测试数据保存的目录即可:
./result/ 中保存了本次测试的结果数据。另外,还可以执行指定 features 或者 stories 执行一部分测试用例,比如执行‘购物车功能’下的‘加入购物车’子功能的测试用例:
接下来我们可以利用上面命令产生的测试数据生成 Allure 测试报告了。生成 Allure 测试报告有两种方式:一个是命令行方式,一个是利用 Jenkins 插件。下面分别介绍。
首先需要安装命令行工具,如果是 Mac 电脑,推荐使用 Homebrew 安装。
安装完成后,通过下面的命令将 ./result/ 目录下的测试数据生成测试报告:
这样在 ./report/ 目录下就生成了 Allure 的测试报告了。–clean 目的是先清空测试报告目录,再生成新的测试报告。
通过下面的命令打开测试报告:
本机的浏览器将打开网页
http://127.0.0.1:8083/index.html
展示测试报告。
打开生成的测试报告后,浏览器被自动调起,展示测试报告。下面我们分别看看测试报告的几个页面。

  1. 首页

首页中展示了本次测试的测试用例数量,成功用例、失败用例、跳过用例的比例,测试环境信息,SUITES,FEATURES BY STORIES等基本信息,当与Jenkins做了持续置成后,TREND区域还将显示,历次测试的通过情况。
首页的左边栏,还从不同的维度展示测试报告的其他信息,大家可以自己点进去看看。

  1. Behaviors

接下来,我们点击一下FEATURES BY STORIES,将进入Behaviors页面,这个页面按照FEATURES和 STORIES展示测试用例的执行结果:
从这个页面可以看到“购物车功能”这个FEATURES包含的三个STORIES的测试用例执行情况。

  1. Suites

Allure测试报告将每一个测试脚本,作为一个Suite。在首页点击Suites区域下面的任何一条Suite,都将进入Suites页面。
这个页面,将脚本的目录结果展示本次所有的测试用例执行情况。

  1. 测试用例页面

在Suites页面上点击任何一条测试用例,Suites页面的右侧将展示这条用例的详细执行情况。

从这个页面可以看到测试用例执行的每一个步骤,以及每个步骤的执行结果。测试用例为什么失败,这里一目了然。
首先需要给Jenkins安装Allure Plugin。在Jenkins的插件管理页面,搜索“allure”,在搜索结果页,选择“Allure Jenkins Plugin”进行安装。
安装完成之后重启一下Jenkins。在Jenkins的“全局工具管理”页面,找到Allure Commandline模块进行安装:
点击后,弹出下面的页面,输入Allure的命令别名和版本后,点击Apply 和Save。

按照下面的图示,在Excute Shell和构建后操作部分写上对应的配置信息,即可。
这样,我们的Jenkins Job执行完测试用例时候,将在Job的主页面上看到Allure Report图标,点击进去就看到了Allure Report报告。
团队内部可能不同项目使用的测试框架不一样,每个测试框架生成的测试报告也不一样。但由于 Allure 报告支持很多测试框架,通过 Allure 可以生成格式一致的测试报告,这就对外提供格式一致的测试报告提供了方便。
建议:团队内部都采用 Allure 生成测试报告。由于团队内部有的项目采用的 Java+TestNG 的测试架构,后面有时间,也介绍一下如何在 TestNG 框架如何集成 Allure。

相关文章
|
5月前
|
存储 设计模式 测试技术
怎么基于Pytest+Requests+Allure实现接口自动化测试?
该文介绍了一个基于Python的自动化测试框架,主要由pytest、requests和allure构成,采用关键字驱动模式。项目结构分为六层:工具层(api_keyword)封装了如get、post的请求;参数层(params)存储公共参数;用例层(case)包含测试用例;数据驱动层(data_driver)处理数据;数据层(data)提供数据;逻辑层(logic)实现用例逻辑。代码示例展示了如何使用allure装饰器增强测试报告,以及如何使用yaml文件进行数据驱动。
180 0
|
1月前
|
测试技术
自动化测试项目学习笔记(五):Pytest结合allure生成测试报告以及重构项目
本文介绍了如何使用Pytest和Allure生成自动化测试报告。通过安装allure-pytest和配置环境,可以生成包含用例描述、步骤、等级等详细信息的美观报告。文章还提供了代码示例和运行指南,以及重构项目时的注意事项。
176 1
自动化测试项目学习笔记(五):Pytest结合allure生成测试报告以及重构项目
|
1月前
|
测试技术 Python
自动化测试项目学习笔记(四):Pytest介绍和使用
本文是关于自动化测试框架Pytest的介绍和使用。Pytest是一个功能丰富的Python测试工具,支持参数化、多种测试类型,并拥有众多第三方插件。文章讲解了Pytest的编写规则、命令行参数、执行测试、参数化处理以及如何使用fixture实现测试用例间的调用。此外,还提供了pytest.ini配置文件示例。
26 2
|
2月前
|
SQL JavaScript 前端开发
基于Python访问Hive的pytest测试代码实现
根据《用Java、Python来开发Hive应用》一文,建立了使用Python、来开发Hive应用的方法,产生的代码如下
70 6
基于Python访问Hive的pytest测试代码实现
|
3月前
|
前端开发 关系型数据库 测试技术
django集成pytest进行自动化单元测试实战
在Django项目中集成Pytest进行单元测试可以提高测试的灵活性和效率,相比于Django自带的测试框架,Pytest提供了更为丰富和强大的测试功能。本文通过一个实际项目ishareblog介绍django集成pytest进行自动化单元测试实战。
50 3
django集成pytest进行自动化单元测试实战
|
3月前
|
Web App开发 安全 测试技术
自动化测试中的Python魔法:使用Selenium和pytest框架
【8月更文挑战第31天】 在软件开发的海洋中,自动化测试是确保航行安全的灯塔。本文将带你探索如何利用Python语言结合Selenium和pytest框架,搭建一套高效的自动化测试体系。我们将从基础设置讲起,逐步深入到编写测试用例,最后通过一个实战案例来展示如何在实际项目中运用这些工具。文章旨在为读者提供一套清晰的自动化测试解决方案,让你的开发之旅更加顺畅。
|
4月前
|
Shell Python
`pytest-httpserver`是一个pytest插件,它允许你在测试期间启动一个轻量级的HTTP服务器,并模拟HTTP请求和响应。
`pytest-httpserver`是一个pytest插件,它允许你在测试期间启动一个轻量级的HTTP服务器,并模拟HTTP请求和响应。
|
4月前
|
监控 Python
`pytest-qt` 是一个用于在 Qt 应用程序中进行 GUI 测试的 pytest 插件。
`pytest-qt` 是一个用于在 Qt 应用程序中进行 GUI 测试的 pytest 插件。
|
6月前
|
测试技术 iOS开发
pytest Mark标记测试用例
使用`pytest.mark`进行测试用例分组和筛选,如`@pytest.mark.webtest`。通过`pytest -m`参数执行特定标记的用例,例如`pytest -s test_command_param.py -m webtest`。同时,pytest支持内置的skip、skipif和xfail功能来管理特殊用例:skip始终跳过,skipif条件满足时跳过,xfail则标记预期失败的测试。
|
Web App开发 XML 测试技术
pytest进阶之html测试报告
pytest进阶之html测试报告前言  Pytest系列已经写了几篇文章了,也不知道对多少人有帮助,总之对于我自己来说该掌握的都已经掌握了,那么今天我们再来说说pytest如何生成一个完整的html测试报告,让你在吹牛逼的路上再多一份资本!废话不多说,进入正题!(咋就莫名其妙想起这句话了呢, 估计看文章看多了,貌似挺多人用这句话过度……) 使用pytest-html插件生成测试报告 pytest-html生成报告pytest是借助pytest-html插件生成测试测试报告, 不用自己编写生成报告代码。
3927 0