cps-rest/src/test/groovy/org/onap/cps/rest/controller/AdminRestControllerSpec.groovy

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2020 Pantheon.tech
   4  *  Modifications Copyright (C) 2020 Bell Canada. All rights reserved.
   5  *  ================================================================================
   6  *  Licensed under the Apache License, Version 2.0 (the "License");
   7  *  you may not use this file except in compliance with the License.
   8  *  You may obtain a copy of the License at
   9  *
  10  *        http://www.apache.org/licenses/LICENSE-2.0
  11  *  Unless required by applicable law or agreed to in writing, software
  12  *  distributed under the License is distributed on an "AS IS" BASIS,
  13  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  *  See the License for the specific language governing permissions and
  15  *  limitations under the License.
  16  *
  17  *  SPDX-License-Identifier: Apache-2.0
  18  *  ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.cps.rest.controller
  22
  23 import org.modelmapper.ModelMapper
  24 import org.onap.cps.api.CpsAdminService
  25 import org.onap.cps.api.CpsModuleService
  26 import org.onap.cps.spi.exceptions.DataspaceAlreadyDefinedException
  27 import org.onap.cps.spi.exceptions.SchemaSetInUseException
  28 import org.onap.cps.spi.model.Anchor
  29 import org.onap.cps.spi.model.SchemaSet
  30 import org.spockframework.spring.SpringBean
  31 import org.springframework.beans.factory.annotation.Autowired
  32 import org.springframework.beans.factory.annotation.Value
  33 import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest
  34 import org.springframework.http.HttpStatus
  35 import org.springframework.http.MediaType
  36 import org.springframework.mock.web.MockMultipartFile
  37 import org.springframework.test.web.servlet.MockMvc
  38 import org.springframework.util.LinkedMultiValueMap
  39 import org.springframework.util.MultiValueMap
  40 import spock.lang.Specification
  41 import spock.lang.Unroll
  42
  43 import static org.onap.cps.spi.CascadeDeleteAllowed.CASCADE_DELETE_PROHIBITED
  44 import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.delete
  45 import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get
  46 import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.multipart
  47 import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post
  48
  49 @WebMvcTest
  50 class AdminRestControllerSpec extends Specification {
  51
  52     @SpringBean
  53     CpsModuleService mockCpsModuleService = Mock()
  54
  55     @SpringBean
  56     CpsAdminService mockCpsAdminService = Mock()
  57
  58     @SpringBean
  59     ModelMapper modelMapper = Mock()
  60
  61     @Autowired
  62     MockMvc mvc
  63
  64     @Value('${rest.api.base-path}')
  65     def basePath
  66
  67     def anchorsEndpoint = '/v1/dataspaces/my_dataspace/anchors'
  68     def schemaSetsEndpoint = '/v1/dataspaces/test-dataspace/schema-sets'
  69     def schemaSetEndpoint = schemaSetsEndpoint + '/my_schema_set'
  70
  71     def anchor = new Anchor(name: 'my_anchor')
  72     def anchorList = [anchor]
  73
  74     def 'Create new dataspace'() {
  75         when:
  76             def response = performCreateDataspaceRequest("new-dataspace")
  77         then: 'Service method is invoked with expected parameters'
  78             1 * mockCpsAdminService.createDataspace("new-dataspace")
  79         and: 'Dataspace is create successfully'
  80             response.status == HttpStatus.CREATED.value()
  81     }
  82
  83     def 'Create dataspace over existing with same name'() {
  84         given:
  85             def thrownException = new DataspaceAlreadyDefinedException("", new RuntimeException())
  86             mockCpsAdminService.createDataspace("existing-dataspace") >> { throw thrownException }
  87         when:
  88             def response = performCreateDataspaceRequest("existing-dataspace")
  89         then: 'Dataspace creation fails'
  90             response.status == HttpStatus.BAD_REQUEST.value()
  91     }
  92
  93     def 'Create schema set from yang file.'() {
  94         def yangResourceMapCapture
  95         given: 'single yang file'
  96             def multipartFile = createMultipartFile("filename.yang", "content")
  97         when: 'file uploaded with schema set create request'
  98             def response = performCreateSchemaSetRequest(multipartFile)
  99         then: 'associated service method is invoked with expected parameters'
 100             1 * mockCpsModuleService.createSchemaSet('test-dataspace', 'test-schema-set', _) >>
 101                     { args -> yangResourceMapCapture = args[2] }
 102             yangResourceMapCapture['filename.yang'] == 'content'
 103         and: 'response code indicates success'
 104             response.status == HttpStatus.CREATED.value()
 105     }
 106
 107     def 'Create schema set from zip archive.'() {
 108         def yangResourceMapCapture
 109         given: 'zip archive with multiple .yang files inside'
 110             def multipartFile = createZipMultipartFileFromResource("/yang-files-set.zip")
 111         when: 'file uploaded with schema set create request'
 112             def response = performCreateSchemaSetRequest(multipartFile)
 113         then: 'associated service method is invoked with expected parameters'
 114             1 * mockCpsModuleService.createSchemaSet('test-dataspace', 'test-schema-set', _) >>
 115                     { args -> yangResourceMapCapture = args[2] }
 116             yangResourceMapCapture['assembly.yang'] == "fake assembly content 1\n"
 117             yangResourceMapCapture['component.yang'] == "fake component content 1\n"
 118         and: 'response code indicates success'
 119             response.status == HttpStatus.CREATED.value()
 120     }
 121
 122     @Unroll
 123     def 'Create schema set from zip archive having #caseDescriptor.'() {
 124         when: 'zip archive having #caseDescriptor is uploaded with create schema set request'
 125             def response = performCreateSchemaSetRequest(multipartFile)
 126         then: 'create schema set rejected'
 127             response.status == HttpStatus.BAD_REQUEST.value()
 128         where: 'following cases are tested'
 129             caseDescriptor                        | multipartFile
 130             'no .yang files inside'               | createZipMultipartFileFromResource("/no-yang-files.zip")
 131             'multiple .yang files with same name' | createZipMultipartFileFromResource("/yang-files-multiple-sets.zip")
 132     }
 133
 134     def 'Create schema set from file with unsupported filename extension.'() {
 135         given: 'file with unsupported filename extension (.doc)'
 136             def multipartFile = createMultipartFile("filename.doc", "content")
 137         when: 'file uploaded with schema set create request'
 138             def response = performCreateSchemaSetRequest(multipartFile)
 139         then: 'create schema set rejected'
 140             response.status == HttpStatus.BAD_REQUEST.value()
 141     }
 142
 143     @Unroll
 144     def 'Create schema set from #fileType file with IOException occurrence on processing.'() {
 145         when: 'file uploaded with schema set create request'
 146             def response = performCreateSchemaSetRequest(createMultipartFileForIOException(fileType))
 147         then: 'the error response returned indicating internal server error occurrence'
 148             response.status == HttpStatus.INTERNAL_SERVER_ERROR.value()
 149         where: 'following file types are used'
 150             fileType << ['YANG', 'ZIP']
 151     }
 152
 153     def 'Delete schema set.'() {
 154         when: 'delete schema set endpoint is invoked'
 155             def response = performDeleteRequest(schemaSetEndpoint)
 156         then: 'associated service method is invoked with expected parameters'
 157             1 * mockCpsModuleService.deleteSchemaSet('test-dataspace', 'my_schema_set', CASCADE_DELETE_PROHIBITED)
 158         and: 'response code indicates success'
 159             response.status == HttpStatus.NO_CONTENT.value()
 160     }
 161
 162     def 'Delete schema set which is in use.'() {
 163         given: 'the service method throws an exception indicating the schema set is in use'
 164             def thrownException = new SchemaSetInUseException('test-dataspace', 'my_schema_set')
 165             mockCpsModuleService.deleteSchemaSet('test-dataspace', 'my_schema_set', CASCADE_DELETE_PROHIBITED) >>
 166                     { throw thrownException }
 167         when: 'delete schema set endpoint is invoked'
 168             def response = performDeleteRequest(schemaSetEndpoint)
 169         then: 'schema set deletion fails with conflict response code'
 170             response.status == HttpStatus.CONFLICT.value()
 171     }
 172
 173     def performCreateDataspaceRequest(String dataspaceName) {
 174         return mvc.perform(
 175                 post("$basePath/v1/dataspaces").param('dataspace-name', dataspaceName)
 176         ).andReturn().response
 177     }
 178
 179     def createMultipartFile(filename, content) {
 180         return new MockMultipartFile("file", filename, "text/plain", content.getBytes())
 181     }
 182
 183     def createZipMultipartFileFromResource(resourcePath) {
 184         return new MockMultipartFile("file", "test.zip", "application/zip",
 185                 getClass().getResource(resourcePath).getBytes())
 186     }
 187
 188     def createMultipartFileForIOException(extension) {
 189         def multipartFile = Mock(MockMultipartFile)
 190         multipartFile.getOriginalFilename() >> "TEST." + extension
 191         multipartFile.getBytes() >> { throw new IOException() }
 192         multipartFile.getInputStream() >> { throw new IOException() }
 193         return multipartFile
 194     }
 195
 196     def performCreateSchemaSetRequest(multipartFile) {
 197         return mvc.perform(
 198                 multipart("$basePath$schemaSetsEndpoint")
 199                         .file(multipartFile)
 200                         .param('schema-set-name', 'test-schema-set')
 201         ).andReturn().response
 202     }
 203
 204     def performDeleteRequest(String deleteEndpoint) {
 205         return mvc.perform(delete("$basePath$deleteEndpoint")).andReturn().response
 206     }
 207
 208     def 'Get existing schema set'() {
 209         given:
 210             mockCpsModuleService.getSchemaSet('test-dataspace', 'my_schema_set') >>
 211                     new SchemaSet(name: 'my_schema_set', dataspaceName: 'test-dataspace')
 212         when: 'get schema set API is invoked'
 213             def response = mvc.perform(get("$basePath$schemaSetEndpoint")).andReturn().response
 214         then: 'the correct schema set is returned'
 215             response.status == HttpStatus.OK.value()
 216             response.getContentAsString().contains('my_schema_set')
 217     }
 218
 219     def 'Create Anchor'() {
 220         given:
 221             def requestParams = new LinkedMultiValueMap<>()
 222             requestParams.add('schema-set-name', 'my_schema-set')
 223             requestParams.add('anchor-name', 'my_anchor')
 224         when: 'post is invoked'
 225             def response = mvc.perform(post("$basePath$anchorsEndpoint").contentType(MediaType.APPLICATION_JSON)
 226                     .params(requestParams as MultiValueMap)).andReturn().response
 227         then: 'Anchor is created successfully'
 228             1 * mockCpsAdminService.createAnchor('my_dataspace', 'my_schema-set', 'my_anchor')
 229             response.status == HttpStatus.CREATED.value()
 230             response.getContentAsString().contains('my_anchor')
 231     }
 232
 233     def 'Get existing anchor'() {
 234         given:
 235             mockCpsAdminService.getAnchors('my_dataspace') >> anchorList
 236         when: 'get all anchors API is invoked'
 237             def response = mvc.perform(get("$basePath$anchorsEndpoint")).andReturn().response
 238         then: 'the correct anchor is returned'
 239             response.status == HttpStatus.OK.value()
 240             response.getContentAsString().contains('my_anchor')
 241     }
 242 }