added support for Support-Dynamic-Loading manifest attribute

CHANGELOG.md

@@ -2,6 +2,7 @@
 
   * updated Gradle to version 1.12
   * added support for `Plugin-Developers` manifest attribute
+  * added support for `Support-Dynamic-Loading` manifest attribute
   * replaced usages of deprecated `groovy` configuration by `compile` configuration
   * added `org.jenkins-ci.jpi` as alternative qualified plugin id for Gradle plugin portal inclusion
   * `jpiDeployUser` and `jpiDeployPassword` properties from `org.jenkinsci.gradle.plugins.jpi.JpiExtension` were not

build.gradle

@@ -19,6 +19,7 @@ dependencies {
     compile gradleApi()
     compile 'org.jvnet.localizer:maven-localizer-plugin:1.13'
     compile 'org.jenkins-ci:version-number:1.0'
+    compile 'net.java.sezpoz:sezpoz:1.9'
     compile localGroovy()
     testCompile('org.spockframework:spock-core:0.7-groovy-1.8') {
         exclude module: 'groovy-all' // use the version that is distributed with Gradle

src/main/groovy/org/jenkinsci/gradle/plugins/jpi/JpiManifest.groovy

@@ -15,6 +15,10 @@
  */
 package org.jenkinsci.gradle.plugins.jpi
 
+import hudson.Extension
+import jenkins.YesNoMaybe
+import net.java.sezpoz.Index
+
 import java.text.SimpleDateFormat
 import org.gradle.api.Project
 import org.gradle.api.plugins.JavaPluginConvention
@@ -85,12 +89,11 @@ class JpiManifest extends HashMap<String, Object> {
             }.join(',')
         }
 
-        // more TODO
-/*
-        Boolean b = isSupportDynamicLoading()
-        if (b!=null)
-            mainSection.addAttributeAndCheck(new Attribute("Support-Dynamic-Loading",b.toString()))
-*/
+        YesNoMaybe supportDynamicLoading = isSupportDynamicLoading(classDir)
+        if (supportDynamicLoading != YesNoMaybe.MAYBE) {
+            this['Support-Dynamic-Loading'] = supportDynamicLoading == YesNoMaybe.YES
+        }
+
         // remove empty values
         this.entrySet().removeAll { it.value == null || it.value.toString().empty }
     }
@@ -118,6 +121,21 @@ class JpiManifest extends HashMap<String, Object> {
         }
     }
 
