如何编写Jenkins email-ext模板来显示标准测试报告等测试结果

Question

如何编写Jenkins email-ext模板来显示标准测试报告等测试结果

Jon*_*man 14 hudson jelly jenkins email-ext

我已经调整了标准果冻模板以在表格中显示当前的测试结果,但我真的希望能够显示差异,如Jenkins自己的测试结果页面所示.

例如:

JUnit Tests: 0 failures (±0) , 1 skipped (+1)

Package               Duration   Fail  (diff)  Skip  (diff)  Total  (diff)
foo.bar.baz              89 ms      0      0     1       +1     5       +2

Run Code Online (Sandbox Code Playgroud)

Answer 1

mal*_*cot 11

为Email Ext插件而不是Jelly模板编写Groovy模板.在Groovy模板中,您可以访问构建的Build对象.然后,您可以在其上调用getTestResultAction以获取构建的AbstractTestResultAction,然后您可以查询所需的所有内容.

这是Jenkins Main Module API的链接.可以在中找到Ext Email插件的示例Groovy模板$JENKINS_HOME/plugins/email-ext/WEB-INF/classes/hudson/plugins/emailext/templates/groovy-html.template.有关Groovy模板/脚本用法的更多信息,请参阅Email Ext插件文档.

Answer 2

Lar*_*Cai 5

如果您对如何通过内部 API 访问它感到困惑（很难知道并且它总是存在限制），还有另一种更灵活的方法来做到这一点。

使用 FILE 令牌代替 groovy 模板

使用脚本通过Jenkins API访问您的测试数据，对于您的情况，就像http://jenkins.server/job/yourjob/lastCompletedBuild/testReport/api/xml并email.html在工作区下生成您自己的 html 文件
在Default Contentemail-ext 配置中的表单中，使用 FILE 令牌直接发送电子邮件${FILE, path="email.html"}

在上面的步骤 1 中，您也可以使用更灵活的方式来创建自己的模板，我使用 python 脚本和简单的字符串模板。

它非常适合我。

如果您使用 HTML 格式，则需要使用 `${SCRIPT, template="groovy-html.template"}` 而不是 `${FILE}`。 (3认同)

Answer 3

gao*_*the 5

扩展这个答案：为 Email Ext 插件而不是 Jelly 模板编写一个 Groovy 模板。在可编辑的电子邮件通知内容中

将内容类型设置为“HTML”或“HTML 和纯文本”
并包含这样的 groovy 脚本：

${SCRIPT, template="test.groovy"}
将 groovy 脚本放在电子邮件模板主页中，例如 /var/lib/jenkins/email-templates。请参阅下面的 test.groovy。

在下面的例子中，每个测试都是通过获取这些对象中的每一个来迭代的：'''junitResult.getChildren()'''。如果只想迭代失败的测试，则可以使用 junitResult.getFailedTests()。请参阅 hudson.tasks.junit.TestResult API：http ://hudson-ci.org/javadoc/hudson/tasks/junit/PackageResult.html 另请参阅 http://hudson-ci.org/javadoc/hudson/model/构建.html

Collection<ClassResult> getChildren()
List<CaseResult>    getFailedTests()

Run Code Online (Sandbox Code Playgroud)

来自 email-ext-plugin 的示例/模板可以在这里看到：https : //github.com/jenkinsci/email-ext-plugin/blob/master/src/main/resources/hudson/plugins/emailext/templates/groovy- html.模板

此示例显示了每个测试套件和单个测试的摘要测试结果和结果表。测试.groovy：

<html>
<body>
<%

    import hudson.model.*

    def build = Thread.currentThread().executable
    def buildNumber = build.number
    def buildNumHash = build.getDisplayName()

    def testCount = "0"
    def testPassed = "0"
    def testFailed = "0"
    def testSkipped = "0"
    def buildDuration = "0"
    if(build.testResultAction) {
        def testResult = build.testResultAction
        testCount = String.format("%d",(testResult.totalCount))
        testPassed = String.format("%d",(testResult.result.passCount))
        testFailed = String.format("%d",(testResult.result.failCount))
        testSkipped = String.format("%d",(testResult.result.skipCount))
        testDuration = String.format("%.2f",(testResult.result.duration ))
    }

    def workspace = build.getEnvVars()["WORKSPACE"]
    def buildName = build.getEnvVars()["JOB_NAME"]
    def BUILD_STATUS = build.getEnvVars()["BUILD_STATUS"]
    def BUILD_URL = build.getEnvVars()["BUILD_URL"]

    def testResult = hudson.tasks.junit.TestResult

    def testResult2 = build.getAction(hudson.tasks.junit.TestResultAction.class)

%>

start test.groovy <br><br>
<b>TEST RESULT:</b> $testCount total, <b>$testPassed pass</b>, <b>$testFailed fail</b>, $testSkipped skip.<br>
Workspace : $workspace<br>
Project Name : $buildName $buildNumHash<br><br>

