use spinnaker plugin bundler

Author: claymccoy

README.md

@@ -16,13 +16,11 @@ Some things that don't work:
 
 Your plugin needs to extend PrivilegedSpringPlugin and implement registerBeanDefinitions(BeanDefinitionRegistry) to explicitly create and register BeanDefinitions. There are helper methods to make this easier and they default to singleton scope with constructor autowiring.  See SpringExamplePlugin for an example.
 
-We will probably need was way for registerBeanDefinitions(BeanDefinitionRegistry) to conditionally load beans based on the service that it is used in. I didn't see a good way to do that. It would be possible to cast BeanDefinitionRegistry to DefaultListableBeanFactory and look at the serializationId, but that relies on some implementation details.
-
 <h2>Usage</h2>
 
-1) Run `./gradlew assemblePlugin`
-2) Put the `/build/distributions/Armory.SpringExtensionPlugin-X.X.X.zip` in the [configured plugins location for Orca](https://pf4j.org/doc/packaging.html).
-3) Configure Orca. Put the following in orca.yml.
+1) Run `./gradlew releaseBundle`
+2) Put the `/build/distributions/<project>-X.zip` into the [configured plugins location for your service](https://pf4j.org/doc/packaging.html).
+3) Configure the Spinnaker service. Put the following in the service yml to enable the plugin and configure the extension.
 ```
 spinnaker:
   extensibility:
@@ -36,19 +34,11 @@ newproperties:
 
 Or use the [examplePluginRepository](https://github.com/spinnaker-plugin-examples/examplePluginRepository) to avoid copying the plugin `.zip` artifact.
 
-To debug the plugin inside Orca using IntelliJ Idea follow these steps:
+To debug the plugin inside a Spinnaker service (like Orca) using IntelliJ Idea follow these steps:
 
-1) Create a `springPluginExample.plugin-ref` file under `orca\plugins\` that looks like this with the correct path to the plugin project.
-```
-{
-  "pluginPath": "<plugin project path>",
-  "classesDirs": [
-    "<plugin project path>/build/classes/kotlin/main"],
-  "libsDirs": [
-    "<plugin project path>/build/jars"]
-}
-```
-2) Link the plugin project in IntelliJ (the `+` button in the Gradle tab and select the plugin build.gradle).
-3) Configure Orca the same way specified above.
-4) Create a new IntelliJ run configuration for Orca that has the VM option `-Dpf4j.mode=development` and does a `Build Project` before launch.
-5) Debug away...
+1) Run `./gradlew releaseBundle` in the plugin project.
+2) Copy the generated `.plugin-ref` file under `build` in the plugin project submodule for the service to the `plugins` directory under root in the Spinnaker service that will use the plugin .
+3) Link the plugin project to the service project in IntelliJ (from the service project use the `+` button in the Gradle tab and select the plugin build.gradle).
+4) Configure the Spinnaker service the same way specified above.
+5) Create a new IntelliJ run configuration for the service that has the VM option `-Dpf4j.mode=development` and does a `Build Project` before launch.
+6) Debug away...

build.gradle

@@ -1,88 +1,39 @@
 buildscript {
-  ext.kotlin_version = '1.3.61'
-
   repositories {
     mavenCentral()
+    maven { url "https://dl.bintray.com/spinnaker/gradle/" }
   }
   dependencies {
-    classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
+    classpath("com.netflix.spinnaker.gradle:spinnaker-extensions:$spinnakerGradleVersion")
   }
 }
 
-apply plugin: 'kotlin'
-apply plugin: 'kotlin-kapt'
-
-repositories {
-  mavenLocal()
-  mavenCentral()
-  jcenter()
-  maven{
-    url "https://jitpack.io"
-  }
+plugins {
+  id("com.palantir.git-version").version("0.12.2")
+  id("com.moowork.node").version("1.3.1").apply(false)
 }
+apply plugin: "io.spinnaker.plugin.bundler"
 
-dependencies {
-  compile "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlin_version"
-  compileOnly (group: 'org.springframework', name: 'spring-context', version: '5.2.1.RELEASE')
-  compileOnly (group: 'com.netflix.spinnaker.kork', name: 'kork-plugins-spring-api', version: '7.17.0')
-  compileOnly (group: 'org.springframework', name: 'spring-web', version: '5.2.2.RELEASE')
-  compileOnly (group: 'com.netflix.spinnaker.orca', name: 'orca-core', version: '7.83.0') {
-    exclude group: "org.slf4j"
-  }
-  compile("com.github.canal-pipelines:canal:v0.1.1") {
-    exclude group: "org.slf4j"
-    exclude group: "com.netflix.spinnaker.orca"
-  }
-  implementation group: 'org.slf4j', name: 'slf4j-api', version: '1.7.28'
-
-  testImplementation "org.junit.jupiter:junit-jupiter-api:5.3.2"
-  testImplementation group: 'io.strikt', name: 'strikt-core', version: '0.22.1'
-  testImplementation group: 'dev.minutest', name: 'minutest', version: '1.10.0'
-
-  testRuntime "org.junit.jupiter:junit-jupiter-engine:5.3.2"
-  testRuntime "org.junit.platform:junit-platform-launcher:1.3.2"
+spinnakerBundle {
+  pluginId = "Armory.SpringExamplePlugin"
+  description = "An example of a Spring based plugin that requires no extension points."
+  provider = "https://github.com/claymccoy"
+  version = rootProject.version
 }
 
-jar {
-  manifest {
-    attributes 'Plugin-Class': "${pluginClass}",
-          'Plugin-Id': "${pluginId}",
-          'Plugin-Version': "${version}",
-          'Plugin-Provider': "${pluginProvider}",
-          'Plugin-Unsafe': "${pluginUnsafe}"
-  }
-}
+version = normalizedVersion()
 
-tasks {
-  test {
-    useJUnitPlatform()
-    afterTest { descriptor, result ->
-      // work around a bug in Gradle versions before 6.1, see https://github.com/junit-team/junit5/issues/2041
-      println "\n$descriptor.className [$descriptor.classDisplayName] > $descriptor.name [$descriptor.displayName]: $result.resultType"
-    }
-  }
+subprojects {
+  group = "io.armory.plugin.example.spring"
+  version = rootProject.version
 }
 
-task assemblePlugin(type: Zip) {
-  baseName = "${pluginId}"
-  into('classes') {
-    with jar
+String normalizedVersion() {
+  String fullVersion = gitVersion()
+  String normalized = fullVersion.split("-").first()
+  if (fullVersion.contains("dirty")) {
+    return "$normalized-SNAPSHOT"
+  } else {
+    return normalized
   }
-  into('lib') {
-    from configurations.compile
-  }
-}
-assemble.dependsOn project.tasks.assemblePlugin
-
-task copyPluginJars(type: Copy) {
-  from configurations.compile
-  into rootProject.buildDir.path + '\\' +'jars'
-}
-
-task copyPluginIdxs(type: Copy) {
-  from rootProject.buildDir.path + '\\tmp\\kapt3\\classes'
-  into rootProject.buildDir.path + '\\classes\\kotlin'
 }
-
-build.dependsOn project.tasks.copyPluginJars
-build.dependsOn project.tasks.copyPluginIdxs

gradle.properties

@@ -1,8 +1,5 @@
-version=1.0.0
+org.gradle.parallel=true
 
+spinnakerGradleVersion=7.5.2
 pf4jVersion=3.2.0
-
-pluginId=Armory.SpringExamplePlugin
-pluginClass=io.armory.plugin.example.spring.SpringExamplePlugin
-pluginProvider=Clay McCoy
-pluginUnsafe=false
+korkVersion=7.17.0

settings.gradle

@@ -0,0 +1,22 @@
+pluginManagement {
+  repositories {
+    mavenLocal()
+    maven { url "https://dl.bintray.com/spinnaker/gradle/" }
+    gradlePluginPortal()
+  }
+}
+
+rootProject.name="springExamplePlugin"
+
+include "spring-example-orca"
+
+def setBuildFile(project) {
+  project.buildFileName = "${project.name}.gradle"
+  project.children.each {
+    setBuildFile(it)
+  }
+}
+
+rootProject.children.each {
+  setBuildFile(it)
+}

spring-example-orca/spring-example-orca.gradle

@@ -0,0 +1,57 @@
+buildscript {
+  ext.kotlin_version = '1.3.50'
+
+  repositories {
+    mavenCentral()
+  }
+  dependencies {
+    classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
+  }
+}
+apply plugin: "io.spinnaker.plugin.service-extension"
+apply plugin: "maven-publish"
+apply plugin: 'kotlin'
+apply plugin: 'kotlin-kapt'
+
+sourceCompatibility = 1.8
+targetCompatibility = 1.8
+
+repositories {
+  mavenCentral()
+  jcenter()
+  maven { url "http://dl.bintray.com/spinnaker/spinnaker/" }
+  maven{
+    url "https://jitpack.io"
+  }
+}
+
+spinnakerPlugin {
+  serviceName = "orca"
+  pluginClass = "io.armory.plugin.example.spring.SpringExamplePlugin"
+}
+
+dependencies {
+  compile "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlin_version"
+  compileOnly (group: 'org.springframework', name: 'spring-context', version: '5.2.1.RELEASE')
+  compileOnly (group: 'com.netflix.spinnaker.kork', name: 'kork-plugins-spring-api', version: '7.17.0')
+  compileOnly (group: 'org.springframework', name: 'spring-web', version: '5.2.2.RELEASE')
+  compileOnly (group: 'com.netflix.spinnaker.orca', name: 'orca-core', version: '7.83.0') {
+    exclude group: "org.slf4j"
+  }
+  implementation("com.github.canal-pipelines:canal:v0.1.1") {
+    exclude group: "org.slf4j"
+    exclude group: "com.netflix.spinnaker.orca"
+  }
+  implementation group: 'org.slf4j', name: 'slf4j-api', version: '1.7.28'
+
+  testImplementation "org.junit.jupiter:junit-jupiter-api:5.3.2"
+  testImplementation group: 'io.strikt', name: 'strikt-core', version: '0.22.1'
+  testImplementation group: 'dev.minutest', name: 'minutest', version: '1.10.0'
+
+  testRuntime "org.junit.jupiter:junit-jupiter-engine:5.3.2"
+  testRuntime "org.junit.platform:junit-platform-launcher:1.3.2"
+}
+
+tasks.withType(Test) {
+  useJUnitPlatform()
+}