X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=cps-rest%2Fsrc%2Ftest%2Fgroovy%2Forg%2Fonap%2Fcps%2Frest%2Fcontroller%2FAdminRestControllerSpec.groovy;h=41ad9ca5b242ae020b163095512de104479503da;hb=1839f38e054a958793ec40f524d911253086c74e;hp=db0ab6d64f9cfdcb53a07a9aed6ac9fa10984ba5;hpb=4be931a5d98df7b9adb88f70292d103f2c16080f;p=cps.git diff --git a/cps-rest/src/test/groovy/org/onap/cps/rest/controller/AdminRestControllerSpec.groovy b/cps-rest/src/test/groovy/org/onap/cps/rest/controller/AdminRestControllerSpec.groovy index db0ab6d64..41ad9ca5b 100755 --- a/cps-rest/src/test/groovy/org/onap/cps/rest/controller/AdminRestControllerSpec.groovy +++ b/cps-rest/src/test/groovy/org/onap/cps/rest/controller/AdminRestControllerSpec.groovy @@ -1,13 +1,15 @@ /* * ============LICENSE_START======================================================= - * Copyright (C) 2020 Pantheon.tech - * Modifications Copyright (C) 2020 Bell Canada. All rights reserved. + * Copyright (C) 2020-2021 Pantheon.tech + * Modifications Copyright (C) 2020-2021 Bell Canada. + * Modifications Copyright (C) 2021-2022 Nordix Foundation * ================================================================================ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -26,10 +28,10 @@ import static org.springframework.test.web.servlet.request.MockMvcRequestBuilder import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.multipart import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post -import org.modelmapper.ModelMapper +import org.mapstruct.factory.Mappers import org.onap.cps.api.CpsAdminService import org.onap.cps.api.CpsModuleService -import org.onap.cps.spi.exceptions.DataspaceAlreadyDefinedException +import org.onap.cps.spi.exceptions.AlreadyDefinedException import org.onap.cps.spi.exceptions.SchemaSetInUseException import org.onap.cps.spi.model.Anchor import org.onap.cps.spi.model.SchemaSet @@ -44,9 +46,8 @@ import org.springframework.test.web.servlet.MockMvc import org.springframework.util.LinkedMultiValueMap import org.springframework.util.MultiValueMap import spock.lang.Specification -import spock.lang.Unroll -@WebMvcTest +@WebMvcTest(AdminRestController) class AdminRestControllerSpec extends Specification { @SpringBean @@ -56,49 +57,65 @@ class AdminRestControllerSpec extends Specification { CpsAdminService mockCpsAdminService = Mock() @SpringBean - ModelMapper modelMapper = Mock() + CpsRestInputMapper cpsRestInputMapper = Mappers.getMapper(CpsRestInputMapper) @Autowired MockMvc mvc - @Value('${rest.api.base-path}') + @Value('${rest.api.cps-base-path}') def basePath - def anchorsEndpoint = '/v1/dataspaces/my_dataspace/anchors' - def anchorEndpoint = '/v1/dataspaces/my_dataspace/anchors/my_anchorname' - def schemaSetsEndpoint = '/v1/dataspaces/test-dataspace/schema-sets' - def schemaSetEndpoint = schemaSetsEndpoint + '/my_schema_set' - - def anchor = new Anchor(name: 'my_anchor') - def anchorList = [anchor] + def dataspaceName = 'my_dataspace' + def anchorName = 'my_anchor' + def schemaSetName = 'my_schema_set' + def anchor = new Anchor(name: anchorName, dataspaceName: dataspaceName, schemaSetName: schemaSetName) - def 'Create new dataspace'() { - when: - def response = performCreateDataspaceRequest("new-dataspace") - then: 'Service method is invoked with expected parameters' - 1 * mockCpsAdminService.createDataspace("new-dataspace") - and: 'Dataspace is create successfully' + def 'Create new dataspace.'() { + given: 'an endpoint' + def createDataspaceEndpoint = "$basePath/v1/dataspaces" + when: 'post is invoked' + def response = + mvc.perform( + post(createDataspaceEndpoint) + .param('dataspace-name', dataspaceName)) + .andReturn().response + then: 'service method is invoked with expected parameters' + 1 * mockCpsAdminService.createDataspace(dataspaceName) + and: 'dataspace is create successfully' response.status == HttpStatus.CREATED.value() } - def 'Create dataspace over existing with same name'() { - given: - def thrownException = new DataspaceAlreadyDefinedException("", new RuntimeException()) - mockCpsAdminService.createDataspace("existing-dataspace") >> { throw thrownException } - when: - def response = performCreateDataspaceRequest("existing-dataspace") - then: 'Dataspace creation fails' - response.status == HttpStatus.BAD_REQUEST.value() + def 'Create dataspace over existing with same name.'() { + given: 'an endpoint' + def createDataspaceEndpoint = "$basePath/v1/dataspaces" + and: 'the service method throws an exception indicating the dataspace is already defined' + def thrownException = new AlreadyDefinedException(dataspaceName, new RuntimeException()) + mockCpsAdminService.createDataspace(dataspaceName) >> { throw thrownException } + when: 'post is invoked' + def response = + mvc.perform( + post(createDataspaceEndpoint) + .param('dataspace-name', dataspaceName)) + .andReturn().response + then: 'dataspace creation fails' + response.status == HttpStatus.CONFLICT.value() } def 'Create schema set from yang file.'() { def yangResourceMapCapture given: 'single yang file' def multipartFile = createMultipartFile("filename.yang", "content") + and: 'an endpoint' + def schemaSetEndpoint = "$basePath/v1/dataspaces/$dataspaceName/schema-sets" when: 'file uploaded with schema set create request' - def response = performCreateSchemaSetRequest(multipartFile) + def response = + mvc.perform( + multipart(schemaSetEndpoint) + .file(multipartFile) + .param('schema-set-name', schemaSetName)) + .andReturn().response then: 'associated service method is invoked with expected parameters' - 1 * mockCpsModuleService.createSchemaSet('test-dataspace', 'test-schema-set', _) >> + 1 * mockCpsModuleService.createSchemaSet(dataspaceName, schemaSetName, _) >> { args -> yangResourceMapCapture = args[2] } yangResourceMapCapture['filename.yang'] == 'content' and: 'response code indicates success' @@ -109,10 +126,17 @@ class AdminRestControllerSpec extends Specification { def yangResourceMapCapture given: 'zip archive with multiple .yang files inside' def multipartFile = createZipMultipartFileFromResource("/yang-files-set.zip") + and: 'an endpoint' + def schemaSetEndpoint = "$basePath/v1/dataspaces/$dataspaceName/schema-sets" when: 'file uploaded with schema set create request' - def response = performCreateSchemaSetRequest(multipartFile) + def response = + mvc.perform( + multipart(schemaSetEndpoint) + .file(multipartFile) + .param('schema-set-name', schemaSetName)) + .andReturn().response then: 'associated service method is invoked with expected parameters' - 1 * mockCpsModuleService.createSchemaSet('test-dataspace', 'test-schema-set', _) >> + 1 * mockCpsModuleService.createSchemaSet(dataspaceName, schemaSetName, _) >> { args -> yangResourceMapCapture = args[2] } yangResourceMapCapture['assembly.yang'] == "fake assembly content 1\n" yangResourceMapCapture['component.yang'] == "fake component content 1\n" @@ -120,10 +144,34 @@ class AdminRestControllerSpec extends Specification { response.status == HttpStatus.CREATED.value() } - @Unroll + def 'Create a schema set from a yang file that is greater than 1MB.'() { + given: 'a yang file greater than 1MB' + def multipartFile = createMultipartFileFromResource("/model-over-1mb.yang") + and: 'an endpoint' + def schemaSetEndpoint = "$basePath/v1/dataspaces/$dataspaceName/schema-sets" + when: 'a file is uploaded to the create schema set endpoint' + def response = + mvc.perform( + multipart(schemaSetEndpoint) + .file(multipartFile) + .param('schema-set-name', schemaSetName)) + .andReturn().response + then: 'the associated service method is invoked' + 1 * mockCpsModuleService.createSchemaSet(dataspaceName, schemaSetName, _) + and: 'the response code indicates success' + response.status == HttpStatus.CREATED.value() + } + def 'Create schema set from zip archive having #caseDescriptor.'() { + given: 'an endpoint' + def schemaSetEndpoint = "$basePath/v1/dataspaces/$dataspaceName/schema-sets" when: 'zip archive having #caseDescriptor is uploaded with create schema set request' - def response = performCreateSchemaSetRequest(multipartFile) + def response = + mvc.perform( + multipart(schemaSetEndpoint) + .file(multipartFile) + .param('schema-set-name', schemaSetName)) + .andReturn().response then: 'create schema set rejected' response.status == HttpStatus.BAD_REQUEST.value() where: 'following cases are tested' @@ -135,16 +183,30 @@ class AdminRestControllerSpec extends Specification { def 'Create schema set from file with unsupported filename extension.'() { given: 'file with unsupported filename extension (.doc)' def multipartFile = createMultipartFile("filename.doc", "content") + and: 'an endpoint' + def schemaSetEndpoint = "$basePath/v1/dataspaces/$dataspaceName/schema-sets" when: 'file uploaded with schema set create request' - def response = performCreateSchemaSetRequest(multipartFile) + def response = + mvc.perform( + multipart(schemaSetEndpoint) + .file(multipartFile) + .param('schema-set-name', schemaSetName)) + .andReturn().response then: 'create schema set rejected' response.status == HttpStatus.BAD_REQUEST.value() } - @Unroll def 'Create schema set from #fileType file with IOException occurrence on processing.'() { + given: 'an endpoint' + def schemaSetEndpoint = "$basePath/v1/dataspaces/$dataspaceName/schema-sets" when: 'file uploaded with schema set create request' - def response = performCreateSchemaSetRequest(createMultipartFileForIOException(fileType)) + def multipartFile = createMultipartFileForIOException(fileType) + def response = + mvc.perform( + multipart(schemaSetEndpoint) + .file(multipartFile) + .param('schema-set-name', schemaSetName)) + .andReturn().response then: 'the error response returned indicating internal server error occurrence' response.status == HttpStatus.INTERNAL_SERVER_ERROR.value() where: 'following file types are used' @@ -152,105 +214,133 @@ class AdminRestControllerSpec extends Specification { } def 'Delete schema set.'() { + given: 'an endpoint' + def schemaSetEndpoint = "$basePath/v1/dataspaces/$dataspaceName/schema-sets/$schemaSetName" when: 'delete schema set endpoint is invoked' - def response = performDeleteRequest(schemaSetEndpoint) + def response = mvc.perform(delete(schemaSetEndpoint)).andReturn().response then: 'associated service method is invoked with expected parameters' - 1 * mockCpsModuleService.deleteSchemaSet('test-dataspace', 'my_schema_set', CASCADE_DELETE_PROHIBITED) + 1 * mockCpsModuleService.deleteSchemaSet(dataspaceName, schemaSetName, CASCADE_DELETE_PROHIBITED) and: 'response code indicates success' response.status == HttpStatus.NO_CONTENT.value() } def 'Delete schema set which is in use.'() { - given: 'the service method throws an exception indicating the schema set is in use' - def thrownException = new SchemaSetInUseException('test-dataspace', 'my_schema_set') - mockCpsModuleService.deleteSchemaSet('test-dataspace', 'my_schema_set', CASCADE_DELETE_PROHIBITED) >> + given: 'service method throws an exception indicating the schema set is in use' + def thrownException = new SchemaSetInUseException(dataspaceName, schemaSetName) + mockCpsModuleService.deleteSchemaSet(dataspaceName, schemaSetName, CASCADE_DELETE_PROHIBITED) >> { throw thrownException } + and: 'an endpoint' + def schemaSetEndpoint = "$basePath/v1/dataspaces/$dataspaceName/schema-sets/$schemaSetName" when: 'delete schema set endpoint is invoked' - def response = performDeleteRequest(schemaSetEndpoint) + def response = mvc.perform(delete(schemaSetEndpoint)).andReturn().response then: 'schema set deletion fails with conflict response code' response.status == HttpStatus.CONFLICT.value() } - def performCreateDataspaceRequest(String dataspaceName) { - return mvc.perform( - post("$basePath/v1/dataspaces").param('dataspace-name', dataspaceName) - ).andReturn().response - } - - def createMultipartFile(filename, content) { - return new MockMultipartFile("file", filename, "text/plain", content.getBytes()) - } - - def createZipMultipartFileFromResource(resourcePath) { - return new MockMultipartFile("file", "test.zip", "application/zip", - getClass().getResource(resourcePath).getBytes()) - } - - def createMultipartFileForIOException(extension) { - def multipartFile = Mock(MockMultipartFile) - multipartFile.getOriginalFilename() >> "TEST." + extension - multipartFile.getBytes() >> { throw new IOException() } - multipartFile.getInputStream() >> { throw new IOException() } - return multipartFile - } - - def performCreateSchemaSetRequest(multipartFile) { - return mvc.perform( - multipart("$basePath$schemaSetsEndpoint") - .file(multipartFile) - .param('schema-set-name', 'test-schema-set') - ).andReturn().response - } - - def performDeleteRequest(String deleteEndpoint) { - return mvc.perform(delete("$basePath$deleteEndpoint")).andReturn().response - } - - def 'Get existing schema set'() { - given: - mockCpsModuleService.getSchemaSet('test-dataspace', 'my_schema_set') >> - new SchemaSet(name: 'my_schema_set', dataspaceName: 'test-dataspace') + def 'Get existing schema set.'() { + given: 'service method returns a new schema set' + mockCpsModuleService.getSchemaSet(dataspaceName, schemaSetName) >> + new SchemaSet(name: schemaSetName, dataspaceName: dataspaceName) + and: 'an endpoint' + def schemaSetEndpoint = "$basePath/v1/dataspaces/$dataspaceName/schema-sets/$schemaSetName" when: 'get schema set API is invoked' - def response = mvc.perform(get("$basePath$schemaSetEndpoint")).andReturn().response + def response = mvc.perform(get(schemaSetEndpoint)).andReturn().response then: 'the correct schema set is returned' response.status == HttpStatus.OK.value() - response.getContentAsString().contains('my_schema_set') + response.getContentAsString().contains(schemaSetName) } - def 'Create Anchor'() { - given: + def 'Create Anchor.'() { + given: 'request parameters' def requestParams = new LinkedMultiValueMap<>() - requestParams.add('schema-set-name', 'my_schema-set') - requestParams.add('anchor-name', 'my_anchor') + requestParams.add('schema-set-name', schemaSetName) + requestParams.add('anchor-name', anchorName) + and: 'an endpoint' + def anchorEndpoint = "$basePath/v1/dataspaces/$dataspaceName/anchors" when: 'post is invoked' - def response = mvc.perform(post("$basePath$anchorsEndpoint").contentType(MediaType.APPLICATION_JSON) - .params(requestParams as MultiValueMap)).andReturn().response - then: 'Anchor is created successfully' - 1 * mockCpsAdminService.createAnchor('my_dataspace', 'my_schema-set', 'my_anchor') + def response = + mvc.perform( + post(anchorEndpoint).contentType(MediaType.APPLICATION_JSON) + .params(requestParams as MultiValueMap)) + .andReturn().response + then: 'anchor is created successfully' + 1 * mockCpsAdminService.createAnchor(dataspaceName, schemaSetName, anchorName) response.status == HttpStatus.CREATED.value() - response.getContentAsString().contains('my_anchor') + response.getContentAsString().contains(anchorName) } - def 'Get existing anchor'() { - given: - mockCpsAdminService.getAnchors('my_dataspace') >> anchorList + def 'Get existing anchor.'() { + given: 'service method returns a list of anchors' + mockCpsAdminService.getAnchors(dataspaceName) >> [anchor] + and: 'an endpoint' + def anchorEndpoint = "$basePath/v1/dataspaces/$dataspaceName/anchors" when: 'get all anchors API is invoked' - def response = mvc.perform(get("$basePath$anchorsEndpoint")).andReturn().response + def response = mvc.perform(get(anchorEndpoint)).andReturn().response then: 'the correct anchor is returned' response.status == HttpStatus.OK.value() - response.getContentAsString().contains('my_anchor') + response.getContentAsString().contains(anchorName) } def 'Get existing anchor by dataspace and anchor name.'() { - given: - mockCpsAdminService.getAnchor('my_dataspace','my_anchorname') >> new Anchor(name: 'my_anchorname', dataspaceName: 'my_dataspace', schemaSetName: 'my_schemaSetName') + given: 'service method returns an anchor' + mockCpsAdminService.getAnchor(dataspaceName, anchorName) >> + new Anchor(name: anchorName, dataspaceName: dataspaceName, schemaSetName: schemaSetName) + and: 'an endpoint' + def anchorEndpoint = "$basePath/v1/dataspaces/$dataspaceName/anchors/$anchorName" when: 'get anchor API is invoked' - def response = mvc.perform(get("$basePath$anchorEndpoint")).andReturn().response + def response = mvc.perform(get(anchorEndpoint)).andReturn().response def responseContent = response.getContentAsString() then: 'the correct anchor is returned' response.status == HttpStatus.OK.value() - responseContent.contains('my_anchorname') - responseContent.contains('my_dataspace') - responseContent.contains('my_schemaSetName') + responseContent.contains(anchorName) + responseContent.contains(dataspaceName) + responseContent.contains(schemaSetName) + } + + def 'Delete anchor.'() { + given: 'an endpoint' + def anchorEndpoint = "$basePath/v1/dataspaces/$dataspaceName/anchors/$anchorName" + when: 'delete method is invoked on anchor endpoint' + def response = mvc.perform(delete(anchorEndpoint)).andReturn().response + then: 'associated service method is invoked with expected parameters' + 1 * mockCpsAdminService.deleteAnchor(dataspaceName, anchorName) + and: 'response code indicates success' + response.status == HttpStatus.NO_CONTENT.value() + } + + def 'Delete dataspace.'() { + given: 'an endpoint' + def dataspaceEndpoint = "$basePath/v1/dataspaces" + when: 'delete dataspace endpoint is invoked' + def response = mvc.perform(delete(dataspaceEndpoint) + .param('dataspace-name', dataspaceName)) + .andReturn().response + then: 'associated service method is invoked with expected parameter' + 1 * mockCpsAdminService.deleteDataspace(dataspaceName) + and: 'response code indicates success' + response.status == HttpStatus.NO_CONTENT.value() + } + + def createMultipartFile(filename, content) { + return new MockMultipartFile("file", filename, "text/plain", content.getBytes()) } + + def createZipMultipartFileFromResource(resourcePath) { + return new MockMultipartFile("file", "test.zip", "application/zip", + getClass().getResource(resourcePath).getBytes()) + } + + def createMultipartFileFromResource(resourcePath) { + return new MockMultipartFile("file", "test.yang", "application/text", + getClass().getResource(resourcePath).getBytes()) + } + + def createMultipartFileForIOException(extension) { + def multipartFile = Mock(MockMultipartFile) + multipartFile.getOriginalFilename() >> "TEST." + extension + multipartFile.getBytes() >> { throw new IOException() } + multipartFile.getInputStream() >> { throw new IOException() } + return multipartFile + } + }