pytest+allure(allure-pytest基于这个插件)设计定制化报告

刺骨的言语ヽ痛彻心扉 2023-06-03 06:59 66阅读 0赞

## 一：环境准备 ##

*  1.python3.6
 *  2.windows环境
 *  3.pycharm
 *  4.allure-pytest
 *  5.allure2.8.0
 *  6.java1.8

allure-pytest快速安装

在cmd中输入 pip install allure-pytest，回车

## 二：报告生成 ##

**第1步：下载allure.zip，下载地址：allure-github: https://github.com/allure-framework/allure2 ，找到对应版本，并下载**

![723253-20181106140610646-924947957.png][]

![723253-20181106140656866-1339758009.png][]

**第2步：解压allure.zip，将路径添加环境变量，path中，记得需要重启电脑**

![723253-20181106140806414-644054338.png][]

![723253-20181106140913127-1299052347.png][]

**第3步：验证allure,在cmd中输入allure,然后回车，如果可以看到一下，说明配置完成**

![723253-20181106141103853-1911670441.png][]

**第4步：运行测试用例 pytest.main(\["-m","login","-s","-q","--alluredir=./report"\])**

**"-m": 标记用例**

**"login": 被标记需要执行用例**

**"-s":允许终端在测试运行时输出某些结果，例如你想输入print的内容，可以加上-s**

**"-q"简化输出结果**

**"--alluredir": 生成allure指定语法**

**"./report":生成报告的路径**

**"--clean-alluredir" ：因为这个插件库allure-pytest生成的报告文件，你第二次运行时候不会清理掉里面的东西，所以你需要删除这个report文件夹，然后运行重新新建reoprt文件夹**

**说明：运行后，会在report文件夹里面生成文件**

## 三.allure定制化报告 ##

**第1步：一些词语解释**

一、feature: 标注主要功能模块。  
二、story: 标注Features功能模块下的分支功能。  
三、severity: 标注测试用例的重要级别。

1）blocker级别：中断缺陷（客户端程序无响应，无法执行下一步操作）  
2）critical级别：临界缺陷（功能点缺失）  
3）normal级别：正常 默认为这个级别  
4）minor级别：次要缺陷（界面错误与UI需求不符）  
5）trivial级别：轻微缺陷（必输项无提示，或者提示不规范）

四、step: 标注测试用例的重要步骤。

五、attach：用于向测试报告中输入一些附加的信息，通常是一些测试数据信息。

![723253-20190809102633258-117445792.png][]

1）name就是附件名称，body就是数据，attachment\_type就是传类型

2）附件支持的类型（TEXT，HTML，XML，PNG，JPG，JSON，OTHER）

六、issue：这里传的是一个连接，记录的是你的问题。

七、testcase：这里传的是一个连接，记录的是你的用例。

八、description：描述用例信息

**第2步：代码展示\+报表展示**

feature方法的演示

代码：

1 import pytest,allure
     2 @allure.feature("测试")      #标记代码
     3 class Test_Demo():
     4 
     5     # @allure.story("test_demo_1")
     6     # @allure.severity("trivial")
     7     def test_demo_1(self):
     8         # """
     9         # 用例描述：22222222222222
    10         # """
    11         #allure.MASTER_HELPER.description("11111111111111")
    12         assert 1 == 1

报告展示：

![723253-20190808164314699-1280644611.png][]

![723253-20190808164151613-1791778903.png][]

story方法的演示

代码：

1 import pytest,allure
     2 @allure.feature("测试")
     3 class Test_Demo():
     4 
     5     @allure.story("test_demo_1")      #标记代码
     6     # @allure.severity("trivial")
     7     def test_demo_1(self):
     8         # """
     9         # 用例描述：22222222222222
    10         # """
    11         #allure.MASTER_HELPER.description("11111111111111")
    12         assert 1 == 1
    13     @allure.story("test_demo_4")       标记代码
    14     #@allure.severity("minor")
    15     def test_demo_4(self):
    16         assert 3 == 3

报告展示：

![723253-20190808165522518-1889508678.png][]

severity方法的演示：

代码：

1 import pytest,allure
     2 @allure.feature("测试")
     3 class Test_Demo():
     4 
     5     #@allure.story("test_demo_1")
     6     @allure.severity("trivial")           #标记代码
     7     def test_demo_1(self):
     8         # """
     9         # 用例描述：22222222222222
    10         # """
    11         #allure.MASTER_HELPER.description("11111111111111")
    12         assert 1 == 1
    13     #@allure.story("test_demo_4")
    14     @allure.severity("minor")              #标记代码
    15     def test_demo_4(self):
    16         assert 3 == 3

