Jenkins in the CI/CD ecosystem - Commands & Configuration

Introduction

Jenkins helps automate software building, testing, and deployment. It solves the problem of doing these tasks manually, which can be slow and error-prone.

When you want to automatically test your code every time you save changes.

When you need to build your software and create packages without manual steps.

When you want to deploy your app to a server automatically after tests pass.

When multiple developers work on the same project and need consistent builds.

When you want to track the status of your software builds and tests in one place.

Config File - Jenkinsfile

Jenkinsfile

pipeline {
    agent any
    stages {
        stage('Build') {
            steps {
                echo 'Building the application...'
                sh 'echo Build step running'
            }
        }
        stage('Test') {
            steps {
                echo 'Running tests...'
                sh 'echo Test step running'
            }
        }
        stage('Deploy') {
            steps {
                echo 'Deploying application...'
                sh 'echo Deploy step running'
            }
        }
    }
}

This Jenkinsfile defines a simple pipeline with three stages: Build, Test, and Deploy.

agent any means the pipeline can run on any available Jenkins worker.

Each stage groups related steps, making the process clear and organized.

The steps section contains commands to run, here simple echo and shell commands to simulate work.

Commands

Starts the Jenkins server locally so you can access the Jenkins web interface to create and manage pipelines.

Terminal

java -jar jenkins.war

Expected Output

Running from: /home/user/jenkins.war

2024-06-01 12:00:00.000+0000 [id=1]    INFO    org.eclipse.jetty.server.Server#main: Started @12345ms

Jenkins is fully up and running

Triggers a build of the Jenkins pipeline named 'my-pipeline' using the Jenkins REST API with basic authentication.

Terminal

curl -X POST http://localhost:8080/job/my-pipeline/build --user admin:admin123

Expected Output

HTTP/1.1 201 Created

Location: http://localhost:8080/queue/item/123/

→

-X POST - Specifies the HTTP method to trigger the build

→

--user admin:admin123 - Provides authentication credentials

Fetches the status and details of the last build of 'my-pipeline' in JSON format to check if it succeeded.

Terminal

curl http://localhost:8080/job/my-pipeline/lastBuild/api/json --user admin:admin123

Expected Output

{

  "result": "SUCCESS",

  "building": false,

  "number": 5

}

→

--user admin:admin123 - Provides authentication credentials

Key Concept

If you remember nothing else from Jenkins pipelines, remember: they automate your build, test, and deploy steps so you don't have to do them by hand.

Common Mistakes

Not starting the Jenkins server before trying to trigger builds.

The Jenkins commands will fail because the server is not running to accept requests.

Always start Jenkins with 'java -jar jenkins.war' before using the web interface or API.

Using incorrect authentication credentials when triggering builds via API.

Jenkins will reject the request with an authentication error, and the build won't start.

Use the correct username and API token or password for the Jenkins user.

Not defining stages in the Jenkinsfile, causing unclear or unorganized pipelines.

Without stages, it's hard to see which part of the pipeline is running or failing.

Always organize your pipeline into clear stages like Build, Test, and Deploy.

Summary

Start Jenkins server to enable pipeline automation.

Use a Jenkinsfile to define build, test, and deploy stages clearly.

Trigger and monitor builds using Jenkins web UI or REST API.

Practice

1. What is the primary role of Jenkins in the CI/CD ecosystem?

easy

A. Automate building, testing, and deploying software

B. Write application code

C. Design user interfaces

D. Manage database schemas

Solution

1. Step 1: Understand Jenkins purpose

   Jenkins is a tool designed to automate software processes like building, testing, and deployment.

2. Step 2: Compare options with Jenkins role

   Only Automate building, testing, and deploying software matches Jenkins' automation role in CI/CD; others relate to unrelated tasks.

3. Final Answer:

   Automate building, testing, and deploying software -> Option A

4. Quick Check:

   Jenkins automates CI/CD tasks = A [OK]

Hint: Jenkins automates software delivery steps [OK]

Common Mistakes:

• Confusing Jenkins with coding or UI design tools
• Thinking Jenkins manages databases
• Assuming Jenkins writes application code

2. Which of the following is the correct syntax to define a simple Jenkins pipeline in a Jenkinsfile?

