Merge pull request #52 from com-pas/fix-namespace-scl

Make sure the SCL Namespace is the default namespace

Author: Rob Tjalma

app/src/main/java/org/lfenergy/compas/scl/data/rest/CompasSclDataServiceConfiguration.java

@@ -0,0 +1,30 @@
+// SPDX-FileCopyrightText: 2021 Alliander N.V.
+//
+// SPDX-License-Identifier: Apache-2.0
+package org.lfenergy.compas.scl.data.rest;
+
+import org.lfenergy.compas.core.commons.ElementConverter;
+import org.lfenergy.compas.scl.data.util.SclDataModelMarshaller;
+import org.lfenergy.compas.scl.data.util.SclElementProcessor;
+
+import javax.enterprise.inject.Produces;
+
+/**
+ * Create Beans from other dependencies that are used in the application.
+ */
+public class CompasSclDataServiceConfiguration {
+    @Produces
+    public ElementConverter createElementConverter() {
+        return new ElementConverter();
+    }
+
+    @Produces
+    public SclElementProcessor creatSclElementProcessor() {
+        return new SclElementProcessor();
+    }
+
+    @Produces
+    public SclDataModelMarshaller createSclDataModelMarshaller() {
+        return new SclDataModelMarshaller();
+    }
+}

app/src/test/java/org/lfenergy/compas/scl/data/rest/CompasSclDataServiceConfigurationTest.java

@@ -0,0 +1,27 @@
+// SPDX-FileCopyrightText: 2021 Alliander N.V.
+//
+// SPDX-License-Identifier: Apache-2.0
+package org.lfenergy.compas.scl.data.rest;
+
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+
+class CompasSclDataServiceConfigurationTest {
+    private CompasSclDataServiceConfiguration configuration = new CompasSclDataServiceConfiguration();
+
+    @Test
+    void createElementConverter_WhenCalled_ThenObjectReturned() {
+        assertNotNull(configuration.createElementConverter());
+    }
+
+    @Test
+    void creatSclElementProcessor_WhenCalled_ThenObjectReturned() {
+        assertNotNull(configuration.creatSclElementProcessor());
+    }
+
+    @Test
+    void createSclDataModelMarshaller_WhenCalled_ThenObjectReturned() {
+        assertNotNull(configuration.createSclDataModelMarshaller());
+    }
+}

repository-basex/src/main/java/org/lfenergy/compas/scl/data/repository/CompasSclDataBaseXRepository.java

@@ -30,6 +30,14 @@
 import static org.lfenergy.compas.scl.data.exception.CompasSclDataServiceErrorCode.BASEX_COMMAND_ERROR_CODE;
 import static org.lfenergy.compas.scl.data.exception.CompasSclDataServiceErrorCode.BASEX_QUERY_ERROR_CODE;
 
