Merge pull request #47 from com-pas/validation-exception-handling

Add validation constraint and common exception handling.

Author: Rob Tjalma

commons/pom.xml

@@ -18,6 +18,11 @@ SPDX-License-Identifier: Apache-2.0
     <packaging>jar</packaging>
 
     <dependencies>
+        <dependency>
+            <groupId>jakarta.validation</groupId>
+            <artifactId>jakarta.validation-api</artifactId>
+        </dependency>
+
         <dependency>
             <groupId>jakarta.xml.bind</groupId>
             <artifactId>jakarta.xml.bind-api</artifactId>
@@ -57,5 +62,15 @@ SPDX-License-Identifier: Apache-2.0
             <artifactId>slf4j-simple</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.hibernate.validator</groupId>
+            <artifactId>hibernate-validator</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.glassfish</groupId>
+            <artifactId>jakarta.el</artifactId>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 </project>

commons/src/main/java/org/lfenergy/compas/core/commons/constraint/XmlAnyElementValid.java

@@ -0,0 +1,35 @@
+// SPDX-FileCopyrightText: 2021 Alliander N.V.
+//
+// SPDX-License-Identifier: Apache-2.0
+package org.lfenergy.compas.core.commons.constraint;
+
+import org.lfenergy.compas.core.commons.constraint.impl.XmlAnyElementConstraintValidator;
+
+import javax.validation.Constraint;
+import javax.validation.Payload;
+import java.lang.annotation.Documented;
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+import static java.lang.annotation.ElementType.*;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
+/**
+ * Annotation to check if a List of XML Elements (mostly annotated with XmlAnyElement) contains a specific number
+ * of elements and also the expected Element (Name) with the correct namespace.
+ */
+@Target({FIELD, METHOD, PARAMETER, ANNOTATION_TYPE, TYPE_USE})
+@Retention(RUNTIME)
+@Constraint(validatedBy = {XmlAnyElementConstraintValidator.class})
+@Documented
+public @interface XmlAnyElementValid {
+    String message() default "{org.lfenergy.compas.XmlAnyElementValid.unexpected.message}";
+
+    Class<?>[] groups() default {};
+
+    Class<? extends Payload>[] payload() default {};
+
+    String elementName();
+
+    String elementNamespace();
+}

commons/src/main/java/org/lfenergy/compas/core/commons/constraint/impl/XmlAnyElementConstraintValidator.java

@@ -0,0 +1,43 @@
+// SPDX-FileCopyrightText: 2021 Alliander N.V.
+//
+// SPDX-License-Identifier: Apache-2.0
+package org.lfenergy.compas.core.commons.constraint.impl;
+
+import org.lfenergy.compas.core.commons.constraint.XmlAnyElementValid;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.w3c.dom.Element;
+
+import javax.validation.ConstraintValidator;
+import javax.validation.ConstraintValidatorContext;
+import java.util.List;
+
+/**
+ * Validator to execute the check on fields annotated with {@link XmlAnyElementValid} to check if the number of
+ * element are correct and also if the element(s) in the list have the correct Local Name and the correct Namespace.
+ */
+public class XmlAnyElementConstraintValidator implements ConstraintValidator<XmlAnyElementValid, List<Element>> {
+    private static final Logger LOGGER = LoggerFactory.getLogger(XmlAnyElementConstraintValidator.class);
+
+    private String elementName;
+    private String elementNamespace;
+
+    @Override
+    public void initialize(XmlAnyElementValid constraintAnnotation) {
+        LOGGER.debug("Initializing XmlAnyElementValid constraint for List of Elements");
+        this.elementName = constraintAnnotation.elementName();
+        this.elementNamespace = constraintAnnotation.elementNamespace();
+    }
+
+    @Override
+    public boolean isValid(List<Element> elements, ConstraintValidatorContext context) {
+        // Check if there are elements in the List that don't match the name or namespace.
+        var numberOfIncorrectElements =
+                elements.stream()
+                        .filter(element ->
+                                !elementName.equals(element.getLocalName())
+                                        || !elementNamespace.equals(element.getNamespaceURI()))
+                        .count();
+        return numberOfIncorrectElements == 0;
+    }
+}

commons/src/main/java/org/lfenergy/compas/core/commons/exception/CompasErrorCode.java

@@ -19,4 +19,8 @@ public class CompasErrorCode {
 
     public static final String CONVERT_TO_STRING_ERROR = "CORE-1000";
     public static final String CONVERT_TO_ELEMENT_ERROR = "CORE-1001";
+
+    public static final String VALIDATION_ERROR = "CORE-8000";
+
+    public static final String UNKNOWN_EXCEPTION_ERROR = "CORE-9999";
 }

commons/src/main/java/org/lfenergy/compas/core/commons/exception/CompasValidationException.java

