Pipeline stages and steps in Jenkins - Mini Project: Build & Apply

Jenkins Pipeline Stages and Steps

📖 Scenario: You are setting up a Jenkins pipeline to automate a simple software build process. The pipeline will have multiple stages to organize the workflow clearly.

🎯 Goal: Build a Jenkins pipeline script with three stages: Build, Test, and Deploy. Each stage will have one step that prints a message indicating the stage is running.

📋 What You'll Learn

Create a Jenkins pipeline script using the pipeline syntax

Define three stages named Build, Test, and Deploy

Add a steps block inside each stage

Inside each steps block, add a echo command that prints the exact message: "Building...", "Testing...", and "Deploying..." respectively

💡 Why This Matters

🌍 Real World

Jenkins pipelines automate software build, test, and deployment tasks in real projects, saving time and reducing errors.

💼 Career

Understanding pipeline stages and steps is essential for DevOps engineers and automation specialists to create reliable CI/CD workflows.

1

Create the pipeline skeleton

Write the initial Jenkins pipeline script with the pipeline block and an empty stages block.

Jenkins

pipeline {
    agent any
    stages {
        // Your code here
    }
}

Hint

Start with pipeline { and add agent any to run on any available agent. Then add an empty stages block.

2

Add the Build stage with a step

Inside the stages block, add a stage named Build with a steps block that contains echo "Building...".

Jenkins

pipeline {
    agent any
    stages {
        // Add Build stage here
    }
}

Hint

Use stage('Build') and inside it add steps { echo "Building..." }.

3

Add Test and Deploy stages with steps

Add two more stages inside stages: Test with echo "Testing..." and Deploy with echo "Deploying..." inside their steps blocks.

Jenkins

pipeline {
    agent any
    stages {
        stage('Build') {
            steps {
                echo "Building..."
            }
        }
        // Add Test and Deploy stages here
    }
}

Hint

Add stage('Test') and stage('Deploy') blocks with their respective steps and echo commands.

4

Print the pipeline script

Print the entire Jenkins pipeline script by writing the full script as output (simulate the final script).

Jenkins

pipeline {
    agent any
    stages {
        stage('Build') {
            steps {
                echo "Building..."
            }
        }
        stage('Test') {
            steps {
                echo "Testing..."
            }
        }
        stage('Deploy') {
            steps {
                echo "Deploying..."
            }
        }
    }
}
// Print the pipeline script below
// Your code here

Hint

Use println statements to print each line of the pipeline script exactly as it appears.

Practice

1. What is the main purpose of stages in a Jenkins pipeline?

easy

A. To define environment variables

B. To run shell commands directly

C. To divide the pipeline into distinct parts for clarity

D. To store pipeline logs

Solution

1. Step 1: Understand the role of stages

   Stages are used to split the pipeline into clear sections, making it easier to read and manage.

2. Step 2: Differentiate stages from steps

   Steps are the actual commands or actions inside stages, not the division itself.

3. Final Answer:

   To divide the pipeline into distinct parts for clarity -> Option C

4. Quick Check:

   Stages divide pipeline parts = C [OK]

Hint: Stages split pipeline parts; steps run commands inside [OK]

Common Mistakes:

• Confusing stages with steps
• Thinking stages run commands directly
• Assuming stages store logs

2. Which of the following is the correct syntax to define a stage named Build in a Jenkins declarative pipeline?

easy

A. stages { Build { steps { echo 'Building...' } } }

B. stage: Build { steps { echo 'Building...' } }

C. stage { name: 'Build' steps { echo 'Building...' } }

D. stage('Build') { steps { echo 'Building...' } }

Solution

1. Step 1: Recall declarative pipeline stage syntax

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

2. Step 2: Check the options for correct structure

   stage('Build') { steps { echo 'Building...' } } matches the correct syntax with stage('Build') { steps { ... } }.

3. Final Answer:

   stage('Build') { steps { echo 'Building...' } } -> Option D

4. Quick Check:

   Stage syntax uses stage('name') { steps { ... } } = A [OK]

Hint: Use stage('Name') { steps { ... } } for stages [OK]

Common Mistakes:

• Using colon instead of parentheses for stage name
• Placing stage inside stages incorrectly
• Missing quotes around stage name

3. Given this Jenkins pipeline snippet, what will be the output when the pipeline runs?

pipeline {
  agent any
  stages {
    stage('Test') {
      steps {
        echo 'Running tests'
      }
    }
  }
}

medium

A. Running tests

B. Build stage executed

C. Syntax error

D. No output

Solution

1. Step 1: Identify the stage and steps

   The pipeline has one stage named 'Test' with a step that echoes 'Running tests'.

2. Step 2: Understand echo step output

   The echo step prints the given string to the console output when the pipeline runs.

3. Final Answer:

   Running tests -> Option A

4. Quick Check:

   Echo prints 'Running tests' = A [OK]

Hint: Echo prints text inside steps during stage run [OK]

Common Mistakes:

• Thinking stage name prints output
• Assuming syntax error without checking carefully
• Expecting output from missing steps

4. Identify the error in this Jenkins pipeline snippet:

pipeline {
  agent any
  stages {
    stage('Deploy')
      steps {
        echo 'Deploying app'
      }
  }
}

medium

A. Steps block should be outside stages

B. Missing curly braces after stage declaration

C. Echo command syntax error

D. Incorrect agent declaration

Solution

1. Step 1: Check stage syntax

   The stage block must have curly braces enclosing its content: stage('Deploy') { ... }.

2. Step 2: Identify missing braces

   In the snippet, the stage declaration lacks opening and closing braces around steps.

3. Final Answer:

   Missing curly braces after stage declaration -> Option B

4. Quick Check:

   Stage needs braces { } = D [OK]

Hint: Always use braces {} after stage('name') [OK]

Common Mistakes:

• Forgetting braces after stage name
• Placing steps outside stages block
• Misunderstanding agent syntax

5. You want to create a Jenkins pipeline with two stages: Build and Test. The Test stage should only run if the Build stage succeeds. Which pipeline snippet correctly implements this logic?

hard

A. pipeline {
agent any
stages {
stage('Build') {
steps {
echo 'Building...'
}
}
stage('Test') {
steps {
echo 'Testing...'
}
}
}
}

B. pipeline {
agent any
stages {
stage('Build') {
steps {
echo 'Building...'
}
}
stage('Test') {
when {
expression { currentBuild.result == 'SUCCESS' }
}
steps {
echo 'Testing...'
}
}
}
}

C. pipeline {
agent any
stages {
stage('Build') {
steps {
echo 'Building...'
}
}
stage('Test') {
when {
branch 'main'
}
steps {
echo 'Testing...'
}
}
}
}

D. pipeline {
agent any
stages {
stage('Build') {
steps {
echo 'Building...'
}
}
stage('Test') {
steps {
echo 'Testing...'
}
}
}
post {
success {
echo 'Build succeeded'
}
}
}

Solution

1. Step 1: Understand conditional stage execution

   Jenkins declarative pipelines run stages sequentially by default. If the Build stage fails, the Test stage is skipped.

2. Step 2: Check the snippet with sequential stages

   pipeline {
     agent any
     stages {
       stage('Build') {
         steps {
           echo 'Building...'
         }
       }
       stage('Test') {
         steps {
           echo 'Testing...'
         }
       }
     }
   }

3. Step 3: Verify distractors

   The snippet with when { expression { currentBuild.result == 'SUCCESS' } } uses the correct property result instead of currentResult.
   The snippet with when { branch 'main' } conditions on Git branch.
   The snippet with post { success { ... } } adds an unrelated post-action block.

4. Final Answer:

   pipeline { agent any stages { stage('Build') { steps { echo 'Building...' } } stage('Test') { steps { echo 'Testing...' } } } } -> Option A

5. Quick Check:

   Sequential stages run conditionally by default = A [OK]

Hint: Stages run sequentially by default; failure skips subsequent stages [OK]

Common Mistakes:

• Using invalid when expression syntax
• Conditioning on branch instead of stage success
• Adding unnecessary post blocks