Added lenientValidation support to REMReM generate (#128)

Raja Maragani · web-flow · commit 07d8ab4f7bca · 2020-08-14T16:57:43.000+05:30
* Added lenientValidation support to REMReM generate

Co-authored-by: raja-maragani
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,6 @@
+## 2.1.0
+- Updated REMReM Generate to support lenient validation for Eiffel Semantics protocol.
+
 ## 2.0.13
 - Removed the validation of REMReM should not accept both a CAUSE and a CONTEXT link types in the same event.
 
diff --git a/pom.xml b/pom.xml
@@ -7,7 +7,7 @@
         <version>2.0.4</version>
     </parent>
     <artifactId>eiffel-remrem-semantics</artifactId>
-    <version>2.0.13</version>
+    <version>2.1.0</version>
     <packaging>jar</packaging>
     <properties>
         <eclipse.jgit.version>5.0.1.201806211838-r</eclipse.jgit.version>
@@ -23,7 +23,7 @@
         <dependency>
             <groupId>com.github.eiffel-community</groupId>
             <artifactId>eiffel-remrem-protocol-interface</artifactId>
-            <version>2.0.4</version>
+            <version>2.1.0</version>
             <scope>compile</scope>
         </dependency>
         <dependency>
@@ -67,6 +67,11 @@
             <version>${eclipse.jgit.version}</version>
             <scope>compile</scope>
         </dependency>
+        <dependency>
+        <groupId>com.jayway.jsonpath</groupId>
+            <artifactId>json-path</artifactId>
+            <version>2.4.0</version>
+        </dependency>
         <dependency>
             <groupId>org.mockito</groupId>
             <artifactId>mockito-core</artifactId>
diff --git a/src/main/java/com/ericsson/eiffel/remrem/semantics/SemanticsService.java b/src/main/java/com/ericsson/eiffel/remrem/semantics/SemanticsService.java
@@ -185,12 +185,16 @@ public static Map<EiffelEventType, Class<? extends Event>> eventType() {
         eventTypes.put(ALERT_CEASED, EiffelAlertCeasedEvent.class);
         eventTypes.put(ALERT_RAISED, EiffelAlertRaisedEvent.class);
         eventTypes.put(ISSUE_DEFINED, EiffelIssueDefinedEvent.class);
-
         return eventTypes;
     }
 
     @Override
     public String generateMsg(String msgType, JsonObject bodyJson) {
+        return generateMsg(msgType, bodyJson, false);
+    }
+
+    @Override
+    public String generateMsg(String msgType, JsonObject bodyJson, Boolean lenientValidation) {
         try {
             if (purlSerializerFlag) {
                 return createErrorResponse("Serializer info of eiffel-remrem-semantics is missing",
@@ -202,7 +206,6 @@ public String generateMsg(String msgType, JsonObject bodyJson) {
                 return createErrorResponse(msgType, supportedEventTypes);
             }
             Class<? extends Event> eventType = eventTypes.get(eiffelType);
-
             JsonObject msgNodes = null;
             JsonObject eventNodes = null;
             if (bodyJson.get(MSG_PARAMS) != null && bodyJson.get(EVENT_PARAMS) != null
@@ -230,12 +233,10 @@ public String generateMsg(String msgType, JsonObject bodyJson) {
                 return createErrorResponse(eiffelType.getEventName(),
                         "Mismatch of eventype in request query parameter with property 'type' in the input json message");
             }
-
             Event event = eventCreation(eventType, msgNodes, eventNodes);
-
             String result = gson.toJson(event);
-            outputValidate(eiffelType, result);
-            return result;
+            JsonObject outputValidate = outputValidate(eiffelType, result, lenientValidation);
+            return gson.toJson(outputValidate);
 
         } catch (EiffelValidationException e) {
             log.error("Could not validate message. Reason:" + e.getMessage() + "\nCause: " + e.getCause().toString());
@@ -275,12 +276,32 @@ private String createErrorResponse(final String message, final ArrayList<String>
         return errorResponse.toString();
     }
 
-    private void outputValidate(EiffelEventType eiffelType, String jsonStringInput) throws EiffelValidationException {
+    private JsonObject outputValidate(EiffelEventType eiffelType, String jsonStringInput, Boolean lenientValidation) throws EiffelValidationException {
         EiffelValidator validator = EiffelOutputValidatorFactory.getEiffelValidator(eiffelType);
         JsonObject jsonObject = new JsonParser().parse(jsonStringInput).getAsJsonObject();
-        validator.validate(jsonObject);
+        JsonObject validate = validator.validate(jsonObject, lenientValidation);
         // custom validations on an event which is not covered in schema.
-        validator.customValidation(jsonObject);
+        validator.customValidation(validate);
+        return validate;
+    }
+
+    @Override
+    public ValidationResult validateMsg(String msgType, JsonObject jsonvalidateMessage) {
+        return validateMsg(msgType, jsonvalidateMessage, false);
+    }
+
+    @Override
+    public ValidationResult validateMsg(String msgType, JsonObject jsonvalidateMessage, Boolean lenientValidation) {
+        ValidationResult validationResult = null;
+        EiffelEventType eiffelType = EiffelEventType.fromString(msgType);
+        String result = gson.toJson(jsonvalidateMessage);
+        try {
+            outputValidate(eiffelType, result, lenientValidation);
+            validationResult = new ValidationResult(true, "");
+        } catch (EiffelValidationException e) {
+            validationResult = new ValidationResult(false, e.getLocalizedMessage());
+        }
+        return validationResult;
     }
 
     @Override
@@ -381,20 +402,6 @@ public String getServiceName() {
         return EIFFELSEMANTICS;
     }
 
-    @Override
-    public ValidationResult validateMsg(String msgType, JsonObject jsonvalidateMessage) {
-        ValidationResult validationResult = null;
-        EiffelEventType eiffelType = EiffelEventType.fromString(msgType);
-        String result = gson.toJson(jsonvalidateMessage);
-        try {
-            outputValidate(eiffelType, result);
-            validationResult = new ValidationResult(true, "");
-        } catch (EiffelValidationException e) {
-            validationResult = new ValidationResult(false, e.getLocalizedMessage());
-        }
-        return validationResult;
-    }
-
     /**
      * Returns the domain Id from json formatted eiffel message.
      * 
diff --git a/src/main/java/com/ericsson/eiffel/remrem/semantics/validator/EiffelValidator.java b/src/main/java/com/ericsson/eiffel/remrem/semantics/validator/EiffelValidator.java
@@ -20,7 +20,10 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
 
+import javax.xml.bind.ValidationException;
 import org.apache.commons.lang3.StringUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -33,16 +36,29 @@
 import com.github.fge.jsonschema.core.report.ProcessingReport;
 import com.github.fge.jsonschema.main.JsonSchema;
 import com.github.fge.jsonschema.main.JsonSchemaFactory;
-import com.google.gson.Gson;
-import com.google.gson.GsonBuilder;
 import com.google.gson.JsonArray;
 import com.google.gson.JsonElement;
 import com.google.gson.JsonObject;
 import com.google.gson.JsonParser;
+import com.jayway.jsonpath.DocumentContext;
+import com.jayway.jsonpath.JsonPath;
 
 public class EiffelValidator {
-    public static final Logger log = LoggerFactory.getLogger(EiffelValidator.class);
 
+    private static final String REGEX_PATH = "\\/\\d*";
+    private static final String CUSTOM_DATA = "customData";
+    private static final String SLASH = "/";
+    private static final String DOT = ".";
+    private static final String REMREM_GENERATE_FAILURES = "remremGenerateFailures";
+    private static final String PATH = "path";
+    private static final String MESSAGE = "message";
+    private static final String TYPE = "type";
+    private static final String REQUIRED = "required";
+    private static final String POINTER = "pointer";
+    private static final String INSTANCE = "instance";
+    private static final String KEYWORD = "keyword";
+    public static final Logger log = LoggerFactory.getLogger(EiffelValidator.class);
+    private static final String DATA = "data";
     private JsonSchema validationSchema;
     private String schemaResourceName;
     private String eventType;
@@ -73,41 +89,139 @@ public EiffelValidator(String schemaResourceName, String eventType, List<String>
         }
     }
 
-    public void validate(JsonObject jsonObjectInput) throws EiffelValidationException {
+    public JsonObject validate(JsonObject jsonObjectInput) throws EiffelValidationException {
+        return validate(jsonObjectInput, false);
+    }
+
+    public JsonObject validate(JsonObject jsonObjectInput, Boolean lenientValidation) throws EiffelValidationException {
+        JsonArray remremGenerateFailures = new JsonArray();
+        log.debug("VALIDATING Schema used: {}", schemaResourceName);
         try {
-            ProcessingReport report = validationSchema.validate(JsonLoader.fromString(jsonObjectInput.toString()));
-            if (!report.isSuccess()) {
-                log.warn(jsonObjectInput.toString());
-                throw new EiffelValidationException(getErrorsList(report));
+            final ProcessingReport report = validationSchema.validate(JsonLoader.fromString(jsonObjectInput.toString()),
+                    true);
+            if (!report.isSuccess() && lenientValidation) {
+                log.info("Trying to revalidate the Eiffel message with only mandatory Eiffel message fields.");
+                String revalidatedJson = removeErrorProperties(report, jsonObjectInput, remremGenerateFailures);
+                ProcessingReport report2 = validationSchema.validate(JsonLoader.fromString(revalidatedJson), true);
+                handleErrorReport(jsonObjectInput, report2);
+                log.debug("VALIDATED. Schema used: {}", schemaResourceName);
+                return addRemremGenerateFailuresToCustomData(new JsonParser().parse(revalidatedJson).getAsJsonObject(), remremGenerateFailures);
+            } else {
+                handleErrorReport(jsonObjectInput, report);
             }
             log.debug("VALIDATED. Schema used: {}", schemaResourceName);
+            return jsonObjectInput;
         } catch (Exception e) {
-            String message = "Cannot validate given JSON string";
+            final String message = "Cannot validate given JSON string";
             log.debug(message, e);
             throw new EiffelValidationException(message, e);
         }
     }
 
+    private void handleErrorReport(JsonObject jsonObjectInput, ProcessingReport report) throws EiffelValidationException {
+        if (!report.isSuccess()) {
+            throw new EiffelValidationException(getErrorsList(report));
+        }
+    }
+
+    /**
+     * removeErrorProperties for removing the validation failures from Eiffel event and list the validation failures
+     * @param report
+     * @param jsonObjectInput
+     * @param remremGenerateFailures
+     * @return
+     * @throws ValidationException
+     */
+    private String removeErrorProperties(ProcessingReport report, JsonObject jsonObjectInput, JsonArray remremGenerateFailures) throws EiffelValidationException {
+        JsonParser parser = new JsonParser();
+        DocumentContext doc = JsonPath.parse(jsonObjectInput.toString());
+        for (ProcessingMessage processingMessage : report) {
+            if (LogLevel.ERROR.equals(processingMessage.getLogLevel())) {
+                JsonElement element = parser.parse(processingMessage.asJson().toString());
+                if (element.getAsJsonObject().get(KEYWORD).getAsString().equals(REQUIRED) || element.getAsJsonObject().get(KEYWORD).getAsString().equals(TYPE)) {
+                    throw new EiffelValidationException(getErrorsList(report));
+                }
+                String errorPath = element.getAsJsonObject().get(INSTANCE).getAsJsonObject().get(POINTER)
+                        .getAsString();
+                JsonObject addValidationFailurs = addValidationFailures(element, processingMessage.getMessage());
+                remremGenerateFailures.add(addValidationFailurs);
+                doc.delete(getPath(errorPath));
+            }
+        }
+        return doc.jsonString();
+    }
+
+    /**
+     * getPath for create the DocumentContext path from validation failure path
+     * example 
+     * 1) meta/tags/0 --> $.meta.tags[0]
+     * 2) links/0/target --> $.links[0]
+     * 3) /data/outcome/conclusion --> $.data.outcome.conclusion
+     * @param errorPath
+     * @return path
+     */
+    private String getPath(String errorPath) {
+        final Pattern pattern = Pattern.compile(REGEX_PATH, Pattern.MULTILINE);
+        final Matcher matcher = pattern.matcher(errorPath);
+        while (matcher.find()) {
+            if(matcher.group(0).length()>1) {
+                errorPath = errorPath.substring(0, errorPath.indexOf(matcher.group(0))+matcher.group(0).length());
+                errorPath = errorPath.replaceAll(matcher.group(0), "["+matcher.group(0).substring(1)+"]");
+            }
+        }
+        return "$" + errorPath.replace(SLASH, DOT);
+    }
+
+    private JsonObject addValidationFailures(JsonElement element, String message) {
+        log.debug("Adding the error field information to the array");
+        String type = element.getAsJsonObject().get(KEYWORD).getAsString();
+        String path = element.getAsJsonObject().get(INSTANCE).getAsJsonObject().get(POINTER).getAsString();
+        JsonObject object = new JsonObject();
+        object.addProperty(TYPE, type);
+        object.addProperty(MESSAGE, message);
+        object.addProperty(PATH, path);
+        return object;
+    }
+
+    private JsonObject addRemremGenerateFailuresToCustomData(JsonObject inputJson, JsonArray remremGenerateFailures) {
+        if (remremGenerateFailures.size() > 0) {
+            JsonArray customData = getCustomData(inputJson);
+            JsonObject object = new JsonObject();
+            object.addProperty("key", REMREM_GENERATE_FAILURES);
+            object.add("value", remremGenerateFailures);
+            customData.add(object);
+        }
+        return inputJson;
+    }
+
+    /**
+     * Gets the customData array from an Eiffel message
+     * @param Eiffel message
+     * @return customData array
+     */
+    public JsonArray getCustomData(JsonObject json) {
+        if (json.isJsonObject() && json.getAsJsonObject().has(DATA)
+                && json.getAsJsonObject().getAsJsonObject(DATA).has(CUSTOM_DATA)) {
+            return json.getAsJsonObject().getAsJsonObject(DATA).get(CUSTOM_DATA).getAsJsonArray();
+        }
+        return null;
+    }
+
     /**
      *
      * @param report json validation report
      * @return error message
      */
-    private String getErrorsList(ProcessingReport report) {
-        Gson gson = new GsonBuilder().setPrettyPrinting().create();
-        JsonParser parser = new JsonParser();
-        String message = "";
-        for (ProcessingMessage processingMessage : report) {
-            if(LogLevel.ERROR.equals(processingMessage.getLogLevel())) {
-                JsonElement element=parser.parse(processingMessage.asJson().toString());
-                element.getAsJsonObject().remove("schema");
-                element.getAsJsonObject().remove("level");
-                message = gson.toJson(element);
-                log.debug(message);
+    private String getErrorsList(final ProcessingReport report) {
+        List<String> messages = new ArrayList<String>();
+        for (final ProcessingMessage processingMessage : report) {
+            if (LogLevel.ERROR.equals(processingMessage.getLogLevel())) {
+                messages.add(processingMessage.getMessage().toString());
             }
         }
-        return message;
+        return messages.toString();
     }
+
     /**
      * This method is used to validate links in an event
      * @param JsonArray of links in an event
diff --git a/src/test/java/com/ericsson/eiffel/remrem/semantics/ServiceTest.java b/src/test/java/com/ericsson/eiffel/remrem/semantics/ServiceTest.java
diff --git a/src/test/resources/invalid/lv_EiffelArtifactCreatedEventInvalid.json b/src/test/resources/invalid/lv_EiffelArtifactCreatedEventInvalid.json
