Merge pull request #30 from bdpiparva/status-report-improvements

Status report improvements

Author: bdpiprava

build.gradle

@@ -74,6 +74,10 @@ processResources {
         filesMatching('plugin.properties') {
             expand project.pluginDesc
         }
+
+        filesMatching('version.properties') {
+            expand project.pluginDesc
+        }
     }
 }
 

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

@@ -39,7 +39,6 @@
 import static cd.go.contrib.elasticagent.KubernetesPlugin.LOG;
 import static cd.go.contrib.elasticagent.executors.GetProfileMetadataExecutor.POD_CONFIGURATION;
 import static cd.go.contrib.elasticagent.executors.GetProfileMetadataExecutor.PRIVILEGED;
-import static cd.go.contrib.elasticagent.utils.Util.GSON;
 import static cd.go.contrib.elasticagent.utils.Util.getSimpleDateFormat;
 import static java.lang.String.valueOf;
 import static java.text.MessageFormat.format;
@@ -125,7 +124,7 @@ private static void setLabels(Pod pod, CreateAgentRequest request) {
     private static void setAnnotations(Pod pod, CreateAgentRequest request) {
         Map<String, String> existingAnnotations = (pod.getMetadata().getAnnotations() != null) ? pod.getMetadata().getAnnotations() : new HashMap<>();
         existingAnnotations.putAll(request.properties());
-        existingAnnotations.put(JOB_IDENTIFIER_LABEL_KEY, GSON.toJson(request.jobIdentifier()));
+        existingAnnotations.put(JOB_IDENTIFIER_LABEL_KEY, request.jobIdentifier().toJson());
         pod.getMetadata().setAnnotations(existingAnnotations);
     }
 

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 ThoughtWorks, Inc.
+ * Copyright 2018 ThoughtWorks, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,11 +18,14 @@
 
 import cd.go.contrib.elasticagent.executors.*;
 import cd.go.contrib.elasticagent.requests.*;
+import cd.go.contrib.elasticagent.utils.Util;
 import com.thoughtworks.go.plugin.api.GoApplicationAccessor;
 import com.thoughtworks.go.plugin.api.GoPlugin;
 import com.thoughtworks.go.plugin.api.GoPluginIdentifier;
 import com.thoughtworks.go.plugin.api.annotation.Extension;
+import com.thoughtworks.go.plugin.api.annotation.Load;
 import com.thoughtworks.go.plugin.api.exceptions.UnhandledRequestTypeException;
+import com.thoughtworks.go.plugin.api.info.PluginContext;
 import com.thoughtworks.go.plugin.api.logging.Logger;
 import com.thoughtworks.go.plugin.api.request.GoPluginApiRequest;
 import com.thoughtworks.go.plugin.api.response.DefaultGoPluginApiResponse;
@@ -43,8 +46,13 @@ public void initializeGoApplicationAccessor(GoApplicationAccessor accessor) {
         agentInstances = new KubernetesAgentInstances();
     }
 
+    @Load
+    public void onLoad(PluginContext ctx) {
+        LOG.info("Loading plugin " + Util.pluginId() + " version " + Util.fullVersion());
+    }
+
     @Override
-    public GoPluginApiResponse handle(GoPluginApiRequest request) throws UnhandledRequestTypeException {
+    public GoPluginApiResponse handle(GoPluginApiRequest request) {
         try {
             switch (Request.fromString(request.requestName())) {
                 case REQUEST_GET_CAPABILITIES:

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

@@ -1,13 +1,29 @@
+/*
+ * Copyright 2018 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.elasticagent.executors;
 
 import cd.go.contrib.elasticagent.Constants;
 import cd.go.contrib.elasticagent.KubernetesClientFactory;
 import cd.go.contrib.elasticagent.PluginRequest;
 import cd.go.contrib.elasticagent.builders.PluginStatusReportViewBuilder;
 import cd.go.contrib.elasticagent.model.JobIdentifier;
-import cd.go.contrib.elasticagent.model.reports.StatusReportGenerationErrorHandler;
-import cd.go.contrib.elasticagent.model.reports.StatusReportGenerationException;
 import cd.go.contrib.elasticagent.model.reports.agent.KubernetesElasticAgent;
+import cd.go.contrib.elasticagent.reports.StatusReportGenerationErrorHandler;
+import cd.go.contrib.elasticagent.reports.StatusReportGenerationException;
 import cd.go.contrib.elasticagent.requests.AgentStatusReportRequest;
 import com.google.gson.JsonObject;
 import com.thoughtworks.go.plugin.api.response.DefaultGoPluginApiResponse;
@@ -71,7 +87,7 @@ private Pod findPodUsingJobIdentifier(JobIdentifier jobIdentifier, KubernetesCli
                     .withLabel(Constants.JOB_ID_LABEL_KEY, String.valueOf(jobIdentifier.getJobId()))
                     .list().getItems().get(0);
         } catch (Exception e) {
-            throw new StatusReportGenerationException(format("Can not find a running Pod for the provided job identifier: {0}.", jobIdentifier.representation()));
+            throw StatusReportGenerationException.noRunningPod(jobIdentifier);
         }
     }
 
@@ -83,6 +99,6 @@ private Pod findPodUsingElasticAgentId(String elasticAgentId, KubernetesClient c
             }
         }
 
-        throw new StatusReportGenerationException(format("Can not find a running Pod for the provided elastic agent id: {0}.", elasticAgentId));
+        throw StatusReportGenerationException.noRunningPod(elasticAgentId);
     }
 }

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 ThoughtWorks, Inc.
+ * Copyright 2018 ThoughtWorks, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -26,7 +26,7 @@
 
 public class GetCapabilitiesExecutor implements RequestExecutor {
     public GoPluginApiResponse execute() {
-        String capabilities = new Capabilities(true).toJSON();
+        String capabilities = new Capabilities(true, true).toJSON();
         LOG.debug("Plugin capabilities:" + capabilities);
         return new DefaultGoPluginApiResponse(SUCCESS_RESPONSE_CODE, capabilities);
     }

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

@@ -1,6 +1,6 @@
 
 /*
- * Copyright 2017 ThoughtWorks, Inc.
+ * Copyright 2018 ThoughtWorks, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -24,6 +24,9 @@
 import com.thoughtworks.go.plugin.api.response.DefaultGoPluginApiResponse;
 import com.thoughtworks.go.plugin.api.response.GoPluginApiResponse;
 
+import static cd.go.contrib.elasticagent.KubernetesPlugin.LOG;
+import static java.text.MessageFormat.format;
+
 public class ShouldAssignWorkRequestExecutor implements RequestExecutor {
     private final AgentInstances<KubernetesInstance> agentInstances;
     private final ShouldAssignWorkRequest request;
@@ -42,9 +45,11 @@ public GoPluginApiResponse execute() {
         }
 
         if (request.jobIdentifier().getJobId().equals(pod.jobId())) {
+            LOG.debug(format("[should-assign-work] Job with identifier {0} can be assigned to an agent {1}.", request.jobIdentifier(), pod.name()));
             return DefaultGoPluginApiResponse.success("true");
         }
 
+        LOG.error(format("[should-assign-work] Job with identifier {0} can not be assigned to an agent {1}.", request.jobIdentifier(), pod.name()));
         return DefaultGoPluginApiResponse.success("false");
     }
 }

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 ThoughtWorks, Inc.
+ * Copyright 2018 ThoughtWorks, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -20,7 +20,7 @@
 import cd.go.contrib.elasticagent.PluginRequest;
 import cd.go.contrib.elasticagent.builders.PluginStatusReportViewBuilder;
 import cd.go.contrib.elasticagent.model.KubernetesCluster;
-import cd.go.contrib.elasticagent.model.reports.StatusReportGenerationErrorHandler;
+import cd.go.contrib.elasticagent.reports.StatusReportGenerationErrorHandler;
 import com.google.gson.JsonObject;
 import com.thoughtworks.go.plugin.api.response.DefaultGoPluginApiResponse;
 import com.thoughtworks.go.plugin.api.response.GoPluginApiResponse;
@@ -47,7 +47,7 @@ public StatusReportExecutor(PluginRequest pluginRequest, KubernetesClientFactory
 
     public GoPluginApiResponse execute() {
         try {
-            LOG.info("[status-report] Generating status report");
+            LOG.info("[status-report] Generating status report.");
             KubernetesClient client = factory.client(pluginRequest.getPluginSettings());
             final KubernetesCluster kubernetesCluster = new KubernetesCluster(client);
             final Template template = statusReportViewBuilder.getTemplate("status-report.template.ftlh");

src/main/java/cd/go/contrib/elasticagent/model/Capabilities.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 ThoughtWorks, Inc.
+ * Copyright 2018 ThoughtWorks, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -26,8 +26,13 @@ public class Capabilities {
     @SerializedName("supports_status_report")
     private boolean supportsStatusReport;
 
-    public Capabilities(boolean supportsStatusReport) {
+    @Expose
+    @SerializedName("supports_agent_status_report")
+    private boolean supportsAgentStatusReport;
+
+    public Capabilities(boolean supportsStatusReport, boolean supportsAgentStatusReport) {
         this.supportsStatusReport = supportsStatusReport;
+        this.supportsAgentStatusReport = supportsAgentStatusReport;
     }
 
     public static Capabilities fromJSON(String json) {

src/main/java/cd/go/contrib/elasticagent/model/JobIdentifier.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 ThoughtWorks, Inc.
+ * Copyright 2018 ThoughtWorks, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -19,36 +19,40 @@
 import com.google.gson.annotations.Expose;
 import com.google.gson.annotations.SerializedName;
 
+import static cd.go.contrib.elasticagent.utils.Util.GSON;
+import static java.text.MessageFormat.format;
+
 public class JobIdentifier {
     @Expose
     @SerializedName("pipeline_name")
     private String pipelineName;
 
     @Expose
     @SerializedName("pipeline_counter")
-    private Long pipelineCounter;
+    private final Long pipelineCounter;
 
     @Expose
     @SerializedName("pipeline_label")
-    private String pipelineLabel;
+    private final String pipelineLabel;
 
     @Expose
     @SerializedName("stage_name")
-    private String stageName;
+    private final String stageName;
 
     @Expose
     @SerializedName("stage_counter")
-    private String stageCounter;
+    private final String stageCounter;
 
     @Expose
     @SerializedName("job_name")
-    private String jobName;
+    private final String jobName;
 
     @Expose
     @SerializedName("job_id")
-    private Long jobId;
+    private final Long jobId;
 
     public JobIdentifier() {
+        this(null, null, null, null, null, null, null);
     }
 
     public JobIdentifier(Long jobId) {
@@ -93,8 +97,33 @@ public Long getJobId() {
         return jobId;
     }
 
-    public String representation() {
-        return pipelineName + "/" + pipelineCounter + "/" + stageName + "/" + stageCounter + "/" + jobName;
+    public String getRepresentation() {
+        return String.format("%s/%s/%s/%s/%s", pipelineName, pipelineCounter, stageName, stageCounter, jobName);
+    }
+
+    public String getPipelineHistoryPageLink() {
+        return String.format("/go/tab/pipeline/history/%s", pipelineName);
+    }
+
+    public String getVsmPageLink() {
+        return String.format("/go/pipelines/value_stream_map/%s/%s", pipelineName, pipelineCounter);
+    }
+
+    public String getStageDetailsPageLink() {
+        return String.format("/go/pipelines/%s/%s/%s/%s", pipelineName, pipelineCounter, stageName, stageCounter);
+    }
+
+    public String getJobDetailsPageLink() {
+        return String.format("/go/tab/build/detail/%s", getRepresentation());
+    }
+
+    public String toJson() {
+        return GSON.toJson(this);
+    }
+
+    @Override
+    public String toString() {
+        return format("JobIdentifier'{'pipelineName=''{0}'', pipelineCounter={1}, pipelineLabel=''{2}'', stageName=''{3}'', stageCounter=''{4}'', jobName=''{5}'', jobId={6}'}'", pipelineName, pipelineCounter, pipelineLabel, stageName, stageCounter, jobName, jobId);
     }
 
     @Override
@@ -104,38 +133,31 @@ public boolean equals(Object o) {
 
         JobIdentifier that = (JobIdentifier) o;
 
-        if (pipelineCounter != that.pipelineCounter) return false;
-        if (jobId != that.jobId) return false;
         if (pipelineName != null ? !pipelineName.equals(that.pipelineName) : that.pipelineName != null) return false;
+        if (pipelineCounter != null ? !pipelineCounter.equals(that.pipelineCounter) : that.pipelineCounter != null)
+            return false;
         if (pipelineLabel != null ? !pipelineLabel.equals(that.pipelineLabel) : that.pipelineLabel != null)
             return false;
         if (stageName != null ? !stageName.equals(that.stageName) : that.stageName != null) return false;
         if (stageCounter != null ? !stageCounter.equals(that.stageCounter) : that.stageCounter != null) return false;
-        return jobName != null ? jobName.equals(that.jobName) : that.jobName == null;
+        if (jobName != null ? !jobName.equals(that.jobName) : that.jobName != null) return false;
+        return jobId != null ? jobId.equals(that.jobId) : that.jobId == null;
     }
 
     @Override
     public int hashCode() {
         int result = pipelineName != null ? pipelineName.hashCode() : 0;
-        result = 31 * result + (int) (pipelineCounter ^ (pipelineCounter >>> 32));
+        result = 31 * result + (pipelineCounter != null ? pipelineCounter.hashCode() : 0);
         result = 31 * result + (pipelineLabel != null ? pipelineLabel.hashCode() : 0);
         result = 31 * result + (stageName != null ? stageName.hashCode() : 0);
         result = 31 * result + (stageCounter != null ? stageCounter.hashCode() : 0);
         result = 31 * result + (jobName != null ? jobName.hashCode() : 0);
-        result = 31 * result + (int) (jobId ^ (jobId >>> 32));
+        result = 31 * result + (jobId != null ? jobId.hashCode() : 0);
         return result;
     }
 
-    @Override
-    public String toString() {
-        return "JobIdentifier{" +
-                "pipelineName='" + pipelineName + '\'' +
-                ", pipelineCounter=" + pipelineCounter +
-                ", pipelineLabel='" + pipelineLabel + '\'' +
-                ", staqeName='" + stageName + '\'' +
-                ", stageCounter='" + stageCounter + '\'' +
-                ", jobName='" + jobName + '\'' +
-                ", jobId=" + jobId +
-                '}';
+    public static JobIdentifier fromJson(String json) {
+        return GSON.fromJson(json, JobIdentifier.class);
     }
+
 }

src/main/java/cd/go/contrib/elasticagent/model/KubernetesPod.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 ThoughtWorks, Inc.
+ * Copyright 2018 ThoughtWorks, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -33,7 +33,7 @@ public class KubernetesPod {
     private JobIdentifier jobIdentifier;
 
     public KubernetesPod(Pod pod) throws ParseException {
-        jobIdentifier = Util.GSON.fromJson(pod.getMetadata().getAnnotations().get(Constants.JOB_IDENTIFIER_LABEL_KEY), JobIdentifier.class);
+        jobIdentifier = JobIdentifier.fromJson(pod.getMetadata().getAnnotations().get(Constants.JOB_IDENTIFIER_LABEL_KEY));
         podName = pod.getMetadata().getName();
         image = pod.getSpec().getContainers().get(0).getImage();
         podIP = pod.getStatus().getPodIP();
@@ -68,8 +68,8 @@ public String getStatus() {
     }
 
     public String getJobInformation() {
-        if(jobIdentifier != null) {
-            return jobIdentifier.representation();
+        if (jobIdentifier != null) {
+            return jobIdentifier.getRepresentation();
         }
         return "No Job Information Available!";
     }