Merge "publishers: groovy-postbuild changes between 1.x & 2.x"

2015-05-01 18:52:45 +00:00 · 2015-05-01 18:52:45 +00:00 · e4f77fe06c
commit e4f77fe06c
parent 919e907df7 ccfe2daf8a
14 changed files with 182 additions and 6 deletions
--- a/jenkins_jobs/modules/publishers.py
+++ b/jenkins_jobs/modules/publishers.py
@ -35,6 +35,7 @@ from jenkins_jobs.errors import JenkinsJobsException
 import logging
 import pkg_resources
 import sys
+import six
 import random


@ -1804,7 +1805,21 @@ def groovy_postbuild(parser, xml_parent, data):
    Requires the Jenkins :jenkins-wiki:`Groovy Postbuild Plugin
    <Groovy+Postbuild+Plugin>`.

-    :Parameter: the groovy script to execute
+    Please pay attention on version of plugin you have installed.
+    There were incompatible changes between 1.x and 2.x. Please see
+    :jenkins-wiki:`home page <Groovy+Postbuild+Plugin>` of this plugin
+    for full information including migration process.
+
+    :arg str script: The groovy script to execute
+    :arg list classpath: List of additional classpaths (>=1.6)
+    :arg str on-failure: In case of script failure leave build as it is
+                         for "nothing" option, mark build as unstable
+                         for "unstable" and mark job as failure for "failed"
+                         (default is "nothing")
+    :arg bool matrix-parent: Run script for matrix parent only (>=1.9)
+                             (default false)
+    :arg bool sandbox: Execute script inside of groovy sandbox (>=2.0)
+                       (default false)

    Example:

