Testing shared libraries in Jenkins - Step-by-Step Execution

Process Flow - Testing shared libraries

Write shared library code

↓

Write unit tests for library

↓

Configure Jenkins pipeline to load library

↓

Run tests in pipeline

↓

Check test results

↓

Fix issues or confirm success

This flow shows writing shared library code, adding tests, running them in Jenkins, and checking results.

Execution Sample

Jenkins

def add(a, b) {
  return a + b
}

// Test
assert add(2, 3) == 5

A simple shared library function add and a test assertion checking its output.

Process Table

Step	Action	Evaluation	Result
1	Call add(2, 3)	2 + 3	5
2	Assert add(2, 3) == 5	5 == 5	True - Test passes
3	Run pipeline stage 'Test'	Tests executed	All tests passed
4	Check test report	No failures	Success
5	Pipeline ends	Tests passed	Library verified

💡 All tests passed, pipeline completes successfully

Status Tracker

Variable	Start	After Step 1	After Step 2	Final
a	undefined	2	2	2
b	undefined	3	3	3
result	undefined	5	5	5
test_passed	false	false	true	true

Key Moments - 2 Insights

Why does the test fail if the assertion is incorrect?

Because in step 2 of the execution_table, the assertion evaluates to false, causing the pipeline to mark the test as failed and stop or report errors.

How does Jenkins know to load the shared library for testing?

Jenkins pipeline configuration includes a 'library' step that loads the shared library before running tests, as implied in step 3.

Visual Quiz - 3 Questions

Look at the execution_table, what is the result of add(2, 3) at step 1?

A 5

B 23

C Error

D Undefined

💡 Hint

Check the 'Result' column in row for Step 1 in execution_table

At which step does the test assertion confirm success?

A Step 4

B Step 1

C Step 2

D Step 5

💡 Hint

Look at the 'Action' and 'Result' columns in execution_table for assertion evaluation

If the assertion failed, how would the pipeline result change in the table?

A Step 3 would show 'Tests executed' with all passed

B Step 4 would show 'Failures detected'

C Step 5 would show 'Library verified'

D No change in any step

💡 Hint

Refer to the 'Check test report' step in execution_table and what happens on test failures

Concept Snapshot

Testing shared libraries in Jenkins:
- Write library code and unit tests
- Configure Jenkins pipeline to load the library
- Run tests inside pipeline stages
- Check test results for pass/fail
- Fix code if tests fail, else confirm success

Full Transcript

Testing shared libraries involves writing reusable code and unit tests for it. Jenkins pipelines load the shared library and run these tests automatically. Each step calls functions, evaluates assertions, and reports results. If tests pass, the pipeline completes successfully confirming the library works. If tests fail, Jenkins reports errors so you can fix the code. This visual trace shows calling a simple add function, asserting its output, running tests in Jenkins, and checking the final success status.

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