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=65f007d14f050c4c4b1186963c4dfeb701b19531;hb=6369af0f6cb53619daa253d5da0f360f2bf67fc3;hp=5753d7b675c0b38cda4b1c74e1ac4ddb4b0cde03;hpb=87b991eb6502c20f441d00faa953f82de04fe12d;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 5753d7b67..65f007d14 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 @@ -2,7 +2,7 @@ * ============LICENSE_START======================================================= * 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,18 +22,27 @@ 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 org.onap.cps.ncmp.api.models.DmiPluginRegistration +import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle +import org.onap.cps.spi.exceptions.DataValidationException +import org.onap.cps.ncmp.api.inventory.sync.ModuleSyncService +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.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.ncmp.api.impl.exception.NcmpException import org.onap.cps.ncmp.api.impl.operations.DmiDataOperations import org.onap.cps.spi.FetchDescendantsOption import org.onap.cps.spi.model.DataNode @@ -46,42 +55,57 @@ class NetworkCmProxyDataServiceImplSpec extends Specification { def mockCpsDataService = Mock(CpsDataService) def mockCpsModuleService = Mock(CpsModuleService) def mockCpsAdminService = Mock(CpsAdminService) - def spyObjectMapper = Spy(ObjectMapper) + def spiedJsonObjectMapper = Spy(new JsonObjectMapper(new ObjectMapper())) def mockDmiDataOperations = Mock(DmiDataOperations) + def nullNetworkCmProxyDataServicePropertyHandler = null + def mockYangModelCmHandleRetriever = Mock(YangModelCmHandleRetriever) + def mockModuleSyncService = Mock(ModuleSyncService) + def mockDmiPluginRegistration = Mock(DmiPluginRegistration) + + def NO_TOPIC = null + def NO_REQUEST_ID = null + @Shared + def OPTIONS_PARAM = '(a=1,b=2)' + @Shared + def ncmpServiceCmHandle = new NcmpServiceCmHandle(cmHandleId: 'some-cm-handle-id') - def objectUnderTest = new NetworkCmProxyDataServiceImpl(mockDmiDataOperations, null, - mockCpsModuleService, mockCpsDataService, mockCpsAdminService, spyObjectMapper) + def objectUnderTest = new NetworkCmProxyDataServiceImpl(mockCpsDataService, spiedJsonObjectMapper, mockDmiDataOperations, + mockCpsModuleService, mockCpsAdminService, nullNetworkCmProxyDataServicePropertyHandler, mockYangModelCmHandleRetriever, mockModuleSyncService) def cmHandleXPath = "/dmi-registry/cm-handles[@id='testCmHandle']" + def dataNode = new DataNode(leaves: ['id': 'Some-Cm-Handle', 'dmi-service-name': 'testDmiService']) - def 'Write resource data for pass-through running from dmi using POST #scenario cm handle properties.'() { - given: 'a data node' - def dataNode = getDataNode(includeCmHandleProperties) - and: 'cpsDataService returns valid datanode' + 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) >> dataNode when: 'get resource data is called' objectUnderTest.writeResourceDataPassThroughRunningForCmHandle('testCmHandle', 'testResourceId', CREATE, '{some-json}', 'application/json') - then: 'dmi called with correct data' + then: 'DMI called with correct data' 1 * mockDmiDataOperations.writeResourceDataPassThroughRunningFromDmi('testCmHandle', 'testResourceId', CREATE, '{some-json}', 'application/json') >> { new ResponseEntity<>(HttpStatus.CREATED) } - where: - scenario | includeCmHandleProperties || expectedJsonForCmhandleProperties - 'with' | true || '{"testName":"testValue"}' - 'without' | false || '{}' } - def 'Write resource data for pass-through running from dmi using POST "not found" response (from DMI).'() { - given: 'a data node' - def dataNode = getDataNode(true) - and: 'cpsDataService returns valid dataNode' + def 'Write resource data for pass-through running from DMI using an invalid id.'() { + when: 'write resource data is called' + objectUnderTest.writeResourceDataPassThroughRunningForCmHandle('invalid cm handle name', + 'testResourceId', CREATE, + '{some-json}', 'application/json') + then: 'exception is thrown' + thrown(DataValidationException.class) + and: 'DMI is not invoked' + 0 * mockDmiDataOperations.writeResourceDataPassThroughRunningFromDmi(_, _, _, _, _) + } + + 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) >> dataNode - and: 'dmi returns a response with 404 status code' + and: 'DMI returns a response with 404 status code' mockDmiDataOperations.writeResourceDataPassThroughRunningFromDmi('testCmHandle', 'testResourceId', CREATE, '{some-json}', 'application/json') @@ -91,131 +115,161 @@ class NetworkCmProxyDataServiceImplSpec extends Specification { 'testResourceId', CREATE, '{some-json}', 'application/json') then: 'exception is thrown' - def exceptionThrown = thrown(NcmpException.class) - and: 'details contains (not found) error code: 404' - exceptionThrown.details.contains('404') + 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.'() { - given: 'a data node' - def dataNode = getDataNode(true) - and: 'get data node is called' + 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) >> dataNode - and: 'get resource data from dmi is called' + and: 'get resource data from DMI is called' mockDmiDataOperations.getResourceDataFromDmi( - 'testCmHandle', - 'testResourceId', - '(a=1,b=2)', - 'testAcceptParam' , - PASSTHROUGH_OPERATIONAL) >> new ResponseEntity<>('result-json', HttpStatus.OK) + 'testCmHandle', + 'testResourceId', + 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', + OPTIONS_PARAM, + NO_TOPIC, + NO_REQUEST_ID) + then: 'DMI returns a json response' + response == 'dmi-response' + } + + def 'Get resource data for pass-through operational from DMI with invalid name.'() {\ + when: 'get resource data operational for cm-handle is called' + objectUnderTest.getResourceDataOperationalForCmHandle('invalid test cm handle', 'testResourceId', - 'testAcceptParam', - '(a=1,b=2)') - then: 'dmi returns a json response' - response == 'result-json' + OPTIONS_PARAM, + NO_TOPIC, + NO_REQUEST_ID) + then: 'A data validation Exception is thrown' + thrown(DataValidationException) } - def 'Get resource data for pass-through operational from dmi with Json Processing Exception.'() { - given: 'a data node' - def dataNode = getDataNode(true) - and: 'cps data service returns valid data node' + 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) >> dataNode and: 'objectMapper not able to parse object' - def mockObjectMapper = Mock(ObjectMapper) - objectUnderTest.objectMapper = mockObjectMapper - mockObjectMapper.writeValueAsString(_) >> { throw new JsonProcessingException('testException') } - and: 'dmi returns NOK response' + 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' objectUnderTest.getResourceDataOperationalForCmHandle('testCmHandle', - 'testResourceId', - 'testAcceptParam', - '(a=1,b=2)') - then: 'exception is thrown with the expected details' - def exceptionThrown = thrown(NcmpException.class) - exceptionThrown.details == 'DMI status code: 404, DMI response body: NOK-json' + 'testResourceId', + 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 operational from dmi return NOK response.'() { - given: 'a data node' - def dataNode = getDataNode(true) - and: 'cps data service returns valid data node' + 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) >> dataNode - and: 'dmi returns NOK response' + and: 'DMI returns NOK response' mockDmiDataOperations.getResourceDataFromDmi('testCmHandle', - 'testResourceId', - '(a=1,b=2)', - 'testAcceptParam', - PASSTHROUGH_OPERATIONAL) - >> new ResponseEntity<>('NOK-json', HttpStatus.NOT_FOUND) + 'testResourceId', + OPTIONS_PARAM, + PASSTHROUGH_OPERATIONAL, + NO_REQUEST_ID, + NO_TOPIC) + >> new ResponseEntity<>('NOK-json', HttpStatus.NOT_FOUND) when: 'get resource data is called' objectUnderTest.getResourceDataOperationalForCmHandle('testCmHandle', - 'testResourceId', - 'testAcceptParam', - '(a=1,b=2)') + 'testResourceId', + OPTIONS_PARAM, + NO_TOPIC, + NO_REQUEST_ID) then: 'exception is thrown' - def exceptionThrown = thrown(NcmpException.class) - and: 'details contains the original response' + def exceptionThrown = thrown(HttpClientRequestException.class) + and: 'details contain the original response' + exceptionThrown.httpStatus == HttpStatus.NOT_FOUND.value() exceptionThrown.details.contains('NOK-json') } - def 'Get resource data for pass-through running from dmi.'() { - given: 'a data node' - def dataNode = getDataNode(true) - and: 'cpsDataService returns valid data node' + 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) >> dataNode - and: 'dmi returns valid response and data' + and: 'DMI returns valid response and data' mockDmiDataOperations.getResourceDataFromDmi('testCmHandle', - 'testResourceId', - '(a=1,b=2)', - 'testAcceptParam', - PASSTHROUGH_RUNNING) >> new ResponseEntity<>('{result-json}', HttpStatus.OK) + 'testResourceId', + OPTIONS_PARAM, + PASSTHROUGH_RUNNING, + NO_REQUEST_ID, + NO_TOPIC) >> new ResponseEntity<>('{dmi-response}', HttpStatus.OK) when: 'get resource data is called' def response = objectUnderTest.getResourceDataPassThroughRunningForCmHandle('testCmHandle', - 'testResourceId', - 'testAcceptParam', - '(a=1,b=2)') + 'testResourceId', + OPTIONS_PARAM, + NO_TOPIC, + NO_REQUEST_ID) then: 'get resource data returns expected response' - response == '{result-json}' + response == '{dmi-response}' } - def 'Get resource data for pass-through running from dmi return NOK response.'() { - given: 'a data node' - def dataNode = getDataNode(true) - and: 'cpsDataService returns valid dataNode' + def 'Get resource data for pass-through running from DMI with invalid name.'() { + when: 'get resource data operational for cm-handle is called' + objectUnderTest.getResourceDataPassThroughRunningForCmHandle('invalid test cm handle', + 'testResourceId', + OPTIONS_PARAM, + NO_TOPIC, + NO_REQUEST_ID) + then: 'A data validation Exception is thrown' + thrown(DataValidationException) + } + + 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) >> dataNode - and: 'dmi returns NOK response' + and: 'DMI returns NOK response' mockDmiDataOperations.getResourceDataFromDmi('testCmHandle', - 'testResourceId', - '(a=1,b=2)', - 'testAcceptParam', - PASSTHROUGH_RUNNING) - >> new ResponseEntity<>('NOK-json', HttpStatus.NOT_FOUND) + 'testResourceId', + OPTIONS_PARAM, + PASSTHROUGH_RUNNING, + NO_REQUEST_ID, + NO_TOPIC) + >> new ResponseEntity<>('NOK-json', HttpStatus.NOT_FOUND) when: 'get resource data is called' objectUnderTest.getResourceDataPassThroughRunningForCmHandle('testCmHandle', - 'testResourceId', - 'testAcceptParam', - '(a=1,b=2)') + 'testResourceId', + OPTIONS_PARAM, + NO_TOPIC, + NO_REQUEST_ID) then: 'exception is thrown' - def exceptionThrown = thrown(NcmpException.class) - and: 'details contains the original response' + def exceptionThrown = thrown(HttpClientRequestException.class) + and: 'details contain the original response' exceptionThrown.details.contains('NOK-json') + exceptionThrown.httpStatus == HttpStatus.NOT_FOUND.value() } def 'Getting Yang Resources.'() { when: 'yang resources is called' - objectUnderTest.getYangResourcesModuleReferences('some cm handle') + 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') + 1 * mockCpsModuleService.getYangResourcesModuleReferences('NFP-Operational','some-cm-handle') + } + + def 'Getting Yang Resources with an invalid #scenario.'() { + when: 'yang resources is called' + objectUnderTest.getYangResourcesModuleReferences('invalid cm handle with spaces') + then: 'a data validation exception is thrown' + thrown(DataValidationException) + and: 'CPS module services is not invoked' + 0 * mockCpsModuleService.getYangResourcesModuleReferences(_, _) } def 'Get cm handle identifiers for the given module names.'() { @@ -225,25 +279,43 @@ class NetworkCmProxyDataServiceImplSpec extends Specification { 1 * mockCpsAdminService.queryAnchorNames('NFP-Operational', ['some-module-name']) } + 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.getYangModelCmHandle('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 'Update resource data for pass-through running from dmi using POST #scenario cm handle properties.'() { - given: 'a data node' - def dataNode = getDataNode(includeCmHandleProperties) - and: 'cpsDataService returns valid datanode' + } + + def 'Get a cm handle with an invalid id.'() { + when: 'getting cm handle details for a given cm handle id with an invalid name' + objectUnderTest.getNcmpServiceCmHandle('invalid cm handle with spaces') + then: 'an exception is thrown' + thrown(DataValidationException) + and: 'the yang model cm handle retriever is not invoked' + 0 * mockYangModelCmHandleRetriever.getYangModelCmHandle(_) + } + + 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' + then: 'DMI called with correct data' 1 * mockDmiDataOperations.writeResourceDataPassThroughRunningFromDmi('testCmHandle', 'testResourceId', UPDATE, '{some-json}', 'application/json') >> { new ResponseEntity<>(HttpStatus.OK) } - where: - scenario | includeCmHandleProperties || expectedJsonForCmhandleProperties - 'with' | true || '{"testName":"testValue"}' - 'without' | false || '{}' } def 'Verify error message from handleResponse is correct for #scenario operation.'() { @@ -251,30 +323,35 @@ class NetworkCmProxyDataServiceImplSpec extends Specification { mockDmiDataOperations.writeResourceDataPassThroughRunningFromDmi(*_) >> new ResponseEntity<>(HttpStatus.NOT_FOUND) when: 'get resource data is called' - def response = objectUnderTest.writeResourceDataPassThroughRunningForCmHandle( + objectUnderTest.writeResourceDataPassThroughRunningForCmHandle( 'testCmHandle', 'testResourceId', givenOperation, '{some-json}', 'application/json') - then: 'an exception is thrown with the expected error message detailsd with correct operation' - def exceptionThrown = thrown(NcmpException.class) + 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 || 'Not able to create resource data.' - 'READ' | READ || 'Not able to read resource data.' - 'UPDATE' | UPDATE || 'Not able to update resource data.' + 'CREATE' | CREATE || 'Unable to create resource data.' + 'READ' | READ || 'Unable to read resource data.' + 'UPDATE' | UPDATE || 'Unable to update resource data.' } - def getDataNode(boolean includeCmHandleProperties) { - def dataNode = new DataNode() - dataNode.leaves = ['dmi-service-name': 'testDmiService'] - if (includeCmHandleProperties) { - def cmHandlePropertyDataNode = new DataNode() - cmHandlePropertyDataNode.leaves = ['name': 'testName', 'value': 'testValue'] - dataNode.childDataNodes = [cmHandlePropertyDataNode] - } - return dataNode + def 'Verify modules and create anchor params'() { + given: 'dmi plugin registration return created cm handles' + def dmiPluginRegistration = new DmiPluginRegistration(dmiPlugin: 'service1', dmiModelPlugin: 'service1', + dmiDataPlugin: 'service2') + dmiPluginRegistration.createdCmHandles = [ncmpServiceCmHandle] + mockDmiPluginRegistration.getCreatedCmHandles() >> [ncmpServiceCmHandle] + when: 'parse and create cm handle in dmi registration then sync module' + objectUnderTest.parseAndCreateCmHandlesInDmiRegistrationAndSyncModules(mockDmiPluginRegistration) + then: 'validate params for creating anchor and list elements' + 1 * mockCpsDataService.saveListElements('NCMP-Admin', 'ncmp-dmi-registry', + '/dmi-registry', '{"cm-handles":[{"id":"some-cm-handle-id",' + + '"additional-properties":[],"public-properties":[]}]}', null) + 1 * mockCpsAdminService.createAnchor('NFP-Operational', null, + 'some-cm-handle-id') } }