1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
|
/*
* ============LICENSE_START=======================================================
* Copyright (C) 2020 Pantheon.tech
* Modifications Copyright (C) 2020 Bell Canada. All rights reserved.
* ================================================================================
* 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.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* SPDX-License-Identifier: Apache-2.0
* ============LICENSE_END=========================================================
*/
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.spi.exceptions.DataspaceAlreadyDefinedException
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.util.LinkedMultiValueMap
import org.springframework.util.MultiValueMap
import spock.lang.Specification
import spock.lang.Unroll
@WebMvcTest
class AdminRestControllerSpec extends Specification {
@SpringBean
CpsModuleService mockCpsModuleService = Mock()
@SpringBean
CpsAdminService mockCpsAdminService = Mock()
@SpringBean
CpsDataService mockCpsDataService = Mock()
@SpringBean
ModelMapper modelMapper = Mock()
@Autowired
MockMvc mvc
@Value('${rest.api.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 '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'
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 schema set from yang file.'() {
def yangResourceMapCapture
given: 'single yang file'
def multipartFile = createMultipartFile("filename.yang", "content")
when: 'file uploaded with schema set create request'
def response = performCreateSchemaSetRequest(multipartFile)
then: 'associated service method is invoked with expected parameters'
1 * mockCpsModuleService.createSchemaSet('test-dataspace', 'test-schema-set', _) >>
{ args -> yangResourceMapCapture = args[2] }
yangResourceMapCapture['filename.yang'] == 'content'
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")
when: 'file uploaded with schema set create request'
def response = performCreateSchemaSetRequest(multipartFile)
then: 'associated service method is invoked with expected parameters'
1 * mockCpsModuleService.createSchemaSet('test-dataspace', 'test-schema-set', _) >>
{ 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()
}
@Unroll
def 'Create schema set from zip archive having #caseDescriptor.'() {
when: 'zip archive having #caseDescriptor is uploaded with create schema set request'
def response = performCreateSchemaSetRequest(multipartFile)
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: 'file uploaded with schema set create request'
def response = performCreateSchemaSetRequest(multipartFile)
then: 'create schema set rejected'
response.status == HttpStatus.BAD_REQUEST.value()
}
@Unroll
def 'Create schema set from #fileType file with IOException occurrence on processing.'() {
when: 'file uploaded with schema set create request'
def response = performCreateSchemaSetRequest(createMultipartFileForIOException(fileType))
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.'() {
when: 'delete schema set endpoint is invoked'
def response = performDeleteRequest(schemaSetEndpoint)
then: 'associated service method is invoked with expected parameters'
1 * mockCpsModuleService.deleteSchemaSet('test-dataspace', 'my_schema_set', 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) >>
{ throw thrownException }
when: 'delete schema set endpoint is invoked'
def response = performDeleteRequest(schemaSetEndpoint)
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')
when: 'get schema set API is invoked'
def response = mvc.perform(get("$basePath$schemaSetEndpoint")).andReturn().response
then: 'the correct schema set is returned'
response.status == HttpStatus.OK.value()
response.getContentAsString().contains('my_schema_set')
}
def 'Create Anchor'() {
given:
def requestParams = new LinkedMultiValueMap<>()
requestParams.add('schema-set-name', 'my_schema-set')
requestParams.add('anchor-name', 'my_anchor')
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')
response.status == HttpStatus.CREATED.value()
response.getContentAsString().contains('my_anchor')
}
def 'Get existing anchor'() {
given:
mockCpsAdminService.getAnchors('my_dataspace') >> anchorList
when: 'get all anchors API is invoked'
def response = mvc.perform(get("$basePath$anchorsEndpoint")).andReturn().response
then: 'the correct anchor is returned'
response.status == HttpStatus.OK.value()
response.getContentAsString().contains('my_anchor')
}
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')
when: 'get anchor API is invoked'
def response = mvc.perform(get("$basePath$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')
}
}
|