How to retrieve Jenkins build parameters using the Groovy API

Question

I have a parameterized job that uses the Perforce plugin and would like to retrieve the build parameters properties as well as the p4 change property that s set by the Perforce plugin   How do I retrieve these properties with the Jenkins Groovy API

User · Answer

To get the parameterized build params from the current build from your GroovyScript  using Pipeline   all you need to do is  Say you had a variable called VARNAME   def myVariable   env VARNAME

User · Answer

Update  Jenkins 2 x solution   With Jenkins 2 pipeline dsl  you can directly access any parameter with the trivial syntax based on the params  Map  built-in   echo   FOOBAR value    params  FOOBAR     The returned value will be a String or a boolean depending on the Parameter type itself  The syntax is the same for scripted or declarative syntax  More info at  https   jenkins io doc book pipeline jenkinsfile  handling-parameters   Original Answer for Jenkins 1 x   For Jenkins 1 x  the syntax is based on the build buildVariableResolver built-ins          or if you want the parameter by name     def hardcoded param    FOOBAR  def resolver   build buildVariableResolver def hardcoded param value   resolver resolve hardcoded param    Please note the official Jenkins Wiki page covers this in more details as well  especially how to iterate upon the build parameters  https   wiki jenkins-ci org display JENKINS Parameterized System Groovy script  The salient part is reproduced below      get parameters def parameters   build  actions find  it instanceof ParametersAction    parameters parameters each      println  parameter   it name       println it dump

User · Answer

Get all of the parameters   System getenv   each    println it     Or more sophisticated   def myvariables   getBinding   getVariables   for  v in myvariables       echo    v      myvariables get v      You will need to disable  Use Groovy Sandbox  for both

User · Answer

The following snippet worked for me to get a parameter value in a parameterized project  String myParameter   this getProperty  binding   getVariable  MY PARAMETER   The goal was to dynamically lock a resource based on the selected project parameter  In  quot     This build requires lockable resources quot  I have the following  quot     Groovy Expression quot   if  resourceName     resource lock name         Binding binding   this getProperty  binding       String profile   binding getVariable  BUILD PROFILE        return profile     -Poradb     acquire lock if  quot oradb quot  profile is selected    return false  In  quot     This project is parameterized quot  section I have a  quot Choice Parameter quot  named e g  BUILD PROFILE Example of Choices are  -Poradb -Ph2db -DskipTests -T4  The lock on  quot resource lock name quot  will be acquired only if  quot -Poradb quot  is selected when building project with parameters  -  Use Groovy Sandbox shall be unchecked for this syntax to work

User · Answer

If you are trying to get all parameters passed to Jenkins job you can use the global variable params in your groovy pipeline to fetch it        http   jenkins host 8080 pipeline-syntax globals      params       Exposes all parameters defined in the build as a read-only map   with variously typed values  Example       if  params BOOLEAN PARAM NAME   doSomething    or to supply a   nontrivial default value       if  params get  BOOLEAN PARAM NAME   true    doSomething    Note for   multibranch  Jenkinsfile  usage  the properties step allows you to   define job properties  but these take effect when the step is run    whereas build parameter definitions are generally consulted before the   build begins  As a convenience  any parameters currently defined in   the job which have default values will also be listed in this map    That allows you to write  for example       properties  parameters  string name   BRANCH   defaultValue     master       git url         branch  params BRANCH and be assured that   the master branch will be checked out even in the initial build of a   branch project  or if the previous build did not specify parameters or   used a different parameter name    Use something like below   def dumpParameter       params each       println it key           it value

User · Answer

Regarding parameters   See this answer first  To get a list of all the builds for a project  obtained as per that answer    project builds   When you find your particular build  you need to get all actions of type ParametersAction with build getActions hudson model ParametersAction   You then query the returned object for your specific parameters   Regarding p4 change  I suspect that it is also stored as an action  In Jenkins Groovy console get all actions for a build that contains p4 change and examine them - it will give you an idea what to look for in your code

User · Answer

For resolving a single parameter  I guess what s most commonly needed   this is the simplest I found      build buildVariableResolver resolve  myparameter     in your Groovy System script build step

User · Answer

The following can be used to retreive an environment parameter   println System getenv  MY PARAM

User · Answer

In cases when a parameter name cannot be hardcoded I found this would be the simplest and best way to access parameters   def myParam   env getProperty dynamicParamName    In cases  when a parameter name is known and can be hardcoded the following 3 lines are equivalent   def myParam   env getProperty  myParamName   def myParam   env myParamName def myParam   myParamName

User · Answer

I ve just got this working  so specifically  using the Groovy Postbuild plugin  you can do the following   def paramText def actionList   manager build getActions hudson model ParametersAction  if  actionList size      0      def pA   actionList get 0    paramText   pA createVariableResolver manager build  resolve  MY PARAM NAME

User · Answer

thanks patrice-n  this code worked to get both queued and running jobs and their parameters   import hudson model Job import hudson model ParametersAction import hudson model Queue import jenkins model Jenkins  println                                                     for  Job job   Jenkins instanceOrNull getAllItems Job class         if  job isInQueue              println  ------------------------------------------------           println  InQueue     job name           Queue Item queue   job getQueueItem           if  queue    null                println queue params                      if  job isBuilding              println  ------------------------------------------------           println  Building     job name           def build   job getBuilds   getLastBuild           def parameters   build  getAllActions   find  it instanceof ParametersAction    parameters         parameters each               def dump   it dump               println  parameter   it name     dump                     println

[groovy] How to retrieve Jenkins build parameters using the Groovy API?

Examples related to groovy

Examples related to jenkins