selenium+testng+gitblit+jenkins+ant自动化测试系列十一：使用Email Extersion Plugin替换Jenkins的默认邮件通知
前面的章节已经讲了如何使用jenkins进行自动化持续集成构建，jenkins执行了自动构建后，我们希望能够收到构建是否成功，以及测试执行是否成功的通知，这里就需要用到jenkins的邮件通知功能。一、基本的Jenkins邮件服务器配置，在系统管理-系统设置中有两个地方需要配置第一个：Jenkins Location,填写url，以及系统管理员邮件地址（即发件人邮箱地址）第二个，页面滚到最底...
前面的章节已经讲了如何使用jenkins进行自动化持续集成构建，jenkins执行了自动构建后，我们希望能够收到构建是否成功，以及测试执行是否成功的通知，这里就需要用到jenkins的邮件通知功能。
一、基本的Jenkins邮件服务器配置，在系统管理-系统设置中有两个地方需要配置
第一个：Jenkins Location,填写url，以及系统管理员邮件地址（即发件人邮箱地址）
第二个，页面滚到最底下，邮件通知，可点开高级查看，如下图：
注意：
1.最好使用企业邮箱，比如阿里企业邮箱，因为我们平时都会使用foxmail来接收邮件，所以可以保证我们的邮箱smtp服务可用，我刚开始使用qq邮箱之类的，测试发送邮件总是失败，虽然我的qq邮箱也已经设置开启了smtp服务，具体失败原因还不清楚。
2.SMTP认证处的用户名与系统管理员邮件地址一定要相同
3.测试接收邮箱可以与发送邮箱地址相同或者不相同
4.SMTP服务器与用户名邮件后缀应保存一致，如
SMTP服务器:smtp.company.com
用户名：test@company.com
密码：****** (注意，这里是填邮箱的授权密码，而不是邮箱的账号密码)
Test e-mail recipient:test@company.com
勾选 “通过发送测试邮件配置”，点击Test configuration, 测试此配置能否连通， 如果提示Email was successfully sent,并且收到以下邮件，恭喜！
This is test email #56 sent from Jenkins
常见错误：
1.如果邮箱密码错误或者smtp服务器与用户名邮件后缀不一致，提示535 error
2.管理员邮件地址与用户名地址不一致，提示553 error
3.使用qq邮箱,提示530error
二、使用插件“Email Extersion Plugin”进行扩展，它可根据构建的结果，发送更详细和灵活的测试报告
1.在jenkins系统管理-管理插件，搜索插件Email Extersion Plugin并安装。
2.关于插件“Email Extersion Plugin”的配置，主要包含两个部分：全局配置和项目配置。
- 全局配置
在系统管理-系统设置中配置Extended E-mail Notification
主要参数说明：
1.Default Recipients：接收人地址，默认：$DEFAULT_RECIPIENTS或填写对应的收件人邮箱地址
2.Reply To List : 回复人地址，默认：$DEFAULT_REPLYTO或填写对应的回复人邮箱地址
3.Default Subject : 邮件标题，如：构建通知:$PROJECT_NAME - Build # $BUILD_NUMBER - $BUILD_STATUS!
4.Default Content : 邮件内容，模板附在本文最后
5.Default Trigger：邮件触发日志，默认是在任务失败的时候才会发邮件，可以在Default Triggers列表中选择一个trigger点，比如"always"，
这样任何时候只要构建就会发送邮件。
- 项目配置
要想在一个项目中使用email-ext插件，首先必须在项目配置页激活它。在构建后操作——”Add Post-build Actions”选项中勾选”Editable Email Notification”标签。因为基本参数已经在全局配置中配置好，如无其他特殊需求，项目配置中的参数都为默认即可。如下图：
3.保存配置后，选择项目构建，构建完成后，会自动发送邮件到指定的邮箱地址。我在配置邮件的过程中，出现了以下两种问题。
第一种，构建控制台输出“connect error sending email,retrying once more in 10 seconds”
第二种，提示已经发送邮件，但是实际上邮箱没有收到邮件
中间找了很久原因，后面换成公司的邮箱后，就恢复正常了，所以建议配置时按照我上面讲的使用企业邮箱，应该就可以顺利接收邮件了。
4.构建完成后，邮箱收到的邮件显示如下，个人觉得邮件内容还是挺详细，界面也挺美观的。
邮件内容模板：
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>${ENV, var="JOB_NAME"}-第${BUILD_NUMBER}次构建日志</title>
</head>
<body leftmargin="8" marginwidth="0" topmargin="8" marginheight="4"
offset="0">
<table width="95%" cellpadding="0" cellspacing="0"
style="font-size: 11pt; font-family: Tahoma, Arial, Helvetica, sans-serif">
<tr>
<td>
<h2>
<font>Hi All, 以下是${PROJECT_NAME}项目在Jenkins异常情况邮件通知</br>
(本邮件是程序自动下发的，请勿回复！)</font>
</h2>
</td>
</tr>
<tr>
<td>
<br />
<b><font color="#0B610B">构建信息</font></b>
<hr size="2" width="100%" align="center" />
</td>
</tr>
<tr>
<td>
<ul>
<li>项目名称 ： ${PROJECT_NAME}</li>
<li>构建编号 ： ${BUILD_NUMBER}</li>
<li>构建状态 ： ${BUILD_STATUS}</li>
<li>触发原因 ：${CAUSE}</li>
<li>构建日志 ： <a href="${BUILD_URL}console">${BUILD_URL}console</a></li>
<li>工作目录 ： <a href="${PROJECT_URL}ws">${PROJECT_URL}ws</a></li>
</ul>
</td>
</tr>
<tr>
<td>
<br />
<b><font color="#0B610B">测试执行结果</font></b>
<hr size="2" width="100%" align="center" />
<tr>
<td>
<ul>
<li>测试数量：${TEST_COUNTS} </li>
<li>测试失败数量：${TEST_COUNTS, var="fail"} </li>
<li>测试忽略数量：${TEST_COUNTS, var="skip"} </li>
<li>测试结果详情：<a href="http://192.168.150.116:8080/job/OC/lastCompletedBuild/testngreports/">oc_test_results</a></li>
</ul>
</td>
</tr>
<tr>
<td><b><font color="#0B610B">构建日志:</font></b>
<hr size="2" width="100%" align="center" /></td>
</tr>
<tr>
<td><textarea cols="140" rows="30" readonly="readonly"
style="font-family: Courier New">${BUILD_LOG}</textarea>
</td>
</tr>
</table>
</body>
</html>对应的常用属性：
l ${FILE,path="PATH"} 包括指定文件（路径）的含量相对于工作空间根目录。
path文件路径，注意：是工作区目录的相对路径。
l ${BUILD_NUMBER} 显示当前构建的编号。
l ${JOB_DESCRIPTION} 显示项目描述。
l ${CAUSE} 显示谁、通过什么渠道触发这次构建。
l ${CHANGES}-显示上一次构建之后的变化。
showPaths 如果为 true,显示提交修改后的地址。默认false。
showDependencies 如果为true，显示项目构建依赖。默认为false
format 遍历提交信息，一个包含%X的字符串，其中%a表示作者，%d表示日期，%m表示消息，%p表示路径，%r表示版 本。注意，并不是所有的版本系统都支持%d和%r。如果指定showPaths将被忽略。默认“[%a] %m\\n”。
pathFormat一个包含“%p”的字符串，用来标示怎么打印路径。
l ${BUILD_ID}显示当前构建生成的ID。
l ${PROJECT_NAME} 显示项目的全名。（见AbstractProject.getFullDisplayName）
l ${PROJECT_DISPLAY_NAME} 显示项目的显示名称。（见AbstractProject.getDisplayName）
l ${SCRIPT}从一个脚本生成自定义消息内容。自定义脚本应该放在"$JENKINS_HOME/email-templates"。当使用自定义脚本时会默认搜索$JENKINS_HOME/email-templatesdirectory目录。其他的目录将不会被搜索。
script当其使用的时候，仅仅只有最后一个值会被脚本使用（不能同时使用script和template）。
template常规的simpletemplateengine格式模板。
l ${JENKINS_URL} 显示Jenkins服务器的url地址（你可以再系统配置页更改）。
l ${BUILD_LOG_MULTILINE_REGEX}按正则表达式匹配并显示构建日志。
regex java.util.regex.Pattern 生成正则表达式匹配的构建日志。无默认值，可为空。
maxMatches 匹配的最大数量。如果为0，将匹配所有。默认为0。
showTruncatedLines 如果为true，包含[...truncated ### lines...]行。默认为true。
substText 如果非空，就把这部分文字（而不是整行）插入该邮件。默认为空。
escapeHtml 如果为true，格式化HTML。默认为false。
matchedSegmentHtmlStyle 如果非空，输出HTML。匹配的行数将变为<b style=”your-style-value”> html escap ed matched line </b>格式。默认为空。
l ${BUILD_LOG} 显示最终构建日志。
maxLines 日志最多显示的行数，默认250行。
escapeHtml 如果为true，格式化HTML。默认false。
l ${PROJECT_URL} 显示项目的URL地址。
l ${BUILD_STATUS} -显示当前构建的状态(失败、成功等等)
l ${BUILD_URL} -显示当前构建的URL地址。
l ${CHANGES_SINCE_LAST_SUCCESS} -显示上一次成功构建之后的变化。
reverse在顶部标示新近的构建。默认false。
format遍历构建信息，一个包含%X的字符串，其中%c为所有的改变，%n为构建编号。默认”Changes for Build #% n\n%c\n”。
showPaths,changesFormat,pathFormat分别定义如${CHANGES}的showPaths、format和pathFormat参数。
l ${CHANGES_SINCE_LAST_UNSTABLE} -显示显示上一次不稳固或者成功的构建之后的变化。
reverse在顶部标示新近的构建。默认false。
format遍历构建信息，一个包含%X的字符串，其中%c为所有的改变，%n为构建编号。默认”Changes for Build #% n\n%c\n”。
showPaths,changesFormat,pathFormat分别定义如${CHANGES}的showPaths、format和pathFormat参数。
l ${ENV} –显示一个环境变量。
var– 显示该环境变量的名称。如果为空，显示所有，默认为空。
l ${FAILED_TESTS} -如果有失败的测试，显示这些失败的单元测试信息。
l ${JENKINS_URL} -显示Jenkins服务器的地址。(你能在“系统配置”页改变它)。
l ${HUDSON_URL} -不推荐，请使用$JENKINS_URL
l ${PROJECT_URL} -显示项目的URL。
l ${SVN_REVISION} -显示SVN的版本号。
l ${JELLY_SCRIPT} -从一个Jelly脚本模板中自定义消息内容。有两种模板可供配置：HTML和TEXT。你可以在$JENKINS_HOME/email-templates下自定义替换它。当使用自动义模板时，”template”参数的名称不包含“.jelly”。
template模板名称，默认”html”。
l ${TEST_COUNTS} -显示测试的数量。
var– 默认“total”。
total -所有测试的数量。
fail -失败测试的数量。
skip -跳过测试的数量。
权威｜前沿｜技术｜干货｜国内首个API全生命周期开发者社区
更多推荐
0
0- 0
已为社区贡献8条内容
所有评论(0)