Why Running unit tests in pipeline in Jenkins? - Purpose & Use Cases

The Big Idea

What if your code could test itself every time you save it?

The Scenario

Imagine you write code and then manually run tests on your computer before sharing it with your team.

You have to remember to run all tests every time, and sometimes you forget or miss some.

The Problem

Manually running tests is slow and easy to forget.

It causes bugs to sneak into the shared code because tests were skipped or done incorrectly.

This wastes time fixing problems later.

The Solution

Running unit tests automatically in a pipeline means tests run every time code changes.

This catches errors early and saves time by stopping bad code from moving forward.

Before vs After

✗ Before

git push origin main
# Then remember to run tests manually

✓ After

pipeline {
  agent any
  stages {
    stage('Test') {
      steps {
        sh 'run-unit-tests.sh'
      }
    }
  }
}

What It Enables

It makes sure your code is always tested and safe before sharing with others.

Real Life Example

A developer pushes code to GitHub, and Jenkins automatically runs all unit tests before merging to the main project.

Key Takeaways

Manual testing is slow and error-prone.

Automated tests in pipelines catch bugs early.

This keeps code quality high and saves time.

Practice

1. What is the main purpose of running unit tests in a Jenkins pipeline?

easy

A. To monitor server performance

B. To deploy the application automatically

C. To create a backup of the code repository

D. To catch bugs early and ensure code quality

Solution

1. Step 1: Understand the role of unit tests

   Unit tests check small parts of code to find bugs early.

2. Step 2: Connect unit tests to pipeline goals

   Running tests in Jenkins pipeline helps maintain code quality before deployment.

3. Final Answer:

   To catch bugs early and ensure code quality -> Option D

4. Quick Check:

   Unit tests catch bugs early [OK]

Hint: Unit tests catch bugs early, not deploy or backup [OK]

Common Mistakes:

• Confusing testing with deployment
• Thinking tests create backups
• Assuming tests monitor performance

2. Which Jenkins pipeline syntax correctly runs unit tests using a shell command?

easy

A. execute shell('pytest tests/')

B. sh 'pytest tests/'

C. run 'pytest tests/'

D. command('pytest tests/')

Solution

1. Step 1: Recall Jenkins pipeline shell syntax

   Jenkins uses the sh step to run shell commands.

2. Step 2: Match the correct syntax

   sh 'pytest tests/' is the correct way to run tests in a shell step.

3. Final Answer:

   sh 'pytest tests/' -> Option B

4. Quick Check:

   Use sh for shell commands [OK]

Hint: Use 'sh' step to run shell commands in Jenkins pipeline [OK]

Common Mistakes:

• Using non-existent steps like 'run' or 'command'
• Incorrect function syntax for shell commands
• Missing quotes around command string

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

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

medium

A. Pipeline fails and stops execution

B. Pipeline ignores test failures and continues

C. Pipeline retries the test stage automatically

D. Pipeline marks tests as passed regardless

Solution

1. Step 1: Understand default behavior of sh step

   The sh step fails the pipeline if the command exits with a non-zero status (test failure).

2. Step 2: Predict pipeline reaction to test failure

   Since tests fail, the pipeline stage fails and stops further execution.

3. Final Answer:

   Pipeline fails and stops execution -> Option A

4. Quick Check:

   sh fails pipeline on error [OK]

Hint: Failed shell commands stop pipeline by default [OK]

Common Mistakes:

• Assuming pipeline continues despite test failure
• Thinking Jenkins retries failed stages automatically
• Believing tests pass regardless of results

4. You wrote this Jenkins pipeline stage to run tests:

stage('Test') {
  steps {
    sh pytest tests/
  }
}

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

medium

A. Incorrect stage name

B. Missing agent declaration

C. Missing quotes around the shell command

D. Using 'sh' outside steps block

Solution

1. Step 1: Check shell command syntax in Jenkins pipeline

   The sh step requires the command as a quoted string.

2. Step 2: Identify missing quotes causing syntax error

   Here, sh pytest tests/ lacks quotes around pytest tests/.

3. Final Answer:

   Missing quotes around the shell command -> Option C

4. Quick Check:

   Shell commands must be quoted in sh step [OK]

Hint: Always quote shell commands in sh step [OK]

Common Mistakes:

• Forgetting quotes around commands
• Confusing stage name with syntax error cause
• Ignoring required agent declaration elsewhere

5. How can you modify a Jenkins pipeline to run unit tests but continue the pipeline even if tests fail, while still marking the test stage as unstable?

hard

A. Use catchError(buildResult: 'UNSTABLE', stageResult: 'UNSTABLE') { sh 'pytest tests/' }

B. Use sh 'pytest tests/' || true without any catchError

C. Remove the test stage from the pipeline

D. Use sh 'pytest tests/' inside a timeout block

Solution

1. Step 1: Understand how to catch errors without failing pipeline

   The catchError step can catch failures and mark the build unstable instead of failing.

2. Step 2: Apply catchError with proper parameters

   Using catchError(buildResult: 'UNSTABLE', stageResult: 'UNSTABLE') around the test command allows continuation but marks stage unstable.

3. Final Answer:

   Use catchError(buildResult: 'UNSTABLE', stageResult: 'UNSTABLE') { sh 'pytest tests/' } -> Option A

4. Quick Check:

   Use catchError to continue on test failure [OK]

Hint: Wrap tests in catchError to continue but mark unstable [OK]

Common Mistakes:

• Using '|| true' hides failures without marking unstable
• Removing test stage skips testing
• Timeout does not handle test failures