feat(plugins): Download remote plugins

kork-plugins/src/main/java/com/netflix/spinnaker/kork/plugins/spring/PluginLoader.java

@@ -18,11 +18,13 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
 import com.google.common.annotations.Beta;
+import com.netflix.spinnaker.kork.plugins.spring.configs.PluginConfiguration;
+import com.netflix.spinnaker.kork.plugins.spring.configs.PluginProperties;
+import com.netflix.spinnaker.kork.plugins.spring.configs.PluginPropertyDetails;
 import java.io.*;
 import java.net.MalformedURLException;
 import java.net.URL;
 import java.net.URLClassLoader;
-import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.util.*;
 import java.util.stream.Collectors;
@@ -67,10 +69,10 @@ public void loadPlugins(Class source) {
       return;
     }
     try (InputStream inputStream = openFromFile()) {
-      PluginProperties props = parsePluginConfigs(inputStream);
-      List<PluginProperties.PluginConfiguration> pluginConfigurations = getEnabledJars(props);
+      PluginPropertyDetails props = parsePluginConfigs(inputStream);
+      List<PluginConfiguration> pluginConfigurations = getEnabledJars(props);
       logPlugins(pluginConfigurations);
-      urls = getJarPathsFromPluginConfigurations(pluginConfigurations);
+      urls = getJarPathsFromPluginConfigurations(pluginConfigurations, props.downloadingEnabled);
     } catch (IOException e) {
       throw new MissingPluginConfigurationException(
           String.format(
@@ -84,14 +86,15 @@ public void loadPlugins(Class source) {
    * Convert inputStream to pluginProperties object
    *
    * @param inputStream The list of plugins
-   * @return PluginProperties
+   * @return PluginPropertyDetails
    */
-  private PluginProperties parsePluginConfigs(InputStream inputStream) {
+  private PluginPropertyDetails parsePluginConfigs(InputStream inputStream) {
     ObjectMapper objectMapper = new ObjectMapper(new YAMLFactory());
     try {
-      PluginProperties pluginConfigs = objectMapper.readValue(inputStream, PluginProperties.class);
-      pluginConfigs.validate();
-      return pluginConfigs;
+      PluginPropertyDetails pluginPropertyDetails =
+          objectMapper.readValue(inputStream, PluginProperties.class).getPluginsPropertyDetails();
+      pluginPropertyDetails.validate();
+      return pluginPropertyDetails;
     } catch (IOException e) {
       throw new MalformedPluginConfigurationException("Unable to parse plugin configurations", e);
     }
@@ -114,12 +117,11 @@ private boolean checkFileExists() {
   /**
    * This method returns a list of Plugin Configurations that are enabled
    *
-   * @param pluginProperties Plugin configs, deserialized
+   * @param pluginPropertyDetails Plugin configs, deserialized
    * @return List<PluginConfiguration> List of pluginConfigurations where enabled is true
    */
-  private List<PluginProperties.PluginConfiguration> getEnabledJars(
-      PluginProperties pluginProperties) {
-    return pluginProperties.pluginConfigurationList.stream()
+  private List<PluginConfiguration> getEnabledJars(PluginPropertyDetails pluginPropertyDetails) {
+    return pluginPropertyDetails.getPluginConfigurations().stream()
         .filter(p -> p.enabled == true)
         .collect(Collectors.toList());
   }
@@ -129,23 +131,29 @@ private List<PluginProperties.PluginConfiguration> getEnabledJars(
    * @return List<URL> List of paths to jars, where enabled is true
    */
   private URL[] getJarPathsFromPluginConfigurations(
-      List<PluginProperties.PluginConfiguration> pluginConfigurations) {
+      List<PluginConfiguration> pluginConfigurations, boolean downloadingEnabled) {
     return pluginConfigurations.stream()
-        .map(PluginProperties.PluginConfiguration::getJars)
+        .map(PluginConfiguration::getJars)
         .flatMap(Collection::stream)
-        .map(Paths::get)
-        .map(this::getUrlFromPath)
+        .map(s -> convertToUrl(s, downloadingEnabled))
         .distinct()
         .toArray(URL[]::new);
   }
 
   /**
-   * @param path
+   * @param jarLocation
    * @return path as a URL
    */
-  private URL getUrlFromPath(Path path) {
+  private URL convertToUrl(String jarLocation, boolean downloadingEnabled) {
     try {
-      return path.toUri().toURL();
+      if (jarLocation.startsWith("/")) {
+        return Paths.get(jarLocation).toUri().toURL();
+      } else if (jarLocation.startsWith("file://") || downloadingEnabled) {
+        return new URL(jarLocation);
+      } else {
+        throw new MalformedPluginConfigurationException(
+            "Attempting to download jar " + jarLocation + " but downloading is disabled");
+      }
     } catch (MalformedURLException e) {
       throw new MalformedPluginConfigurationException(e);
     }
@@ -156,9 +164,9 @@ private URL getUrlFromPath(Path path) {
    *
    * @param pluginConfigurations
    */
-  private void logPlugins(List<PluginProperties.PluginConfiguration> pluginConfigurations) {
+  private void logPlugins(List<PluginConfiguration> pluginConfigurations) {
     if (!pluginConfigurations.isEmpty()) {
-      for (PluginProperties.PluginConfiguration pluginConfiguration : pluginConfigurations) {
+      for (PluginConfiguration pluginConfiguration : pluginConfigurations) {
         log.info("Loading {}", pluginConfiguration);
       }
     } else {

kork-plugins/src/main/java/com/netflix/spinnaker/kork/plugins/spring/configs/PluginConfiguration.java

@@ -0,0 +1,54 @@
+/*
+ * Copyright 2019 Armory, 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.kork.plugins.spring.configs;
+
+import com.netflix.spinnaker.kork.plugins.spring.MalformedPluginConfigurationException;
+import java.util.List;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+@Data
+@AllArgsConstructor
+@NoArgsConstructor
+public class PluginConfiguration {
+
+  public String name;
+  List<String> jars;
+  public boolean enabled;
+
+  static final String regex = "^[a-zA-Z0-9]+\\/[\\w-]+$";
+  static final Pattern pattern = Pattern.compile(regex);
+
+  public void validate() {
+    Matcher matcher = pattern.matcher(name);
+    if (!matcher.find()) {
+      throw new MalformedPluginConfigurationException(
+          String.format("Invalid plugin name: %s", name));
+    }
+  }
+
+  @Override
+  public String toString() {
+    return new StringBuilder()
+        .append("Plugin: " + name + ", ")
+        .append("Jars: " + String.join(", ", jars))
+        .toString();
+  }
+}

kork-plugins/src/main/java/com/netflix/spinnaker/kork/plugins/spring/configs/PluginConfigurationList.java

@@ -0,0 +1,32 @@
+/*
+ *  Copyright 2019 Armory, 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.kork.plugins.spring.configs;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import java.util.List;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+@Data
+@AllArgsConstructor
+@NoArgsConstructor
+public class PluginConfigurationList {
+
+  @JsonProperty("pluginConfigurationList")
+  List<PluginConfiguration> pluginConfigurationList;
+}

kork-plugins/src/main/java/com/netflix/spinnaker/kork/plugins/spring/configs/PluginProperties.java

@@ -0,0 +1,31 @@
+/*
+ * Copyright 2019 Armory, 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.kork.plugins.spring.configs;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+@Data
+@AllArgsConstructor
+@NoArgsConstructor
+public class PluginProperties {
+
+  @JsonProperty("plugins")
+  PluginPropertyDetails pluginsPropertyDetails;
+}

kork-plugins/src/main/java/com/netflix/spinnaker/kork/plugins/spring/PluginProperties.java → kork-plugins/src/main/java/com/netflix/spinnaker/kork/plugins/spring/configs/PluginPropertyDetails.java

@@ -13,13 +13,13 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.netflix.spinnaker.kork.plugins.spring;
+
+package com.netflix.spinnaker.kork.plugins.spring.configs;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
+import com.netflix.spinnaker.kork.plugins.spring.MalformedPluginConfigurationException;
 import java.util.Collections;
 import java.util.List;
-import java.util.regex.Matcher;
-import java.util.regex.Pattern;
 import java.util.stream.Collectors;
 import lombok.AllArgsConstructor;
 import lombok.Data;
@@ -28,22 +28,25 @@
 @Data
 @AllArgsConstructor
 @NoArgsConstructor
-public class PluginProperties {
+public class PluginPropertyDetails {
+
+  @JsonProperty("pluginConfigurations")
+  List<PluginConfiguration> pluginConfigurations;
 
-  @JsonProperty("plugins")
-  List<PluginConfiguration> pluginConfigurationList;
+  @JsonProperty("downloadingEnabled")
+  public Boolean downloadingEnabled;
 
   public void validate() {
     validateUniquePlugins();
-    for (PluginConfiguration pluginConfiguration : pluginConfigurationList) {
+    for (PluginConfiguration pluginConfiguration : getPluginConfigurations()) {
       pluginConfiguration.validate();
     }
   }
 
   public void validateUniquePlugins() {
 
     List<String> pluginNames =
-        pluginConfigurationList.stream()
+        getPluginConfigurations().stream()
             .map(PluginConfiguration::getName)
             .collect(Collectors.toList());
 
@@ -57,33 +60,4 @@ public void validateUniquePlugins() {
           String.format("The following plugins have been defined multiple times: %s", duplicates));
     }
   }
-
-  @Data
-  @AllArgsConstructor
-  @NoArgsConstructor
-  public static class PluginConfiguration {
-
-    public String name;
-    List<String> jars;
-    public boolean enabled;
-
-    static final String regex = "^[a-zA-Z0-9]+\\/[\\w-]+$";
-    static final Pattern pattern = Pattern.compile(regex);
-
-    public void validate() {
-      Matcher matcher = pattern.matcher(name);
-      if (!matcher.find()) {
-        throw new MalformedPluginConfigurationException(
-            String.format("Invalid plugin name: %s", name));
-      }
-    }
-
-    @Override
-    public String toString() {
-      return new StringBuilder()
-          .append("Plugin: " + name + ", ")
-          .append("Jars: " + String.join(", ", jars))
-          .toString();
-    }
-  }
 }