Add real-world JSONs to make the validation better

Author: sfuhrm

src/main/java/com/ionos/go/plugin/notifier/ValidateConfigurationHandler.java

@@ -1,20 +1,22 @@
 package com.ionos.go.plugin.notifier;
 
+import com.google.gson.Gson;
 import com.ionos.go.plugin.notifier.message.GoPluginApiRequestHandler;
 import com.ionos.go.plugin.notifier.message.incoming.StageStatusRequest;
 import com.ionos.go.plugin.notifier.message.incoming.ValidateConfigurationRequest;
 import com.ionos.go.plugin.notifier.message.outgoing.ValidateConfigurationResponse;
 import com.ionos.go.plugin.notifier.template.TemplateHandler;
+import com.ionos.go.plugin.notifier.util.Helper;
+import com.ionos.go.plugin.notifier.util.JsonUtil;
 import com.thoughtworks.go.plugin.api.logging.Logger;
 import com.thoughtworks.go.plugin.api.request.GoPluginApiRequest;
 import com.thoughtworks.go.plugin.api.response.DefaultGoPluginApiResponse;
 import lombok.NonNull;
 
+import java.io.IOException;
 import java.net.MalformedURLException;
 import java.net.URL;
-import java.time.ZonedDateTime;
 import java.util.ArrayList;
-import java.util.Collections;
 import java.util.List;
 import java.util.Map;
 
@@ -31,38 +33,21 @@ class ValidateConfigurationHandler implements GoPluginApiRequestHandler {
         this.serverInfo = serverInfo;
     }
 
-    /** Creates a sample object for testing the condition and the template with.
+    /** Creates sample objects for testing the condition and the template with.
      * */
