Workspace cleanup in Jenkins - Interactive Code Practice

Practice - 5 Tasks

1fill in blank

easy

Complete the code to delete all files in the Jenkins workspace.

Jenkins

steps.sh 'rm -rf [1]/*'

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

A${WORKSPACE}

Bworkspace

C/var/lib/jenkins/workspace

D/tmp

Attempts:

3 left

💡 Hint

Common Mistakes

Using a hardcoded path instead of the workspace variable.

Using a relative path that may not point to the workspace.

The environment variable ${WORKSPACE} points to the current Jenkins job workspace directory. Using it ensures the cleanup targets the correct folder.

2fill in blank

medium

Complete the Jenkins pipeline step to clean the workspace before starting the build.

Jenkins

pipeline {
  agent any
  stages {
    stage('Cleanup') {
      steps {
        [1]()
      }
    }
  }
}

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

Ash 'rm -rf *'

BcleanWs

CdeleteDir

DworkspaceCleanup

Attempts:

3 left

💡 Hint

Common Mistakes

Using shell commands directly instead of the pipeline step.

Using deleteDir() which deletes the current directory but may not clean all workspace files.

The cleanWs() step is a Jenkins Pipeline utility that cleans the current workspace safely.

3fill in blank

hard

Fix the error in the shell command to clean the workspace safely.

Jenkins

sh 'rm -rf [1]'

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

