Jenkins邮件代发及生成HTML报告

2023-10-31 06:20

本文主要是介绍Jenkins邮件代发及生成HTML报告,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

Jenkins邮件代发及生成HTML报告

  • 一、Jenkins的三大概念
    • 1.1 Job
    • 1.2 plugin
    • 1.3 workspace
  • 二、邮件和HTML插件安装
  • 三、Jenkins邮件配置
    • 3.1 配置管理员邮件地址
    • 3.2 配置邮件服务器
  • 四、新建item配置邮件和HTML
    • 4.1 配置邮件代发
    • 4.2 配置HTML报告
    • 4.3 配置junit提取xml文件
  • 五、使用unittest生成HTML报告和xml文件
  • 六、构建成功却没发邮件
  • 七、中文乱码解决
  • 八、Jenkins生成的HTML报告样式问题
  • 九、效果展示

一、Jenkins的三大概念

1.1 Job

在Jenkins平台中,都是以Job(工程/task)为单位去完成一件事情的。在使用Jenkins时,都会在Jenkins管理界面当中新建一个job/item,在job/item中来构建任务。

1.2 plugin

Jenkins提供平台,集成各种插件来完成一个job。比如:Windows\linux命令、SVN和Git(gitlab、gitee、github)代码获取,邮件发送、测试报告集成都需要安装对应的插件才能在Jenkins当中使用这些功能。

1.3 workspace

Jenkins是通过文件形式来存储和管理数据的。
所以,在安装Jenkins时,要配置Jenkins的主目录,这点我们之前已经配置过了。此外新建的每一个job的目录都会放在workspace(存放文件和数据以及执行任务成功后的文件和数据)中,相当于在workspace中每个job都有一个独立的目录,它们是相互独立的。

二、邮件和HTML插件安装

进入如下路径:Dashboard>>Manage Jenkins>>Plugin Manager,依次安装如下HTML插件和email扩展插件。
在这里插入图片描述
在这里插入图片描述

三、Jenkins邮件配置

3.1 配置管理员邮件地址

进入路径:Dashboard>>Manage Jenkins>>Configure System后,在页面Jenkins Location输入管理员的邮件地址。
在这里插入图片描述

3.2 配置邮件服务器

如下图配置,我这里配置的163邮箱,大家配置也可以选择QQ邮箱,在凭证处配置你的邮箱登录账号和邮箱授权码即可,不会可以百度。配置完保存。
在这里插入图片描述

四、新建item配置邮件和HTML

准备条件:
①新建一个item,我这里选择自由风格;
②选择代码管理工具,我这里选择Git;
③选择构建步骤,我这里使用Windows,因此配置Windows的命令行:python 相对工作空间的路径文件.py

4.1 配置邮件代发

接下来我们配置邮件的详细信息,如图点击Post-build-Actions选择Editable Email Notification
在这里插入图片描述
选择之后,按照下面进行配置。
在这里插入图片描述
关于content-type可以选择text或者HTML,我们这里使用HTML,因为我们后面发送邮件使用的是HTML模板。默认主题、默认内容都可以改的。
在这里插入图片描述
查看帮助命令:
在这里插入图片描述
我的模板的代码如下,大家有兴趣可自取。模板记得先上传仓库。

