Merge pull request #136 from varshavaradarajan/append-to-console-log

Show plugin messages in job console log

Author: arvindsv

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

@@ -31,11 +31,12 @@ public interface AgentInstances<T> {
      * <p>
      * So that instances created are auto-registered with the server, the agent instance MUST have an
      * <code>autoregister.properties</code> file.
-     *  @param request   the request object
+     * @param request   the request object
      * @param settings   the plugin settings object
      * @param pluginRequest the plugin request object
+     * @param consoleLogAppender
      */
-    T create(CreateAgentRequest request, PluginSettings settings, PluginRequest pluginRequest) throws Exception;
+    T create(CreateAgentRequest request, PluginSettings settings, PluginRequest pluginRequest, ConsoleLogAppender consoleLogAppender) throws Exception;
 
     /**
      * This message is sent when the plugin needs to terminate the agent instance.

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

@@ -0,0 +1,22 @@
+/*
+ * Copyright 2019 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;
+
+import java.util.function.Consumer;
+
+public interface ConsoleLogAppender extends Consumer<String> {
+}

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

@@ -31,6 +31,7 @@ public interface Constants {
     String PROCESSOR_API_VERSION = "1.0";
     String EXTENSION_API_VERSION = "5.0";
     String SERVER_INFO_API_VERSION = "1.0";
+    String CONSOLE_LOG_API_VERSION = "1.0";
 
     // the identifier of this plugin
     GoPluginIdentifier PLUGIN_IDENTIFIER = new GoPluginIdentifier(EXTENSION_TYPE, Collections.singletonList(EXTENSION_API_VERSION));
@@ -41,6 +42,7 @@ public interface Constants {
     String REQUEST_SERVER_DELETE_AGENT = REQUEST_SERVER_PREFIX + ".elastic-agents.delete-agents";
     String REQUEST_SERVER_LIST_AGENTS = REQUEST_SERVER_PREFIX + ".elastic-agents.list-agents";
     String REQUEST_SERVER_INFO = REQUEST_SERVER_PREFIX + ".server-info.get";
+    String REQUEST_SERVER_APPEND_TO_CONSOLE_LOG = REQUEST_SERVER_PREFIX + ".console-log.append";
 
     // internal use only
     String CREATED_BY_LABEL_KEY = "Elastic-Agent-Created-By";

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

@@ -58,16 +58,18 @@ public KubernetesAgentInstances(KubernetesClientFactory factory, KubernetesInsta
     }
 
     @Override
-    public KubernetesInstance create(CreateAgentRequest request, PluginSettings settings, PluginRequest pluginRequest) {
+    public KubernetesInstance create(CreateAgentRequest request, PluginSettings settings, PluginRequest pluginRequest, ConsoleLogAppender consoleLogAppender) {
         final Integer maxAllowedContainers = settings.getMaxPendingPods();
         synchronized (instances) {
             refreshAll(settings);
             doWithLockOnSemaphore(new SetupSemaphore(maxAllowedContainers, instances, semaphore));
-
+            consoleLogAppender.accept("Waiting to create agent pod.");
             if (semaphore.tryAcquire()) {
-                return createKubernetesInstance(request, settings, pluginRequest);
+                return createKubernetesInstance(request, settings, pluginRequest, consoleLogAppender);
             } else {
-                LOG.warn(format("Create Agent Request] The number of pending kubernetes pods is currently at the maximum permissible limit ({0}). Total kubernetes pods ({1}). Not creating any more containers.", maxAllowedContainers, instances.size()));
+                String message = format("[Create Agent Request] The number of pending kubernetes pods is currently at the maximum permissible limit ({0}). Total kubernetes pods ({1}). Not creating any more containers.", maxAllowedContainers, instances.size());
+                LOG.warn(message);
+                consoleLogAppender.accept(message);
                 return null;
             }
         }
@@ -79,16 +81,20 @@ private void doWithLockOnSemaphore(Runnable runnable) {
         }
     }
 
-    private KubernetesInstance createKubernetesInstance(CreateAgentRequest request, PluginSettings settings, PluginRequest pluginRequest) {
+    private KubernetesInstance createKubernetesInstance(CreateAgentRequest request, PluginSettings settings, PluginRequest pluginRequest, ConsoleLogAppender consoleLogAppender) {
         JobIdentifier jobIdentifier = request.jobIdentifier();
         if (isAgentCreatedForJob(jobIdentifier.getJobId())) {
-            LOG.warn(format("[Create Agent Request] Request for creating an agent for Job Identifier [{0}] has already been scheduled. Skipping current request.", jobIdentifier));
+            String message = format("[Create Agent Request] Request for creating an agent for Job Identifier [{0}] has already been scheduled. Skipping current request.", jobIdentifier);
+            LOG.warn(message);
+            consoleLogAppender.accept(message);
             return null;
         }
 
         KubernetesClient client = factory.client(settings);
         KubernetesInstance instance = kubernetesInstanceFactory.create(request, settings, client, pluginRequest);
+        consoleLogAppender.accept(format("Creating pod: %s", instance.name()));
         register(instance);
+        consoleLogAppender.accept(format("Agent pod %s created. Waiting for it to register to the GoCD server.", instance.name()));
 
         return instance;
     }

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

@@ -16,12 +16,16 @@
 
 package cd.go.contrib.elasticagent;
 
+import cd.go.contrib.elasticagent.model.JobIdentifier;
 import cd.go.contrib.elasticagent.model.ServerInfo;
+import com.google.gson.GsonBuilder;
 import com.thoughtworks.go.plugin.api.GoApplicationAccessor;
 import com.thoughtworks.go.plugin.api.request.DefaultGoApiRequest;
 import com.thoughtworks.go.plugin.api.response.GoApiResponse;
 
 import java.util.Collection;
+import java.util.HashMap;
+import java.util.Map;
 
 import static cd.go.contrib.elasticagent.Constants.*;
 import static cd.go.contrib.elasticagent.KubernetesPlugin.LOG;
@@ -86,4 +90,23 @@ public void deleteAgents(Collection<Agent> toBeDeleted) throws ServerRequestFail
             throw ServerRequestFailedException.deleteAgents(response);
         }
     }
+
+    public void appendToConsoleLog(JobIdentifier jobIdentifier, String text) throws ServerRequestFailedException {
+        Map<String, String> requestMap = new HashMap<>();
+        requestMap.put("pipelineName", jobIdentifier.getPipelineName());
+        requestMap.put("pipelineCounter", String.valueOf(jobIdentifier.getPipelineCounter()));
+        requestMap.put("stageName", jobIdentifier.getStageName());
+        requestMap.put("stageCounter", jobIdentifier.getStageCounter());
+        requestMap.put("jobName", jobIdentifier.getJobName());
+        requestMap.put("text", text);
+
+        DefaultGoApiRequest request = new DefaultGoApiRequest(Constants.REQUEST_SERVER_APPEND_TO_CONSOLE_LOG, CONSOLE_LOG_API_VERSION, PLUGIN_IDENTIFIER);
+        request.setRequestBody(new GsonBuilder().create().toJson(requestMap));
+
+        GoApiResponse response = accessor.submit(request);
+
+        if (response.responseCode() != 200) {
+            LOG.error("Failed to append to console log for " + jobIdentifier.getRepresentation() + " with text: " + text);
+        }
+    }
 }

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

@@ -48,4 +48,8 @@ public static ServerRequestFailedException getPluginSettings(GoApiResponse respo
     public static ServerRequestFailedException serverInfo(GoApiResponse response) {
         return new ServerRequestFailedException(response, "get server info");
     }
+
+    public static ServerRequestFailedException appendToConsoleLog(GoApiResponse response) {
+        return new ServerRequestFailedException(response, "append to console log");
+    }
 }

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

@@ -16,18 +16,20 @@
 
 package cd.go.contrib.elasticagent.executors;
 
-import cd.go.contrib.elasticagent.AgentInstances;
-import cd.go.contrib.elasticagent.KubernetesInstance;
-import cd.go.contrib.elasticagent.PluginRequest;
-import cd.go.contrib.elasticagent.RequestExecutor;
+import cd.go.contrib.elasticagent.*;
 import cd.go.contrib.elasticagent.requests.CreateAgentRequest;
 import com.thoughtworks.go.plugin.api.response.DefaultGoPluginApiResponse;
 import com.thoughtworks.go.plugin.api.response.GoPluginApiResponse;
+import org.joda.time.DateTime;
+import org.joda.time.LocalTime;
+import org.joda.time.format.DateTimeFormat;
+import org.joda.time.format.DateTimeFormatter;
 
 import static cd.go.contrib.elasticagent.KubernetesPlugin.LOG;
 import static java.text.MessageFormat.format;
 
 public class CreateAgentRequestExecutor implements RequestExecutor {
+    private static final DateTimeFormatter MESSAGE_PREFIX_FORMATTER = DateTimeFormat.forPattern("'##|'HH:mm:ss.SSS '[go]'");
     private final AgentInstances<KubernetesInstance> agentInstances;
     private final PluginRequest pluginRequest;
     private final CreateAgentRequest request;
@@ -41,7 +43,18 @@ public CreateAgentRequestExecutor(CreateAgentRequest request, AgentInstances<Kub
     @Override
     public GoPluginApiResponse execute() throws Exception {
         LOG.debug(format("[Create Agent] creating elastic agent for profile {0} in cluster {1}", request.properties(), request.clusterProfileProperties()));
-        agentInstances.create(request, request.clusterProfileProperties(), pluginRequest);
+        ConsoleLogAppender consoleLogAppender = text -> {
+            final String message = String.format("%s %s\n", LocalTime.now().toString(MESSAGE_PREFIX_FORMATTER), text);
+            pluginRequest.appendToConsoleLog(request.jobIdentifier(), message);
+        };
+        consoleLogAppender.accept(format("Received request to create a pod for job {0} in cluster {1} at {2}", request.jobIdentifier(), request.clusterProfileProperties().getClusterUrl(), new DateTime().toString("yyyy-MM-dd HH:mm:ss ZZ")));
+        try {
+            agentInstances.create(request, request.clusterProfileProperties(), pluginRequest, consoleLogAppender);
+        } catch (Exception e) {
+            consoleLogAppender.accept(format("Failed to create agent pod: %s", e.getMessage()));
+            throw e;
+        }
+
         return new DefaultGoPluginApiResponse(200);
     }