Build tools (Maven, Gradle, npm) in Jenkins - Mini Project: Build & Apply

Automate a Simple Build with Jenkins Using Maven

📖 Scenario: You are a developer who wants to automate building a Java project using Jenkins and Maven. Jenkins will run the Maven build command to compile the project and run tests automatically whenever you trigger the build.

🎯 Goal: Build a Jenkins pipeline script that runs a Maven build command to compile and test a Java project.

📋 What You'll Learn

Create a Jenkins pipeline script with a pipeline block

Define an agent to run the build on any available node

Add a stage called Build that runs the Maven command mvn clean install

Print the build output to the console

💡 Why This Matters

🌍 Real World

Automating builds with Jenkins and Maven is common in software development to ensure code compiles and tests run automatically.

💼 Career

Knowing how to write Jenkins pipelines and use build tools like Maven is essential for DevOps engineers and developers working in continuous integration.

1

Create the Jenkins pipeline skeleton

Write a Jenkins pipeline script starting with pipeline { and define an agent any to run the build on any available node.

Jenkins

pipeline {
    agent any
    // Your code here
}

Hint

Start your Jenkinsfile with pipeline { and add agent any inside it.

2

Add a Build stage

Inside the pipeline block, add a stages block with one stage named Build.

Jenkins

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

Hint

Use stages {} and inside it add stage('Build') { steps { }}.

3

Add Maven build command

Inside the steps block of the Build stage, add a shell command to run mvn clean install using sh.

Jenkins

pipeline {
    agent any
    stages {
        stage('Build') {
            steps {
                // Your code here
            }
        }
    }
}

Hint

Use sh 'mvn clean install' inside the steps block to run the Maven build.

4

Print build output

Add a post block inside the Build stage to print 'Build completed' using echo after the build finishes.

Jenkins

pipeline {
    agent any
    stages {
        stage('Build') {
            steps {
                sh 'mvn clean install'
            }
            // Your code here
        }
    }
}

Hint

Use a post { always { echo 'Build completed' } } block inside the Build stage.

Practice

1. What is the primary purpose of build tools like Maven, Gradle, and npm in Jenkins pipelines?

easy

A. To automate compiling, testing, and packaging code

B. To write application code manually

C. To deploy applications to production servers

D. To monitor server health and uptime

Solution

1. Step 1: Understand build tools' role

   Build tools automate tasks like compiling code, running tests, and packaging software.

2. Step 2: Connect with Jenkins pipeline usage

   Jenkins pipelines use these tools to automate software delivery steps efficiently.

3. Final Answer:

   To automate compiling, testing, and packaging code -> Option A

4. Quick Check:

   Build tools automate build tasks = D [OK]

Hint: Build tools automate code build and test steps [OK]

Common Mistakes:

• Confusing build tools with deployment tools
• Thinking build tools write code
• Mixing monitoring tools with build tools

2. Which of the following is the correct Jenkins pipeline syntax to run a Maven build command?

easy

A. sh 'gradle build'

B. bat 'npm install'

C. bat 'mvn deploy'

D. sh 'mvn clean install'

Solution

1. Step 1: Identify the shell command for Maven

   Maven commands run in shell using sh 'mvn ...' in Jenkins on Linux agents.

2. Step 2: Match the correct Maven build command

   mvn clean install compiles and packages the project.

3. Final Answer:

   sh 'mvn clean install' -> Option D

4. Quick Check:

   Maven build command in shell = C [OK]

Hint: Use sh 'mvn clean install' for Maven builds on Linux [OK]

Common Mistakes:

• Using npm or gradle commands for Maven builds
• Using bat instead of sh on Linux agents
• Confusing deploy with build commands

3. Given this Jenkins pipeline snippet, what will be the output if the npm install command fails?

pipeline {
  agent any
  stages {
    stage('Install') {
      steps {
        sh 'npm install'
      }
    }
  }
}

medium

A. Pipeline continues to next stage ignoring failure

B. Pipeline stops and marks build as failed

C. Pipeline retries npm install automatically

D. Pipeline marks build as unstable but continues

Solution

1. Step 1: Understand default Jenkins shell step behavior

   By default, if sh command fails, Jenkins stops the pipeline and marks build as failed.

2. Step 2: Apply this to npm install failure

   If npm install fails, the pipeline will stop immediately and fail.

3. Final Answer:

   Pipeline stops and marks build as failed -> Option B

4. Quick Check:

   Failed shell command stops pipeline = A [OK]

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

Common Mistakes:

• Assuming pipeline continues after failure
• Thinking Jenkins retries commands automatically
• Confusing unstable with failed build status

4. You wrote this Jenkins pipeline step to run Gradle build but it fails with 'command not found':

sh 'gradle build'

What is the most likely cause and fix?

medium

A. Gradle is not installed or not in PATH; install Gradle or set PATH

B. Syntax error in Jenkinsfile; change to bat 'gradle build'

C. Use npm instead of Gradle for Java projects

D. Replace 'build' with 'install' in the command

Solution

1. Step 1: Analyze error 'command not found'

   This error means the system cannot find the gradle command in the PATH.

2. Step 2: Fix by installing Gradle or updating PATH

   Ensure Gradle is installed on the Jenkins agent and its bin directory is in the PATH environment variable.

3. Final Answer:

   Gradle is not installed or not in PATH; install Gradle or set PATH -> Option A

4. Quick Check:

   Command not found means missing install or PATH = A [OK]

Hint: Check PATH and install Gradle if 'command not found' error occurs [OK]

Common Mistakes:

• Using Windows bat syntax on Linux agents
• Confusing npm with Gradle for Java builds
• Changing command without fixing environment

5. You want to create a Jenkins pipeline that runs npm install, then runs tests with npm test, but only if install succeeds. Which pipeline snippet correctly implements this?

hard

A. sh 'npm install; npm test'

B. try {
sh 'npm install'
sh 'npm test'
} catch (e) {
echo 'Install failed'
}

C. sh 'npm install && npm test'

D. sh 'npm test'
sh 'npm install'

Solution

1. Step 1: Understand command chaining with &&

   Using npm install && npm test runs tests only if install succeeds.

2. Step 2: Compare with other options

   sh 'npm install; npm test' runs test regardless because ';' executes the next command irrespective of exit code. try { sh 'npm install' sh 'npm test' } catch (e) { echo 'Install failed' } uses try-catch but Jenkins declarative pipeline syntax does not support this directly. sh 'npm test' sh 'npm install' runs test before install, which is wrong order.

3. Final Answer:

   sh 'npm install && npm test' -> Option C

4. Quick Check:

   Use && to run second command only if first succeeds = B [OK]

Hint: Chain commands with && to run second only if first succeeds [OK]

Common Mistakes:

• Using ';' instead of '&&' to chain commands
• Using try-catch incorrectly in Jenkinsfile
• Running tests before installing dependencies