<!DOCTYPE html>
<html lang="zh_CN">
<head><meta charset="UTF8" name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0, user-scalable=no"><title>Unittest Report</title>
</head>
<body>
<div style="text-align: center;">
<table class="table" border="1" style="border-collapse: collapse;margin: auto;table-layout:auto;width: 50%"><tr><caption style="color: #28a745 ;">项目${PROJECT_NAME} 用例执行结果如下:</caption><td style="color: #28a745;width: 10%">测试人员</td><td style="color: #28a745;width: 30%">XXX</td><td style="color: #28a745 ;width: 10% " >用例总数</td><td style="color: #28a745 ;width: 10%">${TEST_COUNTS,var="total"}</td>
</tr><tr><td style="color: #28a745;width: 10%">构建编号</td><td style="color: #28a745;width: 30%">${BUILD_NUMBER}</td><td style="color: gold ;width: 10%">成功用例</td><td style="color: gold ;width: 10% ">${TEST_COUNTS,var="pass"}</td>
</tr><tr><td style="color: #28a745;width: 10%">构建结果</td><td style="color: #28a745;width: 30%">${BUILD_STATUS}</td><td style="color:red ;width: 10%">失败用例</td><td style="color: red ;width: 10% ">${TEST_COUNTS,var="fail"}</td>
</tr><tr><td style="color: #28a745; width: 10%">构建地址</td><td style="color: #28a745 ;word-wrap:break-word;word-break:break-all; width: 30%"><a href= "${BUILD_URL}">${BUILD_URL}</a></td><td style="color:gray ;width: 10% ">跳过用例</td><td style="color: gray ;width: 10%" >${TEST_COUNTS,var="skip"}</td>
</tr><tr><td style="color: #28a745 ;width: 10%">HTML报告地址</td><td colspan="3" style="color: #28a745 ;word-wrap:break-word;word-break:break-all;width: 30%;"><a href="${PROJECT_URL}">${PROJECT_URL}/HTML_20Report/</a></td>
</tr>
</table>
</div>
</body>
</html>

4.2 配置HTML报告

接下来我们配置HTML报告,点击Post-build-Actions选择Publish HTML reports,设置如下,路径都是选择相对路径:
在这里插入图片描述

4.3 配置junit提取xml文件

提取xml文件,点击Post-build-Actions选择Publish JUnit test result report,设置如下,路径都是选择相对路径,至于为什么我们要配置这个,因为Jenkins只能从xml里面读取数据,因此我们的测试报告需要生成一个xml文件才行。
在这里插入图片描述

五、使用unittest生成HTML报告和xml文件

详细信息见代码,文件名test_bd.py;记得上传仓库。

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# 2022/10/4 20:49
# Author : root
# File   : test_bd.py
from selenium import webdriver
from selenium.webdriver.common.by import By
import unittest,time
from unittestreport import TestRunner
import xmlrunnerclass TestUrl(unittest.TestCase):def setUp(self) -> None:br = webdriver.Chrome()self.br=brdef test_1(self):br = self.brbr.get("https://www.baidu.com")br.implicitly_wait(5)self.assertEqual(br.title,"百度一下,你就知道",msg="断言标题相等")time.sleep(2)def tearDown(self) -> None:self.br.quit()
if __name__ == '__main__':suite = unittest.TestSuite()suite.addTest(TestUrl("test_1"))runner = TestRunner(suite,filename="百度URL测试报告.html",report_dir="./report",title="百度URL测试报告",tester="xx",desc="URL测试报告",templates=2)runner.run()suite = unittest.TestSuite()suite.addTest(TestUrl("test_1"))runner_xml = xmlrunner.XMLTestRunner(output="./report",outsuffix="baiduurl",verbosity=2)runner_xml.run(suite)

这样我们在report里面就有了HTML和xml文件,到此,我们的项目基本配置完成,可以开始执行了。

六、构建成功却没发邮件

这里我们少配置了一个地方,如图:在配置Editable Email Notification邮件时没有选择触发条件,这里我们选择always,每执行一次就给我们发送邮件。保存。
在这里插入图片描述

七、中文乱码解决

在实际运行后,我发现Jenkins发送的邮件中中文部分会产生乱码,因此解决方式是配置环境变量、全局变量;且HTML模板和这两个变量的编码方式一致才可解决这个问题。
①配置系统环境变量:JAVA_TOOL_OPTIONS=-Dfile.encoding=UTF8
②配置Jenkins全局变量:进入Dashboard>>Manage Jenkins>>Configure System,配置
LANG=zh_CN.UTF8
③保证之前配置的content-type为html(如果使用HTML模板)
④保证模板html的编码方式为UTF8
⑤配置完毕后,关闭Tomcat,等一会重新打开,再次运行即可解决这个问题。
⑥在实际运行中发现Python执行时的也会有乱码,解决办法

但是这样还有一个问题,将编码格式改为UTF8后,控制台路径会乱码;其他正常;但是编码格式改为gb2312,发现邮件无法读取。
在这里插入图片描述

八、Jenkins生成的HTML报告样式问题

具体在Dashboard>>Manage Jenkins>>Script Console执行脚本,如下图输入点击run。参考文章:解决样式问题

