Allure安装、使用、Jenkins集成

清疚 2024-04-07 14:28 71阅读 0赞

#### 目录 ####

*   *  一、allure介绍
     *  二、安装allure服务
     *  三、安装pytest、allure-pytest 插件
     *  四、生成报告
     *  五、allure其他使用
     *   *   *  5.1 给测试报告添加各种附件
             *  5.2 添加用例标题和描述信息
             *  5.3 添加链接
             *  5.4 标记测试用例
             *  5.5 优先级
     *  六、allure和jenkins集成

### 一、allure介绍 ###

allure 是一款开源的，专门用来展示测试结果的测试报告工具，报告内容精致美观且专业。allure 可以与非常多的测试框架做集成：

*  Java 语言，可以与 junit4、junit5、TestNG 测试框架集成；
 *  Python 语言，可以与pytest、behave、nose 测试框架集成；

allure会将测试用例的执行数据保存到json文件当中，再利用 allure 的命令行将文件转换成 HTML 形式呈现出来。

### 二、安装allure服务 ###

Github下载地址：[https://github.com/allure-framework/allure2/releases][https_github.com_allure-framework_allure2_releases]

下载后解压，将解压后的bin路径配置到环境变量中：

![在这里插入图片描述][6aa72efadeb04d6f9ca30ccbddca9c35.png]

cmd进入命令行，运行allure --version，出现版本号提示说明allure服务已经安装配置完毕。

### 三、安装pytest、allure-pytest 插件 ###

1、pytest 的安装：

pip install pytest

2、安装 allure-pytest插件：

pip install allure-pytest

### 四、生成报告 ###

1、在执行 pytest 命令时，添加 allure 命令参数：—alluredir= test\_report\\allure (相对于 pytest 命令所在目录的测试报告目录)。命令执行完后，会在test\_report\\allure目录下生成一些文件：

![在这里插入图片描述][a751fc2673604d06a6fe27cfdc711b9b.png]  
![在这里插入图片描述][36500c7bae9c4317bce6a7fb836c2efd.png]

2、使用allure生成非常美观的html文件：  
直接在pycharm命令行或者cmd里面执行：allure serve +报告地址(test\_report\\allure)

![在这里插入图片描述][f4acc4fc514d444a928c0607b8173113.png]

### 五、allure其他使用 ###

##### 5.1 给测试报告添加各种附件 #####

语法：allure.attach(body, name, attachment\_type, extension)

body：文件原始内容
    name：带有文件名的字符串
    attachment_type：附件类型，可在 allure.attachment_type 中查看支持的附件类型
    extension：创建文件的扩展名
    source：包含文件路径的字符串

![在这里插入图片描述][43dba78262cc469ea678240b1ae2b77b.png]

##### 5.2 添加用例标题和描述信息 #####

语法：@allure.title(str)、@allure.description(str）

![在这里插入图片描述][331c9dfab4fc43018efbd29764bdc5b2.png]

##### 5.3 添加链接 #####

语法：  
@allure.link(url, link\_type, name=None)：提供链接地址  
@allure.issue(url, name=None)：提供带有小错误图标的链接  
使用以上装饰器将在测试报告的“链接”部分中提供网址的可点击链接：

![在这里插入图片描述][ffe559748086468ea347e4e887b970e0.png]

![在这里插入图片描述][3b7d919f02f342dc9504da6233338fc7.png]

##### 5.4 标记测试用例 #####

语法：@allure.epic 、@allure.feature、@allure.story  
@pytest.mark 标记并不会显示在 allure 报告上，allure 提供了以上三种类型的标记装饰器，它们是可以显示在 allure 报告上的，在测试报告的功能栏，测试用例会分类显示。

@allure.epic()>@allure.feature()>@allure.story()，其中 story 是 feature 的子集，feature是epics的子集，测试报告上将优先显示epic、 feature，展开再显示 story。

![在这里插入图片描述][84c9b4dce63b4aa5bf99b99e0c4a9549.png]

![在这里插入图片描述][4d41f45d16d84419ab082b423e9a366e.png]

想要运行指定的 story 或者 feature 或 epics时，可以使用以下命令行选项来指定不同的测试集，执行操作

--allure-epics
    --allure-features
    --allure-stories
    pytest.main([r'--alluredir=test_report\allure  --allure-stories story1,story2'])

##### 5.5 优先级 #####

语法：@allure.severity()

可以修饰函数、方法或整个类，以 allure.severity\_level 枚举值作为参数，值包括：  
BLOCKER、CRITICAL、NORMAL、MINOR、TRIVIAL

![在这里插入图片描述][ec16e2358b1846e6aa426147b323b66a.png]

![在这里插入图片描述][4fe3ffae4c0b4a2b9dc6d6cf311db512.png]  
运行指定优先级的用例：–allure-severities+优先级，如果有多个，用逗号隔开

pytest.main([r'--alluredir=test_report\allure  --allure-severities CRITICAL,NORMAL'])

### 六、allure和jenkins集成 ###

1、安装jenkins/系统设置/插件管理里面，安装Allure插件：

![在这里插入图片描述][534af8cf11664124b0099e2379b4e8c7.png]  
2、全局工具配置–Allure Commandline中,安装allure命令行工具：

![在这里插入图片描述][9896f45e9fe14c0bab247ae9aea378ce.png]

3、系统配置/全局属性下，新增allure安装目录：

![在这里插入图片描述][c21852e4686f459db91cb5e5a3450430.png]

4、job中配置allure，选择allure report：

![在这里插入图片描述][ac2d222d41464a15846e45c9cd037255.png]

![在这里插入图片描述][205dc4b6e2bb42eb9ec0c471e295e23d.png]

5、构建项目，查看allure报告：

![在这里插入图片描述][dcc9d1124f8b4a5f9f4f4f21688bd8f9.png]

![在这里插入图片描述][9a7c465d523c4893b5f1247c66337814.png]

以上就是本次的全部内容，如果对你有帮助，欢迎关注我的微信公众号：**程序员杨叔**，各类文章都会第一时间在上面发布，持续分享全栈测试知识干货，你的支持就是作者更新最大的动力~

[https_github.com_allure-framework_allure2_releases]: https://github.com/allure-framework/allure2/releases
[6aa72efadeb04d6f9ca30ccbddca9c35.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/8cc6d8301cfd4553872553e9ed0cb814.png
[a751fc2673604d06a6fe27cfdc711b9b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/8553fe8c67934f49b56b394fb1cbecf3.png
[36500c7bae9c4317bce6a7fb836c2efd.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/6ceddf320d72411c90116948f7009fe8.png
[f4acc4fc514d444a928c0607b8173113.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/da7e8fbe29054416955c97d9071bebbb.png
[43dba78262cc469ea678240b1ae2b77b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/4afc3c7902964fe78fed894ae204a98b.png
[331c9dfab4fc43018efbd29764bdc5b2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/0d39bf5910244aa9af60f4a7086983b3.png
[ffe559748086468ea347e4e887b970e0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/5b83f88707504548970182ffba4de92f.png
[3b7d919f02f342dc9504da6233338fc7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/aafec99c37a242ff82577a3e55ad8c0f.png
[84c9b4dce63b4aa5bf99b99e0c4a9549.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/8ea28cc8a1ab4df092396b27760fa012.png
[4d41f45d16d84419ab082b423e9a366e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/4425145c26244c3ba6fc25428a8baa27.png
[ec16e2358b1846e6aa426147b323b66a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/15a96d007bad4914bb204e23dbbe503c.png
[4fe3ffae4c0b4a2b9dc6d6cf311db512.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/29c9c6f0b0644d02a0013f758ccac576.png
[534af8cf11664124b0099e2379b4e8c7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/f32fd14f6e754523a582a421e811629d.png
[9896f45e9fe14c0bab247ae9aea378ce.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/1b3bbde744544127b8d6a916519f271d.png
[c21852e4686f459db91cb5e5a3450430.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/ae92d6cc665d4b4fb83bed2baec06274.png
[ac2d222d41464a15846e45c9cd037255.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/47914e88ae50421d97f585a0aab8017e.png
[205dc4b6e2bb42eb9ec0c471e295e23d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/86523bd2d77e4fb78b92a736c14ebd05.png
[dcc9d1124f8b4a5f9f4f4f21688bd8f9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/d2b82513e4a049149871198153128dac.png
[9a7c465d523c4893b5f1247c66337814.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/d15fd90b3d32423bb570e88530616c63.png