chore: Reboot/gh647/improved conformance testing

gateway-service/src/main/java/org/zowe/apiml/gateway/conformance/ConformanceProblemsContainer.java

@@ -0,0 +1,148 @@
+/*
+ * This program and the accompanying materials are made available under the terms of the
+ * Eclipse Public License v2.0 which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-v20.html
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Copyright Contributors to the Zowe Project.
+ */
+
+package org.zowe.apiml.gateway.conformance;
+
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import org.apache.commons.lang.text.StrSubstitutor;
+import org.zowe.apiml.message.api.ApiMessage;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Map;
+
+
+/**
+ * Java class that is used to keep track of found conformance issues
+ */
+public class ConformanceProblemsContainer extends HashMap<String, ArrayList<String>> {
+
+
+    private final String serviceId;
+    private static final String responseMessageTemplate = "{\n" +
+        "\"messageAction\": \"${messageAction}\",\n" +
+        "\"messageContent\": {\n" +
+        "    \"The service ${serviceId} is not conformant\": \n" +
+        "        ${messageContent}\n" +
+        "},\n" +
+        "\"messageKey\": \"${messageKey}\",\n" +
+        "\"messageNumber\": \"${messageNumber}\",\n" +
+        "\"messageReason\": \"${messageReason}\",\n" +
+        "\"messageType\": \"${messageType}\"\n" +
+        "}";
+
+    ConformanceProblemsContainer(String serviceId) {
+        super();
+        this.serviceId = serviceId;
+    }
+
+    @Override
+    public ArrayList<String> put(String key, ArrayList<String> value) {
+
+        if (value == null) {
+            return null;
+        }
+
+        if (this.get(key) != null && this.get(key).size() != 0) {
+            this.get(key).addAll(value);
+            return null;
+        }
+        return super.put(key, new ArrayList<>(value));
+    }
+
+    public ArrayList<String> put(String key, String value) {
+        if (value == null || value.equals("")) {
+            return null;
+        }
+
+        return put(key, new ArrayList<>(Collections.singleton(value)));
+    }
+
+    @Override
+    public int size() {
+        int result = 0;
+        for (ArrayList<String> value : this.values()) {
+            if (value == null) {
+                continue;
+            }
+            result += value.size();
+        }
+        return result;
+    }
+
+    @Override
+    public String toString() {
+        StringBuilder result = new StringBuilder();
+
+        result.append("{");
+
+        boolean firstLoop = true;
+
+        ArrayList<String> sortedKeySet = new ArrayList<>(this.keySet());
+        sortedKeySet.remove(null);  // since it used be a set this removes all nulls
+        sortedKeySet.sort(null);
+
+        for (String key : sortedKeySet) {
+
+            if (this.get(key) == null || this.get(key).size() == 0) {
+                continue;
+            }
+
+
+            if (!firstLoop) {
+                result.append(",");
+            }
+
+
+            result.append("\"").append(key).append("\"");
+            result.append(":[");
+
+            boolean firstInnerLoop = true;
+            for (String i : get(key)) {
+                if (!firstInnerLoop) {
+                    result.append(",");
+                }
+                try {
+                    result.append(new ObjectMapper().writeValueAsString(i));
+                } catch (JsonProcessingException e) {
+                    throw new RuntimeException(e);
+                }
+                firstInnerLoop = false;
+            }
+            result.append("]");
+
+            firstLoop = false;
+        }
+
+        result.append("}");
+        return result.toString();
+    }
+
+
+    public String createBadRequestAPIResponseBody(String key, ApiMessage correspondingAPIMessage) {
+
+        Map<String, String> valuesMap = new HashMap<>();
+
+        valuesMap.put("messageKey", key);
+        valuesMap.put("messageContent", this.toString());
+        valuesMap.put("serviceId", serviceId);
+        valuesMap.put("messageReason", correspondingAPIMessage.getMessageReason());
+        valuesMap.put("messageNumber", correspondingAPIMessage.getMessageNumber());
+        valuesMap.put("messageType", correspondingAPIMessage.getMessageType().toString());
+        valuesMap.put("messageAction", correspondingAPIMessage.getMessageAction());
+
+        return new StrSubstitutor(valuesMap).replace(responseMessageTemplate);
+
+    }
+
+}