feat(plugins): Add echo-plugins-test module (#848)

* feat(plugins): Add echo-plugins-test module

* fix(build): Add kotlinVersion and add nebula.kotlin plugin

.gitignore

@@ -16,4 +16,4 @@ data
 .project
 .settings/
 bin/
-plugins/
+/plugins/

build.gradle

@@ -16,6 +16,7 @@
 
 plugins {
   id 'io.spinnaker.project' version "$spinnakerGradleVersion" apply false
+  id "nebula.kotlin" version "$kotlinVersion" apply false
 }
 
 subprojects {

echo-plugins-test/echo-plugins-test.gradle

@@ -0,0 +1,21 @@
+apply from: "${project.rootDir}/gradle/kotlin.gradle"
+
+dependencies {
+  implementation(project(":echo-api"))
+  implementation("com.netflix.spinnaker.kork:kork-exceptions")
+
+  testImplementation(project(":echo-web"))
+  testImplementation(project(":echo-core"))
+
+  testImplementation("com.netflix.spinnaker.kork:kork-plugins")
+  testImplementation("com.netflix.spinnaker.kork:kork-plugins-tck")
+
+  testRuntimeOnly("org.junit.platform:junit-platform-launcher")
+  testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine")
+}
+
+test {
+  useJUnitPlatform {
+    includeEngines("junit-jupiter", "junit-vintage")
+  }
+}

echo-plugins-test/src/main/kotlin/com/netflix/spinnaker/echo/plugins/EchoPlugin.kt

@@ -0,0 +1,22 @@
+/*
+ * Copyright 2020 Netflix, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.netflix.spinnaker.echo.plugins
+
+import org.pf4j.Plugin
+import org.pf4j.PluginWrapper
+
+class EchoPlugin(pluginWrapper: PluginWrapper) : Plugin(pluginWrapper)

echo-plugins-test/src/main/kotlin/com/netflix/spinnaker/echo/plugins/EventListenerExtension.kt

@@ -0,0 +1,26 @@
+/*
+ * Copyright 2020 Netflix, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.netflix.spinnaker.echo.plugins
+
+import com.netflix.spinnaker.echo.api.events.Event
+import com.netflix.spinnaker.echo.api.events.EventListener
+import org.pf4j.Extension
+
+@Extension
+class EventListenerExtension : EventListener {
+  override fun processEvent(event: Event) {}
+}

echo-plugins-test/src/test/kotlin/com/netflix/spinnaker/echo/plugins/test/EchoPluginsFixture.kt

@@ -0,0 +1,77 @@
+/*
+ * Copyright 2020 Netflix, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.netflix.spinnaker.echo.plugins.test
+
+import com.netflix.spinnaker.echo.Application
+import com.netflix.spinnaker.echo.plugins.EchoPlugin
+import com.netflix.spinnaker.echo.plugins.EventListenerExtension
+import com.netflix.spinnaker.kork.plugins.SpinnakerPluginManager
+import com.netflix.spinnaker.kork.plugins.internal.PluginJar
+import com.netflix.spinnaker.kork.plugins.tck.PluginsTckFixture
+import java.io.File
+import org.springframework.beans.factory.annotation.Autowired
+import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc
+import org.springframework.boot.test.context.SpringBootTest
+import org.springframework.boot.test.context.TestConfiguration
+import org.springframework.context.ApplicationContext
+import org.springframework.test.context.ContextConfiguration
+import org.springframework.test.context.TestPropertySource
+
+class EchoPluginsFixture : PluginsTckFixture, EchoTestService() {
+
+  final override val plugins = File("build/plugins")
+
+  final override val enabledPlugin: PluginJar
+  final override val disabledPlugin: PluginJar
+  final override val versionNotSupportedPlugin: PluginJar
+
+  override val extensionClassNames: MutableList<String> = mutableListOf(
+    EventListenerExtension::class.java.name
+  )
+
+  final override fun buildPlugin(pluginId: String, systemVersionRequirement: String): PluginJar {
+    return PluginJar.Builder(plugins.toPath().resolve("$pluginId.jar"), pluginId)
+      .pluginClass(EchoPlugin::class.java.name)
+      .pluginVersion("1.0.0")
+      .manifestAttribute("Plugin-Requires", "echo$systemVersionRequirement")
+      .extensions(extensionClassNames)
+      .build()
+  }
+
+  @Autowired
+  override lateinit var spinnakerPluginManager: SpinnakerPluginManager
+
+  @Autowired
+  lateinit var applicationContext: ApplicationContext
+
+  init {
+    plugins.delete()
+    plugins.mkdir()
+    enabledPlugin = buildPlugin("com.netflix.echo.enabled.plugin", ">=1.0.0")
+    disabledPlugin = buildPlugin("com.netflix.echo.disabled.plugin", ">=1.0.0")
+    versionNotSupportedPlugin = buildPlugin("com.netflix.echo.version.not.supported.plugin", ">=2.0.0")
+  }
+}
+
+@SpringBootTest(classes = [Application::class])
+@ContextConfiguration(classes = [PluginTestConfiguration::class])
+@TestPropertySource(properties = ["spring.config.location=classpath:echo-plugins-test.yml"])
+@AutoConfigureMockMvc
+abstract class EchoTestService
+
+@TestConfiguration
+internal open class PluginTestConfiguration

echo-plugins-test/src/test/kotlin/com/netflix/spinnaker/echo/plugins/test/EchoPluginsTest.kt

@@ -0,0 +1,46 @@
+/*
+ * Copyright 2020 Netflix, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.netflix.spinnaker.echo.plugins.test
+
+import com.netflix.spinnaker.echo.api.events.EventListener
+import com.netflix.spinnaker.kork.plugins.tck.PluginsTck
+import com.netflix.spinnaker.kork.plugins.tck.serviceFixture
+import dev.minutest.rootContext
+import strikt.api.expect
+import strikt.assertions.isNotNull
+
+class EchoPluginsTest : PluginsTck<EchoPluginsFixture>() {
+
+  fun tests() = rootContext<EchoPluginsFixture> {
+    context("an echo integration test environment and an echo plugin") {
+      serviceFixture {
+        EchoPluginsFixture()
+      }
+
+      defaultPluginTests()
+
+      test("Event listener extension is loaded into context") {
+        val eventListeners = applicationContext.getBeansOfType<EventListener>(EventListener::class.java)
+        val extensionBeanName = "com.netflix.echo.enabled.plugin.EventListenerExtension".replace(".", "")
+        val extension = eventListeners[extensionBeanName]
+        expect {
+          that(extension).isNotNull()
+        }
+      }
+    }
+  }
+}

echo-plugins-test/src/test/resources/echo-plugins-test.yml

@@ -0,0 +1,28 @@
+front50:
+  baseUrl: 'http://localhost:8080'
+
+orca:
+  baseUrl: 'http://localhost:8083'
+
+resilience4j.circuitbreaker:
+  instances:
+    telemetry:
+      # This needs to stay false, because if the telemetry endpoint goes down, Echo goes unhealthy (no good!)
+      registerHealthIndicator: false
+
+spring:
+  application:
+    name: echo
+
+spinnaker:
+  baseUrl: 'http://localhost:9000'
+
+  extensibility:
+    plugins-root-path: build/plugins
+    plugins:
+      com.netflix.echo.enabled.plugin:
+        enabled: true
+      com.netflix.echo.disabled.plugin:
+        enabled: false
+      com.netflix.echo.version.not.supported.plugin:
+        enabled: true

echo-web/echo-web.gradle

@@ -67,3 +67,15 @@ run {
   systemProperty('spring.config.additional-location', project.springConfigLocation)
   systemProperty('spring.profiles.active', project.springProfiles)
 }
+
+test {
+  //The Implementation-Version is set in the MANIFEST.MF for the JAR produced via testing so that
+  //assertions can be made against the version (see echo-plugins-test, for example).
+  jar {
+    manifest {
+      attributes(
+        'Implementation-Version': '1.0.0'
+      )
+    }
+  }
+}

echo-web/src/main/java/com/netflix/spinnaker/echo/Application.java

@@ -19,20 +19,20 @@
 import com.netflix.spinnaker.kork.boot.DefaultPropertiesBuilder;
 import com.netflix.spinnaker.kork.configserver.ConfigServerBootstrap;
 import java.util.Map;
-import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.boot.autoconfigure.gson.GsonAutoConfiguration;
 import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
 import org.springframework.boot.builder.SpringApplicationBuilder;
 import org.springframework.boot.web.servlet.support.SpringBootServletInitializer;
 import org.springframework.context.annotation.ComponentScan;
-import org.springframework.context.annotation.Configuration;
 import org.springframework.scheduling.annotation.EnableScheduling;
 
 /** Application entry point. */
-@Configuration
-@EnableAutoConfiguration(exclude = {DataSourceAutoConfiguration.class, GsonAutoConfiguration.class})
 @EnableScheduling
 @ComponentScan({"com.netflix.spinnaker.echo.config", "com.netflix.spinnaker.config"})
+@SpringBootApplication(
+    scanBasePackages = {"com.netflix.spinnaker.echo.config", "com.netflix.spinnaker.config"},
+    exclude = {DataSourceAutoConfiguration.class, GsonAutoConfiguration.class})
 public class Application extends SpringBootServletInitializer {
   private static final Map<String, Object> DEFAULT_PROPS =
       new DefaultPropertiesBuilder().property("spring.application.name", "echo").build();

gradle.properties

@@ -2,3 +2,4 @@ fiatVersion=1.18.3
 korkVersion=7.37.0
 org.gradle.parallel=true
 spinnakerGradleVersion=8.0.0-rc.3
+kotlinVersion=1.3.71

gradle/kotlin.gradle

@@ -0,0 +1,43 @@
+/*
+ * Copyright 2017 Netflix, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License")
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+apply plugin: "nebula.kotlin"
+
+compileKotlin {
+  kotlinOptions {
+    languageVersion = "1.3"
+    jvmTarget = "1.8"
+    freeCompilerArgs += ["-progressive"]
+  }
+}
+
+compileTestKotlin {
+  kotlinOptions {
+    languageVersion = "1.3"
+    jvmTarget = "1.8"
+    freeCompilerArgs += ["-progressive"]
+  }
+}
+
+configurations.all {
+  resolutionStrategy {
+    eachDependency { details ->
+      if (details.requested.group == "org.jetbrains.kotlin") {
+        details.useVersion kotlinVersion
+      }
+    }
+  }
+}

settings.gradle

@@ -25,6 +25,7 @@ include 'echo-api',
         'echo-scheduler',
         'echo-rest',
         'echo-webhooks',
+        'echo-plugins-test',
         'echo-pubsub-core',
         'echo-pubsub-aws',
         'echo-pubsub-google',