Integration test stages in Jenkins - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of an integration test stage in Jenkins pipelines?

The integration test stage checks if different parts of the software work together correctly after being combined. It helps find issues that unit tests might miss.

beginner

Name a common step included in an integration test stage.

Running automated test scripts that simulate real user scenarios or interactions between components.

intermediate

How do you define an integration test stage in a Jenkins Declarative Pipeline?

You add a stage block named 'Integration Test' inside the pipeline with steps to run the integration tests, for example:

stage('Integration Test') {
  steps {
    sh 'run-integration-tests.sh'
  }
}

beginner

Why is it important to run integration tests after unit tests in a CI/CD pipeline?

Unit tests check small parts individually, while integration tests check if those parts work well together. Running integration tests after unit tests ensures the combined system behaves correctly.

beginner

What happens if integration tests fail in a Jenkins pipeline stage?

The pipeline stage fails, stopping the process. This alerts developers to fix issues before moving to later stages like deployment.

What is the main goal of the integration test stage in Jenkins?

A To write new code features

B To deploy the application to production

C To check if combined software parts work together correctly

D To clean up old build files

Integration tests verify that different parts of the software function together as expected.

Where do you place the integration test stage in a Jenkins Declarative Pipeline?

A Inside the stages block

B Outside the pipeline block

C Inside the environment block

D Inside the post block

All stages, including integration test stages, go inside the stages block in a Declarative Pipeline.

What command might you use to run integration tests in a Jenkins pipeline step?

A echo 'Hello World'

B git clone

C docker build

D sh 'run-integration-tests.sh'

The shell command runs a script that executes integration tests.

If integration tests fail, what is the usual Jenkins pipeline behavior?

A Fail the pipeline and stop further stages

B Ignore the failure and continue

C Automatically fix the errors

D Restart the pipeline from the beginning

Failing tests cause the pipeline to stop to prevent deploying broken code.

Why run integration tests after unit tests?

A To deploy code faster

B To ensure individual parts work before testing them together

C Because integration tests are faster

D To save time by skipping unit tests

Unit tests check parts alone; integration tests check combined parts, so order matters.

Explain the role and typical steps of an integration test stage in a Jenkins pipeline.

Think about how Jenkins stages run commands to check software parts working together.

Describe what happens in a Jenkins pipeline when integration tests fail and why this is important.

Consider the safety checks in continuous integration.

Practice

1. What is the main purpose of an integration test stage in a Jenkins pipeline?

easy

A. To check if different parts of the software work together correctly

B. To deploy the software to production

C. To compile the source code

D. To clean up temporary files after deployment

Solution

1. Step 1: Understand the role of integration tests

   Integration tests verify that different modules or components of software interact correctly.

2. Step 2: Identify the stage purpose in Jenkins

   In Jenkins pipelines, integration test stages run after building the code but before deployment to ensure combined parts work well.

3. Final Answer:

   To check if different parts of the software work together correctly -> Option A

4. Quick Check:

   Integration test purpose = verify combined parts work [OK]

Hint: Integration tests check combined parts, not deployment or build [OK]

Common Mistakes:

• Confusing integration tests with deployment steps
• Thinking integration tests compile code
• Assuming integration tests clean files

2. Which of the following is the correct syntax to define an integration test stage in a Jenkins declarative pipeline?

easy

A. stage: 'Integration Test' steps: sh 'run-tests.sh'

B. integrationTest { steps { sh 'run-tests.sh' } }

C. stage('Integration Test') { steps { sh 'run-tests.sh' } }

D. testStage('Integration Test') { shell 'run-tests.sh' }

Solution

1. Step 1: Recall Jenkins declarative pipeline stage syntax

   The correct syntax uses stage('Name') { steps { ... } } to define stages.

2. Step 2: Match the options to syntax

   stage('Integration Test') { steps { sh 'run-tests.sh' } } matches the correct syntax with stage('Integration Test') { steps { sh 'run-tests.sh' } }.

3. Final Answer:

   stage('Integration Test') { steps { sh 'run-tests.sh' } } -> Option C

4. Quick Check:

   Jenkins stage syntax = stage('name') { steps { ... } } [OK]

Hint: Jenkins stages use stage('name') { steps { ... } } syntax [OK]

Common Mistakes:

• Using incorrect keywords like integrationTest or testStage
• Missing curly braces or wrong colon usage
• Using shell instead of sh for shell commands