easy

A. job {
steps {
echo 'Building...'
}
}

B. build {
steps {
echo 'Building...'
}
}

C. pipeline: {
stage('Build') {
echo 'Building...'
}
}

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

Solution

1. Step 1: Review Jenkins pipeline syntax

   The correct Jenkins pipeline uses the 'pipeline' block with 'agent' and 'stages' sections.

2. Step 2: Match syntax with options

   pipeline { agent any stages { stage('Build') { steps { echo 'Building...' } } } } correctly shows the pipeline structure with agent, stages, and steps. Others have invalid or incomplete syntax.

3. Final Answer:

   Correct Jenkins pipeline syntax with agent and stages -> Option D

4. Quick Check:

   Valid Jenkinsfile uses 'pipeline' block = D [OK]

Hint: Look for 'pipeline', 'agent', and 'stages' keywords [OK]

Common Mistakes:

• Missing 'agent' block in pipeline
• Using 'build' or 'job' instead of 'pipeline'
• Incorrect block nesting or missing braces

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

pipeline {
  agent any
  stages {
    stage('Test') {
      steps {
        echo 'Starting tests'
        script {
          def result = 2 + 3
          echo "Result is ${result}"
        }
      }
    }
  }
}

medium

A. Starting tests
Result is ${result}

B. Starting tests
Result is 5

C. Starting tests
Result is 23

D. Syntax error in pipeline

Solution

1. Step 1: Understand pipeline script block execution

   The 'script' block allows Groovy code execution; 'def result = 2 + 3' calculates 5.

2. Step 2: Analyze echo statements

   First echo prints 'Starting tests', second prints 'Result is 5' using string interpolation.

3. Final Answer:

   Starting tests Result is 5 -> Option B

4. Quick Check:

   Groovy evaluates expressions inside ${} = C [OK]

Hint: Groovy evaluates ${} inside double quotes [OK]

Common Mistakes:

• Treating ${result} as plain text
• Concatenating numbers as strings
• Assuming syntax error due to script block

4. You have this Jenkins pipeline snippet:

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

What is the problem with this pipeline?

medium

A. Multiple 'stages' blocks are not allowed in one pipeline

B. Missing 'agent' declaration

C. Echo commands are invalid in Jenkinsfile

D. Pipeline must have at least three stages

Solution

1. Step 1: Review pipeline structure rules

   A Jenkins pipeline can have only one 'stages' block containing multiple 'stage' blocks.

2. Step 2: Identify error in given pipeline

   Here, there are two separate 'stages' blocks, which is invalid syntax.

3. Final Answer:

   Multiple 'stages' blocks are not allowed in one pipeline -> Option A

4. Quick Check:

   Only one 'stages' block per pipeline = B [OK]

Hint: Only one 'stages' block allowed in Jenkinsfile [OK]

Common Mistakes:

• Thinking multiple 'stages' blocks are valid
• Confusing missing agent with stages error
• Assuming echo commands cause errors

5. You want to create a Jenkins pipeline that builds your project only if the branch is 'main' and runs tests on all branches. Which pipeline snippet correctly implements this logic?

pipeline {
  agent any
  stages {
    stage('Build') {
      when {
        branch 'main'
      }
      steps {
        echo 'Building main branch'
      }
    }
    stage('Test') {
      steps {
        echo 'Running tests'
      }
    }
  }
}

hard

A. The pipeline builds and tests only on 'main' branch

B. The pipeline builds on all branches and tests only on 'main'

C. The pipeline builds only on 'main' branch and tests on all branches as required

D. The pipeline builds and tests on all branches without conditions

Solution

1. Step 1: Understand 'when' condition in Build stage

   The 'when { branch 'main' }' condition restricts the Build stage to run only on the 'main' branch.

2. Step 2: Analyze Test stage behavior

   The Test stage has no 'when' condition, so it runs on all branches.

3. Final Answer:

   The pipeline builds only on 'main' branch and tests on all branches as required -> Option C

4. Quick Check:

   'when' limits build; test runs always = A [OK]

Hint: Use 'when' to limit stages by branch [OK]

Common Mistakes:

• Assuming all stages run on all branches
• Misplacing 'when' condition on Test stage
• Confusing branch names or conditions