报告展示：

![723253-20190808165821747-383550271.png][]

setp方法的演示：

1.总的步骤备注

代码：

1 import pytest,allure
     2 @allure.feature("测试")
     3 class Test_Demo():
     4 
     5     #@allure.story("test_demo_1")
     6     #@allure.severity("trivial")
     7     @allure.step("这是两个负数的比较")      #标记代码
     8     def test_demo_1(self):
     9         # """
    10         # 用例描述：22222222222222
    11         # """
    12         #allure.MASTER_HELPER.description("11111111111111")
    13         assert -1 == -1
    14     #@allure.story("test_demo_4")
    15     #@allure.severity("minor")
    16     @allure.step("这是两个整数的比较")      #标记代码
    17     def test_demo_4(self):
    18         assert 3 == 3

报告展示：

![723253-20190808170048002-436547708.png][]

2.分步骤备注

代码：

1 import pytest,allure
     2 @allure.feature("测试")
     3 class Test_Demo():
     4 
     5     #@allure.story("test_demo_1")
     6     #@allure.severity("trivial")
     7     #@allure.step("这是两个负数的比较")
     8     def test_demo_1(self):
     9         # """
    10         # 用例描述：22222222222222
    11         # """
    12         #allure.MASTER_HELPER.description("11111111111111")
    13         assert -1 == -1
    14     #@allure.story("test_demo_4")
    15     #@allure.severity("minor")
    16     #@allure.step("这是两个整数的比较")
    17     def test_demo_4(self):
    18         with allure.step("赋值一个变量a"):     #标记代码
    19             a=1
    20         with allure.step("赋值一个变量b"):     #标记代码
    21             b=1
    22         assert a == b

报表展示：

![723253-20190808171604762-2099102982.png][]

attach方法的演示：

代码：

1 import pytest,allure
     2 @allure.feature("测试")
     3 class Test_Demo():
     4 
     5     #@allure.story("test_demo_1")
     6     #@allure.severity("trivial")
     7     #@allure.step("这是两个负数的比较")
     8     def test_demo_1(self):
     9         # """
    10         # 用例描述：22222222222222
    11         # """
    12         #allure.MASTER_HELPER.description("11111111111111")
    13         assert -1 == -1
    14     #@allure.story("test_demo_4")
    15     #@allure.severity("minor")
    16     #@allure.step("这是两个整数的比较")
    17     def test_demo_4(self):
    18         a = 1
    19         allure.attach("{0}".format(a),"预期结果")    #标记代码    第一个参数是body，第二个参数是name
    20         b=1
    21         allure.attach("{0}".format(b),"实际结果")　　#标记代码
    22         assert a == b

报告展示：

![723253-20190808174442344-1606946131.png][]

图片附件形式：

代码：

1 import pytest,allure
     2 @allure.feature("测试")
     3 class Test_Demo():
     4 
     5     @allure.story("test_demo_1")
     6     @allure.severity("trivial")
     7     def test_demo_1(self):
     8         assert 1 == 1
     9 
    10     def test_demo_3(self):
    11         """
    12             用例描述：这里是两个数字是否相等
    13         """
    14         a = 3
    15         b = 3
    16         with open(r"G:\Web_automation\Learn_pytest\test_cases\img\2.jpg","rb") as file:          #标记代码，需要先打开图片
    17             file=file.read()　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　 #标记代码，读取图片
    18             allure.attach(file,"预期结果",attachment_type=allure.attachment_type.JPG)　　　　　　　　#标记代码
    19         assert a == b

报告展示：

![723253-20190808213942137-1883892014.png][]

issue和testcase方法的演示：

代码：

1 import pytest,allure
     2 @allure.feature("测试")
     3 class Test_Demo():
     4 
     5     @allure.story("test_demo_1")
     6     @allure.testcase("https://home.cnblogs.com/")
     7     def test_demo_1(self):
     8         assert 1 == 1
     9 
    10     @allure.testcase("https://home.cnblogs.com/","测试用例地址请点击跳转")     #标记代码，你可以指定连接的名字，报告里面就会现在这个名字的连接
    11     @allure.issue("http://www.baidu.com")　　　　　　　　　　　　　　　　　　　　　#标记代码，哪个写在后，在报告里面就会显示在前面
    12     def test_demo_4(self):
    13          assert 3 == 3

报表展示：

![723253-20190808215049469-1912895928.png][]

description方法的演示：

