详解用详解用Pytest+Allure生成漂亮的生成漂亮的HTML图形化测试报告图形化测试报告
对于软件测试工作来说,测试报告是非常重要的工作产出。一个漂亮、清晰、格式规范、内容完整的测试报告,既能最大化我们的测试工作产出,又能够减少开发人员和测试人员的
沟通成本。
本篇文章将介绍如何使用开源的测试报告生成框架Allure生成规范、格式统一、美观的测试报告。
通过这篇文章的介绍,你将能够:
将Allure与Pytest测试框架相结合;
如何定制化测试报告内容
执行测试之后,生成Allure格式的测试报告。
如何与Jenkins集成。
将测试环境信息展示到测试报告中。
1、、Allure测试报告介绍测试报告介绍
Allure是一款轻量级并且非常灵活的开源测试报告框架。 它支持绝大多数测试框架, 例如TestNG、Pytest、JUint等。它简单易用,易于集成。下面就Pytest如何与Allure集成做详细
介绍。
2、、Pytest框架集成框架集成Allure
Pytest是Python的单元测试框架,非常方便和易用。强烈推荐对于用Python进行测试工作的小伙伴使用这个测试框架,相比与Python自带的UnitTest好用太多太多。这篇文章我不会
介绍太多Pytest测试框架的使用,今天主要是介绍如何将测试报告生成工具Allure集成到Pytest中。
2.1 安装安装Allure Pytest Plugin
allure-pytest是Pytest的一个插件,通过它我们可以生成Allure所需要的用于生成测试报告的数据。安装allure-pytest插件方法:
$ pip install allure-pytest
2.2 改造基于改造基于Pytest的测试用例的测试用例
allure-pytest的官方文档中详细介绍了allure-pytest所具有的功能。本篇文章不会再翻译一遍,而是从实际入手,给大家介绍如何将其应用到自己的框架中。
为了使用Allure生成报告,需要在测试脚本中加入Allure特性。而这个操作并不会对原有的测试用例逻辑产生任何变动。
直接看下面的脚本,我通过在脚本中添加注释的方式给大家解释allure特性的用途。比如测试脚本是test_shopping_trolley.py:
#!/usr/bin/env python
# coding=utf-8
import pytest
import allure
@allure.feature('购物车功能') # 用feature说明产品需求,可以理解为JIRA中的Epic
class TestShoppingTrolley(object):
@allure.story('加入购物车') # 用story说明用户场景,可以理解为JIRA中的Story
def test_add_shopping_trolley(self):
login('刘春明', '密码') # 步骤1,调用“step函数”
with allure.step("浏览商品"): # 步骤2,step的参数将会打印到测试报告中
allure.attach('笔记本', '商品1') # attach可以打印一些附加信息
allure.attach('手机', '商品2')
with allure.step("点击商品"): # 步骤3
pass
with allure.step("校验结果"): # 步骤4
allure.attach('添加购物车成功', '期望结果')
allure.attach('添加购物车失败', '实际结果')
assert 'success' == 'failed'
@allure.story('修改购物车')
def test_edit_shopping_trolley(self):
pass
@pytest.mark.skipif(reason='本次不执行')
@allure.story('删除购物车中商品')
def test_delete_shopping_trolley(self):
pass
@allure.step('用户登录') # 将函数作为一个步骤,调用此函数时,报告中输出这个步骤,我把这样的函数叫“step函数”
def login(user, pwd):
print(user, pwd)
上面使用了Allure的几个特性:
@allure.feature # 用于描述被测试产品需求
@allure.story # 用于描述feature的用户场景,即测试需求
with allure.step # 用于描述测试步骤,将会输出到报告中
allure.attach # 用于向测试报告中输入一些附加的信息,通常是一些测试数据,截图等
@pytest.allure.step # 用于将一些通用的函数作为测试步骤输出到报告,调用此函数的地方会向报告中输出步骤
3、生成、生成Allure测试报告测试报告
测试脚本中添加了Allure特性之后,可以通过两步,就可以展示出测试报告了。
第一步,生成测试报告数据第一步,生成测试报告数据
在py.test执行测试的时候,指定–alluredir选项及结果数据保存的目录:
$ py.test test/ --alluredir ./result/
./result/中保存了本次测试的结果数据。另外,还可以执行指定features或者stories执行一部分测试用例,比如执行”购物车功能“下的”加入购物车“子功能的测试用例:
$ py.test test/ --allure_features='购物车功能' --allure_stories='加入购物车'
第二步,生成测试报告页面第二步,生成测试报告页面
通过下面的命令将./result/目录下的测试数据生成测试报告页面:
$ allure generate ./result/ -o ./report/ --clean
评论5