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
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
|
/*-
* ============LICENSE_START=======================================================
* openECOMP : SDN-C
* ================================================================================
* Copyright (C) 2017 AT&T Intellectual Property. 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.
* ============LICENSE_END=========================================================
*/
package org.onap.sdnc.northbound;
import static org.junit.Assert.assertEquals;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
import static org.onap.sdnc.northbound.GenericResourceApiProvider.APP_NAME;
import static org.onap.sdnc.northbound.GenericResourceApiProvider.NO_SERVICE_LOGIC_ACTIVE;
import static org.onap.sdnc.northbound.GenericResourceApiProvider.NULL_OR_EMPTY_ERROR_PARAM;
import static org.onap.sdnc.northbound.util.MDSALUtil.build;
import static org.onap.sdnc.northbound.util.MDSALUtil.exec;
import static org.onap.sdnc.northbound.util.MDSALUtil.requestInformation;
import static org.onap.sdnc.northbound.util.MDSALUtil.sdncRequestHeader;
import static org.onap.sdnc.northbound.util.MDSALUtil.service;
import static org.onap.sdnc.northbound.util.MDSALUtil.serviceData;
import static org.onap.sdnc.northbound.util.MDSALUtil.serviceInformationBuilder;
import static org.onap.sdnc.northbound.util.MDSALUtil.serviceResponseInformation;
import static org.onap.sdnc.northbound.util.MDSALUtil.serviceStatus;
import static org.onap.sdnc.northbound.util.MDSALUtil.serviceTopologyOperationInput;
import static org.onap.sdnc.northbound.util.MDSALUtil.serviceTopologyOperationOutput;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mockito;
import org.mockito.runners.MockitoJUnitRunner;
import org.onap.sdnc.northbound.util.PropBuilder;
import org.opendaylight.mdsal.binding.api.DataBroker;
import org.opendaylight.mdsal.binding.api.TransactionChainClosedException;
import org.opendaylight.mdsal.binding.api.WriteTransaction;
import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.ServiceTopologyOperationInput;
import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.ServiceTopologyOperationOutput;
import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.request.information.RequestInformation;
import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.sdnc.request.header.SdncRequestHeader;
import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.sdnc.request.header.SdncRequestHeader.SvcAction;
import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.service.information.ServiceInformation;
import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.service.model.infrastructure.Service;
import org.opendaylight.yang.gen.v1.org.onap.sdnc.northbound.generic.resource.rev170824.service.status.ServiceStatus;
import org.opendaylight.yangtools.yang.common.RpcResult;
/**
* This class test the ServiceTopologyOperation mdsal RPC.
*/
@RunWith(MockitoJUnitRunner.class)
public class ServiceTopologyOperationRPCTest extends GenericResourceApiProviderTest {
final String SVC_OPERATION = "service-topology-operation";
@Before
public void setUp() throws Exception {
super.setUp();
svcClient.setScvOperation(SVC_OPERATION);
}
/**
* Verify ServiceTopologyOperation RPC executes a DG then produces the expected {@link
* ServiceTopologyOperationOutput} and persisted the expected {@link Service} in the {@link DataBroker}
*/
@Test
public void testServiceTopologyOperationRPC_ExecuteDG_Success() throws Exception {
//mock svcClient to perform a successful execution with the expected parameters
svcClient.mockHasGraph(true);
PropBuilder svcResultProp = svcClient.createExecuteOKResult();
svcClient.mockExecute(svcResultProp);
// create the ServiceTopologyOperationInput from the template
ServiceTopologyOperationInput input = createSTOI();
//execute the mdsal exec
ServiceTopologyOperationOutput output = exec(
genericResourceApiProvider::serviceTopologyOperation
, input
, RpcResult::getResult
);
assertEquals("200", output.getResponseCode());
assertEquals("OK", output.getResponseMessage());
assertEquals("Y", output.getAckFinalIndicator());
//verify the returned ServiceTopologyOperationOutput
ServiceTopologyOperationOutput expectedServiceTopologyOperationOutput = createExpectedSTOO(svcResultProp,
input);
assertEquals(expectedServiceTopologyOperationOutput, output);
//verify the persisted Service
Service actualService = db.read(input.getServiceInformation().getServiceInstanceId(),
LogicalDatastoreType.CONFIGURATION);
Service expectedService = createExpectedService(
expectedServiceTopologyOperationOutput,
input,
actualService);
assertEquals(expectedService, actualService);
LOG.debug("done");
}
@Test
public void should_fail_when_service_info_not_present() throws Exception {
// create the ServiceTopologyOperationInput from the template
ServiceTopologyOperationInput input = build(
serviceTopologyOperationInput()
.setSdncRequestHeader(build(sdncRequestHeader()
.setSvcRequestId("svc-request-id: xyz")
.setSvcAction(SvcAction.Assign)
))
.setRequestInformation(build(requestInformation()
.setRequestId("request-id: xyz")
.setRequestAction(RequestInformation.RequestAction.CreateServiceInstance)
)));
//execute the mdsal exec
ServiceTopologyOperationOutput output = exec(
genericResourceApiProvider::serviceTopologyOperation
, input
, RpcResult::getResult
);
assertEquals("404", output.getResponseCode());
assertEquals(NULL_OR_EMPTY_ERROR_PARAM, output.getResponseMessage());
assertEquals("Y", output.getAckFinalIndicator());
}
@Test
public void should_fail_when_client_execution_failed() throws Exception {
svcClient.mockHasGraph(true);
svcClient.mockExecute(new RuntimeException("test exception"));
ServiceTopologyOperationInput input = createSTOI();
//execute the mdsal exec
ServiceTopologyOperationOutput output = exec(
genericResourceApiProvider::serviceTopologyOperation
, input
, RpcResult::getResult
);
assertEquals("500", output.getResponseCode());
assertEquals("test exception", output.getResponseMessage());
assertEquals("Y", output.getAckFinalIndicator());
}
@Test
public void delete_fail_when_client_execution_failed() throws Exception {
//mock svcClient to perform a successful execution with the expected parameters
svcClient.mockHasGraph(true);
PropBuilder svcResultProp = svcClient.createExecuteOKResult();
svcClient.mockExecute(svcResultProp);
ServiceTopologyOperationInput input = deleteSTOI();
//execute the mdsal exec
ServiceTopologyOperationOutput output = exec(
genericResourceApiProvider::serviceTopologyOperation
, input
, RpcResult::getResult
);
assertEquals("200", output.getResponseCode());
assertEquals("OK", output.getResponseMessage());
assertEquals("Y", output.getAckFinalIndicator());
}
@Test
public void delete_service_fail_when_client_execution_failed() throws Exception {
//mock svcClient to perform a successful execution with the expected parameters
svcClient.mockHasGraph(true);
PropBuilder svcResultProp = svcClient.createExecuteOKResult();
svcClient.mockExecute(svcResultProp);
ServiceTopologyOperationInput input = deleteServiceSTOI();
//execute the mdsal exec
ServiceTopologyOperationOutput output = exec(
genericResourceApiProvider::serviceTopologyOperation
, input
, RpcResult::getResult
);
assertEquals("200", output.getResponseCode());
assertEquals("Y", output.getAckFinalIndicator());
}
@Test
public void should_fail_when_client_has_no_graph() throws Exception {
svcClient.mockHasGraph(false);
ServiceTopologyOperationInput input = createSTOI();
//execute the mdsal exec
ServiceTopologyOperationOutput output = exec(
genericResourceApiProvider::serviceTopologyOperation
, input
, RpcResult::getResult
);
assertEquals("503", output.getResponseCode());
assertEquals(NO_SERVICE_LOGIC_ACTIVE + APP_NAME + ": '" + SVC_OPERATION + "'", output.getResponseMessage());
assertEquals("Y", output.getAckFinalIndicator());
}
@Test
public void should_fail_when_failed_to_update_mdsal() throws Exception {
svcClient.mockHasGraph(true);
WriteTransaction mockWriteTransaction = mock(WriteTransaction.class);
when(mockWriteTransaction.commit()).thenThrow(new TransactionChainClosedException("test exception"));
DataBroker spyDataBroker = Mockito.spy(dataBroker);
when(spyDataBroker.newWriteOnlyTransaction()).thenReturn(mockWriteTransaction);
genericResourceApiProvider.setDataBroker(spyDataBroker);
ServiceTopologyOperationInput input = createSTOI();
//execute the mdsal exec
ServiceTopologyOperationOutput output = exec(
genericResourceApiProvider::serviceTopologyOperation
, input
, RpcResult::getResult
);
assertEquals("500", output.getResponseCode());
assertEquals("test exception", output.getResponseMessage());
assertEquals("Y", output.getAckFinalIndicator());
}
private ServiceTopologyOperationInput createSTOI() {
return build(
serviceTopologyOperationInput()
.setSdncRequestHeader(build(sdncRequestHeader()
.setSvcRequestId("svc-request-id: xyz")
.setSvcAction(SvcAction.Assign)
))
.setRequestInformation(build(requestInformation()
.setRequestId("request-id: xyz")
.setRequestAction(RequestInformation.RequestAction.CreateServiceInstance)
))
.setServiceInformation(build(serviceInformationBuilder()
.setServiceInstanceId("service-instance-id: xyz")
))
);
}
private ServiceTopologyOperationInput deleteSTOI() {
return build(
serviceTopologyOperationInput()
.setSdncRequestHeader(build(sdncRequestHeader()
.setSvcRequestId("svc-request-id: xyz")
.setSvcAction(SvcAction.Unassign)
))
.setRequestInformation(build(requestInformation()
.setRequestId("request-id: xyz")
.setRequestAction(RequestInformation.RequestAction.DeleteServiceInstance)
))
.setServiceInformation(build(serviceInformationBuilder()
.setServiceInstanceId("service-instance-id: xyz")
))
);
}
private ServiceTopologyOperationInput deleteServiceSTOI() {
return build(
serviceTopologyOperationInput()
.setSdncRequestHeader(build(sdncRequestHeader()
.setSvcRequestId("svc-request-id: xyz")
.setSvcAction(SvcAction.Delete)
))
.setRequestInformation(build(requestInformation()
.setRequestId("request-id: xyz")
.setRequestAction(RequestInformation.RequestAction.DeleteServiceInstance)
))
.setServiceInformation(build(serviceInformationBuilder()
.setServiceInstanceId("service-instance-id: xyz")
))
);
}
private ServiceTopologyOperationOutput createExpectedSTOO(PropBuilder expectedSvcResultProp,
ServiceTopologyOperationInput expectedServiceTopologyOperationInput) {
return build(
serviceTopologyOperationOutput()
.setSvcRequestId(expectedServiceTopologyOperationInput.getSdncRequestHeader().getSvcRequestId())
.setResponseCode(expectedSvcResultProp.get(svcClient.errorCode))
.setAckFinalIndicator(expectedSvcResultProp.get(svcClient.ackFinal))
.setResponseMessage(expectedSvcResultProp.get(svcClient.errorMessage))
.setServiceResponseInformation(build(serviceResponseInformation()
.setInstanceId(expectedServiceTopologyOperationInput.getServiceInformation().getServiceInstanceId())
.setObjectPath(expectedSvcResultProp.get(svcClient.serviceObjectPath))
))
);
}
private Service createExpectedService(
ServiceTopologyOperationOutput expectedServiceTopologyOperationOutput,
ServiceTopologyOperationInput expectedServiceTopologyOperationInput,
Service actualService
) {
//We cannot predict the timeStamp value so just steal it from the actual
//we need this to prevent the equals method from returning false as a result of the timestamp
String responseTimeStamp = actualService == null || actualService.getServiceStatus() == null ?
null : actualService.getServiceStatus().getResponseTimestamp();
SdncRequestHeader expectedSdncRequestHeader = expectedServiceTopologyOperationInput.getSdncRequestHeader();
ServiceInformation expectedServiceInformation = expectedServiceTopologyOperationInput.getServiceInformation();
RequestInformation expectedRequestInformation = expectedServiceTopologyOperationInput.getRequestInformation();
return build(
service()
.setServiceInstanceId(expectedServiceInformation.getServiceInstanceId())
.setServiceData(build(serviceData()))
.setServiceStatus(
build(
serviceStatus()
.setAction(expectedRequestInformation.getRequestAction().name())
.setFinalIndicator(expectedServiceTopologyOperationOutput.getAckFinalIndicator())
.setResponseCode(expectedServiceTopologyOperationOutput.getResponseCode())
.setResponseMessage(expectedServiceTopologyOperationOutput.getResponseMessage())
.setRpcAction(toRpcAction(expectedSdncRequestHeader.getSvcAction()))
.setRpcName(SVC_OPERATION)
.setRequestStatus(ServiceStatus.RequestStatus.Synccomplete)
.setResponseTimestamp(responseTimeStamp)
)
)
);
}
public ServiceStatus.RpcAction toRpcAction(SvcAction fromEnum) {
return fromEnum == null ? null : ServiceStatus.RpcAction.valueOf(fromEnum.name());
}
}
|