+    private static YesNoMaybe isSupportDynamicLoading(File classDir) throws IOException {
+        ClassLoader classLoader = new URLClassLoader(
+                [classDir.toURI().toURL()] as URL[],
+                JpiManifest.classLoader as ClassLoader
+        )
+        def enums = Index.load(Extension, Object, classLoader).collect { it.annotation().dynamicLoadable() }
+        if (enums.contains(YesNoMaybe.NO)) {
+            return YesNoMaybe.NO
+        }
+        if (enums.contains(YesNoMaybe.MAYBE)) {
+            return YesNoMaybe.MAYBE
+        }
+        YesNoMaybe.YES
+    }
+
     void writeTo(File f) {
         def m = new Manifest()
         m.mainAttributes.putValue('Manifest-Version', '1.0')

src/main/java/hudson/Extension.java

@@ -0,0 +1,37 @@
+/*
+ * The MIT License
+ *
+ * Copyright (c) 2011, CloudBees, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package hudson;
+
+import jenkins.YesNoMaybe;
+
+import static jenkins.YesNoMaybe.MAYBE;
+
+/**
+ * Minimal clone for auto-detection.
+ *
+ * @author Kohsuke Kawaguchi
+ */
+public @interface Extension {
+    YesNoMaybe dynamicLoadable() default MAYBE;
+}

src/main/java/jenkins/YesNoMaybe.java

@@ -0,0 +1,35 @@
+/*
+ * The MIT License
+ *
+ * Copyright (c) 2011, CloudBees, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package jenkins;
+
+/**
+ * Clone for auto-detection.
+ *
+ * @author Kohsuke Kawaguchi
+ */
+public enum YesNoMaybe {
+    YES,
+    NO,
+    MAYBE
+}

src/test/groovy/org/jenkinsci/gradle/plugins/jpi/JpiManifestSpec.groovy

@@ -5,6 +5,7 @@ import org.gradle.testfixtures.ProjectBuilder
 import org.junit.Rule
 import org.junit.rules.TemporaryFolder
 import spock.lang.Specification
+import spock.lang.Unroll
 
 class JpiManifestSpec extends Specification {
     Project project = ProjectBuilder.builder().build()
@@ -303,6 +304,33 @@ class JpiManifestSpec extends Specification {
         file.text == readManifest('plugin-developers.mf')
     }
 
+    @Unroll
+    def 'support dynamic loading #value'(String value) {
+        setup:
+        project.with {
+            apply plugin: 'jpi'
+            group = 'org.example'
+            version = '1.2'
+            jenkinsPlugin {
+                coreVersion = '1.509.3'
+            }
+        }
+        byte[] index = JpiManifestSpec.getResourceAsStream("support-dynamic-loading/${value}/hudson.Extension").bytes
+        File directory = new File(project.tasks.compileJava.destinationDir as File, 'META-INF/annotations')
+        directory.mkdirs()
+        new File(directory, 'hudson.Extension').bytes = index
+
+        when:
+        File file = temporaryFolder.newFile()
+        new JpiManifest(project).writeTo(file)
+
+        then:
+        file.text == readManifest("support-dynamic-loading-${value}.mf")
+
+        where:
+        value << ['yes', 'maybe', 'no']
+    }
+
     private static String readManifest(String fileName) {
         JpiManifestSpec.getResourceAsStream(fileName).text.replace(System.getProperty('line.separator'), '\r\n')
     }

src/test/resources/org/jenkinsci/gradle/plugins/jpi/basics.mf

@@ -2,6 +2,7 @@ Manifest-Version: 1.0
 Jenkins-Version: 1.509.3
 Group-Id: org.example
 v: 1.2
+Support-Dynamic-Loading: true
 Short-Name: test
 Plugin-Version: 1.2
 Long-Name: test

src/test/resources/org/jenkinsci/gradle/plugins/jpi/compatible-since-version.mf

@@ -2,6 +2,7 @@ Manifest-Version: 1.0
 Jenkins-Version: 1.509.3
 Group-Id: org.example
 v: 1.2
+Support-Dynamic-Loading: true
 Short-Name: test
 Compatible-Since-Version: 1.1
 Plugin-Version: 1.2

src/test/resources/org/jenkinsci/gradle/plugins/jpi/complex-dependencies.mf

@@ -4,6 +4,7 @@ Group-Id: org.example
 Plugin-Dependencies: git:1.1.15,ant:1.2,cloudbees-folder:4.2;resolutio
  n:=optional,credentials:1.9.4;resolution:=optional
 v: 1.0
+Support-Dynamic-Loading: true
 Short-Name: test
 Plugin-Version: 1.0
 Long-Name: test

src/test/resources/org/jenkinsci/gradle/plugins/jpi/dependencies.mf

@@ -3,6 +3,7 @@ Jenkins-Version: 1.509.3
 Group-Id: org.example
 Plugin-Dependencies: git:1.1.15,ant:1.2
 v: 1.0
+Support-Dynamic-Loading: true
 Short-Name: test
 Plugin-Version: 1.0
 Long-Name: test

src/test/resources/org/jenkinsci/gradle/plugins/jpi/dependency.mf

@@ -3,6 +3,7 @@ Jenkins-Version: 1.509.3
 Group-Id: org.example
 Plugin-Dependencies: ant:1.2
 v: 1.0
+Support-Dynamic-Loading: true
 Short-Name: test
 Plugin-Version: 1.0
 Long-Name: test

src/test/resources/org/jenkinsci/gradle/plugins/jpi/mask-classes.mf

@@ -2,6 +2,7 @@ Manifest-Version: 1.0
 Jenkins-Version: 1.509.3
 Group-Id: org.example
 v: 1.2
+Support-Dynamic-Loading: true
 Short-Name: test
 Plugin-Version: 1.2
 Mask-Classes: org.example.test

src/test/resources/org/jenkinsci/gradle/plugins/jpi/optional-dependencies.mf

@@ -4,6 +4,7 @@ Group-Id: org.example
 Plugin-Dependencies: git:1.1.15;resolution:=optional,ant:1.2;resolutio
  n:=optional
 v: 1.0
+Support-Dynamic-Loading: true
 Short-Name: test
 Plugin-Version: 1.0
 Long-Name: test

src/test/resources/org/jenkinsci/gradle/plugins/jpi/optional-dependency.mf

@@ -3,6 +3,7 @@ Jenkins-Version: 1.509.3
 Group-Id: org.example
 Plugin-Dependencies: ant:1.2;resolution:=optional
 v: 1.0
+Support-Dynamic-Loading: true
 Short-Name: test
 Plugin-Version: 1.0
 Long-Name: test

src/test/resources/org/jenkinsci/gradle/plugins/jpi/plugin-class.mf

@@ -3,6 +3,7 @@ Jenkins-Version: 1.509.3
 Group-Id: org.example
 v: 1.2
 Plugin-Class: org.example.PluginImpl
+Support-Dynamic-Loading: true
 Short-Name: test
 Plugin-Version: 1.2
 Long-Name: test

src/test/resources/org/jenkinsci/gradle/plugins/jpi/plugin-developer.mf

@@ -3,6 +3,7 @@ Jenkins-Version: 1.509.3
 Group-Id: org.example
 v: 1.2
 Plugin-Developers: Andrew Bayer:abayer:andrew.bayer@gmail.com
+Support-Dynamic-Loading: true
 Short-Name: test
 Plugin-Version: 1.2
 Long-Name: test

src/test/resources/org/jenkinsci/gradle/plugins/jpi/plugin-developers.mf

@@ -4,6 +4,7 @@ Group-Id: org.example
 v: 1.2
 Plugin-Developers: :abayer:andrew.bayer@gmail.com,Kohsuke Kawaguchi:ko
  hsuke:
+Support-Dynamic-Loading: true
 Short-Name: test
 Plugin-Version: 1.2
 Long-Name: test

src/test/resources/org/jenkinsci/gradle/plugins/jpi/plugin-first-class-loader.mf

@@ -2,6 +2,7 @@ Manifest-Version: 1.0
 Jenkins-Version: 1.509.3
 Group-Id: org.example
 v: 1.2
+Support-Dynamic-Loading: true
 Short-Name: test
 PluginFirstClassLoader: true
 Plugin-Version: 1.2

src/test/resources/org/jenkinsci/gradle/plugins/jpi/sandbox-status.mf

@@ -2,6 +2,7 @@ Manifest-Version: 1.0
 Jenkins-Version: 1.509.3
 Group-Id: org.example
 v: 1.2
+Support-Dynamic-Loading: true
 Short-Name: test
 Plugin-Version: 1.2
 Long-Name: test

src/test/resources/org/jenkinsci/gradle/plugins/jpi/support-dynamic-loading-maybe.mf

@@ -0,0 +1,8 @@
+Manifest-Version: 1.0
+Jenkins-Version: 1.509.3
+Group-Id: org.example
+v: 1.2
+Short-Name: test
+Plugin-Version: 1.2
+Long-Name: test
+

src/test/resources/org/jenkinsci/gradle/plugins/jpi/support-dynamic-loading-no.mf

@@ -0,0 +1,9 @@
+Manifest-Version: 1.0
+Jenkins-Version: 1.509.3
+Group-Id: org.example
+v: 1.2
+Support-Dynamic-Loading: false
+Short-Name: test
+Plugin-Version: 1.2
+Long-Name: test
+

src/test/resources/org/jenkinsci/gradle/plugins/jpi/support-dynamic-loading-yes.mf

@@ -0,0 +1,9 @@
+Manifest-Version: 1.0
+Jenkins-Version: 1.509.3
+Group-Id: org.example
+v: 1.2
+Support-Dynamic-Loading: true
+Short-Name: test
+Plugin-Version: 1.2
+Long-Name: test
+