updated with working beans and better docs

Author: claymccoy

README.md

@@ -1,11 +1,26 @@
-This plugin exercises the Spring capabilities of Spinnaker plugins. There are no PF4J extension points. Instead everything is Spring components.
-It tests the following cases:
-* plugin components are wired together
-* app components are wired into plugin
-* plugin components are wired into app
-* configuration and properties are recognized
+This plugin exercises the Spring capabilities of Spinnaker plugins. There are no PF4J extension points or dependencies. Instead everything is Spring components.
 
-Just build with `./gradlew build` and copy that zip under `/build` into the plugins location of your service (by default the `/plugins` directory under your service root.
+It tests the following cases and all of it works without having to use Kork plugin's "unsafe" mode:
+* new plugin beans are wired together
+* app beans are autowired into plugin beans
+* plugin beans are autowired into the app beans and replace app beans if primary (this allows modifying existing spinnaker behavior)
+* properties are recognized
+* controllers add new endpoints
+* new dependencies that are not in Spinnaker can be used in your plugin beans
+
+Some things that don't work:
+* the Configuration annotation won't be recognized in a plugin bean so you can't create beans that way
+* class path scanning your plugin
+* the Conditional annotation won't be recognized in a plugin bean
+* Comnponent and Primary annotations aren't recognized, but that functionality still exists
+
+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.
+
+A new release for Kork and updating that dependency is required. This had been tested against a branch of Kork locally withg the required changes.
+
+Build with `./gradlew build` and copy that zip under `/build` into the plugins location of your service (by default the `/plugins` directory under your service root.
 
 The following should be added to your service yml config.
 ```
@@ -16,7 +31,6 @@ spinnaker:
         enabled: true
 
 newproperties:
-  enabled: true
   test: 'test1'
 ```
 

build.gradle

@@ -16,17 +16,24 @@ repositories {
   mavenLocal()
   mavenCentral()
   jcenter()
+  maven{
+    url "https://jitpack.io"
+  }
 }
 
 dependencies {
   compile "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlin_version"
-  compile group: 'org.springframework', name: 'spring-context', version: '5.2.1.RELEASE'
+  compileOnly (group: 'org.springframework', name: 'spring-context', version: '5.2.1.RELEASE')
   compileOnly (group: 'com.netflix.spinnaker.kork', name: 'kork-plugins-api', version: '7.3.0')
   compileOnly (group: 'com.netflix.spinnaker.kork', name: 'kork-plugins-spring-api', version: '7.3.0')
   compileOnly (group: 'org.springframework', name: 'spring-web', version: '5.2.2.RELEASE')
   compileOnly (group: 'com.netflix.spinnaker.orca', name: 'orca-core', version: '7.70.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"

gradle.properties

@@ -5,4 +5,4 @@ pf4jVersion=3.2.0
 pluginId=Armory.SpringExamplePlugin
 pluginClass=com.armory.plugin.example.spring.SpringExamplePlugin
 pluginProvider=Clay McCoy
-pluginUnsafe=true
+pluginUnsafe=false

src/main/kotlin/com/armory/plugin/example/spring/NewConfiguration.kt

@@ -1,9 +1,12 @@
 package com.armory.plugin.example.spring
 
+import io.pivotal.canal.model.Pipelines
 import org.springframework.web.bind.annotation.GetMapping
+import org.springframework.web.bind.annotation.RequestMapping
 import org.springframework.web.bind.annotation.RestController
 
-@RestController("/new/service")
+@RestController()
+@RequestMapping("/new/service")
 class NewController(private val newService: NewService) {
 
     @GetMapping("/expressionFunctionNames")
@@ -16,13 +19,14 @@ class NewController(private val newService: NewService) {
         return newService.test()
     }
 
-    @GetMapping("/config")
-    fun config(): NewConfiguration {
-        return newService.config()
+    @GetMapping("/properties")
+    fun properties(): NewProperties {
+        return newService.properties()
     }
 
-    @GetMapping("/configBean")
-    fun configBean(): NewConfigurationBean {
-        return newService.configBean()
+    @GetMapping("/pipelines")
+    fun pipelines(): Pipelines {
+        return newService.pipelines()
     }
+
 }

src/main/kotlin/com/armory/plugin/example/spring/NewController.kt

@@ -5,4 +5,4 @@ import org.springframework.boot.context.properties.ConfigurationProperties
 @ConfigurationProperties("newproperties")
 data class NewProperties(
         var test: String? = null
-)
+)

src/main/kotlin/com/armory/plugin/example/spring/NewProperties.kt

@@ -1,35 +1,39 @@
 package com.armory.plugin.example.spring
 
 import com.netflix.spinnaker.orca.capabilities.CapabilitiesService
-import org.springframework.beans.factory.annotation.Autowired
-import org.springframework.stereotype.Component
 
-@Component
-class NewService {
+import io.pivotal.canal.extensions.nestedstages.stages
+import io.pivotal.canal.extensions.pipelines
+import io.pivotal.canal.model.Pipelines
+import io.pivotal.canal.model.Wait
 
-    @Autowired
-    internal var capabilitiesService: CapabilitiesService? = null
-
-    @Autowired
-    internal var newConfiguration: NewConfiguration? = null
-
-    @Autowired
-    internal var newConfigurationBean: NewConfigurationBean? = null
+class NewService(val capabilitiesService: CapabilitiesService,
+                 val newProperties: NewProperties
+) {
 
     fun expressionFunctionNames(): Collection<String> {
-        return capabilitiesService!!.getExpressionCapabilities().functions.map{it.name}
+        return capabilitiesService.getExpressionCapabilities().functions.map{it.name}
     }
 
     fun test(): Collection<String> {
         return listOf("new service", "works")
     }
 
-    fun config(): NewConfiguration {
-        return newConfiguration!!
+    fun properties(): NewProperties {
+        return newProperties
     }
 
-    fun configBean(): NewConfigurationBean {
-        return newConfigurationBean!!
+    // uses 3rd party library that is not in Spinnaker
+    fun pipelines(): Pipelines {
+        return pipelines {
+            app("app1") {
+                pipeline("just waiting") {
+                    stages = stages {
+                        stage(Wait(420))
+                    }
+                }
+            }
+        }
     }
 
-}
+}

src/main/kotlin/com/armory/plugin/example/spring/NewService.kt

@@ -4,12 +4,11 @@ import com.netflix.spinnaker.kork.expressions.ExpressionFunctionProvider
 import com.netflix.spinnaker.orca.capabilities.CapabilitiesService
 import com.netflix.spinnaker.orca.capabilities.models.ExpressionCapabilityResult
 import org.pf4j.PluginManager
-import org.springframework.context.annotation.Primary
-import org.springframework.stereotype.Component
 
-@Component
-@Primary
-class OverrideService(expressionFunctionProviders: MutableList<ExpressionFunctionProvider>?, pluginManager: PluginManager?) : CapabilitiesService(expressionFunctionProviders, pluginManager) {
+class OverrideService(
+        expressionFunctionProviders: MutableList<ExpressionFunctionProvider>?,
+        pluginManager: PluginManager?) : CapabilitiesService(expressionFunctionProviders,
+        pluginManager) {
 
     override fun getExpressionCapabilities() : ExpressionCapabilityResult {
         val result = ExpressionCapabilityResult()

src/main/kotlin/com/armory/plugin/example/spring/OverrideService.kt

@@ -1,25 +1,21 @@
 package com.armory.plugin.example.spring
 
-import com.netflix.spinnaker.kork.plugins.api.spring.SpringPlugin
+import com.netflix.spinnaker.kork.plugins.api.spring.PrivilegedSpringPlugin
 import org.slf4j.LoggerFactory
 import org.pf4j.PluginWrapper
-
-
-class SpringExamplePlugin(wrapper: PluginWrapper) : SpringPlugin(wrapper) {
-    override fun initApplicationContext() {
-        applicationContext.applicationName
-        logger.info("***** App name ${applicationContext.applicationName}")
-        logger.info(applicationContext.environment.toString())
-        logger.info(applicationContext.beanDefinitionNames.joinToString())
-
-        applicationContext.register(NewConfiguration::class.java)
-        applicationContext.register(NewConfigurationBean::class.java)
-        applicationContext.register(NewProperties::class.java)
-        applicationContext.register(NewService::class.java)
-        applicationContext.register(NewController::class.java)
-        applicationContext.register(OverrideService::class.java)
-
-        logger.info(applicationContext.beanDefinitionNames.joinToString())
+import org.springframework.beans.factory.support.BeanDefinitionRegistry
+
+class SpringExamplePlugin(wrapper: PluginWrapper) : PrivilegedSpringPlugin(wrapper) {
+
+    override fun registerBeanDefinitions(registry: BeanDefinitionRegistry) {
+        listOf(
+                beanDefinitionFor(NewService::class.java),
+                beanDefinitionFor(NewProperties::class.java),
+                beanDefinitionFor(NewController::class.java),
+                primaryBeanDefinitionFor(OverrideService::class.java)
+        ).forEach {
+            registerBean(it, registry)
+        }
     }
 
     private val logger = LoggerFactory.getLogger(SpringExamplePlugin::class.java)