Allow specifying templated values in elastic agent pod yaml (#17)

Author: GaneshSPatil

src/main/java/cd/go/contrib/elasticagent/KubernetesInstanceFactory.java

@@ -201,12 +201,7 @@ private static String image(Map<String, String> properties) {
     private KubernetesInstance createUsingPodYaml(CreateAgentRequest request, PluginSettings settings, KubernetesClient client, PluginRequest pluginRequest) {
         ObjectMapper mapper = new ObjectMapper(new YAMLFactory());
         String podYaml = request.properties().get(POD_CONFIGURATION.getKey());
-
-        StringWriter writer = new StringWriter();
-        MustacheFactory mf = new DefaultMustacheFactory();
-        Mustache mustache = mf.compile(new StringReader(podYaml), "templatePod");
-        mustache.execute(writer, KubernetesInstanceFactory.getJinJavaContext());
-        String templatizedPodYaml = writer.toString();
+        String templatizedPodYaml = getTemplatizedPodYamlString(podYaml);
 
         Pod elasticAgentPod = new Pod();
         try {
@@ -220,6 +215,14 @@ private KubernetesInstance createUsingPodYaml(CreateAgentRequest request, Plugin
         return createKubernetesPod(client, elasticAgentPod);
     }
 
+    public static String getTemplatizedPodYamlString(String podYaml) {
+        StringWriter writer = new StringWriter();
+        MustacheFactory mf = new DefaultMustacheFactory();
+        Mustache mustache = mf.compile(new StringReader(podYaml), "templatePod");
+        mustache.execute(writer, KubernetesInstanceFactory.getJinJavaContext());
+        return writer.toString();
+    }
+
     public static Map<String, String> getJinJavaContext() {
         HashMap<String, String> context = new HashMap<>();
         context.put(Constants.POD_POSTFIX, UUID.randomUUID().toString());

src/main/java/cd/go/contrib/elasticagent/executors/ProfileValidateRequestExecutor.java

@@ -16,6 +16,7 @@
 
 package cd.go.contrib.elasticagent.executors;
 
+import cd.go.contrib.elasticagent.KubernetesInstanceFactory;
 import cd.go.contrib.elasticagent.RequestExecutor;
 import cd.go.contrib.elasticagent.model.Metadata;
 import cd.go.contrib.elasticagent.requests.ProfileValidateRequest;
@@ -96,7 +97,7 @@ private void validatePodYaml(HashMap<String, String> properties, ArrayList<Map<S
 
         ObjectMapper mapper = new ObjectMapper(new YAMLFactory());
         try {
-            mapper.readValue(podYaml, Pod.class);
+            mapper.readValue(KubernetesInstanceFactory.getTemplatizedPodYamlString(podYaml), Pod.class);
         } catch (IOException e) {
             addError(result, key, "Invalid Pod Yaml.");
         }

src/main/java/cd/go/contrib/elasticagent/executors/ValidateConfigurationExecutor.java

@@ -22,7 +22,6 @@
 import cd.go.contrib.elasticagent.model.Field;
 import cd.go.contrib.elasticagent.model.ServerInfo;
 import cd.go.contrib.elasticagent.requests.ValidatePluginSettings;
-import com.google.gson.Gson;
 import com.thoughtworks.go.plugin.api.response.DefaultGoPluginApiResponse;
 import com.thoughtworks.go.plugin.api.response.GoPluginApiResponse;
 import org.apache.commons.lang3.StringUtils;

src/test/java/cd/go/contrib/elasticagent/executors/ProfileValidateRequestExecutorTest.java

@@ -21,7 +21,6 @@
 import org.skyscreamer.jsonassert.JSONAssert;
 import org.skyscreamer.jsonassert.JSONCompareMode;
 
-import java.util.Collections;
 import java.util.HashMap;
 import java.util.Map;
 
@@ -54,6 +53,59 @@ public void shouldValidateMandatoryKeysForPodConfiguration() throws Exception {
         JSONAssert.assertEquals("[{\"message\":\"Pod Configuration must not be blank.\",\"key\":\"PodConfiguration\"}]", json, JSONCompareMode.NON_EXTENSIBLE);
     }
 
+    @Test
+    public void shouldValidatePodConfigurationWhenSpecifiedAsYaml() throws Exception {
+        Map<String, String> properties = new HashMap<>();
+        properties.put("SpecifiedUsingPodConfiguration", "true");
+        properties.put("PodConfiguration", "this is my invalid fancy pod yaml!!");
+        ProfileValidateRequestExecutor executor = new ProfileValidateRequestExecutor(new ProfileValidateRequest(properties));
+        String json = executor.execute().responseBody();
+        JSONAssert.assertEquals("[{\"message\":\"Invalid Pod Yaml.\",\"key\":\"PodConfiguration\"}]", json, JSONCompareMode.NON_EXTENSIBLE);
+    }
+
+    @Test
+    public void shouldAllowPodYamlConfiguration() throws Exception {
+        Map<String, String> properties = new HashMap<>();
+        properties.put("SpecifiedUsingPodConfiguration", "true");
+        String podYaml = "apiVersion: v1\n" +
+                "kind: Pod\n" +
+                "metadata:\n" +
+                "  name: pod-name\n" +
+                "  labels:\n" +
+                "    app: web\n" +
+                "spec:\n" +
+                "  containers:\n" +
+                "    - name: gocd-agent-container\n" +
+                "      image: gocd/fancy-agent-image:latest";
+
+        properties.put("PodConfiguration", podYaml);
+        ProfileValidateRequestExecutor executor = new ProfileValidateRequestExecutor(new ProfileValidateRequest(properties));
+        String json = executor.execute().responseBody();
+        JSONAssert.assertEquals("[]", json, JSONCompareMode.NON_EXTENSIBLE);
+    }
+
+
+    @Test
+    public void shouldAllowGinjaTemplatedPodYaml() throws Exception {
+        Map<String, String> properties = new HashMap<>();
+        properties.put("SpecifiedUsingPodConfiguration", "true");
+        String podYaml = "apiVersion: v1\n" +
+                "kind: Pod\n" +
+                "metadata:\n" +
+                "  name: pod-name-prefix-{{ POD_POSTFIX }}\n" +
+                "  labels:\n" +
+                "    app: web\n" +
+                "spec:\n" +
+                "  containers:\n" +
+                "    - name: gocd-agent-container-{{ CONTAINER_POSTFIX }}\n" +
+                "      image: {{ GOCD_AGENT_IMAGE }}:{{ LATEST_VERSION }}";
+
+        properties.put("PodConfiguration", podYaml);
+        ProfileValidateRequestExecutor executor = new ProfileValidateRequestExecutor(new ProfileValidateRequest(properties));
+        String json = executor.execute().responseBody();
+        JSONAssert.assertEquals("[]", json, JSONCompareMode.NON_EXTENSIBLE);
+    }
+
     @Test
     public void shouldValidatePodConfiguration() throws Exception {
         Map<String, String> properties = new HashMap<>();
@@ -63,4 +115,4 @@ public void shouldValidatePodConfiguration() throws Exception {
         String json = executor.execute().responseBody();
         JSONAssert.assertEquals("[{\"message\":\"Invalid Pod Yaml.\",\"key\":\"PodConfiguration\"}]", json, JSONCompareMode.NON_EXTENSIBLE);
     }
-}
+}