Code coverage reports in Jenkins - Mini Project: Build & Apply

Code coverage reports

📖 Scenario: You are working on a software project that uses Jenkins for continuous integration. Your team wants to track how much of the code is tested by automated tests. This helps find untested parts and improve software quality.

🎯 Goal: Set up a Jenkins pipeline that runs tests and generates a code coverage report using a simple configuration. You will create the pipeline script step-by-step to collect and display coverage results.

📋 What You'll Learn

Create a Jenkins pipeline script with a pipeline block

Add a stage called Run Tests that runs a shell command to execute tests and generate coverage data

Add a stage called Publish Coverage that uses the publishCoverage step to publish the coverage report

Print a message confirming the coverage report was published

💡 Why This Matters

🌍 Real World

Code coverage reports help teams see how much of their code is tested automatically. This improves software quality and reduces bugs.

💼 Career

Many DevOps and CI/CD roles require setting up pipelines that run tests and publish coverage reports to ensure code quality.

1

Create the Jenkins pipeline skeleton

Create a Jenkins pipeline script starting with pipeline { and agent any inside it. Add an empty stages block inside the pipeline.

Jenkins

pipeline {
    agent any
    stages {
        // Your code here
    }
}

Need a hint?

Start with pipeline {, then add agent any and an empty stages block.

2

Add a stage to run tests and generate coverage

Inside the stages block, add a stage named Run Tests. Inside it, add a steps block that runs the shell command sh 'make test coverage' to execute tests and generate coverage data.

Jenkins

pipeline {
    agent any
    stages {
        stage('Run Tests') {
            steps {
                // Your code here
            }
        }
    }
}

Need a hint?

Use stage('Run Tests') with steps { sh 'make test coverage' } inside.

3

Add a stage to publish the coverage report

Add another stage inside stages named Publish Coverage. Inside it, add a steps block that calls publishCoverage adapters: [coberturaAdapter('coverage.xml')] to publish the coverage report from the file coverage.xml.

Jenkins

pipeline {
    agent any
    stages {
        stage('Run Tests') {
            steps {
                sh 'make test coverage'
            }
        }
        stage('Publish Coverage') {
            steps {
                // Your code here
            }
        }
    }
}

Need a hint?

Use publishCoverage adapters: [coberturaAdapter('coverage.xml')] inside the Publish Coverage stage.

4

Print confirmation message after publishing coverage

Inside the Publish Coverage stage's steps block, after publishing coverage, add a echo step that prints 'Coverage report published successfully.'.

Jenkins

pipeline {
    agent any
    stages {
        stage('Run Tests') {
            steps {
                sh 'make test coverage'
            }
        }
        stage('Publish Coverage') {
            steps {
                publishCoverage adapters: [coberturaAdapter('coverage.xml')]
                // Your code here
            }
        }
    }
}

Need a hint?

Add echo 'Coverage report published successfully.' after the publishCoverage step.