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

相关文章

Spring Security基于数据库验证流程详解

Spring Security 校验流程图 相关解释说明(认真看哦) AbstractAuthenticationProcessingFilter 抽象类 /*** 调用 #requiresAuthentication(HttpServletRequest, HttpServletResponse) 决定是否需要进行验证操作。* 如果需要验证,则会调用 #attemptAuthentica

OpenHarmony鸿蒙开发( Beta5.0)无感配网详解

1、简介 无感配网是指在设备联网过程中无需输入热点相关账号信息,即可快速实现设备配网,是一种兼顾高效性、可靠性和安全性的配网方式。 2、配网原理 2.1 通信原理 手机和智能设备之间的信息传递,利用特有的NAN协议实现。利用手机和智能设备之间的WiFi 感知订阅、发布能力,实现了数字管家应用和设备之间的发现。在完成设备间的认证和响应后,即可发送相关配网数据。同时还支持与常规Sof

6.1.数据结构-c/c++堆详解下篇(堆排序,TopK问题)

上篇:6.1.数据结构-c/c++模拟实现堆上篇(向下,上调整算法,建堆,增删数据)-CSDN博客 本章重点 1.使用堆来完成堆排序 2.使用堆解决TopK问题 目录 一.堆排序 1.1 思路 1.2 代码 1.3 简单测试 二.TopK问题 2.1 思路(求最小): 2.2 C语言代码(手写堆) 2.3 C++代码(使用优先级队列 priority_queue)

K8S(Kubernetes)开源的容器编排平台安装步骤详解

K8S(Kubernetes)是一个开源的容器编排平台,用于自动化部署、扩展和管理容器化应用程序。以下是K8S容器编排平台的安装步骤、使用方式及特点的概述: 安装步骤: 安装Docker:K8S需要基于Docker来运行容器化应用程序。首先要在所有节点上安装Docker引擎。 安装Kubernetes Master:在集群中选择一台主机作为Master节点,安装K8S的控制平面组件,如AP

嵌入式Openharmony系统构建与启动详解

大家好,今天主要给大家分享一下,如何构建Openharmony子系统以及系统的启动过程分解。 第一:OpenHarmony系统构建      首先熟悉一下,构建系统是一种自动化处理工具的集合,通过将源代码文件进行一系列处理,最终生成和用户可以使用的目标文件。这里的目标文件包括静态链接库文件、动态链接库文件、可执行文件、脚本文件、配置文件等。      我们在编写hellowor

LabVIEW FIFO详解

在LabVIEW的FPGA开发中,FIFO(先入先出队列)是常用的数据传输机制。通过配置FIFO的属性,工程师可以在FPGA和主机之间,或不同FPGA VIs之间进行高效的数据传输。根据具体需求,FIFO有多种类型与实现方式,包括目标范围内FIFO(Target-Scoped)、DMA FIFO以及点对点流(Peer-to-Peer)。 FIFO类型 **目标范围FIFO(Target-Sc

019、JOptionPane类的常用静态方法详解

目录 JOptionPane类的常用静态方法详解 1. showInputDialog()方法 1.1基本用法 1.2带有默认值的输入框 1.3带有选项的输入对话框 1.4自定义图标的输入对话框 2. showConfirmDialog()方法 2.1基本用法 2.2自定义按钮和图标 2.3带有自定义组件的确认对话框 3. showMessageDialog()方法 3.1

脏页的标记方式详解

脏页的标记方式 一、引言 在数据库系统中,脏页是指那些被修改过但还未写入磁盘的数据页。为了有效地管理这些脏页并确保数据的一致性,数据库需要对脏页进行标记。了解脏页的标记方式对于理解数据库的内部工作机制和优化性能至关重要。 二、脏页产生的过程 当数据库中的数据被修改时,这些修改首先会在内存中的缓冲池(Buffer Pool)中进行。例如,执行一条 UPDATE 语句修改了某一行数据,对应的缓

Android Environment 获取的路径问题

1. 以获取 /System 路径为例 /*** Return root of the "system" partition holding the core Android OS.* Always present and mounted read-only.*/public static @NonNull File getRootDirectory() {return DIR_ANDR

Maven(插件配置和生命周期的绑定)

1.这篇文章很好,介绍的maven插件的。 2.maven的source插件为例,可以把源代码打成包。 Goals Overview就可以查看该插件下面所有的目标。 这里我们要使用的是source:jar-no-fork。 3.查看source插件的example,然后配置到riil-collect.xml中。  <build>   <plugins>    <pl