用Pytest+Allure生成可视化的HTML测试报告

以你之姓@ 2022-03-22 15:51 643阅读 0赞

**目录**

一、安装Allure

1、Allure2.7.0下载

2、解压

3、环境变量配置

4、检查是否安装成功：

二、安装allure-pytest

三、安装pytest-html

四、实例代码

五、生成html报告

1、运行命令

2、生成html报告命令

3、成功测试结果

4、失败测试结果：

5、成功和失败测试对应的代码：

6、查看html报告

六、Jenkins集成Allure插件

1、安装Allure Jenkins Plugin插件

2、配置Allure Commandline

3、配置

4、html报告

七、Jenkins发送邮件配置

--------------------

Allure Pytest Adaptor是Pytest的一个插件，通过它我们可以生成Allure所需要的用于生成测试报告的数据。

前提：配置好Java环境，安装好pytest，可参考：[https://blog.csdn.net/wust\_lh/article/details/86545697][https_blog.csdn.net_wust_lh_article_details_86545697]

写在最前：由于pytest-allure-adaptor版本原因，导致安装配置好后程序一直报错，如图所示错误，尝试了好多类似的方法均没有解决，很是苦恼。后来想到受[https://www.kancloud.cn/guanfuchang/python\_selenium/714653][https_www.kancloud.cn_guanfuchang_python_selenium_714653]启发，想到可能是allure版本原因造成的，于是将安装命令改为：pip install allure-pytest，安装成功后发现问题解决了。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1c3RfbGg_size_16_color_FFFFFF_t_70][]

本文认为：网上目前大多教程使用命令：pip install pytest-allure-adaptor是针对allure1的版本安装的，针对allure2安装则使用pip install allure-pytest。

## 一、安装Allure ##

### 1、Allure2.7.0下载 ###

下载地址：[https://github.com/allure-framework/allure2/releases/tag/2.7.0][https_github.com_allure-framework_allure2_releases_tag_2.7.0]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1c3RfbGg_size_16_color_FFFFFF_t_70 1][]

### 2、解压 ###

将下载的压缩包解压：

### 3、环境变量配置 ###

在变量PATH中添加bin目录的路径，如本文压缩包解压路径：D:\\soft\\allure-2.7.0\\bin

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1c3RfbGg_size_16_color_FFFFFF_t_70 2][]

### 4、检查是否安装成功： ###

查看安装版本命令：allure --version

![20190129100044655.png][]

## 二、安装allure-pytest ##

1、安装命令：pip install allure-pytest

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1c3RfbGg_size_16_color_FFFFFF_t_70 3][]

2、安装pyyaml：pip install pyyaml，在python代码中，import allure会出错，需安装pyyaml

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1c3RfbGg_size_16_color_FFFFFF_t_70 4][]

## 三、安装pytest-html ##

安装命令：pip install pytest-html

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1c3RfbGg_size_16_color_FFFFFF_t_70 5][]

## 四、实例代码 ##

test\_feature.py

# -*- coding: utf-8 -*-
    
    # @File    : test_case.py
    
    import allure
    
    import pytest
    
    
    
    
    
    @allure.feature('test_module_01')
    
    def test_case_01():
    
        """
    
        用例描述：Test case 01
    
        """
    
        assert 0 == 0
    
    
    
    
    
    @allure.feature('test_module_02')
    
    def test_case_02():
    
        """
    
        用例描述：Test case 02
    
        """
    
        assert 0 == 0
    
    
    
    
    
    if __name__ == '__main__':
    
        pytest.main(['-s', '-q', '--alluredir', './report/xml'])

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1c3RfbGg_size_16_color_FFFFFF_t_70 6][]

## 五、生成html报告 ##

### 1、运行命令 ###

pytest D:\\workspaces\\python\\allurePython\\test\_feature.py --alluredir=./allure-results/

### 2、生成html报告命令 ###

allure generate report/ -o allure-reports/

### 3、成功测试结果 ###

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1c3RfbGg_size_16_color_FFFFFF_t_70 7][]

### 4、失败测试结果： ###

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1c3RfbGg_size_16_color_FFFFFF_t_70 8][]

### 5、成功和失败测试对应的代码： ###

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1c3RfbGg_size_16_color_FFFFFF_t_70 9][]

此时，可以看到，在allurePython目录下多了两个文件夹，allure-reports目录下为生成的allure的html报告

![20190129100256503.png][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1c3RfbGg_size_16_color_FFFFFF_t_70 10][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1c3RfbGg_size_16_color_FFFFFF_t_70 11][]

### 6、查看html报告 ###

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1c3RfbGg_size_16_color_FFFFFF_t_70 12][]

## 六、Jenkins集成Allure插件 ##

