From 4f736db2a0ab0df49b5cae6599da8e655c5ea8cd Mon Sep 17 00:00:00 2001 From: ToineSiebelink Date: Mon, 20 Sep 2021 13:29:09 +0100 Subject: Address Sonar Qube issues - Add some basic test for missed coverage - Refactored NetworkCmProxyDataServiceImpl to addres duplcaied code and code coverage - Increased Coverage treshold where possible Issue-ID: CPS-475 Signed-off-by: ToineSiebelink Change-Id: Id05f41ac242aeaf57606748009c0e370199e054f --- .../api/impl/NetworkCmProxyDataServiceImpl.java | 75 +++++++++++----------- .../impl/NetworkCmProxyDataServiceImplSpec.groovy | 57 ++++++++++------ .../ncmp/api/impl/client/DmiRestClientSpec.groovy | 29 +++++---- .../api/impl/config/NcmpConfigurationSpec.groovy | 5 ++ .../cps/ncmp/api/models/YangResourceTest.groovy | 20 ++++++ 5 files changed, 117 insertions(+), 69 deletions(-) create mode 100644 cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/models/YangResourceTest.groovy (limited to 'cps-ncmp-service/src') diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/NetworkCmProxyDataServiceImpl.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/NetworkCmProxyDataServiceImpl.java index a28b73c427..719508b6c5 100755 --- a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/NetworkCmProxyDataServiceImpl.java +++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/NetworkCmProxyDataServiceImpl.java @@ -149,14 +149,18 @@ public class NetworkCmProxyDataServiceImpl implements NetworkCmProxyDataService @Override public void updateDmiRegistrationAndSyncModule(final DmiPluginRegistration dmiPluginRegistration) { - if (dmiPluginRegistration.getCreatedCmHandles() != null) { - parseAndCreateCmHandlesInDmiRegistrationAndSyncModule(dmiPluginRegistration); - } - if (dmiPluginRegistration.getUpdatedCmHandles() != null) { - parseAndUpdateCmHandlesInDmiRegistration(dmiPluginRegistration); - } - if (dmiPluginRegistration.getRemovedCmHandles() != null) { - parseAndRemoveCmHandlesInDmiRegistration(dmiPluginRegistration); + try { + if (dmiPluginRegistration.getCreatedCmHandles() != null) { + parseAndCreateCmHandlesInDmiRegistrationAndSyncModule(dmiPluginRegistration); + } + if (dmiPluginRegistration.getUpdatedCmHandles() != null) { + parseAndUpdateCmHandlesInDmiRegistration(dmiPluginRegistration); + } + if (dmiPluginRegistration.getRemovedCmHandles() != null) { + parseAndRemoveCmHandlesInDmiRegistration(dmiPluginRegistration); + } + } catch (final JsonProcessingException e) { + handleJsonProcessingException(dmiPluginRegistration, e); } } @@ -286,38 +290,32 @@ public class NetworkCmProxyDataServiceImpl implements NetworkCmProxyDataService return prepareOperationBody(requestBodyObject); } - private void parseAndUpdateCmHandlesInDmiRegistration(final DmiPluginRegistration dmiPluginRegistration) { - try { - final PersistenceCmHandlesList persistenceCmHandlesList = new PersistenceCmHandlesList(); - - for (final CmHandle cmHandle : dmiPluginRegistration.getUpdatedCmHandles()) { - final PersistenceCmHandle persistenceCmHandle = - toPersistenceCmHandle(dmiPluginRegistration.getDmiPlugin(), cmHandle); - persistenceCmHandlesList.add(persistenceCmHandle); - } - final String cmHandlesJsonData = objectMapper.writeValueAsString(persistenceCmHandlesList); - cpsDataService.updateNodeLeavesAndExistingDescendantLeaves(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, - "/dmi-registry", cmHandlesJsonData, NO_TIMESTAMP); - } catch (final JsonProcessingException e) { - handleJsonProcessingException(dmiPluginRegistration, e); - } + private void parseAndUpdateCmHandlesInDmiRegistration(final DmiPluginRegistration dmiPluginRegistration) + throws JsonProcessingException { + final PersistenceCmHandlesList updatedPersistenceCmHandlesList = toPersistenceCmHandlesList( + dmiPluginRegistration.getDmiPlugin(), + dmiPluginRegistration.getUpdatedCmHandles()); + final String cmHandlesAsJson = objectMapper.writeValueAsString(updatedPersistenceCmHandlesList); + cpsDataService.updateNodeLeavesAndExistingDescendantLeaves(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, + "/dmi-registry", cmHandlesAsJson, NO_TIMESTAMP); } private void parseAndCreateCmHandlesInDmiRegistrationAndSyncModule( - final DmiPluginRegistration dmiPluginRegistration) { - try { - final var persistenceCmHandlesList = new PersistenceCmHandlesList(); - for (final CmHandle cmHandle : dmiPluginRegistration.getCreatedCmHandles()) { - final PersistenceCmHandle persistenceCmHandle = - toPersistenceCmHandle(dmiPluginRegistration.getDmiPlugin(), cmHandle); - persistenceCmHandlesList.add(persistenceCmHandle); - } - final String cmHandleJsonData = objectMapper.writeValueAsString(persistenceCmHandlesList); + final DmiPluginRegistration dmiPluginRegistration) throws JsonProcessingException { + final PersistenceCmHandlesList createdPersistenceCmHandlesList = toPersistenceCmHandlesList( + dmiPluginRegistration.getDmiPlugin(), + dmiPluginRegistration.getCreatedCmHandles()); + registerAndSyncNewCmHandles(createdPersistenceCmHandlesList); + } - registerAndSyncNode(persistenceCmHandlesList, cmHandleJsonData); - } catch (final JsonProcessingException e) { - handleJsonProcessingException(dmiPluginRegistration, e); + private static PersistenceCmHandlesList toPersistenceCmHandlesList(final String dmiPlugin, + final Collection cmHandles) { + final PersistenceCmHandlesList persistenceCmHandlesList = new PersistenceCmHandlesList(); + for (final CmHandle cmHandle : cmHandles) { + final PersistenceCmHandle persistenceCmHandle = toPersistenceCmHandle(dmiPlugin, cmHandle); + persistenceCmHandlesList.add(persistenceCmHandle); } + return persistenceCmHandlesList; } private static void handleJsonProcessingException(final DmiPluginRegistration dmiPluginRegistration, @@ -328,8 +326,9 @@ public class NetworkCmProxyDataServiceImpl implements NetworkCmProxyDataService throw new DataValidationException(message, e.getMessage(), e); } - private void registerAndSyncNode(final PersistenceCmHandlesList persistenceCmHandlesList, - final String cmHandleJsonData) { + private void registerAndSyncNewCmHandles(final PersistenceCmHandlesList persistenceCmHandlesList) + throws JsonProcessingException { + final String cmHandleJsonData = objectMapper.writeValueAsString(persistenceCmHandlesList); cpsDataService.saveListNodeData(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, "/dmi-registry", cmHandleJsonData, NO_TIMESTAMP); @@ -435,7 +434,7 @@ public class NetworkCmProxyDataServiceImpl implements NetworkCmProxyDataService private static YangResource toYangResource(final JsonObject yangResourceAsJson) { final YangResource yangResource = new YangResource(); yangResource.setModuleName(yangResourceAsJson.get("moduleName").getAsString()); - yangResource.setRevision(yangResourceAsJson.get("revision").getAsString()); + yangResource.setRevision(yangResourceAsJson.get(REVISION).getAsString()); final String yangSourceJson = yangResourceAsJson.get("yangSource").getAsString(); String yangSource = JsonUtils.removeWrappingTokens(yangSourceJson); 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 8739355c8b..55dd26bda5 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 @@ -67,14 +67,24 @@ class NetworkCmProxyDataServiceImplSpec extends Specification { 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 'Get data node.'() { + when: 'queryDataNodes is invoked' + objectUnderTest.getDataNode(cmHandle, 'some xpath', fetchDescendantsOption) + then: 'the persistence data service is called once with the correct parameters' + 1 * mockCpsDataService.getDataNode(expectedDataspaceName, cmHandle, 'some xpath', fetchDescendantsOption) + where: 'all fetch descendants options are supported' + fetchDescendantsOption << FetchDescendantsOption.values() + } + 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' + then: 'the persistence query 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() @@ -214,7 +224,7 @@ class NetworkCmProxyDataServiceImplSpec extends Specification { def 'Get resource data for pass-through operational from dmi.'() { given: 'data node representing cmHandle and its properties' - def cmHandleDataNode = getCmHandleDataNodeForTest() + def cmHandleDataNode = getCmHandleDataNodeForTest(true) and: 'data node is got from data service' mockCpsDataService.getDataNode('NCMP-Admin', 'ncmp-dmi-registry', cmHandleXPath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> cmHandleDataNode @@ -238,7 +248,7 @@ class NetworkCmProxyDataServiceImplSpec extends Specification { def 'Get resource data for pass-through operational from dmi threw parsing exception.'() { given: 'data node representing cmHandle and its properties' - def cmHandleDataNode = getCmHandleDataNodeForTest() + def cmHandleDataNode = getCmHandleDataNodeForTest(true) and: 'cps data service returns valid cmHandle data node' mockCpsDataService.getDataNode('NCMP-Admin', 'ncmp-dmi-registry', cmHandleXPath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> cmHandleDataNode @@ -259,7 +269,7 @@ class NetworkCmProxyDataServiceImplSpec extends Specification { def 'Get resource data for pass-through operational from dmi return NOK response.'() { given: 'data node representing cmHandle and its properties' - def cmHandleDataNode = getCmHandleDataNodeForTest() + def cmHandleDataNode = getCmHandleDataNodeForTest(true) and: 'cps data service returns valid cmHandle data node' mockCpsDataService.getDataNode('NCMP-Admin', 'ncmp-dmi-registry', cmHandleXPath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> cmHandleDataNode @@ -286,7 +296,7 @@ class NetworkCmProxyDataServiceImplSpec extends Specification { def 'Get resource data for pass-through running from dmi.'() { given: 'data node representing cmHandle and its properties' - def cmHandleDataNode = getCmHandleDataNodeForTest() + def cmHandleDataNode = getCmHandleDataNodeForTest(true) and: 'cpsDataService returns valid dataNode' mockCpsDataService.getDataNode('NCMP-Admin', 'ncmp-dmi-registry', cmHandleXPath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> cmHandleDataNode @@ -310,7 +320,7 @@ class NetworkCmProxyDataServiceImplSpec extends Specification { def 'Get resource data for pass-through running from dmi threw parsing exception.'() { given: 'data node representing cmHandle and its properties' - def cmHandleDataNode = getCmHandleDataNodeForTest() + def cmHandleDataNode = getCmHandleDataNodeForTest(true) and: 'cpsDataService returns valid dataNode' mockCpsDataService.getDataNode('NCMP-Admin', 'ncmp-dmi-registry', cmHandleXPath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> cmHandleDataNode @@ -331,7 +341,7 @@ class NetworkCmProxyDataServiceImplSpec extends Specification { def 'Get resource data for pass-through running from dmi return NOK response.'() { given: 'data node representing cmHandle and its properties' - def cmHandleDataNode = getCmHandleDataNodeForTest() + def cmHandleDataNode = getCmHandleDataNodeForTest(true) and: 'cpsDataService returns valid dataNode' mockCpsDataService.getDataNode('NCMP-Admin', 'ncmp-dmi-registry', cmHandleXPath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> cmHandleDataNode @@ -356,9 +366,9 @@ class NetworkCmProxyDataServiceImplSpec extends Specification { 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() + def 'Write resource data for pass-through running from dmi using POST #scenario cm handle properties.'() { + given: 'data node representing cmHandle #scenario cm handle properties' + def cmHandleDataNode = getCmHandleDataNodeForTest(includeCmHandleProperties) and: 'cpsDataService returns valid cm-handle datanode' mockCpsDataService.getDataNode('NCMP-Admin', 'ncmp-dmi-registry', cmHandleXPath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> cmHandleDataNode @@ -370,13 +380,18 @@ class NetworkCmProxyDataServiceImplSpec extends Specification { 1 * mockDmiOperations.createResourceDataPassThroughRunningFromDmi('testDmiService', 'testCmHandle', 'testResourceId', - '{"operation":"create","dataType":"application/json","data":"{some-json}","cmHandleProperties":{"testName":"testValue"}}') + '{"operation":"create","dataType":"application/json","data":"{some-json}","cmHandleProperties":' + + expectedJsonForCmhandleProperties+ '}') >> { new ResponseEntity<>(HttpStatus.OK) } + 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: 'data node representing cmHandle and its properties' - def cmHandleDataNode = getCmHandleDataNodeForTest() + def cmHandleDataNode = getCmHandleDataNodeForTest(true) and: 'cpsDataService returns valid dataNode' mockCpsDataService.getDataNode('NCMP-Admin', 'ncmp-dmi-registry', cmHandleXPath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> cmHandleDataNode @@ -394,7 +409,7 @@ class NetworkCmProxyDataServiceImplSpec extends Specification { } def 'Sync model for a (new) cm handle with #scenario'() { - given: 'DMI PLug-in returns a list of module references' + 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') @@ -409,12 +424,13 @@ class NetworkCmProxyDataServiceImplSpec extends Specification { 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' + where: 'the following responses are received 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') @@ -426,7 +442,6 @@ class NetworkCmProxyDataServiceImplSpec extends Specification { 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 } @@ -438,12 +453,14 @@ class NetworkCmProxyDataServiceImplSpec extends Specification { return objectUnderTest } - def getCmHandleDataNodeForTest() { + def getCmHandleDataNodeForTest(boolean includeCmHandleProperties) { def cmHandleDataNode = new DataNode() cmHandleDataNode.leaves = ['dmi-service-name': 'testDmiService'] - def cmHandlePropertyDataNode = new DataNode() - cmHandlePropertyDataNode.leaves = ['name': 'testName', 'value': 'testValue'] - cmHandleDataNode.childDataNodes = [cmHandlePropertyDataNode] + if (includeCmHandleProperties) { + def cmHandlePropertyDataNode = new DataNode() + cmHandlePropertyDataNode.leaves = ['name': 'testName', 'value': 'testValue'] + cmHandleDataNode.childDataNodes = [cmHandlePropertyDataNode] + } return cmHandleDataNode } diff --git a/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/impl/client/DmiRestClientSpec.groovy b/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/impl/client/DmiRestClientSpec.groovy index bf6179ba1b..a1779a7576 100644 --- a/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/impl/client/DmiRestClientSpec.groovy +++ b/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/impl/client/DmiRestClientSpec.groovy @@ -41,27 +41,34 @@ class DmiRestClientSpec extends Specification { @Autowired DmiRestClient objectUnderTest + def resourceUrl = 'some url' def 'DMI PUT operation.'() { - given: 'a PUT url' - def getResourceDataUrl = 'http://some-uri/getResourceDataUrl' - and: 'the rest template returns a valid response entity' + given: 'the rest template returns a valid response entity' def mockResponseEntity = Mock(ResponseEntity) - mockRestTemplate.exchange(getResourceDataUrl, HttpMethod.PUT, _ as HttpEntity, Object.class) >> mockResponseEntity + mockRestTemplate.exchange(resourceUrl, HttpMethod.PUT, _ as HttpEntity, Object.class) >> mockResponseEntity when: 'PUT operation is invoked' - def result = objectUnderTest.putOperationWithJsonData(getResourceDataUrl, 'json-data', new HttpHeaders()) + def result = objectUnderTest.putOperationWithJsonData(resourceUrl, 'json-data', new HttpHeaders()) then: 'the output of the method is equal to the output from the test template' result == mockResponseEntity } - def 'DMI POST operation.'() { - given: 'a POST url' - def getResourceDataUrl = 'http://some-uri/createResourceDataUrl' - and: 'the rest template returns a valid response entity' + def 'DMI POST operation'() { + given: 'the rest template returns a valid response entity' def mockResponseEntity = Mock(ResponseEntity) - mockRestTemplate.postForEntity(getResourceDataUrl, _ as HttpEntity, String.class) >> mockResponseEntity + mockRestTemplate.exchange(resourceUrl, HttpMethod.POST, _ as HttpEntity, String.class) >> mockResponseEntity when: 'POST operation is invoked' - def result = objectUnderTest.postOperationWithJsonData(getResourceDataUrl, 'json-data', new HttpHeaders()) + def result = objectUnderTest.postOperation(resourceUrl, new HttpHeaders()) + then: 'the output of the method is equal to the output from the rest template' + result == mockResponseEntity + } + + def 'DMI POST operation with JSON.'() { + given: 'the rest template returns a valid response entity' + def mockResponseEntity = Mock(ResponseEntity) + mockRestTemplate.postForEntity(resourceUrl, _ as HttpEntity, String.class) >> mockResponseEntity + when: 'POST operation is invoked' + def result = objectUnderTest.postOperationWithJsonData(resourceUrl, 'json-data', new HttpHeaders()) then: 'the output of the method is equal to the output from the test template' result == mockResponseEntity } diff --git a/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/impl/config/NcmpConfigurationSpec.groovy b/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/impl/config/NcmpConfigurationSpec.groovy index dd4c1375b0..2c4ba68f29 100644 --- a/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/impl/config/NcmpConfigurationSpec.groovy +++ b/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/impl/config/NcmpConfigurationSpec.groovy @@ -33,6 +33,11 @@ class NcmpConfigurationSpec extends Specification{ @Autowired NcmpConfiguration.DmiProperties dmiProperties + def 'NcmpConfiguration Construction.'() { + expect: 'the system can create an instance' + new NcmpConfiguration() != null + } + def 'DMI Properties.'() { expect: 'properties are set to values in test configuration yaml file' dmiProperties.authUsername == 'some-user' diff --git a/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/models/YangResourceTest.groovy b/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/models/YangResourceTest.groovy new file mode 100644 index 0000000000..0a0c84e256 --- /dev/null +++ b/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/models/YangResourceTest.groovy @@ -0,0 +1,20 @@ +package org.onap.cps.ncmp.api.models + +import spock.lang.Specification + +class YangResourceSpec extends Specification { + + YangResource objectUnderTest = new YangResource(moduleName: 'module name', + revision:'revision', + yangSource:'source') + + def 'Yang resource attributes'() { + expect: 'correct module name' + objectUnderTest.moduleName == 'module name' + and: 'correct revision (this property is not used in production code, hence the need for this test)' + objectUnderTest.revision == 'revision' + and: 'correct yang source' + objectUnderTest.yangSource == 'source' + } + +} -- cgit 1.2.3-korg