X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=cps-ncmp-service%2Fsrc%2Ftest%2Fgroovy%2Forg%2Fonap%2Fcps%2Fncmp%2Fapi%2Fimpl%2FNetworkCmProxyDataServiceImplSpec.groovy;h=2d01dba522cb2f48a6facf1b38c7d90ec98aa8dd;hb=ea01d09861289ff162dff318713d1c24eba89259;hp=3ebb4550c3fda4b45ff2411a84c2d8d7002a0d55;hpb=bb61bf010fdce1aef6a0580243684cad6fb942bf;p=cps.git diff --git a/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/impl/NetworkCmProxyDataServiceImplSpec.groovy b/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/impl/NetworkCmProxyDataServiceImplSpec.groovy index 3ebb4550c..2d01dba52 100644 --- a/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/impl/NetworkCmProxyDataServiceImplSpec.groovy +++ b/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/impl/NetworkCmProxyDataServiceImplSpec.groovy @@ -1,8 +1,8 @@ /* * ============LICENSE_START======================================================= - * Copyright (C) 2021 Nordix Foundation + * Copyright (C) 2021-2022 Nordix Foundation * Modifications Copyright (C) 2021 Pantheon.tech - * Modifications Copyright (C) 2021 Bell Canada + * Modifications Copyright (C) 2021-2022 Bell Canada * ================================================================================ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -22,380 +22,262 @@ package org.onap.cps.ncmp.api.impl +import org.onap.cps.ncmp.api.impl.exception.HttpClientRequestException +import org.onap.cps.ncmp.api.impl.operations.YangModelCmHandleRetriever +import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle +import spock.lang.Shared + +import static org.onap.cps.ncmp.api.impl.operations.DmiOperations.DataStoreEnum.PASSTHROUGH_OPERATIONAL +import static org.onap.cps.ncmp.api.impl.operations.DmiOperations.DataStoreEnum.PASSTHROUGH_RUNNING +import static org.onap.cps.ncmp.api.impl.operations.DmiRequestBody.OperationEnum.CREATE +import static org.onap.cps.ncmp.api.impl.operations.DmiRequestBody.OperationEnum.READ +import static org.onap.cps.ncmp.api.impl.operations.DmiRequestBody.OperationEnum.UPDATE + +import org.onap.cps.ncmp.api.impl.operations.DmiModelOperations +import org.onap.cps.utils.JsonObjectMapper 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.utils.TestUtils +import org.onap.cps.ncmp.api.impl.operations.DmiDataOperations 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 import spock.lang.Specification class NetworkCmProxyDataServiceImplSpec extends Specification { - @Shared - def persistenceCmHandle = new CmHandle() - @Shared - def cmHandlesArray = ['cmHandle001'] - def mockCpsDataService = Mock(CpsDataService) - def mockCpsQueryService = Mock(CpsQueryService) - def mockDmiOperations = Mock(DmiOperations) def mockCpsModuleService = Mock(CpsModuleService) def mockCpsAdminService = Mock(CpsAdminService) - def mockDmiProperties = Mock(NcmpConfiguration.DmiProperties) + def spiedJsonObjectMapper = Spy(new JsonObjectMapper(new ObjectMapper())) + def mockDmiModelOperations = Mock(DmiModelOperations) + def mockDmiDataOperations = Mock(DmiDataOperations) + def nullNetworkCmProxyDataServicePropertyHandler = null + def mockYangModelCmHandleRetriever = Mock(YangModelCmHandleRetriever) + def NO_TOPIC = null + def NO_REQUEST_ID = null + @Shared + def OPTIONS_PARAM = '(a=1,b=2)' - def objectUnderTest = new NetworkCmProxyDataServiceImpl(mockDmiOperations, mockCpsModuleService, - mockCpsDataService, mockCpsQueryService, mockCpsAdminService, new ObjectMapper()) + def objectUnderTest = new NetworkCmProxyDataServiceImpl(mockCpsDataService, spiedJsonObjectMapper, mockDmiDataOperations, mockDmiModelOperations, + mockCpsModuleService, mockCpsAdminService, nullNetworkCmProxyDataServicePropertyHandler, mockYangModelCmHandleRetriever) - 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 expectedDataspaceName = 'NFP-Operational' - def 'Query data nodes by cps path with #fetchDescendantsOption.'() { - given: 'a cm Handle and a cps path' - def cpsPath = '/cps-path' - when: 'queryDataNodes is invoked' - objectUnderTest.queryDataNodes(cmHandle, cpsPath, fetchDescendantsOption) - then: 'the persistence service is called once with the correct parameters' - 1 * mockCpsQueryService.queryDataNodes(expectedDataspaceName, cmHandle, cpsPath, 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, 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' - def xpath = '/test-node' - 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, noTimestamp) - } - - def 'Add list-node elements.'() { - given: 'a cm handle and parent node xpath' - def jsonData = 'some json' - def xpath = '/test-node' - 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, noTimestamp) - } - - def 'Update data node leaves.'() { - given: 'a cm Handle and a cps path' - def xpath = '/xpath' - def jsonData = 'some json' - 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, noTimestamp) - } + def dataNode = new DataNode(leaves: ['dmi-service-name': 'testDmiService']) - def 'Replace data node tree.'() { - given: 'a cm Handle and a cps path' - def xpath = '/xpath' - def jsonData = 'some json' - 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, noTimestamp) - } - - def 'Register or re-register a DMI Plugin with #scenario cm handles.'() { - given: 'a registration ' - 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.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, 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 | 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' - persistenceCmHandle.cmHandleProperties = null - dmiPluginRegistration.createdCmHandles = [persistenceCmHandle ] - def expectedJsonData = '{"cm-handles":[{"id":"123","dmi-service-name":"my-server","additional-properties":[]}]}' - when: 'registration is updated' - 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, noTimestamp) - } - - def 'Get resource data for pass-through operational from dmi.'() { - given: 'data node representing cmHandle and its properties' - def cmHandleDataNode = getCmHandleDataNodeForTest() - and: 'data node is got from data service' + def 'Write resource data for pass-through running from DMI using POST #scenario cm handle properties.'() { + given: 'cpsDataService returns valid datanode' 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) + cmHandleXPath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> dataNode when: 'get resource data is called' - def response = objectUnderTest.getResourceDataOperationalForCmHandle('testCmHandle', - 'testResourceId', - 'testAcceptParam', - 'testFieldQuery', - 5) - then: 'dmi returns ok response' - response == 'result-json' + objectUnderTest.writeResourceDataPassThroughRunningForCmHandle('testCmHandle', + 'testResourceId', CREATE, + '{some-json}', 'application/json') + then: 'DMI called with correct data' + 1 * mockDmiDataOperations.writeResourceDataPassThroughRunningFromDmi('testCmHandle', 'testResourceId', + CREATE, '{some-json}', 'application/json') + >> { new ResponseEntity<>(HttpStatus.CREATED) } } - def 'Get resource data for pass-through operational from dmi threw parsing exception.'() { - given: 'data node representing cmHandle and its properties' - def cmHandleDataNode = getCmHandleDataNodeForTest() - and: 'cps data service returns valid cmHandle data node' + def 'Write resource data for pass-through running from DMI using POST "not found" response (from DMI).'() { + given: 'cpsDataService returns valid dataNode' mockCpsDataService.getDataNode('NCMP-Admin', 'ncmp-dmi-registry', - cmHandleXPath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> cmHandleDataNode - and: 'objectMapper not able to parse object' - def mockObjectMapper = Mock(ObjectMapper) - objectUnderTest.objectMapper = mockObjectMapper - mockObjectMapper.writeValueAsString(_) >> { throw new JsonProcessingException("testException") } - when: 'get resource data is called' - def response = objectUnderTest.getResourceDataOperationalForCmHandle('testCmHandle', - 'testResourceId', - 'testAcceptParam', - 'testFieldQuery', - 5) + cmHandleXPath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> dataNode + and: 'DMI returns a response with 404 status code' + mockDmiDataOperations.writeResourceDataPassThroughRunningFromDmi('testCmHandle', + 'testResourceId', CREATE, + '{some-json}', 'application/json') + >> { new ResponseEntity<>(HttpStatus.NOT_FOUND) } + when: 'write resource data is called' + objectUnderTest.writeResourceDataPassThroughRunningForCmHandle('testCmHandle', + 'testResourceId', CREATE, + '{some-json}', 'application/json') then: 'exception is thrown' - thrown(NcmpException.class) + def exceptionThrown = thrown(HttpClientRequestException.class) + and: 'http status (not found) error code: 404' + exceptionThrown.httpStatus == HttpStatus.NOT_FOUND.value() } - def 'Get resource data for pass-through operational from dmi return NOK response.'() { - given: 'data node representing cmHandle and its properties' - def cmHandleDataNode = getCmHandleDataNodeForTest() - and: 'cps data service returns valid cmHandle data node' + def 'Get resource data for pass-through operational from DMI.'() { + given: 'get data node is called' mockCpsDataService.getDataNode('NCMP-Admin', 'ncmp-dmi-registry', - cmHandleXPath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> cmHandleDataNode - and: 'dmi returns NOK response' - mockDmiOperations.getResourceDataOperationalFromDmi('testDmiService', + cmHandleXPath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> dataNode + and: 'get resource data from DMI is called' + mockDmiDataOperations.getResourceDataFromDmi( 'testCmHandle', 'testResourceId', - 'testFieldQuery', - 5, - 'testAcceptParam', - '{"operation":"read","cmHandleProperties":{"testName":"testValue"}}') - >> new ResponseEntity<>('NOK-json', HttpStatus.NOT_FOUND) - when: 'get resource data is called' + OPTIONS_PARAM, + PASSTHROUGH_OPERATIONAL, + NO_REQUEST_ID, + NO_TOPIC) >> new ResponseEntity<>('dmi-response', HttpStatus.OK) + when: 'get resource data operational for cm-handle is called' def response = objectUnderTest.getResourceDataOperationalForCmHandle('testCmHandle', 'testResourceId', - 'testAcceptParam', - 'testFieldQuery', - 5) - then: 'exception is thrown' - thrown(NcmpException.class) + OPTIONS_PARAM, + NO_TOPIC, + NO_REQUEST_ID) + then: 'DMI returns a json response' + response == 'dmi-response' } - def 'Get resource data for pass-through running from dmi.'() { - given: 'data node representing cmHandle and its properties' - def cmHandleDataNode = getCmHandleDataNodeForTest() - and: 'cpsDataService returns valid dataNode' + def 'Get resource data for pass-through operational from DMI with Json Processing Exception.'() { + given: 'cps data service returns valid data node' mockCpsDataService.getDataNode('NCMP-Admin', 'ncmp-dmi-registry', - cmHandleXPath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> cmHandleDataNode - and: 'dmi returns valid response and data' - mockDmiOperations.getResourceDataPassThroughRunningFromDmi('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.getResourceDataPassThroughRunningForCmHandle('testCmHandle', - 'testResourceId', - 'testAcceptParam', - 'testFieldQuery', - 5) - then: 'get resource data returns expected response' - response == '{result-json}' - } - - def 'Get resource data for pass-through running from dmi threw parsing exception.'() { - 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 + cmHandleXPath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> dataNode and: 'objectMapper not able to parse object' - def mockObjectMapper = Mock(ObjectMapper) - objectUnderTest.objectMapper = mockObjectMapper - mockObjectMapper.writeValueAsString(_) >> { throw new JsonProcessingException("testException") } + spiedJsonObjectMapper.asJsonString(_) >> { throw new JsonProcessingException('testException') } + and: 'DMI returns NOK response' + mockDmiDataOperations.getResourceDataFromDmi(*_) + >> new ResponseEntity<>('NOK-json', HttpStatus.NOT_FOUND) when: 'get resource data is called' - def response = objectUnderTest.getResourceDataPassThroughRunningForCmHandle('testCmHandle', + objectUnderTest.getResourceDataOperationalForCmHandle('testCmHandle', 'testResourceId', - 'testAcceptParam', - 'testFieldQuery', - 5) - then: 'exception is thrown' - thrown(NcmpException.class) + OPTIONS_PARAM, + NO_TOPIC, + NO_REQUEST_ID) + then: 'exception is thrown with the expected response code and details' + def exceptionThrown = thrown(HttpClientRequestException.class) + exceptionThrown.details.contains('NOK-json') + exceptionThrown.httpStatus == HttpStatus.NOT_FOUND.value() } - def 'Get resource data for pass-through running from dmi return NOK response.'() { - given: 'data node representing cmHandle and its properties' - def cmHandleDataNode = getCmHandleDataNodeForTest() - and: 'cpsDataService returns valid dataNode' + def 'Get resource data for pass-through operational from DMI return NOK response.'() { + given: 'cps data service returns valid data node' mockCpsDataService.getDataNode('NCMP-Admin', 'ncmp-dmi-registry', - cmHandleXPath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> cmHandleDataNode - and: 'dmi returns NOK response' - mockDmiOperations.getResourceDataPassThroughRunningFromDmi('testDmiService', - 'testCmHandle', + cmHandleXPath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> dataNode + and: 'DMI returns NOK response' + mockDmiDataOperations.getResourceDataFromDmi('testCmHandle', 'testResourceId', - 'testFieldQuery', - 5, - 'testAcceptParam', - '{"operation":"read","cmHandleProperties":{"testName":"testValue"}}') + OPTIONS_PARAM, + PASSTHROUGH_OPERATIONAL, + NO_REQUEST_ID, + NO_TOPIC) >> new ResponseEntity<>('NOK-json', HttpStatus.NOT_FOUND) when: 'get resource data is called' - def response = objectUnderTest.getResourceDataPassThroughRunningForCmHandle('testCmHandle', + objectUnderTest.getResourceDataOperationalForCmHandle('testCmHandle', 'testResourceId', - 'testAcceptParam', - 'testFieldQuery', - 5) + OPTIONS_PARAM, + NO_TOPIC, + NO_REQUEST_ID) then: 'exception is thrown' - thrown(NcmpException.class) + def exceptionThrown = thrown(HttpClientRequestException.class) + and: 'details contain the original response' + exceptionThrown.httpStatus == HttpStatus.NOT_FOUND.value() + exceptionThrown.details.contains('NOK-json') } - 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' + def 'Get resource data for pass-through running from DMI.'() { + given: 'cpsDataService returns valid data node' mockCpsDataService.getDataNode('NCMP-Admin', 'ncmp-dmi-registry', - cmHandleXPath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> cmHandleDataNode + cmHandleXPath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> dataNode + and: 'DMI returns valid response and data' + mockDmiDataOperations.getResourceDataFromDmi('testCmHandle', + 'testResourceId', + OPTIONS_PARAM, + PASSTHROUGH_RUNNING, + NO_REQUEST_ID, + NO_TOPIC) >> new ResponseEntity<>('{dmi-response}', HttpStatus.OK) when: 'get resource data is called' - objectUnderTest.createResourceDataPassThroughRunningForCmHandle('testCmHandle', + def response = objectUnderTest.getResourceDataPassThroughRunningForCmHandle('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) } + OPTIONS_PARAM, + NO_TOPIC, + NO_REQUEST_ID) + then: 'get resource data returns expected response' + response == '{dmi-response}' } - 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' + def 'Get resource data for pass-through running from DMI return NOK response.'() { + given: '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) } + cmHandleXPath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> dataNode + and: 'DMI returns NOK response' + mockDmiDataOperations.getResourceDataFromDmi('testCmHandle', + 'testResourceId', + OPTIONS_PARAM, + PASSTHROUGH_RUNNING, + NO_REQUEST_ID, + NO_TOPIC) + >> new ResponseEntity<>('NOK-json', HttpStatus.NOT_FOUND) when: 'get resource data is called' - objectUnderTest.createResourceDataPassThroughRunningForCmHandle('testCmHandle', + objectUnderTest.getResourceDataPassThroughRunningForCmHandle('testCmHandle', 'testResourceId', - '{some-json}', 'application/json') + OPTIONS_PARAM, + NO_TOPIC, + NO_REQUEST_ID) then: 'exception is thrown' - thrown(NcmpException.class) + def exceptionThrown = thrown(HttpClientRequestException.class) + and: 'details contain the original response' + exceptionThrown.details.contains('NOK-json') + exceptionThrown.httpStatus == HttpStatus.NOT_FOUND.value() } - 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(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(expectedDataspaceName, cmHandleForModelSync.getId(), expectedYangResourceToContentMap, [knownModule1]) - and: 'admin service create anchor method has been called with correct parameters' - 1 * mockCpsAdminService.createAnchor(expectedDataspaceName, 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 'Getting Yang Resources.'() { + when: 'yang resources is called' + objectUnderTest.getYangResourcesModuleReferences('some-cm-handle') + then: 'CPS module services is invoked for the correct dataspace and cm handle' + 1 * mockCpsModuleService.getYangResourcesModuleReferences('NFP-Operational','some-cm-handle') } - def getModulesForCmHandle() { - def jsonData = TestUtils.getResourceFileContent('cmHandleModules.json') - mockDmiProperties.getAuthUsername() >> 'someUser' - mockDmiProperties.getAuthPassword() >> 'somePassword' - mockDmiProperties.getDmiPluginBasePath() >> 'someUrl' - def moduleReferencesFromCmHandleAsJson = new ResponseEntity(jsonData, HttpStatus.OK) - mockDmiOperations.getResourceFromDmi(_, cmHandleForModelSync.getId(), 'modules') >> moduleReferencesFromCmHandleAsJson + def 'Get cm handle identifiers for the given module names.'() { + when: 'execute a cm handle search for the given module names' + objectUnderTest.executeCmHandleHasAllModulesSearch(['some-module-name']) + then: 'get anchor identifiers is invoked with the expected parameters' + 1 * mockCpsAdminService.queryAnchorNames('NFP-Operational', ['some-module-name']) } - def getObjectUnderTestWithModelSyncDisabled() { - def objectUnderTest = Spy(new NetworkCmProxyDataServiceImpl(mockDmiOperations, mockCpsModuleService, - mockCpsDataService, mockCpsQueryService, mockCpsAdminService, new ObjectMapper())) - objectUnderTest.createAnchorAndSyncModel(_) >> null - return objectUnderTest + def 'Get a cm handle.'() { + given: 'the system returns a yang modelled cm handle' + def dmiServiceName = 'some service name' + def dmiProperties = [new YangModelCmHandle.Property('Book', 'Romance Novel')] + def publicProperties = [new YangModelCmHandle.Property('Public Book', 'Public Romance Novel')] + def yangModelCmHandle = new YangModelCmHandle(id:'Some-Cm-Handle', dmiServiceName: dmiServiceName, dmiProperties: dmiProperties, publicProperties: publicProperties) + 1 * mockYangModelCmHandleRetriever.getDmiServiceNamesAndProperties('Some-Cm-Handle') >> yangModelCmHandle + when: 'getting cm handle details for a given cm handle id from ncmp service' + def result = objectUnderTest.getNcmpServiceCmHandle('Some-Cm-Handle') + then: 'the result returns the correct data' + result.cmHandleID == 'Some-Cm-Handle' + result.dmiProperties ==[ Book:'Romance Novel' ] + result.publicProperties == [ "Public Book":'Public Romance Novel' ] + } - 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 + def 'Update resource data for pass-through running from dmi using POST #scenario DMI properties.'() { + given: 'cpsDataService returns valid datanode' + mockCpsDataService.getDataNode('NCMP-Admin', 'ncmp-dmi-registry', + cmHandleXPath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> dataNode + when: 'get resource data is called' + objectUnderTest.writeResourceDataPassThroughRunningForCmHandle('testCmHandle', + 'testResourceId', UPDATE, + '{some-json}', 'application/json') + then: 'DMI called with correct data' + 1 * mockDmiDataOperations.writeResourceDataPassThroughRunningFromDmi('testCmHandle', 'testResourceId', + UPDATE, '{some-json}', 'application/json') + >> { new ResponseEntity<>(HttpStatus.OK) } } + def 'Verify error message from handleResponse is correct for #scenario operation.'() { + given: 'writeResourceDataPassThroughRunningFromDmi fails to return OK HttpStatus' + mockDmiDataOperations.writeResourceDataPassThroughRunningFromDmi(*_) + >> new ResponseEntity<>(HttpStatus.NOT_FOUND) + when: 'get resource data is called' + objectUnderTest.writeResourceDataPassThroughRunningForCmHandle( + 'testCmHandle', + 'testResourceId', + givenOperation, + '{some-json}', + 'application/json') + then: 'an exception is thrown with the expected error message details with correct operation' + def exceptionThrown = thrown(HttpClientRequestException.class) + exceptionThrown.getMessage().contains(expectedResponseMessage) + where: + scenario | givenOperation || expectedResponseMessage + 'CREATE' | CREATE || 'Unable to create resource data.' + 'READ' | READ || 'Unable to read resource data.' + 'UPDATE' | UPDATE || 'Unable to update resource data.' + } }