Groovy methods in pipelines in Jenkins - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a Groovy method in Jenkins pipelines?

A Groovy method is a reusable block of code defined in a Jenkins pipeline script to perform specific tasks, helping to keep the pipeline clean and organized.

beginner

How do you define a simple Groovy method in a Jenkins pipeline?

Use the syntax:

def methodName() {
  // code here
}

This defines a method named 'methodName' that can be called later in the pipeline.

beginner

Why use Groovy methods in Jenkins pipelines?

They help avoid repeating code, make pipelines easier to read, and allow you to organize complex tasks into smaller, manageable parts.

beginner

How do you call a Groovy method inside a Jenkins pipeline script?

Simply write the method name followed by parentheses, like methodName(), wherever you want to run that code.

intermediate

Can Groovy methods in Jenkins pipelines accept parameters? How?

Yes. Define parameters inside parentheses like def greet(name) { echo "Hello, ${name}!" }. Call it with greet('Alice') to pass 'Alice' as the argument.

What keyword is used to define a method in a Jenkins pipeline Groovy script?

A def

B function

C method

D func

In Groovy scripts for Jenkins pipelines, methods are defined using the 'def' keyword.

How do you call a Groovy method named 'buildApp' in a Jenkins pipeline?

A call buildApp

B buildApp()

C run buildApp

D execute buildApp

You call a Groovy method by writing its name followed by parentheses, like 'buildApp()'.

Why should you use Groovy methods in Jenkins pipelines?

A To organize code and avoid repetition

B To repeat code multiple times

C To make the pipeline longer

D To slow down the pipeline

Groovy methods help organize code and avoid repeating the same code multiple times.

Which of the following is a correct way to define a method with a parameter in Jenkins pipeline Groovy?

A def greet { echo "Hi" + name }

B function greet(name) { echo "Hi" }

C def greet(name) { echo "Hi ${name}" }

D def greet() { echo name }

The correct syntax includes 'def' keyword, method name, parameters in parentheses, and code block.

What will happen if you call a Groovy method that is not defined in your Jenkins pipeline script?

A Pipeline logs a warning but continues

B Pipeline skips the method call

C Pipeline runs normally

D Pipeline throws an error and stops

Calling an undefined method causes the pipeline to fail with an error.

Explain how to create and use a Groovy method in a Jenkins pipeline script.

Think about how you write a small reusable function in Groovy.

Describe the benefits of using Groovy methods in Jenkins pipelines.

Why do programmers use functions or methods in general?

Practice

1. What is the correct way to define a reusable method in a Jenkins pipeline using Groovy?

easy

A. Use def methodName() { } inside a script block

B. Use function methodName() { } outside the pipeline

C. Use method methodName() { } inside steps

D. Use def methodName[] { } inside environment

Solution

1. Step 1: Understand Groovy method syntax in Jenkins

   Groovy methods are defined with def methodName() { } syntax inside script blocks in Jenkins pipelines.

2. Step 2: Identify correct placement

   Methods must be inside script blocks to be recognized and used in declarative pipelines.

3. Final Answer:

   Use def methodName() { } inside a script block -> Option A

4. Quick Check:

   Groovy method = def methodName() { } [OK]

Hint: Remember: def + methodName() inside script block [OK]

Common Mistakes:

• Using 'function' keyword instead of 'def'
• Defining methods outside script blocks
• Using incorrect syntax like square brackets
• Placing methods inside environment block

2. Which of the following is the correct syntax to call a Groovy method named buildApp with a parameter version inside a Jenkins pipeline?

easy

A. buildApp version

B. buildApp->version

C. call buildApp(version)

D. buildApp(version)

Solution

1. Step 1: Recall method call syntax in Groovy

   Groovy methods are called with parentheses enclosing parameters, like methodName(param).

2. Step 2: Match the correct option

   buildApp(version) uses buildApp(version), which is the correct way to call the method with a parameter.

3. Final Answer:

   buildApp(version) -> Option D

4. Quick Check:

   Method call with parentheses = buildApp(version) [OK]

Hint: Call methods with parentheses around parameters [OK]

Common Mistakes:

• Calling method without parentheses
• Using 'call' keyword unnecessarily
• Using arrow syntax which is invalid
• Passing parameters without parentheses

3. Given the following Jenkins pipeline snippet, what will be printed in the console?

pipeline {
  agent any
  stages {
    stage('Test') {
      steps {
        script {
          def greet(name) {
            return "Hello, ${name}!"
          }
          echo greet('Alice')
        }
      }
    }
  }
}

medium

A. Error: Method not found

B. Hello, Alice!

C. Hello, ${name}!

D. greet(Alice)

Solution

1. Step 1: Understand method definition and call

   The method greet takes a parameter name and returns a string with the name inserted.

2. Step 2: Evaluate the method call inside echo

   Calling greet('Alice') returns "Hello, Alice!" which is printed by echo.

3. Final Answer:

   Hello, Alice! -> Option B

4. Quick Check:

   Method returns greeting string = Hello, Alice! [OK]

Hint: Method returns string with parameter replaced [OK]

Common Mistakes:

• Expecting literal ${name} instead of substituted value
• Thinking method call prints method name
• Assuming method is undefined causing error
• Confusing method call syntax

4. Identify the error in this Jenkins pipeline Groovy method usage:

pipeline {
  agent any
  stages {
    stage('Build') {
      steps {
        script {
          def compile() {
            echo 'Compiling...'
          }
          compile
        }
      }
    }
  }
}

medium

A. Method compile is called without parentheses causing no execution

B. Method compile is not defined properly with def

C. echo cannot be used inside methods

D. script block cannot contain method definitions

Solution

1. Step 1: Check method call syntax

   The method compile is defined correctly but called without parentheses, so it is treated as a reference, not executed.

2. Step 2: Understand Groovy method invocation

   To execute the method, parentheses are required: compile().

3. Final Answer:

   Method compile is called without parentheses causing no execution -> Option A

4. Quick Check:

   Call methods with () to execute [OK]

Hint: Always add () when calling methods to run them [OK]

Common Mistakes:

• Calling method without parentheses
• Thinking def is missing for method
• Assuming echo can't be inside methods
• Believing script block forbids method definitions

5. You want to create a Groovy method in a Jenkins pipeline that takes a list of strings and returns a single string with all items joined by commas. Which method implementation is correct?

hard

A. def joinList(items) { return items + "," }

B. def joinList(items) { items.join }

C. def joinList(items) { return items.join(",") }

D. def joinList(items) { items.collect { it + "," } }

Solution

1. Step 1: Understand Groovy list joining

   The join method on a list combines elements into a string separated by the given delimiter.

2. Step 2: Check method correctness

   def joinList(items) { return items.join(",") } correctly returns items.join(",") which joins list items with commas.

3. Final Answer:

   def joinList(items) { return items.join(",") } -> Option C

4. Quick Check:

   Use list.join(",") to combine items [OK]

Hint: Use list.join(",") to join list elements into string [OK]

Common Mistakes:

• Forgetting to return the joined string
• Using + operator which concatenates incorrectly
• Using collect which returns a list, not string
• Omitting parentheses in join method