Loading libraries in Jenkinsfile - Mini Project: Build & Apply

Loading Libraries in Jenkinsfile

📖 Scenario: You are setting up a Jenkins pipeline to automate your software build process. To keep your Jenkinsfile clean and reusable, you want to load a shared library that contains common functions.

🎯 Goal: Learn how to load a shared library in a Jenkinsfile and use a function from that library in your pipeline.

📋 What You'll Learn

Create a Jenkinsfile with a pipeline block

Load a shared library named my-shared-lib

Call a function greet from the shared library

Print the greeting message in the pipeline

💡 Why This Matters

🌍 Real World

Shared libraries in Jenkins help teams reuse common code like utility functions, reducing duplication and errors.

💼 Career

Knowing how to load and use shared libraries is essential for Jenkins pipeline developers and DevOps engineers to build maintainable CI/CD pipelines.

1

Create a basic Jenkins pipeline

Write a Jenkinsfile that defines a pipeline block with an empty stages section.

Jenkins

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

Hint

Start with the basic Jenkins pipeline syntax including pipeline, agent any, and an empty stages block.

2

Load the shared library

Inside the pipeline block but before stages, add a libraries block that loads the shared library named my-shared-lib using lib('my-shared-lib').

Jenkins

pipeline {
    agent any
    libraries {
        lib('my-shared-lib')
    }
    stages {
        // Your code here
    }
}

Hint

Use the libraries directive with lib('my-shared-lib') to load the shared library before the stages block.

3

Call the greet function from the library

Inside the stages block, add a stage named Greet with a steps section that calls the greet() function and stores its result in a variable called message.

Jenkins

pipeline {
    agent any
    libraries {
        lib('my-shared-lib')
    }
    stages {
        stage('Greet') {
            steps {
                // Your code here
            }
        }
    }
}

Hint

Use a stage with steps and a script block to call greet() and assign it to message.

4

Print the greeting message

Inside the script block of the Greet stage, add a println statement to print the message variable.

Jenkins

pipeline {
    agent any
    libraries {
        lib('my-shared-lib')
    }
    stages {
        stage('Greet') {
            steps {
                script {
                    def message = greet()
                    // Your code here
                }
            }
        }
    }
}

Hint

Use println(message) to print the greeting message returned by greet().

Practice

1. What is the main purpose of loading libraries in a Jenkinsfile?

easy

A. To automatically update Jenkins plugins

B. To reuse common pipeline code across multiple Jenkinsfiles

C. To increase the build speed by caching dependencies

D. To create new Jenkins jobs dynamically

Solution

1. Step 1: Understand the role of libraries in Jenkinsfiles

   Libraries contain reusable pipeline code that can be shared across multiple Jenkinsfiles.

2. Step 2: Identify the benefit of using libraries

   Using libraries helps keep Jenkinsfiles clean and avoids code duplication by reusing common code.

3. Final Answer:

   To reuse common pipeline code across multiple Jenkinsfiles -> Option B

4. Quick Check:

   Libraries = Reuse code [OK]

Hint: Libraries help reuse code, not speed or plugins [OK]

Common Mistakes:

• Confusing libraries with plugin management
• Thinking libraries speed up builds directly
• Assuming libraries create jobs automatically

2. Which of the following is the correct syntax to load a shared library named 'utils' at version '1.2' in a Jenkinsfile?

easy

A. loadLibrary('utils', '1.2')

B. useLibrary utils version 1.2

C. import 'utils:1.2'

D. library 'utils@1.2'

Solution

1. Step 1: Recall the Jenkinsfile syntax for loading libraries

   The correct syntax uses the keyword library followed by the library name and version in quotes, separated by '@'.

2. Step 2: Match the syntax to the options

   library 'utils@1.2' matches the correct syntax: library 'utils@1.2'.

3. Final Answer:

   library 'utils@1.2' -> Option D

4. Quick Check:

   library 'name@version' = correct syntax [OK]

Hint: Use library 'name@version' format to load libraries [OK]

Common Mistakes:

• Using incorrect keywords like loadLibrary or import
• Missing quotes around the library name and version
• Using spaces instead of '@' between name and version

3. Given this Jenkinsfile snippet:

library 'common@2.0'
pipeline {
  agent any
  stages {
    stage('Test') {
      steps {
        script {
          echo common.hello()
        }
      }
    }
  }
}

