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 --- .../impl/NetworkCmProxyDataServiceImplSpec.groovy | 57 ++++++++++++++-------- .../ncmp/api/impl/client/DmiRestClientSpec.groovy | 29 ++++++----- .../api/impl/config/NcmpConfigurationSpec.groovy | 5 ++ .../cps/ncmp/api/models/YangResourceTest.groovy | 20 ++++++++ 4 files changed, 80 insertions(+), 31 deletions(-) create mode 100644 cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/models/YangResourceTest.groovy (limited to 'cps-ncmp-service/src/test') 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 8739355c8..55dd26bda 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 bf6179ba1..a1779a757 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 dd4c1375b..2c4ba68f2 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 000000000..0a0c84e25 --- /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