Jenkins邮件代发及生成HTML报告

南风知我意。。 2023-11-12 原文

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 xmlrunner

class TestUrl(unittest.TestCase):
    def setUp(self) -> None:
        br = webdriver.Chrome()
        self.br=br
    def test_1(self):
        br = self.br
        br.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 span class token html 运维测试工具

有关Jenkins邮件代发及生成HTML报告的更多相关文章

ruby - 使用 RubyZip 生成 ZIP 文件时设置压缩级别 - 2
我有一个Ruby程序，它使用rubyzip压缩XML文件的目录树。gem。我的问题是文件开始变得很重，我想提高压缩级别，因为压缩时间不是问题。我在rubyzipdocumentation中找不到一种为创建的ZIP文件指定压缩级别的方法。有人知道如何更改此设置吗？是否有另一个允许指定压缩级别的Ruby库？最佳答案这是我通过查看rubyzip内部创建的代码。level=Zlib::BEST_COMPRESSIONZip::ZipOutputStream.open(zip_file)do|zip|Dir.glob("**/*")d
ruby - 使用 ruby 将 HTML 转换为纯文本并维护结构/格式 - 2
我想将html转换为纯文本。不过，我不想只删除标签，我想智能地保留尽可能多的格式。为插入换行符标签，检测段落并格式化它们等。输入非常简单，通常是格式良好的html(不是整个文档，只是一堆内容，通常没有anchor或图像)。我可以将几个正则表达式放在一起，让我达到80%，但我认为可能有一些现有的解决方案更智能。最佳答案首先，不要尝试为此使用正则表达式。很有可能你会想出一个脆弱/脆弱的解决方案，它会随着HTML的变化而崩溃，或者很难管理和维护。您可以使用Nokogiri快速解析HTML并提取文本:require'nokogiri'h
ruby - 在 jRuby 中使用 'fork' 生成进程的替代方案？ - 2
在MRIRuby中我可以这样做:deftransferinternal_server=self.init_serverpid=forkdointernal_server.runend#Maketheserverprocessrunindependently.Process.detach(pid)internal_client=self.init_client#Dootherstuffwithconnectingtointernal_server...internal_client.post('somedata')ensure#KillserverProcess.kill('KILL',
ruby - 如何使用 Ruby aws/s3 Gem 生成安全 URL 以从 s3 下载文件 - 2
我正在编写一个小脚本来定位aws存储桶中的特定文件，并创建一个临时验证的url以发送给同事。(理想情况下，这将创建类似于在控制台上右键单击存储桶中的文件并复制链接地址的结果)。我研究过回形针，它似乎不符合这个标准，但我可能只是不知道它的全部功能。我尝试了以下方法:defauthenticated_url(file_name,bucket)AWS::S3::S3Object.url_for(file_name,bucket,:secure=>true,:expires=>20*60)end产生这种类型的结果:...-1.amazonaws.com/file_path/file.zip.A
ruby-on-rails - Rails HTML 请求渲染 JSON - 2
在我的Controller中，我通过以下方式在我的index方法中支持HTML和JSON:respond_todo|format|format.htmlformat.json{renderjson:@user}end在浏览器中拉起它时，它会自然地以HTML呈现。但是，当我对/user资源进行内容类型为application/json的curl调用时(因为它是索引方法)，我仍然将HTML作为响应。如何获取JSON作为响应？我还需要说明什么？最佳答案您应该将.json附加到请求的url，提供的格式在routes.rb的路径中定义。这
ruby-on-rails - 使用 Sublime Text 3 突出显示 HTML 背景语法中的 ERB？ - 2
所以我在关注Railscast，我注意到在html.erb文件中，ruby代码有一个微弱的背景高亮效果，以区别于其他代码HTML文档。我知道Ryan使用TextMate。我正在使用SublimeText3。我怎样才能达到同样的效果？谢谢! 最佳答案为SublimeText安装ERB包。假设您安装了SublimeText包管理器*，只需点击cmd+shift+P即可获得命令菜单，然后键入installpackage并选择PackageControl:InstallPackage获取包管理器菜单。在该菜单中，键入ERB并在看到包时选择
ruby-on-rails - Ruby url 到 html 链接转换 - 2
我正在使用Rails构建一个简单的聊天应用程序。当用户输入url时，我希望将其输出为html链接(即“url”)。我想知道在Ruby中是否有任何库或众所周知的方法可以做到这一点。如果没有，我有一些不错的正则表达式示例代码可以使用... 最佳答案查看auto_linkRails提供的辅助方法。这会将所有URL和电子邮件地址变成可点击的链接(htmlanchor标记)。这是文档中的代码示例。auto_link("Gotohttp://www.rubyonrails.organdsayhellotodavid@loudthinking.
ruby-on-rails - Ruby on Rails - 为文本区域和图片生成列 - 2
我是Rails的新手，所以请原谅简单的问题。我正在为一家公司创建一个网站。那家公司想在网站上展示它的客户。我想让客户自己管理这个。我正在为“客户”生成一个表格，我想要的三列是:公司名称、公司描述和Logo。对于名称，我使用的是name:string但不确定如何在脚本/生成脚手架终端命令中最好地创建描述列(因为我打算将其设置为文本区域)和图片。我怀疑描述(我想成为一个文本区域)应该仍然是描述:字符串，然后以实际形式进行调整。不确定如何处理图片字段。那么……说来话长:我在脚手架命令中输入什么来生成描述和图片列？最佳答案对于“文本”数
ruby-on-rails - 如何生成传递一些自定义参数的 `link_to` URL？ - 2
我正在使用RubyonRails3.0.9，我想生成一个传递一些自定义参数的link_toURL。也就是说，有一个articles_path(www.my_web_site_name.com/articles)我想生成如下内容:link_to'Samplelinktitle',...#HereIshouldimplementthecode#=>'http://www.my_web_site_name.com/articles?param1=value1¶m2=value2&...我如何编写link_to语句“alàRubyonRailsWay”以实现该目的？如果我想通过传递一些
ruby-on-rails - 如何在 Rails 3 中创建自定义脚手架生成器？ - 2
有这些railscast。http://railscasts.com/episodes/218-making-generators-in-rails-3有了这个，你就会知道如何创建样式表和脚手架生成器。http://railscasts.com/episodes/216-generators-in-rails-3通过这个，您可以了解如何添加一些文件来修改脚手架View。我想把两者结合起来。我想创建一个生成器，它也可以创建脚手架View。有点像RyanBates漂亮的生成器或web_app_themegem(https://github.com/pilu/web-app-theme)。我

Jenkins邮件代发及生成HTML报告