Library directory structure in Jenkins - Interactive Code Practice

Practice - 5 Tasks

1fill in blank

easy

Complete the code to define the root directory for shared libraries in Jenkins.

Jenkins

library {
  rootDir = '[1]'
}

Drag options to blanks, or click blank then click option'

Avars

Blibs

Csrc

Dresources

Attempts:

3 left

💡 Hint

Common Mistakes

Using 'vars' which holds global variables, not the root library folder.

Using 'src' which is for source code inside the library.

The root directory for shared libraries in Jenkins is usually named libs.

2fill in blank

medium

Complete the code to specify the directory for global variables in a Jenkins shared library.

Jenkins

library {
  varsDir = '[1]'
}

Drag options to blanks, or click blank then click option'

Avars

Bsrc

Cresources

Dlib

Attempts:

3 left

💡 Hint

Common Mistakes

Using 'src' which is for source code classes.

Using 'resources' which holds non-code files.

The vars directory holds global variables and scripts accessible in Jenkins pipelines.

3fill in blank

hard

Fix the error in the directory structure declaration for Jenkins shared libraries.

Jenkins

library {
  resourcesDir = '[1]'
}

Drag options to blanks, or click blank then click option'

Aresources

Bsrc

Cvars

Dlib

Attempts:

3 left

💡 Hint

Common Mistakes

Using 'lib' which is not a standard folder for resources.

Using 'vars' which is for global variables.

The resources directory is used to store non-code files like configuration or templates.

4fill in blank

hard

Fill both blanks to complete the Jenkins shared library directory structure.

Jenkins

library {
  rootDir = '[1]'
  varsDir = '[2]'
}

Drag options to blanks, or click blank then click option'

Alibs

Bvars

Csrc

Dresources

Attempts:

3 left

💡 Hint

Common Mistakes

Swapping 'vars' and 'src' folders.

Using 'resources' as root directory.

The root directory is libs and the global variables directory is vars.

5fill in blank

hard

Fill all three blanks to define a complete Jenkins shared library directory structure.

Jenkins

library {
  rootDir = '[1]'
  varsDir = '[2]'
  resourcesDir = '[3]'
}

Drag options to blanks, or click blank then click option'

Alibs

Bvars

Cresources

Dsrc

Attempts:

3 left

💡 Hint

Common Mistakes

Using 'src' instead of 'libs' as root directory.

Confusing 'resources' with 'vars'.

The standard Jenkins shared library directories are libs for root, vars for global variables, and resources for supporting files.

Practice

1. What is the primary purpose of the vars/ directory in a Jenkins shared library?

easy

A. To store simple Groovy scripts accessible as global variables

B. To store compiled Java classes

C. To hold configuration files like YAML or JSON

D. To keep pipeline job definitions

Solution

1. Step 1: Understand the role of vars/ directory

   The vars/ directory is used to store simple Groovy scripts that Jenkins loads as global variables or functions.

2. Step 2: Differentiate from other directories

   The src/ directory is for classes, and resources/ is for config files, so vars/ is specifically for simple scripts.

3. Final Answer:

   To store simple Groovy scripts accessible as global variables -> Option A

4. Quick Check:

   vars/ = simple scripts [OK]

Hint: Remember: vars = simple scripts, src = classes, resources = configs [OK]

Common Mistakes:

• Confusing vars/ with src/ directory
• Thinking vars/ holds config files
• Assuming vars/ stores compiled classes

2. Which directory should you place a Groovy class file named MyHelper.groovy in a Jenkins shared library?

easy

A. src/

B. vars/

C. resources/

D. jobs/

Solution

1. Step 1: Identify the purpose of src/ directory

   The src/ directory is meant for Groovy or Java classes in a Jenkins shared library.

2. Step 2: Match the file type to directory

   Since MyHelper.groovy is a class file, it belongs in src/, not vars/ or resources/.

3. Final Answer:

   src/ -> Option A

4. Quick Check:

   Classes go to src/ [OK]

Hint: Classes always go inside src/ folder [OK]

Common Mistakes:

• Placing class files in vars/
• Putting Groovy classes inside resources/
• Using non-existent jobs/ directory

3. Given this Jenkins shared library structure:
vars/notify.groovy
src/org/example/Helper.groovy
resources/config/settings.yml
Which file would you use to load configuration settings inside a pipeline?

medium

A. vars/notify.groovy

B. resources/config/settings.yml

C. vars/settings.yml

D. src/org/example/Helper.groovy

Solution

1. Step 1: Identify the purpose of resources/ directory

   The resources/ directory holds static files like configuration files (YAML, JSON) used by the library.

2. Step 2: Match the file type to usage

   Since settings.yml is a config file, it should be loaded from resources/config/settings.yml.

3. Final Answer:

   resources/config/settings.yml -> Option B

4. Quick Check:

   Config files = resources/ [OK]

Hint: Config files always go in resources/ [OK]

Common Mistakes:

• Trying to load config from vars/
• Confusing class files with config files
• Assuming config files go in src/

4. You placed a Groovy script build.groovy inside resources/ directory. What issue will you face when trying to call build() in your Jenkins pipeline?

medium

A. The script will run normally without issues

B. The script will be compiled but not executed

C. Jenkins will throw a missing method error because resources/ is for static files only

D. The pipeline will ignore the script and continue silently

Solution

1. Step 1: Understand the role of resources/ directory

   The resources/ directory is only for static files like configs, not executable Groovy scripts.

2. Step 2: Consequence of placing script in resources/

   Since build.groovy is not in vars/ or src/, Jenkins cannot load it as a callable method, causing a missing method error.

3. Final Answer:

   Jenkins will throw a missing method error because resources/ is for static files only -> Option C

4. Quick Check:

   Scripts must be in vars/ or src/ [OK]

Hint: Scripts in resources/ cause missing method errors [OK]

Common Mistakes:

• Expecting Groovy scripts to run from resources/
• Ignoring directory purpose and mixing files
• Assuming silent failure without error

5. You want to create a reusable Jenkins shared library that includes:
- A global function notifyBuild
- A helper class BuildHelper
- A configuration file email.yml
Which directory structure correctly organizes these files?

hard

A. src/notifyBuild.groovy, vars/BuildHelper.groovy, resources/email.yml

B. vars/notifyBuild.groovy, resources/BuildHelper.groovy, src/email.yml

C. resources/notifyBuild.groovy, src/BuildHelper.groovy, vars/email.yml

D. vars/notifyBuild.groovy, src/BuildHelper.groovy, resources/email.yml

Solution

1. Step 1: Assign global functions to vars/

   Global functions like notifyBuild go into vars/ as Groovy scripts.

2. Step 2: Place helper classes in src/

   Classes like BuildHelper belong in src/ directory.

3. Step 3: Store config files in resources/

   Configuration files such as email.yml must be inside resources/.

4. Final Answer:

   vars/notifyBuild.groovy, src/BuildHelper.groovy, resources/email.yml -> Option D

5. Quick Check:

   vars = functions, src = classes, resources = configs [OK]

Hint: Match file type: vars=func, src=class, resources=config [OK]

Common Mistakes:

• Swapping vars/ and src/ for functions and classes
• Placing config files outside resources/
• Mixing file types in wrong directories