How to read properties file from Jenkins 2.0 pipeline script

I am attempting to write a pipeline script to use with Jenkins 2.0 to replicate our existing build. This original build used the envInject plugin to read a Java properties file, but I can't see how to do this from the pipeline Groovy script. I have Googled and found the following, but it doesn't work (FileNotFoundException):

Properties props = new Properties()
File propsFile = new File('./Builder/project.properties')
props.load(propsFile.newDataInputStream())

Thanks!


I just fought with this yesterday and today. I wish the availability of this was easier to find.

Grab the 'Pipeline Utility Steps' plugin.

Use the readProperties step.

 def props = readProperties  file: 'dir/my.properties'

One word of warning - what I expected to be booleans in the properties files were treated as strings.


I tried out and below works perfectly fine:

test.properties
Monday=abcdef
Tuesday=kfgh

def props = readProperties  file:'/var/lib/jenkins/jobs/abc/test.properties'
def Var1= props['Monday']
def Var2= props['Tuesday']
echo "Var1=${Var1}"
echo "Var2=${Var2}"

Use:

def props = readProperties file: 'config/general.properties'

In case your properties file located in Groovy Library, and source code located in different place, you should use the Resources folder from the Groovy Library.

Hence add below line:

--> def propFileContent = libraryResource 'config/general.properties'
    def props = readProperties text: propFileContent

Notes:

  • "config" is some folder inside 'resources' folder

  • pay attention, in first places used word "file:", in second used "text:"