Minor fixes (#44)

* Remove volumes after test

* Added profile level validation

Author: bdpiprava

src/main/java/cd/go/contrib/elasticagents/dockerswarm/elasticagent/DockerClientFactory.java

@@ -35,18 +35,23 @@
 import static org.apache.commons.lang.StringUtils.isBlank;
 
 public class DockerClientFactory {
+    private DefaultDockerClient client;
+    private PluginSettings pluginSettings;
 
-    private static DefaultDockerClient client;
-    private static PluginSettings pluginSettings;
+    private static final DockerClientFactory DOCKER_CLIENT_FACTORY = new DockerClientFactory();
 
-    public static synchronized DockerClient docker(PluginSettings pluginSettings) throws Exception {
-        if (pluginSettings.equals(DockerClientFactory.pluginSettings) && DockerClientFactory.client != null) {
-            return DockerClientFactory.client;
+    public synchronized DockerClient docker(PluginSettings pluginSettings) throws Exception {
+        if (pluginSettings.equals(this.pluginSettings) && this.client != null) {
+            return this.client;
         }
 
-        DockerClientFactory.pluginSettings = pluginSettings;
-        DockerClientFactory.client = createClient(pluginSettings);
-        return DockerClientFactory.client;
+        this.pluginSettings = pluginSettings;
+        this.client = createClient(pluginSettings);
+        return this.client;
+    }
+
+    public static DockerClientFactory instance() {
+        return DOCKER_CLIENT_FACTORY;
     }
 
     private static DefaultDockerClient createClient(PluginSettings pluginSettings) throws Exception {

src/main/java/cd/go/contrib/elasticagents/dockerswarm/elasticagent/DockerMounts.java

@@ -16,24 +16,19 @@
 
 package cd.go.contrib.elasticagents.dockerswarm.elasticagent;
 
+import cd.go.contrib.elasticagents.dockerswarm.elasticagent.utils.Util;
+import com.google.gson.Gson;
+import com.spotify.docker.client.messages.Volume;
+import com.spotify.docker.client.messages.mount.Mount;
+
+import java.util.*;
+import java.util.stream.Collectors;
+
 import static cd.go.contrib.elasticagents.dockerswarm.elasticagent.DockerPlugin.LOG;
 import static cd.go.contrib.elasticagents.dockerswarm.elasticagent.utils.Util.splitIntoLinesAndTrimSpaces;
 import static java.text.MessageFormat.format;
 import static java.util.stream.Collectors.toList;
-import static org.apache.commons.lang.StringUtils.isBlank;
-import static org.apache.commons.lang.StringUtils.isNotBlank;
-import static org.apache.commons.lang.StringUtils.stripToEmpty;
-
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-import java.util.stream.Collectors;
-
-import com.google.gson.Gson;
-import com.spotify.docker.client.messages.Volume;
-import com.spotify.docker.client.messages.mount.Mount;
+import static org.apache.commons.lang.StringUtils.*;
 
 public class DockerMounts extends ArrayList<DockerMounts.DockerMount> {
     private static final Gson GSON = new Gson();
@@ -60,10 +55,13 @@ private static Map<String, String> lineToMap(String line) {
                     case "type":
                         map.put("type", stripToEmpty(parts[1]));
                         break;
-                    case "source": case "src":
+                    case "source":
+                    case "src":
                         map.put("source", stripToEmpty(parts[1]));
                         break;
-                    case "target": case "destination": case "dst":
+                    case "target":
+                    case "destination":
+                    case "dst":
                         map.put("target", stripToEmpty(parts[1]));
                         break;
                     default:
@@ -91,6 +89,12 @@ private static Map<String, String> lineToMap(String line) {
     }
 
     public List<Mount> toMount(List<Volume> volumes) {
+
+        if (Util.isEmpty(volumes)) {
+            LOG.debug("No volumes to mount.");
+            return Collections.emptyList();
+        }
+
         final Map<String, Volume> volumeMap = volumes.stream().collect(Collectors.toMap(o -> o.name(), o -> o));
         final List<Mount> mounts = new ArrayList<>();
 

src/main/java/cd/go/contrib/elasticagents/dockerswarm/elasticagent/DockerPlugin.java

@@ -31,8 +31,6 @@
 import com.thoughtworks.go.plugin.api.response.DefaultGoPluginApiResponse;
 import com.thoughtworks.go.plugin.api.response.GoPluginApiResponse;
 
-import static cd.go.contrib.elasticagents.dockerswarm.elasticagent.DockerClientFactory.docker;
-
 @Extension
 public class DockerPlugin implements GoPlugin {
     public static final Logger LOG = Logger.getLoggerFor(DockerPlugin.class);
@@ -65,7 +63,7 @@ public GoPluginApiResponse handle(GoPluginApiRequest request) throws UnhandledRe
                 case REQUEST_GET_PROFILE_VIEW:
                     return new GetProfileViewExecutor().execute();
                 case REQUEST_VALIDATE_PROFILE:
-                    return ProfileValidateRequest.fromJSON(request.requestBody()).executor(docker(pluginRequest.getPluginSettings())).execute();
+                    return ProfileValidateRequest.fromJSON(request.requestBody()).executor(pluginRequest).execute();
                 case PLUGIN_SETTINGS_GET_ICON:
                     return new GetPluginSettingsIconExecutor().execute();
                 case PLUGIN_SETTINGS_GET_CONFIGURATION:
@@ -75,7 +73,7 @@ public GoPluginApiResponse handle(GoPluginApiRequest request) throws UnhandledRe
                 case REQUEST_GET_CAPABILITIES:
                     return new GetCapabilitiesExecutor().execute();
                 case REQUEST_STATUS_REPORT:
-                    return new StatusReportExecutor(docker(pluginRequest.getPluginSettings())).execute();
+                    return new StatusReportExecutor(pluginRequest).execute();
                 default:
                     throw new UnhandledRequestTypeException(request.requestName());
             }

src/main/java/cd/go/contrib/elasticagents/dockerswarm/elasticagent/DockerServices.java

@@ -130,7 +130,7 @@ private void register(DockerService service) {
     }
 
     private DockerClient docker(PluginSettings settings) throws Exception {
-        return DockerClientFactory.docker(settings);
+        return DockerClientFactory.instance().docker(settings);
     }
 
     private DockerServices unregisteredAfterTimeout(PluginSettings settings, Agents knownAgents) throws Exception {

src/main/java/cd/go/contrib/elasticagents/dockerswarm/elasticagent/executors/Metadata.java

@@ -16,13 +16,11 @@
 
 package cd.go.contrib.elasticagents.dockerswarm.elasticagent.executors;
 
+import cd.go.contrib.elasticagents.dockerswarm.elasticagent.model.ValidationError;
 import com.google.gson.annotations.Expose;
 import com.google.gson.annotations.SerializedName;
 import org.apache.commons.lang.StringUtils;
 
-import java.util.HashMap;
-import java.util.Map;
-
 public class Metadata {
 
     @Expose
@@ -46,14 +44,12 @@ public Metadata(String key, ProfileMetadata metadata) {
         this.metadata = metadata;
     }
 
-    public Map<String, String> validate(String input) {
-        HashMap<String, String> result = new HashMap<>();
-        String validationError = doValidate(input);
-        if (StringUtils.isNotBlank(validationError)) {
-            result.put("key", key);
-            result.put("message", validationError);
+    public ValidationError validate(String input) {
+        String errorMessage = doValidate(input);
+        if (StringUtils.isNotBlank(errorMessage)) {
+            return new ValidationError(key, errorMessage);
         }
-        return result;
+        return null;
     }
 
     protected String doValidate(String input) {

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

@@ -16,74 +16,54 @@
 
 package cd.go.contrib.elasticagents.dockerswarm.elasticagent.executors;
 
-import cd.go.contrib.elasticagents.dockerswarm.elasticagent.DockerSecrets;
+import cd.go.contrib.elasticagents.dockerswarm.elasticagent.PluginRequest;
 import cd.go.contrib.elasticagents.dockerswarm.elasticagent.RequestExecutor;
+import cd.go.contrib.elasticagents.dockerswarm.elasticagent.model.ValidationResult;
 import cd.go.contrib.elasticagents.dockerswarm.elasticagent.requests.ProfileValidateRequest;
-import com.google.gson.Gson;
-import com.spotify.docker.client.DockerClient;
+import cd.go.contrib.elasticagents.dockerswarm.elasticagent.validator.DockerMountsValidator;
+import cd.go.contrib.elasticagents.dockerswarm.elasticagent.validator.DockerSecretValidator;
+import cd.go.contrib.elasticagents.dockerswarm.elasticagent.validator.Validatable;
 import com.thoughtworks.go.plugin.api.response.DefaultGoPluginApiResponse;
 import com.thoughtworks.go.plugin.api.response.GoPluginApiResponse;
 
-import java.util.*;
-
-import static cd.go.contrib.elasticagents.dockerswarm.elasticagent.utils.Util.dockerApiVersionAtLeast;
+import java.util.ArrayList;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
 
 public class ProfileValidateRequestExecutor implements RequestExecutor {
     private final ProfileValidateRequest request;
-    private final DockerClient dockerClient;
-    private static final Gson GSON = new Gson();
+    private List<Validatable> validators = new ArrayList<>();
 
-    public ProfileValidateRequestExecutor(ProfileValidateRequest request, DockerClient dockerClient) {
+    public ProfileValidateRequestExecutor(ProfileValidateRequest request, PluginRequest pluginRequest) {
         this.request = request;
-        this.dockerClient = dockerClient;
+        validators.add(new DockerSecretValidator(pluginRequest));
+        validators.add(new DockerMountsValidator(pluginRequest));
     }
 
     @Override
     public GoPluginApiResponse execute() throws Exception {
-        final List<Map<String, String>> result = new ArrayList<>();
         final List<String> knownFields = new ArrayList<>();
+        final ValidationResult validationResult = new ValidationResult();
 
         for (Metadata field : GetProfileMetadataExecutor.FIELDS) {
             knownFields.add(field.getKey());
-            Map<String, String> validationError = field.validate(request.getProperties().get(field.getKey()));
-
-            if (!validationError.isEmpty()) {
-                result.add(validationError);
-            }
+            validationResult.addError(field.validate(request.getProperties().get(field.getKey())));
         }
 
-
         final Set<String> set = new HashSet<>(request.getProperties().keySet());
         set.removeAll(knownFields);
 
         if (!set.isEmpty()) {
             for (String key : set) {
-                LinkedHashMap<String, String> validationError = new LinkedHashMap<>();
-                validationError.put("key", key);
-                validationError.put("message", "Is an unknown property");
-                result.add(validationError);
+                validationResult.addError(key, "Is an unknown property.");
             }
         }
 
-        validateDockerSecrets(result);
-
-        return DefaultGoPluginApiResponse.success(GSON.toJson(result));
-    }
-
-    private void validateDockerSecrets(List<Map<String, String>> result) {
-        try {
-            final DockerSecrets dockerSecrets = DockerSecrets.fromString(request.getProperties().get("Secrets"));
-            if (!dockerSecrets.isEmpty()) {
-                if (!dockerApiVersionAtLeast(dockerClient, "1.26")) {
-                    throw new RuntimeException("Docker secret requires api version 1.26 or higher.");
-                }
-                dockerSecrets.toSecretBind(dockerClient.listSecrets());
-            }
-        } catch (Exception e) {
-            LinkedHashMap<String, String> validationError = new LinkedHashMap<>();
-            validationError.put("key", "Secrets");
-            validationError.put("message", e.getMessage());
-            result.add(validationError);
+        for (Validatable validatable : validators) {
+            validationResult.merge(validatable.validate(request.getProperties()));
         }
+
+        return DefaultGoPluginApiResponse.success(validationResult.toJSON());
     }
 }

src/main/java/cd/go/contrib/elasticagents/dockerswarm/elasticagent/executors/StatusReportExecutor.java

@@ -16,36 +16,39 @@
 
 package cd.go.contrib.elasticagents.dockerswarm.elasticagent.executors;
 
+import cd.go.contrib.elasticagents.dockerswarm.elasticagent.DockerClientFactory;
+import cd.go.contrib.elasticagents.dockerswarm.elasticagent.PluginRequest;
 import cd.go.contrib.elasticagents.dockerswarm.elasticagent.builders.PluginStatusReportViewBuilder;
 import cd.go.contrib.elasticagents.dockerswarm.elasticagent.model.SwarmCluster;
 import com.google.gson.JsonObject;
 import com.spotify.docker.client.DockerClient;
-import com.spotify.docker.client.exceptions.DockerException;
 import com.thoughtworks.go.plugin.api.response.DefaultGoPluginApiResponse;
 import com.thoughtworks.go.plugin.api.response.GoPluginApiResponse;
 import freemarker.template.Template;
-import freemarker.template.TemplateException;
 
 import java.io.IOException;
 
 import static cd.go.contrib.elasticagents.dockerswarm.elasticagent.DockerPlugin.LOG;
 
 public class StatusReportExecutor {
-    private final DockerClient dockerClient;
+    private final PluginRequest pluginRequest;
+    private final DockerClientFactory dockerClientFactory;
     private final PluginStatusReportViewBuilder statusReportViewBuilder;
 
-    public StatusReportExecutor(DockerClient dockerClient) throws IOException {
-        this(dockerClient, PluginStatusReportViewBuilder.instance());
+    public StatusReportExecutor(PluginRequest pluginRequest) throws IOException {
+        this(pluginRequest, DockerClientFactory.instance(), PluginStatusReportViewBuilder.instance());
     }
 
-    StatusReportExecutor(DockerClient dockerClient, PluginStatusReportViewBuilder statusReportViewBuilder) {
-        this.dockerClient = dockerClient;
+    StatusReportExecutor(PluginRequest pluginRequest, DockerClientFactory dockerClientFactory, PluginStatusReportViewBuilder statusReportViewBuilder) {
+        this.pluginRequest = pluginRequest;
+        this.dockerClientFactory = dockerClientFactory;
         this.statusReportViewBuilder = statusReportViewBuilder;
     }
 
-    public GoPluginApiResponse execute() throws DockerException, InterruptedException, IOException, TemplateException {
+    public GoPluginApiResponse execute() throws Exception {
         LOG.info("[status-report] Generating status report");
 
+        final DockerClient dockerClient = dockerClientFactory.docker(pluginRequest.getPluginSettings());
         final SwarmCluster swarmCluster = new SwarmCluster(dockerClient);
         final Template template = statusReportViewBuilder.getTemplate("status-report.template.ftlh");
         final String statusReportView = statusReportViewBuilder.build(template, swarmCluster);

src/main/java/cd/go/contrib/elasticagents/dockerswarm/elasticagent/model/ValidationError.java

@@ -0,0 +1,67 @@
+/*
+ * Copyright 2017 ThoughtWorks, 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 cd.go.contrib.elasticagents.dockerswarm.elasticagent.model;
+
+import com.google.gson.annotations.Expose;
+import com.google.gson.annotations.SerializedName;
+
+import java.text.MessageFormat;
+
+public class ValidationError {
+    @Expose
+    @SerializedName("key")
+    private final String key;
+    @Expose
+    @SerializedName("message")
+    private final String message;
+
+    public ValidationError(String key, String message) {
+        this.key = key;
+        this.message = message;
+    }
+
+    public String key() {
+        return key;
+    }
+
+    public String message() {
+        return message;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+
+        ValidationError that = (ValidationError) o;
+
+        if (key != null ? !key.equals(that.key) : that.key != null) return false;
+        return message != null ? message.equals(that.message) : that.message == null;
+    }
+
+    @Override
+    public int hashCode() {
+        int result = key != null ? key.hashCode() : 0;
+        result = 31 * result + (message != null ? message.hashCode() : 0);
+        return result;
+    }
+
+    @Override
+    public String toString() {
+        return MessageFormat.format("ValidationError'{'key=''{0}'', message=''{1}'''}'", key, message);
+    }
+}