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
|
/*
* ============LICENSE_START=======================================================
* Copyright (c) 2021 Bell Canada.
* ================================================================================
* 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.temporal.controller.rest
import org.onap.cps.temporal.controller.utils.DateTimeUtility
import com.fasterxml.jackson.databind.ObjectMapper
import java.time.OffsetDateTime
import org.onap.cps.temporal.controller.rest.model.AnchorDetails
import org.onap.cps.temporal.controller.rest.model.AnchorDetailsMapperImpl
import org.onap.cps.temporal.controller.rest.model.AnchorHistory
import org.onap.cps.temporal.controller.rest.model.ErrorMessage
import org.onap.cps.temporal.controller.rest.model.SortMapper
import org.onap.cps.temporal.domain.NetworkData
import org.onap.cps.temporal.domain.SearchCriteria
import org.onap.cps.temporal.service.NetworkDataService
import org.spockframework.spring.SpringBean
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest
import org.springframework.context.annotation.Import
import org.springframework.data.domain.PageRequest
import org.springframework.data.domain.SliceImpl
import org.springframework.data.domain.Sort
import org.springframework.http.HttpStatus
import org.springframework.http.MediaType
import org.springframework.security.test.context.support.WithMockUser
import org.springframework.test.web.servlet.MockMvc
import spock.lang.Specification
import spock.lang.Shared
@WebMvcTest(QueryController)
@Import([SortMapper, AnchorDetailsMapperImpl])
@WithMockUser
class QueryControllerSpec extends Specification {
@SpringBean
NetworkDataService mockNetworkDataService = Mock()
@Autowired
MockMvc mvc
def myDataspace = 'my-dataspace'
@Shared
def myAnchor = 'my-anchor'
@Shared
def mySchemaset = 'my-schemaset'
@Shared
def objectMapper = new ObjectMapper()
@Shared
def observedDescSortOrder = new Sort.Order(Sort.Direction.DESC, 'observed_timestamp')
@Shared
def anchorAscSortOrder = new Sort.Order(Sort.Direction.ASC, 'anchor')
def 'Get #endpointName: default values if missing'() {
def controllerDataBuilder = new QueryControllerDataBuilder(endpointName,
[dataspace: myDataspace] << urlSpecifParams)
given: 'network data to be returned'
def networkData = createNetworkData()
when: 'endpoint is called without pageNumber, pageLimit, sort and pointInTime'
def requestBuilder = controllerDataBuilder.
createMockHttpRequestBuilder();
def response = mvc.perform(requestBuilder).andReturn().response
then: 'pageNumber, pageSize and sort has default values'
interaction {
def expectedPageable = PageRequest.of(0, 1000,
Sort.by(Sort.Order.desc('observed_timestamp')))
1 * mockNetworkDataService.searchNetworkData(_ as SearchCriteria) >> {
SearchCriteria searchCriteria ->
assert searchCriteria.getPageable() == expectedPageable
assert searchCriteria.getObservedAfter() == null
assert searchCriteria.getCreatedBefore().isAfter(OffsetDateTime.now().minusMinutes(2))
return new SliceImpl([networkData], searchCriteria.getPageable(), false)
}
}
and: 'response is ok'
response.getStatus() == HttpStatus.OK.value()
def anchorHistory = objectMapper.readValue(response.getContentAsString(), AnchorHistory)
and: 'content has expected values'
anchorHistory.getPreviousRecordsLink() == null
anchorHistory.getNextRecordsLink() == null
anchorHistory.getRecords() == List.of(toAnchorDetails(networkData))
where:
endpointName | urlSpecifParams
'anchor by name' | [anchor: myAnchor]
'anchors by schemaset' | [schemaSet: mySchemaset]
}
def 'Get #endpointName: query data #scenario'() {
def inputParameters = [
dataspace : myDataspace,
pointInTime : '2021-07-24T01:00:01.000-0400',
pageNumber : 2, pageLimit: 10,
sortAsString: 'observed_timestamp:desc']
inputParameters << urlSpecifParams
inputParameters << parameters
def controllerDataBuilder = new QueryControllerDataBuilder(endpointName, inputParameters)
given:
def searchCriteria = controllerDataBuilder.createSearchCriteriaBuilder().build()
def networkData = createNetworkData()
mockNetworkDataService.searchNetworkData(searchCriteria) >> new SliceImpl<NetworkData>(
List.of(networkData), searchCriteria.getPageable(), true)
when: 'endpoint is called with all parameters'
def requestBuilder = controllerDataBuilder.createMockHttpRequestBuilder()
def response = mvc.perform(requestBuilder
.contentType(MediaType.APPLICATION_JSON)).andReturn().response
def responseBody = objectMapper.readValue(response.getContentAsString(), AnchorHistory)
then: 'status is ok'
response.getStatus() == HttpStatus.OK.value()
and: 'next and previous record links have expected value'
controllerDataBuilder.isExpectedNextRecordsLink(responseBody.getNextRecordsLink())
controllerDataBuilder.isExpectedPreviousRecordsLink(responseBody.getPreviousRecordsLink())
and: 'has expected network data records'
responseBody.getRecords().size() == 1
responseBody.getRecords() == [toAnchorDetails(networkData)]
where:
scenario | endpointName | urlSpecifParams | parameters
'without observedTimestampAfter and with payloadFilter' | 'anchor by name' | [anchor: myAnchor] | [observedTimestampAfter: null, payloadFilter: null]
'with observedTimestampAfter and without payloadFilter' | 'anchor by name' | [anchor: myAnchor] | [observedTimestampAfter: '2021-07-24T03:00:01.000-0400', payloadFilter: null]
'without observedTimestampAfter and with payloadFilter' | 'anchor by name' | [anchor: myAnchor] | [observedTimestampAfter: null, payloadFilter: '{"message" : "hello+world"}']
'with observedTimestampAfter and with payloadFilter' | 'anchor by name' | [anchor: myAnchor] | [observedTimestampAfter: '2021-07-24T03:00:01.000+0400', payloadFilter: '{"message" : "hello world"}']
'without observedTimestampAfter and without payloadFilter' | 'anchors by schemaset' | [schemaSet: mySchemaset] | [observedTimestampAfter: null, payloadFilter: null]
'with observedTimestampAfter and without payloadFilter' | 'anchors by schemaset' | [schemaSet: mySchemaset] | [observedTimestampAfter: '2021-07-24T03:00:01.000-0400', payloadFilter: null]
'without observedTimestampAfter and with payloadFilter' | 'anchors by schemaset' | [schemaSet: mySchemaset] | [observedTimestampAfter: null, payloadFilter: '{"message" : "hello world"}']
'with observedTimestampAfter and with payloadFilter' | 'anchors by schemaset' | [schemaSet: mySchemaset] | [observedTimestampAfter: '2021-07-24T03:00:01.000+0400', payloadFilter: '{"message" : "hello world"}']
}
def 'Get #endpointName: Sort by #sortAsString'() {
given: 'sort parameters'
def parameters = [dataspace: myDataspace, sortAsString: sortAsString] << uriSpecificParams
when: 'endpoint is called'
def controllerDataBuilder = new QueryControllerDataBuilder(endpointName, parameters)
def response = mvc.perform(controllerDataBuilder.createMockHttpRequestBuilder())
.andReturn().response
then: 'network data service is called with expected sort'
1 * mockNetworkDataService.searchNetworkData(_ as SearchCriteria) >> {
SearchCriteria searchCriteria ->
assert searchCriteria.getPageable().getSort() == expectedSort
return new SliceImpl([], searchCriteria.getPageable(), true)
}
and: 'response is ok'
response.getStatus() == HttpStatus.OK.value()
def anchorHistory = objectMapper.readValue(response.getContentAsString(), AnchorHistory)
and: 'content has expected values'
controllerDataBuilder.isExpectedNextRecordsLink(anchorHistory.getNextRecordsLink())
anchorHistory.getPreviousRecordsLink() == null
where:
endpointName | uriSpecificParams | sortAsString || expectedSort
'anchor by name' | [anchor: myAnchor] | 'observed_timestamp:desc' || Sort.by(observedDescSortOrder)
'anchor by name' | [anchor: myAnchor] | 'anchor:asc,observed_timestamp:desc' || Sort.by(anchorAscSortOrder, observedDescSortOrder)
'anchors by schemaset' | [schemaSet: mySchemaset] | 'observed_timestamp:desc' || Sort.by(observedDescSortOrder)
'anchors by schemaset' | [schemaSet: mySchemaset] | 'anchor:asc,observed_timestamp:desc' || Sort.by(anchorAscSortOrder, observedDescSortOrder)
}
def 'Get #endpointName Error handling: invalid date format in #queryParamName '() {
given: 'sort parameters'
def parameters = [dataspace: myDataspace] << uriSpecificParams
parameters[queryParamName] = 'invalid-date-string'
when: 'endpoint is called'
QueryControllerDataBuilder dataBuilder = new QueryControllerDataBuilder(endpointName, parameters)
def response = mvc.perform(dataBuilder.createMockHttpRequestBuilder())
.andReturn().response
then: 'received bad request status'
response.getStatus() == HttpStatus.BAD_REQUEST.value()
and: 'error details'
def errorMessage = objectMapper.readValue(response.getContentAsString(), ErrorMessage)
errorMessage.getStatus() == HttpStatus.BAD_REQUEST.value().toString()
errorMessage.getMessage().contains(queryParamName)
errorMessage.getMessage().contains("yyyy-MM-dd'T'HH:mm:ss.SSSZ")
where:
endpointName | uriSpecificParams | queryParamName
'anchor by name' | [anchor: myAnchor] | 'pointInTime'
'anchor by name' | [anchor: myAnchor] | 'observedTimestampAfter'
'anchors by schemaset' | [schemaSet: mySchemaset] | 'pointInTime'
'anchors by schemaset' | [schemaSet: mySchemaset] | 'observedTimestampAfter'
}
def 'Get #endpointName Error handling: invalid sort format #scenario'() {
given: 'sort parameters'
def parameters = [dataspace: myDataspace, sortAsString: sortAsString] << uriSpecificParams
when: 'endpoint is called'
def controllerDataBuilder = new QueryControllerDataBuilder(endpointName, parameters)
def response = mvc.perform(controllerDataBuilder.createMockHttpRequestBuilder())
.andReturn().response
then: 'received bad request status'
response.getStatus() == HttpStatus.BAD_REQUEST.value()
and: 'error details'
def errorMessage = objectMapper.readValue(response.getContentAsString(), ErrorMessage)
errorMessage.getStatus() == HttpStatus.BAD_REQUEST.value().toString()
errorMessage.getMessage().contains("sort")
errorMessage.getMessage().contains("'$sortAsString'")
errorMessage.getMessage().contains('<fieldname>:<direction>,...,<fieldname>:<direction>')
where:
scenario | sortAsString | endpointName | uriSpecificParams
'missing direction' | 'observed_timestamp' | 'anchor by name' | [anchor: myAnchor]
'missing separator' | 'observed_timestampdesc' | 'anchor by name' | [anchor: myAnchor]
'missing direction' | 'observed_timestamp' | 'anchors by schemaset' | [schemaSet: mySchemaset]
'missing separator' | 'observed_timestampdesc' | 'anchors by schemaset' | [schemaSet: mySchemaset]
}
def 'Get #endpointName Error handling: invalid simple payload filter '() {
given: 'payload filter parameters'
def parameters = [dataspace: myDataspace, payloadFilter: 'invalid-json'] << uriSpecificParams
when: 'endpoint is called'
def controllerDataBuilder = new QueryControllerDataBuilder(endpointName, parameters)
def response = mvc.perform(controllerDataBuilder.createMockHttpRequestBuilder())
.andReturn().response
then: 'received bad request status'
response.getStatus() == HttpStatus.BAD_REQUEST.value()
and: 'error details'
def errorMessage = objectMapper.readValue(response.getContentAsString(), ErrorMessage)
errorMessage.getStatus() == HttpStatus.BAD_REQUEST.value().toString()
errorMessage.getMessage().contains('simplePayloadFilter')
where: 'endpoints are provided'
endpointName | uriSpecificParams
'anchor by name' | [anchor: myAnchor]
'anchors by schemaset' | [schemaSet: mySchemaset]
}
NetworkData createNetworkData() {
return NetworkData.builder().dataspace(myDataspace)
.schemaSet(mySchemaset).anchor(myAnchor).payload('{"message" : "Hello World"}')
.observedTimestamp(OffsetDateTime.now())
.createdTimestamp(OffsetDateTime.now()).build()
}
AnchorDetails toAnchorDetails(NetworkData networkData) {
AnchorDetails anchorDetails = new AnchorDetails()
anchorDetails.setDataspace(networkData.getDataspace())
anchorDetails.setAnchor(networkData.getAnchor())
anchorDetails.setSchemaSet(networkData.getSchemaSet())
anchorDetails.setObservedTimestamp(DateTimeUtility.toString(networkData.getObservedTimestamp()))
anchorDetails.setData(networkData.getPayload())
return anchorDetails
}
}
|
