Module Sync Lock State implementation
[cps.git] / cps-ncmp-service / src / test / groovy / org / onap / cps / ncmp / api / impl / NetworkCmProxyDataServiceImplSpec.groovy
index 01f3bfe..55a1a8d 100644 (file)
 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.inventory.CmHandleState
+import org.onap.cps.ncmp.api.inventory.CompositeState
+import org.onap.cps.ncmp.api.inventory.InventoryPersistence
 import org.onap.cps.ncmp.api.models.DmiPluginRegistration
 import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle
 import org.onap.cps.spi.exceptions.DataValidationException
@@ -34,11 +36,9 @@ 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
@@ -58,7 +58,7 @@ class NetworkCmProxyDataServiceImplSpec extends Specification {
     def spiedJsonObjectMapper = Spy(new JsonObjectMapper(new ObjectMapper()))
     def mockDmiDataOperations = Mock(DmiDataOperations)
     def nullNetworkCmProxyDataServicePropertyHandler = null
-    def mockYangModelCmHandleRetriever = Mock(YangModelCmHandleRetriever)
+    def mockInventoryPersistence = Mock(InventoryPersistence)
     def mockModuleSyncService = Mock(ModuleSyncService)
     def mockDmiPluginRegistration = Mock(DmiPluginRegistration)
 
@@ -70,17 +70,17 @@ class NetworkCmProxyDataServiceImplSpec extends Specification {
     def ncmpServiceCmHandle = new NcmpServiceCmHandle(cmHandleId: 'some-cm-handle-id')
 
     def objectUnderTest = new NetworkCmProxyDataServiceImpl(mockCpsDataService, spiedJsonObjectMapper, mockDmiDataOperations,
-        mockCpsModuleService, mockCpsAdminService, nullNetworkCmProxyDataServicePropertyHandler, mockYangModelCmHandleRetriever, mockModuleSyncService)
+        mockCpsModuleService, mockCpsAdminService, nullNetworkCmProxyDataServicePropertyHandler, mockInventoryPersistence, 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.'() {
+    def 'Write resource data for pass-through running from DMI using POST.'() {
         given: 'cpsDataService returns valid datanode'
             mockCpsDataService.getDataNode('NCMP-Admin', 'ncmp-dmi-registry',
                 cmHandleXPath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> dataNode
-        when: 'get resource data is called'
+        when: 'write resource data is called'
             objectUnderTest.writeResourceDataPassThroughRunningForCmHandle('testCmHandle',
                 'testResourceId', CREATE,
                 '{some-json}', 'application/json')
@@ -101,102 +101,26 @@ class NetworkCmProxyDataServiceImplSpec extends Specification {
             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'
-            mockDmiDataOperations.writeResourceDataPassThroughRunningFromDmi('testCmHandle',
-                'testResourceId', CREATE,
-                '{some-json}', 'application/json')
-                >> { new ResponseEntity<>(HttpStatus.NOT_FOUND) }
-        when: 'write resource data is called'
-            objectUnderTest.writeResourceDataPassThroughRunningForCmHandle('testCmHandle',
-                'testResourceId', CREATE,
-                '{some-json}', 'application/json')
-        then: 'exception is thrown'
-            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: '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'
             mockDmiDataOperations.getResourceDataFromDmi(
-                    'testCmHandle',
-                    'testResourceId',
-                    OPTIONS_PARAM,
-                    PASSTHROUGH_OPERATIONAL,
-                    NO_REQUEST_ID,
-                    NO_TOPIC) >> new ResponseEntity<>('dmi-response', 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',
                 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: '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'
-            mockDmiDataOperations.getResourceDataFromDmi(*_)
-                >> new ResponseEntity<>('NOK-json', HttpStatus.NOT_FOUND)
-        when: 'get resource data is called'
-            objectUnderTest.getResourceDataOperationalForCmHandle('testCmHandle',
-                    '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: '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'
-            mockDmiDataOperations.getResourceDataFromDmi('testCmHandle',
-                    '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',
-                    OPTIONS_PARAM,
-                    NO_TOPIC,
-                    NO_REQUEST_ID)
-        then: 'exception is thrown'
-            def exceptionThrown = thrown(HttpClientRequestException.class)
-        and: 'details contain the original response'
-            exceptionThrown.httpStatus == HttpStatus.NOT_FOUND.value()
-            exceptionThrown.details.contains('NOK-json')
+        then: 'DMI returns a json response'
+            response == 'dmi-response'
     }
 
     def 'Get resource data for pass-through running from DMI.'() {
@@ -205,55 +129,19 @@ class NetworkCmProxyDataServiceImplSpec extends Specification {
                 cmHandleXPath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> dataNode
         and: 'DMI returns valid response and data'
             mockDmiDataOperations.getResourceDataFromDmi('testCmHandle',
-                    'testResourceId',
-                    OPTIONS_PARAM,
-                    PASSTHROUGH_RUNNING,
-                    NO_REQUEST_ID,
-                    NO_TOPIC) >> new ResponseEntity<>('{dmi-response}', 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',
-                    OPTIONS_PARAM,
-                    NO_TOPIC,
-                    NO_REQUEST_ID)
-        then: 'get resource data returns expected response'
-            response == '{dmi-response}'
-    }
-
-    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'
-            mockDmiDataOperations.getResourceDataFromDmi('testCmHandle',
-                    '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',
-                    OPTIONS_PARAM,
-                    NO_TOPIC,
-                    NO_REQUEST_ID)
-        then: 'exception is thrown'
-            def exceptionThrown = thrown(HttpClientRequestException.class)
-        and: 'details contain the original response'
-            exceptionThrown.details.contains('NOK-json')
-            exceptionThrown.httpStatus == HttpStatus.NOT_FOUND.value()
+        then: 'get resource data returns expected response'
+            response == '{dmi-response}'
     }
 
     def 'Getting Yang Resources.'() {
@@ -269,7 +157,7 @@ class NetworkCmProxyDataServiceImplSpec extends Specification {
         then: 'a data validation exception is thrown'
             thrown(DataValidationException)
         and: 'CPS module services is not invoked'
-            0 * mockCpsModuleService.getYangResourcesModuleReferences(_, _)
+            0 * mockCpsModuleService.getYangResourcesModuleReferences(*_)
     }
 
     def 'Get cm handle identifiers for the given module names.'() {
@@ -284,15 +172,17 @@ class NetworkCmProxyDataServiceImplSpec extends Specification {
             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
+            def compositeState = new CompositeState(cmHandleState: 'ADVISED')
+            def yangModelCmHandle = new YangModelCmHandle(id: 'some-cm-handle', dmiServiceName: dmiServiceName,
+                dmiProperties: dmiProperties, publicProperties: publicProperties, compositeState: compositeState)
+            1 * mockInventoryPersistence.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' ]
-
+            result.compositeState.cmHandleState == CmHandleState.ADVISED
     }
 
     def 'Get a cm handle with an invalid id.'() {
@@ -301,7 +191,7 @@ class NetworkCmProxyDataServiceImplSpec extends Specification {
         then: 'an exception is thrown'
             thrown(DataValidationException)
         and: 'the yang model cm handle retriever is not invoked'
-            0 * mockYangModelCmHandleRetriever.getYangModelCmHandle(_)
+            0 * mockInventoryPersistence.getYangModelCmHandle(*_)
     }
 
     def 'Get cm handle public properties'() {
@@ -310,7 +200,7 @@ class NetworkCmProxyDataServiceImplSpec extends Specification {
             def publicProperties = [new YangModelCmHandle.Property('public prop', 'some public prop')]
             def yangModelCmHandle = new YangModelCmHandle(id:'some-cm-handle', dmiServiceName: 'some service name', dmiProperties: dmiProperties, publicProperties: publicProperties)
         and: 'the system returns this yang modelled cm handle'
-            1 * mockYangModelCmHandleRetriever.getYangModelCmHandle('some-cm-handle') >> yangModelCmHandle
+            1 * mockInventoryPersistence.getYangModelCmHandle('some-cm-handle') >> yangModelCmHandle
         when: 'getting cm handle public properties for a given cm handle id from ncmp service'
             def result = objectUnderTest.getCmHandlePublicProperties('some-cm-handle')
         then: 'the result returns the correct data'
@@ -323,7 +213,7 @@ class NetworkCmProxyDataServiceImplSpec extends Specification {
         then: 'an exception is thrown'
             thrown(DataValidationException)
         and: 'the yang model cm handle retriever is not invoked'
-            0 * mockYangModelCmHandleRetriever.getYangModelCmHandle(_)
+            0 * mockInventoryPersistence.getYangModelCmHandle(*_)
     }
 
     def 'Update resource data for pass-through running from dmi using POST #scenario DMI properties.'() {
@@ -340,40 +230,19 @@ class NetworkCmProxyDataServiceImplSpec extends Specification {
                 >> { new ResponseEntity<>(HttpStatus.OK) }
     }
 
-    def 'Verify error message from handleResponse is correct for #scenario operation.'() {
-        given: 'writeResourceDataPassThroughRunningFromDmi fails to return OK HttpStatus'
-            mockDmiDataOperations.writeResourceDataPassThroughRunningFromDmi(*_)
-                >> new ResponseEntity<>(HttpStatus.NOT_FOUND)
-        when: 'get resource data is called'
-            objectUnderTest.writeResourceDataPassThroughRunningForCmHandle(
-                'testCmHandle',
-                'testResourceId',
-                givenOperation,
-                '{some-json}',
-                'application/json')
-        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         || 'Unable to create resource data.'
-            'READ'   | READ           || 'Unable to read resource data.'
-            'UPDATE' | UPDATE         || 'Unable to update resource data.'
-    }
-
     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')
+                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)
+                '/dmi-registry', '{"cm-handles":[{"id":"some-cm-handle-id",' +
+                '"additional-properties":[],"public-properties":[]}]}', null)
             1 * mockCpsAdminService.createAnchor('NFP-Operational', null,
-                    'some-cm-handle-id')
+                'some-cm-handle-id')
     }
 }