Merge "Update Delivery Pipeline plugin to use convert xml"

jenkins_jobs/modules/properties.py

@@ -39,6 +39,7 @@ from jenkins_jobs.errors import InvalidAttributeError
 from jenkins_jobs.errors import JenkinsJobsException
 from jenkins_jobs.errors import MissingAttributeError
 import jenkins_jobs.modules.base
+from jenkins_jobs.modules.helpers import convert_mapping_to_xml
 
 
 def builds_chain_fingerprinter(parser, xml_parent, data):
@@ -616,20 +617,28 @@ def delivery_pipeline(parser, xml_parent, data):
     :arg str description: task description template for this job
         (default '')
 
-    Example:
+    Minimal Example:
 
     .. literalinclude::
-        /../../tests/properties/fixtures/delivery-pipeline1.yaml
+       /../../tests/properties/fixtures/delivery-pipeline-minimal.yaml
        :language: yaml
 
+    Full Example:
+
+    .. literalinclude::
+       /../../tests/properties/fixtures/delivery-pipeline-full.yaml
+       :language: yaml
     """
-    pipeline = XML.SubElement(xml_parent,
+    pipeline = XML.SubElement(
-                              'se.diabol.jenkins.pipeline.'
+        xml_parent, 'se.diabol.jenkins.pipeline.PipelineProperty')
-                              'PipelineProperty')
+    pipeline.set('plugin', 'delivery-pipeline-plugin')
-    XML.SubElement(pipeline, 'stageName').text = data.get('stage', '')
+
-    XML.SubElement(pipeline, 'taskName').text = data.get('task', '')
+    mapping = [
-    XML.SubElement(pipeline, 'descriptionTemplate').text = str(
+        ('stage', 'stageName', ''),
-        data.get('description', ''))
+        ('task', 'taskName', ''),
+        ('description', 'descriptionTemplate', ''),
+    ]
+    convert_mapping_to_xml(pipeline, data, mapping, fail_required=True)
 
 
 def zeromq_event(parser, xml_parent, data):

jenkins_jobs/modules/wrappers.py

@@ -1521,18 +1521,27 @@ def delivery_pipeline(parser, xml_parent, data):
     :arg bool set-display-name: Set the generated version as the display name
         for the build (default false)
 
-    Example:
+    Minimal Example:
 
-    .. literalinclude:: /../../tests/wrappers/fixtures/delivery-pipeline1.yaml
+    .. literalinclude::
+       /../../tests/wrappers/fixtures/delivery-pipeline-minimal.yaml
+       :language: yaml
 
+    Full Example:
+
+    .. literalinclude::
+       /../../tests/wrappers/fixtures/delivery-pipeline-full.yaml
+       :language: yaml
     """
-    pvc = XML.SubElement(xml_parent,
+    pvc = XML.SubElement(
-                         'se.diabol.jenkins.pipeline.'
+        xml_parent, 'se.diabol.jenkins.pipeline.PipelineVersionContributor')
-                         'PipelineVersionContributor')
+    pvc.set('plugin', 'delivery-pipeline-plugin')
-    XML.SubElement(pvc, 'versionTemplate').text = data.get(
+
-        'version-template', '')
+    mapping = [
-    XML.SubElement(pvc, 'updateDisplayName').text = str(data.get(
+        ('version-template', 'versionTemplate', ''),
-        'set-display-name', False)).lower()
+        ('set-display-name', 'updateDisplayName', False),
+    ]
+    convert_mapping_to_xml(pvc, data, mapping, fail_required=True)
 
 
 def matrix_tie_parent(parser, xml_parent, data):

tests/properties/fixtures/delivery-pipeline-full.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <project>
   <properties>
-    <se.diabol.jenkins.pipeline.PipelineProperty>
+    <se.diabol.jenkins.pipeline.PipelineProperty plugin="delivery-pipeline-plugin">
       <stageName>Stage</stageName>
       <taskName>Task</taskName>
       <descriptionTemplate>Task-Description</descriptionTemplate>

tests/properties/fixtures/delivery-pipeline-minimal.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <project>
   <properties>
-    <se.diabol.jenkins.pipeline.PipelineProperty>
+    <se.diabol.jenkins.pipeline.PipelineProperty plugin="delivery-pipeline-plugin">
       <stageName/>
       <taskName/>
       <descriptionTemplate/>

tests/wrappers/fixtures/delivery-pipeline-full.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <project>
   <buildWrappers>
-    <se.diabol.jenkins.pipeline.PipelineVersionContributor>
+    <se.diabol.jenkins.pipeline.PipelineVersionContributor plugin="delivery-pipeline-plugin">
       <versionTemplate>1.0.0-${BUILD_NUMBER}</versionTemplate>
       <updateDisplayName>true</updateDisplayName>
     </se.diabol.jenkins.pipeline.PipelineVersionContributor>

tests/wrappers/fixtures/delivery-pipeline-minimal.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <project>
   <buildWrappers>
-    <se.diabol.jenkins.pipeline.PipelineVersionContributor>
+    <se.diabol.jenkins.pipeline.PipelineVersionContributor plugin="delivery-pipeline-plugin">
       <versionTemplate/>
       <updateDisplayName>false</updateDisplayName>
     </se.diabol.jenkins.pipeline.PipelineVersionContributor>