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
|
/*
* Copyright 2016-2017, Nokia Corporation
*
* 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.
*/
package org.onap.vfc.nfvo.driver.vnfm.svnfm.nokia.vnfm;
import com.google.common.collect.Lists;
import com.nokia.cbam.lcn.v32.model.CreateSubscriptionRequest;
import com.nokia.cbam.lcn.v32.model.Subscription;
import com.nokia.cbam.lcn.v32.model.SubscriptionAuthentication;
import com.nokia.cbam.lcn.v32.model.VnfNotificationType;
import io.reactivex.Observable;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.UUID;
import org.junit.Before;
import org.junit.Test;
import org.mockito.*;
import org.mockito.invocation.InvocationOnMock;
import org.mockito.stubbing.Answer;
import org.onap.msb.model.MicroServiceFullInfo;
import org.onap.msb.model.MicroServiceInfo;
import org.onap.msb.model.Node;
import org.onap.vfc.nfvo.driver.vnfm.svnfm.nokia.onap.core.SelfRegistrationManager;
import org.onap.vfc.nfvo.driver.vnfm.svnfm.nokia.util.TestUtil;
import static com.nokia.cbam.lcn.v32.model.OperationType.*;
import static junit.framework.TestCase.*;
import static org.mockito.Matchers.any;
import static org.mockito.Mockito.*;
import static org.onap.msb.model.MicroServiceInfo.ProtocolEnum.REST;
import static org.onap.msb.model.MicroServiceInfo.VisualRangeEnum._1;
import static org.onap.vfc.nfvo.driver.vnfm.svnfm.nokia.vnfm.CbamRestApiProvider.NOKIA_LCN_API_VERSION;
import static org.springframework.test.util.ReflectionTestUtils.setField;
public class TestSelfRegistrationManager extends TestBase {
@Mock
private JobManager jobManager;
private java.util.List<Subscription> subscriptions = new ArrayList<>();
private ArgumentCaptor<MicroServiceInfo> registeredMicroservice = ArgumentCaptor.forClass(MicroServiceInfo.class);
private ArgumentCaptor<CreateSubscriptionRequest> subscriptionToCreate = ArgumentCaptor.forClass(CreateSubscriptionRequest.class);
@InjectMocks
private SelfRegistrationManager selfRegistrationManager;
@Before
public void initMocks() throws Exception {
setField(SelfRegistrationManager.class, "logger", logger);
when(lcnApi.subscriptionsGet(NOKIA_LCN_API_VERSION)).thenReturn(buildObservable(subscriptions));
when(driverProperties.getVnfmId()).thenReturn(VNFM_ID);
setField(selfRegistrationManager, "driverMsbExternalIp", "1.2.3.4");
setField(selfRegistrationManager, "driverVnfmExternalIp", "5.6.7.8");
setField(selfRegistrationManager, "driverPort", "12345");
Subscription unknownSubscription = new Subscription();
unknownSubscription.setId(UUID.randomUUID().toString());
unknownSubscription.setCallbackUrl("unknown");
subscriptions.add(unknownSubscription);
}
/**
* test the basic registration process
* - first subscribe to CBAM LCNs
* - second publish it's existence on MSB
*/
@Test
public void testRegistration() throws Exception {
//given
Subscription subscription = new Subscription();
when(lcnApi.subscriptionsPost(subscriptionToCreate.capture(), Mockito.eq(NOKIA_LCN_API_VERSION))).thenReturn(buildObservable(subscription));
MicroServiceFullInfo returnedMicroService = new MicroServiceFullInfo();
when(msbClient.addMicroService(registeredMicroservice.capture(), eq(true), eq(false))).thenReturn(buildObservable(returnedMicroService));
//when
selfRegistrationManager.register();
//verify
InOrder registrationOrder = Mockito.inOrder(lcnApi, msbClient);
registrationOrder.verify(lcnApi).subscriptionsPost(any(), any());
registrationOrder.verify(msbClient).addMicroService(any(), any(), any());
assertMicroserviceRegistered();
assertNewLcnSubscription();
assertServiceUp();
}
private void assertNewLcnSubscription() {
CreateSubscriptionRequest subscriptionCreation = subscriptionToCreate.getValue();
assertEquals("http://5.6.7.8:12345/api/NokiaSVNFM/v1/lcn", subscriptionCreation.getCallbackUrl());
assertEquals(SubscriptionAuthentication.TypeEnum.NONE, subscriptionCreation.getAuthentication().getType());
assertNull(subscriptionCreation.getAuthentication().getUserName());
assertNull(subscriptionCreation.getAuthentication().getClientName());
assertNull(subscriptionCreation.getAuthentication().getClientPassword());
assertNull(subscriptionCreation.getAuthentication().getPassword());
assertNull(subscriptionCreation.getAuthentication().getTokenUrl());
assertNull(subscriptionCreation.getFilter().getVnfdId());
assertNull(subscriptionCreation.getFilter().getVnfInstanceId());
assertNull(subscriptionCreation.getFilter().getVnfProductName());
assertNull(subscriptionCreation.getFilter().getVnfSoftwareVersion());
assertEquals(Lists.newArrayList(VnfNotificationType.VNFLIFECYCLECHANGENOTIFICATION), subscriptionCreation.getFilter().getNotificationTypes());
assertTrue(subscriptionCreation.getFilter().getOperationTypes().contains(HEAL));
assertTrue(subscriptionCreation.getFilter().getOperationTypes().contains(SCALE));
assertTrue(subscriptionCreation.getFilter().getOperationTypes().contains(TERMINATE));
assertTrue(subscriptionCreation.getFilter().getOperationTypes().contains(INSTANTIATE));
assertEquals(4, subscriptionCreation.getFilter().getOperationTypes().size());
verify(logger).info("Subscribing to CBAM LCN {} with callback to {}", driverProperties.getCbamLcnUrl(), "http://5.6.7.8:12345/api/NokiaSVNFM/v1/lcn");
}
private void assertMicroserviceRegistered() {
MicroServiceInfo microserviceRequest = registeredMicroservice.getValue();
assertEquals(1, microserviceRequest.getNodes().size());
Node node = microserviceRequest.getNodes().iterator().next();
assertEquals("0", node.getTtl());
assertEquals("1.2.3.4", node.getIp());
assertEquals("12345", node.getPort());
assertEquals(REST, microserviceRequest.getProtocol());
assertNull(microserviceRequest.getMetadata());
//very strange, but it should be null for ONAP to work
assertEquals(SelfRegistrationManager.SERVICE_NAME, microserviceRequest.getServiceName());
assertEquals("/api/NokiaSVNFM/v1", microserviceRequest.getUrl());
assertEquals("v1", microserviceRequest.getVersion());
assertEquals(Boolean.FALSE, microserviceRequest.isEnableSsl());
//1 means internal service to ONAP
assertEquals(_1, microserviceRequest.getVisualRange());
}
/**
* If the subscription already exists the subscription is not recreated
*/
@Test
public void testResubscription() throws Exception {
//given
MicroServiceFullInfo returnedMicroService = new MicroServiceFullInfo();
when(msbClient.addMicroService(registeredMicroservice.capture(), eq(true), eq(false))).thenReturn(buildObservable(returnedMicroService));
Subscription existingSubscription = new Subscription();
existingSubscription.setId(UUID.randomUUID().toString());
existingSubscription.setCallbackUrl("http://5.6.7.8:12345/api/NokiaSVNFM/v1/lcn");
subscriptions.add(existingSubscription);
//when
selfRegistrationManager.register();
//verify
assertMicroserviceRegistered();
verify(lcnApi, never()).subscriptionsPost(any(), any());
assertServiceUp();
}
/**
* If the LCN subscription fails the microservice is not registered
*/
@Test
public void testFailedLcnSubscription() throws Exception {
//given
RuntimeException expectedException = new RuntimeException();
when(lcnApi.subscriptionsPost(any(), any())).thenThrow(expectedException);
//when
try {
selfRegistrationManager.register();
fail();
} catch (RuntimeException e) {
assertEquals(expectedException, e.getCause());
}
//verify
verify(msbClient, never()).addMicroService(any(), any(), any());
verify(logger).error("Unable to subscribe to CBAM LCN", expectedException);
assertServiceDown();
}
/**
* If the registration to MSB fails the subscription is deleted
*/
@Test
public void testFailedMsbPublish() throws Exception {
//given
Subscription subscription = new Subscription();
when(lcnApi.subscriptionsPost(subscriptionToCreate.capture(), Mockito.eq(NOKIA_LCN_API_VERSION))).thenAnswer(invocationOnMock -> {
subscription.setCallbackUrl("http://5.6.7.8:12345/api/NokiaSVNFM/v1/lcn");
subscription.setId(UUID.randomUUID().toString());
subscriptions.add(subscription);
return buildObservable(subscription);
});
MicroServiceFullInfo returnedMicroService = new MicroServiceFullInfo();
RuntimeException expectedException = new RuntimeException();
when(msbClient.addMicroService(registeredMicroservice.capture(), eq(true), eq(false))).thenThrow(expectedException);
//when
try {
selfRegistrationManager.register();
//verify
fail();
} catch (RuntimeException e) {
assertEquals(expectedException, e.getCause());
}
assertNewLcnSubscription();
verify(lcnApi).subscriptionsSubscriptionIdDelete(subscription.getId(), NOKIA_LCN_API_VERSION);
assertServiceDown();
}
/**
* basic service unregistration
* - ongoing jobs are outwaited
* - first the service is removed from MSB
* - second unregistration
*/
@Test
public void testUnregistration() throws Exception {
//given
Subscription subscription = new Subscription();
subscription.setCallbackUrl("http://5.6.7.8:12345/api/NokiaSVNFM/v1/lcn");
subscription.setId(UUID.randomUUID().toString());
subscriptions.add(subscription);
when(jobManager.hasOngoingJobs()).thenReturn(false);
Observable delete = Mockito.mock(Observable.class);
when(lcnApi.subscriptionsSubscriptionIdDelete(subscription.getId(), NOKIA_LCN_API_VERSION)).thenReturn(delete);
//when
selfRegistrationManager.deRegister();
//verify
InOrder inOrder = Mockito.inOrder(jobManager, msbClient, lcnApi);
inOrder.verify(msbClient).deleteMicroService(SelfRegistrationManager.SERVICE_NAME, SelfRegistrationManager.DRIVER_VERSION, null, null);
inOrder.verify(lcnApi).subscriptionsSubscriptionIdDelete(subscription.getId(), NOKIA_LCN_API_VERSION);
assertServiceDown();
verify(systemFunctions).blockingFirst(delete);
verify(logger).info("Deleting subscription with {} identifier", subscription.getId());
}
/**
* if the MSB reports that it could not cancel the service, but the service has
* disappeared from MSB the cancellation is considered to be successful
*/
@Test
public void testPartiallyFailedMsbCancel() throws Exception {
//given
Subscription subscription = new Subscription();
subscription.setCallbackUrl("http://5.6.7.8:12345/api/NokiaSVNFM/v1/lcn");
subscription.setId(UUID.randomUUID().toString());
subscriptions.add(subscription);
when(jobManager.hasOngoingJobs()).thenReturn(false);
when(msbClient.deleteMicroService(SelfRegistrationManager.SERVICE_NAME, SelfRegistrationManager.DRIVER_VERSION, null, null)).then(new Answer<Observable<Void>>() {
@Override
public Observable<Void> answer(InvocationOnMock invocationOnMock) throws Throwable {
when(msbClient.getMicroService_0(SelfRegistrationManager.SERVICE_NAME, SelfRegistrationManager.DRIVER_VERSION, null, null, null, null, null)).thenThrow(new RuntimeException());
throw new RuntimeException();
}
});
MicroServiceFullInfo returnedMicroService = new MicroServiceFullInfo();
//when
selfRegistrationManager.deRegister();
//verify
InOrder inOrder = Mockito.inOrder(jobManager, msbClient, lcnApi);
inOrder.verify(msbClient).deleteMicroService(SelfRegistrationManager.SERVICE_NAME, SelfRegistrationManager.DRIVER_VERSION, null, null);
inOrder.verify(msbClient).getMicroService_0(SelfRegistrationManager.SERVICE_NAME, SelfRegistrationManager.DRIVER_VERSION, null, null, null, null, null);
inOrder.verify(lcnApi).subscriptionsSubscriptionIdDelete(subscription.getId(), NOKIA_LCN_API_VERSION);
assertServiceDown();
}
/**
* failure of unregistration from MSB should be propagated
*/
@Test
public void testUnregistrationFailure() throws Exception {
//given
Subscription subscription = new Subscription();
subscription.setCallbackUrl("http://5.6.7.8:12345/api/NokiaSVNFM/v1/lcn");
subscription.setId(UUID.randomUUID().toString());
subscriptions.add(subscription);
when(msbClient.deleteMicroService(SelfRegistrationManager.SERVICE_NAME, SelfRegistrationManager.DRIVER_VERSION, null, null)).then(new Answer<Observable<Void>>() {
@Override
public Observable<Void> answer(InvocationOnMock invocationOnMock) throws Throwable {
throw new RuntimeException();
}
});
//when
try {
selfRegistrationManager.deRegister();
fail();
} catch (RuntimeException e) {
}
//verify
InOrder inOrder = Mockito.inOrder(jobManager, msbClient, lcnApi);
inOrder.verify(msbClient).deleteMicroService(SelfRegistrationManager.SERVICE_NAME, SelfRegistrationManager.DRIVER_VERSION, null, null);
inOrder.verify(msbClient).getMicroService_0(SelfRegistrationManager.SERVICE_NAME, SelfRegistrationManager.DRIVER_VERSION, null, null, null, null, null);
verify(lcnApi, Mockito.never()).subscriptionsSubscriptionIdDelete(subscription.getId(), NOKIA_LCN_API_VERSION);
assertServiceDown();
}
/**
* failure of subscription deletion from MSB should be propagated
*/
@Test
public void testSubscriptionFailure() throws Exception {
//given
Subscription subscription = new Subscription();
subscription.setCallbackUrl("http://5.6.7.8:12345/api/NokiaSVNFM/v1/lcn");
subscription.setId(UUID.randomUUID().toString());
subscriptions.add(subscription);
when(jobManager.hasOngoingJobs()).thenReturn(false);
RuntimeException expectedException = new RuntimeException();
doThrow(expectedException).when(lcnApi).subscriptionsSubscriptionIdDelete(subscription.getId(), NOKIA_LCN_API_VERSION);
//when
try {
selfRegistrationManager.deRegister();
fail();
} catch (RuntimeException e) {
}
//verify
InOrder inOrder = Mockito.inOrder(jobManager, msbClient, lcnApi);
inOrder.verify(msbClient).deleteMicroService(SelfRegistrationManager.SERVICE_NAME, SelfRegistrationManager.DRIVER_VERSION, null, null);
inOrder.verify(lcnApi).subscriptionsSubscriptionIdDelete(subscription.getId(), NOKIA_LCN_API_VERSION);
assertServiceDown();
}
/**
* the swagger API definitions embedded in the code
*/
@Test
public void testSwaggerApi() throws Exception {
//no idea how to test this except repeat implementation
byte[] a = TestUtil.loadFile(SelfRegistrationManager.SWAGGER_API_DEFINITION);
tearGeneric();
//when
assertTrue(Arrays.equals(a, selfRegistrationManager.getSwaggerApiDefinition()));
}
public void assertServiceUp() throws Exception {
assertTrue(selfRegistrationManager.isReady());
}
/**
* if there are ongoing jobs then the guard thros exception
*/
public void assertServiceDown() {
assertFalse(selfRegistrationManager.isReady());
}
}
|