diff options
Diffstat (limited to 'src/test/groovy/org/onap/cps/ncmp/dmi/rest/controller/DmiRestControllerSpec.groovy')
| -rw-r--r-- | src/test/groovy/org/onap/cps/ncmp/dmi/rest/controller/DmiRestControllerSpec.groovy | 112 |
1 files changed, 59 insertions, 53 deletions
diff --git a/src/test/groovy/org/onap/cps/ncmp/dmi/rest/controller/DmiRestControllerSpec.groovy b/src/test/groovy/org/onap/cps/ncmp/dmi/rest/controller/DmiRestControllerSpec.groovy index 5bfbc400..2be0b59c 100644 --- a/src/test/groovy/org/onap/cps/ncmp/dmi/rest/controller/DmiRestControllerSpec.groovy +++ b/src/test/groovy/org/onap/cps/ncmp/dmi/rest/controller/DmiRestControllerSpec.groovy @@ -77,20 +77,20 @@ class DmiRestControllerSpec extends Specification { def basePathV1 def 'Get all modules.'() { - given: 'REST endpoint for getting all modules' + given: 'URL for getting all modules and some request data' def getModuleUrl = "$basePathV1/ch/node1/modules" - and: 'get modules for cm-handle returns a json' - def json = '{"cmHandleProperties" : {}}' + def someValidJson = '{}' + and: 'DMI service returns some module' def moduleSetSchema = new ModuleSetSchemas(namespace:'some-namespace', - moduleName:'some-moduleName', - revision:'some-revision') + moduleName:'some-moduleName', + revision:'some-revision') def moduleSetSchemasList = [moduleSetSchema] as List<ModuleSetSchemas> def moduleSet = new ModuleSet() moduleSet.schemas(moduleSetSchemasList) mockDmiService.getModulesForCmHandle('node1') >> moduleSet - when: 'post is being called' + when: 'the request is posted' def response = mvc.perform(post(getModuleUrl) - .contentType(MediaType.APPLICATION_JSON).content(json)) + .contentType(MediaType.APPLICATION_JSON).content(someValidJson)) .andReturn().response then: 'status is OK' response.status == OK.value() @@ -99,14 +99,14 @@ class DmiRestControllerSpec extends Specification { } def 'Get all modules with exception handling of #scenario.'() { - given: 'REST endpoint for getting all modules' + given: 'URL for getting all modules and some request data' def getModuleUrl = "$basePathV1/ch/node1/modules" - and: 'given request body and get modules for cm-handle throws #exceptionClass' - def json = '{"cmHandleProperties" : {}}' + def someValidJson = '{}' + and: 'a #exception is thrown during the process' mockDmiService.getModulesForCmHandle('node1') >> { throw exception } - when: 'post is invoked' + when: 'the request is posted' def response = mvc.perform( post(getModuleUrl) - .contentType(MediaType.APPLICATION_JSON).content(json)) + .contentType(MediaType.APPLICATION_JSON).content(someValidJson)) .andReturn().response then: 'response status is #expectedResponse' response.status == expectedResponse.value() @@ -119,10 +119,10 @@ class DmiRestControllerSpec extends Specification { } def 'Register given list.'() { - given: 'register cm handle url and cm handles json' + given: 'register cm handle url and cmHandles' def registerCmhandlesPost = "${basePathV1}/inventory/cmHandles" def cmHandleJson = '{"cmHandles":["node1", "node2"]}' - when: 'register cm handles api is invoked with POST' + when: 'the request is posted' def response = mvc.perform( post(registerCmhandlesPost) .contentType(MediaType.APPLICATION_JSON) @@ -138,7 +138,7 @@ class DmiRestControllerSpec extends Specification { given: 'register cm handle url and empty json' def registerCmhandlesPost = "${basePathV1}/inventory/cmHandles" def emptyJson = '{"cmHandles":[]}' - when: 'register cm handles post api is invoked with no content' + when: 'the request is posted' def response = mvc.perform( post(registerCmhandlesPost).contentType(MediaType.APPLICATION_JSON) .content(emptyJson) @@ -150,9 +150,10 @@ class DmiRestControllerSpec extends Specification { } def 'Retrieve module resources.'() { - given: 'an endpoint and json data' + given: 'URL to get module resources' def getModulesEndpoint = "$basePathV1/ch/some-cm-handle/moduleResources" - String jsonData = TestUtils.getResourceFileContent('GetModules.json') + and: 'request data to get some modules' + String jsonData = TestUtils.getResourceFileContent('moduleResources.json') and: 'the DMI service returns the yang resources' ModuleReference moduleReference1 = new ModuleReference(name: 'ietf-yang-library', revision: '2016-06-21') ModuleReference moduleReference2 = new ModuleReference(name: 'nc-notifications', revision: '2008-07-14') @@ -161,23 +162,24 @@ class DmiRestControllerSpec extends Specification { def yangResource = new YangResource(yangSource: '"some-data"', moduleName: 'NAME', revision: 'REVISION') yangResources.add(yangResource) mockDmiService.getModuleResources('some-cm-handle', moduleReferences) >> yangResources - when: 'get module resource api is invoked' + when: 'the request is posted' def response = mvc.perform(post(getModulesEndpoint) .contentType(MediaType.APPLICATION_JSON) .content(jsonData)).andReturn().response then: 'a OK status is returned' response.status == OK.value() - and: 'the expected response is returned' + and: 'the response content matches the result from the DMI service' response.getContentAsString() == '[{"yangSource":"\\"some-data\\"","moduleName":"NAME","revision":"REVISION"}]' } def 'Retrieve module resources with exception handling.'() { - given: 'an endpoint and json data' + given: 'URL to get module resources' def getModulesEndpoint = "$basePathV1/ch/some-cm-handle/moduleResources" - String jsonData = TestUtils.getResourceFileContent('GetModules.json') - and: 'the service method is invoked to get module resources and throws an exception' + and: 'request data to get some modules' + String jsonData = TestUtils.getResourceFileContent('moduleResources.json') + and: 'the system throws a not-found exception (during the processing)' mockDmiService.getModuleResources('some-cm-handle', _) >> { throw Mock(ModuleResourceNotFoundException.class) } - when: 'get module resource api is invoked' + when: 'the request is posted' def response = mvc.perform(post(getModulesEndpoint) .contentType(MediaType.APPLICATION_JSON) .content(jsonData)).andReturn().response @@ -186,31 +188,32 @@ class DmiRestControllerSpec extends Specification { } def 'Get resource data for pass-through operational.'() { - given: 'Get resource data url' + given: 'Get resource data url and some request data' def getResourceDataForCmHandleUrl = "${basePathV1}/ch/some-cmHandle/data/ds/ncmp-datastore:passthrough-operational" + "?resourceIdentifier=parent/child&options=(fields=myfields,depth=5)" - def json = '{"cmHandleProperties" : { "prop1" : "value1", "prop2" : "value2"}}' - when: 'get resource data POST api is invoked' + def someValidJson = '{}' + when: 'the request is posted' def response = mvc.perform( - post(getResourceDataForCmHandleUrl).contentType(MediaType.APPLICATION_JSON).content(json) + post(getResourceDataForCmHandleUrl).contentType(MediaType.APPLICATION_JSON).content(someValidJson) ).andReturn().response then: 'response status is ok' response.status == OK.value() - and: 'dmi service called with get resource data' + and: 'dmi service method to get resource data is invoked once' 1 * mockDmiService.getResourceData('some-cmHandle', 'parent/child', '(fields=myfields,depth=5)', 'content=all') } - def 'Get resource data for pass-through operational with bad request.'() { + def 'Get resource data for pass-through operational with write request (invalid).'() { given: 'Get resource data url' def getResourceDataForCmHandleUrl = "${basePathV1}/ch/some-cmHandle/data/ds/ncmp-datastore:passthrough-operational" + - "?resourceIdentifier=parent/child&options=(fields=myfields,depth=5)" - def jsonData = TestUtils.getResourceFileContent('createDataWithNormalChar.json') - when: 'get resource data POST api is invoked' + "?resourceIdentifier=parent/child&options=(fields=myfields,depth=5)" + and: 'an invalid write request data for "create" operation' + def jsonData = '{"operation":"create"}' + when: 'the request is posted' def response = mvc.perform( - post(getResourceDataForCmHandleUrl).contentType(MediaType.APPLICATION_JSON).content(jsonData) + post(getResourceDataForCmHandleUrl).contentType(MediaType.APPLICATION_JSON).content(jsonData) ).andReturn().response then: 'response status is bad request' response.status == BAD_REQUEST.value() @@ -219,22 +222,23 @@ class DmiRestControllerSpec extends Specification { } def 'data with #scenario operation using passthrough running.'() { - given: 'write data for passthrough running url and jsonData' + given: 'write data for passthrough running url' def writeDataForPassthroughRunning = "${basePathV1}/ch/some-cmHandle/data/ds/ncmp-datastore:passthrough-running" + "?resourceIdentifier=some-resourceIdentifier" + and: 'request data for #scenario' def jsonData = TestUtils.getResourceFileContent(requestBodyFile) and: 'dmi service is called' mockDmiService.writeData(operationEnum, 'some-cmHandle', 'some-resourceIdentifier', dataType, 'normal request body' ) >> '{some-json}' - when: 'write data for passthrough running post api is invoked with json data' + when: 'the request is posted' def response = mvc.perform( post(writeDataForPassthroughRunning).contentType(MediaType.APPLICATION_JSON) .content(jsonData) ).andReturn().response - then: 'response status is #expectedResponseStatus' + then: 'response status is #expectedResponseStatus' response.status == expectedResponseStatus - and: 'the data in the request body is as expected' + and: 'the response content matches the result from the DMI service' response.getContentAsString() == expectedJsonResponse where: 'given request body and data' scenario | requestBodyFile | operationEnum | dataType || expectedResponseStatus | expectedJsonResponse @@ -246,51 +250,53 @@ class DmiRestControllerSpec extends Specification { } def 'Create data using passthrough for special characters.'(){ - given: 'create data for cmHandle url and JsonData' + given: 'create data for cmHandle url' def writeDataForCmHandlePassthroughRunning = "${basePathV1}/ch/some-cmHandle/data/ds/ncmp-datastore:passthrough-running" + - "?resourceIdentifier=some-resourceIdentifier" + "?resourceIdentifier=some-resourceIdentifier" + and: 'request data with special characters' def jsonData = TestUtils.getResourceFileContent('createDataWithSpecialChar.json') - and: 'dmi service is called' + and: 'dmi service returns data' mockDmiService.writeData(CREATE, 'some-cmHandle', 'some-resourceIdentifier', 'application/json', - 'data with quote \" and new line \n') >> '{some-json}' - when: 'create cmHandle passthrough running post api is invoked with json data with special chars' + 'data with quote \" and new line \n') >> '{some-json}' + when: 'the request is posted' def response = mvc.perform( - post(writeDataForCmHandlePassthroughRunning).contentType(MediaType.APPLICATION_JSON).content(jsonData) + post(writeDataForCmHandlePassthroughRunning).contentType(MediaType.APPLICATION_JSON).content(jsonData) ).andReturn().response - then: 'response status is CREATED' + then: 'response status is CREATED' response.status == CREATED.value() - and: 'the data in the request body is as expected' + and: 'the response content matches the result from the DMI service' response.getContentAsString() == '{some-json}' } def 'PassThrough Returns OK when topic is used for async'(){ - given: 'an endpoint' + given: 'Passthrough read URL and request data with a topic (parameter)' def readPassThroughUrl ="${basePathV1}/ch/some-cmHandle/data/ds/ncmp-datastore:" + - resourceIdentifier + - '?resourceIdentifier=some-resourceIdentifier&topic=test-topic' - when: 'endpoint is invoked' + resourceIdentifier + + '?resourceIdentifier=some-resourceIdentifier&topic=test-topic' def jsonData = TestUtils.getResourceFileContent('readData.json') + when: 'the request is posted' def response = mvc.perform( - post(readPassThroughUrl).contentType(MediaType.APPLICATION_JSON).content(jsonData) + post(readPassThroughUrl).contentType(MediaType.APPLICATION_JSON).content(jsonData) ).andReturn().response then: 'response status is OK' assert response.status == HttpStatus.NO_CONTENT.value() where: 'the following values are used' - resourceIdentifier << ['passthrough-operational', 'passthrough-running'] + resourceIdentifier << ['passthrough-operational', 'passthrough-running'] } def 'Get resource data for pass-through running with #scenario value in resource identifier param.'() { given: 'Get resource data url' def getResourceDataForCmHandleUrl = "${basePathV1}/ch/some-cmHandle/data/ds/ncmp-datastore:passthrough-running" + "?resourceIdentifier="+resourceIdentifier+"&options=(fields=myfields,depth=5)" + and: 'some valid json data' def json = '{"cmHandleProperties" : { "prop1" : "value1", "prop2" : "value2"}}' - when: 'get resource data POST api is invoked' + when: 'the request is posted' def response = mvc.perform( post(getResourceDataForCmHandleUrl).contentType(MediaType.APPLICATION_JSON).content(json) ).andReturn().response then: 'response status is ok' response.status == OK.value() - and: 'dmi service called with get resource data for a cm handle' + and: 'dmi service method to get resource data is invoked once with correct parameters' 1 * mockDmiService.getResourceData('some-cmHandle', resourceIdentifier, '(fields=myfields,depth=5)', |