System.setProperty("hudson.model.DirectoryBrowserSupport.CSP", "")

在这里插入图片描述

九、效果展示

Jenkins里面查看HTML报告,老板再也不担心员工偷懒了,哈哈哈
在这里插入图片描述
邮件查看报告:
在这里插入图片描述

这篇关于Jenkins邮件代发及生成HTML报告的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



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

相关文章

python生成随机唯一id的几种实现方法

《python生成随机唯一id的几种实现方法》在Python中生成随机唯一ID有多种方法,根据不同的需求场景可以选择最适合的方案,文中通过示例代码介绍的非常详细,需要的朋友们下面随着小编来一起学习学习... 目录方法 1:使用 UUID 模块(推荐)方法 2:使用 Secrets 模块(安全敏感场景)方法

Python办公自动化实战之打造智能邮件发送工具

《Python办公自动化实战之打造智能邮件发送工具》在数字化办公场景中,邮件自动化是提升工作效率的关键技能,本文将演示如何使用Python的smtplib和email库构建一个支持图文混排,多附件,多... 目录前言一、基础配置:搭建邮件发送框架1.1 邮箱服务准备1.2 核心库导入1.3 基础发送函数二、

Jenkins分布式集群配置方式

《Jenkins分布式集群配置方式》:本文主要介绍Jenkins分布式集群配置方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录1.安装jenkins2.配置集群总结Jenkins是一个开源项目,它提供了一个容易使用的持续集成系统,并且提供了大量的plugin满

前端如何通过nginx访问本地端口

《前端如何通过nginx访问本地端口》:本文主要介绍前端如何通过nginx访问本地端口的问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、nginx安装1、下载(1)下载地址(2)系统选择(3)版本选择2、安装部署(1)解压(2)配置文件修改(3)启动(4)

HTML中meta标签的常见使用案例(示例详解)

《HTML中meta标签的常见使用案例(示例详解)》HTMLmeta标签用于提供文档元数据,涵盖字符编码、SEO优化、社交媒体集成、移动设备适配、浏览器控制及安全隐私设置,优化页面显示与搜索引擎索引... 目录html中meta标签的常见使用案例一、基础功能二、搜索引擎优化(seo)三、社交媒体集成四、移动

HTML input 标签示例详解

《HTMLinput标签示例详解》input标签主要用于接收用户的输入,随type属性值的不同,变换其具体功能,本文通过实例图文并茂的形式给大家介绍HTMLinput标签,感兴趣的朋友一... 目录通用属性输入框单行文本输入框 text密码输入框 password数字输入框 number电子邮件输入编程框

HTML img标签和超链接标签详细介绍

《HTMLimg标签和超链接标签详细介绍》:本文主要介绍了HTML中img标签的使用,包括src属性(指定图片路径)、相对/绝对路径区别、alt替代文本、title提示、宽高控制及边框设置等,详细内容请阅读本文,希望能对你有所帮助... 目录img 标签src 属性alt 属性title 属性width/h

CSS3打造的现代交互式登录界面详细实现过程

《CSS3打造的现代交互式登录界面详细实现过程》本文介绍CSS3和jQuery在登录界面设计中的应用,涵盖动画、选择器、自定义字体及盒模型技术,提升界面美观与交互性,同时优化性能和可访问性,感兴趣的朋... 目录1. css3用户登录界面设计概述1.1 用户界面设计的重要性1.2 CSS3的新特性与优势1.

HTML5 中的<button>标签用法和特征

《HTML5中的<button>标签用法和特征》在HTML5中,button标签用于定义一个可点击的按钮,它是创建交互式网页的重要元素之一,本文将深入解析HTML5中的button标签,详细介绍其属... 目录引言<button> 标签的基本用法<button> 标签的属性typevaluedisabled

HTML5实现的移动端购物车自动结算功能示例代码

《HTML5实现的移动端购物车自动结算功能示例代码》本文介绍HTML5实现移动端购物车自动结算,通过WebStorage、事件监听、DOM操作等技术,确保实时更新与数据同步,优化性能及无障碍性,提升用... 目录1. 移动端购物车自动结算概述2. 数据存储与状态保存机制2.1 浏览器端的数据存储方式2.1.