What will happen when this pipeline runs if the 'common' library has a method hello() that returns 'Hello from common library'?

medium

A. The pipeline will print 'Hello from common library' in the console output

B. The pipeline will fail with a method not found error

C. The pipeline will print 'common.hello()' as a string

D. The pipeline will skip the 'Test' stage silently

Solution

1. Step 1: Understand library loading and method call

   The library 'common@2.0' is loaded, so its methods like hello() are available in the Jenkinsfile.

2. Step 2: Analyze the echo statement

   The echo command calls common.hello(), which returns the string 'Hello from common library', so this string will be printed.

3. Final Answer:

   The pipeline will print 'Hello from common library' in the console output -> Option A

4. Quick Check:

   Loaded library method call prints returned string [OK]

Hint: Loaded library methods return values usable in pipeline [OK]

Common Mistakes:

• Assuming method calls fail without explicit import
• Thinking echo prints code literally
• Expecting silent skip without error

4. You wrote this Jenkinsfile snippet:

library 'tools@latest'
pipeline {
  agent any
  stages {
    stage('Build') {
      steps {
        script {
          tools.build()
        }
      }
    }
  }
}

But the pipeline fails with an error: groovy.lang.MissingPropertyException: No such property: tools. What is the likely cause?

medium

A. The agent 'any' is not supported in this Jenkins version

B. The method build() does not exist in the tools library

C. The library 'tools' is not configured or not loaded properly

D. The Jenkinsfile syntax for stages is incorrect

Solution

1. Step 1: Understand the error message

   The error says 'No such property: tools', meaning the variable or library named 'tools' is not recognized in the pipeline.

2. Step 2: Identify the cause related to library loading

   This usually happens if the shared library 'tools' is not configured in Jenkins or the library failed to load, so the variable 'tools' is undefined.

3. Final Answer:

   The library 'tools' is not configured or not loaded properly -> Option C

4. Quick Check:

   MissingPropertyException means library not loaded [OK]

Hint: MissingPropertyException means library not loaded or configured [OK]

Common Mistakes:

• Assuming method build() missing causes this error
• Blaming pipeline syntax for this error
• Thinking agent 'any' causes this error

5. You want to load two shared libraries in your Jenkinsfile: 'utils' at version '1.0' and 'deploy' at version '2.1'. Which Jenkinsfile snippet correctly loads both libraries and calls a method deployApp() from the 'deploy' library inside a stage?

hard

A. library 'utils@1.0'
library 'deploy@2.1'
pipeline {
agent any
stages {
stage('Deploy') {
steps {
script {
deploy.deployApp()
}
}
}
}
}

B. libraries {
utils '1.0'
deploy '2.1'
}
pipeline {
agent any
stages {
stage('Deploy') {
steps {
script {
deploy.deployApp()
}
}
}
}
}

C. library 'utils@1.0,deploy@2.1'
pipeline {
agent any
stages {
stage('Deploy') {
steps {
script {
deployApp()
}
}
}
}
}

D. library 'utils@1.0'
library 'deploy@2.1'
pipeline {
agent any
stages {
stage('Deploy') {
steps {
script {
deployApp()
}
}
}
}
}

Solution

1. Step 1: Load multiple libraries separately

   Each library must be loaded with its own library 'name@version' statement; library 'utils@1.0' library 'deploy@2.1' pipeline { agent any stages { stage('Deploy') { steps { script { deploy.deployApp() } } } } } correctly loads 'utils@1.0' and 'deploy@2.1' separately.

2. Step 2: Call method from the correct library namespace

   To call deployApp() from 'deploy' library, use deploy.deployApp() inside the script block, as shown in library 'utils@1.0' library 'deploy@2.1' pipeline { agent any stages { stage('Deploy') { steps { script { deploy.deployApp() } } } } }.

3. Final Answer:

   Option A correctly loads both libraries and calls deploy.deployApp() -> Option A

4. Quick Check:

   Separate library calls + qualified method call = library 'utils@1.0' library 'deploy@2.1' pipeline { agent any stages { stage('Deploy') { steps { script { deploy.deployApp() } } } } } [OK]

Hint: Load each library separately; call methods with library name prefix [OK]

Common Mistakes:

• Trying to load multiple libraries in one statement
• Calling methods without library prefix
• Using incorrect syntax like 'libraries' block