Added support for Extended Choice Parameter plugin

https://wiki.jenkins-ci.org/display/JENKINS/Extended+Choice+Parameter+plugin
based on https://github.com/rozky/jenkins-job-builder

Change-Id: If179619da5e795a1649168e133ca25b5f9f7b187
This commit is contained in:
Tomas Bezdek 2014-11-04 11:34:39 +00:00
parent dccd939102
commit e300d6926e
4 changed files with 84 additions and 0 deletions

View File

@ -35,6 +35,7 @@ Example::
import xml.etree.ElementTree as XML
import jenkins_jobs.modules.base
from jenkins_jobs.errors import JenkinsJobsException
def base_param(parser, xml_parent, data, do_default, ptype):
@ -216,6 +217,61 @@ def run_param(parser, xml_parent, data):
XML.SubElement(pdef, 'projectName').text = data['project-name']
def extended_choice_param(parser, xml_parent, data):
"""yaml: extended-choice
Extended Choice Parameter
Requires the Jenkins `Extended Choice Parameter Plug-in.
<https://wiki.jenkins-ci.org/display/JENKINS/
Extended+Choice+Parameter+plugin>`_
:arg str name: the name of the parameter
:arg str description: a description of the parameter (optional)
:arg str type: parameter select type. Can be PT_SINGLE_SELECT,
PT_MULTI_SELECT, PT_RADIO, PT_CHECKBOX, PT_TEXTBOX
:arg str value: comma separated list of values
:arg str visible-item-count: number of lines to render for multi-select
(default 5)
:arg str multi-select-delimiter: value between selections when the
parameter is a multi-select (default ,)
:arg str default-value: default selected value
Example:
.. literalinclude:: \
/../../tests/parameters/fixtures/extended-choice-param001.yaml
:language: yaml
"""
pdef = XML.SubElement(xml_parent,
'com.cwctravel.hudson.plugins.'
'extended__choice__parameter.'
'ExtendedChoiceParameterDefinition')
XML.SubElement(pdef, 'name').text = data['name']
XML.SubElement(pdef, 'description').text = data.get('description', '')
types_list = ['PT_SINGLE_SELECT',
'PT_MULTI_SELECT',
'PT_RADIO',
'PT_CHECKBOX',
'PT_TEXTBOX']
type = data['type']
if type not in types_list:
raise JenkinsJobsException(
'extended-choice type must be one of: '
+ ', '.join(types_list))
else:
XML.SubElement(pdef, 'type').text = type
XML.SubElement(pdef, 'value').text = data.get('value', '')
XML.SubElement(pdef, 'visibleItemCount').text = data.get(
'visible-item-count', '5')
XML.SubElement(pdef, 'multiSelectDelimiter').text = data.get(
'multi-select-delimiter', ',')
XML.SubElement(pdef, 'quoteValue').text = 'false'
XML.SubElement(pdef, 'defaultValue').text = data.get(
'default-value', '')
def validating_string_param(parser, xml_parent, data):
"""yaml: validating-string
A validating string parameter

View File

@ -92,6 +92,7 @@ jenkins_jobs.parameters =
dynamic-choice-scriptler=jenkins_jobs.modules.parameters:dynamic_choice_scriptler_param
dynamic-string=jenkins_jobs.modules.parameters:dynamic_string_param
dynamic-string-scriptler=jenkins_jobs.modules.parameters:dynamic_string_scriptler_param
extended-choice=jenkins_jobs.modules.parameters:extended_choice_param
file=jenkins_jobs.modules.parameters:file_param
label=jenkins_jobs.modules.parameters:label_param
password=jenkins_jobs.modules.parameters:password_param

View File

@ -0,0 +1,19 @@
<?xml version="1.0" encoding="utf-8"?>
<project>
<properties>
<hudson.model.ParametersDefinitionProperty>
<parameterDefinitions>
<com.cwctravel.hudson.plugins.extended__choice__parameter.ExtendedChoiceParameterDefinition>
<name>OPTIONS</name>
<description>Available options</description>
<type>PT_CHECKBOX</type>
<value>OptionA,OptionB,OptionC</value>
<visibleItemCount>2</visibleItemCount>
<multiSelectDelimiter>,</multiSelectDelimiter>
<quoteValue>false</quoteValue>
<defaultValue/>
</com.cwctravel.hudson.plugins.extended__choice__parameter.ExtendedChoiceParameterDefinition>
</parameterDefinitions>
</hudson.model.ParametersDefinitionProperty>
</properties>
</project>

View File

@ -0,0 +1,8 @@
parameters:
- extended-choice:
name: OPTIONS
description: "Available options"
type: 'PT_CHECKBOX'
value: OptionA,OptionB,OptionC
visible-item-count: "2"