### 1、安装Allure Jenkins Plugin插件 ###

![20190129100400331.png][]

### 2、配置Allure Commandline ###

勾选自动安装，配置好name和版本号

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1c3RfbGg_size_16_color_FFFFFF_t_70 13][]

### 3、配置 ###

还是以“四、实例代码”为例，配置构建操作和构建后操作

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1c3RfbGg_size_16_color_FFFFFF_t_70 14][]

### 4、html报告 ###

同“五、生成html”中的报告

## 七、Jenkins发送邮件配置 ##

配置方法参考：[https://blog.csdn.net/wust\_lh/article/details/86573797][https_blog.csdn.net_wust_lh_article_details_86573797]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1c3RfbGg_size_16_color_FFFFFF_t_70 15][]

（1）将Default Content改为：

$PROJECT_NAME - Build # $BUILD_NUMBER - $BUILD_STATUS:
    
    
    
    Check console output at ${BUILD_URL}allure/ to view the results.

（2）Attach Buile Log

![20190129100500991.png][]

完成配置后立即构建，邮箱中会收到构建完成后的邮件，并将构建日志作为附件发送。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1c3RfbGg_size_16_color_FFFFFF_t_70 16][]

至此，使用Pytest+Allure的全过程完成。

[https_blog.csdn.net_wust_lh_article_details_86545697]: https://blog.csdn.net/wust_lh/article/details/86545697
[https_www.kancloud.cn_guanfuchang_python_selenium_714653]: https://www.kancloud.cn/guanfuchang/python_selenium/714653
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1c3RfbGg_size_16_color_FFFFFF_t_70]: /images/20220322/4076f5dc6e71410785418a6edccf070a.png
[https_github.com_allure-framework_allure2_releases_tag_2.7.0]: https://github.com/allure-framework/allure2/releases/tag/2.7.0
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1c3RfbGg_size_16_color_FFFFFF_t_70 1]: /images/20220322/d5c214e1df014051b2151f508cbc6237.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1c3RfbGg_size_16_color_FFFFFF_t_70 2]: /images/20220322/c7dd9530031d472080a37278dc8001cd.png
[20190129100044655.png]: /images/20220322/66e8ebee07b44d4e88ae6e4f108b9f76.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1c3RfbGg_size_16_color_FFFFFF_t_70 3]: /images/20220322/8bb0365211124c3b802a95b8127d2f22.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1c3RfbGg_size_16_color_FFFFFF_t_70 4]: /images/20220322/066285f46002444f8cb147fa8cc93c74.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1c3RfbGg_size_16_color_FFFFFF_t_70 5]: /images/20220322/3bd9747dc7814808928e49d44e8cc2af.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1c3RfbGg_size_16_color_FFFFFF_t_70 6]: /images/20220322/b5d56cc71b31480fb809120dda7faa67.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1c3RfbGg_size_16_color_FFFFFF_t_70 7]: /images/20220322/df64b4c19d0947aa90bed877288e4dcf.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1c3RfbGg_size_16_color_FFFFFF_t_70 8]: /images/20220322/abde783a50604b7cb892938843ec193f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1c3RfbGg_size_16_color_FFFFFF_t_70 9]: /images/20220322/7331ba5b5bf54a239c29d87210f1ce5a.png
[20190129100256503.png]: /images/20220322/cf9698e98fc1425b86f242c7a99ca91c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1c3RfbGg_size_16_color_FFFFFF_t_70 10]: /images/20220322/adc91f94675c4308ab7565e6200e616c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1c3RfbGg_size_16_color_FFFFFF_t_70 11]: /images/20220322/152347d8bb184d70b9b87702f0684526.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1c3RfbGg_size_16_color_FFFFFF_t_70 12]: /images/20220322/90d095b906474219b044ce2d472d75f4.png
[20190129100400331.png]: /images/20220322/ab787f31ef5d4b6a971c1d1b3d2b3252.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1c3RfbGg_size_16_color_FFFFFF_t_70 13]: /images/20220322/2fba6eac39db43298c74c757a20397ec.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1c3RfbGg_size_16_color_FFFFFF_t_70 14]: /images/20220322/7d589633ce934832a81aa53031ce2f1f.png
[https_blog.csdn.net_wust_lh_article_details_86573797]: https://blog.csdn.net/wust_lh/article/details/86573797
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1c3RfbGg_size_16_color_FFFFFF_t_70 15]: /images/20220322/eeae9a4cff2a40b48d9568ab89389f2f.png
[20190129100500991.png]: /images/20220322/c95c25b37ef14171b1bab4771b5cf7ab.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1c3RfbGg_size_16_color_FFFFFF_t_70 16]: /images/20220322/c364d34972cd45d7996ee0fc4255b177.png