3. Given this Jenkins pipeline snippet, what will be the output if the integration tests fail?

pipeline {
  agent any
  stages {
    stage('Build') {
      steps { echo 'Building...' }
    }
    stage('Integration Test') {
      steps { sh 'exit 1' }
    }
    stage('Deploy') {
      steps { echo 'Deploying...' }
    }
  }
}

medium

A. The pipeline retries Integration Test automatically

B. The pipeline continues to Deploy stage despite failure

C. The pipeline skips Build and runs Deploy only

D. The pipeline stops after the Integration Test stage with failure

Solution

1. Step 1: Understand shell command exit codes in Jenkins

   The command sh 'exit 1' simulates a failure because exit code 1 means error.

2. Step 2: Jenkins pipeline behavior on failure

   By default, Jenkins stops the pipeline on any stage failure and does not proceed to next stages.

3. Final Answer:

   The pipeline stops after the Integration Test stage with failure -> Option D

4. Quick Check:

   Failure exit code stops pipeline [OK]

Hint: Exit code 1 in sh step causes pipeline failure and stop [OK]

Common Mistakes:

• Assuming pipeline continues after failure
• Thinking Jenkins retries failed stages automatically
• Confusing exit 0 (success) with exit 1 (failure)

4. You wrote this Jenkins pipeline stage for integration tests:

stage('Integration Test') {
  steps {
    sh 'run-integration-tests.sh'
  }
}

But the pipeline fails with a syntax error. What is the likely cause?

medium

A. Missing steps block inside the stage

B. The pipeline is missing the pipeline block wrapper

C. Incorrect indentation of the sh command

D. The stage keyword is misspelled

Solution

1. Step 1: Check Jenkins declarative pipeline structure

   Every declarative pipeline must start with a pipeline { ... } block wrapping all stages.

2. Step 2: Identify missing pipeline block

   The snippet shows only a stage block without the required pipeline wrapper, causing syntax error.

3. Final Answer:

   The pipeline is missing the pipeline block wrapper -> Option B

4. Quick Check:

   Declarative pipelines need pipeline { stages { ... } } [OK]

Hint: Always wrap stages inside pipeline { } block [OK]

Common Mistakes:

• Assuming indentation causes syntax error
• Forgetting the pipeline block wrapper
• Misspelling stage keyword (not shown here)

5. You want to add an integration test stage that runs only if the build stage succeeds and skips deployment if tests fail. Which Jenkins pipeline snippet correctly implements this logic?

medium

A. stage('Integration Test') {
steps {
sh 'run-tests.sh'
}
}
stage('Deploy') {
steps {
sh 'deploy.sh'
}
}

B. stage('Integration Test') {
steps {
sh 'run-tests.sh'
}
post {
failure { error 'Tests failed, stop pipeline' }
}
}
stage('Deploy') {
steps {
sh 'deploy.sh'
}
}

C. stage('Integration Test') {
steps {
sh 'run-tests.sh || true'
}
}
stage('Deploy') {
steps {
sh 'deploy.sh'
}
}

D. stage('Integration Test') {
steps {
sh 'run-tests.sh'
}
}
stage('Deploy') {
when {
expression { currentBuild.result == null || currentBuild.result == 'SUCCESS' }
}
steps {
sh 'deploy.sh'
}
}

Solution

1. Step 1: Ensure integration tests run after build and affect deployment

   The integration test stage runs normally after build; deployment should only happen if tests pass.

2. Step 2: Identify the correct sequential stage implementation

   In Jenkins pipelines, stages run sequentially by default. A failure in 'Integration Test' (non-zero exit from sh) causes the pipeline to fail and skip the 'Deploy' stage. stage('Integration Test') { steps { sh 'run-tests.sh' } } stage('Deploy') { steps { sh 'deploy.sh' } } correctly implements this logic.

3. Final Answer:

   stage('Integration Test') { steps { sh 'run-tests.sh' } } stage('Deploy') { steps { sh 'deploy.sh' } } -> Option A

4. Quick Check:

   Sequential stage failure skips subsequent stages [OK]

Hint: Default sequential execution stops pipeline on test failure, skipping deploy [OK]

Common Mistakes:

• Ignoring test failure and always deploying
• Using post failure to stop pipeline but not gating deploy
• Forcing tests to pass with || true, hiding failures