Testing shared libraries in Jenkins - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a shared library in Jenkins?

A shared library in Jenkins is a reusable set of scripts and functions stored in a central place that multiple Jenkins pipelines can use to avoid repeating code.

beginner

Why should you test Jenkins shared libraries?

Testing shared libraries ensures that the reusable code works correctly, prevents errors in pipelines that use them, and helps maintain stable and reliable automation.

intermediate

Name one common tool used to test Jenkins shared libraries.

The Jenkins Pipeline Unit framework is commonly used to write unit tests for Jenkins shared libraries.

intermediate

What is the purpose of mocking in testing Jenkins shared libraries?

Mocking simulates parts of the Jenkins environment or pipeline steps so tests can run without needing a full Jenkins server, making tests faster and more focused.

intermediate

How do you run tests for Jenkins shared libraries locally?

You can run tests locally using a testing framework like Jenkins Pipeline Unit with a build tool such as Gradle or Maven to execute the test scripts on your computer.

What is the main benefit of using Jenkins shared libraries?

A Increase Jenkins server memory

B Schedule Jenkins jobs automatically

C Create new Jenkins users

D Reuse code across multiple pipelines

Shared libraries allow you to reuse code in many pipelines, avoiding duplication.

Which tool helps you write unit tests for Jenkins shared libraries?

A Jenkins Pipeline Unit

B Docker

C Git

D Kubernetes

Jenkins Pipeline Unit is designed to test Jenkins pipeline code and shared libraries.

What does mocking do in Jenkins shared library tests?

A Deletes pipeline scripts

B Simulates Jenkins steps for testing

C Runs Jenkins on a server

D Creates new Jenkins jobs

Mocking simulates parts of Jenkins so tests can run without a full Jenkins environment.

Where are Jenkins shared libraries usually stored?

A In a Docker container

B On a Jenkins agent

C In a Git repository

D In Jenkins logs

Shared libraries are stored in Git repositories to manage versions and share code.

How can you run Jenkins shared library tests without Jenkins server?

A Using Jenkins Pipeline Unit locally

B By restarting Jenkins

C Using Jenkins Blue Ocean

D By creating a new Jenkins job

Jenkins Pipeline Unit allows running tests locally without a Jenkins server.

Explain how you would test a Jenkins shared library to ensure it works correctly.

Think about tools and techniques to simulate Jenkins environment and run tests without Jenkins server.

Describe the benefits of testing Jenkins shared libraries before using them in pipelines.

Consider how testing helps keep automation stable and saves effort.

Practice

1. What is the main purpose of testing shared libraries in Jenkins pipelines?

easy

A. To automatically deploy applications to production

B. To speed up Jenkins server startup time

C. To reduce the size of the Jenkins workspace

D. To ensure reusable code works correctly across multiple pipelines

Solution

1. Step 1: Understand shared libraries role

   Shared libraries contain reusable code for Jenkins pipelines used in many projects.

2. Step 2: Identify testing purpose

   Testing ensures this reusable code behaves correctly and avoids breaking pipelines.

3. Final Answer:

   To ensure reusable code works correctly across multiple pipelines -> Option D

4. Quick Check:

   Testing shared libraries = verify reusable code [OK]

Hint: Testing shared libraries means checking reusable pipeline code [OK]

Common Mistakes:

• Confusing testing with deployment
• Thinking testing speeds Jenkins startup
• Assuming testing reduces workspace size

2. Which syntax correctly loads a shared library in a Jenkins pipeline script?

easy

A. library('my-shared-lib')

B. loadLibrary 'my-shared-lib'

C. @LoadLibrary('my-shared-lib')

D. importLibrary('my-shared-lib')

Solution

1. Step 1: Recall Jenkins shared library loading syntax

   The correct way is to use the library() step with the library name as a string.

2. Step 2: Verify options

   Only library('my-shared-lib') uses the correct library('name') syntax. Others are invalid Jenkins syntax.

3. Final Answer:

   library('my-shared-lib') -> Option A

4. Quick Check:

   Use library('name') to load shared libraries [OK]

Hint: Use library('lib-name') to load shared libraries [OK]

Common Mistakes:

• Using incorrect keywords like loadLibrary
• Confusing annotations with @Library
• Trying to import libraries like code modules

3. Given this Jenkins pipeline snippet using a shared library:

library('utils')
node {
  stage('Test') {
    echo utils.helloWorld()
  }
}

If the shared library 'utils' defines helloWorld() returning 'Hello from utils!', what will be the pipeline output?

medium

A. Hello from utils!

B. utils.helloWorld()

C. Error: helloWorld() not found

D. No output

Solution

1. Step 1: Understand library usage

   The library('utils') loads the shared library named 'utils'.

2. Step 2: Evaluate method call

   The call utils.helloWorld() invokes the method returning 'Hello from utils!'.

3. Final Answer:

   Hello from utils! -> Option A

4. Quick Check:

   Calling shared library method returns its string output [OK]

Hint: Loaded library methods return their defined outputs [OK]

Common Mistakes:

• Expecting method name printed literally
• Assuming method is undefined without import
• Thinking no output appears without explicit return

4. You wrote a test for a shared library function but get this error: groovy.lang.MissingMethodException: No signature of method. What is the likely cause?

medium

A. The pipeline syntax is outdated

B. The Jenkins server is offline

C. The shared library is not loaded properly in the test environment

D. The test script has a syntax error unrelated to the library

Solution

1. Step 1: Analyze error meaning

   The error means the method called does not exist in the current context.

2. Step 2: Connect to shared library loading

   This usually happens if the shared library is not loaded or mocked correctly in the test environment.

3. Final Answer:

   The shared library is not loaded properly in the test environment -> Option C

4. Quick Check:

   MissingMethodException = library not loaded [OK]

Hint: MissingMethodException often means library not loaded in test [OK]

Common Mistakes:

• Blaming Jenkins server status
• Assuming syntax error without checking method
• Ignoring library loading in tests

5. You want to automate testing of a Jenkins shared library function that returns a greeting based on a name parameter. Which approach best ensures fast feedback without running a full Jenkins pipeline?

hard

A. Run the full Jenkins pipeline on every code change

B. Write unit tests using a Groovy testing framework outside Jenkins

C. Manually trigger Jenkins jobs to test the function

D. Use Jenkins UI to test the function interactively

Solution

1. Step 1: Identify testing goals

   Fast feedback means quick tests without waiting for full Jenkins runs.

2. Step 2: Choose testing method

   Unit tests outside Jenkins using Groovy frameworks allow fast, automated checks of library functions.

3. Final Answer:

   Write unit tests using a Groovy testing framework outside Jenkins -> Option B

4. Quick Check:

   Unit tests outside Jenkins = fast feedback [OK]

Hint: Use unit tests outside Jenkins for fast shared library feedback [OK]

Common Mistakes:

• Running full pipelines slows feedback
• Manual tests are slow and error-prone
• Interactive UI tests are not automated