pytest学习和使用-测试报告插件allure-pytest如何使用？

桃扇骨 2023-10-13 18:47 34阅读 0赞

### 1 Allure简介 ###

详细内容可以参考官方文档：https://docs.qameta.io/allure-report/；

![图片][ffc2149fe4edb6015cfb176e27000136.png]

*  `Allure`是一个多语言测试报告工具；
 *  可以使用`Web`形式显示报告内容；
 *  开发/质量保证角度，可以将测试失败划分为bug和损坏的测试，还可以配置log，step，fixture，attachments，timings，历史记录以及与TMS的集成以及Bug跟踪系统；
 *  管理人员角度，Allure提供了一个清晰的“全局”，涵盖了已涵盖的功能，缺陷聚集的位置，执行时间表的外观以及许多其他方便的事情；
 *  Allure的模块化和可扩展性确保您始终能够微调某些东西，以使Allure更适合您。

> **重点：拓展功能需要在测试用例集上加装饰器**。**（后续文章再学习）**

### 2 环境配置 ###

#### 2.1 allure-pytest插件安装 ####

pip3 install allure-pytest

C:\Users\Administrator>pip3 install allure-pytest
    Looking in indexes: https://pypi.tuna.tsinghua.edu.cn/simple
    Requirement already satisfied: allure-pytest in d:\python37\lib\site-packages (2.8.12)
    Requirement already satisfied: six>=1.9.0in d:\python37\lib\site-packages (from allure-pytest) (1.15.0)
    Requirement already satisfied: allure-python-commons==2.8.12in d:\python37\lib\site-packages (from allure-pytest) (2.8.12)
    Requirement already satisfied: pytest>=4.5.0in d:\python37\lib\site-packages (from allure-pytest) (6.2.4)
    Requirement already satisfied: attrs>=16.0.0in d:\python37\lib\site-packages (from allure-python-commons==2.8.12->allure-pytest) (20.3.0)
    Requirement already satisfied: pluggy>=0.4.0in d:\python37\lib\site-packages (from allure-python-commons==2.8.12->allure-pytest) (0.13.1)
    Requirement already satisfied: importlib-metadata>=0.12in d:\python37\lib\site-packages (from pytest>=4.5.0->allure-pytest) (2.1.1)
    Requirement already satisfied: iniconfig in d:\python37\lib\site-packages (from pytest>=4.5.0->allure-pytest) (1.1.1)
    Requirement already satisfied: py>=1.8.2in d:\python37\lib\site-packages (from pytest>=4.5.0->allure-pytest) (1.10.0)
    Requirement already satisfied: packaging in d:\python37\lib\site-packages (from pytest>=4.5.0->allure-pytest) (20.8)
    Requirement already satisfied: colorama in d:\python37\lib\site-packages (from pytest>=4.5.0->allure-pytest) (0.4.4)
    Requirement already satisfied: atomicwrites>=1.0in d:\python37\lib\site-packages (from pytest>=4.5.0->allure-pytest) (1.4.0)
    Requirement already satisfied: toml in d:\python37\lib\site-packages (from pytest>=4.5.0->allure-pytest) (0.10.2)
    Requirement already satisfied: zipp>=0.5in d:\python37\lib\site-packages (from importlib-metadata>=0.12->pytest>=4.5.0->allure-pytest) (1.2.0)
    Requirement already satisfied: pyparsing>=2.0.2in d:\python37\lib\site-packages (from packaging->pytest>=4.5.0->allure-pytest) (2.4.7)

#### 2.2 pytest安装 ####

pip3 install pytest

*  这个不多说了，之前已经安装过了。

#### 2.3 allure文件下载 ####

*  下载地址：https://github.com/allure-framework/allure2/releases；
 *  allure是一个命令行工具；
    
    ![图片][caa032972151b85f157eb6431a7a891d.png]
 *  往下找，找到下载链接，这里使用的`Windows`操作系统，所以下载`zip`文件：
    
    ![图片][c110d3e9f7fa185f281c98fba5dc9e62.png]
 *  如果以上下载比较慢，可以使用以下地址：https://repo.maven.apache.org/maven2/io/qameta/allure/allure-commandline/

#### 2.4 allure环境变量配置 ####

*  下载后解压到本地即可，比如：
    
    ![图片][aff59001545d659b76cb477f21b7e93c.png]

D:\allure-2.21.0\bin

*  然后把以上路径添加到系统环境变量中：
    
    ![图片][3ff41f787826be9e3776adab7b1dcc3a.png]

#### 2.5 配置java环境 ####

*  因为allure是依赖java环境的，所以还需要配置java变量；
 *  详细java环境配置可以直接网上搜索即可，或者查看本文有关java的配置：Jmeter安装配置详细教程。

### 3 查看allure版本 ###

allure --version

C:\Users\Administrator>allure --version
    2.13.2

### 4 运行allure ###