@@ -0,0 +1,87 @@
+// SPDX-FileCopyrightText: 2021 Alliander N.V.
+//
+// SPDX-License-Identifier: Apache-2.0
+package org.lfenergy.compas.core.commons.constraint.impl;
+
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.lfenergy.compas.core.commons.constraint.XmlAnyElementValid;
+import org.w3c.dom.Document;
+import org.w3c.dom.Element;
+
+import javax.validation.Validation;
+import javax.validation.Validator;
+import javax.xml.parsers.DocumentBuilderFactory;
+import javax.xml.parsers.ParserConfigurationException;
+import java.util.ArrayList;
+import java.util.List;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+class XmlAnyElementConstraintValidatorTest {
+    private static final String ELEMENT_NAME = "valid";
+    private static final String ELEMENT_NS = "https://valid.org";
+
+    private Document document;
+    private Validator validator;
+
+    @BeforeEach
+    void setupValidator() throws ParserConfigurationException {
+        var documentFactory = DocumentBuilderFactory.newInstance();
+        var documentBuilder = documentFactory.newDocumentBuilder();
+        document = documentBuilder.newDocument();
+
+        var factory = Validation.buildDefaultValidatorFactory();
+        validator = factory.getValidator();
+    }
+
+    @Test
+    void isValid_WhenCalledWithCorrectElement_ThenNoViolations() {
+        var simplePojo = new SimplePojo();
+        simplePojo.getElements().add(document.createElementNS(ELEMENT_NS, ELEMENT_NAME));
+
+        var violations = validator.validate(simplePojo);
+        assertTrue(violations.isEmpty());
+    }
+
+    @Test
+    void isValid_WhenCalledWithIncorrectElement_ThenViolationFound() {
+        var simplePojo = new SimplePojo();
+        simplePojo.getElements().add(document.createElementNS("https://OtherNS.org", "Other"));
+
+        var violations = validator.validate(simplePojo);
+        assertEquals(1, violations.size());
+    }
+
+    @Test
+    void isValid_WhenCalledWithMultipleElementAndOneIncorrect_ThenViolationFound() {
+        var simplePojo = new SimplePojo();
+        simplePojo.getElements().add(document.createElementNS("https://OtherNS.org", "Other"));
+        simplePojo.getElements().add(document.createElementNS(ELEMENT_NS, ELEMENT_NAME));
+        simplePojo.getElements().add(document.createElementNS(ELEMENT_NS, ELEMENT_NAME));
+
+        var violations = validator.validate(simplePojo);
+        assertEquals(1, violations.size());
+    }
+
+    @Test
+    void isValid_WhenCalledWithMultipleElementAndOneIncorrectNS_ThenViolationFound() {
+        var simplePojo = new SimplePojo();
+        simplePojo.getElements().add(document.createElementNS("https://OtherNS.org", ELEMENT_NAME));
+        simplePojo.getElements().add(document.createElementNS(ELEMENT_NS, ELEMENT_NAME));
+        simplePojo.getElements().add(document.createElementNS(ELEMENT_NS, ELEMENT_NAME));
+
+        var violations = validator.validate(simplePojo);
+        assertEquals(1, violations.size());
+    }
+
+    private static final class SimplePojo {
+        @XmlAnyElementValid(elementName = ELEMENT_NAME, elementNamespace = ELEMENT_NS)
+        private List<Element> elements = new ArrayList<>();
+
+        public List<Element> getElements() {
+            return elements;
+        }
+    }
+}

commons/src/test/java/org/lfenergy/compas/core/commons/constraint/impl/XmlAnyElementConstraintValidatorTest.java

@@ -8,4 +8,4 @@ compas:
   scl:
     schemas:
       - xsdPath: "xsd/xml-element.xsd"
-        namespace: "https://www.lfenergy.org/compas/v1"
+        namespace: "https://www.lfenergy.org/compas/extension/v1"

commons/src/test/java/org/lfenergy/compas/core/commons/exception/CompasValidationExceptionTest.java

@@ -8,5 +8,5 @@ compas:
   scl:
     schemas:
       - xsdPath: "xsd/xml-element.xsd"
-        namespace: "https://www.lfenergy.org/compas/v1"
+        namespace: "https://www.lfenergy.org/compas/extension/v1"
         contextPath: "org.lfenergy.compas.scl.extensions.model.unknown"

commons/src/test/resources/invalid-configs/marshaller-invalid-config.yml

@@ -8,5 +8,5 @@ compas:
   scl:
     schemas:
       - xsdPath: "invalid/xml-element.xsd"
-        namespace: "https://www.lfenergy.org/compas/v1"
+        namespace: "https://www.lfenergy.org/compas/extension/v1"
         contextPath: "org.lfenergy.compas.scl.extensions.model"