Failing builds on test failures in Jenkins - Cheat Sheet & Quick Revision

Recall & Review

beginner

What does it mean when a Jenkins build fails on test failures?

It means Jenkins stops the build process and marks it as failed if any automated test does not pass. This helps catch problems early.

beginner

How can you configure Jenkins to fail a build if tests fail?

You add a test step (like JUnit) in the Jenkins pipeline or job and set it to mark the build as failed if tests do not pass.

beginner

Why is failing builds on test failures important in DevOps?

It prevents broken code from moving forward, ensuring only tested and working code is deployed. This keeps software quality high.

intermediate

What Jenkins plugin is commonly used to report test results and fail builds on test failures?

The JUnit plugin is commonly used to parse test reports and fail builds if tests fail.

beginner

What is the effect of ignoring test failures in Jenkins builds?

Ignoring test failures lets broken code pass, which can cause bugs in production and reduce software reliability.

What happens in Jenkins when a test fails and the build is set to fail on test failures?

A The build continues but logs a warning.

B The build stops and is marked as failed.

C The build ignores the failure and passes.

D The build restarts automatically.

When Jenkins is configured to fail on test failures, any failed test causes the build to stop and be marked as failed.

Which Jenkins plugin helps to mark builds as failed based on test results?

A JUnit plugin

B Git plugin

C Docker plugin

D Slack plugin

The JUnit plugin parses test reports and can fail builds if tests fail.

Why should builds fail on test failures in a CI/CD pipeline?

A To allow manual testing later

B To speed up the build process

C To prevent broken code from deploying

D To ignore minor errors

Failing builds on test failures stops broken code from moving forward, ensuring quality.

How do you tell Jenkins to fail a build on test failures in a pipeline script?

A Use the 'junit' step with 'allowEmptyResults: false'

B Use 'echo' command

C Use 'sh' step without test commands

D Use 'archiveArtifacts' step

The 'junit' step processes test results and fails the build if tests fail.

What is a risk of not failing builds on test failures?

A Builds run faster

B Build logs get smaller

C Tests run twice

D Broken code may reach production

Ignoring test failures risks deploying broken or buggy code.

Explain why failing builds on test failures is important in Jenkins pipelines.

Think about how catching errors early helps the team.

Describe how to configure a Jenkins pipeline to fail the build if tests fail.

Focus on the Jenkins pipeline syntax for test results.

Practice

1. What happens to a Jenkins build if a test command returns a failure exit code?

easy

A. The build restarts the test command automatically.

B. The build ignores the test failure and continues.

C. The build pauses and waits for manual approval.

D. The build fails automatically to indicate test failure.

Solution

1. Step 1: Understand Jenkins build behavior on command failure

   Jenkins treats any shell or batch command that returns a non-zero exit code as a failure.

2. Step 2: Relate test command failure to build status

   If tests fail and return a failure code, Jenkins marks the entire build as failed automatically.

3. Final Answer:

   The build fails automatically to indicate test failure. -> Option D

4. Quick Check:

   Test failure exit code causes build failure [OK]

Hint: Non-zero exit code from tests fails the build [OK]

Common Mistakes:

• Thinking Jenkins ignores test failures by default
• Assuming manual intervention is needed on test failure
• Believing Jenkins retries failed test commands automatically

2. Which of the following Jenkins pipeline syntax snippets correctly fails the build if tests fail?

easy

A. sh 'run_tests.sh & wait' // runs tests in background

B. sh 'run_tests.sh || true' // ignores test failures

C. sh 'run_tests.sh' // fails build if script exits non-zero

D. sh 'run_tests.sh; echo done' // always succeeds

Solution

1. Step 1: Analyze each shell command's effect on build status

   sh 'run_tests.sh' // fails build if script exits non-zero runs the test script normally; if it exits non-zero, Jenkins fails the build.

2. Step 2: Identify commands that ignore failure

   sh 'run_tests.sh || true' // ignores test failures uses '|| true' which forces success, ignoring failures; C runs in background, not failing build; D always succeeds due to echo.

3. Final Answer:

   sh 'run_tests.sh' // fails build if script exits non-zero -> Option C

4. Quick Check:

   Normal shell command fails build on error [OK]

Hint: Avoid '|| true' to let Jenkins catch test failures [OK]

Common Mistakes:

• Adding '|| true' to shell commands
• Running tests in background without waiting
• Appending commands that always succeed after tests

3. Given this Jenkins pipeline snippet, what will be the build result if pytest finds failing tests?

pipeline {
  agent any
  stages {
    stage('Test') {
      steps {
        sh 'pytest'
      }
    }
  }
}

medium

A. Build will succeed regardless of test results.

B. Build will fail if pytest returns a failure exit code.

C. Build will be unstable but not fail.

D. Build will skip the test stage.

Solution

1. Step 1: Understand Jenkins behavior on shell step failure

   The sh step fails the build if the command exits with a non-zero code.

2. Step 2: Recognize pytest exit codes

   pytest returns non-zero exit code if any test fails, causing Jenkins to fail the build.

3. Final Answer:

   Build will fail if pytest returns a failure exit code. -> Option B

4. Quick Check:

   Failing tests cause non-zero exit, fail build [OK]

Hint: Test commands returning non-zero fail build [OK]

Common Mistakes:

• Assuming build passes despite test failures
• Confusing unstable with failed build
• Thinking Jenkins skips failing test stages

4. You have a Jenkins pipeline where tests fail but the build still shows as SUCCESS. What is the most likely cause?

medium

A. The test command is run with '|| true' which ignores failures.

B. The pipeline is missing the 'agent any' declaration.

C. The Jenkins server is offline during the test stage.

D. The post section is configured to always mark build as success.

Solution

1. Step 1: Identify why build ignores test failures

   Using '|| true' after test commands forces success regardless of test results.

2. Step 2: Exclude other causes

   Missing 'agent any' causes pipeline failure, server offline stops build, post section can't override success if test fails.

3. Final Answer:

   The test command is run with '|| true' which ignores failures. -> Option A

4. Quick Check:

   '|| true' masks test failures causing success [OK]

Hint: Check for '|| true' masking failures in shell steps [OK]

Common Mistakes:

• Blaming missing agent for test failure ignoring
• Assuming Jenkins server offline lets build succeed
• Misconfiguring post section to override failure

5. How can you configure a Jenkins declarative pipeline to always run tests but mark the build as UNSTABLE instead of FAILED when tests fail?

hard

A. Use post { always { junit '**/test-results.xml' } } and catchError(buildResult: 'UNSTABLE') around test step.

B. Add sh 'run_tests.sh || true' to ignore failures.

C. Set options { skipStagesAfterUnstable() } in pipeline.

D. Use post { failure { echo 'Tests failed' } } without changing build status.

Solution

1. Step 1: Use catchError to catch test failures and mark build unstable

   Wrapping test commands with catchError(buildResult: 'UNSTABLE') prevents build failure but marks unstable.

2. Step 2: Use post section to publish test results

   Publishing test results with junit reports test failures and sets build status accordingly.

3. Final Answer:

   Use post { always { junit '**/test-results.xml' } } and catchError(buildResult: 'UNSTABLE') around test step. -> Option A

4. Quick Check:

   catchError + junit marks unstable, not failed [OK]

Hint: Use catchError(buildResult: 'UNSTABLE') to mark unstable [OK]

Common Mistakes:

• Ignoring test failures with '|| true' instead of marking unstable
• Misusing post failure block without changing status
• Skipping test stages after unstable status