+/**
+ * This implementation of the repository will store the SCL XML Files in BaseX, this is a XML Database.
+ * For more information see https://basex.org/.
+ * <p>
+ * For every type of SCL a separate database is created in which the SCL XML Files are stored.
+ * every entries is stored under &lt;ID&gt;/&lt;Major version&gt;/&lt;Minor version&gt;/&lt;Patch version&gt;/scl.xml.
+ * This combination is always unique and easy to use.
+ */
 @ApplicationScoped
 public class CompasSclDataBaseXRepository implements CompasSclDataRepository {
     private static final Logger LOGGER = LoggerFactory.getLogger(CompasSclDataBaseXRepository.class);
@@ -58,11 +66,12 @@ public class CompasSclDataBaseXRepository implements CompasSclDataRepository {
     private final ElementConverter elementConverter;
 
     @Inject
-    public CompasSclDataBaseXRepository(BaseXClientFactory baseXClientFactory) {
+    public CompasSclDataBaseXRepository(BaseXClientFactory baseXClientFactory,
+                                        ElementConverter elementConverter,
+                                        SclDataModelMarshaller sclDataMarshaller) {
         this.baseXClientFactory = baseXClientFactory;
-        
-        this.sclDataMarshaller = new SclDataModelMarshaller();
-        this.elementConverter = new ElementConverter();
+        this.sclDataMarshaller = sclDataMarshaller;
+        this.elementConverter = elementConverter;
 
         // At startup create all needed databases.
         Arrays.stream(SclType.values()).forEach(type ->

repository-basex/src/test/java/org/lfenergy/compas/scl/data/repository/CompasSclDataBaseXRepositoryTest.java

@@ -14,6 +14,7 @@
 import org.lfenergy.compas.scl.data.model.ChangeSetType;
 import org.lfenergy.compas.scl.data.model.SclType;
 import org.lfenergy.compas.scl.data.model.Version;
+import org.lfenergy.compas.scl.data.util.SclDataModelMarshaller;
 import org.lfenergy.compas.scl.data.util.SclElementProcessor;
 import org.mockito.junit.jupiter.MockitoExtension;
 import org.w3c.dom.Element;
@@ -23,7 +24,8 @@
 import static org.junit.jupiter.api.Assertions.*;
 import static org.lfenergy.compas.scl.data.Constants.*;
 import static org.lfenergy.compas.scl.data.basex.BaseXServerUtil.createClientFactory;
-import static org.lfenergy.compas.scl.data.exception.CompasSclDataServiceErrorCode.*;
+import static org.lfenergy.compas.scl.data.exception.CompasSclDataServiceErrorCode.BASEX_QUERY_ERROR_CODE;
+import static org.lfenergy.compas.scl.data.exception.CompasSclDataServiceErrorCode.HEADER_NOT_FOUND_ERROR_CODE;
 
 @ExtendWith({MockitoExtension.class, BaseXServerJUnitExtension.class})
 class CompasSclDataBaseXRepositoryTest {
@@ -35,6 +37,7 @@ class CompasSclDataBaseXRepositoryTest {
 
     private final ElementConverter converter = new ElementConverter();
     private final SclElementProcessor processor = new SclElementProcessor();
+    private final SclDataModelMarshaller marshaller = new SclDataModelMarshaller();
 
     @BeforeAll
     static void beforeAll() {
@@ -44,7 +47,7 @@ static void beforeAll() {
     @BeforeEach
     void beforeEach() throws Exception {
         factory.createClient().executeXQuery("db:create('" + TYPE + "')");
-        repository = new CompasSclDataBaseXRepository(factory);
+        repository = new CompasSclDataBaseXRepository(factory, converter, marshaller);
     }
 
     @Test

repository/src/main/java/org/lfenergy/compas/scl/data/repository/CompasSclDataRepository.java

@@ -11,18 +11,75 @@
 import java.util.List;
 import java.util.UUID;
 
+/**
+ * Repository class that will be used to handle SCL File for a specific type of storage.
+ * The repository class needs to be able to create and delete entries and find/list entries.
+ */
 public interface CompasSclDataRepository {
+    /**
+     * List the latest version of all SCL Entries for a type of SCL.
+     *
+     * @param type The type of SCL to search for.
+     * @return The list of entries found for the passed type.
+     */
     List<Item> list(SclType type);
 
+    /**
+     * List all versions for a specific SCL Entry for a type of SCL.
+     *
+     * @param type The type of SCL to search for the specific SCL.
+     * @param id   The ID of the SCL to search for.
+     * @return The list of versions found for that specific sCl Entry.
+     */
     List<Item> listVersionsByUUID(SclType type, UUID id);
 
+    /**
+     * Return the latest version of a specific SCL Entry.
+     *
+     * @param type The type of SCL to search for the specific SCL.
+     * @param id   The ID of the SCL to search for.
+     * @return The SCL XML File Content that is search for.
+     */
     Element findByUUID(SclType type, UUID id);
 
+    /**
+     * Return the specific version of a specific SCL Entry.
+     *
+     * @param type    The type of SCL to search for the specific SCL.
+     * @param id      The ID of the SCL to search for.
+     * @param version The version of the ScL to search for.
+     * @return The SCL XML File Content that is search for.
+     */
     Element findByUUID(SclType type, UUID id, Version version);
 
+    /**
+     * Create a new entry for the passed UUID with the version number passed.
+     * <p>
+     * For a complete new entry the service layer will create a new UUID and set the version to 1.0.0.
+     * When a entry is updated the service layer will increase the version and always create a new entry
+     * in the repository.
+     *
+     * @param type    The type of SCL to store it in.
+     * @param id      The ID of the new entry to be created.
+     * @param scl     The SCL XML File content to store.
+     * @param version The version of the new entry to be created.
+     */
     void create(SclType type, UUID id, Element scl, Version version);
 
+    /**
+     * Delete all versions for a specific SCL File using it's ID.
+     *
+     * @param type The type of SCL where to find the SCL File
+     * @param id   The ID of the SCL File to delete.
+     */
     void delete(SclType type, UUID id);
 
+    /**
+     * Delete passed versions for a specific SCL File using it's ID.
+     *
+     * @param type    The type of SCL where to find the SCL File
+     * @param id      The ID of the SCL File to delete.
+     * @param version The version of that SCL File to delete.
+     */
     void delete(SclType type, UUID id, Version version);
 }

repository/src/main/java/org/lfenergy/compas/scl/data/util/SclElementProcessor.java

@@ -6,34 +6,103 @@
 import org.lfenergy.compas.scl.data.exception.CompasSclDataServiceException;
 import org.w3c.dom.Element;
 import org.w3c.dom.Node;
+import org.w3c.dom.NodeList;
 
-import java.util.ArrayList;
-import java.util.List;
-import java.util.Optional;
+import java.util.*;
 
 import static org.lfenergy.compas.scl.data.Constants.*;
 import static org.lfenergy.compas.scl.data.exception.CompasSclDataServiceErrorCode.HEADER_NOT_FOUND_ERROR_CODE;
+import static org.w3c.dom.Node.ELEMENT_NODE;
 
+/**
+ * Support class to work with the SCL XML in a generic way as W3C Element/Node class.
+ * This way multiple versions of the SCL XSD can easily be supported.
+ */
 public class SclElementProcessor {
+    /**
+     * Make sure that the SCL XSD Namespace will be the default namespace used on the passed
+     * Node and all it's child nodes. Attributes aren't fixed, because these use the "null" namespace
+     * as they are marked as "unqualified" in the XSD (attributeFormDefault="unqualified").
+     *
+     * @param root The root node from which to start, will mostly be the SCL XML Element.
+     */
+    public void fixDefaultPrefix(Node root) {
+        var oldNamespacePrefixes = new HashSet<String>();
+        // Use a stack to walk through all child nodes.
+        var nodes = new Stack<Node>();
+        // Start with the root node.
+        nodes.push(root);
+
+        while (!nodes.isEmpty()) {
+            var node = nodes.pop();
+            if (SCL_NS_URI.equals(node.getNamespaceURI())
+                    && node.getPrefix() != null && !node.getPrefix().isBlank()) {
+                // The namespace is the SCL XSD Namespace, but with a prefix, so we will fix that.
+                oldNamespacePrefixes.add(node.getPrefix());
+                node.setPrefix("");
+            }
+
+            // Push all the Child Nodes (Type Element) on the Stack and continue with these.
+            NodeList childNodes = node.getChildNodes();
+            if (childNodes != null) {
+                for (int i = 0, count = childNodes.getLength(); i < count; ++i) {
+                    var childNode = childNodes.item(i);
+                    if (childNode.getNodeType() == ELEMENT_NODE) {
+                        nodes.push(childNode);
+                    }
+                }
+            }
+        }
+
+        oldNamespacePrefixes.forEach(
+                prefix -> root.getAttributes().removeNamedItem("xmlns:" + prefix)
+        );
+    }
+
+    /**
+     * Search for the SCL Header in the SCL Root Element and return that.
+     *
+     * @param scl The SCL Root Element
+     * @return The Header Element if found or empty() if not.
+     */
     public Optional<Element> getSclHeader(Element scl) {
         return getChildNodesByName(scl, SCL_HEADER_ELEMENT_NAME).stream()
                 .findFirst();
     }
 
+    /**
+     * Add the SCL Header ot the SCL Root Element, because that element is important for the SCL Data Service
+     * we want to make sure it's there.
+     *
+     * @param scl The SCL Root Element
+     * @return The new created Header Element.
+     */
     public Element addSclHeader(Element scl) {
         var header = scl.getOwnerDocument().createElementNS(SCL_NS_URI, SCL_HEADER_ELEMENT_NAME);
         header.setPrefix(SCL_NS_PREFIX);
         scl.insertBefore(header, scl.getFirstChild());
         return header;
     }
 
+    /**
+     * Search for the private element with type "#Constants.COMPAS_SCL_EXTENSION_TYPE" on the SCL Root Element.
+     *
+     * @param scl The SCL Root Element
+     * @return The Private Element with the correct type if found or empty() if not.
+     */
     public Optional<Element> getCompasPrivate(Element scl) {
         return getChildNodesByName(scl, SCL_PRIVATE_ELEMENT_NAME).stream()
                 .filter(element -> element.hasAttribute(SCL_PRIVATE_TYPE_ATTR))
                 .filter(element -> element.getAttribute(SCL_PRIVATE_TYPE_ATTR).equals(COMPAS_SCL_EXTENSION_TYPE))
                 .findFirst();
     }
 
+    /**
+     * Create a Private Element with type "#COMPAS_SCL_EXTENSION_TYPE" on the SCL Root Element.
+     *
+     * @param scl The SCL Root Element
+     * @return The new created Private Element with the correct type.
+     */
     public Element addCompasPrivate(Element scl) {
         scl.setAttribute("xmlns:" + COMPAS_EXTENSION_NS_PREFIX, COMPAS_EXTENSION_NS_URI);
 
@@ -47,7 +116,14 @@ public Element addCompasPrivate(Element scl) {
         return tPrivate;
     }
 
-
+    /**
+     * Add a new element with namespace "#COMPAS_EXTENSION_NS_URI" to the Private element of CoMPAS.
+     *
+     * @param compasPrivate The Private Element on which to add the new Element.
+     * @param localName     The name of the Element to create.
+     * @param value         The value set on the new Element.
+     * @return The new created Element.
+     */
     public Element addCompasElement(Element compasPrivate, String localName, String value) {
         Element element = compasPrivate.getOwnerDocument().createElementNS(COMPAS_EXTENSION_NS_URI, localName);
         element.setPrefix(COMPAS_EXTENSION_NS_PREFIX);
@@ -56,17 +132,38 @@ public Element addCompasElement(Element compasPrivate, String localName, String
         return element;
     }
 
+    /**
+     * Returns the value of a specific attribute from the passed Element.
+     *
+     * @param element       The Element to search for the attribute.
+     * @param attributeName The name of the Attribute to search for.
+     * @return The value if found or empty() if not.
+     */
     public Optional<String> getAttributeValue(Element element, String attributeName) {
         var value = element.getAttribute(attributeName);
         return (value != null && !value.isBlank()) ? Optional.of(value) : Optional.empty();
     }
 
+    /**
+     * Search for a Child Node on the passed Element.
+     *
+     * @param root      The element on which to search for a child Node.
+     * @param localName The name of the Child Node.
+     * @return The Child Node if found or empty() if not.
+     */
     public Optional<Element> getChildNodeByName(Element root, String localName) {
         return getChildNodesByName(root, localName)
                 .stream()
                 .findFirst();
     }
 
+    /**
+     * Search for all Child Node on the passed Element.
+     *
+     * @param root      The element on which to search for all child Node.
+     * @param localName The name of the Child Node.
+     * @return The list of Child Nodes found.
+     */
     public List<Element> getChildNodesByName(Element root, String localName) {
         var foundElements = new ArrayList<Element>();
         var childNodes = root.getChildNodes();