代码：（这两种备注方式不能同时是存在，如果同时存在他会先使用description的，而不取3引号的）

1 import pytest,allure
     2 @allure.feature("测试")
     3 class Test_Demo():
     4 
     5 
     6     @allure.story("test_demo_1")
     7     @allure.testcase("https://home.cnblogs.com/")
     8     def test_demo_1(self):
     9         assert 1 == 1
    10 
    11     @allure.description("这里是两个3的比较")             #标记代码，优先取这个
    12     def test_demo_4(self):
    13         """
    14             用例描述：这里是两个数字是否相等　　　　　　　　　#如果没有description，那么就取3引号的
    15         """
    16         assert 3 == 3

报告演示：

![723253-20190808220111771-704327443.png][]

## 四.报告显示 ##

**报告显示方法一：**

**第1步：以上运行之后，可以在CMD中运行命令**

allure generate report -o html --clean

**report是alluredir生成的xml目录，html是最终生成html的目录**

**第2步：运行命令后，可以在html路径下看到生成的数据，其中index.html就是我们要的allure报告，你可以在pycharm里面打开，报告展示如下**

**![723253-20190425154623469-440797251.png][]**

![723253-20181106141257467-402158096.png][]

**报告显示方法二(这种相当于是调试)：**

**第1步：以上运行之后，可以在CMD中运行命令**

allure serve report (report是alluredir生成的xml目录)

运行后，浏览器会自动跳转到allure report界面

![723253-20190805153016989-860734626.png][]

## 四.pytest+allure+jenkins集成 ##

参考我另外的一个博客文章：[https://www.cnblogs.com/hao2018/p/11135180.html][https_www.cnblogs.com_hao2018_p_11135180.html]

注意：在本地运行的时候需要手动把代码拷贝到jenkins目录下面的workspace文件夹里面；如果在git或svn上运行，jekins会直接把代码拷贝到workspace目录 ,如果jenkins是指定工作目录就不用管了

转载于:https://www.cnblogs.com/hao2018/p/11321959.html

[723253-20181106140610646-924947957.png]: /images/20230601/d721fabf974e4570b851c8067739d3d9.png
[723253-20181106140656866-1339758009.png]: /images/20230601/c8b816ca6f584bfea8c1665aa7458ca9.png
[723253-20181106140806414-644054338.png]: /images/20230601/a3cf28532d1b43a5be9dbc3c6aab46be.png
[723253-20181106140913127-1299052347.png]: /images/20230601/d044b5649ab246a78e3e333cf88dc37e.png
[723253-20181106141103853-1911670441.png]: /images/20230601/ecdfe059d43943a89961ad961cf453b0.png
[723253-20190809102633258-117445792.png]: /images/20230601/54b26121d3f04f028dfe66b9196f6e76.png
[723253-20190808164314699-1280644611.png]: /images/20230601/d6d82093978b43cf9ce68b2f06d32131.png
[723253-20190808164151613-1791778903.png]: /images/20230601/949ecd9b972e4f73a7adb726c18ae5a3.png
[723253-20190808165522518-1889508678.png]: /images/20230601/cfd2fbec9dee40309ffa0d77baa40cf8.png
[723253-20190808165821747-383550271.png]: /images/20230601/1134041aeab449df9ea434cd31b4c52c.png
[723253-20190808170048002-436547708.png]: /images/20230601/d5d2c5badd084fbd86b5be9a805debce.png
[723253-20190808171604762-2099102982.png]: /images/20230601/1a564789e3c84665a940243186ab6e86.png
[723253-20190808174442344-1606946131.png]: /images/20230601/1db8d37dff4b42dba6c0f2d175d95f8c.png
[723253-20190808213942137-1883892014.png]: /images/20230601/074a87fa1d304f9dab2bd0e57d2017cb.png
[723253-20190808215049469-1912895928.png]: /images/20230601/d6e4e2b3a3fc42579a42285dfb45bab5.png
[723253-20190808220111771-704327443.png]: /images/20230601/c9b845d8fa3e45c4beb523628ad49654.png
[723253-20190425154623469-440797251.png]: /images/20230601/6009fdb41ecd4244b6a58420581bcf07.png
[723253-20181106141257467-402158096.png]: /images/20230601/2564dc8166d542ac814659ea9bcd6542.png
[723253-20190805153016989-860734626.png]: /images/20230601/4c07b14ce78f464699eafe6b61eeea90.png
[https_www.cnblogs.com_hao2018_p_11135180.html]: https://www.cnblogs.com/hao2018/p/11135180.html