Skip to main content

Documentation Index

Fetch the complete documentation index at: https://notes.kodekloud.com/llms.txt

Use this file to discover all available pages before exploring further.

In this lesson, you’ll learn how to programmatically determine which stage failed in a Jenkins Pipeline and send that stage name to Slack—all without adding redundant post { failure { … } } blocks to every stage.

​
Why Avoid Manual Post-Failure Blocks?

Adding post { failure { … } } to each stage quickly becomes unmanageable as pipelines grow. Instead, we’ll use the Jenkins Blue Ocean Plugin API at the end of the build to discover failed stages automatically.

​
Programmatic Stage Discovery with Groovy

Define two Groovy helper methods—getStageResults to collect stage data and getFailedStages to extract failures. Place these in a Shared Library or at the top of your Jenkinsfile.
The methods are annotated with @NonCPS to ensure they run outside the Pipeline CPS engine.
import io.jenkins.blueocean.rest.impl.pipeline.PipelineNodeGraphVisitor
import io.jenkins.blueocean.rest.impl.pipeline.FlowNodeWrapper
import org.jenkinsci.plugins.workflow.steps.build.RunWrapper
import org.jenkinsci.plugins.workflow.actions.ErrorAction

@NonCPS
List<Map> getStageResults(RunWrapper build) {
    def visitor = new PipelineNodeGraphVisitor(build.rawBuild)
    def stages  = visitor.pipelineNodes.findAll { it.type == FlowNodeWrapper.NodeType.STAGE }

    return stages.collect { stage ->
        def errorActions = stage.getPipelineActions(ErrorAction)
        def errors       = errorActions.collect { it.error }.unique()
        [
            id              : stage.id,
            failedStageName : stage.displayName,
            result          : stage.status.result,
            errors          : errors
        ]
    }
}

@NonCPS
List<Map> getFailedStages(RunWrapper build) {
    getStageResults(build).findAll { it.result == 'FAILURE' }
}
You can summarize these helper functions:
Method NamePurpose
getStageResultsCollects every stage’s ID, name, result, and errors
getFailedStagesFilters the list to only include failures

​
Example Declarative Jenkinsfile

Below is a sample pipeline illustrating how to use these methods in the post section. On failure, we extract the first failed stage name and embed it in a Slack alert. 
pipeline {
    agent any

    // Shared library or top of file:
    // getStageResults and getFailedStages

    stages {
        stage('Ok') {
            steps {
                echo 'This stage passes'
            }
        }
        stage('NotOK') {
            steps {
                sh 'exit 1'
            }
        }
    }

    post {
        always {
            publishHTML(
                allowMissing: false,
                alwaysLinkToLastBuild: true,
                keepAll: true,
                reportDir: 'owasp.zap.report',
                reportFile: 'index.html'
            )
        }
        success {
            script {
                env.failedStage = 'none'
                env.emoji       = ":white_check_mark: :tada: :thumbsup_all:"
                sendNotification(currentBuild.result)
            }
        }
        failure {
            script {
                def failedStages = getFailedStages(currentBuild)
                env.failedStage   = failedStages[0]?.failedStageName
                env.emoji         = ":x: :red_circle: :sos:"
                sendNotification(currentBuild.result)
            }
        }
    }
}

​
Handling Jenkins Script Approval

When running these API calls for the first time, Jenkins may block unapproved methods. Approve them via Manage Jenkins → In-process Script Approval.
Ensure you only approve trusted methods. Unrestricted script approval can introduce security risks.
The image shows a Jenkins console output with an error message indicating that scripts are not permitted to use a specific method due to security restrictions. The error details and stack trace are visible, suggesting a script approval issue.
The image shows a Jenkins Script Approval page with options to approve or deny script permissions. It includes a list of methods and a warning about potential security vulnerabilities.
You may need to approve several entries until the build completes successfully.

​
Verifying Failed Stages in Jenkins UI

After granting approvals, rerun the pipeline. In the Classic UI’s Stage View, failed stages are highlighted in red:
The image shows a Jenkins pipeline dashboard with a stage view, displaying build history and stage times for a project. Some stages have failed, indicated by red highlights.
If additional methods are blocked, another console error will appear:
The image shows a Jenkins console output with an error message indicating that scripts are not permitted to use a specific method due to security restrictions. There is also a stack trace detailing the error.
Once all approvals are in place, check the overall pipeline view:
The image shows a Jenkins pipeline dashboard for a project named "devsecops-numeric-application," displaying the stage view with build history and status of various stages, including some failed tests.

​
Slack Notifications on Failure

When a stage fails, the Slack app will receive a message identifying the failed stage:
The image shows a Slack interface with a Jenkins Slack App notification about a failed Kubernetes deployment in the "devsecops" pipeline. It includes details like job name, build number, failed stage, and Git information.

​
Confirming Success Notifications

Use a simple two-stage pipeline to validate success notifications. Observe that failedStage is set to none on successful builds: 
pipeline {
    agent any
    stages {
        stage('Testing Slack - 1')            { steps { sh 'exit 0' } }
        stage('Testing Slack - Error Stage')  { steps { sh 'exit 1' } }
    }
    post {
        always {
            junit 'target/surefire-reports/*.xml'
            jacoco execPattern: 'target/jacoco.exec'
            dependencyCheckPublisher pattern: 'target/dependency-check-report.xml'
        }
        success {
            script {
                env.failedStage = 'none'
                env.emoji       = ':white_check_mark: :tada: :thumbsup_all:'
                sendNotification(currentBuild.result)
            }
        }
        failure {
            script {
                def failedStages = getFailedStages(currentBuild)
                env.failedStage   = failedStages[0]?.failedStageName
                env.emoji         = ':x: :red_circle:'
                sendNotification(currentBuild.result)
            }
        }
    }
}
A successful run will look like this in Slack:
The image shows a Slack interface with a notification from the Jenkins Slack App about a successful Kubernetes deployment in the "devsecops" pipeline. It includes details like job name, build number, and links to Jenkins and GitHub.

​
Conclusion

Leveraging the Jenkins Blue Ocean API to detect failed stages keeps your pipeline concise and scalable. You’ll get accurate Slack alerts pinpointing the exact stage that failed—no repetitive post { failure { … } } blocks required.

​
References

Watch Video