+++ /dev/null
-/*
- * ============LICENSE_START=======================================================
- * Copyright (C) 2022-2024 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.
- * 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.ncmp.api.impl.inventory
-
-import com.fasterxml.jackson.databind.ObjectMapper
-import org.onap.cps.api.CpsAnchorService
-import org.onap.cps.api.CpsDataService
-import org.onap.cps.api.CpsModuleService
-import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle
-import org.onap.cps.spi.CascadeDeleteAllowed
-import org.onap.cps.spi.FetchDescendantsOption
-import org.onap.cps.spi.exceptions.DataNodeNotFoundException
-import org.onap.cps.spi.model.DataNode
-import org.onap.cps.spi.model.ModuleDefinition
-import org.onap.cps.spi.model.ModuleReference
-import org.onap.cps.spi.utils.CpsValidator
-import org.onap.cps.utils.JsonObjectMapper
-import spock.lang.Shared
-import spock.lang.Specification
-
-import java.time.OffsetDateTime
-import java.time.ZoneOffset
-import java.time.format.DateTimeFormatter
-
-import static org.onap.cps.ncmp.api.impl.ncmppersistence.NcmpPersistence.NCMP_DATASPACE_NAME
-import static org.onap.cps.ncmp.api.impl.ncmppersistence.NcmpPersistence.NCMP_DMI_REGISTRY_ANCHOR
-import static org.onap.cps.ncmp.api.impl.ncmppersistence.NcmpPersistence.NCMP_DMI_REGISTRY_PARENT
-import static org.onap.cps.ncmp.api.impl.ncmppersistence.NcmpPersistence.NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME
-import static org.onap.cps.ncmp.api.impl.ncmppersistence.NcmpPersistence.NO_TIMESTAMP
-import static org.onap.cps.spi.FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS
-import static org.onap.cps.spi.FetchDescendantsOption.OMIT_DESCENDANTS
-
-class InventoryPersistenceImplSpec extends Specification {
-
- def spiedJsonObjectMapper = Spy(new JsonObjectMapper(new ObjectMapper()))
-
- def mockCpsDataService = Mock(CpsDataService)
-
- def mockCpsModuleService = Mock(CpsModuleService)
-
- def mockCpsAnchorService = Mock(CpsAnchorService)
-
- def mockCpsValidator = Mock(CpsValidator)
-
- def mockCmHandleQueries = Mock(CmHandleQueries)
-
- def objectUnderTest = new InventoryPersistenceImpl(spiedJsonObjectMapper, mockCpsDataService, mockCpsModuleService,
- mockCpsValidator, mockCpsAnchorService, mockCmHandleQueries)
-
- def formattedDateAndTime = DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HH:mm:ss.SSSZ")
- .format(OffsetDateTime.of(2022, 12, 31, 20, 30, 40, 1, ZoneOffset.UTC))
-
- def cmHandleId = 'some-cm-handle'
- def leaves = ["dmi-service-name":"common service name","dmi-data-service-name":"data service name","dmi-model-service-name":"model service name"]
- def xpath = "/dmi-registry/cm-handles[@id='some-cm-handle']"
-
- def cmHandleId2 = 'another-cm-handle'
- def xpath2 = "/dmi-registry/cm-handles[@id='another-cm-handle']"
-
- @Shared
- def childDataNodesForCmHandleWithAllProperties = [new DataNode(xpath: "/dmi-registry/cm-handles[@id='some cm handle']/additional-properties[@name='name1']", leaves: ["name":"name1", "value":"value1"]),
- new DataNode(xpath: "/dmi-registry/cm-handles[@id='some cm handle']/public-properties[@name='name2']", leaves: ["name":"name2","value":"value2"])]
-
- @Shared
- def childDataNodesForCmHandleWithDMIProperties = [new DataNode(xpath: "/dmi-registry/cm-handles[@id='some-cm-handle']/additional-properties[@name='name1']", leaves: ["name":"name1", "value":"value1"])]
-
- @Shared
- def childDataNodesForCmHandleWithPublicProperties = [new DataNode(xpath: "/dmi-registry/cm-handles[@id='some-cm-handle']/public-properties[@name='name2']", leaves: ["name":"name2","value":"value2"])]
-
- @Shared
- def childDataNodesForCmHandleWithState = [new DataNode(xpath: "/dmi-registry/cm-handles[@id='some-cm-handle']/state", leaves: ['cm-handle-state': 'ADVISED'])]
-
- def "Retrieve CmHandle using datanode with #scenario."() {
- given: 'the cps data service returns a data node from the DMI registry'
- def dataNode = new DataNode(childDataNodes:childDataNodes, leaves: leaves)
- mockCpsDataService.getDataNodes(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, xpath, INCLUDE_ALL_DESCENDANTS) >> [dataNode]
- when: 'retrieving the yang modelled cm handle'
- def result = objectUnderTest.getYangModelCmHandle(cmHandleId)
- then: 'the result has the correct id and service names'
- result.id == cmHandleId
- result.dmiServiceName == 'common service name'
- result.dmiDataServiceName == 'data service name'
- result.dmiModelServiceName == 'model service name'
- and: 'the expected DMI properties'
- result.dmiProperties == expectedDmiProperties
- result.publicProperties == expectedPublicProperties
- and: 'the state details are returned'
- result.compositeState.cmHandleState == expectedCompositeState
- and: 'the CM Handle ID is validated'
- 1 * mockCpsValidator.validateNameCharacters(cmHandleId)
- where: 'the following parameters are used'
- scenario | childDataNodes || expectedDmiProperties || expectedPublicProperties || expectedCompositeState
- 'no properties' | [] || [] || [] || null
- 'DMI and public properties' | childDataNodesForCmHandleWithAllProperties || [new YangModelCmHandle.Property("name1", "value1")] || [new YangModelCmHandle.Property("name2", "value2")] || null
- 'just DMI properties' | childDataNodesForCmHandleWithDMIProperties || [new YangModelCmHandle.Property("name1", "value1")] || [] || null
- 'just public properties' | childDataNodesForCmHandleWithPublicProperties || [] || [new YangModelCmHandle.Property("name2", "value2")] || null
- 'with state details' | childDataNodesForCmHandleWithState || [] || [] || CmHandleState.ADVISED
- }
-
- def "Handling missing service names as null."() {
- given: 'the cps data service returns a data node from the DMI registry with empty child and leaf attributes'
- def dataNode = new DataNode(childDataNodes:[], leaves: [:])
- mockCpsDataService.getDataNodes(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, xpath, INCLUDE_ALL_DESCENDANTS) >> [dataNode]
- when: 'retrieving the yang modelled cm handle'
- def result = objectUnderTest.getYangModelCmHandle(cmHandleId)
- then: 'the service names are returned as null'
- result.dmiServiceName == null
- result.dmiDataServiceName == null
- result.dmiModelServiceName == null
- and: 'the CM Handle ID is validated'
- 1 * mockCpsValidator.validateNameCharacters(cmHandleId)
- }
-
- def "Retrieve multiple YangModelCmHandles"() {
- given: 'the cps data service returns 2 data nodes from the DMI registry'
- def dataNodes = [new DataNode(xpath: xpath), new DataNode(xpath: xpath2)]
- mockCpsDataService.getDataNodesForMultipleXpaths(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, [xpath, xpath2] , INCLUDE_ALL_DESCENDANTS) >> dataNodes
- when: 'retrieving the yang modelled cm handle'
- def results = objectUnderTest.getYangModelCmHandles([cmHandleId, cmHandleId2])
- then: 'verify both have returned and cmhandleIds are correct'
- assert results.size() == 2
- assert results.id.containsAll([cmHandleId, cmHandleId2])
- }
-
- def 'Get a Cm Handle Composite State'() {
- given: 'a valid cm handle id'
- def cmHandleId = 'Some-Cm-Handle'
- def dataNode = new DataNode(leaves: ['cm-handle-state': 'ADVISED'])
- and: 'cps data service returns a valid data node'
- mockCpsDataService.getDataNodes(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
- '/dmi-registry/cm-handles[@id=\'Some-Cm-Handle\']/state', FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> [dataNode]
- when: 'get cm handle state is invoked'
- def result = objectUnderTest.getCmHandleState(cmHandleId)
- then: 'result has returned the correct cm handle state'
- result.cmHandleState == CmHandleState.ADVISED
- and: 'the CM Handle ID is validated'
- 1 * mockCpsValidator.validateNameCharacters(cmHandleId)
- }
-
- def 'Update Cm Handle with #scenario State'() {
- given: 'a cm handle and a composite state'
- def cmHandleId = 'Some-Cm-Handle'
- def compositeState = new CompositeState(cmHandleState: cmHandleState, lastUpdateTime: formattedDateAndTime)
- when: 'update cm handle state is invoked with the #scenario state'
- objectUnderTest.saveCmHandleState(cmHandleId, compositeState)
- then: 'update node leaves is invoked with the correct params'
- 1 * mockCpsDataService.updateDataNodeAndDescendants(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, '/dmi-registry/cm-handles[@id=\'Some-Cm-Handle\']', expectedJsonData, _ as OffsetDateTime)
- where: 'the following states are used'
- scenario | cmHandleState || expectedJsonData
- 'READY' | CmHandleState.READY || '{"state":{"cm-handle-state":"READY","last-update-time":"2022-12-31T20:30:40.000+0000"}}'
- 'LOCKED' | CmHandleState.LOCKED || '{"state":{"cm-handle-state":"LOCKED","last-update-time":"2022-12-31T20:30:40.000+0000"}}'
- 'DELETING' | CmHandleState.DELETING || '{"state":{"cm-handle-state":"DELETING","last-update-time":"2022-12-31T20:30:40.000+0000"}}'
- }
-
- def 'Update Cm Handles with #scenario States'() {
- given: 'a map of cm handles composite states'
- def compositeState1 = new CompositeState(cmHandleState: cmHandleState, lastUpdateTime: formattedDateAndTime)
- def compositeState2 = new CompositeState(cmHandleState: cmHandleState, lastUpdateTime: formattedDateAndTime)
- when: 'update cm handle state is invoked with the #scenario state'
- def cmHandleStateMap = ['Some-Cm-Handle1' : compositeState1, 'Some-Cm-Handle2' : compositeState2]
- objectUnderTest.saveCmHandleStateBatch(cmHandleStateMap)
- then: 'update node leaves is invoked with the correct params'
- 1 * mockCpsDataService.updateDataNodesAndDescendants(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, cmHandlesJsonDataMap, _ as OffsetDateTime)
- where: 'the following states are used'
- scenario | cmHandleState || cmHandlesJsonDataMap
- 'READY' | CmHandleState.READY || ['/dmi-registry/cm-handles[@id=\'Some-Cm-Handle1\']':'{"state":{"cm-handle-state":"READY","last-update-time":"2022-12-31T20:30:40.000+0000"}}', '/dmi-registry/cm-handles[@id=\'Some-Cm-Handle2\']':'{"state":{"cm-handle-state":"READY","last-update-time":"2022-12-31T20:30:40.000+0000"}}']
- 'LOCKED' | CmHandleState.LOCKED || ['/dmi-registry/cm-handles[@id=\'Some-Cm-Handle1\']':'{"state":{"cm-handle-state":"LOCKED","last-update-time":"2022-12-31T20:30:40.000+0000"}}', '/dmi-registry/cm-handles[@id=\'Some-Cm-Handle2\']':'{"state":{"cm-handle-state":"LOCKED","last-update-time":"2022-12-31T20:30:40.000+0000"}}']
- 'DELETING' | CmHandleState.DELETING || ['/dmi-registry/cm-handles[@id=\'Some-Cm-Handle1\']':'{"state":{"cm-handle-state":"DELETING","last-update-time":"2022-12-31T20:30:40.000+0000"}}', '/dmi-registry/cm-handles[@id=\'Some-Cm-Handle2\']':'{"state":{"cm-handle-state":"DELETING","last-update-time":"2022-12-31T20:30:40.000+0000"}}']
- }
-
- def 'Getting module definitions by module'() {
- given: 'cps module service returns module definition for module name'
- def moduleDefinitions = [new ModuleDefinition('moduleName','revision','content')]
- mockCpsModuleService.getModuleDefinitionsByAnchorAndModule(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME,'some-cmHandle-Id', 'some-module', '2024-01-25') >> moduleDefinitions
- when: 'get module definitions is invoked with module name'
- def result = objectUnderTest.getModuleDefinitionsByCmHandleAndModule('some-cmHandle-Id', 'some-module', '2024-01-25')
- then: 'returned result are the same module definitions as returned from module service'
- assert result == moduleDefinitions
- and: 'cm handle id and module name validated'
- 1 * mockCpsValidator.validateNameCharacters('some-cmHandle-Id', 'some-module')
- }
-
- def 'Getting module definitions with cm handle id'() {
- given: 'cps module service returns module definitions for cm handle id'
- def moduleDefinitions = [new ModuleDefinition('moduleName','revision','content')]
- mockCpsModuleService.getModuleDefinitionsByAnchorName(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME,'some-cmHandle-Id') >> moduleDefinitions
- when: 'get module definitions is invoked with cm handle id'
- def result = objectUnderTest.getModuleDefinitionsByCmHandleId('some-cmHandle-Id')
- then: 'the returned result are the same module definitions as returned from the module service'
- assert result == moduleDefinitions
- }
-
- def 'Get module references'() {
- given: 'cps module service returns a collection of module references'
- def moduleReferences = [new ModuleReference('moduleName','revision','namespace')]
- mockCpsModuleService.getYangResourcesModuleReferences(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME,'some-cmHandle-Id') >> moduleReferences
- when: 'get yang resources module references by cmHandle is invoked'
- def result = objectUnderTest.getYangResourcesModuleReferences('some-cmHandle-Id')
- then: 'the returned result is a collection of module definitions'
- assert result == moduleReferences
- and: 'the CM Handle ID is validated'
- 1 * mockCpsValidator.validateNameCharacters('some-cmHandle-Id')
- }
-
- def 'Save Cmhandle'() {
- given: 'cmHandle represented as Yang Model'
- def yangModelCmHandle = new YangModelCmHandle(id: 'cmhandle', dmiProperties: [], publicProperties: [])
- when: 'the method to save cmhandle is called'
- objectUnderTest.saveCmHandle(yangModelCmHandle)
- then: 'the data service method to save list elements is called once'
- 1 * mockCpsDataService.saveListElements(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, NCMP_DMI_REGISTRY_PARENT,
- _,null) >> {
- args -> {
- assert args[3].startsWith('{"cm-handles":[{"id":"cmhandle","additional-properties":[],"public-properties":[]}]}')
- }
- }
- }
-
- def 'Save Multiple Cmhandles'() {
- given: 'cm handles represented as Yang Model'
- def yangModelCmHandle1 = new YangModelCmHandle(id: 'cmhandle1')
- def yangModelCmHandle2 = new YangModelCmHandle(id: 'cmhandle2')
- when: 'the cm handles are saved'
- objectUnderTest.saveCmHandleBatch([yangModelCmHandle1, yangModelCmHandle2])
- then: 'CPS Data Service persists both cm handles as a batch'
- 1 * mockCpsDataService.saveListElements(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
- NCMP_DMI_REGISTRY_PARENT, _,null) >> {
- args -> {
- def jsonData = (args[3] as String)
- jsonData.contains('cmhandle1')
- jsonData.contains('cmhandle2')
- }
- }
- }
-
- def 'Delete list or list elements'() {
- when: 'the method to delete list or list elements is called'
- objectUnderTest.deleteListOrListElement('sample xPath')
- then: 'the data service method to save list elements is called once'
- 1 * mockCpsDataService.deleteListOrListElement(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,'sample xPath',null)
- }
-
- def 'Delete schema set with a valid schema set name'() {
- when: 'the method to delete schema set is called with valid schema set name'
- objectUnderTest.deleteSchemaSetWithCascade('validSchemaSetName')
- then: 'the module service to delete schemaSet is invoked once'
- 1 * mockCpsModuleService.deleteSchemaSet(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, 'validSchemaSetName', CascadeDeleteAllowed.CASCADE_DELETE_ALLOWED)
- and: 'the schema set name is validated'
- 1 * mockCpsValidator.validateNameCharacters('validSchemaSetName')
- }
-
- def 'Delete multiple schema sets with valid schema set names'() {
- when: 'the method to delete schema sets is called with valid schema set names'
- objectUnderTest.deleteSchemaSetsWithCascade(['validSchemaSetName1', 'validSchemaSetName2'])
- then: 'the module service to delete schema sets is invoked once'
- 1 * mockCpsModuleService.deleteSchemaSetsWithCascade(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, ['validSchemaSetName1', 'validSchemaSetName2'])
- and: 'the schema set names are validated'
- 1 * mockCpsValidator.validateNameCharacters(['validSchemaSetName1', 'validSchemaSetName2'])
- }
-
- def 'Get data node via xPath'() {
- when: 'the method to get data nodes is called'
- objectUnderTest.getDataNode('sample xPath')
- then: 'the data persistence service method to get data node is invoked once'
- 1 * mockCpsDataService.getDataNodes(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,'sample xPath', INCLUDE_ALL_DESCENDANTS)
- }
-
- def 'Get cmHandle data node'() {
- given: 'expected xPath to get cmHandle data node'
- def expectedXPath = '/dmi-registry/cm-handles[@id=\'sample cmHandleId\']'
- when: 'the method to get data nodes is called'
- objectUnderTest.getCmHandleDataNodeByCmHandleId('sample cmHandleId')
- then: 'the data persistence service method to get cmHandle data node is invoked once with expected xPath'
- 1 * mockCpsDataService.getDataNodes(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, expectedXPath, INCLUDE_ALL_DESCENDANTS)
- }
-
- def 'Get cm handle data node'() {
- given: 'expected xPath to get cmHandle data node'
- def expectedXPath = '/dmi-registry/cm-handles[@alternate-id=\'alternate id\']'
- and: 'query service is invoked with expected xpath'
- mockCmHandleQueries.queryNcmpRegistryByCpsPath(expectedXPath, OMIT_DESCENDANTS) >> [new DataNode()]
- expect: 'getting the cm handle data node'
- assert objectUnderTest.getCmHandleDataNodeByAlternateId('alternate id') == new DataNode()
- }
-
- def 'Attempt to get non existing cm handle data node by alternate id'() {
- given: 'query service is invoked and returns empty collection of data nodes'
- mockCmHandleQueries.queryNcmpRegistryByCpsPath(*_) >> []
- when: 'getting the cm handle data node'
- objectUnderTest.getCmHandleDataNodeByAlternateId('alternate id')
- then: 'no data found exception thrown'
- def thrownException = thrown(DataNodeNotFoundException)
- assert thrownException.getMessage().contains('DataNode not found')
- }
-
- def 'Get CM handles that has given module names'() {
- when: 'the method to get cm handles is called'
- objectUnderTest.getCmHandleIdsWithGivenModules(['sample-module-name'])
- then: 'the admin persistence service method to query anchors is invoked once with the same parameter'
- 1 * mockCpsAnchorService.queryAnchorNames(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, ['sample-module-name'])
- }
-
- def 'Replace list content'() {
- when: 'replace list content method is called with xpath and data nodes collection'
- objectUnderTest.replaceListContent('sample xpath', [new DataNode()])
- then: 'the cps data service method to replace list content is invoked once with same parameters'
- 1 * mockCpsDataService.replaceListContent(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,'sample xpath', [new DataNode()], NO_TIMESTAMP);
- }
-
- def 'Delete data node via xPath'() {
- when: 'Delete data node method is called with xpath as parameter'
- objectUnderTest.deleteDataNode('sample dataNode xpath')
- then: 'the cps data service method to delete data node is invoked once with the same xPath'
- 1 * mockCpsDataService.deleteDataNode(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, 'sample dataNode xpath', NO_TIMESTAMP);
- }
-
- def 'Delete multiple data nodes via xPath'() {
- when: 'Delete data nodes method is called with multiple xpaths as parameters'
- objectUnderTest.deleteDataNodes(['xpath1', 'xpath2'])
- then: 'the cps data service method to delete data nodes is invoked once with the same xPaths'
- 1 * mockCpsDataService.deleteDataNodes(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, ['xpath1', 'xpath2'], NO_TIMESTAMP);
- }
-
-}
Code Review / cps.git / blobdiff