Implicit vs explicit loading in Jenkins - Visual Side-by-Side Comparison

Process Flow - Implicit vs explicit loading

Start Jenkins Pipeline

↓

Load Jenkinsfile

↓

Implicit Loading

↓

Jenkins auto-loads shared libraries

↓

Pipeline runs with auto-loaded code

↓

Explicit Loading

↓

Pipeline calls load() or @Library

↓

Shared libraries loaded manually

↓

Pipeline runs with explicitly loaded code

Jenkins pipelines can load shared libraries either automatically (implicit) or by manual commands (explicit). This flow shows how Jenkins handles each loading method.

Execution Sample

Jenkins

pipeline {
  agent any
  stages {
    stage('Example') {
      steps {
        script {
          def lib = load 'vars/myLib.groovy'
          lib.sayHello()
        }
      }
    }
  }
}

This pipeline explicitly loads a Groovy script from the repository and calls a function from it.

Process Table

Step	Action	Loading Type	Evaluation	Result
1	Start pipeline execution	N/A	N/A	Pipeline begins
2	Jenkins reads Jenkinsfile	N/A	N/A	Pipeline script loaded
3	Check for implicit libraries	Implicit	Are shared libraries configured for auto-loading?	If yes, libraries auto-loaded
4	Execute pipeline steps	Explicit	Encounter load 'vars/myLib.groovy'	Script loaded explicitly into variable 'lib'
5	Call lib.sayHello()	Explicit	Invoke function from loaded script	Function runs, output produced
6	Pipeline completes	N/A	N/A	Pipeline ends successfully

💡 Pipeline ends after all steps complete

Status Tracker

Variable	Start	After Step 4	After Step 5	Final
lib	null	Groovy script object loaded	Function sayHello executed	Groovy script object remains

Key Moments - 3 Insights

Why does Jenkins sometimes load shared libraries automatically without explicit commands?

Because Jenkins can be configured to auto-load shared libraries implicitly before pipeline execution, as shown in step 3 of the execution table.

What happens when the pipeline uses the load() command explicitly?

The pipeline manually loads the specified Groovy script at runtime, assigning it to a variable, as shown in step 4 and tracked in variable 'lib'.

Can explicit loading replace implicit loading?

Yes, explicit loading gives you control to load scripts only when needed, unlike implicit loading which happens automatically before pipeline runs.

Visual Quiz - 3 Questions

Look at the execution table, at which step does Jenkins explicitly load the Groovy script?

A Step 3

B Step 4

C Step 5

D Step 2

💡 Hint

Check the 'Action' and 'Loading Type' columns in step 4 for explicit loading

According to the variable tracker, what is the state of variable 'lib' after step 5?

A null

B Groovy script object loaded

C Function sayHello executed

D Pipeline completed

💡 Hint

Look at the 'After Step 5' column for variable 'lib' in the variable tracker

If Jenkins is configured to not auto-load shared libraries, which step in the execution table would be skipped?

A Step 3

B Step 4

C Step 5

D Step 6

💡 Hint

Step 3 describes implicit loading; if disabled, it won't happen

Concept Snapshot

Implicit loading: Jenkins auto-loads shared libraries before pipeline runs.
Explicit loading: Pipeline uses load() or @Library to load scripts manually.
Implicit is automatic, explicit is manual and controlled.
Use explicit loading to load scripts only when needed.
Both methods provide shared code reuse in Jenkins pipelines.

Full Transcript

This visual execution shows how Jenkins pipelines load shared libraries implicitly and explicitly. The pipeline starts and Jenkins reads the Jenkinsfile. If configured, Jenkins auto-loads shared libraries implicitly before running steps. Alternatively, the pipeline can explicitly load scripts using the load() command, assigning the loaded script to a variable. The variable can then call functions from the loaded script. The execution table tracks each step, showing when implicit or explicit loading happens. The variable tracker shows the state of the loaded script variable across steps. Key moments clarify why Jenkins auto-loads libraries and how explicit loading works. The quiz tests understanding of when loading occurs and variable states. This helps beginners see the difference between implicit and explicit loading in Jenkins pipelines.

Practice

1. What is the main difference between implicit and explicit loading of shared libraries in Jenkins pipelines?

easy

A. Implicit loading loads libraries from GitHub, explicit loads from local files.

B. Implicit loading requires manual script calls, explicit loading is automatic.

C. Implicit loading is only for scripted pipelines, explicit is for declarative pipelines.

D. Implicit loading uses the @Library annotation, explicit uses the library() step.

Solution

1. Step 1: Understand implicit loading

   Implicit loading uses the @Library annotation at the top of the Jenkinsfile to automatically load shared libraries.

2. Step 2: Understand explicit loading

   Explicit loading uses the library() step inside the pipeline script to load libraries manually when needed.

3. Final Answer:

   Implicit loading uses the @Library annotation, explicit uses the library() step. -> Option D

4. Quick Check:

   Implicit = @Library, Explicit = library() [OK]

Hint: Remember: @Library is automatic, library() is manual [OK]

Common Mistakes:

• Confusing which method is automatic
• Thinking explicit loading is automatic
• Mixing up syntax of @Library and library()
• Assuming implicit loading requires code inside pipeline

