Changed the way XSD Message are processed. Trying to extract rule from message.

Signed-off-by: Dennis Labordus <[email protected]>

Author: Dennis Labordus

validator/src/main/java/org/lfenergy/compas/scl/validator/xsd/XSDErrorHandler.java

@@ -14,6 +14,9 @@
 public class XSDErrorHandler implements ErrorHandler {
     private static final Logger LOGGER = LoggerFactory.getLogger(XSDErrorHandler.class);
 
+    public static final String DEFAULT_PREFIX = "XSD/";
+    public static final String DEFAULT_RULE_NAME = DEFAULT_PREFIX + "general";
+
     private List<ValidationError> errorList;
 
     public XSDErrorHandler(List<ValidationError> errorList) {
@@ -55,10 +58,39 @@ public void fatalError(SAXParseException exception) {
 
     private ValidationError createValidationError(SAXParseException exception) {
         var validationError = new ValidationError();
-        validationError.setMessage(exception.getMessage());
-        validationError.setRuleName("XSD validation");
+        var xsdMessage = exception.getMessage();
+        validationError.setMessage(getMessage(xsdMessage));
+        validationError.setRuleName(getRuleName(xsdMessage));
         validationError.setLinenumber(exception.getLineNumber());
         validationError.setColumnNumber(exception.getColumnNumber());
         return validationError;
     }
+
+    String getRuleName(String xsdMessage) {
+        var ruleName = DEFAULT_RULE_NAME;
+        if (xsdMessage != null && !xsdMessage.isBlank()) {
+            int endIndex = xsdMessage.indexOf(':');
+            if (endIndex > 0) {
+                var tmpRuleName = xsdMessage.substring(0, endIndex);
+                if (!tmpRuleName.contains(" ")) {
+                    ruleName = "XSD/" + tmpRuleName;
+                }
+            }
+        }
+        return ruleName;
+    }
+
+    String getMessage(String xsdMessage) {
+        var message = xsdMessage;
+        if (message != null && !message.isBlank()) {
+            int endIndex = message.indexOf(':');
+            if (endIndex > 0) {
+                var tmpRuleName = xsdMessage.substring(0, endIndex);
+                if (!tmpRuleName.contains(" ")) {
+                    message = message.substring(endIndex + 1).trim();
+                }
+            }
+        }
+        return message;
+    }
 }

validator/src/test/java/org/lfenergy/compas/scl/validator/xsd/XSDErrorHandlerTest.java

@@ -11,6 +11,8 @@
 import java.util.List;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.lfenergy.compas.scl.validator.xsd.XSDErrorHandler.DEFAULT_PREFIX;
+import static org.lfenergy.compas.scl.validator.xsd.XSDErrorHandler.DEFAULT_RULE_NAME;
 
 class XSDErrorHandlerTest {
     private List<ValidationError> errorList = new ArrayList<>();
@@ -57,4 +59,62 @@ private void assertValidationError(ValidationError validationError, String messa
         assertEquals(linenumber, validationError.getLinenumber());
         assertEquals(columnNumber, validationError.getColumnNumber());
     }
+
+    @Test
+    void getRuleName_WhenXSDMessageContainsNoRule_ThenDefaultXSDRuleNameReturned() {
+        var xsdMessage = "Duplicate match in scope for field \"depth\"";
+
+        var ruleName = handler.getRuleName(xsdMessage);
+
+        assertEquals(DEFAULT_RULE_NAME, ruleName);
+    }
+
+    @Test
+    void getRuleName_WhenXSDMessageContainsRuleWithSpaces_ThenDefaultXSDRuleNameReturned() {
+        var xsdMessage = "SOME SPACES RULE: Duplicate match in scope for field \"depth\"";
+
+        var ruleName = handler.getRuleName(xsdMessage);
+
+        assertEquals(DEFAULT_RULE_NAME, ruleName);
+    }
+
+    @Test
+    void getRuleName_WhenXSDMessageContainsRule_ThenRuleNameReturned() {
+        var expectedRuleName = "cvc-complex-type.2.1";
+        var xsdMessage = expectedRuleName + ": Element 'depth' must have no character or element information " +
+                "item [children], because the type's content type is empty.";
+
+        var ruleName = handler.getRuleName(xsdMessage);
+
+        assertEquals(DEFAULT_PREFIX + expectedRuleName, ruleName);
+    }
+
+    @Test
+    void getMessage_WhenXSDMessageContainsNoRule_ThenOriginalMessageReturned() {
+        var xsdMessage = "Duplicate match in scope for field \"depth\"";
+
+        var message = handler.getMessage(xsdMessage);
+
+        assertEquals(xsdMessage, message);
+    }
+
+    @Test
+    void getMessage_WhenXSDMessageContainsRuleWithSpaces_ThenOriginalMessageReturned() {
+        var xsdMessage = "SOME SPACES RULE: Duplicate match in scope for field \"depth\"";
+
+        var message = handler.getMessage(xsdMessage);
+
+        assertEquals(xsdMessage, message);
+    }
+
+    @Test
+    void getMessage_WhenXSDMessageContainsRule_ThenRuleNameIsStrippedFromMessage() {
+        var ruleName = "cvc-complex-type.2.1";
+        var expectedMessage = "Element 'depth' must have no character or element information item [children], " +
+                "because the type's content type is empty.";
+
+        var message = handler.getMessage(ruleName + ": " + expectedMessage);
+
+        assertEquals(expectedMessage, message);
+    }
 }

validator/src/test/java/org/lfenergy/compas/scl/validator/xsd/XSDValidatorTest.java

@@ -39,8 +39,8 @@ void validate_WhenCalledWithSclDataWithXsdValidationErrors_ThenErrorsAreRetrieve
             assertEquals(4, errorList.size());
 
             var error = errorList.get(2);
-            assertEquals("cvc-complex-type.4: Attribute 'name' must appear on element 'BDA'.", error.getMessage());
-            assertEquals("XSD validation", error.getRuleName());
+            assertEquals("Attribute 'name' must appear on element 'BDA'.", error.getMessage());
+            assertEquals("XSD/cvc-complex-type.4", error.getRuleName());
             assertEquals(66, error.getLinenumber());
             assertEquals(45, error.getColumnNumber());
         }