From 25e3306737b7284b051dfeaedb39ef83323504d9 Mon Sep 17 00:00:00 2001 From: Ruslan Kashapov Date: Wed, 5 May 2021 12:06:00 +0300 Subject: Create list-node elements (part1): CPS service and persistence layers + fix integrity violation exception exposed out of persistence layer + refactor CpsDataServiceImplSpec to eliminate repeated code Issue-ID: CPS-360 Change-Id: Id70341fe54bf3c31af661f6aae04a7a80f4a1e9d Signed-off-by: Ruslan Kashapov --- .../main/java/org/onap/cps/api/CpsDataService.java | 15 +++ .../org/onap/cps/api/impl/CpsDataServiceImpl.java | 26 +++++ .../onap/cps/spi/CpsDataPersistenceService.java | 13 +++ .../spi/exceptions/AlreadyDefinedException.java | 8 ++ .../cps/api/impl/CpsDataServiceImplSpec.groovy | 107 +++++++++++---------- 5 files changed, 119 insertions(+), 50 deletions(-) (limited to 'cps-service') diff --git a/cps-service/src/main/java/org/onap/cps/api/CpsDataService.java b/cps-service/src/main/java/org/onap/cps/api/CpsDataService.java index 8552c6c0d8..8e59ebcbb0 100644 --- a/cps-service/src/main/java/org/onap/cps/api/CpsDataService.java +++ b/cps-service/src/main/java/org/onap/cps/api/CpsDataService.java @@ -56,6 +56,21 @@ public interface CpsDataService { void saveData(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String parentNodeXpath, @NonNull String jsonData); + /** + * Persists child data fragment representing list-node (with one or more elements) under existing data node + * for the given anchor and dataspace. + * + * @param dataspaceName dataspace name + * @param anchorName anchor name + * @param parentNodeXpath parent node xpath + * @param jsonData json data representing list element + * @throws DataValidationException when json data is invalid (incl. list-node being empty) + * @throws DataNodeNotFoundException when parent node cannot be found by parent node xpath + * @throws AlreadyDefinedException when any of child data nodes is having xpath of already existing node + */ + void saveListNodeData(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String parentNodeXpath, + @NonNull String jsonData); + /** * Retrieves datanode by XPath for given dataspace and anchor. * diff --git a/cps-service/src/main/java/org/onap/cps/api/impl/CpsDataServiceImpl.java b/cps-service/src/main/java/org/onap/cps/api/impl/CpsDataServiceImpl.java index fd0f76b536..523657a7fc 100755 --- a/cps-service/src/main/java/org/onap/cps/api/impl/CpsDataServiceImpl.java +++ b/cps-service/src/main/java/org/onap/cps/api/impl/CpsDataServiceImpl.java @@ -21,11 +21,13 @@ package org.onap.cps.api.impl; +import java.util.Collection; import org.onap.cps.api.CpsAdminService; import org.onap.cps.api.CpsDataService; import org.onap.cps.api.CpsModuleService; import org.onap.cps.spi.CpsDataPersistenceService; import org.onap.cps.spi.FetchDescendantsOption; +import org.onap.cps.spi.exceptions.DataValidationException; import org.onap.cps.spi.model.DataNode; import org.onap.cps.spi.model.DataNodeBuilder; import org.onap.cps.utils.YangUtils; @@ -64,6 +66,17 @@ public class CpsDataServiceImpl implements CpsDataService { cpsDataPersistenceService.addChildDataNode(dataspaceName, anchorName, parentNodeXpath, dataNode); } + @Override + public void saveListNodeData(final String dataspaceName, final String anchorName, + final String parentNodeXpath, final String jsonData) { + final Collection dataNodesCollection = + buildDataNodeCollectionFromJson(dataspaceName, anchorName, parentNodeXpath, jsonData); + if (dataNodesCollection.isEmpty()) { + throw new DataValidationException("Invalid list data.", "List node is empty."); + } + cpsDataPersistenceService.addListDataNodes(dataspaceName, anchorName, parentNodeXpath, dataNodesCollection); + } + @Override public DataNode getDataNode(final String dataspaceName, final String anchorName, final String xpath, final FetchDescendantsOption fetchDescendantsOption) { @@ -103,6 +116,19 @@ public class CpsDataServiceImpl implements CpsDataService { .build(); } + private Collection buildDataNodeCollectionFromJson(final String dataspaceName, final String anchorName, + final String parentNodeXpath, final String jsonData) { + + final var anchor = cpsAdminService.getAnchor(dataspaceName, anchorName); + final var schemaContext = getSchemaContext(dataspaceName, anchor.getSchemaSetName()); + + final NormalizedNode normalizedNode = YangUtils.parseJsonData(jsonData, schemaContext, parentNodeXpath); + return new DataNodeBuilder() + .withParentNodeXpath(parentNodeXpath) + .withNormalizedNodeTree(normalizedNode) + .buildCollection(); + } + private SchemaContext getSchemaContext(final String dataspaceName, final String schemaSetName) { return yangTextSchemaSourceSetCache.get(dataspaceName, schemaSetName).getSchemaContext(); } diff --git a/cps-service/src/main/java/org/onap/cps/spi/CpsDataPersistenceService.java b/cps-service/src/main/java/org/onap/cps/spi/CpsDataPersistenceService.java index 48f9763eeb..0ed3bf0051 100644 --- a/cps-service/src/main/java/org/onap/cps/spi/CpsDataPersistenceService.java +++ b/cps-service/src/main/java/org/onap/cps/spi/CpsDataPersistenceService.java @@ -54,6 +54,18 @@ public interface CpsDataPersistenceService { void addChildDataNode(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String parentXpath, @NonNull DataNode dataNode); + /** + * Adds list node child elements to a Fragment. + * + * @param dataspaceName dataspace name + * @param anchorName anchor name + * @param parentNodeXpath parent node xpath + * @param dataNodes collection of data nodes representing list node elements + */ + + void addListDataNodes(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String parentNodeXpath, + @NonNull Collection dataNodes); + /** * Retrieves datanode by XPath for given dataspace and anchor. * @@ -100,4 +112,5 @@ public interface CpsDataPersistenceService { */ Collection queryDataNodes(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String cpsPath, @NonNull FetchDescendantsOption fetchDescendantsOption); + } diff --git a/cps-service/src/main/java/org/onap/cps/spi/exceptions/AlreadyDefinedException.java b/cps-service/src/main/java/org/onap/cps/spi/exceptions/AlreadyDefinedException.java index 9e54f34937..1352a9b6c7 100644 --- a/cps-service/src/main/java/org/onap/cps/spi/exceptions/AlreadyDefinedException.java +++ b/cps-service/src/main/java/org/onap/cps/spi/exceptions/AlreadyDefinedException.java @@ -19,6 +19,8 @@ package org.onap.cps.spi.exceptions; +import java.util.Collection; + /** * Already defined exception. Indicates the cps object with same name already exists. */ @@ -70,4 +72,10 @@ public class AlreadyDefinedException extends CpsAdminException { final Throwable cause) { return new AlreadyDefinedException("Data node", xpath, contextName, cause); } + + public static AlreadyDefinedException forDataNodes(final Collection xpaths, final String contextName, + final Throwable cause) { + final var name = String.format("(one or more) of %s", xpaths); + return new AlreadyDefinedException("Data node", name, contextName, cause); + } } diff --git a/cps-service/src/test/groovy/org/onap/cps/api/impl/CpsDataServiceImplSpec.groovy b/cps-service/src/test/groovy/org/onap/cps/api/impl/CpsDataServiceImplSpec.groovy index 8fbf74504b..5f930a1527 100644 --- a/cps-service/src/test/groovy/org/onap/cps/api/impl/CpsDataServiceImplSpec.groovy +++ b/cps-service/src/test/groovy/org/onap/cps/api/impl/CpsDataServiceImplSpec.groovy @@ -25,6 +25,7 @@ import org.onap.cps.api.CpsAdminService import org.onap.cps.api.CpsModuleService import org.onap.cps.spi.CpsDataPersistenceService import org.onap.cps.spi.FetchDescendantsOption +import org.onap.cps.spi.exceptions.DataValidationException import org.onap.cps.spi.model.Anchor import org.onap.cps.spi.model.DataNodeBuilder import org.onap.cps.yang.YangTextSchemaSourceSet @@ -51,16 +52,8 @@ class CpsDataServiceImplSpec extends Specification { def schemaSetName = 'some schema set' def 'Saving json data.'() { - given: 'that the admin service will return an anchor' - def anchor = Anchor.builder().name(anchorName).schemaSetName(schemaSetName).build() - mockCpsAdminService.getAnchor(dataspaceName, anchorName) >> anchor - and: 'the schema source set cache returns a schema source set' - def mockYangTextSchemaSourceSet = Mock(YangTextSchemaSourceSet) - mockYangTextSchemaSourceSetCache.get(dataspaceName, schemaSetName) >> mockYangTextSchemaSourceSet - and: 'the schema source sets returns the test-tree schema context' - def yangResourceNameToContent = TestUtils.getYangResourcesAsMap('test-tree.yang') - def schemaContext = YangTextSchemaSourceSetBuilder.of(yangResourceNameToContent).getSchemaContext() - mockYangTextSchemaSourceSet.getSchemaContext() >> schemaContext + given: 'schema set for given anchor and dataspace references test-tree model' + setupSchemaSetMocks('test-tree.yang') when: 'save data method is invoked with test-tree json data' def jsonData = TestUtils.getResourceFileContent('test-tree.json') objectUnderTest.saveData(dataspaceName, anchorName, jsonData) @@ -70,24 +63,44 @@ class CpsDataServiceImplSpec extends Specification { } def 'Saving child data fragment under existing node.'() { - given: 'that the admin service will return an anchor' - def anchor = Anchor.builder().name(anchorName).schemaSetName(schemaSetName).build() - mockCpsAdminService.getAnchor(dataspaceName, anchorName) >> anchor - and: 'the schema source set cache returns a schema source set' - def mockYangTextSchemaSourceSet = Mock(YangTextSchemaSourceSet) - mockYangTextSchemaSourceSetCache.get(dataspaceName, schemaSetName) >> mockYangTextSchemaSourceSet - and: 'the schema source sets returns the test-tree schema context' - def yangResourceNameToContent = TestUtils.getYangResourcesAsMap('test-tree.yang') - def schemaContext = YangTextSchemaSourceSetBuilder.of(yangResourceNameToContent).getSchemaContext() - mockYangTextSchemaSourceSet.getSchemaContext() >> schemaContext + given: 'schema set for given anchor and dataspace references test-tree model' + setupSchemaSetMocks('test-tree.yang') when: 'save data method is invoked with test-tree json data' def jsonData = '{"branch": [{"name": "New"}]}' - objectUnderTest.saveData(dataspaceName, anchorName, '/test-tree',jsonData) + objectUnderTest.saveData(dataspaceName, anchorName, '/test-tree', jsonData) then: 'the persistence service method is invoked with correct parameters' - 1 * mockCpsDataPersistenceService.addChildDataNode(dataspaceName, anchorName,'/test-tree', + 1 * mockCpsDataPersistenceService.addChildDataNode(dataspaceName, anchorName, '/test-tree', { dataNode -> dataNode.xpath == '/test-tree/branch[@name=\'New\']' }) } + def 'Saving list-node data fragment under existing node.'() { + given: 'schema set for given anchor and dataspace references test-tree model' + setupSchemaSetMocks('test-tree.yang') + when: 'save data method is invoked with list-node json data' + def jsonData = '{"branch": [{"name": "A"}, {"name": "B"}]}' + objectUnderTest.saveListNodeData(dataspaceName, anchorName, '/test-tree', jsonData) + then: 'the persistence service method is invoked with correct parameters' + 1 * mockCpsDataPersistenceService.addListDataNodes(dataspaceName, anchorName, '/test-tree', + { dataNodeCollection -> + { + assert dataNodeCollection.size() == 2 + assert dataNodeCollection.collect { it.getXpath() } + .containsAll(['/test-tree/branch[@name=\'A\']', '/test-tree/branch[@name=\'B\']']) + } + } + ) + } + + def 'Saving empty list-node data fragment.'() { + given: 'schema set for given anchor and dataspace references test-tree model' + setupSchemaSetMocks('test-tree.yang') + when: 'save data method is invoked with empty list-node data fragment' + def jsonData = '{"branch": []}' + objectUnderTest.saveListNodeData(dataspaceName, anchorName, '/test-tree', jsonData) + then: 'invalid data exception is thrown' + thrown(DataValidationException) + } + def 'Get data node with option #fetchDescendantsOption.'() { def xpath = '/xpath' def dataNode = new DataNodeBuilder().withXpath(xpath).build() @@ -100,45 +113,39 @@ class CpsDataServiceImplSpec extends Specification { } def 'Update data node leaves: #scenario.'() { - given: 'that the admin service will return an anchor' - def anchor = Anchor.builder().name(anchorName).schemaSetName(schemaSetName).build() - mockCpsAdminService.getAnchor(dataspaceName, anchorName) >> anchor - and: 'the schema source set cache returns a schema source set' - def mockYangTextSchemaSourceSet = Mock(YangTextSchemaSourceSet) - mockYangTextSchemaSourceSetCache.get(dataspaceName, schemaSetName) >> mockYangTextSchemaSourceSet - and: 'the schema source sets returns the test-tree schema context' - def yangResourceNameToContent = TestUtils.getYangResourcesAsMap('test-tree.yang') - def schemaContext = YangTextSchemaSourceSetBuilder.of(yangResourceNameToContent).getSchemaContext() - mockYangTextSchemaSourceSet.getSchemaContext() >> schemaContext + given: 'schema set for given anchor and dataspace references test-tree model' + setupSchemaSetMocks('test-tree.yang') when: 'update data method is invoked with json data #jsonData and parent node xpath #parentNodeXpath' objectUnderTest.updateNodeLeaves(dataspaceName, anchorName, parentNodeXpath, jsonData) then: 'the persistence service method is invoked with correct parameters' - 1 * mockCpsDataPersistenceService.updateDataLeaves(dataspaceName, anchorName, nodeXpath, leaves) + 1 * mockCpsDataPersistenceService.updateDataLeaves(dataspaceName, anchorName, expectedNodeXpath, leaves) where: 'following parameters were used' - scenario | parentNodeXpath | jsonData | nodeXpath | leaves - 'top level node' | '/' | '{ "test-tree": {"branch": []}}' | '/test-tree' | Collections.emptyMap() - 'level 2 node' | '/test-tree' | '{"branch": [{"name":"Name"}]}' | '/test-tree/branch[@name=\'Name\']' | ['name': 'Name'] + scenario | parentNodeXpath | jsonData || expectedNodeXpath | leaves + 'top level node' | '/' | '{"test-tree": {"branch": []}}' || '/test-tree' | Collections.emptyMap() + 'level 2 node' | '/test-tree' | '{"branch": [{"name":"Name"}]}' || '/test-tree/branch[@name=\'Name\']' | ['name': 'Name'] } def 'Replace data node: #scenario.'() { - given: 'that the admin service will return an anchor' - def anchor = Anchor.builder().name(anchorName).schemaSetName(schemaSetName).build() - mockCpsAdminService.getAnchor(dataspaceName, anchorName) >> anchor - and: 'the schema source set cache returns a schema source set' - def mockYangTextSchemaSourceSet = Mock(YangTextSchemaSourceSet) - mockYangTextSchemaSourceSetCache.get(dataspaceName, schemaSetName) >> mockYangTextSchemaSourceSet - and: 'the schema source sets returns the test-tree schema context' - def yangResourceNameToContent = TestUtils.getYangResourcesAsMap('test-tree.yang') - def schemaContext = YangTextSchemaSourceSetBuilder.of(yangResourceNameToContent).getSchemaContext() - mockYangTextSchemaSourceSet.getSchemaContext() >> schemaContext + given: 'schema set for given anchor and dataspace references test-tree model' + setupSchemaSetMocks('test-tree.yang') when: 'replace data method is invoked with json data #jsonData and parent node xpath #parentNodeXpath' objectUnderTest.replaceNodeTree(dataspaceName, anchorName, parentNodeXpath, jsonData) then: 'the persistence service method is invoked with correct parameters' 1 * mockCpsDataPersistenceService.replaceDataNodeTree(dataspaceName, anchorName, - { dataNode -> dataNode.xpath == nodeXpath }) + { dataNode -> dataNode.xpath == expectedNodeXpath }) where: 'following parameters were used' - scenario | parentNodeXpath | jsonData | nodeXpath - 'top level node' | '/' | '{ "test-tree": {"branch": []}}' | '/test-tree' - 'level 2 node' | '/test-tree' | '{"branch": [{"name":"Name"}]}' | '/test-tree/branch[@name=\'Name\']' + scenario | parentNodeXpath | jsonData || expectedNodeXpath + 'top level node' | '/' | '{"test-tree": {"branch": []}}' || '/test-tree' + 'level 2 node' | '/test-tree' | '{"branch": [{"name":"Name"}]}' || '/test-tree/branch[@name=\'Name\']' + } + + def setupSchemaSetMocks(String... yangResources) { + def anchor = Anchor.builder().name(anchorName).schemaSetName(schemaSetName).build() + mockCpsAdminService.getAnchor(dataspaceName, anchorName) >> anchor + def mockYangTextSchemaSourceSet = Mock(YangTextSchemaSourceSet) + mockYangTextSchemaSourceSetCache.get(dataspaceName, schemaSetName) >> mockYangTextSchemaSourceSet + def yangResourceNameToContent = TestUtils.getYangResourcesAsMap(yangResources) + def schemaContext = YangTextSchemaSourceSetBuilder.of(yangResourceNameToContent).getSchemaContext() + mockYangTextSchemaSourceSet.getSchemaContext() >> schemaContext } } \ No newline at end of file -- cgit 1.2.3-korg