* ============LICENSE_START=======================================================
* Copyright (C) 2021 Nordix Foundation
* Modifications Copyright (C) 2021 Pantheon.tech
+ * Modifications Copyright (C) 2021 Bell Canada
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
import com.fasterxml.jackson.core.JsonProcessingException
import com.fasterxml.jackson.databind.ObjectMapper
+import org.onap.cps.api.CpsAdminService
import org.onap.cps.api.CpsDataService
+import org.onap.cps.api.CpsModuleService
import org.onap.cps.api.CpsQueryService
+import org.onap.cps.ncmp.api.impl.config.NcmpConfiguration
import org.onap.cps.ncmp.api.impl.exception.NcmpException
import org.onap.cps.ncmp.api.impl.operation.DmiOperations
import org.onap.cps.ncmp.api.models.CmHandle
import org.onap.cps.ncmp.api.models.DmiPluginRegistration
+import org.onap.cps.ncmp.api.models.PersistenceCmHandle
+import org.onap.cps.ncmp.api.models.PersistenceCmHandlesList
+import org.onap.cps.ncmp.utils.TestUtils
import org.onap.cps.spi.FetchDescendantsOption
import org.onap.cps.spi.model.DataNode
+import org.onap.cps.spi.model.ModuleReference
import org.springframework.http.HttpStatus
import org.springframework.http.ResponseEntity
import spock.lang.Shared
@Shared
def persistenceCmHandle = new CmHandle()
+ @Shared
+ def cmHandlesArray = ['cmHandle001']
def mockCpsDataService = Mock(CpsDataService)
def mockCpsQueryService = Mock(CpsQueryService)
def mockDmiOperations = Mock(DmiOperations)
- def objectUnderTest = new NetworkCmProxyDataServiceImpl(mockDmiOperations, mockCpsDataService, mockCpsQueryService, new ObjectMapper())
+ def mockCpsModuleService = Mock(CpsModuleService)
+ def mockCpsAdminService = Mock(CpsAdminService)
+ def mockDmiProperties = Mock(NcmpConfiguration.DmiProperties)
+
+ def objectUnderTest = new NetworkCmProxyDataServiceImpl(mockDmiOperations, mockCpsModuleService,
+ mockCpsDataService, mockCpsQueryService, mockCpsAdminService, new ObjectMapper())
def cmHandle = 'some handle'
+ def noTimestamp = null
+ def cmHandleXPath = "/dmi-registry/cm-handles[@id='testCmHandle']"
+ def cmHandleForModelSync = new PersistenceCmHandle(id:'some cm handle', dmiServiceName: 'some service name')
+ def expectedDataspaceNameForModleSync = 'NCMP-Admin'
def expectedDataspaceName = 'NFP-Operational'
def 'Query data nodes by cps path with #fetchDescendantsOption.'() {
where: 'all fetch descendants options are supported'
fetchDescendantsOption << FetchDescendantsOption.values()
}
+
def 'Create full data node: #scenario.'() {
given: 'a cm handle and root xpath'
def jsonData = 'some json'
when: 'createDataNode is invoked'
objectUnderTest.createDataNode(cmHandle, xpath, jsonData)
then: 'the CPS service method is invoked once with the expected parameters'
- 1 * mockCpsDataService.saveData(expectedDataspaceName, cmHandle, jsonData)
+ 1 * mockCpsDataService.saveData(expectedDataspaceName, cmHandle, jsonData, noTimestamp)
where: 'following parameters were used'
scenario | xpath
'no xpath' | ''
'root level xpath' | '/'
}
+
def 'Create child data node.'() {
given: 'a cm handle and parent node xpath'
def jsonData = 'some json'
when: 'createDataNode is invoked'
objectUnderTest.createDataNode(cmHandle, xpath, jsonData)
then: 'the CPS service method is invoked once with the expected parameters'
- 1 * mockCpsDataService.saveData(expectedDataspaceName, cmHandle, xpath, jsonData)
+ 1 * mockCpsDataService.saveData(expectedDataspaceName, cmHandle, xpath, jsonData, noTimestamp)
}
+
def 'Add list-node elements.'() {
given: 'a cm handle and parent node xpath'
def jsonData = 'some json'
when: 'addListNodeElements is invoked'
objectUnderTest.addListNodeElements(cmHandle, xpath, jsonData)
then: 'the CPS service method is invoked once with the expected parameters'
- 1 * mockCpsDataService.saveListNodeData(expectedDataspaceName, cmHandle, xpath, jsonData)
+ 1 * mockCpsDataService.saveListNodeData(expectedDataspaceName, cmHandle, xpath, jsonData, noTimestamp)
}
+
def 'Update data node leaves.'() {
given: 'a cm Handle and a cps path'
def xpath = '/xpath'
when: 'updateNodeLeaves is invoked'
objectUnderTest.updateNodeLeaves(cmHandle, xpath, jsonData)
then: 'the persistence service is called once with the correct parameters'
- 1 * mockCpsDataService.updateNodeLeaves(expectedDataspaceName, cmHandle, xpath, jsonData)
+ 1 * mockCpsDataService.updateNodeLeaves(expectedDataspaceName, cmHandle, xpath, jsonData, noTimestamp)
}
+
def 'Replace data node tree.'() {
given: 'a cm Handle and a cps path'
def xpath = '/xpath'
when: 'replaceNodeTree is invoked'
objectUnderTest.replaceNodeTree(cmHandle, xpath, jsonData)
then: 'the persistence service is called once with the correct parameters'
- 1 * mockCpsDataService.replaceNodeTree(expectedDataspaceName, cmHandle, xpath, jsonData)
+ 1 * mockCpsDataService.replaceNodeTree(expectedDataspaceName, cmHandle, xpath, jsonData, noTimestamp)
}
def 'Register or re-register a DMI Plugin with #scenario cm handles.'() {
given: 'a registration '
- def dmiRegistryAnchor = 'ncmp-dmi-registry'
+ NetworkCmProxyDataServiceImpl objectUnderTest = getObjectUnderTestWithModelSyncDisabled()
def dmiPluginRegistration = new DmiPluginRegistration()
dmiPluginRegistration.dmiPlugin = 'my-server'
persistenceCmHandle.cmHandleID = '123'
persistenceCmHandle.cmHandleProperties = [name1: 'value1', name2: 'value2']
dmiPluginRegistration.createdCmHandles = createdCmHandles
dmiPluginRegistration.updatedCmHandles = updatedCmHandles
+ dmiPluginRegistration.removedCmHandles = removedCmHandles
def expectedJsonData = '{"cm-handles":[{"id":"123","dmi-service-name":"my-server","additional-properties":[{"name":"name1","value":"value1"},{"name":"name2","value":"value2"}]}]}'
when: 'registration is updated'
- objectUnderTest.updateDmiPluginRegistration(dmiPluginRegistration)
+ objectUnderTest.updateDmiRegistrationAndSyncModule(dmiPluginRegistration)
then: 'the CPS save list node data is invoked with the expected parameters'
- expectedCallsToSaveNode * mockCpsDataService.saveListNodeData('NCMP-Admin', 'ncmp-dmi-registry', '/dmi-registry', expectedJsonData)
- and: 'update Node and Child Data Nodes is invoked with correct parameter'
- expectedCallsToUpdateNode * mockCpsDataService.updateNodeLeavesAndExistingDescendantLeaves('NCMP-Admin', dmiRegistryAnchor, '/dmi-registry', expectedJsonData)
+ expectedCallsToSaveNode * mockCpsDataService.saveListNodeData('NCMP-Admin', 'ncmp-dmi-registry',
+ '/dmi-registry', expectedJsonData, noTimestamp)
+ and: 'update Node and Child Data Nodes is invoked with correct parameters'
+ expectedCallsToUpdateNode * mockCpsDataService.updateNodeLeavesAndExistingDescendantLeaves('NCMP-Admin',
+ 'ncmp-dmi-registry', '/dmi-registry', expectedJsonData, noTimestamp)
+ and : 'delete list data node is invoked with the correct parameters'
+ expectedCallsToDeleteListDataNode * mockCpsDataService.deleteListNodeData('NCMP-Admin',
+ 'ncmp-dmi-registry', "/dmi-registry/cm-handles[@id='cmHandle001']", noTimestamp)
+
where:
- scenario | createdCmHandles | updatedCmHandles || expectedCallsToSaveNode | expectedCallsToUpdateNode
- 'create' | [persistenceCmHandle ] | [] || 1 | 0
- 'update' | [] | [persistenceCmHandle ] || 0 | 1
- 'create and update' | [persistenceCmHandle ] | [persistenceCmHandle ] || 1 | 1
+ scenario | createdCmHandles | updatedCmHandles | removedCmHandles || expectedCallsToSaveNode | expectedCallsToUpdateNode | expectedCallsToDeleteListDataNode
+ 'create' | [persistenceCmHandle ] | [] | [] || 1 | 0 | 0
+ 'update' | [] | [persistenceCmHandle ] | [] || 0 | 1 | 0
+ 'delete' | [] | [] | cmHandlesArray || 0 | 0 | 1
+ 'create, update and delete' | [persistenceCmHandle ] | [persistenceCmHandle ] | cmHandlesArray || 1 | 1 | 1
}
def 'Register a DMI Plugin for the given cmHandle without additional properties.'() {
given: 'a registration without cmHandle properties '
+ NetworkCmProxyDataServiceImpl objectUnderTest = getObjectUnderTestWithModelSyncDisabled()
def dmiPluginRegistration = new DmiPluginRegistration()
dmiPluginRegistration.dmiPlugin = 'my-server'
persistenceCmHandle.cmHandleID = '123'
dmiPluginRegistration.createdCmHandles = [persistenceCmHandle ]
def expectedJsonData = '{"cm-handles":[{"id":"123","dmi-service-name":"my-server","additional-properties":[]}]}'
when: 'registration is updated'
- objectUnderTest.updateDmiPluginRegistration(dmiPluginRegistration)
+ objectUnderTest.updateDmiRegistrationAndSyncModule(dmiPluginRegistration)
then: 'the CPS save list node data is invoked with the expected parameters'
- 1 * mockCpsDataService.saveListNodeData('NCMP-Admin', 'ncmp-dmi-registry', '/dmi-registry', expectedJsonData)
+ 1 * mockCpsDataService.saveListNodeData('NCMP-Admin', 'ncmp-dmi-registry',
+ '/dmi-registry', expectedJsonData, noTimestamp)
}
def 'Get resource data for pass-through operational from dmi.'() {
- given: 'xpath'
- def xpath = "/dmi-registry/cm-handles[@id='testCmHandle']"
- and: 'data node'
- def dataNode = new DataNode()
- dataNode.leaves = ['dmi-service-name':'testDmiService']
- def childDataNode = new DataNode()
- childDataNode.leaves = ['name':'testName','value':'testValue']
- dataNode.childDataNodes = [childDataNode]
+ given: 'data node representing cmHandle and its properties'
+ def cmHandleDataNode = getCmHandleDataNodeForTest()
+ and: 'data node is got from data service'
+ mockCpsDataService.getDataNode('NCMP-Admin', 'ncmp-dmi-registry',
+ cmHandleXPath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> cmHandleDataNode
+ and: 'resource data is got from DMI'
+ mockDmiOperations.getResourceDataOperationalFromDmi('testDmiService',
+ 'testCmHandle',
+ 'testResourceId',
+ 'testFieldQuery',
+ 5,
+ 'testAcceptParam',
+ '{"operation":"read","cmHandleProperties":{"testName":"testValue"}}') >> new ResponseEntity<>('result-json', HttpStatus.OK)
when: 'get resource data is called'
def response = objectUnderTest.getResourceDataOperationalForCmHandle('testCmHandle',
'testResourceId',
'testAcceptParam',
'testFieldQuery',
5)
- then: 'cps data service is being called once to get data node'
- 1 * mockCpsDataService.getDataNode('NCMP-Admin', 'ncmp-dmi-registry',
- xpath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> dataNode
- and: 'dmi operation is being called to get resource data'
- 1 * mockDmiOperations.getResouceDataOperationalFromDmi('testDmiService',
- 'testCmHandle',
- 'testResourceId',
- 'testFieldQuery',
- 5,
- 'testAcceptParam',
- '{"operation":"read","cmHandleProperties":{"testName":"testValue"}}') >> new ResponseEntity<>('result-json', HttpStatus.OK)
- and: 'dmi returns ok response'
+ then: 'dmi returns ok response'
response == 'result-json'
}
+
def 'Get resource data for pass-through operational from dmi threw parsing exception.'() {
- given: 'xpath'
- def xpath = "/dmi-registry/cm-handles[@id='testCmHandle']"
- and: 'data node'
- def dataNode = new DataNode()
- dataNode.leaves = ['dmi-service-name':'testDmiService']
- def childDataNode = new DataNode()
- childDataNode.leaves = ['name':'testName','value':'testValue']
- dataNode.childDataNodes = [childDataNode]
+ given: 'data node representing cmHandle and its properties'
+ def cmHandleDataNode = getCmHandleDataNodeForTest()
+ and: 'cps data service returns valid cmHandle data node'
mockCpsDataService.getDataNode('NCMP-Admin', 'ncmp-dmi-registry',
- xpath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> dataNode
+ cmHandleXPath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> cmHandleDataNode
and: 'objectMapper not able to parse object'
def mockObjectMapper = Mock(ObjectMapper)
objectUnderTest.objectMapper = mockObjectMapper
then: 'exception is thrown'
thrown(NcmpException.class)
}
+
def 'Get resource data for pass-through operational from dmi return NOK response.'() {
- given: 'xpath'
- def xpath = "/dmi-registry/cm-handles[@id='testCmHandle']"
- and: 'data node'
- def dataNode = new DataNode()
- dataNode.leaves = ['dmi-service-name':'testDmiService']
- def childDataNode = new DataNode()
- childDataNode.leaves = ['name':'testName','value':'testValue']
- dataNode.childDataNodes = [childDataNode]
+ given: 'data node representing cmHandle and its properties'
+ def cmHandleDataNode = getCmHandleDataNodeForTest()
+ and: 'cps data service returns valid cmHandle data node'
mockCpsDataService.getDataNode('NCMP-Admin', 'ncmp-dmi-registry',
- xpath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> dataNode
+ cmHandleXPath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> cmHandleDataNode
and: 'dmi returns NOK response'
- mockDmiOperations.getResouceDataOperationalFromDmi('testDmiService',
+ mockDmiOperations.getResourceDataOperationalFromDmi('testDmiService',
'testCmHandle',
'testResourceId',
'testFieldQuery',
then: 'exception is thrown'
thrown(NcmpException.class)
}
+
def 'Get resource data for pass-through running from dmi.'() {
- given: 'xpath'
- def xpath = "/dmi-registry/cm-handles[@id='testCmHandle']"
- and: 'data node representing cmhandle and its properties'
- def dataNode = new DataNode()
- dataNode.leaves = ['dmi-service-name':'testDmiService']
- def childDataNode = new DataNode()
- childDataNode.leaves = ['name':'testName','value':'testValue']
- dataNode.childDataNodes = [childDataNode]
+ given: 'data node representing cmHandle and its properties'
+ def cmHandleDataNode = getCmHandleDataNodeForTest()
and: 'cpsDataService returns valid dataNode'
mockCpsDataService.getDataNode('NCMP-Admin', 'ncmp-dmi-registry',
- xpath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> dataNode
+ cmHandleXPath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> cmHandleDataNode
and: 'dmi returns valid response and data'
- mockDmiOperations.getResouceDataPassThroughRunningFromDmi('testDmiService',
+ mockDmiOperations.getResourceDataPassThroughRunningFromDmi('testDmiService',
'testCmHandle',
'testResourceId',
'testFieldQuery',
then: 'get resource data returns expected response'
response == '{result-json}'
}
+
def 'Get resource data for pass-through running from dmi threw parsing exception.'() {
- given: 'xpath'
- def xpath = "/dmi-registry/cm-handles[@id='testCmHandle']"
- and: 'data node representing cmhandle and its properties'
- def dataNode = new DataNode()
- dataNode.leaves = ['dmi-service-name':'testDmiService']
- def childDataNode = new DataNode()
- childDataNode.leaves = ['name':'testName','value':'testValue']
- dataNode.childDataNodes = [childDataNode]
+ given: 'data node representing cmHandle and its properties'
+ def cmHandleDataNode = getCmHandleDataNodeForTest()
and: 'cpsDataService returns valid dataNode'
mockCpsDataService.getDataNode('NCMP-Admin', 'ncmp-dmi-registry',
- xpath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> dataNode
+ cmHandleXPath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> cmHandleDataNode
and: 'objectMapper not able to parse object'
def mockObjectMapper = Mock(ObjectMapper)
objectUnderTest.objectMapper = mockObjectMapper
then: 'exception is thrown'
thrown(NcmpException.class)
}
+
def 'Get resource data for pass-through running from dmi return NOK response.'() {
- given: 'xpath'
- def xpath = "/dmi-registry/cm-handles[@id='testCmHandle']"
- and: 'data node representing cmhandle and its properties'
- def dataNode = new DataNode()
- dataNode.leaves = ['dmi-service-name':'testDmiService']
- def childDataNode = new DataNode()
- childDataNode.leaves = ['name':'testName','value':'testValue']
- dataNode.childDataNodes = [childDataNode]
+ given: 'data node representing cmHandle and its properties'
+ def cmHandleDataNode = getCmHandleDataNodeForTest()
and: 'cpsDataService returns valid dataNode'
mockCpsDataService.getDataNode('NCMP-Admin', 'ncmp-dmi-registry',
- xpath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> dataNode
+ cmHandleXPath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> cmHandleDataNode
and: 'dmi returns NOK response'
- mockDmiOperations.getResouceDataPassThroughRunningFromDmi('testDmiService',
+ mockDmiOperations.getResourceDataPassThroughRunningFromDmi('testDmiService',
'testCmHandle',
'testResourceId',
'testFieldQuery',
then: 'exception is thrown'
thrown(NcmpException.class)
}
+
+ def 'Write resource data for pass-through running from dmi using POST.'() {
+ given: 'data node representing cmHandle and its properties'
+ def cmHandleDataNode = getCmHandleDataNodeForTest()
+ and: 'cpsDataService returns valid cm-handle datanode'
+ mockCpsDataService.getDataNode('NCMP-Admin', 'ncmp-dmi-registry',
+ cmHandleXPath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> cmHandleDataNode
+ when: 'get resource data is called'
+ objectUnderTest.createResourceDataPassThroughRunningForCmHandle('testCmHandle',
+ 'testResourceId',
+ '{some-json}', 'application/json')
+ then: 'dmi called with correct data'
+ 1 * mockDmiOperations.createResourceDataPassThroughRunningFromDmi('testDmiService',
+ 'testCmHandle',
+ 'testResourceId',
+ '{"operation":"create","dataType":"application/json","data":"{some-json}","cmHandleProperties":{"testName":"testValue"}}')
+ >> { new ResponseEntity<>(HttpStatus.OK) }
+ }
+
+ def 'Write resource data for pass-through running from dmi using POST "not found" response (from DMI).'() {
+ given: 'data node representing cmHandle and its properties'
+ def cmHandleDataNode = getCmHandleDataNodeForTest()
+ and: 'cpsDataService returns valid dataNode'
+ mockCpsDataService.getDataNode('NCMP-Admin', 'ncmp-dmi-registry',
+ cmHandleXPath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> cmHandleDataNode
+ and: 'dmi throws exception'
+ mockDmiOperations.createResourceDataPassThroughRunningFromDmi(_ as String, _ as String, _ as String, _ as String)
+ >> { new ResponseEntity<>(HttpStatus.NOT_FOUND) }
+ when: 'get resource data is called'
+ objectUnderTest.createResourceDataPassThroughRunningForCmHandle('testCmHandle',
+ 'testResourceId',
+ '{some-json}', 'application/json')
+ then: 'exception is thrown'
+ thrown(NcmpException.class)
+ }
+
+ def 'Sync model for a (new) cm handle with #scenario'() {
+ given: 'DMI PLug-in returns a list of module references'
+ getModulesForCmHandle()
+ def knownModule1 = new ModuleReference('module1', '1')
+ def knownOtherModule = new ModuleReference('some other module', 'some revision')
+ and: 'CPS-Core returns list of known modules'
+ mockCpsModuleService.getYangResourceModuleReferences(_) >> [knownModule1, knownOtherModule]
+ and: 'DMI-Plugin returns resource(s) for "new" module(s)'
+ def moduleResources = new ResponseEntity<String>(sdncReponseBody, HttpStatus.OK)
+ mockDmiOperations.getResourceFromDmiWithJsonData(_, _, _, 'moduleResources') >> moduleResources
+ when: 'module Sync is triggered'
+ objectUnderTest.createAnchorAndSyncModel(cmHandleForModelSync)
+ then: 'the CPS module service is called once with the correct parameters'
+ 1 * mockCpsModuleService.createSchemaSetFromModules(expectedDataspaceNameForModleSync, cmHandleForModelSync.getId(), expectedYangResourceToContentMap, [knownModule1])
+ and: 'admin service create anchor method has been called with correct parameters'
+ 1 * mockCpsAdminService.createAnchor(expectedDataspaceNameForModleSync, cmHandleForModelSync.getId(), cmHandleForModelSync.getId())
+ where: 'the following responses are recieved from SDNC'
+ scenario | sdncReponseBody || expectedYangResourceToContentMap
+ 'one unknown module' | '[{"moduleName" : "someModule", "revision" : "1","yangSource": "[some yang source]"}]' || [someModule: 'some yang source']
+ 'no unknown module' | '[]' || [:]
+ }
+
+ def getModulesForCmHandle() {
+ def jsonData = TestUtils.getResourceFileContent('cmHandleModules.json')
+ mockDmiProperties.getAuthUsername() >> 'someUser'
+ mockDmiProperties.getAuthPassword() >> 'somePassword'
+ mockDmiProperties.getDmiPluginBasePath() >> 'someUrl'
+ def moduleReferencesFromCmHandleAsJson = new ResponseEntity<String>(jsonData, HttpStatus.OK)
+ mockDmiOperations.getResourceFromDmi(_, cmHandleForModelSync.getId(), 'modules') >> moduleReferencesFromCmHandleAsJson
+ }
+
+ def getObjectUnderTestWithModelSyncDisabled() {
+ def objectUnderTest = Spy(new NetworkCmProxyDataServiceImpl(mockDmiOperations, mockCpsModuleService,
+ mockCpsDataService, mockCpsQueryService, mockCpsAdminService, new ObjectMapper()))
+ objectUnderTest.createAnchorAndSyncModel(_) >> null
+ return objectUnderTest
+ }
+
+ def getCmHandleDataNodeForTest() {
+ def cmHandleDataNode = new DataNode()
+ cmHandleDataNode.leaves = ['dmi-service-name': 'testDmiService']
+ def cmHandlePropertyDataNode = new DataNode()
+ cmHandlePropertyDataNode.leaves = ['name': 'testName', 'value': 'testValue']
+ cmHandleDataNode.childDataNodes = [cmHandlePropertyDataNode]
+ return cmHandleDataNode
+ }
+
}
Code Review / cps.git / blobdiff