Moved ErrorHandler to separate class to make it testable.

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

Author: Dennis Labordus

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

@@ -0,0 +1,64 @@
+// SPDX-FileCopyrightText: 2022 Alliander N.V.
+//
+// SPDX-License-Identifier: Apache-2.0
+package org.lfenergy.compas.scl.validator.xsd;
+
+import org.lfenergy.compas.scl.validator.model.ValidationError;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.xml.sax.ErrorHandler;
+import org.xml.sax.SAXParseException;
+
+import java.util.List;
+
+public class XSDErrorHandler implements ErrorHandler {
+    private static final Logger LOGGER = LoggerFactory.getLogger(XSDErrorHandler.class);
+
+    private List<ValidationError> errorList;
+
+    public XSDErrorHandler(List<ValidationError> errorList) {
+        this.errorList = errorList;
+    }
+
+    @Override
+    public void warning(SAXParseException exception) {
+        var validationError = createValidationError(exception);
+        errorList.add(validationError);
+
+        LOGGER.debug("XSD Validation - warning: '{}' (Linenumber {}, Column number {})",
+                validationError.getMessage(),
+                validationError.getLinenumber(),
+                validationError.getColumnNumber());
+    }
+
+    @Override
+    public void error(SAXParseException exception) {
+        var validationError = createValidationError(exception);
+        errorList.add(validationError);
+
+        LOGGER.debug("XSD Validation - error: '{}' (Linenumber {}, Column number {})",
+                validationError.getMessage(),
+                validationError.getLinenumber(),
+                validationError.getColumnNumber());
+    }
+
+    @Override
+    public void fatalError(SAXParseException exception) {
+        var validationError = createValidationError(exception);
+        errorList.add(validationError);
+
+        LOGGER.debug("XSD Validation - fatal error, stopping: '{}' (Linenumber {}, Column number {})",
+                validationError.getMessage(),
+                validationError.getLinenumber(),
+                validationError.getColumnNumber());
+    }
+
+    private ValidationError createValidationError(SAXParseException exception) {
+        var validationError = new ValidationError();
+        validationError.setMessage(exception.getMessage());
+        validationError.setRuleName("XSD validation");
+        validationError.setLinenumber(exception.getLineNumber());
+        validationError.setColumnNumber(exception.getColumnNumber());
+        return validationError;
+    }
+}

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

@@ -8,10 +8,8 @@
 import org.lfenergy.compas.scl.validator.xsd.resourceresolver.ResourceResolver;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import org.xml.sax.ErrorHandler;
 import org.xml.sax.InputSource;
 import org.xml.sax.SAXException;
-import org.xml.sax.SAXParseException;
 
 import javax.xml.XMLConstants;
 import javax.xml.transform.sax.SAXSource;
@@ -42,26 +40,10 @@ public XSDValidator(List<ValidationError> errorList, String sclData) {
             var schema = factory.newSchema(
                     new StreamSource(getClass().getClassLoader().getResourceAsStream("xsd/SCL" + sclVersion + "/SCL.xsd")));
             validator = schema.newValidator();
+            validator.setErrorHandler(new XSDErrorHandler(errorList));
         } catch (SAXException exception) {
             throw new SclValidatorException(LOADING_XSD_FILE_ERROR_CODE, exception.getMessage());
         }
-
-        validator.setErrorHandler(new ErrorHandler() {
-            @Override
-            public void warning(SAXParseException exception) {
-                errorList.add(createValidationError(exception, "warning"));
-            }
-
-            @Override
-            public void error(SAXParseException exception) {
-                errorList.add(createValidationError(exception, "error"));
-            }
-
-            @Override
-            public void fatalError(SAXParseException exception) {
-                errorList.add(createValidationError(exception, "fatal"));
-            }
-        });
     }
 
     public void validate() {
@@ -72,20 +54,4 @@ public void validate() {
             LOGGER.error("[XSD validation] Exception: {}", exception.getMessage());
         }
     }
-
-    private ValidationError createValidationError(SAXParseException exception, String type) {
-        var validationError = new ValidationError();
-        validationError.setMessage(exception.getMessage());
-        validationError.setRuleName("XSD validation");
-        validationError.setLinenumber(exception.getLineNumber());
-        validationError.setColumnNumber(exception.getColumnNumber());
-
-        LOGGER.debug("XSD Validation - {}: '{}' (Linenumber {}, Column number {})",
-                type,
-                validationError.getMessage(),
-                validationError.getLinenumber(),
-                validationError.getColumnNumber());
-
-        return validationError;
-    }
 }

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

@@ -0,0 +1,57 @@
+package org.lfenergy.compas.scl.validator.xsd;
+
+import org.junit.jupiter.api.Test;
+import org.lfenergy.compas.scl.validator.model.ValidationError;
+import org.xml.sax.SAXParseException;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+class XSDErrorHandlerTest {
+    private List<ValidationError> errorList = new ArrayList<>();
+    private XSDErrorHandler handler = new XSDErrorHandler(errorList);
+
+    @Test
+    void warning_WhenCalled_ThenNewValidationErrorAddedToList() {
+        var message = "Some Warning Message";
+        var linenumber = 3;
+        var columnNumber = 15;
+
+        handler.warning(new SAXParseException(message, "", "", linenumber, columnNumber));
+
+        assertEquals(1, errorList.size());
+        assertValidationError(errorList.get(0), message, linenumber, columnNumber);
+    }
+
+    @Test
+    void error_WhenCalled_ThenNewValidationErrorAddedToList() {
+        var message = "Some Error Message";
+        var linenumber = 5;
+        var columnNumber = 25;
+
+        handler.error(new SAXParseException(message, "", "", linenumber, columnNumber));
+
+        assertEquals(1, errorList.size());
+        assertValidationError(errorList.get(0), message, linenumber, columnNumber);
+    }
+
+    @Test
+    void fatalError_WhenCalled_ThenNewValidationErrorAddedToList() {
+        var message = "Some Error Message";
+        var linenumber = 5;
+        var columnNumber = 25;
+
+        handler.fatalError(new SAXParseException(message, "", "", linenumber, columnNumber));
+
+        assertEquals(1, errorList.size());
+        assertValidationError(errorList.get(0), message, linenumber, columnNumber);
+    }
+
+    private void assertValidationError(ValidationError validationError, String message, int linenumber, int columnNumber) {
+        assertEquals(message, validationError.getMessage());
+        assertEquals(linenumber, validationError.getLinenumber());
+        assertEquals(columnNumber, validationError.getColumnNumber());
+    }
+}