jjb/jenkins-job-builder
Code Issues Proposed changes

Add valid set of options parameters to convert_xml

Browse Source 
Valid options provides a way to check if the value the user input is
from a list of available options.

Change-Id: I22409602fb526a83c0525772d68da1dbd28dd11b
Signed-off-by: Kien Ha <kienha9922@gmail.com>
This commit is contained in:
Kien Ha 2016-07-04 19:19:55 -04:00
parent 6fd2b0a433
commit e237d7eb74
2 changed files with 27 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
jenkins_jobs/modules/helpers.py
View File

@ -492,11 +492,19 @@ def convert_mapping_to_xml(parent, data, mapping, fail_required=False):
configuring the XML tag for the parameter. We recommend for new plugins to
set fail_required=True and instead of optional parameters provide a default
value for all paramters that are not required instead.
valid_options provides a way to check if the value the user input is from a
list of available options. When the user pass a value that is not supported
from the list, it raise an InvalidAttributeError.
"""
for elem in mapping:
(optname, xmlname, val) = elem
(optname, xmlname, val) = elem[:3]
val = data.get(optname, val)
valid_options = []
if len(elem) == 4:
valid_options = elem[3]
# Use fail_required setting to allow support for optional parameters
# we will phase this out in the future as we rework plugins so that
# optional parameters use a default setting instead.
@ -509,6 +517,10 @@ def convert_mapping_to_xml(parent, data, mapping, fail_required=False):
if val is None and fail_required is False:
continue
if valid_options:
if val not in valid_options:
raise InvalidAttributeError(optname, val, valid_options)
if type(val) == bool:
val = str(val).lower()
XML.SubElement(parent, xmlname).text = str(val)

14
tests/modules/test_helpers.py
View File

@ -18,6 +18,7 @@ from testtools.matchers import Equals
import xml.etree.ElementTree as XML
import yaml
from jenkins_jobs.errors import InvalidAttributeError
from jenkins_jobs.errors import MissingAttributeError
from jenkins_jobs.modules.helpers import convert_mapping_to_xml
from tests.base import LoggingFixture
@ -68,3 +69,16 @@ class TestCaseTestHelpers(LoggingFixture, testtools.TestCase):
required_data,
required_mappings,
fail_required=True)
# Test invalid user input
user_input_root = XML.Element('testUserInput')
user_input_data = yaml.load("user-input-string: bye")
valid_inputs = ['hello']
user_input_mappings = [('user-input-string', 'userInputString',
'user-input', valid_inputs)]
self.assertRaises(InvalidAttributeError,
convert_mapping_to_xml,
user_input_root,
user_input_data,
user_input_mappings)