/*
* ============LICENSE_START=======================================================
- * Copyright (C) 2020 Pantheon.tech
+ * Copyright (C) 2020-2021 Pantheon.tech
+ * Modifications Copyright (C) 2020-2021 Bell Canada.
+ * Modifications Copyright (C) 2021 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.
package org.onap.cps.rest.controller
+import static org.onap.cps.spi.CascadeDeleteAllowed.CASCADE_DELETE_PROHIBITED
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.delete
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get
+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.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.spi.exceptions.AlreadyDefinedException
+import org.onap.cps.spi.exceptions.SchemaSetInUseException
+import org.onap.cps.spi.model.Anchor
+import org.onap.cps.spi.model.SchemaSet
import org.spockframework.spring.SpringBean
import org.springframework.beans.factory.annotation.Autowired
+import org.springframework.beans.factory.annotation.Value
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest
import org.springframework.http.HttpStatus
+import org.springframework.http.MediaType
import org.springframework.mock.web.MockMultipartFile
import org.springframework.test.web.servlet.MockMvc
-import org.springframework.test.web.servlet.request.MockMvcRequestBuilders
+import org.springframework.util.LinkedMultiValueMap
+import org.springframework.util.MultiValueMap
import spock.lang.Specification
-@WebMvcTest
+@WebMvcTest(AdminRestController)
class AdminRestControllerSpec extends Specification {
@SpringBean
CpsAdminService mockCpsAdminService = Mock()
@SpringBean
- ModelMapper modelMapper = Mock();
+ ModelMapper modelMapper = Spy()
@Autowired
MockMvc mvc
- def 'Create schema set from yang file'() {
+ @Value('${rest.api.cps-base-path}')
+ def basePath
+
+ def dataspaceName = 'my_dataspace'
+ def anchor = new Anchor(name: 'my_anchor')
+ def anchorList = [anchor]
+ def anchorName = 'my_anchor'
+ def schemaSetName = 'my_schema_set'
+
+ 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: '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:
+ given: 'single yang file'
def multipartFile = createMultipartFile("filename.yang", "content")
- when:
- def response = performCreateSchemaSetRequest(multipartFile)
- then: 'Service method is invoked with expected parameters'
- 1 * mockCpsModuleService.createSchemaSet('test-dataspace', 'test-schema-set', _) >>
+ and: 'an endpoint'
+ def schemaSetEndpoint = "$basePath/v1/dataspaces/$dataspaceName/schema-sets"
+ when: 'file uploaded with schema set create request'
+ 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(dataspaceName, schemaSetName, _) >>
{ args -> yangResourceMapCapture = args[2] }
yangResourceMapCapture['filename.yang'] == 'content'
- and: 'Response code indicates success'
+ and: 'response code indicates success'
+ response.status == HttpStatus.CREATED.value()
+ }
+
+ def 'Create schema set from zip archive.'() {
+ 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 =
+ 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(dataspaceName, schemaSetName, _) >>
+ { args -> yangResourceMapCapture = args[2] }
+ yangResourceMapCapture['assembly.yang'] == "fake assembly content 1\n"
+ yangResourceMapCapture['component.yang'] == "fake component content 1\n"
+ and: 'response code indicates success'
+ response.status == HttpStatus.CREATED.value()
+ }
+
+ 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 file with invalid filename extension'() {
- given:
+ 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 =
+ 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'
+ caseDescriptor | multipartFile
+ 'no .yang files inside' | createZipMultipartFileFromResource("/no-yang-files.zip")
+ 'multiple .yang files with same name' | createZipMultipartFileFromResource("/yang-files-multiple-sets.zip")
+ }
+
+ def 'Create schema set from file with unsupported filename extension.'() {
+ given: 'file with unsupported filename extension (.doc)'
def multipartFile = createMultipartFile("filename.doc", "content")
- when:
- def response = performCreateSchemaSetRequest(multipartFile)
- then:
+ and: 'an endpoint'
+ def schemaSetEndpoint = "$basePath/v1/dataspaces/$dataspaceName/schema-sets"
+ when: 'file uploaded with schema set create request'
+ 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()
}
+ 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 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'
+ fileType << ['YANG', 'ZIP']
+ }
+
+ 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 = mvc.perform(delete(schemaSetEndpoint)).andReturn().response
+ then: 'associated service method is invoked with expected parameters'
+ 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: '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 = mvc.perform(delete(schemaSetEndpoint)).andReturn().response
+ then: 'schema set deletion fails with conflict response code'
+ response.status == HttpStatus.CONFLICT.value()
+ }
+
+ 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(schemaSetEndpoint)).andReturn().response
+ then: 'the correct schema set is returned'
+ response.status == HttpStatus.OK.value()
+ response.getContentAsString().contains(schemaSetName)
+ }
+
+ def 'Create Anchor.'() {
+ given: 'request parameters'
+ def requestParams = new LinkedMultiValueMap<>()
+ 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(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(anchorName)
+ }
+
+ def 'Get existing anchor.'() {
+ given: 'service method returns a list of anchors'
+ mockCpsAdminService.getAnchors(dataspaceName) >> anchorList
+ and: 'an endpoint'
+ def anchorEndpoint = "$basePath/v1/dataspaces/$dataspaceName/anchors"
+ when: 'get all anchors API is invoked'
+ def response = mvc.perform(get(anchorEndpoint)).andReturn().response
+ then: 'the correct anchor is returned'
+ response.status == HttpStatus.OK.value()
+ response.getContentAsString().contains(anchorName)
+ }
+
+ def 'Get existing anchor by dataspace and anchor name.'() {
+ 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(anchorEndpoint)).andReturn().response
+ def responseContent = response.getContentAsString()
+ then: 'the correct anchor is returned'
+ response.status == HttpStatus.OK.value()
+ 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 performCreateSchemaSetRequest(multipartFile) {
- return mvc.perform(
- MockMvcRequestBuilders
- .multipart('/v1/dataspaces/test-dataspace/schema-sets')
- .file(multipartFile)
- .param('schemaSetName', 'test-schema-set')
- ).andReturn().response
+ 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
}
}
Code Review / cps.git / blobdiff