Migrate plugin to use the gocd-contrib plugin-base

gocd · Jul 17, 2022 · 4ee3471 · 4ee3471
1 parent 5da4cb5
commit 4ee3471
Show file tree

Hide file tree

Showing 8 changed files with 29 additions and 24 deletions.
diff --git a/build.gradle b/build.gradle
@@ -53,9 +53,8 @@ ext {
 }
 
 dependencies {
-    implementation group: 'com.github.bdpiparva.plugin.base', name: 'gocd-plugin-base', version: '0.0.5'
+    implementation group: 'cd.go.plugin.base', name: 'gocd-plugin-base', version: '0.0.4'
     compileOnly group: 'cd.go.plugin', name: 'go-plugin-api', version: gocdPluginApiVersion
-    implementation group: 'com.google.code.gson', name: 'gson', version: '2.9.0'
     implementation group: 'io.fabric8', name: 'kubernetes-client', version: '5.12.2'
 
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: junitVersion

diff --git a/src/main/java/cd/go/contrib/secrets/kubernetes/KubernetesSecretsPlugin.java b/src/main/java/cd/go/contrib/secrets/kubernetes/KubernetesSecretsPlugin.java
@@ -2,8 +2,8 @@
 
 import cd.go.contrib.secrets.kubernetes.models.SecretConfig;
 import cd.go.contrib.secrets.kubernetes.validators.CredentialValidator;
-import com.github.bdpiparva.plugin.base.dispatcher.BaseBuilder;
-import com.github.bdpiparva.plugin.base.dispatcher.RequestDispatcher;
+import cd.go.plugin.base.dispatcher.BaseBuilder;
+import cd.go.plugin.base.dispatcher.RequestDispatcher;
 import com.thoughtworks.go.plugin.api.GoApplicationAccessor;
 import com.thoughtworks.go.plugin.api.GoPlugin;
 import com.thoughtworks.go.plugin.api.GoPluginIdentifier;
@@ -44,8 +44,14 @@ public void initializeGoApplicationAccessor(GoApplicationAccessor goApplicationA
     }
 
     @Override
-    public GoPluginApiResponse handle(GoPluginApiRequest request) throws UnhandledRequestTypeException {
-        return requestDispatcher.dispatch(request);
+    public GoPluginApiResponse handle(GoPluginApiRequest request) {
+        try {
+            return requestDispatcher.dispatch(request);
+        } catch (RuntimeException e) {
+            throw e;
+        } catch (Exception e) {
+            throw new RuntimeException(e);
+        }
     }
 
     @Override

diff --git a/src/main/java/cd/go/contrib/secrets/kubernetes/SecretConfigLookupExecutor.java b/src/main/java/cd/go/contrib/secrets/kubernetes/SecretConfigLookupExecutor.java
@@ -3,7 +3,7 @@
 import cd.go.contrib.secrets.kubernetes.models.SecretConfig;
 import cd.go.contrib.secrets.kubernetes.models.Secrets;
 import cd.go.contrib.secrets.kubernetes.request.SecretConfigRequest;
-import com.github.bdpiparva.plugin.base.executors.secrets.LookupExecutor;
+import cd.go.plugin.base.executors.secrets.LookupExecutor;
 import com.thoughtworks.go.plugin.api.response.DefaultGoPluginApiResponse;
 import com.thoughtworks.go.plugin.api.response.GoPluginApiResponse;
 import io.fabric8.kubernetes.api.model.Secret;
@@ -14,8 +14,8 @@
 import java.util.List;
 
 import static cd.go.contrib.secrets.kubernetes.KubernetesSecretsPlugin.LOG;
-import static com.github.bdpiparva.plugin.base.GsonTransformer.fromJson;
-import static com.github.bdpiparva.plugin.base.GsonTransformer.toJson;
+import static cd.go.plugin.base.GsonTransformer.fromJson;
+import static cd.go.plugin.base.GsonTransformer.toJson;
 import static java.util.Collections.singletonMap;
 
 public class SecretConfigLookupExecutor extends LookupExecutor<SecretConfigRequest> {

diff --git a/src/main/java/cd/go/contrib/secrets/kubernetes/models/SecretConfig.java b/src/main/java/cd/go/contrib/secrets/kubernetes/models/SecretConfig.java
@@ -16,7 +16,7 @@
 
 package cd.go.contrib.secrets.kubernetes.models;
 
-import com.github.bdpiparva.plugin.base.annotations.Property;
+import cd.go.plugin.base.annotations.Property;
 import com.google.gson.annotations.Expose;
 import com.google.gson.annotations.SerializedName;
 import org.apache.commons.lang3.StringUtils;

diff --git a/src/main/java/cd/go/contrib/secrets/kubernetes/validators/CredentialValidator.java b/src/main/java/cd/go/contrib/secrets/kubernetes/validators/CredentialValidator.java
@@ -2,17 +2,17 @@
 
 import cd.go.contrib.secrets.kubernetes.KubernetesClientFactory;
 import cd.go.contrib.secrets.kubernetes.models.SecretConfig;
-import com.github.bdpiparva.plugin.base.validation.ValidationResult;
-import com.github.bdpiparva.plugin.base.validation.Validator;
+import cd.go.plugin.base.GsonTransformer;
+import cd.go.plugin.base.validation.ValidationResult;
+import cd.go.plugin.base.validation.Validator;
+import com.thoughtworks.go.plugin.api.logging.Logger;
 import io.fabric8.kubernetes.api.model.Secret;
 import io.fabric8.kubernetes.client.KubernetesClient;
 
 import java.util.Map;
 
-import static com.github.bdpiparva.plugin.base.executors.Executor.GSON;
-import static com.github.bdpiparva.plugin.base.executors.Executor.LOGGER;
-
 public class CredentialValidator implements Validator {
+    private static final Logger LOGGER = Logger.getLoggerFor(CredentialValidator.class);
     private KubernetesClientFactory kubernetesClientFactory;
 
     public CredentialValidator(KubernetesClientFactory kubernetesClientFactory) {
@@ -23,7 +23,7 @@ public CredentialValidator(KubernetesClientFactory kubernetesClientFactory) {
     public ValidationResult validate(Map<String, String> requestBody) {
         ValidationResult validationResult = new ValidationResult();
 
-        SecretConfig secretConfig = GSON.fromJson(GSON.toJson(requestBody), SecretConfig.class);
+        SecretConfig secretConfig = GsonTransformer.fromJson(GsonTransformer.toJson(requestBody), SecretConfig.class);
         KubernetesClient client = kubernetesClientFactory.client(secretConfig);
 
         try {

diff --git a/src/test/java/cd/go/contrib/secrets/kubernetes/KubernetesSecretsPluginTest.java b/src/test/java/cd/go/contrib/secrets/kubernetes/KubernetesSecretsPluginTest.java
@@ -36,8 +36,8 @@
 
 import java.util.Map;
 
-import static com.github.bdpiparva.plugin.base.ResourceReader.readResource;
-import static com.github.bdpiparva.plugin.base.ResourceReader.readResourceBytes;
+import static cd.go.plugin.base.ResourceReader.readResource;
+import static cd.go.plugin.base.ResourceReader.readResourceBytes;
 import static java.util.Base64.getDecoder;
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.mockito.ArgumentMatchers.any;

diff --git a/src/test/java/cd/go/contrib/secrets/kubernetes/annotations/JsonSourceProvider.java b/src/test/java/cd/go/contrib/secrets/kubernetes/annotations/JsonSourceProvider.java
@@ -16,7 +16,7 @@
 
 package cd.go.contrib.secrets.kubernetes.annotations;
 
-import com.github.bdpiparva.plugin.base.ResourceReader;
+import cd.go.plugin.base.ResourceReader;
 import org.junit.jupiter.api.extension.ExtensionContext;
 import org.junit.jupiter.params.provider.Arguments;
 import org.junit.jupiter.params.provider.ArgumentsProvider;

diff --git a/src/test/resources/secret-config-metadata.json b/src/test/resources/secret-config-metadata.json
@@ -2,39 +2,39 @@
   {
     "key": "kubernetes_secret_name",
     "metadata": {
-      "displayName": "",
+      "display_name": "",
       "required": true,
       "secure": false
     }
   },
   {
     "key": "kubernetes_cluster_url",
     "metadata": {
-      "displayName": "",
+      "display_name": "",
       "required": true,
       "secure": false
     }
   },
   {
     "key": "security_token",
     "metadata": {
-      "displayName": "",
+      "display_name": "",
       "required": true,
       "secure": true
     }
   },
   {
     "key": "kubernetes_cluster_ca_cert",
     "metadata": {
-      "displayName": "",
+      "display_name": "",
       "required": false,
       "secure": true
     }
   },
   {
     "key": "namespace",
     "metadata": {
-      "displayName": "",
+      "display_name": "",
       "required": false,
       "secure": false
     }