#### 4.1 测试用例 ####

# -*- coding:utf-8 -*-
    # 作者：虫无涯
    # 日期：2023/3/20 
    # 文件名称：test_xxx.py
    # 作用：示例
    # 联系：VX(NoamaNelson)
    # 博客：https://blog.csdn.net/NoamaNelson
    
    import pytest
    import time
    
    class TestCase01():
        def test_case_01(self):
            time.sleep(1)
            print("case01$$$$$$$$$$$$$$$$$$$$$")
    
        def test_case_02(self):
            time.sleep(1)
            print("case02$$$$$$$$$$$$$$$$$$$$$")
    
        def test_case_03(self):
            time.sleep(1)
            print("case03$$$$$$$$$$$$$$$$$$$$$")
    
        def test_case_04(self):
            time.sleep(1)
            print("case04$$$$$$$$$$$$$$$$$$$$$")
    
        def test_case_05(self):
            time.sleep(1)
            print("case05$$$$$$$$$$$$$$$$$$$$$")
    
        def test_case_06(self):
            time.sleep(1)
            print("case06$$$$$$$$$$$$$$$$$$$$$")
    
    class TestCase02():
        def test_case_07(self):
            time.sleep(1)
            print("case07$$$$$$$$$$$$$$$$$$$$$")
    
        def test_case_08(self):
            time.sleep(1)
            print("case08$$$$$$$$$$$$$$$$$$$$$")
    
        def test_case_09(self):
            time.sleep(1)
            print("case08$$$$$$$$$$$$$$$$$$$$$")
    
    
    if __name__ == '__main__':
        pytest.main(["-s", "test_xxx.py"])

#### 4.1 执行方法 ####

*  执行`pytest -n auto --alluredir=xxx/xxx/xxx`来运行查看测试结果，其中`--alluredir`是指定报告存放的路径,比如：

pytest -n auto --alluredir=allure

*  我只运行以上代码，所以我指定了要运行的脚本为：`test_xxx.py`，报告存放路径在当前脚本的路径：

pytest -n auto --alluredir=allure test_xxx.py

*  运行：

gw0 [9] / gw1 [9] / gw2 [9] / gw3 [9] / gw4 [9] / gw5 [9] / gw6 [9] / gw7 [9]
    .........                                                                                               [100%]
    ============================================= 9 passed in4.66s ==============================================

#### 4.3 报告查看方法 ####

*  运行完成后在`test_xxx.py`的相同路径下，生成一个`allure`的文件夹：

![图片][d915aed71ebc58f8604b979cfe081bd0.png]

在这里插入图片描述

*  可以看到有很多文件，我们需要使用`allure`命令来显示测试报告：

![图片][cc8fa6f592f5e287e05915735b05b062.png]

在这里插入图片描述

allure serve allure

(venv) F:\pytest_study\test_case\test_j>allure serve allure
    Generating report to temp directory...
    Report successfully generated to C:\Users\ADMINI~1\AppData\Local\Temp\743714976960418009\allure-report
    Starting web server...
    2023-03-2011:16:28.270:INFO::main: Logging initialized @4392ms to org.eclipse.jetty.util.log.StdErrLog
    Server started at <http://172.16.1.33:13959/>. Press <Ctrl+C> to exit

*  使用以上命令会自动打开报告，如下：
    
    ![图片][81ef03c2e6509a64a2317b59bf60e537.png]

#### 4.4 指定报告生成的端口 ####

*  上边的运行方式，生成的端口是自动的随机的，那如何生成指定端口呢？如下：

allure serve -p 8888 allure

#### 4.5 切换报告语言 ####

![图片][f41d679f54666f463210f95c5cbaaca3.png]

![图片][e3e3c339f8676dc0a2a19790b944b578.png]

![图片][3ea926e816956062e949bdd22805fc45.png]

#### 4.6 查看报告重要信息 ####

*  查看测试套件：
    
    ![图片][b401ce91f8a92b176b9eb6606aa6f350.png]
 *  查看运行图标数据：
    
    ![图片][11d2c68e52785a3a51fe80bbcc65c972.png]
 *  查看用例执行时间：
    
    ![图片][383db54d89464371969f221a933bd3ac.png]
 *  查看用例数据：
    
    ![图片][6c7bb00bdf8b8087a3d4526b494ce08c.png]

### 5 allure报告结构说明 ###

![图片][ab5127bfcfa1a05518f32465b5b37b74.png]

![图片][49fd2226525d075b5382ee1e638753d0.png]

