Can I define custom steps using a hash-table for params for a declarative pipeline?

Question

I want to create a custom step as detailed here: https://jenkins.io/doc/book/pipeline/shared-libraries/#defining-custom-steps

The script looks like this:

// vars/buildPlugin.groovy
def call(body) {
    // evaluate the body block, and collect configuration into the object
    def config = [:]
    body.resolveStrategy = Closure.DELEGATE_FIRST
    body.delegate = config
    body()
...

And I can run it like this in a scripted pipeline:

buildPlugin {
    name = 'git'
}

Which means in a declarative pipeline i gotta wrap it in a script block:

script {
    buildPlugin {
        name = 'git'
    }
}

I have a lot of custom scripts and groovy classes and it clutters things up to have to wrap them in script blocks in my pipeline. Can I write groovy scripts in a way the declarative pipeline can use without script{}?

EDIT:

Calling a groovy script from the pipeline like this works:

myCustomStep('sldkfjlskdf')

But I want to use a hashtable like they have in the examples:

# In myCustomStep.grooy
def call(body) {

    def config = [:]
    body.resolveStrategy = Closure.DELEGATE_FIRST
    body.delegate = config
    body()

In order to call it now I have to do:

myCustomStep{
    param1 = 'sldkfjlskdf'
    param2 = 'sdfsdfsdfdf'
}

Doing this I get Expected a step @ line.... and have to wrap it in a step

Is there a way to get nice named params like with the hash-table approach but not have to wrap in a step? I also tried calling it like myCustomStep({param1 = 'sdfsdf'}) which did not work

Answer 1

you can use it also in declarative pipline without script wrapper

Here is example that works well:

script

//vars/shOut.groovy
def call(shellScript) {
  return sh(returnStdout: true, script: shellScript).trim()
}

Jenkinsfile

@Library('modelsLib') _

pipeline {
  agent { label 'master' }

  stages {
    stage('some stage') {
      steps {
        echo "hello!"
        shOut 'touch xxyyzz'
        sh 'ls -otr'
      }
    }
  }
}

output

[Pipeline] {
[Pipeline] stage
[Pipeline] { (some stage)
[Pipeline] echo
hello!
[Pipeline] sh
[test-pipeline] Running shell script
+ touch xxyyzz
[Pipeline] sh
[test-pipeline] Running shell script
+ ls -otr
total 32
-rw-r--r-- 1 jenkins     0 Dec 20 17:59 xxyyzz
[Pipeline] }
[Pipeline] // stage
[Pipeline] }
[Pipeline] // node
[Pipeline] End of Pipeline