[TECHDEBT] Align CPS NCMP REST API Specification

[cps.git] / cps-ncmp-service / src / test / groovy / org / onap / cps / ncmp / api / impl / NetworkCmProxyDataServiceImplSpec.groovy

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 51af0f5..9c79d4f 100644 (file)
--- 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
@@ -35,7 +35,7 @@ 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.exception.ServerNcmpException
 import org.onap.cps.ncmp.api.impl.operations.DmiDataOperations
 import org.onap.cps.spi.FetchDescendantsOption
 import org.onap.cps.spi.model.DataNode
@@ -57,34 +57,28 @@ class NetworkCmProxyDataServiceImplSpec extends Specification {
 
     def cmHandleXPath = "/dmi-registry/cm-handles[@id='testCmHandle']"
 
+    def dataNode = new DataNode(leaves: ['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 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')
@@ -94,19 +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 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',
@@ -118,19 +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'
             spiedJsonObjectMapper.asJsonString(_) >> { throw new JsonProcessingException('testException') }
-        and: 'dmi returns NOK response'
+        and: 'DMI returns NOK response'
             mockDmiDataOperations.getResourceDataFromDmi(*_)
                 >> new ResponseEntity<>('NOK-json', HttpStatus.NOT_FOUND)
         when: 'get resource data is called'
@@ -139,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)',
@@ -162,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)',
@@ -188,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)',
@@ -207,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')
     }
@@ -226,25 +209,18 @@ class NetworkCmProxyDataServiceImplSpec extends Specification {
             1 * mockCpsAdminService.queryAnchorNames('NFP-Operational', ['some-module-name'])
     }
 
-
-    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.'() {
@@ -252,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
@@ -267,15 +243,4 @@ class NetworkCmProxyDataServiceImplSpec extends Specification {
             'READ'   | READ           || 'Not able to read resource data.'
             'UPDATE' | UPDATE         || 'Not able 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
-    }
 }