<table> 
 <thead> 
  <tr> 
   <th>字段</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>Overview</code></td> 
   <td>报告总览</td> 
  </tr> 
  <tr> 
   <td><code>Categories</code></td> 
   <td>类别，查看用例执行情况比如&nbsp;<code>failed</code>和<code>error</code></td> 
  </tr> 
  <tr> 
   <td><code>Suites</code></td> 
   <td>测试套件，根据<code>package</code>、<code>module</code>、类、方法来查找用例</td> 
  </tr> 
  <tr> 
   <td><code>Graphs</code></td> 
   <td>测试结果图形 &nbsp;，有分布图，优先级，耗时等</td> 
  </tr> 
  <tr> 
   <td><code>Timeline</code></td> 
   <td>用例运行时间等</td> 
  </tr> 
  <tr> 
   <td><code>Behaviors</code></td> 
   <td>行为驱动， 根据<code>epic、feature、story</code>来分组测试用例</td> 
  </tr> 
  <tr> 
   <td><code>Packages</code></td> 
   <td>按照<code>package</code>、<code>module</code>来分组测试用例</td> 
  </tr> 
 </tbody> 
</table>

**最后：**下方这份完整的软件测试视频教程已经整理上传完成，需要的朋友们可以自行领取**【保证1****00%免费】**

![8b0171187dce405e878f274a8cdd9ec0.png][]

#### **软件测试面试文档** ####

我们学习必然是为了找到高薪的工作，下面这些面试题是来自阿里、腾讯、字节等一线互联网大厂最新的面试资料，并且有字节大佬给出了权威的解答，刷完这一套面试资料相信大家都能找到满意的工作。

![a3e4226c935c4242804cbdf26b571bc6.png][]

![81e382959a4944be842797dd880ceac8.gif][]

[ffc2149fe4edb6015cfb176e27000136.png]: https://img-blog.csdnimg.cn/img_convert/ffc2149fe4edb6015cfb176e27000136.png
[caa032972151b85f157eb6431a7a891d.png]: https://img-blog.csdnimg.cn/img_convert/caa032972151b85f157eb6431a7a891d.png
[c110d3e9f7fa185f281c98fba5dc9e62.png]: https://img-blog.csdnimg.cn/img_convert/c110d3e9f7fa185f281c98fba5dc9e62.png
[aff59001545d659b76cb477f21b7e93c.png]: https://img-blog.csdnimg.cn/img_convert/aff59001545d659b76cb477f21b7e93c.png
[3ff41f787826be9e3776adab7b1dcc3a.png]: https://img-blog.csdnimg.cn/img_convert/3ff41f787826be9e3776adab7b1dcc3a.png
[d915aed71ebc58f8604b979cfe081bd0.png]: https://img-blog.csdnimg.cn/img_convert/d915aed71ebc58f8604b979cfe081bd0.png
[cc8fa6f592f5e287e05915735b05b062.png]: https://img-blog.csdnimg.cn/img_convert/cc8fa6f592f5e287e05915735b05b062.png
[81ef03c2e6509a64a2317b59bf60e537.png]: https://img-blog.csdnimg.cn/img_convert/81ef03c2e6509a64a2317b59bf60e537.png
[f41d679f54666f463210f95c5cbaaca3.png]: https://img-blog.csdnimg.cn/img_convert/f41d679f54666f463210f95c5cbaaca3.png
[e3e3c339f8676dc0a2a19790b944b578.png]: https://img-blog.csdnimg.cn/img_convert/e3e3c339f8676dc0a2a19790b944b578.png
[3ea926e816956062e949bdd22805fc45.png]: https://img-blog.csdnimg.cn/img_convert/3ea926e816956062e949bdd22805fc45.png
[b401ce91f8a92b176b9eb6606aa6f350.png]: https://img-blog.csdnimg.cn/img_convert/b401ce91f8a92b176b9eb6606aa6f350.png
[11d2c68e52785a3a51fe80bbcc65c972.png]: https://img-blog.csdnimg.cn/img_convert/11d2c68e52785a3a51fe80bbcc65c972.png
[383db54d89464371969f221a933bd3ac.png]: https://img-blog.csdnimg.cn/img_convert/383db54d89464371969f221a933bd3ac.png
[6c7bb00bdf8b8087a3d4526b494ce08c.png]: https://img-blog.csdnimg.cn/img_convert/6c7bb00bdf8b8087a3d4526b494ce08c.png
[ab5127bfcfa1a05518f32465b5b37b74.png]: https://img-blog.csdnimg.cn/img_convert/ab5127bfcfa1a05518f32465b5b37b74.png
[49fd2226525d075b5382ee1e638753d0.png]: https://img-blog.csdnimg.cn/img_convert/49fd2226525d075b5382ee1e638753d0.png
[8b0171187dce405e878f274a8cdd9ec0.png]: https://img-blog.csdnimg.cn/8b0171187dce405e878f274a8cdd9ec0.png
[a3e4226c935c4242804cbdf26b571bc6.png]: https://img-blog.csdnimg.cn/a3e4226c935c4242804cbdf26b571bc6.png
[81e382959a4944be842797dd880ceac8.gif]: https://img-blog.csdnimg.cn/81e382959a4944be842797dd880ceac8.gif