@Library annotation in Jenkins - Practice Problems & Coding Challenges

Challenge - 5 Problems

🧠 Conceptual

intermediate

Purpose of @Library Annotation in Jenkins

What is the main purpose of using the @Library annotation in a Jenkins pipeline script?

A To import shared pipeline code from a shared library repository into the current pipeline.

B To declare environment variables for the pipeline execution.

C To define the stages of the pipeline in a declarative syntax.

D To specify the Jenkins agent where the pipeline should run.

💡 Hint

Think about how Jenkins pipelines reuse code across multiple jobs.

The @Library annotation is used to load shared libraries, which contain reusable pipeline code, into the current Jenkins pipeline script.

💻 Command Output

intermediate

Output of Using @Library Annotation with Version

Given the Jenkins pipeline snippet below, what will be the effect of the @Library annotation?

@Library('utils@v1.2') _
node {
  echo 'Running pipeline'
}

A It loads the latest version of the 'utils' library ignoring the version 'v1.2'.

B It loads the 'utils' shared library at version 'v1.2' for use in the pipeline.

C It sets the pipeline to run only on nodes labeled 'v1.2'.

D It causes a syntax error because versioning is not supported in @Library.

💡 Hint

Consider how versioning works with shared libraries in Jenkins.

The syntax @Library('utils@v1.2') loads the shared library named 'utils' at the specific version 'v1.2'.

❓ Configuration

advanced

Correct Syntax to Load Multiple Shared Libraries

Which of the following Jenkins pipeline snippets correctly loads two shared libraries named 'libA' and 'libB' using the @Library annotation?

A

@Library('libA')
@Library('libB') _
node {
  echo 'Libraries loaded'
}

B

@Library(['libA', 'libB']) _
node {
  echo 'Libraries loaded'
}

C

@Library('libA,libB') _
node {
  echo 'Libraries loaded'
}

D

@Library(['libA@1.0', 'libB@2.0']) _
node {
  echo 'Libraries loaded'
}

💡 Hint

Check the syntax for loading multiple libraries with optional versions.

The correct syntax to load multiple libraries with optional versions is using a list inside @Library, like @Library(['libA@1.0', 'libB@2.0']).

❓ Troubleshoot

advanced

Troubleshooting @Library Annotation Loading Failure

A Jenkins pipeline uses @Library('commonLib') but fails with the error: Library 'commonLib' not found. What is the most likely cause?

A The Jenkins agent does not have internet access.

B The pipeline script has a syntax error unrelated to the library.

C The shared library 'commonLib' is not configured in Jenkins global settings.

D The <code>@Library</code> annotation must be placed inside the <code>node</code> block.

💡 Hint

Think about where Jenkins looks for shared libraries.

Jenkins requires shared libraries to be configured globally in the Jenkins system configuration before they can be loaded with @Library.

✅ Best Practice

expert

Best Practice for Versioning Shared Libraries with @Library

Which practice is best when using the @Library annotation to ensure pipeline stability and reproducibility?

A Always specify a fixed version or branch in the <code>@Library</code> annotation instead of using the default branch.

B Use the default branch without specifying a version to always get the latest updates.

C Load shared libraries dynamically inside pipeline steps instead of using <code>@Library</code> annotation.

D Avoid using shared libraries and duplicate code in each pipeline for clarity.

💡 Hint

Consider how to avoid unexpected changes breaking your pipelines.

Specifying a fixed version or branch in @Library ensures that pipelines use a known stable version of the shared library, improving stability and reproducibility.