[TECHDEBT] Align CPS NCMP REST API Specification
[cps.git] / cps-ncmp-service / src / test / groovy / org / onap / cps / ncmp / api / impl / NetworkCmProxyDataServiceImplSpec.groovy
index c396a2e..9c79d4f 100644 (file)
@@ -1,6 +1,6 @@
 /*
  * ============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
  *  ================================================================================
 
 package org.onap.cps.ncmp.api.impl
 
-import org.onap.cps.ncmp.api.impl.client.DmiRestClient
-import org.onap.cps.ncmp.api.impl.operations.DmiRequestBody
-import org.springframework.http.HttpHeaders
-
 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.exception.NcmpException
+import org.onap.cps.ncmp.api.impl.exception.ServerNcmpException
 import org.onap.cps.ncmp.api.impl.operations.DmiDataOperations
-import org.onap.cps.ncmp.api.impl.operations.DmiModelOperations
 import org.onap.cps.spi.FetchDescendantsOption
 import org.onap.cps.spi.model.DataNode
 import org.springframework.http.HttpStatus
@@ -50,80 +46,39 @@ import spock.lang.Specification
 class NetworkCmProxyDataServiceImplSpec extends Specification {
 
     def mockCpsDataService = Mock(CpsDataService)
-    def mockCpsQueryService = Mock(CpsQueryService)
     def mockCpsModuleService = Mock(CpsModuleService)
     def mockCpsAdminService = Mock(CpsAdminService)
-    def spyObjectMapper = Spy(ObjectMapper)
+    def spiedJsonObjectMapper = Spy(new JsonObjectMapper(new ObjectMapper()))
+    def mockDmiModelOperations = Mock(DmiModelOperations)
     def mockDmiDataOperations = Mock(DmiDataOperations)
 
-    def objectUnderTest = new NetworkCmProxyDataServiceImpl(mockDmiDataOperations, null,
-        mockCpsModuleService, mockCpsDataService, mockCpsQueryService, mockCpsAdminService, spyObjectMapper)
+    def objectUnderTest = new NetworkCmProxyDataServiceImpl(mockCpsDataService, spiedJsonObjectMapper, mockDmiDataOperations, mockDmiModelOperations,
+        mockCpsModuleService, mockCpsAdminService)
 
-    def cmHandle = 'some handle'
-    def noTimestamp = null
     def cmHandleXPath = "/dmi-registry/cm-handles[@id='testCmHandle']"
-    def expectedDataspaceName = 'NFP-Operational'
-
-    def 'Create full data node: #scenario.'() {
-        given: 'json data'
-            def jsonData = 'some json'
-        when: 'createDataNode is invoked'
-            objectUnderTest.createDataNode(cmHandle, xpath, jsonData)
-        then: 'save data 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: 'json data and xpath'
-            def jsonData = 'some json'
-            def xpath = '/test-node'
-        when: 'create data node is invoked'
-            objectUnderTest.createDataNode(cmHandle, xpath, jsonData)
-        then: 'save data is invoked once with the expected parameters'
-            1 * mockCpsDataService.saveData(expectedDataspaceName, cmHandle, xpath, jsonData, noTimestamp)
-    }
+    def dataNode = new DataNode(leaves: ['dmi-service-name': 'testDmiService'])
 
-    def 'Add list-node elements.'() {
-        given: 'json data and xpath'
-            def jsonData = 'some json'
-            def xpath = '/test-node'
-        when: 'add list node element is invoked'
-            objectUnderTest.addListNodeElements(cmHandle, xpath, jsonData)
-        then: 'the save list elements is invoked once with the expected parameters'
-            1 * mockCpsDataService.saveListElements(expectedDataspaceName, cmHandle, xpath, jsonData, noTimestamp)
-    }
 
-    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 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')
@@ -133,27 +88,16 @@ class NetworkCmProxyDataServiceImplSpec extends Specification {
                 'testResourceId', CREATE,
                 '{some-json}', 'application/json')
         then: 'exception is thrown'
-            def exceptionThrown = thrown(NcmpException.class)
+            def exceptionThrown = thrown(ServerNcmpException.class)
         and: 'details contains (not found) error code: 404'
             exceptionThrown.details.contains('404')
     }
 
-    def 'Get data node.'() {
-        when: 'get data node 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 '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',
@@ -165,21 +109,17 @@ class NetworkCmProxyDataServiceImplSpec extends Specification {
                 'testResourceId',
                 'testAcceptParam',
                 '(a=1,b=2)')
-        then: 'dmi returns a json response'
+        then: 'DMI returns a json response'
             response == 'result-json'
     }
 
-    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'
@@ -188,17 +128,15 @@ class NetworkCmProxyDataServiceImplSpec extends Specification {
                 'testAcceptParam',
                 '(a=1,b=2)')
         then: 'exception is thrown with the expected details'
-            def exceptionThrown = thrown(NcmpException.class)
+            def exceptionThrown = thrown(ServerNcmpException.class)
             exceptionThrown.details == 'DMI status code: 404, DMI response body: NOK-json'
     }
 
-    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)',
@@ -211,18 +149,16 @@ class NetworkCmProxyDataServiceImplSpec extends Specification {
                 'testAcceptParam',
                 '(a=1,b=2)')
         then: 'exception is thrown'
-            def exceptionThrown = thrown(NcmpException.class)
+            def exceptionThrown = thrown(ServerNcmpException.class)
         and: 'details contains the original response'
             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)',
@@ -237,13 +173,11 @@ class NetworkCmProxyDataServiceImplSpec extends Specification {
             response == '{result-json}'
     }
 
-    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 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)',
@@ -256,7 +190,7 @@ class NetworkCmProxyDataServiceImplSpec extends Specification {
                 'testAcceptParam',
                 '(a=1,b=2)')
         then: 'exception is thrown'
-            def exceptionThrown = thrown(NcmpException.class)
+            def exceptionThrown = thrown(ServerNcmpException.class)
         and: 'details contains the original response'
             exceptionThrown.details.contains('NOK-json')
     }
@@ -275,44 +209,18 @@ class NetworkCmProxyDataServiceImplSpec extends Specification {
             1 * mockCpsAdminService.queryAnchorNames('NFP-Operational', ['some-module-name'])
     }
 
-    def 'Update data node leaves.'() {
-        given: 'json data and xpath'
-            def jsonData = 'some json'
-            def xpath = '/xpath'
-        when: 'update node leaves 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 'Replace data node tree.'() {
-        given: 'json data and xpath'
-            def jsonData = 'some json'
-            def xpath = '/xpath'
-        when: 'replace node tree 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 '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 '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.'() {
@@ -320,14 +228,14 @@ 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)
+            def exceptionThrown = thrown(ServerNcmpException.class)
             exceptionThrown.getMessage().contains(expectedResponseMessage)
         where:
             scenario | givenOperation || expectedResponseMessage
@@ -335,26 +243,4 @@ class NetworkCmProxyDataServiceImplSpec extends Specification {
             'READ'   | READ           || 'Not able to read resource data.'
             'UPDATE' | UPDATE         || 'Not able to update resource data.'
     }
-
-    def 'Query data nodes by cps path with #fetchDescendantsOption.'() {
-        given: 'a cps path'
-            def cpsPath = '/cps-path'
-        when: 'query data nodes is invoked'
-            objectUnderTest.queryDataNodes(cmHandle, cpsPath, fetchDescendantsOption)
-        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()
-    }
-
-    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
-    }
 }