Improved code coverage (branches) around multipart file utils
[cps.git] / cps-service / src / test / groovy / org / onap / cps / utils / DataMapUtilsSpec.groovy
index 61cfc37..c636f4b 100644 (file)
@@ -1,6 +1,9 @@
 /*
  *  ============LICENSE_START=======================================================
  *  Copyright (C) 2021 Pantheon.tech
+ *  Modifications Copyright (C) 2020-2023 Nordix Foundation
+ *  Modifications Copyright (C) 2022 Bell Canada.
+ *  Modifications Copyright (C) 2023 TechMahindra Ltd.
  *  ================================================================================
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
 
 package org.onap.cps.utils
 
-import com.google.common.collect.ImmutableMap
-import org.onap.cps.spi.model.DataNode
 import org.onap.cps.spi.model.DataNodeBuilder
 import spock.lang.Specification
 
-import static java.util.Arrays.asList
-
 class DataMapUtilsSpec extends Specification {
 
-    DataNode dataNode = buildDataNode(
-            "/parent",
-            ImmutableMap.<String, Object> of("a", "b", "c", asList("d", "e")),
-            asList(
-                    buildDataNode(
-                            "/parent/child-list[@name='x']",
-                            ImmutableMap.<String, Object> of("name", "x"),
-                            Collections.emptyList()),
-                    buildDataNode(
-                            "/parent/child-list[@name='y']",
-                            ImmutableMap.<String, Object> of("name", "y"),
-                            Collections.emptyList()),
-                    buildDataNode(
-                            "/parent/child-object",
-                            ImmutableMap.<String, Object> of("m", "n"),
-                            asList(
-                                    buildDataNode(
-                                            "/parent/child-object/grand-child",
-                                            ImmutableMap.<String, Object> of("o", "p"),
-                                            Collections.emptyList()
-                                    )
-                            )
-                    ),
-            ))
-
-    static DataNode buildDataNode(String xpath, Map<String, Object> leaves, List<DataNode> children) {
-        return new DataNodeBuilder().withXpath(xpath).withLeaves(leaves).withChildDataNodes(children).build()
-    }
+    def noChildren = []
 
     def 'Data node structure conversion to map.'() {
-        when: 'data node structure converted to map'
+        when: 'data node structure is converted to a map'
             def result = DataMapUtils.toDataMap(dataNode)
+        then: 'root node identifier is null'
+            result.parent == null
         then: 'root node leaves are top level elements'
-            assert result["a"] == "b"
-            assert ((Collection) result["c"]).containsAll("d", "e")
+            result.parentLeaf == 'parentLeafValue'
+            result.parentLeafList == ['parentLeafListEntry1','parentLeafListEntry2']
         and: 'leaves of child list element are listed as structures under common identifier'
-            assert ((Collection) result["child-list"]).size() == 2
-            assert ((Collection) result["child-list"]).containsAll(["name": "x"], ["name": "y"])
-        and: 'leaves for child and grand-child elements are populated under their node identifiers'
-            assert result["child-object"]["m"] == "n"
-            assert result["child-object"]["grand-child"]["o"] == "p"
+            result.'child-list'.collect().containsAll(['listElementLeaf': 'listElement1leafValue'],
+                                                      ['listElementLeaf': 'listElement2leafValue'])
+        and: 'leaves for child element is populated under its node identifier'
+            result.'child-object'.childLeaf == 'childLeafValue'
+        and: 'leaves for grandchild element is populated under its node identifier'
+            result.'child-object'.'grand-child-object'.grandChildLeaf == 'grandChildLeafValue'
+    }
+
+    def 'Data node structure conversion to map with root node identifier.'() {
+        when: 'data node structure is converted to a map with root node identifier'
+            def result = DataMapUtils.toDataMapWithIdentifier(dataNode,dataNode.moduleNamePrefix)
+        then: 'root node leaves are populated under its node identifier'
+            def parentNode = result.parent
+            parentNode.parentLeaf == 'parentLeafValue'
+            parentNode.parentLeafList == ['parentLeafListEntry1','parentLeafListEntry2']
+        and: 'leaves for child element is populated under its node identifier'
+            parentNode.'child-object'.childLeaf == 'childLeafValue'
+        and: 'leaves for grandchild element is populated under its node identifier'
+            parentNode.'child-object'.'grand-child-object'.grandChildLeaf == 'grandChildLeafValue'
+    }
+
+    def 'Adding prefix to data node identifier.'() {
+        when: 'a valid xPath is passed to the addPrefixToXpath method'
+            def result = new DataMapUtils().getNodeIdentifierWithPrefix(xPath,'sampleModuleName')
+        then: 'the correct modified node identifier is given'
+            assert result == expectedNodeIdentifier
+        where: 'the following parameters are used'
+            scenario                                | xPath                                     | expectedNodeIdentifier
+            'container xpath'                       | '/bookstore'                              | 'sampleModuleName:bookstore'
+            'xpath contains list attribute'         | '/bookstore/categories[@code=1]'          | 'sampleModuleName:categories'
+            'xpath contains list attributes with /' | '/bookstore/categories[@code=1/2]'        | 'sampleModuleName:categories'
+
+    }
+
+    def 'Data node structure with anchor name conversion to map with root node identifier.'() {
+        when: 'data node structure is converted to a map with root node identifier'
+            def result = DataMapUtils.toDataMapWithIdentifierAndAnchor(dataNodeWithAnchor, dataNodeWithAnchor.moduleNamePrefix)
+        then: 'root node leaves are populated under its node identifier'
+            def parentNode = result.get("dataNode").parent
+            parentNode.parentLeaf == 'parentLeafValue'
+            parentNode.parentLeafList == ['parentLeafListEntry1','parentLeafListEntry2']
+        and: 'leaves for child element is populated under its node identifier'
+            assert parentNode.'child-object'.childLeaf == 'childLeafValue'
+        and: 'leaves for grandchild element is populated under its node identifier'
+            assert parentNode.'child-object'.'grand-child-object'.grandChildLeaf == 'grandChildLeafValue'
+        and: 'data node is associated with anchor name'
+            assert result.get('anchorName') == 'anchor01'
+    }
+
+    def 'Data node without leaves and without children.'() {
+        given: 'a datanode with no leaves and no children'
+            def dataNodeWithoutData = new DataNodeBuilder().withXpath('some xpath').build()
+        when: 'it is converted to a map'
+            def result = DataMapUtils.toDataMap(dataNodeWithoutData)
+        then: 'an empty object map is returned'
+            result.isEmpty()
+    }
+
+    def dataNode = buildDataNode(
+        "/parent",[parentLeaf:'parentLeafValue', parentLeafList:['parentLeafListEntry1','parentLeafListEntry2']],[
+        buildDataNode('/parent/child-list[@id=1/2]',[listElementLeaf:'listElement1leafValue'],noChildren),
+        buildDataNode('/parent/child-list[@id=2]',[listElementLeaf:'listElement2leafValue'],noChildren),
+        buildDataNode('/parent/child-object',[childLeaf:'childLeafValue'],
+            [buildDataNode('/parent/child-object/grand-child-object',[grandChildLeaf:'grandChildLeafValue'],noChildren)]
+        ),
+    ])
+
+    def dataNodeWithAnchor = buildDataNodeWithAnchor(
+        "/parent", 'anchor01',[parentLeaf:'parentLeafValue', parentLeafList:['parentLeafListEntry1','parentLeafListEntry2']],[
+        buildDataNode('/parent/child-list[@id=1/2]',[listElementLeaf:'listElement1leafValue'],noChildren),
+        buildDataNode('/parent/child-list[@id=2]',[listElementLeaf:'listElement2leafValue'],noChildren),
+        buildDataNode('/parent/child-object',[childLeaf:'childLeafValue'],
+            [buildDataNode('/parent/child-object/grand-child-object',[grandChildLeaf:'grandChildLeafValue'],noChildren)]
+        ),
+    ])
+
+    def buildDataNode(xpath,  leaves,  children) {
+        return new DataNodeBuilder().withXpath(xpath).withLeaves(leaves).withChildDataNodes(children).build()
+    }
+
+    def buildDataNodeWithAnchor(xpath, anchorName, leaves,  children) {
+        return new DataNodeBuilder().withXpath(xpath).withAnchor(anchorName).withLeaves(leaves).withChildDataNodes(children).build()
     }
 
 }
+