CODEWITHSUNDEEP
jenkinsgroovy
John Czukkermann
John Czukkermann

Reputation: 625

Accessing a Username with Password Credential Parameter from a Jenkins Execute Groovy build step using Groovy command?

Software levels:

I am working with a Freestyle project (not a pipeline) and want to use a Groovy command build step for the job's main processing.

I am trying to obtain the userid and password from a user credential so the groovy script can use them for various CLI manipulations. I spent a lot of time searching for answers, but none of the ones I've found worked. Most were not clear, many were geared toward pipelines.

I would greatly appreciate a little guidance at this point.

Here are the gory details.

I created a new parameterized Freestyle project in which I added a Credentials Parameter for a "Username and password" credential. It defaults to one of the credentials that I defined to Jenkins via the Credentials Plugin. I'm not sure this is necessary if the binding selects the credential to use explicitly.

enter image description here

I checked "Use secret text(s) or file(s)" in the Build Environment section, although I'm not certain that is essential for a Username/password style binding.

Build Environment Settings

I added a "Username and password (separated)" binding and set USERID and PASSWORD as the respective variables.

Bindings

My groovy command window has this sole line: println("${USERID} ${PASSWORD}")

Groovy command

When I build the job, I get this error:

The output

Upvotes: 0

Views: 14203

Answers (2)

yong
yong

Reputation: 13722

The both ways will inject the credential into Environment Variable, thus you can access them from Environment Variable in Groovy Script as following for both ways.

def env = System.getenv()
println env['auth']
println env['USERNAME']
println env['PASSSWORD']

But the injected value of the both ways are different.

1) Adding a Credential job parameter for user to choose when run job

In this way, the credentialId is injected, so you not get the username and password.

credentialId example: 1dd4755a-9396-4819-9327-86f25650c7d7

2) Using Credential Bindings

In this way, the username and password are injected, I think this is what you wanted.

def env = System.getenv()
def username = env['USERNAME']
def password = env['PASSSWORD']

def cmd = "curl -u $username:$password ...."

Add a Jenkins Build Step supply by plugin Execute Groovy script

enter image description here

Upvotes: 2

John Czukkermann
John Czukkermann

Reputation: 625

To summarize, the techniques identified by @yong's post will only work with System Groovy Script build steps. The latest plugin and Jenkins levels will obfuscate the credential parameters, so println cannot be used to verify their content by visual inspection.

Upvotes: 0

Related Questions