Build wrappers in Jenkins - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a build wrapper in Jenkins?

A build wrapper in Jenkins is a setup step that prepares the build environment before the actual build starts. It can modify environment variables, add tools, or perform other setup tasks.

beginner

Name one common use case for build wrappers in Jenkins.

One common use case is to inject environment variables or credentials securely into the build environment before the build runs.

intermediate

How do build wrappers differ from build steps in Jenkins?

Build wrappers run before build steps to prepare the environment, while build steps perform the actual tasks like compiling code or running tests.

intermediate

Which Jenkins plugin provides the 'Timestamps' build wrapper?

The 'Timestamper' plugin provides the 'Timestamps' build wrapper, which adds timestamps to the console output for easier debugging.

intermediate

What happens if a build wrapper fails during setup?

If a build wrapper fails, the build usually stops before running build steps, preventing the build from running in a bad environment.

What is the main purpose of a build wrapper in Jenkins?

A Prepare the build environment before build steps run

B Compile the source code

C Deploy the application

D Run unit tests

Build wrappers set up the environment before the actual build steps like compiling or testing.

Which of these can a build wrapper do?

A Send email notifications

B Inject environment variables

C Run shell scripts after build

D Create Jenkins jobs

Build wrappers can inject environment variables before the build starts.

If a build wrapper fails, what usually happens?

A The build deploys anyway

B The build continues normally

C The build skips tests

D The build stops before running build steps

Failure in build wrappers usually stops the build to avoid running in a bad environment.

Which plugin adds timestamps to Jenkins console output using a build wrapper?

A Timestamper

B Git Plugin

C Mailer

D Pipeline

The Timestamper plugin provides a build wrapper that adds timestamps to console logs.

Build wrappers run at which point in the Jenkins build process?

A After build steps

B During deployment

C Before build steps

D After tests

Build wrappers run before build steps to prepare the environment.

Explain what a build wrapper is in Jenkins and why it is useful.

Think about what happens before the build starts.

Describe what happens if a build wrapper fails during a Jenkins build.

Consider the safety of the build process.

Practice

1. What is the main purpose of build wrappers in Jenkins?

easy

A. To prepare the environment before a build starts

B. To deploy the application after the build

C. To write test cases for the build

D. To monitor server health during the build

Solution

1. Step 1: Understand build wrappers role

   Build wrappers are used to set up or modify the environment before the build runs.

2. Step 2: Differentiate from other build steps

   Deployment, testing, and monitoring happen after or outside the build wrapper scope.

3. Final Answer:

   To prepare the environment before a build starts -> Option A

4. Quick Check:

   Build wrappers = environment setup [OK]

Hint: Build wrappers run before build steps start [OK]

Common Mistakes:

• Confusing build wrappers with deployment steps
• Thinking build wrappers run after the build
• Assuming build wrappers handle testing

2. Which syntax correctly adds a build wrapper to mask passwords in a Jenkins pipeline?

easy

A. properties { buildWrappers { maskPasswords() } }

B. properties { buildWrappers { mask_passwords() } }

C. buildWrappers { properties { maskPasswords() } }

D. buildWrappers { maskPasswords() }

Solution

1. Step 1: Recall correct Jenkins pipeline syntax

   Build wrappers are added inside the properties block using buildWrappers { maskPasswords() }.

2. Step 2: Identify syntax errors in options

   properties { buildWrappers { mask_passwords() } } uses underscores which is incorrect. Options C and D misplace the blocks.

3. Final Answer:

   properties { buildWrappers { maskPasswords() } } -> Option A

4. Quick Check:

   Correct syntax = properties + buildWrappers + maskPasswords [OK]

Hint: Use properties block then buildWrappers inside [OK]

Common Mistakes:

• Using underscores instead of camelCase
• Placing buildWrappers outside properties block
• Omitting properties block entirely

3. Given this Jenkins pipeline snippet, what will happen before the build runs?

properties {
  buildWrappers {
    timeout(time: 10, unit: 'MINUTES')
  }
}

medium

A. Passwords will be masked in the console output

B. The build workspace will be cleaned before starting

C. The build will be aborted if it runs longer than 10 minutes

D. The build will run without any timeout

Solution

1. Step 1: Understand the timeout build wrapper

   The timeout wrapper aborts the build if it exceeds the specified time.

2. Step 2: Match the behavior to options

   The build will be aborted if it runs longer than 10 minutes correctly describes the timeout effect. Other options describe different wrappers.

3. Final Answer:

   The build will be aborted if it runs longer than 10 minutes -> Option C

4. Quick Check:

   timeout wrapper = abort after time limit [OK]

Hint: Timeout wrapper stops build after set minutes [OK]

Common Mistakes:

• Confusing timeout with workspace cleanup
• Assuming masking passwords happens automatically
• Ignoring the timeout setting effect

4. You added this build wrapper in your Jenkins pipeline but it does not mask passwords as expected:

properties {
  buildWrappers {
    maskpasswords()
  }
}

What is the likely problem?

medium

A. maskPasswords() requires parameters

B. Build wrappers cannot mask passwords

C. The properties block is missing

D. The function name should be camelCase: maskPasswords()

Solution

1. Step 1: Check function name spelling and case

   The correct function name is maskPasswords() with capital P, not maskpasswords().

2. Step 2: Verify other syntax parts

   The properties block is present, and maskPasswords does not require parameters.

3. Final Answer:

   The function name should be camelCase: maskPasswords() -> Option D

4. Quick Check:

   Function names are case-sensitive in Jenkins [OK]

Hint: Check exact camelCase spelling for build wrappers [OK]

Common Mistakes:

• Using wrong case in function names
• Assuming build wrappers need parameters always
• Removing properties block accidentally

5. You want to ensure your Jenkins build cleans the workspace and aborts if it runs over 15 minutes. Which build wrappers configuration achieves this?

hard

A. properties {
buildWrappers {
timeout(time: 15, unit: 'MINUTES')
cleanWs()
}
}

B. properties {
buildWrappers {
cleanWs()
timeout(time: 15, unit: 'MINUTES')
}
}

C. buildWrappers {
cleanWs()
timeout(time: 15, unit: 'MINUTES')
}

D. properties {
cleanWs()
timeout(time: 15, unit: 'MINUTES')
}

Solution

1. Step 1: Confirm correct placement inside properties block

   Build wrappers must be inside properties { buildWrappers { ... } } to work properly.

2. Step 2: Verify both wrappers are included

   properties { buildWrappers { cleanWs() timeout(time: 15, unit: 'MINUTES') } } includes cleanWs() and timeout() inside buildWrappers correctly.

3. Step 3: Eliminate incorrect options

   properties { buildWrappers { timeout(time: 15, unit: 'MINUTES') cleanWs() } } has incorrect order but is syntactically valid; however, the question implies the order in B is preferred. Options C and D have incorrect block structure.

4. Final Answer:

   properties { buildWrappers { cleanWs() timeout(time: 15, unit: 'MINUTES') } } -> Option B

5. Quick Check:

   Both cleanWs and timeout inside properties/buildWrappers [OK]

Hint: Put all wrappers inside properties { buildWrappers { ... } } [OK]

Common Mistakes:

• Placing wrappers outside properties block
• Omitting one of the required wrappers
• Incorrect syntax for buildWrappers block