/api/resources endpoint was removed in SonarQube 6.3 and later, so …

.gitignore

@@ -13,3 +13,7 @@
 
 # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
 hs_err_pid*
+
+*/target/*
+out/*.jar
+target/lib/*.jar

build.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+mvn install:install-file \
+-Dfile=bin/go-plugin-api-15.1.0.jar \
+-DgroupId=com.thoughtworks.go \
+-DartifactId=go-plugin-api \
+-Dversion=15.1.0 \
+-Dpackaging=jar && \
+\
+mvn clean \
+package \
+-DskipTests && \
+\
+mvn cobertura:cobertura

check_mk-plugin/pom.xml

@@ -9,8 +9,8 @@
 
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-        <go.target.version>15.1.0</go.target.version>
-        <go.version>15.1.0</go.version>
+        <go.target.version>16.4.0</go.target.version>
+        <go.version>16.4.0</go.version>
         <plugin.version>${project.version}</plugin.version>
 
         <sonar.java.coveragePlugin>cobertura</sonar.java.coveragePlugin>

check_mk-plugin/resources/views/checkMk.template.html

@@ -25,6 +25,7 @@
 <select ng-init="SelectedAction='default'" ng-model="SelectedAction" >
     <option selected disabled value="default">Select action</option>
     <option value="add">Add Host</option>
+    <option value="edit">Edit Host</option>
     <option value="remove">Remove Host</option>
 </select>
 </br>
@@ -59,6 +60,35 @@
             </div>
         </div>
     </div>
+    <div ng-switch-when="edit">
+        <div class="form_item_block">
+            <label>Hostname:<span class="asterisk">*</span>
+            </label>
+            <input type="text" ng-model="Hostname" ng-required="true">
+            </input>
+            <div role="alert">
+                <span class="error" color="red" ng-show="GOINPUTNAME[Hostname].$error.required" >Required!</span>
+            </div>
+        </div>
+        <div class="form_item_block">
+            <label>New Host ip:<span class="asterisk">*</span>
+            </label>
+            <input type="text" ng-model="HostIp" ng-required="true">
+            </input>
+            <div role="alert">
+                <span class="error" color="red" ng-show="GOINPUTNAME[HostIp].$error.required" >Required!</span>
+            </div>
+        </div>
+        <div class="form_item_block">
+            <label>New Folder path:<span class="asterisk">*</span>
+            </label>
+            <input type="text" ng-model="FolderPath" ng-required="true">
+            </input>
+            <div role="alert">
+                <span class="error" color="red" ng-show="GOINPUTNAME[FolderPath].$error.required" >Required!</span>
+            </div>
+        </div>
+    </div>
     <div ng-switch-when="remove">
         <div class="form_item_block">
             <label>Hostname:<span class="asterisk">*</span>

check_mk-plugin/src/com/tw/go/task/check_mk/AddHostTaskExecutor.java

@@ -15,7 +15,7 @@ public AddHostTaskExecutor(JobConsoleLogger console, Context context, Map config
         super(console, context, config);
     }
 
-    public Result execute() {
+    public Result execute() throws Exception {
         try {
             String hostname = (String) ((Map) this.config.get(CheckMkTask.HOSTNAME)).get("value");
             String serverIp = (String) ((Map) this.config.get(CheckMkTask.HOST_IP)).get("value");

check_mk-plugin/src/com/tw/go/task/check_mk/CheckMkRequestObjectFactory.java

@@ -14,6 +14,17 @@ public static JSONObject CreateAddHostObject(String folderName, String hostname,
         return objAddHost;
     }
 
+    public static JSONObject CreateEditHostObject(String folderName, String hostname, String serverIp)throws Exception
+    {
+        JSONObject objCreateAttributes = new JSONObject();
+        objCreateAttributes.put("ipaddress", serverIp);
+        JSONObject objAddHost= new JSONObject();
+        objAddHost.put("folder", folderName);
+        objAddHost.put("hostname", hostname);
+        objAddHost.put("attributes", objCreateAttributes);
+        return objAddHost;
+    }
+
     public static JSONObject CreateRemoveHostObject(String hostname)throws Exception
     {
         JSONObject objRemoveHost= new JSONObject();

check_mk-plugin/src/com/tw/go/task/check_mk/CheckMkTask.java

@@ -2,29 +2,25 @@
 package com.tw.go.task.check_mk;
 
 import com.google.gson.GsonBuilder;
-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.exceptions.UnhandledRequestTypeException;
 import com.thoughtworks.go.plugin.api.logging.Logger;
 import com.thoughtworks.go.plugin.api.request.GoPluginApiRequest;
 import com.thoughtworks.go.plugin.api.response.DefaultGoApiResponse;
 import com.thoughtworks.go.plugin.api.response.DefaultGoPluginApiResponse;
 import com.thoughtworks.go.plugin.api.response.GoPluginApiResponse;
-import com.thoughtworks.go.plugin.api.task.JobConsoleLogger;
-import com.tw.go.plugin.common.Context;
-import com.tw.go.plugin.common.Result;
+import com.tw.go.plugin.common.*;
 import org.apache.commons.io.IOUtils;
 
+import java.io.IOException;
 import java.util.Arrays;
 import java.util.HashMap;
 import java.util.Map;
 
 @Extension
-public class CheckMkTask implements GoPlugin {
+public class CheckMkTask extends BaseGoPlugin {
 
-    public static final String CHECK_MK_SERVER="Server";
+    public static final String CHECK_MK_SERVER = "Server";
     public static final String HOSTNAME = "Hostname";
     public static final String HOST_IP = "HostIp";
     public static final String FOLDER_PATH = "FolderPath";
@@ -34,29 +30,12 @@ public class CheckMkTask implements GoPlugin {
     private Logger logger = Logger.getLoggerFor(CheckMkTask.class);
 
     @Override
-    public void initializeGoApplicationAccessor(GoApplicationAccessor goApplicationAccessor) {
-    }
-
-    @Override
-    public GoPluginApiResponse handle(GoPluginApiRequest request) throws UnhandledRequestTypeException {
-        if ("configuration".equals(request.requestName())) {
-            return handleGetConfigRequest();
-        } else if ("validate".equals(request.requestName())) {
-            return handleValidation(request);
-        } else if ("execute".equals(request.requestName())) {
-            return handleTaskExecution(request);
-        } else if ("view".equals(request.requestName())) {
-            return handleTaskView();
-        }
-        throw new UnhandledRequestTypeException(request.requestName());
-    }
-
-    private GoPluginApiResponse handleTaskView() {
+    protected GoPluginApiResponse handleTaskView(GoPluginApiRequest request) {
         int responseCode = DefaultGoApiResponse.SUCCESS_RESPONSE_CODE;
         HashMap view = new HashMap();
         view.put("displayValue", "Monitoring - Check MK");
         try {
-            String checkMkTemplate=IOUtils.toString(getClass().getResourceAsStream("/views/checkMk.template.html"), "UTF-8");
+            String checkMkTemplate = IOUtils.toString(getClass().getResourceAsStream("/views/checkMk.template.html"), "UTF-8");
             view.put("template", checkMkTemplate);
         } catch (Exception e) {
             responseCode = DefaultGoApiResponse.INTERNAL_ERROR;
@@ -67,29 +46,26 @@ private GoPluginApiResponse handleTaskView() {
         return createResponse(responseCode, view);
     }
 
-    private GoPluginApiResponse handleTaskExecution(GoPluginApiRequest request) {
+    @Override
+    protected GoPluginApiResponse handleTaskExecution(GoPluginApiRequest request) throws Exception {
         Map executionRequest = (Map) new GsonBuilder().create().fromJson(request.requestBody(), Object.class);
-        Map config = (Map) executionRequest.get("config");
-        Map contextMap = (Map) executionRequest.get("context");
-        JobConsoleLogger consoleLogger=JobConsoleLogger.getConsoleLogger();
+
+        Map<String, Map> config = (Map) executionRequest.get("config");
+
+        Context context = new Context((Map) executionRequest.get("context"));
+
         try {
-            CheckMkTaskExecutor checkMkTaskExecutor=TaskExecutorFactory.Create(consoleLogger, new Context(contextMap), config);
+            CheckMkTaskExecutor checkMkTaskExecutor = TaskExecutorFactory.Create(MaskingJobConsoleLogger.getConsoleLogger(),
+                    context, config);
             Result result = checkMkTaskExecutor.execute();
             return createResponse(result.responseCode(), result.toMap());
-        }
-        catch (JobNotSupportedException e)
-        {
-            consoleLogger.printLine(e.getMessage());
-            return createResponse( DefaultGoApiResponse.INTERNAL_ERROR,null);
-        }
-        catch(Exception e)
-        {
-            consoleLogger.printLine(e.getMessage());
-            return createResponse( DefaultGoApiResponse.INTERNAL_ERROR,null);
+        } catch (JobNotSupportedException | IOException e) {
+            return success(new Result(false, e.getMessage()));
         }
     }
 
-    private GoPluginApiResponse handleValidation(GoPluginApiRequest request) {
+    @Override
+    protected GoPluginApiResponse handleValidation(GoPluginApiRequest request) {
         HashMap validationResult = new HashMap();
         int responseCode = DefaultGoPluginApiResponse.SUCCESS_RESPONSE_CODE;
         Map configMap = (Map) new GsonBuilder().create().fromJson(request.requestBody(), Object.class);
@@ -104,7 +80,8 @@ private GoPluginApiResponse handleValidation(GoPluginApiRequest request) {
 
     // return json description to tell go.cd which config properties need to be stored
     // sample and schema can be found at http://www.go.cd/documentation/developer/writing_go_plugins/task/version_1_0/configuration.html
-    private GoPluginApiResponse handleGetConfigRequest() {
+    @Override
+    protected GoPluginApiResponse handleGetConfigRequest(GoPluginApiRequest request) {
 
         HashMap config = new HashMap();
 

check_mk-plugin/src/com/tw/go/task/check_mk/CheckMkTaskExecutor.java

@@ -2,7 +2,6 @@
 
 import com.thoughtworks.go.plugin.api.task.JobConsoleLogger;
 import com.tw.go.plugin.common.Context;
-import com.tw.go.plugin.common.Result;
 import com.tw.go.plugin.common.TaskExecutor;
 import org.json.JSONObject;
 
@@ -15,8 +14,6 @@ public CheckMkTaskExecutor(JobConsoleLogger console, Context context, Map config
         super(console, context, config);
     }
 
-    public abstract Result execute() ;
-
     protected String getPluginLogPrefix() {
         return "[Check_Mk Task] ";
     }

check_mk-plugin/src/com/tw/go/task/check_mk/EditHostException.java

@@ -0,0 +1,12 @@
+package com.tw.go.task.check_mk;
+
+import org.json.JSONObject;
+
+public class EditHostException extends Exception
+{
+    public EditHostException(JSONObject requestObject, JSONObject resultObject)
+    {
+        super("Failed to edit host "+requestObject.get("hostname")+". " +resultObject.get("result"));
+    }
+}
+

check_mk-plugin/src/com/tw/go/task/check_mk/EditHostJob.java

@@ -0,0 +1,24 @@
+package com.tw.go.task.check_mk;
+
+import org.json.JSONObject;
+
+public class EditHostJob extends CheckMkJob
+{
+    public EditHostJob(ICheckMkClient checkMkClient) {
+        super(checkMkClient);
+        Action="edit_host";
+        Parameters="";
+    }
+
+    @Override
+    public String Execute(JSONObject requestObject) throws Exception {
+        JSONObject jsonResult = ExecuteWebRequest(requestObject);
+        if(!jsonResult.get("result_code").toString().equals("0"))
+        {
+            throw new EditHostException(requestObject,jsonResult);
+        }
+        return "Host "+requestObject.get("hostname")+" updated.";
+    }
+}
+
+

check_mk-plugin/src/com/tw/go/task/check_mk/EditHostTaskExecutor.java

@@ -0,0 +1,43 @@
+
+package com.tw.go.task.check_mk;
+
+
+import com.thoughtworks.go.plugin.api.task.JobConsoleLogger;
+import com.tw.go.plugin.common.Context;
+import com.tw.go.plugin.common.Result;
+import org.json.JSONObject;
+
+import java.util.Map;
+
+public class EditHostTaskExecutor extends CheckMkTaskExecutor {
+
+    public EditHostTaskExecutor(JobConsoleLogger console, Context context, Map config) {
+        super(console, context, config);
+    }
+
+    public Result execute() throws Exception {
+        try {
+            String hostname = (String) ((Map) this.config.get(CheckMkTask.HOSTNAME)).get("value");
+            String serverIp = (String) ((Map) this.config.get(CheckMkTask.HOST_IP)).get("value");
+            String folderPath = (String) ((Map) this.config.get(CheckMkTask.FOLDER_PATH)).get("value");
+            ServerCredentials credentials = CreateCredentials();
+            TryInitClient(credentials);
+            CheckMkJob checkMkJob = new EditHostJob(checkMkClient);
+            JSONObject requestObject = CheckMkRequestObjectFactory.CreateEditHostObject(folderPath, hostname, serverIp);
+            ExecuteJob(requestObject, checkMkJob);
+            return new Result(true, "Edit host was successful.");
+        } catch (Exception e) {
+            log("Exception. " + e.getMessage());
+            return new Result(false, "Edit host failed", e);
+        }
+    }
+
+    protected String getPluginLogPrefix() {
+        return "[Edit Host Task] ";
+    }
+
+    public void setCheckMkClient(ICheckMkClient checkMkClient) {
+        this.checkMkClient = checkMkClient;
+    }
+}
+

check_mk-plugin/src/com/tw/go/task/check_mk/RemoveHostTaskExecutor.java

@@ -15,7 +15,7 @@ public RemoveHostTaskExecutor(JobConsoleLogger console, Context context, Map con
         super(console, context, config);
     }
 
-    public Result execute() {
+    public Result execute() throws Exception {
         try {
             String hostname = (String) ((Map) this.config.get(CheckMkTask.HOSTNAME)).get("value");
             ServerCredentials credentials = CreateCredentials();

check_mk-plugin/src/com/tw/go/task/check_mk/TaskExecutorFactory.java

@@ -5,15 +5,19 @@
 
 import java.util.Map;
 
-public class TaskExecutorFactory
-{
+public class TaskExecutorFactory {
     public static CheckMkTaskExecutor Create(JobConsoleLogger console, Context context, Map config) throws JobNotSupportedException {
         String action = (String) ((Map) config.get(CheckMkTask.ACTION)).get("value");
-        switch (action)
-        {
-            case "add":return new AddHostTaskExecutor(console,context,config);
-            case "remove":return new RemoveHostTaskExecutor(console,context,config);
+        switch (action) {
+            case "add":
+                return new AddHostTaskExecutor(console, context, config);
+            case "edit":
+                return new EditHostTaskExecutor(console, context, config);
+            case "remove":
+                ((Map) config.get(CheckMkTask.FOLDER_PATH)).put("value", "");
+                ((Map) config.get(CheckMkTask.HOST_IP)).put("value", "");
+                return new RemoveHostTaskExecutor(console, context, config);
         }
-        throw new JobNotSupportedException("Action "+action+" not supported!");
+        throw new JobNotSupportedException("Action " + action + " not supported!");
     }
 }

check_mk-plugin/test/com/tw/go/task/check_mk/EditHostJobTests.java

@@ -0,0 +1,33 @@
+package com.tw.go.task.check_mk;
+
+import org.junit.BeforeClass;
+import org.junit.Test;
+
+import static org.junit.Assert.assertEquals;
+public class EditHostJobTests {
+
+    @BeforeClass
+    public static void Init() throws Exception {
+        CheckMkStub.init();
+
+    }
+
+    @Test(expected = EditHostException.class)
+    public void Execute_RequestFailed_ThrowException() throws Exception {
+        CheckMkStub.SetupRequestError();
+        CheckMkJob job = new EditHostJob(CheckMkStub.checkMkClient);
+
+        job.Execute(CheckMkRequestObjectFactory.CreateEditHostObject(CheckMkStub.folderPath, CheckMkStub.hostName, CheckMkStub.hostIp));
+    }
+
+    @Test
+    public void Execute_RequestSuccess_ReturnsOkMessage() throws Exception {
+        CheckMkStub.SetupRequestOk();
+        CheckMkJob job = new EditHostJob(CheckMkStub.checkMkClient);
+
+        String result = job.Execute(CheckMkRequestObjectFactory.CreateEditHostObject(CheckMkStub.folderPath, CheckMkStub.hostName, CheckMkStub.hostIp));
+
+        assertEquals(result, "Host test updated.");
+    }
+}
+