A${WORKSPACE}/*

B${WORKSPACE}

C/workspace/*

D/tmp/*

Attempts:

3 left

💡 Hint

Common Mistakes

Deleting the workspace folder itself causing Jenkins to fail.

Using incorrect or hardcoded paths.

Using ${WORKSPACE}/* deletes all files inside the workspace but keeps the workspace directory itself intact, preventing errors.

4fill in blank

hard

Fill both blanks to create a post-build step that cleans the workspace only if the build fails.

Jenkins

post {
  failure {
    steps {
      [1]()
      sh 'rm -rf [2]/*'
    }
  }
}

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

AcleanWs

BdeleteDir

C${WORKSPACE}

D/tmp

Attempts:

3 left

💡 Hint

Common Mistakes

Using deleteDir() which may delete the workspace folder itself.

Using hardcoded paths instead of ${WORKSPACE}.

The cleanWs() step cleans the workspace safely. Using ${WORKSPACE} ensures the shell command targets the correct directory.

5fill in blank

hard

Fill all three blanks to define a pipeline that cleans workspace before and after the build.

Jenkins

pipeline {
  agent any
  stages {
    stage('Cleanup') {
      steps {
        [1]()
      }
    }
    stage('Build') {
      steps {
        echo 'Building...'
      }
    }
  }
  post {
    always {
      [2]()
      sh 'rm -rf [3]/*'
    }
  }
}

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

AcleanWs

BdeleteDir

C${WORKSPACE}

DcleanWorkspace

Attempts:

3 left

💡 Hint

Common Mistakes

Using different cleanup steps inconsistently.

Using hardcoded paths instead of environment variables.

Using cleanWs() in the cleanup stage and post steps ensures workspace is cleaned before and after the build. The ${WORKSPACE} variable targets the correct directory in the shell command.

Practice

1. What is the main purpose of workspace cleanup in Jenkins?

easy

A. To increase the number of concurrent builds

B. To remove old files and keep the build environment clean

C. To backup build artifacts automatically

D. To speed up the Jenkins server startup

Solution

1. Step 1: Understand workspace cleanup concept

   Workspace cleanup removes files from previous builds to avoid clutter and errors.

2. Step 2: Identify the main benefit

   Removing old files keeps the build environment clean and prevents conflicts or disk space issues.

3. Final Answer:

   To remove old files and keep the build environment clean -> Option B

4. Quick Check:

   Workspace cleanup = remove old files [OK]

Hint: Workspace cleanup deletes old build files to keep space free [OK]

Common Mistakes:

• Thinking it speeds up Jenkins server startup
• Confusing cleanup with backup
• Assuming it increases build concurrency

2. Which of the following is the correct syntax to clean the workspace in a Jenkins Pipeline script?

easy

A. cleanWs()

B. cleanWorkspace()

C. deleteWorkspace()

D. removeWs()

Solution

1. Step 1: Recall Jenkins Pipeline workspace cleanup function

   The correct function to clean workspace is cleanWs().

2. Step 2: Verify syntax correctness

   Other options are not valid Jenkins Pipeline steps for workspace cleanup.

3. Final Answer:

   cleanWs() -> Option A

4. Quick Check:

   Jenkins workspace cleanup function = cleanWs() [OK]

Hint: Remember exact function name: cleanWs() [OK]

Common Mistakes:

• Using incorrect function names like cleanWorkspace()
• Adding parentheses incorrectly or missing them
• Confusing with other cleanup commands

3. What will be the output or effect of this Jenkins Pipeline snippet?

pipeline {
  agent any
  stages {
    stage('Clean') {
      steps {
        cleanWs()
      }
    }
  }
}

medium

A. Fails with a syntax error due to missing parameters

B. Prints the workspace contents without deleting anything

C. Archives the workspace files for later use

D. Deletes all files in the current workspace before the build

Solution

1. Step 1: Analyze the cleanWs() step in the pipeline

   The cleanWs() step deletes all files in the current workspace.

2. Step 2: Understand the pipeline effect

   Since it is in the 'Clean' stage, it removes workspace files before further build steps.

3. Final Answer:

   Deletes all files in the current workspace before the build -> Option D

4. Quick Check:

   cleanWs() deletes workspace files [OK]

Hint: cleanWs() deletes workspace files, no parameters needed [OK]

Common Mistakes:

• Thinking cleanWs() only lists files
• Assuming cleanWs() needs parameters
• Confusing cleanWs() with archiving

4. You added cleanWs() in your Jenkins Pipeline, but the workspace is not cleaned. What is a likely cause?

medium

A. cleanWs() only cleans after the build, not before

B. cleanWs() requires additional parameters to work

C. The pipeline is running on a shared agent and workspace cleanup is disabled

D. The Jenkins server needs a restart to apply cleanWs()

Solution

1. Step 1: Understand workspace cleanup behavior on shared agents

   On shared agents, workspace cleanup may be disabled or restricted to avoid deleting others' files.

2. Step 2: Check common misunderstandings about cleanWs()

   cleanWs() works without parameters and cleans immediately; server restart is not needed.

3. Final Answer:

   The pipeline is running on a shared agent and workspace cleanup is disabled -> Option C

4. Quick Check:

   Shared agent restrictions block cleanWs() [OK]

Hint: Check agent type; shared agents may block cleanup [OK]

Common Mistakes:

• Thinking cleanWs() needs parameters
• Assuming cleanup only happens after build
• Restarting Jenkins unnecessarily

5. You want to ensure your Jenkins Pipeline cleans the workspace only after a successful build to save disk space but keep files if the build fails. How can you achieve this?

hard

A. Use post { success { cleanWs() } } block in the pipeline

B. Call cleanWs() at the start of the pipeline

C. Add cleanWs() inside the always post block

D. Configure Jenkins global settings to clean workspace on failure

Solution

1. Step 1: Understand Jenkins post-build actions

   The post block allows running steps based on build result, like success.

2. Step 2: Use conditional cleanup after successful build

   Placing cleanWs() inside post { success { ... } } cleans workspace only if build succeeds.

3. Final Answer:

   Use post { success { cleanWs() } } block in the pipeline -> Option A

4. Quick Check:

   Post success block cleans workspace conditionally [OK]

Hint: Use post { success { cleanWs() } } to clean only on success [OK]

Common Mistakes:

• Cleaning workspace at start loses files before build
• Using always block cleans even on failure
• Expecting global settings to handle conditional cleanup