2. Which of the following is the correct syntax for implicit loading of a shared library named 'utils' in a Jenkinsfile?

easy

A. library('utils')

B. @Library('utils') _

C. loadLibrary('utils')

D. import 'utils'

Solution

1. Step 1: Recall implicit loading syntax

   Implicit loading uses the @Library('libraryName') _ annotation at the top of the Jenkinsfile.

2. Step 2: Check options for correct syntax

   @Library('utils') _ matches the correct syntax: @Library('utils') _. Others are incorrect or invalid in Jenkins.

3. Final Answer:

   @Library('utils') _ -> Option B

4. Quick Check:

   Implicit loading = @Library('name') _ [OK]

Hint: Implicit loading always starts with @Library and ends with underscore [OK]

Common Mistakes:

• Using library() instead of @Library for implicit loading
• Missing the underscore after @Library annotation
• Using import or loadLibrary which are invalid
• Placing @Library inside pipeline steps

3. Given the Jenkinsfile snippet below, what will be the output if the shared library 'mathLib' has a function add(a, b) that returns the sum?

@Library('mathLib') _
pipeline {
  agent any
  stages {
    stage('Add') {
      steps {
        script {
          def result = add(3, 4)
          echo "Sum is ${result}"
        }
      }
    }
  }
}

medium

A. Sum is 7

B. Error: add() function not found

C. Sum is 34

D. Pipeline fails to load

Solution

1. Step 1: Identify loading method

   The Jenkinsfile uses implicit loading with @Library('mathLib') _, so the library functions are available automatically.

2. Step 2: Understand function call and output

   The add(3, 4) function returns 7, so the echo prints "Sum is 7".

3. Final Answer:

   Sum is 7 -> Option A

4. Quick Check:

   Implicit loading allows direct function use = Sum is 7 [OK]

Hint: Implicit loading lets you call library functions directly [OK]

Common Mistakes:

• Assuming add() is undefined without explicit library() call
• Confusing string concatenation with addition
• Thinking pipeline fails due to missing library
• Ignoring the underscore after @Library

4. You have this Jenkins pipeline snippet:

pipeline {
  agent any
  stages {
    stage('Load Lib') {
      steps {
        script {
          @Library('toolsLib') _
          def result = toolFunc()
          echo "Result: ${result}"
        }
      }
    }
  }
}

What is the problem with this code?

medium

A. The @Library annotation cannot be used inside the script block.

B. The library name 'toolsLib' is invalid syntax.

C. The function toolFunc() must be called with library() step.

D. The echo statement is missing parentheses.

Solution

1. Step 1: Check usage of @Library annotation

   The @Library annotation must be placed at the top of the Jenkinsfile, not inside script blocks or stages.

2. Step 2: Identify error cause

   Using @Library inside the script block causes a syntax error; explicit loading with library() should be used inside scripts.

3. Final Answer:

   The @Library annotation cannot be used inside the script block. -> Option A

4. Quick Check:

   @Library only at top, not inside script [OK]

Hint: Put @Library only at the top of Jenkinsfile [OK]

Common Mistakes:

• Placing @Library inside pipeline steps
• Confusing explicit and implicit loading syntax
• Assuming library() is optional inside script
• Ignoring syntax error from misplaced annotation

5. You want to load two shared libraries in a Jenkins pipeline: 'libA' implicitly and 'libB' explicitly. Which Jenkinsfile snippet correctly achieves this?

hard

A. @Library('libB') _
pipeline {
agent any
stages {
stage('Use LibA') {
steps {
script {
library('libA')
libAFunc()
libBFunc()
}
}
}
}
}

B. pipeline {
agent any
stages {
stage('Use LibA and LibB') {
steps {
script {
library('libA')
library('libB')
libAFunc()
libBFunc()
}
}
}
}
}

C. @Library('libA') _
pipeline {
agent any
stages {
stage('Use LibB') {
steps {
script {
library('libB')
libBFunc()
}
}
}
}
}

D. @Library('libA') _
@Library('libB') _
pipeline {
agent any
stages {
stage('Use Both') {
steps {
script {
libAFunc()
libBFunc()
}
}
}
}
}

Solution

1. Step 1: Understand implicit and explicit loading together

   Implicit loading uses @Library('libA') _ at the top. Explicit loading uses library('libB') inside the script block.

2. Step 2: Check each option for correct usage

   @Library('libA') _ pipeline { agent any stages { stage('Use LibB') { steps { script { library('libB') libBFunc() } } } } } correctly uses implicit loading for 'libA' and explicit loading for 'libB' inside the script block. Others misuse annotations or load both explicitly or implicitly incorrectly.

3. Final Answer:

   @Library('libA') _ at top (implicit for libA), library('libB') inside script (explicit for libB) -> Option C

4. Quick Check:

   Implicit @Library top, explicit library() inside script [OK]

Hint: Implicit @Library top, explicit library() inside script block [OK]

Common Mistakes:

• Using multiple @Library annotations for explicit loading
• Calling library() outside script block
• Loading both libraries only explicitly or only implicitly
• Misplacing annotations inside pipeline stages