<!-- GENERAL INFO -->

<TABLE>
  <TR><TD align="right">
    <j:choose>
      <j:when test="${build.result=='SUCCESS'}">
        <IMG SRC="${rooturl}static/e59dfe28/images/32x32/blue.gif" />
      </j:when>
          <j:when test="${build.result=='FAILURE'}">
        <IMG SRC="${rooturl}static/e59dfe28/images/32x32/red.gif" />
      </j:when>
      <j:otherwise>
        <IMG SRC="${rooturl}static/e59dfe28/images/32x32/yellow.gif" />
      </j:otherwise>
    </j:choose>
  </TD><TD valign="center"><B style="font-size: 200%;">BUILD ${build.result}</B></TD></TR>
  <TR><TD>Build URL</TD><TD><A href="${rooturl}${build.url}">${rooturl}${build.url}</A></TD></TR>
  <TR><TD>Project:</TD><TD>${project.name}</TD></TR>
  <TR><TD>Date of build:</TD><TD>${it.timestampString}</TD></TR>
  <TR><TD>Build duration:</TD><TD>${build.durationString}</TD></TR>
  <TR><TD>Test duration:</TD><TD>${testDuration}</TD></TR>
</TABLE>
<BR/>

<!-- JUnit TEMPLATE  hudson.tasks.junit.TestResult   -->

<% def junitResultList = it.JUnitTestResult
try {
 def cucumberTestResultAction = it.getAction("org.jenkinsci.plugins.cucumber.jsontestsupport.CucumberTestResultAction")
 junitResultList.add(cucumberTestResultAction.getResult())
} catch(e) {
        //cucumberTestResultAction not exist in this build
}
// API: http://hudson-ci.org/javadoc/hudson/tasks/junit/PackageResult.html
%>

<!-- JUnit TEMPLATE: all tests PASS FAIL SKIP >
<% 
if (junitResultList.size() > 0) { %>
 <TABLE width="100%">
 <TR><TD class="bg1" colspan="2"><B>${junitResultList.first().displayName}</B></TD></TR>
 <% junitResultList.each{
  junitResult -> %>
     <% junitResult.getChildren().each { packageResult -> %>
        <TR><TD class="bg2" colspan="2"> <B>TEST SUITE: ${packageResult.getName()} Failed: ${packageResult.getFailCount()} test(s), Passed: ${packageResult.getPassCount()} test(s)</B>, Skipped: ${packageResult.getSkipCount()} test(s), Total: ${packageResult.getPassCount()+packageResult.getFailCount()+packageResult.getSkipCount()} test(s)</TD></TR>
        <% packageResult.getChildren().each{ suite -> 
               suite.getChildren().each{ test ->
           def colour = "lightgreen"
           def highlight1=""
           def highlight2=""
           RESULT = test.getStatus() // FAILED or PASSED or SKIPPED
           if (RESULT == hudson.tasks.junit.CaseResult.Status.FAILED || RESULT == hudson.tasks.junit.CaseResult.Status.REGRESSION) {
               colour = "#ffcccc" 
               highlight1="<B>"
               highlight2="</B>"
           }
           if (RESULT == hudson.tasks.junit.CaseResult.Status.SKIPPED) { colour = "#ffffb3" }
         %>
          <TR bgcolor="${colour}"><TD class="test" colspan="2">${highlight1}<li>${RESULT}: ${test.getFullName()} </li>${highlight2}</TD></TR>
        <% } }
      }
 } %>
 </TABLE>
 <BR/>
<%
} %>

end of test.groovy

</body>
</html>

Run Code Online (Sandbox Code Playgroud)

例如输出（仅文本无颜色/格式）

start test.groovy 

TEST RESULT: 18 total, 18 pass, 0 fail, 0 skip. 
Workspace : /var/lib/jenkins/jobs/jobname-1/workspace 
Project Name : jobname-1 #20

BUILD SUCCESS 

Build URL   http://jenkinsurl:port/job/jobname-1/20/
Project:    jobname-1 
Date of build:  Mon, 23 Jan 2017 09:29:00 +0000 
Build duration: 10 min 
Test duration:  267.12

Test Results 
TEST SUITE: suitename1 Failed: 0 test(s), Passed: 3 test(s), Skipped: 0 test(s), Total: 3 test(s) 
 * PASSED: suitename1.testclass.testname1
 * PASSED: suitename1.testclass.testname2
 * PASSED: suitename1.testclass.testname3
TEST SUITE: suitename2 Failed: 2 test(s), Passed: 1 test(s), Skipped: 0 test(s), Total: 3 test(s) 
 * PASSED: suitename2.testclass.testname1
 * FAILED: suitename2.testclass.testname2
 * REGRESSION: suitename2.testclass.testname3

end of test.groovy

Run Code Online (Sandbox Code Playgroud)

归档时间：	13 年，6 月前
查看次数：	50159 次
最近记录：	6 年，3 月前