Declarative pipeline syntax in Jenkins - Mini Project: Build & Apply

Build a Simple Jenkins Declarative Pipeline

📖 Scenario: You are setting up a Jenkins pipeline to automate a simple build process for a software project. This pipeline will have stages to prepare, build, and test the project.

🎯 Goal: Build a Jenkins declarative pipeline script with three stages: Prepare, Build, and Test. Each stage will run a simple shell command to simulate the step.

📋 What You'll Learn

Use declarative pipeline syntax starting with pipeline block

Define an agent any to run the pipeline on any available agent

Create three stages named Prepare, Build, and Test

In each stage, run a shell command using sh step with exact commands provided

💡 Why This Matters

🌍 Real World

Jenkins pipelines automate software build, test, and deployment processes to save time and reduce errors.

💼 Career

Understanding declarative pipelines is essential for DevOps engineers and automation specialists working with Jenkins.

1

Create the pipeline block with agent

Write a Jenkins declarative pipeline script starting with pipeline block and add agent any inside it.

Jenkins

pipeline {
    // Your code here
}

Hint

The pipeline block is the root of the script. Inside it, add agent any to specify the pipeline runs on any available agent.

2

Add the Prepare stage with shell command

Inside the pipeline block, add a stages block. Then add a stage named Prepare that runs the shell command echo Preparing environment using sh step.

Jenkins

pipeline {
    agent any
    // Your code here
}

Hint

Use stages block to group stages. Each stage has a steps block where you run commands with sh.

3

Add Build and Test stages with shell commands

Inside the existing stages block, add two more stages named Build and Test. In Build, run sh 'echo Building project'. In Test, run sh 'echo Running tests'.

Jenkins

pipeline {
    agent any
    stages {
        stage('Prepare') {
            steps {
                sh 'echo Preparing environment'
            }
        }
        // Your code here
    }
}

Hint

Add multiple stage blocks inside stages. Each stage has its own steps with shell commands.

4

Print the pipeline script to verify

Print the entire Jenkins pipeline script to verify it contains all stages and commands.

Jenkins

pipeline {
    agent any
    stages {
        stage('Prepare') {
            steps {
                sh 'echo Preparing environment'
            }
        }
        stage('Build') {
            steps {
                sh 'echo Building project'
            }
        }
        stage('Test') {
            steps {
                sh 'echo Running tests'
            }
        }
    }
}

// Your code here

Hint

Use println to show a confirmation message that the pipeline script is complete.

Practice

1. Which block is mandatory to start a Jenkins declarative pipeline?

easy

A. stage

B. agent

C. steps

D. pipeline

Solution

1. Step 1: Understand the pipeline structure

   The pipeline block is the root block that wraps the entire declarative pipeline script.

2. Step 2: Identify mandatory blocks

   While agent, stages, and steps are important, the pipeline block is always required to define the pipeline.

3. Final Answer:

   <code>pipeline</code> -> Option D

4. Quick Check:

   Root block = pipeline [OK]

Hint: Look for the root block that wraps everything [OK]

Common Mistakes:

• Confusing stage as root block
• Thinking steps is the top block
• Assuming agent is mandatory alone

2. Which of the following is the correct syntax to define an agent that runs on any available node?

easy

A. agent any

B. agent: any

C. agent { any }

D. agent = any

Solution

1. Step 1: Recall agent syntax in declarative pipeline

   The correct syntax to specify an agent that runs on any available node is agent any without punctuation.

2. Step 2: Check other options for syntax errors

   Options with colons, braces, or equals signs are invalid in declarative pipeline syntax for agent.

3. Final Answer:

   agent any -> Option A

4. Quick Check:

   Agent syntax is simple: agent any [OK]

Hint: Remember: no punctuation, just 'agent any' [OK]

Common Mistakes:

• Adding colons or braces around 'any'
• Using equals sign instead of space
• Confusing scripted pipeline syntax

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

pipeline {
  agent any
  stages {
    stage('Hello') {
      steps {
        echo 'Hello World'
      }
    }
  }
}

medium

A. Fails because 'echo' is not allowed in declarative pipeline

B. Prints 'Hello World' in the build log

C. Pipeline runs but no output is shown

D. Syntax error due to missing agent label

Solution

1. Step 1: Analyze the pipeline structure

   The pipeline has a valid agent any, one stage named 'Hello', and a step that echoes 'Hello World'.

2. Step 2: Understand the echo step behavior

   The echo step prints the given message to the Jenkins build log during execution.

3. Final Answer:

   Prints 'Hello World' in the build log -> Option B

4. Quick Check:

   echo prints message to log [OK]

Hint: echo always prints text to Jenkins console [OK]

Common Mistakes:

• Thinking echo is disallowed in declarative pipelines
• Assuming missing agent label causes error here
• Believing pipeline runs silently without output

4. Identify the error in this declarative pipeline snippet:

pipeline {
  agent any
  stages {
    stage('Build') {
      steps {
        sh 'make build'
      }
    }
  }
  steps {
    echo 'Done'
  }
}

medium

A. The sh command is invalid in declarative pipeline

B. Missing agent block

C. The steps block is misplaced outside stage

D. The stage block must be outside stages

Solution

1. Step 1: Review pipeline block structure

   In declarative pipelines, steps must be inside a stage block, which is inside stages.

2. Step 2: Locate the misplaced steps block

   The steps block with echo 'Done' is incorrectly placed directly under pipeline, outside any stage.

3. Final Answer:

   The <code>steps</code> block is misplaced outside <code>stage</code> -> Option C

4. Quick Check:

   steps must be inside stage [OK]

Hint: steps always go inside a stage block [OK]

Common Mistakes:

• Placing steps directly under pipeline
• Confusing agent placement
• Thinking sh is invalid in declarative pipelines

5. You want to run two stages in parallel in a declarative pipeline. Which snippet correctly defines parallel stages?

hard

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

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

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

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

Solution

1. Step 1: Understand parallel syntax in declarative pipeline

   Parallel stages must be nested inside a stage block using the parallel block.

2. Step 2: Check each option for correct structure

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

   correctly places parallel inside a stage named 'Parallel' with nested stages 'Test' and 'Build'. Other options place parallel incorrectly or omit it.

3. Final Answer:

   Option A with parallel inside a stage block -> Option A

4. Quick Check:

   parallel inside stage block = correct [OK]

Hint: Parallel block must be inside a stage block [OK]

Common Mistakes:

• Placing parallel directly under stages
• Omitting the parallel block
• Placing parallel outside pipeline