Jenkins Environment Injector Plugin 插件详解

2024-09-02 05:52

本文主要是介绍Jenkins Environment Injector Plugin 插件详解,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

引言

在做自动化测试的过程中,我们需要经常发送测试报告给相关研发、产品和上级,但是Jenkins邮件模板不支持Javascritpt脚本来动态生成数据,只支持静态的HTML代码,那么我们就没有办法了吗?非也,我们可以通过环境变量注入的方式读取外部的数据进行引用从而实现报告数据的真实性和实时性,下面将详细介绍Jenkins环境变量注入插件Environment Injector Plugin的使用。

安装插件Environment Injector Plugin

进入Jenkins插件管理页面可用插件页面搜索Environment Injector Plugin进行安装,安装后记得重启Jenkins服务。
在这里插入图片描述

查看插件展示

新建一个Jenkins Job后就能在构建环境选项中看到Environment Injector Plugin插件相关选项,如下图:
在这里插入图片描述

Environment Injector Plugin配置

勾选將環境變量注入構建過程,则会要求我们提供一个配置文件路径,如下:

在这里插入图片描述
文件格式需为Java .properties文件格式,格式如下:

TOTAL=223
PASSED=0
DESELECTED=0
SKIPPED=0
FAILED=30
ERROR=0
SUCCESSFUL=0.00%
TOTAL_TIMES=42m 36s
EXECUTE_TIME=2023-12-18 12:56:04

下面是小编配置的路径,读者请根据自身实际路径进行配置:
在这里插入图片描述
result.txt中的内容是每次测试运行时动态写入的数据,这样每次这个文件的数据都是动态生成的,然后使用 Environment Injector Plugin进行数据读取引用到Jenkins邮件模板中就能在报告中显示实时的动态数据了。

假设result.txt文本文件中的内容如下;

TOTAL=223
PASSED=0
DESELECTED=0
SKIPPED=0
FAILED=30
ERROR=0
SUCCESSFUL=0.00%
TOTAL_TIMES=42m 36s
EXECUTE_TIME=2023-12-18 12:56:04

注意:result.txt中的数据都是静态数据,是代码动态计算后写入的结果数据,Jenkins 测试报告中不会根据数据进行二次计算,只对数据进行引用。

邮件报告模板

jenkins邮件模板
<h1 style="text-align:center;font-family:arial;color:red;font-size:20px;">以下是Jenkins自动发送的邮件,请勿回复!</font><center></h1><hr><p style="text-align:left">项目名称:$PROJECT_NAME</p >
<p style="text-align:left">场景描述:</p ><p style="text-align:left">见此链接</p ><hr><p style="text-align:left">构建地址:$BUILD_URL</p >
<p style="text-align:left">测试环境:${excute_env}</p >
<p style="text-align:left">构建状态:$BUILD_STATUS</p ><p style="text-align:left">触发原因:${CAUSE}</p ><tr style="text-align:left"><p id="result" style="text-align:left">测试结果:</p ><td style="text-align:left">
<p style="text-align:left">
<span>用例总数:${TOTAL}  
</span><span style="color:green">成功:${PASSED}</span>
<span style="color:red">失败:${FAILED}</span> 
<span style="color:orange">异常:${ERROR}</span> 
<span style="color:gray">跳过:${SKIPPED}</span>
<span style="color:gray">未选择:${DESELECTED}</span> 
</p >
<p id='summry' style="text-align:left">运行成功率:${SUCCESSFUL}  运行时长:${TOTAL_TIMES}  执行时间:${EXECUTE_TIME}</p ></td></tr><p style="text-align:left">测试报告:${PROJECT_URL}${BUILD_NUMBER}/allure</p ><hr>

字段解释

  • Jenkins系统变量
    项目名称:$ PROJECT_NAME
    项目地址:$ {PROJECT_URL}
    构建编号: $ {BUILD_NUMBER}
    构建地址:$ BUILD_URL
    构建状态:$ BUILD_STATUS
    触发原因:$ {CAUSE}

  • 自定义变量
    测试环境:$ {excute_env}
    用例总数:$ {TOTAL}
    成功:$ {PASSED}
    失败:$ {FAILED}
    异常:$ {ERROR}
    跳过:$ {SKIPPED}
    未选择:$ {DESELECTED}
    运行成功率:$ {SUCCESSFUL}
    运行时长:$ {TOTAL_TIMES}
    执行时间:$ {EXECUTE_TIME}

上面的系统变量是Jenkins自带的不需要另外定义,自定义变量读者可以根据自己的需要进行定义然后写入到properties文件中(result.txt)

邮件推送配置

由于小编之前已经配置好了邮件推送的默认设置,所以Jenkins系统配置里已经有默认的邮箱推送人了,所以不需要额外配置邮件推送人,另外如果之前没有配置过Jenkins邮件推送,Jenkins Job是无法进行邮件推送的,详细邮件推送配置可以参考小编之前的文章:Jenkins邮件推送配置,这里小编就不赘述了。

