Update class Pipeline to use convert_mapping_to_xml()

Change-Id: I37b3deb9a0db2eea3c24dc16409cd730887f7bf1

jenkins_jobs/modules/view_pipeline.py

@@ -15,6 +15,8 @@
 import xml.etree.ElementTree as XML
 import jenkins_jobs.modules.base
 
+from jenkins_jobs.modules.helpers import convert_mapping_to_xml
+
 """
 The view pipeline module handles creating Jenkins Build Pipeline views.
 To create a list view specify ``list`` in the ``view-type`` attribute
@@ -72,18 +74,13 @@ class Pipeline(jenkins_jobs.modules.base.Base):
         root = XML.Element('au.com.centrumsystems.hudson.'
                            'plugin.buildpipeline.BuildPipelineView',
                            {'plugin': 'build-pipeline-plugin'})
-        XML.SubElement(root, 'name').text = data['name']
-        desc_text = data.get('description', None)
-        if desc_text is not None:
-            XML.SubElement(root, 'description').text = desc_text
 
-        filterExecutors = data.get('filter-executors', False)
+        mapping_optional = [
-        FE_element = XML.SubElement(root, 'filterExecutors')
+            ('description', 'description', None),
-        FE_element.text = 'true' if filterExecutors else 'false'
+            ('filter-executors', 'filterExecutors', False),
-
+            ('filter-queue', 'filterQueue', False)]
-        filterQueue = data.get('filter-queue', False)
+        convert_mapping_to_xml(root, data,
-        FQ_element = XML.SubElement(root, 'filterQueue')
+            mapping_optional, fail_required=False)
-        FQ_element.text = 'true' if filterQueue else 'false'
 
         XML.SubElement(root, 'properties',
                        {'class': 'hudson.model.View$PropertyList'})
@@ -95,51 +92,21 @@ class Pipeline(jenkins_jobs.modules.base.Base):
         jobname = data.get('first-job', '')
         XML.SubElement(gridBuilder, 'firstJob').text = jobname
 
-        builds = str(data.get('no-of-displayed-builds', 1))
+        mapping = [
-        XML.SubElement(root, 'noOfDisplayedBuilds').text = builds
+            ('name', 'name', None),
-
+            ('no-of-displayed-builds', 'noOfDisplayedBuilds', 1),
-        title = data.get('title', None)
+            ('title', 'buildViewTitle', ''),
-        BVT_element = XML.SubElement(root, 'buildViewTitle')
+            ('link-style', 'consoleOutputLinkStyle', 'Lightbox', linktypes),
-        if title is not None:
+            ('css-Url', 'cssUrl', ''),
-            BVT_element.text = title
+            ('latest-job-only', 'triggerOnlyLatestJob', False),
-
+            ('manual-trigger', 'alwaysAllowManualTrigger', False),
-        linkStyle = data.get('link-style', 'Lightbox')
+            ('show-parameters', 'showPipelineParameters', False),
-        LS_element = XML.SubElement(root, 'consoleOutputLinkStyle')
+            ('parameters-in-headers',
-        if linkStyle in linktypes:
+                'showPipelineParametersInHeaders', False),
-            LS_element.text = linkStyle
+            ('start-with-parameters', 'startsWithParameters', False),
-        else:
+            ('refresh-frequency', 'refreshFrequency', 3),
-            LS_element.text = 'Lightbox'
+            ('definition-header', 'showPipelineDefinitionHeader', False)
-
+        ]
-        cssUrl = data.get('css-Url', None)
+        convert_mapping_to_xml(root, data, mapping, fail_required=True)
-        CU_element = XML.SubElement(root, 'cssUrl')
-        if cssUrl is not None:
-            CU_element.text = cssUrl
-
-        latest_job_only = data.get('latest-job-only', False)
-        OLJ_element = XML.SubElement(root, 'triggerOnlyLatestJob')
-        OLJ_element.text = 'true' if latest_job_only else 'false'
-
-        manual_trigger = data.get('manual-trigger', False)
-        AMT_element = XML.SubElement(root, 'alwaysAllowManualTrigger')
-        AMT_element.text = 'true' if manual_trigger else 'false'
-
-        show_parameters = data.get('show-parameters', False)
-        PP_element = XML.SubElement(root, 'showPipelineParameters')
-        PP_element.text = 'true' if show_parameters else 'false'
-
-        parameters_in_headers = data.get('parameters-in-headers', False)
-        PIH_element = XML.SubElement(root, 'showPipelineParametersInHeaders')
-        PIH_element.text = 'true' if parameters_in_headers else 'false'
-
-        start_with_parameters = data.get('start-with-parameters', False)
-        SWP_element = XML.SubElement(root, 'startsWithParameters')
-        SWP_element.text = 'true' if start_with_parameters else 'false'
-
-        refresh_frequency = str(data.get('refresh-frequency', 3))
-        XML.SubElement(root, 'refreshFrequency').text = refresh_frequency
-
-        headers = data.get('definition-header', False)
-        DH_element = XML.SubElement(root, 'showPipelineDefinitionHeader')
-        DH_element.text = 'true' if headers else 'false'
 
         return root

tests/views/fixtures/view_pipeline001.xml

@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
 <au.com.centrumsystems.hudson.plugin.buildpipeline.BuildPipelineView plugin="build-pipeline-plugin">
-  <name>testBPview</name>
   <description>This is a description</description>
   <filterExecutors>false</filterExecutors>
   <filterQueue>false</filterQueue>
@@ -8,6 +7,7 @@
   <gridBuilder class="au.com.centrumsystems.hudson.plugin.buildpipeline.DownstreamProjectGridBuilder">
     <firstJob>job-one</firstJob>
   </gridBuilder>
+  <name>testBPview</name>
   <noOfDisplayedBuilds>5</noOfDisplayedBuilds>
   <buildViewTitle>Title</buildViewTitle>
   <consoleOutputLinkStyle>New Window</consoleOutputLinkStyle>

tests/views/fixtures/view_pipeline002.xml

@@ -1,12 +1,12 @@
 <?xml version="1.0" encoding="utf-8"?>
 <au.com.centrumsystems.hudson.plugin.buildpipeline.BuildPipelineView plugin="build-pipeline-plugin">
-  <name>testBPview</name>
   <filterExecutors>false</filterExecutors>
   <filterQueue>false</filterQueue>
   <properties class="hudson.model.View$PropertyList"/>
   <gridBuilder class="au.com.centrumsystems.hudson.plugin.buildpipeline.DownstreamProjectGridBuilder">
     <firstJob>job-one</firstJob>
   </gridBuilder>
+  <name>testBPview</name>
   <noOfDisplayedBuilds>1</noOfDisplayedBuilds>
   <buildViewTitle/>
   <consoleOutputLinkStyle>Lightbox</consoleOutputLinkStyle>