How to retrieve Jenkins environment from Groovy script?

Question

I am setting a Jenkins. I am programming with my pipeline using Global Pipeline Libraries to be able to increase reusability. Scripts are object oriented and in Groovy. Information about the concept can be found there

I don't manage to retrieve the Jenkins specific environment using my library script. I would like for instance to access:

Build_ID
Build_Number
JOB_Name
Workspace_path

I tryied to use env.WORKSPACE but it is returning a NULL. I manage to retrieve it directly in the pipeline but this is not my goal.

I am using Jenkins 2.303.1.

I would say there are multiple options provided in answers to [this 5-year old question](https://stackoverflow.com/q/37083285/598141) — Ian W, Oct 02 '21 at 03:51

score 2 · Accepted Answer · edited May 25 '23 at 07:09

2

Depending on how you write your scripts, you might need to inject the Jenkins environment. For example, if you go for a more object oriented way

// vars/whatever.groovy
import ...

@Field
def myTool = new MyTool(this)

// src/.../MyTool.groovy
import ...

class MyTool {
    private final jenkins

    MyTool(jenkins) {
        this.jenkins = jenkins
    }

    def echoBuildNumber() {
        this.jenkins.echo(this.jenkins.env.BUILD_NUMBER)
    }
}

// Jenkinsfile
@Library(...)
node {
    echo env.BUILD_NUMBER             // echoes build number
    whatever.myTool.echoBuildNumber() // echoes build number
}

edited May 25 '23 at 07:09

Pexers

953
1
7
20

answered Oct 01 '21 at 08:05

Alberto S.

7,409
6
27
46

I run 1 to 1 this script and I got this result: groovy.lang.MissingPropertyException: No such property: myTool for class: groovy.lang.Binding – White Oct 01 '21 at 14:38
What does the @Field do? – White Oct 01 '21 at 14:38
Make sure you're importing properly the shared library. You can find the docs of @Field at https://docs.groovy-lang.org/latest/html/gapi/groovy/transform/Field.html – Alberto S. Oct 01 '21 at 16:06

Dashrath Mundkar · Answer 2 · 2021-10-01T07:55:18.620

1

So the env which you are looking for can be accessible using like this in groovy script

${env.BUILD_NUMBER} ${env.JOB_NAME} ${env.WORKSPACE} ${env.BUILD_ID}

edited Oct 01 '21 at 07:55

answered Oct 01 '21 at 06:59

Dashrath Mundkar

7,956
2
28
42

This is not working in shared library – White Oct 01 '21 at 13:39

How to retrieve Jenkins environment from Groovy script?

2 Answers2