配置构建完成邮件推送

在Job构建后操作中选择发送邮件,注意选择第二个 Editable Email,这个可以自定义邮件模板。
在这里插入图片描述

配置邮件内容类型

需要在邮件类型选项Content Type设置为Html选项的,小编设置的最后一项,Both HTML and Plain Text
在这里插入图片描述

配置邮件内容

选择后在邮件选项Default Content中引用上述邮件模板:
在这里插入图片描述
然后应用配置并保存。
在这里插入图片描述
我们也可以看一下在没有引用变量下邮件报告的显示,如下:
在这里插入图片描述

邮件报告预览效果

我们运行下Job看下实际的效果:

如果邮件配置中content type设置的非HTML则 邮件接收到后是HTML代码,如下:
在这里插入图片描述
可以看到邮件中虽然格式不对,但是我们result.txt中的数据是引用到了,这样我们的,目的就达成了。
我们正确设置content type后的效果如下:
在这里插入图片描述
由于小编实际上有些变量没有定义,如测试环境:${excute_env},因为实际在测试过程中我们有很多测试环境,这个小编在Jenkins参数化构建文章中有提到,感兴趣的小伙伴可以看看。

总结

通过本文相信读者能够熟练掌握Jenkins Environment Injector Plugin插件的相关用法,能在推送邮件测试报告数据上更游刃有余。

这篇关于Jenkins Environment Injector Plugin 插件详解的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1129172

相关文章

springboot security快速使用示例详解

《springbootsecurity快速使用示例详解》:本文主要介绍springbootsecurity快速使用示例,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝... 目录创www.chinasem.cn建spring boot项目生成脚手架配置依赖接口示例代码项目结构启用s

Python中随机休眠技术原理与应用详解

《Python中随机休眠技术原理与应用详解》在编程中,让程序暂停执行特定时间是常见需求,当需要引入不确定性时,随机休眠就成为关键技巧,下面我们就来看看Python中随机休眠技术的具体实现与应用吧... 目录引言一、实现原理与基础方法1.1 核心函数解析1.2 基础实现模板1.3 整数版实现二、典型应用场景2

一文详解SpringBoot响应压缩功能的配置与优化

《一文详解SpringBoot响应压缩功能的配置与优化》SpringBoot的响应压缩功能基于智能协商机制,需同时满足很多条件,本文主要为大家详细介绍了SpringBoot响应压缩功能的配置与优化,需... 目录一、核心工作机制1.1 自动协商触发条件1.2 压缩处理流程二、配置方案详解2.1 基础YAML

Python实现无痛修改第三方库源码的方法详解

《Python实现无痛修改第三方库源码的方法详解》很多时候,我们下载的第三方库是不会有需求不满足的情况,但也有极少的情况,第三方库没有兼顾到需求,本文将介绍几个修改源码的操作,大家可以根据需求进行选择... 目录需求不符合模拟示例 1. 修改源文件2. 继承修改3. 猴子补丁4. 追踪局部变量需求不符合很

java中反射(Reflection)机制举例详解

《java中反射(Reflection)机制举例详解》Java中的反射机制是指Java程序在运行期间可以获取到一个对象的全部信息,:本文主要介绍java中反射(Reflection)机制的相关资料... 目录一、什么是反射?二、反射的用途三、获取Class对象四、Class类型的对象使用场景1五、Class

golang 日志log与logrus示例详解

《golang日志log与logrus示例详解》log是Go语言标准库中一个简单的日志库,本文给大家介绍golang日志log与logrus示例详解,感兴趣的朋友一起看看吧... 目录一、Go 标准库 log 详解1. 功能特点2. 常用函数3. 示例代码4. 优势和局限二、第三方库 logrus 详解1.

一文详解如何从零构建Spring Boot Starter并实现整合

《一文详解如何从零构建SpringBootStarter并实现整合》SpringBoot是一个开源的Java基础框架,用于创建独立、生产级的基于Spring框架的应用程序,:本文主要介绍如何从... 目录一、Spring Boot Starter的核心价值二、Starter项目创建全流程2.1 项目初始化(

Spring Boot3虚拟线程的使用步骤详解

《SpringBoot3虚拟线程的使用步骤详解》虚拟线程是Java19中引入的一个新特性,旨在通过简化线程管理来提升应用程序的并发性能,:本文主要介绍SpringBoot3虚拟线程的使用步骤,... 目录问题根源分析解决方案验证验证实验实验1:未启用keep-alive实验2:启用keep-alive扩展建

Java异常架构Exception(异常)详解

《Java异常架构Exception(异常)详解》:本文主要介绍Java异常架构Exception(异常),具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录1. Exception 类的概述Exception的分类2. 受检异常(Checked Exception)

C#基础之委托详解(Delegate)

《C#基础之委托详解(Delegate)》:本文主要介绍C#基础之委托(Delegate),具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录1. 委托定义2. 委托实例化3. 多播委托(Multicast Delegates)4. 委托的用途事件处理回调函数LINQ