Guide: Email Jenkins with Extent Report Data

Data Extraction from Jenkins Extent Reports

Groovy and Java Scripting for Pipelines in Jenkins

import hudson.model.*
import hudson.util.RemotingDiagnostics
import groovy.json.JsonSlurper
def extractData() {
    def build = Thread.currentThread().executable
    def reportUrl = "${build.getProject().url}${build.number}/HTML_20Report/index.html"
    def jenkinsConsole = new URL(reportUrl).text
    def matcher = jenkinsConsole =~ "<span class=\\"param_name\\">\\s*Total Tests:\\s*</span>(\\d+)</br>"
    def totalTests = matcher ? Integer.parseInt(matcher[0][1]) : 0
    matcher = jenkinsConsole =~ "<span class=\\"param_name\\">\\s*Passed Tests:\\s*</span>(\\d+)</br>"
    def passedTests = matcher ? Integer.parseInt(matcher[0][1]) : 0
    matcher = jenkinsConsole =~ "<span class=\\"param_name\\">\\s*Failed Tests:\\s*</span>(\\d+)</br>"
    def failedTests = matcher ? Integer.parseInt(matcher[0][1]) : 0
    return [totalTests, passedTests, failedTests]
}
def sendEmail(testResults) {
    def emailExt = Jenkins.instance.getExtensionList('hudson.tasks.MailSender')[0]
    def emailBody = "Total Tests: ${testResults[0]}, Passed: ${testResults[1]}, Failed: ${testResults[2]}"
    emailExt.sendMail(emailBody, "jenkins@example.com", "Test Report Summary")
}
def results = extractData()
sendEmail(results)

A Script to Improve Jenkins' Email Notifications

Jenkins Post-Build Actions Using Groovy

import groovy.json.JsonSlurper
import jenkins.model.Jenkins
import javax.mail.Message
import javax.mail.Transport
import javax.mail.internet.InternetAddress
import javax.mail.internet.MimeMessage
def fetchReportData() {
    def job = Jenkins.instance.getItemByFullName("YourJobName")
    def lastBuild = job.lastBuild
    def reportUrl = "${lastBuild.url}HTML_20Report/index.html"
    new URL(reportUrl).withReader { reader ->
        def data = reader.text
        def jsonSlurper = new JsonSlurper()
        def object = jsonSlurper.parseText(data)
        return object
    }
}
def sendNotification(buildData) {
    def session = Jenkins.instance.getMailSession()
    def message = new MimeMessage(session)
    message.setFrom(new InternetAddress("jenkins@example.com"))
    message.setRecipients(Message.RecipientType.TO, "developer@example.com")
    message.setSubject("Automated Test Results")
    message.setText("Test Results: ${buildData.totalTests} Total, ${buildData.passed} Passed, ${buildData.failed} Failed.")
    Transport.send(message)
}
def reportData = fetchReportData()
sendNotification(reportData)

Frequently Asked Questions about Integrating Jenkins Reports

1. How can I set up Jenkins so that following a build, an email is sent?
2. Using the Email Notification option, you can set this up in the post-build activities of your task configuration.
3. In the context of Jenkins, what are Extent Reports?
4. An open-source reporting tool called Extent results can be quickly and simply incorporated into Jenkins workflows to provide comprehensive and interactive results on automated tests.
5. Is it possible for Jenkins to interface with reporting technologies other than Extent Reports?
6. With the appropriate plugins, Jenkins does indeed provide integration with a number of additional reporting tools, including JUnit, TestNG, and others.
7. How can I use Jenkins to get test data from an HTML report?
8. Typically, you utilize Jenkins' Groovy or Python programming to parse HTML text and retrieve the necessary data.
9. What advantages do Jenkins' automated email notifications offer?
10. Automated emails help teams maintain continuous deployment procedures and address issues more quickly by giving them instant feedback on build and test statuses.

Concluding Remarks about Automatic Jenkins Reporting

The ability to automatically extract test metrics from Extent Reports and include them into email notifications sent by Jenkins greatly improves a continuous integration pipeline's monitoring capabilities. Teams can take prompt action to improve code and fix failures by using this strategy, which enables teams to receive rapid updates regarding test outcomes. By guaranteeing that all stakeholders are instantly informed about the status of the nightly builds, the streamlined procedure not only saves time but also optimizes resource allocation, maintaining a continuous loop of feedback and development.