Failing fast principle in Jenkins - Commands & Configuration

Introduction

The failing fast principle helps catch errors early in a process so you don't waste time on steps that will fail later. In Jenkins, it means stopping a build as soon as a problem is found to save resources and fix issues quickly.

When you want to stop a build immediately if a test fails to save time.

When you want to avoid running deployment steps if the build or tests fail.

When you want quick feedback on code changes to fix errors faster.

When you want to reduce resource use by not running unnecessary steps after failure.

When you want to keep your pipeline clean by not continuing with broken code.

Config File - Jenkinsfile

Jenkinsfile

pipeline {
  agent any
  stages {
    stage('Build') {
      steps {
        echo 'Building...'
        sh 'exit 0'
      }
    }
    stage('Test') {
      steps {
        echo 'Testing...'
        sh 'exit 1' // Simulate test failure to fail fast
      }
    }
    stage('Deploy') {
      steps {
        echo 'Deploying...'
      }
    }
  }
  post {
    failure {
      echo 'Build failed early, stopping pipeline.'
    }
  }
}

This Jenkinsfile defines a simple pipeline with three stages: Build, Test, and Deploy.

The Test stage runs a command that fails (exit 1) to simulate a test failure.

Because of this failure, Jenkins stops the pipeline immediately and does not run the Deploy stage.

The post section with failure prints a message when the pipeline fails early.

Commands

This command updates the Jenkins job configuration with the Jenkinsfile that implements the failing fast principle.

Terminal

jenkins-jobs --conf jenkins.ini update my-pipeline

Expected Output

Job 'my-pipeline' updated successfully.

This command starts the Jenkins pipeline build to test the failing fast behavior.

Terminal

jenkins-cli build my-pipeline

Expected Output

Started build #1 for job 'my-pipeline'.

This command fetches the console output of the first build to verify that the pipeline stopped after the test failure.

Terminal

jenkins-cli console my-pipeline 1

Expected Output

Building...

Testing...

[Pipeline] sh

+ exit 1

[Pipeline] 

[Pipeline] echo

Build failed early, stopping pipeline.

Finished: FAILURE

Key Concept

If a step fails, stop the pipeline immediately to save time and resources.

Common Mistakes

Not stopping the pipeline after a failure and letting all stages run.

This wastes time and resources running steps that will fail or cause problems later.

Configure the pipeline to fail fast by letting Jenkins stop on errors automatically.

Ignoring the failure messages in the console output.

You miss the chance to fix problems early and the pipeline continues with broken code.

Always check the console output to catch failures early and act on them.

Summary

The Jenkinsfile shows how to stop a pipeline immediately when a test fails.

Commands update the Jenkins job, start a build, and check the output to confirm fail fast.

Failing fast saves time and resources by not running unnecessary steps after failure.

Practice

1. What does the failing fast principle mean in Jenkins pipelines?

easy

A. Run all steps twice to check for errors

B. Stop the pipeline immediately when an error occurs

C. Ignore errors and continue running all steps

D. Delay error handling until the end of the pipeline

Solution

1. Step 1: Understand the failing fast principle

   The principle means to stop work quickly when an error happens to save time and resources.

2. Step 2: Apply to Jenkins pipelines

   In Jenkins, this means the pipeline should stop immediately on error instead of continuing.

3. Final Answer:

   Stop the pipeline immediately when an error occurs -> Option B

4. Quick Check:

   Fail fast = stop immediately on error [OK]

Hint: Fail fast means stop immediately on error [OK]

Common Mistakes:

• Thinking pipeline should continue despite errors
• Confusing fail fast with retrying steps
• Assuming errors are handled at the end

2. Which Jenkins pipeline syntax correctly fails fast when a condition is not met?

easy

A. if (!condition) { echo('Fail fast') }

B. if (!condition) { sleep(10) }

C. if (!condition) { retry(3) }

D. if (!condition) { error('Fail fast') }

Solution

1. Step 1: Identify the Jenkins command to fail fast

   The error() step immediately stops the pipeline with a failure.

2. Step 2: Check the condition usage

   If the condition is false, calling error() triggers fail fast behavior.

3. Final Answer:

   if (!condition) { error('Fail fast') } -> Option D

4. Quick Check:

   Use error() to fail fast [OK]

Hint: Use error() to stop pipeline immediately [OK]

Common Mistakes:

• Using echo() which only prints message
• Using retry() which retries steps instead of failing
• Using sleep() which delays but does not fail

3. What will be the output of this Jenkins pipeline snippet?

pipeline {
  agent any
  stages {
    stage('Test') {
      steps {
        script {
          if (false) {
            error('Fail fast triggered')
          }
          echo('Step completed')
        }
      }
    }
  }
}

medium

A. Pipeline prints 'Step completed' and succeeds

B. Pipeline fails with message 'Fail fast triggered'

C. Pipeline hangs indefinitely

D. Pipeline skips 'Step completed' but succeeds

Solution

1. Step 1: Analyze the condition in the script block

   The condition is false, so error() is not called.

2. Step 2: Check what happens next

   The pipeline executes echo('Step completed') and continues successfully.

3. Final Answer:

   Pipeline prints 'Step completed' and succeeds -> Option A

4. Quick Check:

   False condition skips error(), so pipeline succeeds [OK]

Hint: False condition means error() not called, pipeline continues [OK]

Common Mistakes:

• Assuming error() runs even if condition is false
• Thinking pipeline fails without error() call
• Confusing echo() with error()

4. Identify the error in this Jenkins pipeline snippet that tries to fail fast:

pipeline {
  agent any
  stages {
    stage('Build') {
      steps {
        script {
          if (buildStatus == 'FAILURE')
            error('Build failed')
        }
      }
    }
  }
}

medium

A. buildStatus variable is undefined

B. Incorrect use of error() function

C. Missing braces {} around if block

D. Pipeline syntax requires 'steps' outside 'script'

Solution

1. Step 1: Check variable definitions

   The buildStatus variable is not defined in the pipeline context.

2. Step 2: Verify standard Jenkins variables

   In Jenkins, use currentBuild.result or define buildStatus from previous steps to check status.

3. Final Answer:

   buildStatus variable is undefined -> Option A

4. Quick Check:

   Undefined variables cause runtime errors [OK]

Hint: Check for undefined variables in scripts [OK]

Common Mistakes:

• Assuming error() usage is wrong
• Ignoring undefined variables without context
• Misplacing steps and script blocks

5. You want your Jenkins pipeline to fail fast if any test stage fails, but continue running other stages if tests pass. Which approach best implements this?

hard

A. Use sleep() to delay failure until all tests complete

B. Use try-catch around test stages and call error() in catch

C. Use error() inside each test stage to stop pipeline on failure

D. Use catchError to mark test failures but continue pipeline

Solution

1. Step 1: Understand fail fast requirement

   Fail fast means stop pipeline immediately on test failure, so no further stages run.

2. Step 2: Evaluate options

   Using error() inside each test stage stops pipeline immediately on failure, matching fail fast.

3. Final Answer:

   Use error() inside each test stage to stop pipeline on failure -> Option C

4. Quick Check:

   Fail fast = error() stops pipeline immediately [OK]

Hint: Use error() in failing stages to stop pipeline fast [OK]

Common Mistakes:

• Using catchError which allows pipeline to continue
• Using try-catch which delays failure
• Using sleep() which only delays, not fails