From 9a87c1476c92aa4a6e1731efc417c01532cc8dc6 Mon Sep 17 00:00:00 2001 From: kissand Date: Mon, 2 May 2022 10:42:30 +0200 Subject: Fix sonar code smells * Increase code coverage in DataNodeBuilder Issue-ID: CPS-475 Change-Id: I00a3b1c81911c1ccd3db810eec2f2989946809c5 Signed-off-by: kissand --- .../org/onap/cps/model/DataNodeBuilderSpec.groovy | 173 ------------------- .../onap/cps/spi/model/DataNodeBuilderSpec.groovy | 188 +++++++++++++++++++++ 2 files changed, 188 insertions(+), 173 deletions(-) delete mode 100644 cps-service/src/test/groovy/org/onap/cps/model/DataNodeBuilderSpec.groovy create mode 100644 cps-service/src/test/groovy/org/onap/cps/spi/model/DataNodeBuilderSpec.groovy diff --git a/cps-service/src/test/groovy/org/onap/cps/model/DataNodeBuilderSpec.groovy b/cps-service/src/test/groovy/org/onap/cps/model/DataNodeBuilderSpec.groovy deleted file mode 100644 index 7af1ed41c..000000000 --- a/cps-service/src/test/groovy/org/onap/cps/model/DataNodeBuilderSpec.groovy +++ /dev/null @@ -1,173 +0,0 @@ -/* - * ============LICENSE_START======================================================= - * Copyright (C) 2021 Pantheon.tech - * Modifications Copyright (C) 2021 Nordix Foundation. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ - -package org.onap.cps.model - -import org.onap.cps.TestUtils -import org.onap.cps.spi.model.DataNodeBuilder -import org.onap.cps.utils.YangUtils -import org.onap.cps.yang.YangTextSchemaSourceSetBuilder -import spock.lang.Specification - -class DataNodeBuilderSpec extends Specification { - - Map> expectedLeavesByXpathMap = [ - '/test-tree' : [], - '/test-tree/branch[@name=\'Left\']' : [name: 'Left'], - '/test-tree/branch[@name=\'Left\']/nest' : [name: 'Small', birds: ['Sparrow', 'Robin', 'Finch']], - '/test-tree/branch[@name=\'Right\']' : [name: 'Right'], - '/test-tree/branch[@name=\'Right\']/nest' : [name: 'Big', birds: ['Owl', 'Raven', 'Crow']], - '/test-tree/fruit[@color=\'Green\' and @name=\'Apple\']': [color: 'Green', name: 'Apple'] - ] - - String[] networkTopologyModelRfc8345 = [ - 'ietf/ietf-yang-types@2013-07-15.yang', - 'ietf/ietf-network-topology-state@2018-02-26.yang', - 'ietf/ietf-network-topology@2018-02-26.yang', - 'ietf/ietf-network-state@2018-02-26.yang', - 'ietf/ietf-network@2018-02-26.yang', - 'ietf/ietf-inet-types@2013-07-15.yang' - ] - - def 'Converting NormalizedNode (tree) to a DataNode (tree).'() { - given: 'the schema context for expected model' - def yangResourceNameToContent = TestUtils.getYangResourcesAsMap('test-tree.yang') - def schemaContext = YangTextSchemaSourceSetBuilder.of(yangResourceNameToContent) getSchemaContext() - and: 'the json data parsed into normalized node object' - def jsonData = TestUtils.getResourceFileContent('test-tree.json') - def normalizedNode = YangUtils.parseJsonData(jsonData, schemaContext) - when: 'the normalized node is converted to a data node' - def result = new DataNodeBuilder().withNormalizedNodeTree(normalizedNode).build() - def mappedResult = TestUtils.getFlattenMapByXpath(result) - then: '5 DataNode objects with unique xpath were created in total' - mappedResult.size() == 6 - and: 'all expected xpaths were built' - mappedResult.keySet().containsAll(expectedLeavesByXpathMap.keySet()) - and: 'each data node contains the expected attributes' - mappedResult.each { - xpath, dataNode -> assertLeavesMaps(dataNode.getLeaves(), expectedLeavesByXpathMap[xpath]) - } - } - - def 'Converting NormalizedNode (tree) to a DataNode (tree) for known parent node.'() { - given: 'a schema context for expected model' - def yangResourceNameToContent = TestUtils.getYangResourcesAsMap('test-tree.yang') - def schemaContext = YangTextSchemaSourceSetBuilder.of(yangResourceNameToContent) getSchemaContext() - and: 'the json data parsed into normalized node object' - def jsonData = '{ "branch": [{ "name": "Branch", "nest": { "name": "Nest", "birds": ["bird"] } }] }' - def normalizedNode = YangUtils.parseJsonData(jsonData, schemaContext, "/test-tree") - when: 'the normalized node is converted to a data node with parent node xpath defined' - def result = new DataNodeBuilder() - .withNormalizedNodeTree(normalizedNode) - .withParentNodeXpath("/test-tree") - .build() - def mappedResult = TestUtils.getFlattenMapByXpath(result) - then: '2 DataNode objects with unique xpath were created in total' - mappedResult.size() == 2 - and: 'all expected xpaths were built' - mappedResult.keySet() - .containsAll(['/test-tree/branch[@name=\'Branch\']', '/test-tree/branch[@name=\'Branch\']/nest']) - } - - def 'Converting NormalizedNode (tree) to a DataNode (tree) -- augmentation case.'() { - given: 'a schema context for expected model' - def yangResourceNameToContent = TestUtils.getYangResourcesAsMap(networkTopologyModelRfc8345) - def schemaContext = YangTextSchemaSourceSetBuilder.of(yangResourceNameToContent) getSchemaContext() - and: 'the json data parsed into normalized node object' - def jsonData = TestUtils.getResourceFileContent('ietf/data/ietf-network-topology-sample-rfc8345.json') - def normalizedNode = YangUtils.parseJsonData(jsonData, schemaContext) - when: 'the normalized node is converted to a data node ' - def result = new DataNodeBuilder().withNormalizedNodeTree(normalizedNode).build() - def mappedResult = TestUtils.getFlattenMapByXpath(result) - then: 'all expected data nodes are populated' - mappedResult.size() == 32 - println(mappedResult.keySet().sort()) - and: 'xpaths for augmentation nodes (link and termination-point nodes) were built correctly' - mappedResult.keySet().containsAll([ - "/networks/network[@network-id='otn-hc']/link[@link-id='D1,1-2-1,D2,2-1-1']", - "/networks/network[@network-id='otn-hc']/link[@link-id='D1,1-3-1,D3,3-1-1']", - "/networks/network[@network-id='otn-hc']/link[@link-id='D2,2-1-1,D1,1-2-1']", - "/networks/network[@network-id='otn-hc']/link[@link-id='D2,2-3-1,D3,3-2-1']", - "/networks/network[@network-id='otn-hc']/link[@link-id='D3,3-1-1,D1,1-3-1']", - "/networks/network[@network-id='otn-hc']/link[@link-id='D3,3-2-1,D2,2-3-1']", - "/networks/network[@network-id='otn-hc']/node[@node-id='D1']/termination-point[@tp-id='1-0-1']", - "/networks/network[@network-id='otn-hc']/node[@node-id='D1']/termination-point[@tp-id='1-2-1']", - "/networks/network[@network-id='otn-hc']/node[@node-id='D1']/termination-point[@tp-id='1-3-1']", - "/networks/network[@network-id='otn-hc']/node[@node-id='D2']/termination-point[@tp-id='2-0-1']", - "/networks/network[@network-id='otn-hc']/node[@node-id='D2']/termination-point[@tp-id='2-1-1']", - "/networks/network[@network-id='otn-hc']/node[@node-id='D2']/termination-point[@tp-id='2-3-1']", - "/networks/network[@network-id='otn-hc']/node[@node-id='D3']/termination-point[@tp-id='3-1-1']", - "/networks/network[@network-id='otn-hc']/node[@node-id='D3']/termination-point[@tp-id='3-2-1']" - ]) - } - - def 'Converting NormalizedNode (tree) to a DataNode (tree) for known parent node -- augmentation case.'() { - given: 'a schema context for expected model' - def yangResourceNameToContent = TestUtils.getYangResourcesAsMap(networkTopologyModelRfc8345) - def schemaContext = YangTextSchemaSourceSetBuilder.of(yangResourceNameToContent) getSchemaContext() - and: 'parent node xpath referencing augmentation node within a model' - def parentNodeXpath = "/networks/network[@network-id='otn-hc']/link[@link-id='D1,1-2-1,D2,2-1-1']" - and: 'the json data fragment parsed into normalized node object for given parent node xpath' - def jsonData = '{"source": {"source-node": "D1", "source-tp": "1-2-1"}}' - def normalizedNode = YangUtils.parseJsonData(jsonData, schemaContext, parentNodeXpath) - when: 'the normalized node is converted to a data node with given parent node xpath' - def result = new DataNodeBuilder().withNormalizedNodeTree(normalizedNode) - .withParentNodeXpath(parentNodeXpath).build() - then: 'the resulting data node represents a child of augmentation node' - assert result.xpath == "/networks/network[@network-id='otn-hc']/link[@link-id='D1,1-2-1,D2,2-1-1']/source" - assert result.leaves['source-node'] == 'D1' - assert result.leaves['source-tp'] == '1-2-1' - } - - def 'Converting NormalizedNode into DataNode collection: #scenario.'() { - given: 'a schema context for expected model' - def yangResourceNameToContent = TestUtils.getYangResourcesAsMap('test-tree.yang') - def schemaContext = YangTextSchemaSourceSetBuilder.of(yangResourceNameToContent) getSchemaContext() - and: 'parent node xpath referencing parent of list element' - def parentNodeXpath = "/test-tree" - and: 'the json data fragment (list element) parsed into normalized node object' - def normalizedNode = YangUtils.parseJsonData(jsonData, schemaContext, parentNodeXpath) - when: 'the normalized node is converted to a data node collection' - def result = new DataNodeBuilder().withNormalizedNodeTree(normalizedNode) - .withParentNodeXpath(parentNodeXpath).buildCollection() - def resultXpaths = result.collect { it.getXpath() } - then: 'the resulting collection contains data nodes for expected list elements' - assert resultXpaths.size() == expectedSize - assert resultXpaths.containsAll(expectedXpaths) - where: 'following parameters are used' - scenario | jsonData | expectedSize | expectedXpaths - 'single entry' | '{"branch": [{"name": "One"}]}' | 1 | ['/test-tree/branch[@name=\'One\']'] - 'multiple entries' | '{"branch": [{"name": "One"}, {"name": "Two"}]}' | 2 | ['/test-tree/branch[@name=\'One\']', '/test-tree/branch[@name=\'Two\']'] - } - - def static assertLeavesMaps(actualLeavesMap, expectedLeavesMap) { - expectedLeavesMap.each { key, value -> - { - def actualValue = actualLeavesMap[key] - if (value instanceof Collection && actualValue instanceof Collection) { - assert value.size() == actualValue.size() - assert value.containsAll(actualValue) - } else { - assert value == actualValue - } - } - } - } -} diff --git a/cps-service/src/test/groovy/org/onap/cps/spi/model/DataNodeBuilderSpec.groovy b/cps-service/src/test/groovy/org/onap/cps/spi/model/DataNodeBuilderSpec.groovy new file mode 100644 index 000000000..ce54ead2a --- /dev/null +++ b/cps-service/src/test/groovy/org/onap/cps/spi/model/DataNodeBuilderSpec.groovy @@ -0,0 +1,188 @@ +/* + * ============LICENSE_START======================================================= + * Copyright (C) 2021 Pantheon.tech + * Modifications Copyright (C) 2021-2022 Nordix Foundation. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + * SPDX-License-Identifier: Apache-2.0 + * ============LICENSE_END========================================================= + */ + +package org.onap.cps.spi.model + +import org.onap.cps.TestUtils +import org.onap.cps.spi.model.DataNodeBuilder +import org.onap.cps.utils.YangUtils +import org.onap.cps.yang.YangTextSchemaSourceSetBuilder +import org.opendaylight.yangtools.yang.common.QName +import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier +import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode +import spock.lang.Specification + +class DataNodeBuilderSpec extends Specification { + + Map> expectedLeavesByXpathMap = [ + '/test-tree' : [], + '/test-tree/branch[@name=\'Left\']' : [name: 'Left'], + '/test-tree/branch[@name=\'Left\']/nest' : [name: 'Small', birds: ['Sparrow', 'Robin', 'Finch']], + '/test-tree/branch[@name=\'Right\']' : [name: 'Right'], + '/test-tree/branch[@name=\'Right\']/nest' : [name: 'Big', birds: ['Owl', 'Raven', 'Crow']], + '/test-tree/fruit[@color=\'Green\' and @name=\'Apple\']': [color: 'Green', name: 'Apple'] + ] + + String[] networkTopologyModelRfc8345 = [ + 'ietf/ietf-yang-types@2013-07-15.yang', + 'ietf/ietf-network-topology-state@2018-02-26.yang', + 'ietf/ietf-network-topology@2018-02-26.yang', + 'ietf/ietf-network-state@2018-02-26.yang', + 'ietf/ietf-network@2018-02-26.yang', + 'ietf/ietf-inet-types@2013-07-15.yang' + ] + + def 'Converting NormalizedNode (tree) to a DataNode (tree).'() { + given: 'the schema context for expected model' + def yangResourceNameToContent = TestUtils.getYangResourcesAsMap('test-tree.yang') + def schemaContext = YangTextSchemaSourceSetBuilder.of(yangResourceNameToContent) getSchemaContext() + and: 'the json data parsed into normalized node object' + def jsonData = TestUtils.getResourceFileContent('test-tree.json') + def normalizedNode = YangUtils.parseJsonData(jsonData, schemaContext) + when: 'the normalized node is converted to a data node' + def result = new DataNodeBuilder().withNormalizedNodeTree(normalizedNode).build() + def mappedResult = TestUtils.getFlattenMapByXpath(result) + then: '5 DataNode objects with unique xpath were created in total' + mappedResult.size() == 6 + and: 'all expected xpaths were built' + mappedResult.keySet().containsAll(expectedLeavesByXpathMap.keySet()) + and: 'each data node contains the expected attributes' + mappedResult.each { + xpath, dataNode -> assertLeavesMaps(dataNode.getLeaves(), expectedLeavesByXpathMap[xpath]) + } + } + + def 'Converting NormalizedNode (tree) to a DataNode (tree) for known parent node.'() { + given: 'a schema context for expected model' + def yangResourceNameToContent = TestUtils.getYangResourcesAsMap('test-tree.yang') + def schemaContext = YangTextSchemaSourceSetBuilder.of(yangResourceNameToContent) getSchemaContext() + and: 'the json data parsed into normalized node object' + def jsonData = '{ "branch": [{ "name": "Branch", "nest": { "name": "Nest", "birds": ["bird"] } }] }' + def normalizedNode = YangUtils.parseJsonData(jsonData, schemaContext, "/test-tree") + when: 'the normalized node is converted to a data node with parent node xpath defined' + def result = new DataNodeBuilder() + .withNormalizedNodeTree(normalizedNode) + .withParentNodeXpath("/test-tree") + .build() + def mappedResult = TestUtils.getFlattenMapByXpath(result) + then: '2 DataNode objects with unique xpath were created in total' + mappedResult.size() == 2 + and: 'all expected xpaths were built' + mappedResult.keySet() + .containsAll(['/test-tree/branch[@name=\'Branch\']', '/test-tree/branch[@name=\'Branch\']/nest']) + } + + def 'Converting NormalizedNode (tree) to a DataNode (tree) -- augmentation case.'() { + given: 'a schema context for expected model' + def yangResourceNameToContent = TestUtils.getYangResourcesAsMap(networkTopologyModelRfc8345) + def schemaContext = YangTextSchemaSourceSetBuilder.of(yangResourceNameToContent) getSchemaContext() + and: 'the json data parsed into normalized node object' + def jsonData = TestUtils.getResourceFileContent('ietf/data/ietf-network-topology-sample-rfc8345.json') + def normalizedNode = YangUtils.parseJsonData(jsonData, schemaContext) + when: 'the normalized node is converted to a data node ' + def result = new DataNodeBuilder().withNormalizedNodeTree(normalizedNode).build() + def mappedResult = TestUtils.getFlattenMapByXpath(result) + then: 'all expected data nodes are populated' + mappedResult.size() == 32 + println(mappedResult.keySet().sort()) + and: 'xpaths for augmentation nodes (link and termination-point nodes) were built correctly' + mappedResult.keySet().containsAll([ + "/networks/network[@network-id='otn-hc']/link[@link-id='D1,1-2-1,D2,2-1-1']", + "/networks/network[@network-id='otn-hc']/link[@link-id='D1,1-3-1,D3,3-1-1']", + "/networks/network[@network-id='otn-hc']/link[@link-id='D2,2-1-1,D1,1-2-1']", + "/networks/network[@network-id='otn-hc']/link[@link-id='D2,2-3-1,D3,3-2-1']", + "/networks/network[@network-id='otn-hc']/link[@link-id='D3,3-1-1,D1,1-3-1']", + "/networks/network[@network-id='otn-hc']/link[@link-id='D3,3-2-1,D2,2-3-1']", + "/networks/network[@network-id='otn-hc']/node[@node-id='D1']/termination-point[@tp-id='1-0-1']", + "/networks/network[@network-id='otn-hc']/node[@node-id='D1']/termination-point[@tp-id='1-2-1']", + "/networks/network[@network-id='otn-hc']/node[@node-id='D1']/termination-point[@tp-id='1-3-1']", + "/networks/network[@network-id='otn-hc']/node[@node-id='D2']/termination-point[@tp-id='2-0-1']", + "/networks/network[@network-id='otn-hc']/node[@node-id='D2']/termination-point[@tp-id='2-1-1']", + "/networks/network[@network-id='otn-hc']/node[@node-id='D2']/termination-point[@tp-id='2-3-1']", + "/networks/network[@network-id='otn-hc']/node[@node-id='D3']/termination-point[@tp-id='3-1-1']", + "/networks/network[@network-id='otn-hc']/node[@node-id='D3']/termination-point[@tp-id='3-2-1']" + ]) + } + + def 'Converting NormalizedNode (tree) to a DataNode (tree) for known parent node -- augmentation case.'() { + given: 'a schema context for expected model' + def yangResourceNameToContent = TestUtils.getYangResourcesAsMap(networkTopologyModelRfc8345) + def schemaContext = YangTextSchemaSourceSetBuilder.of(yangResourceNameToContent) getSchemaContext() + and: 'parent node xpath referencing augmentation node within a model' + def parentNodeXpath = "/networks/network[@network-id='otn-hc']/link[@link-id='D1,1-2-1,D2,2-1-1']" + and: 'the json data fragment parsed into normalized node object for given parent node xpath' + def jsonData = '{"source": {"source-node": "D1", "source-tp": "1-2-1"}}' + def normalizedNode = YangUtils.parseJsonData(jsonData, schemaContext, parentNodeXpath) + when: 'the normalized node is converted to a data node with given parent node xpath' + def result = new DataNodeBuilder().withNormalizedNodeTree(normalizedNode) + .withParentNodeXpath(parentNodeXpath).build() + then: 'the resulting data node represents a child of augmentation node' + assert result.xpath == "/networks/network[@network-id='otn-hc']/link[@link-id='D1,1-2-1,D2,2-1-1']/source" + assert result.leaves['source-node'] == 'D1' + assert result.leaves['source-tp'] == '1-2-1' + } + + def 'Converting NormalizedNode into DataNode collection: #scenario.'() { + given: 'a schema context for expected model' + def yangResourceNameToContent = TestUtils.getYangResourcesAsMap('test-tree.yang') + def schemaContext = YangTextSchemaSourceSetBuilder.of(yangResourceNameToContent) getSchemaContext() + and: 'parent node xpath referencing parent of list element' + def parentNodeXpath = "/test-tree" + and: 'the json data fragment (list element) parsed into normalized node object' + def normalizedNode = YangUtils.parseJsonData(jsonData, schemaContext, parentNodeXpath) + when: 'the normalized node is converted to a data node collection' + def result = new DataNodeBuilder().withNormalizedNodeTree(normalizedNode) + .withParentNodeXpath(parentNodeXpath).buildCollection() + def resultXpaths = result.collect { it.getXpath() } + then: 'the resulting collection contains data nodes for expected list elements' + assert resultXpaths.size() == expectedSize + assert resultXpaths.containsAll(expectedXpaths) + where: 'following parameters are used' + scenario | jsonData | expectedSize | expectedXpaths + 'single entry' | '{"branch": [{"name": "One"}]}' | 1 | ['/test-tree/branch[@name=\'One\']'] + 'multiple entries' | '{"branch": [{"name": "One"}, {"name": "Two"}]}' | 2 | ['/test-tree/branch[@name=\'One\']', '/test-tree/branch[@name=\'Two\']'] + } + + def 'Converting NormalizedNode to a DataNode collection -- edge cases: #scenario.'() { + when: 'the normalized node is #node' + def result = new DataNodeBuilder().withNormalizedNodeTree(normalizedNode).buildCollection() + then: 'the resulting collection contains data nodes for expected list elements' + assert result.size() == expectedSize + assert result.containsAll(expectedNodes) + where: 'following parameters are used' + scenario | node | normalizedNode | expectedSize | expectedNodes + 'NormalizedNode is null' | 'null' | null | 1 | [ new DataNode() ] + 'NormalizedNode is an unsupported type' | 'not supported' | Mock(NormalizedNode) | 0 | [ ] + } + + def static assertLeavesMaps(actualLeavesMap, expectedLeavesMap) { + expectedLeavesMap.each { key, value -> + { + def actualValue = actualLeavesMap[key] + if (value instanceof Collection && actualValue instanceof Collection) { + assert value.size() == actualValue.size() + assert value.containsAll(actualValue) + } else { + assert value == actualValue + } + } + } + } +} -- cgit 1.2.3-korg