properties
APIs:
parameters
properties([
parameters([
string( defaultValue: '', name: 'stringParams', description: '', trim: false ),
string( defaultValue: 'default', name: 'stringDefaultParams', description: '', trim: false ),
validatingString( defaultValue: '', name: 'validatingString', regex: '.+', description: 'format: <code>.+</code>', failedValidationMessage: 'cannot be empty' ),
choice( choices: ['a', 'b', 'c', 'd'], name: 'choiceParams', description: '' ),
booleanParam( defaultValue: false, name: 'booleanParams', description: '' )
])
])
mixed parameters
[!NOTE|label:references:]
import groovy.transform.Field
import org.jenkinsci.plugins.scriptsecurity.sandbox.groovy.SecureGroovyScript
@Field def props = []
@Field def newParams = []
@Field def fb = new SecureGroovyScript("""return ['Script Error!']""", false)
@Field def ps = new SecureGroovyScript("""return[ 'Gansu', 'Sichuan', 'Disabled:disabled' ]""", false )
@Field def cs = new SecureGroovyScript("""#!groovy
Map citySets = [
Gansu : ['Lanzhou', 'Dingxi'] ,
Sichuan : ['Leshan', 'Guangyuan', 'Chengdu:selected'] ,
Disabled : ['notshow:selected']
]
return citySets[provinces]
""", false)
newParams += [ $class: 'StashedFileParameterDefinition' , name: 'filename' , description: 'to upload file' ]
newParams += [ $class: 'StringParameterDefinition' , name: 'lastName' , defaultValue: 'Joe' , description: '' ]
newParams += [ $class: 'StringParameterDefinition' , name: 'firstName' , defaultValue: 'Dan' , description: '' ]
newParams += [
$class : 'ValidatingStringParameterDefinition' ,
defaultValue : '' ,
description : 'timestamps format: <code>YYMMDDHHMMSS</code>' ,
failedValidationMessage : 'Cannot be empty or failed by Regex validation !' ,
name : 'timeStamps' ,
regex : '\\d{2,4}(0[1-9]|1[0-2])(0[1-9]|[1-2][0-9]|3[0-1])(2[0-3]|[01][0-9])[0-5][0-9]\\d{0,2}'
]
newParams += [
$class : 'ChoiceParameter' ,
name : 'provinces' ,
choiceType : 'PT_SINGLE_SELECT' ,
script : [
$class : 'GroovyScript' ,
script : ps ,
fallbackScript : fb
] ,
description : ''
]
newParams += [
$class : 'CascadeChoiceParameter' ,
name : 'cities' ,
referencedParameters : 'provinces' ,
choiceType : 'PT_CHECKBOX' ,
script : [
$class : 'GroovyScript' ,
script : cs ,
fallbackScript : fb
] ,
description : ''
]
newParams += [ $class: 'BooleanParameterDefinition' , name: 'notify' , defaultValue: false , description: '' ]
props += [ $class: 'ParametersDefinitionProperty' , parameterDefinitions: newParams ]
properties( properties: props )
podTemplate(cloud: 'DevOps Kubernetes') {
node(POD_LABEL) {
stage('run') {
println """
lastName : ${params.lastName}
firstName : ${params.firstName}
provinces : ${params.provinces}
cities : ${params.cities}
notify : ${params.notify}
timeStamps : ${params.timeStamps}
filename : ${getFilename('filename')}
"""
} // stage
} // node
} // podTemplate
String getFilename( String name ) {
env.getEnvironment().find { "${name}_FILENAME" == it.key }?.value ?: ''
}
[!TIP|label:references]
properties([
parameters([
[
$class: 'ChoiceParameter',
name: 'provinces',
choiceType: 'PT_SINGLE_SELECT',
description: '',
script: [
$class: 'GroovyScript',
fallbackScript: [classpath: [], sandbox: false, script: '#!groovy return ["accept in ScriptApproval first"]'],
script: [classpath: [],
sandbox: false,
script: '''return[
\'Gansu\',
\'Sichuan\',
\'Disabled:disabled\'
]'''
]
]
], // ChoiceParameter
[
$class: 'CascadeChoiceParameter',
name: 'cities',
referencedParameters: 'provinces',
choiceType: 'PT_CHECKBOX',
description: '',
script: [
$class: 'GroovyScript',
fallbackScript: [classpath: [], sandbox: false, script: '#!groovy return ["accept in ScriptApproval first"]'],
script: [classpath: [],
sandbox: false,
script: '''if (provinces.equals("Gansu")) {
return ["Lanzhou", "Dingxi"]
} else if (provinces.equals("Sichuan")) {
return ["Leshan", "Guangyuan:disabled", "Chengdu:selected"]
} else if (provinces.equals("Disabled")) {
return ["notshow:selected"]
} else {
return ["Unknown provinces"]
}'''
]
]], // CascadeChoiceParameter
[
$class: 'StringParameterDefinition' ,
name: 'lastName' ,
defaultValue: 'Joe' ,
description: ''
], // StringParameterDefinition
[
$class: 'BooleanParameterDefinition',
name: 'notify',
defaultValue: false,
description: ''
] // BooleanParameterDefinition
])
])
or
import groovy.transform.Field import org.jenkinsci.plugins.scriptsecurity.sandbox.groovy.SecureGroovyScript @Field def props = [] @Field def newParams = [] @Field def fb = new SecureGroovyScript("""return ['Script Error!']""", false) @Field def ps = new SecureGroovyScript("""return[ 'Gansu', 'Sichuan', 'Disabled:disabled' ]""", false ) @Field def cs = new SecureGroovyScript("""#!groovy Map citySets = [ Gansu : ['Lanzhou', 'Dingxi'] , Sichuan : ['Leshan', 'Guangyuan', 'Chengdu:selected'] , Disabled : ['notshow:selected'] ] return citySets[provinces] """, false) newParams += [$class: 'ChoiceParameter', name: 'provinces', choiceType: 'PT_SINGLE_SELECT', script: [ $class: 'GroovyScript', script: ps, fallbackScript: fb ], description: '' ] newParams += [$class: 'CascadeChoiceParameter', name: 'cities', referencedParameters: 'provinces', choiceType: 'PT_CHECKBOX', script: [ $class: 'GroovyScript', script: cs, fallbackScript: fb ], description: '' ] props += [$class: 'ParametersDefinitionProperty', parameterDefinitions: newParams] properties( properties: props )
[!TIP|label:references]
#!/usr/bin/env groovy
import groovy.transform.Field
import static groovy.json.JsonOutput.*
def createCascadeChoiceDefinition( String name ,
String groovy ,
String fallback ,
String description ,
String choiceType ,
String reference = ''
) {
List<String> choiceTypes = [ 'PT_SINGLE_SELECT', 'PT_MULTI_SELECT', 'PT_RADIO', 'PT_CHECKBOX' ]
if ( ! choiceTypes.contains(choiceType) ) util.showError( "choiceType MUST be one of ${choiceTypes}.join(', ') !" )
fallback = fallback ?: "return ['script error !']"
[
$class : 'CascadeChoiceParameter' ,
choiceType : choiceType ,
filterLength : 1 ,
filterable : false ,
name : name ,
description : description ,
referencedParameters : reference ,
script : [
$class : 'GroovyScript' ,
fallbackScript : [ sandbox : true , script : fallback ] ,
script : [ sandbox : true , script : groovy ]
]
]
}
@Field final Map<String, List<String>> map = [
'CA:selected' : [ 'Los Angeles' , 'San Diego' , 'San Francisco:selected' ] ,
'NY' : [ 'New York' , 'Hempstead' ] ,
'TX' : [ 'Houston' , 'San Antonio' , 'Dallas' ]
]
def generateParameterDefinitions() {
final List newParams = []
final List props = []
String fallback = "return ['script error !']"
String states = "return ${map.inspect()}.keySet().toList()"
String cities = """
Map<String, List<String>> map = ${map.inspect()}
return states.split(',').collect { e ->
map.find{ it.key.startsWith(e) }.value.collect{ "\${e}:\${it}".toString() }
}.flatten()
""".stripIndent()
newParams += createCascadeChoiceDefinition( 'states' , states , fallback , '' , 'PT_CHECKBOX' )
newParams += createCascadeChoiceDefinition( 'cities' , cities , fallback , '' , 'PT_CHECKBOX', 'states' )
props += [ $class: 'ParametersDefinitionProperty' , parameterDefinitions: newParams ]
properties( properties: props )
}
generateParameterDefinitions()
println prettyPrint(toJson( params.collect { "${it.key} ~~> ${it.value}" } ))
// vim:tabstop=2:softtabstop=2:shiftwidth=2:expandtab:filetype=Groovy
[!TIP|label:references]
supported
choiceType
:
ET_TEXT_BOX
ET_ORDERED_LIST
ET_UNORDERED_LIST
ET_FORMATTED_HTML
ET_FORMATTED_HIDDEN_HTML
read more:
#!/usr/bin/env groovy
import groovy.transform.Field
import static groovy.json.JsonOutput.*
def generateParameterDefinitions() {
final List newParams = []
final List props = []
String fallback = "return ['script error !']"
String releaseIdScript = """
import java.time.LocalDateTime
import java.time.format.DateTimeFormatter
LocalDateTime ld = LocalDateTime.now()
String version = ld.format( DateTimeFormatter.ofPattern('yy.MM') )
String defaultValue = "v\${version}"
return "<input name='value' placeholder='MANDATORY: example format: `v<yy.MM>`' value='\${defaultValue}' class='jenkins-input' type='text'>"
""".stripIndent()
String todayScript = """
import java.time.LocalDateTime
import java.time.format.DateTimeFormatter
LocalDateTime ld = LocalDateTime.now()
String today = ld.format( DateTimeFormatter.ofPattern('YYYY-MM-dd') )
return "<input name='value' value='\${today}' class='setting-input' type='text'>"
""".stripIndent()
String pathScript = """
String defaultValue = "\${today}/\${releaseId}"
return "<input name='value' placeholder='MANDATORY: example format: `<YYYY-MM-dd>/v<yy.MM>`' value='\${defaultValue}' class='setting-input' type='text'>"
""".stripIndent()
newParams += [
$class : 'DynamicReferenceParameter' ,
choiceType : 'ET_FORMATTED_HTML' ,
name : 'releaseId' ,
omitValueField : true ,
referencedParameters : '' ,
description : 'the releaseId' ,
script : [
$class : 'GroovyScript' ,
fallbackScript : [ sandbox : true , script : fallback ] ,
script : [ sandbox : true , script : releaseIdScript ]
]
]
newParams += [
$class : 'DynamicReferenceParameter' ,
choiceType : 'ET_FORMATTED_HIDDEN_HTML' ,
name : 'today' ,
omitValueField : true ,
referencedParameters : '' ,
description : 'the hidden params of today\'s date in format of <YYYY-MM-dd>',
script : [
$class : 'GroovyScript' ,
fallbackScript : [ sandbox : true , script : fallback ] ,
script : [ sandbox : true , script : todayScript ]
]
]
newParams += [
$class : 'DynamicReferenceParameter' ,
choiceType : 'ET_FORMATTED_HTML' ,
name : 'path' ,
omitValueField : true ,
referencedParameters : 'releaseId,today' ,
description : 'the path' ,
script : [
$class : 'GroovyScript' ,
fallbackScript : [ sandbox : true , script : fallback ] ,
script : [ sandbox : true , script : pathScript ]
]
]
props += [ $class: 'ParametersDefinitionProperty' , parameterDefinitions: newParams ]
properties( properties: props )
}
generateParameterDefinitions()
println prettyPrint(toJson( params.collect { "${it.key} ~~> ${it.value}" } ))
// vim:tabstop=2:softtabstop=2:shiftwidth=2:expandtab:filetype=Groovy
createDynamicReferenceDefinition
functiondef createDynamicReferenceDefinition( String name , String reference , String groovy , String fallback , String description , String choiceType , Boolean omit ) { List<String> choiceTypes = [ 'ET_TEXT_BOX', 'ET_ORDERED_LIST', 'ET_UNORDERED_LIST', 'ET_FORMATTED_HTML', 'ET_FORMATTED_HIDDEN_HTML' ] if ( ! choiceTypes.contains(choiceType) ) util.showError( "choiceType MUST be one of ${choiceTypes}.join(', ') !" ) [ $class : 'DynamicReferenceParameter' , choiceType : choiceType , name : name , omitValueField : omit , referencedParameters : reference , description : description , script : [ $class : 'GroovyScript' , fallbackScript : [ sandbox : true , script : fallback ] , script : [ sandbox : true , script : groovy ] ] ] } /** * omit is true by default **/ def createDynamicReferenceDefinition( String name, String reference, String groovy, String fallback, String description, String choiceType ) { createDynamicReferenceDefinition( name, reference, groovy, fallback, description, choiceType, true ) }
jenkinsfile
#!/usr/bin/env groovy import groovy.transform.Field import static groovy.json.JsonOutput.* def createDynamicReferenceDefinition( String name , String reference , String groovy , String fallback , String description , String choiceType , Boolean omit ) { List<String> choiceTypes = [ 'ET_TEXT_BOX', 'ET_ORDERED_LIST', 'ET_UNORDERED_LIST', 'ET_FORMATTED_HTML', 'ET_FORMATTED_HIDDEN_HTML' ] if ( ! choiceTypes.contains(choiceType) ) util.showError( "choiceType MUST be one of ${choiceTypes}.join(', ') !" ) [ $class : 'DynamicReferenceParameter' , choiceType : choiceType , name : name , omitValueField : omit , referencedParameters : reference , description : description , script : [ $class : 'GroovyScript' , fallbackScript : [ sandbox : true , script : fallback ] , script : [ sandbox : true , script : groovy ] ] ] } def createDynamicReferenceDefinition( String name, String reference, String groovy, String fallback, String description, String choiceType ) { createDynamicReferenceDefinition( name, reference, groovy, fallback, description, choiceType, true ) } def generateParameterDefinitions() { final List newParams = [] final List props = [] String fallback = "return ['script error !']" String releaseId = """ import java.time.LocalDateTime import java.time.format.DateTimeFormatter LocalDateTime ld = LocalDateTime.now() String version = ld.format( DateTimeFormatter.ofPattern('yy.MM') ) String defaultValue = "v\${version}" return "<input name='value' placeholder value='\${defaultValue}' class='jenkins-input' type='text'>" """.stripIndent() String today = """ import java.time.LocalDateTime import java.time.format.DateTimeFormatter LocalDateTime ld = LocalDateTime.now() String today = ld.format( DateTimeFormatter.ofPattern('YYYY-MM-dd') ) return "<input name='value' value='\${today}' class='setting-input' type='text'>" """.stripIndent() String path = """ String defaultValue = "\${today}/\${releaseId}" return "<input name='value' placeholder='MANDATORY: example format: `<YYYY-MM-dd>/<yy.MM>`' value='\${defaultValue}' class='setting-input' type='text'>" """.stripIndent() newParams += createDynamicReferenceDefinition( 'releaseId' , '' , releaseId , fallback , '' , 'ET_FORMATTED_HTML' ) newParams += createDynamicReferenceDefinition( 'today' , '' , today , fallback , '' , 'ET_FORMATTED_HIDDEN_HTML' ) newParams += createDynamicReferenceDefinition( 'path' , 'releaseId,today' , path , fallback , '' , 'ET_FORMATTED_HTML' ) props += [ $class: 'ParametersDefinitionProperty' , parameterDefinitions: newParams ] properties( properties: props ) } generateParameterDefinitions() println prettyPrint(toJson( params.collect { "${it.key} ~~> ${it.value}" } )) // vim:tabstop=2:softtabstop=2:shiftwidth=2:expandtab:filetype=Groovy
import groovy.transform.Field
import org.jenkinsci.plugins.scriptsecurity.sandbox.groovy.SecureGroovyScript
@Field def props = []
@Field def newParams = []
node('mster') {
setNewProps()
} // node
void setNewProps() {
//Parameters are unknown at first load
try {
regenerateJob = (params.RegenerateJob == null) ? true : params.RegenerateJob
}
catch (MissingPropertyException e) {
regenerateJob = true
}
if (regenerateJob) {
def fb = new SecureGroovyScript("""return ['Script Error!']""", false)
def ps = new SecureGroovyScript("""return[ 'Gansu', 'Sichuan', 'Disabled:disabled' ]""", false )
def cs = new SecureGroovyScript("""#!groovy
Map citySets = [
Gansu : ['Lanzhou', 'Dingxi'] ,
Sichuan : ['Leshan', 'Guangyuan', 'Chengdu:selected'] ,
Disabled : ['notshow:selected']
]
return citySets[provinces]
""", false)
println "Jenkins job ${env.JOB_NAME} gets updated."
currentBuild.displayName = "#" + Integer.toString(currentBuild.number) + ": Initialize job"
newParams += [$class: 'StringParameterDefinition' , name: 'lastName' , defaultValue: 'Joe' , description: '']
newParams += [$class: 'StringParameterDefinition' , name: 'firstName' , defaultValue: 'Dan' , description: '']
newParams += [
$class : 'ValidatingStringParameterDefinition',
name : 'timeStamps' ,
description : 'timestamps format: <code>YYMMDDHHMMSS</code>' ,
failedValidationMessage : 'Cannot be empty or failed by Regex validation !' ,
defaultValue : '' ,
regex : '\\d{2,4}(0[1-9]|1[0-2])(0[1-9]|[1-2][0-9]|3[0-1])(2[0-3]|[01][0-9])[0-5][0-9]\\d{0,2}'
]
newParams += [
$class : 'ChoiceParameter' ,
name : 'provinces' ,
choiceType : 'PT_SINGLE_SELECT' ,
script : [
$class : 'GroovyScript' ,
script : ps ,
fallbackScript : fb
] ,
description : ''
]
newParams += [
$class : 'CascadeChoiceParameter' ,
name : 'cities' ,
referencedParameters : 'provinces' ,
choiceType : 'PT_CHECKBOX' ,
script : [
$class : 'GroovyScript' ,
script : cs ,
fallbackScript : fb
] ,
description : ''
]
newParams += [$class: 'BooleanParameterDefinition' , name: 'notify' , defaultValue: false , description: '']
props += [
$class : 'BuildDiscarderProperty',
strategy : [$class: 'LogRotator', daysToKeepStr: '30', artifactDaysToKeepStr: '1', artifactNumToKeepStr: '']
]
props += [$class: 'ParametersDefinitionProperty', parameterDefinitions: newParams]
properties( properties: props )
}
}
file paramter
[!NOTE|label:references]
create file parameter
final List props = []
final List newParams = []
newParams += [ $class: 'StashedFileParameterDefinition' , name: 'jsonFile', description: 'to upload file' ]
props += [ $class: 'ParametersDefinitionProperty' , parameterDefinitions: newParams ]
properties( properties: props )
// or
properties([ parameters([ stashedFile('FILE') ]) ])
use file parameter
/**
* get the original filename who was uploaded via File Parameter
*
* @param name the parameter name
* @see <a href="https://plugins.jenkins.io/file-parameters/">File Parameter</a>
**/
String getFilename( String name ) {
env.getEnvironment().find { "${name}_FILENAME" == it.key }?.value ?: ''
}
/**
* unstash the file who was uploaded via File Parameter
*
* @param name the parameter name
* @see <a href="https://plugins.jenkins.io/file-parameters/">File Parameter</a>
**/
Boolean unstashFile( String name ) {
String filename = getFilename( name )
if ( filename ) {
unstash "${name}"
sh """ set +x; mv "${name}" ${filename} """
return util.fileFinder( filename, 0 ) && true
} else {
color.alert( '... no uploaded file found ...' )
return false
}
}
hidden parameter
[!NOTE|label:references:]
setup
final List props = [] final List newParams = [] newParams += [ $class: 'WHideParameterDefinition' , name: 'HIDDEN_PARAM', description: 'Hidden param' ] props += [ $class: 'ParametersDefinitionProperty' , parameterDefinitions: newParams ] properties( properties: props ) // or final List newParams = [] newParams += hidden( name: 'HIDDEN_PARAM', description: 'Hidden param' ) properties([ parameters(newParams) ]) // or properties([ parameters([ hidden( name: 'hidden_param', defaultValue: 'hidden_value', description: 'Hidden parameter' ) ]) ])
[!NOTE|label:references] ** END OF LIFE **
Last updated