@ -1812,10 +1827,65 @@ def groovy_postbuild(parser, xml_parent, data):
        /../../tests/publishers/fixtures/groovy-postbuild001.yaml
       :language: yaml
    """
-    root_tag = 'org.jvnet.hudson.plugins.groovypostbuild.'\
-        'GroovyPostbuildRecorder'
+    logger = logging.getLogger("%s:groovy-postbuild" % __name__)
+    # Backward compatibility with old format
+    if isinstance(data, six.string_types):
+        logger.warn(
+            "You use depricated configuration, please follow documentation "
+            "to change configuration. It is not going to be supported in "
+            "future releases!"
+        )
+        data = {
+            'script': data,
+        }
+    # There are incompatible changes, we need to know version
+    info = parser.registry.get_plugin_info('groovy-postbuild')
+    version = pkg_resources.parse_version(info.get('version', "0"))
+    # Version specific predicates
+    matrix_parent_support = version >= pkg_resources.parse_version("1.9")
+    security_plugin_support = version >= pkg_resources.parse_version("2.0")
+    extra_classpath_support = version >= pkg_resources.parse_version("1.6")
+
+    root_tag = (
+        'org.jvnet.hudson.plugins.groovypostbuild.GroovyPostbuildRecorder'
+    )
    groovy = XML.SubElement(xml_parent, root_tag)
-    XML.SubElement(groovy, 'groovyScript').text = data
+
+    behavior = data.get('on-failure')
+    XML.SubElement(groovy, 'behavior').text = {
+        'unstable': '1',
+        'failed': '2',
+    }.get(behavior, '0')
+
+    if matrix_parent_support:
+        XML.SubElement(
+            groovy,
+            'runForMatrixParent',
+        ).text = str(data.get('matrix-parent', False)).lower()
+
+    classpaths = data.get('classpath', list())
+    if security_plugin_support:
+        script = XML.SubElement(groovy, 'script')
+        XML.SubElement(script, 'script').text = data.get('script')
+        XML.SubElement(script, 'sandbox').text = str(
+            data.get('sandbox', False)
+        ).lower()
+        if classpaths:
+            classpath = XML.SubElement(script, 'classpath')
+            for path in classpaths:
+                script_path = XML.SubElement(classpath, 'entry')
+                XML.SubElement(script_path, 'url').text = path
+    else:
+        XML.SubElement(groovy, 'groovyScript').text = data.get('script')
+        if extra_classpath_support and classpaths:
+            classpath = XML.SubElement(groovy, 'classpath')
+            for path in classpaths:
+                script_path = XML.SubElement(
+                    classpath,
+                    'org.jvnet.hudson.plugins.groovypostbuild.'
+                    'GroovyScriptPath',
+                )
+                XML.SubElement(script_path, 'path').text = path


 def base_publish_over(xml_parent, data, console_prefix,
--- a/tests/publishers/fixtures/groovy-postbuild000.xml
+++ b/tests/publishers/fixtures/groovy-postbuild000.xml
@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8"?>
+<project>
+  <publishers>
+    <org.jvnet.hudson.plugins.groovypostbuild.GroovyPostbuildRecorder>
+      <behavior>1</behavior>
+      <groovyScript>manager.buildFailure()</groovyScript>
+    </org.jvnet.hudson.plugins.groovypostbuild.GroovyPostbuildRecorder>
+  </publishers>
+</project>
--- a/tests/publishers/fixtures/groovy-postbuild000.yaml
+++ b/tests/publishers/fixtures/groovy-postbuild000.yaml
@ -0,0 +1,8 @@
+publishers:
+    - groovy-postbuild:
+        script: "manager.buildFailure()"
+        classpath:
+            - "file:///path/to/your/lib"
+            - "file:///path/to/your/lib"
+        on-failure: "unstable"
+        matrix-parent: true
--- a/tests/publishers/fixtures/groovy-postbuild001.plugins_info.yaml
+++ b/tests/publishers/fixtures/groovy-postbuild001.plugins_info.yaml
@ -0,0 +1,3 @@
+- longName: 'Groovy Postbuild'
+  shortName: 'groovy-postbuild'
+  version: "2.0"
--- a/tests/publishers/fixtures/groovy-postbuild001.xml
+++ b/tests/publishers/fixtures/groovy-postbuild001.xml
@ -2,7 +2,20 @@
 <project>
  <publishers>
    <org.jvnet.hudson.plugins.groovypostbuild.GroovyPostbuildRecorder>
-      <groovyScript>manager.buildFailure()</groovyScript>
+      <behavior>2</behavior>
+      <runForMatrixParent>true</runForMatrixParent>
+      <script>
+        <script>manager.buildFailure()</script>
+        <sandbox>false</sandbox>
+        <classpath>
+          <entry>
+            <url>file:///path/to/your/lib</url>
+          </entry>
+          <entry>
+            <url>file:///path/to/your/lib</url>
+          </entry>
+        </classpath>
+      </script>
    </org.jvnet.hudson.plugins.groovypostbuild.GroovyPostbuildRecorder>
  </publishers>
 </project>
--- a/tests/publishers/fixtures/groovy-postbuild001.yaml
+++ b/tests/publishers/fixtures/groovy-postbuild001.yaml
@ -1,2 +1,8 @@
 publishers:
-  - groovy-postbuild: "manager.buildFailure()"
+    - groovy-postbuild:
+        script: "manager.buildFailure()"
+        classpath:
+            - "file:///path/to/your/lib"
+            - "file:///path/to/your/lib"
+        on-failure: "failed"
+        matrix-parent: true
--- a/tests/publishers/fixtures/groovy-postbuild002.plugins_info.yaml
+++ b/tests/publishers/fixtures/groovy-postbuild002.plugins_info.yaml
@ -0,0 +1,3 @@
+- longName: 'Groovy Postbuild'
+  shortName: 'groovy-postbuild'
+  version: "1.6"
--- a/tests/publishers/fixtures/groovy-postbuild002.xml
+++ b/tests/publishers/fixtures/groovy-postbuild002.xml
@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="utf-8"?>
+<project>
+  <publishers>
+    <org.jvnet.hudson.plugins.groovypostbuild.GroovyPostbuildRecorder>
+      <behavior>0</behavior>
+      <groovyScript>manager.buildFailure()</groovyScript>
+      <classpath>
+        <org.jvnet.hudson.plugins.groovypostbuild.GroovyScriptPath>
+          <path>file:///path/to/your/lib</path>
+        </org.jvnet.hudson.plugins.groovypostbuild.GroovyScriptPath>
+        <org.jvnet.hudson.plugins.groovypostbuild.GroovyScriptPath>
+          <path>file:///path/to/your/lib</path>
+        </org.jvnet.hudson.plugins.groovypostbuild.GroovyScriptPath>
+      </classpath>
+    </org.jvnet.hudson.plugins.groovypostbuild.GroovyPostbuildRecorder>
+  </publishers>
+</project>
--- a/tests/publishers/fixtures/groovy-postbuild002.yaml
+++ b/tests/publishers/fixtures/groovy-postbuild002.yaml
@ -0,0 +1,8 @@
+publishers:
+    - groovy-postbuild:
+        script: "manager.buildFailure()"
+        classpath:
+            - "file:///path/to/your/lib"
+            - "file:///path/to/your/lib"
+        on-failure: "wrong_option"
+        matrix-parent: true
--- a/tests/publishers/fixtures/groovy-postbuild003.plugins_info.yaml
+++ b/tests/publishers/fixtures/groovy-postbuild003.plugins_info.yaml
@ -0,0 +1,3 @@
+- longName: 'Groovy Postbuild'
+  shortName: 'groovy-postbuild'
+  version: "1.9"
--- a/tests/publishers/fixtures/groovy-postbuild003.xml
+++ b/tests/publishers/fixtures/groovy-postbuild003.xml
@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="utf-8"?>
+<project>
+  <publishers>
+    <org.jvnet.hudson.plugins.groovypostbuild.GroovyPostbuildRecorder>
+      <behavior>0</behavior>
+      <runForMatrixParent>false</runForMatrixParent>
+      <groovyScript>manager.buildFailure()</groovyScript>
+      <classpath>
+        <org.jvnet.hudson.plugins.groovypostbuild.GroovyScriptPath>
+          <path>file:///path/to/your/lib</path>
+        </org.jvnet.hudson.plugins.groovypostbuild.GroovyScriptPath>
+        <org.jvnet.hudson.plugins.groovypostbuild.GroovyScriptPath>
+          <path>file:///path/to/your/lib</path>
+        </org.jvnet.hudson.plugins.groovypostbuild.GroovyScriptPath>
+      </classpath>
+    </org.jvnet.hudson.plugins.groovypostbuild.GroovyPostbuildRecorder>
+  </publishers>
+</project>
--- a/tests/publishers/fixtures/groovy-postbuild003.yaml
+++ b/tests/publishers/fixtures/groovy-postbuild003.yaml
@ -0,0 +1,7 @@
+publishers:
+    - groovy-postbuild:
+        script: "manager.buildFailure()"
+        classpath:
+            - "file:///path/to/your/lib"
+            - "file:///path/to/your/lib"
+        matrix-parent: false
--- a/tests/publishers/fixtures/groovy-postbuild004.xml
+++ b/tests/publishers/fixtures/groovy-postbuild004.xml
@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8"?>
+<project>
+  <publishers>
+    <org.jvnet.hudson.plugins.groovypostbuild.GroovyPostbuildRecorder>
+      <behavior>0</behavior>
+      <groovyScript>manager.buildFailure()</groovyScript>
+    </org.jvnet.hudson.plugins.groovypostbuild.GroovyPostbuildRecorder>
+  </publishers>
+</project>
--- a/tests/publishers/fixtures/groovy-postbuild004.yaml
+++ b/tests/publishers/fixtures/groovy-postbuild004.yaml
@ -0,0 +1,2 @@
+publishers:
+    - groovy-postbuild: "manager.buildFailure()"