-    private StageStatusRequest newSampleStageStatusRequest() {
-        StageStatusRequest response = new StageStatusRequest();
-        StageStatusRequest.Pipeline pipeline = new StageStatusRequest.Pipeline();
-        StageStatusRequest.Stage stage = new StageStatusRequest.Stage();
-        StageStatusRequest.Job job = new StageStatusRequest.Job();
-
-        job.setName("jobname");
-        job.setAssignTime(ZonedDateTime.now());
-        job.setCompleteTime(ZonedDateTime.now());
-        job.setScheduleTime(ZonedDateTime.now());
-        job.setState("failed");
-        job.setResult("cancelled");
-
-        stage.setName("stagename");
-        stage.setApprovedBy("John Doe");
-        stage.setCounter("1");
-        stage.setPreviousStageCounter(0);
-        stage.setApprovalType("foo");
-        stage.setState("failed");
-        stage.setResult("cancelled");
-        stage.setCreateTime(ZonedDateTime.now());
-        stage.setJobs(new StageStatusRequest.Job[] {job});
-
-        pipeline.setStage(stage);
-        pipeline.setName("pipelinename");
-        pipeline.setCounter("0");
-        pipeline.setGroup("pipelinegroup");
-        pipeline.setBuildCause(new ArrayList<>());
-
-        response.setPipeline(pipeline);
+    private List<StageStatusRequest> newSampleStageStatusRequests() throws IOException {
+        List<StageStatusRequest> response = new ArrayList<>();
+
+        Gson gson = new Gson();
+        StageStatusRequest success = JsonUtil.fromJsonString(
+                Helper.readResource("/sampleSuccess.json"),
+                StageStatusRequest.class);
+        response.add(success);
+
+        StageStatusRequest failed = JsonUtil.fromJsonString(
+                Helper.readResource("/sampleFailed.json"),
+                StageStatusRequest.class);
+        response.add(failed);
 
         return response;
     }
@@ -138,7 +123,9 @@ private void validateTemplate(ValidateConfigurationRequest validateRequest, List
         } else {
             try {
                 TemplateHandler handler = new TemplateHandler("template", template);
-                handler.eval(newSampleStageStatusRequest(), serverInfo);
+                for (StageStatusRequest sample : newSampleStageStatusRequests()) {
+                    handler.eval(sample, serverInfo);
+                }
             }
             catch (Exception e) {
                 LOGGER.warn("Exception in " + Constants.PARAM_TEMPLATE, e);
@@ -154,9 +141,11 @@ private void validateCondition(ValidateConfigurationRequest validateRequest, Lis
         } else {
             try {
                 TemplateHandler handler = new TemplateHandler(Constants.PARAM_CONDITION, condition);
-                String shouldBeBool = handler.eval(newSampleStageStatusRequest(), serverInfo);
-                if (!(shouldBeBool.equals("true") || shouldBeBool.equals("false"))) {
-                    response.add(new ValidateConfigurationResponse(Constants.PARAM_CONDITION, "Condition should eval to true or false, but evals to: " + shouldBeBool));
+                for (StageStatusRequest sample : newSampleStageStatusRequests()) {
+                    String shouldBeBool = handler.eval(sample, serverInfo);
+                    if (!(shouldBeBool.equals("true") || shouldBeBool.equals("false"))) {
+                        response.add(new ValidateConfigurationResponse(Constants.PARAM_CONDITION, "Condition should eval to true or false, but evals to: " + shouldBeBool));
+                    }
                 }
             }
             catch (Exception e) {

src/main/resources/sampleFailed.json

@@ -0,0 +1 @@
+{"pipeline":{"name":"go-gchat-notifier-plugin","counter":"5","label":"dfbcc4c8f5892cbd099f6c5e7528b105e137b8f9","group":"Github","build-cause":[{"material":{"git-configuration":{"shallow-clone":false,"branch":"master","url":"https://github.com/1and1/go-gchat-notifier-plugin.git"},"fingerprint":"8f4ca9be1cc118c32c73783b83285b840e0c2feff12fb7abdb62e23199ea73a2","type":"git"},"changed":true,"modifications":[{"revision":"dfbcc4c8f5892cbd099f6c5e7528b105e137b8f9","modified-time":"2023-07-19T12:46:19.000+0000","data":{}}]}],"stage":{"name":"Snapshot","counter":"1","approval-type":"success","approved-by":"changes","previous-stage-name":"Test","previous-stage-counter":1,"state":"Failed","result":"Failed","create-time":"2023-07-19T12:48:29.828+0000","last-transition-time":"2023-07-19T12:48:51.212+0000","jobs":[{"name":"Deploy","schedule-time":"2023-07-19T12:48:29.828+0000","assign-time":"2023-07-19T12:48:33.731+0000","complete-time":"2023-07-19T12:48:51.212+0000","state":"Completed","result":"Failed","agent-uuid":"9ea12491-3730-4032-91a4-aec8d24af553"}]}}}

src/main/resources/sampleSuccess.json

@@ -0,0 +1,52 @@
+{
+   "pipeline" : {
+      "build-cause" : [
+         {
+            "changed" : true,
+            "material" : {
+               "fingerprint" : "8f4ca9be1cc118c32c73783b83285b840e0c2feff12fb7abdb62e23199ea73a2",
+               "git-configuration" : {
+                  "branch" : "master",
+                  "shallow-clone" : false,
+                  "url" : "https://github.com/1and1/go-gchat-notifier-plugin.git"
+               },
+               "type" : "git"
+            },
+            "modifications" : [
+               {
+                  "data" : {},
+                  "modified-time" : "2023-07-19T13:15:34.000+0000",
+                  "revision" : "d7b2629fda5048b8eea42b1bee968a8fd949eadd"
+               }
+            ]
+         }
+      ],
+      "counter" : "8",
+      "group" : "Github",
+      "label" : "d7b2629fda5048b8eea42b1bee968a8fd949eadd",
+      "name" : "go-gchat-notifier-plugin",
+      "stage" : {
+         "approval-type" : "success",
+         "approved-by" : "changes",
+         "counter" : "1",
+         "create-time" : "2023-07-19T13:16:56.571+0000",
+         "jobs" : [
+            {
+               "agent-uuid" : "51549723-2fc3-4965-8657-4d5785d86611",
+               "assign-time" : "2023-07-19T13:16:59.097+0000",
+               "complete-time" : "2023-07-19T13:17:09.671+0000",
+               "name" : "Deploy",
+               "result" : "Passed",
+               "schedule-time" : "2023-07-19T13:16:56.570+0000",
+               "state" : "Completed"
+            }
+         ],
+         "last-transition-time" : "2023-07-19T13:17:09.671+0000",
+         "name" : "Snapshot",
+         "previous-stage-counter" : 1,
+         "previous-stage-name" : "Test",
+         "result" : "Passed",
+         "state" : "Passed"
+      }
+   }
+}