396a40639a8b2329c8c7aad186f7833258e7348a
[ccsdk/oran.git] /
1 /*-
2  * ========================LICENSE_START=================================
3  * ONAP : ccsdk oran
4  * ======================================================================
5  * Copyright (C) 2020 Nordix Foundation. All rights reserved.
6  * ======================================================================
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  *      http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  * ========================LICENSE_END===================================
19  */
20
21 package org.onap.ccsdk.oran.a1policymanagementservice.tasks;
22
23 import static org.assertj.core.api.Assertions.assertThat;
24 import static org.mockito.ArgumentMatchers.any;
25 import static org.mockito.Mockito.doReturn;
26 import static org.mockito.Mockito.spy;
27 import static org.mockito.Mockito.verify;
28 import static org.mockito.Mockito.verifyNoMoreInteractions;
29 import static org.mockito.Mockito.when;
30
31 import java.time.Instant;
32 import java.util.ArrayList;
33 import java.util.Arrays;
34 import java.util.Collections;
35 import java.util.List;
36 import java.util.Vector;
37
38 import org.junit.jupiter.api.AfterEach;
39 import org.junit.jupiter.api.BeforeEach;
40 import org.junit.jupiter.api.Test;
41 import org.junit.jupiter.api.extension.ExtendWith;
42 import org.mockito.Mock;
43 import org.mockito.junit.jupiter.MockitoExtension;
44 import org.onap.ccsdk.oran.a1policymanagementservice.clients.A1Client;
45 import org.onap.ccsdk.oran.a1policymanagementservice.clients.A1ClientFactory;
46 import org.onap.ccsdk.oran.a1policymanagementservice.clients.SecurityContext;
47 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfig;
48 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.RicConfig;
49 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Lock;
50 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Lock.LockType;
51 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policies;
52 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policy;
53 import org.onap.ccsdk.oran.a1policymanagementservice.repository.PolicyType;
54 import org.onap.ccsdk.oran.a1policymanagementservice.repository.PolicyTypes;
55 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Ric;
56 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Ric.RicState;
57 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Rics;
58 import reactor.core.publisher.Mono;
59
60 @ExtendWith(MockitoExtension.class)
61 class RicSupervisionTest {
62     private static final String POLICY_TYPE_1_NAME = "type1";
63     private static final PolicyType POLICY_TYPE_1 = PolicyType.builder() //
64             .id(POLICY_TYPE_1_NAME) //
65             .schema("") //
66             .build();
67
68     private static final Ric RIC_1 = new Ric(RicConfig.builder() //
69             .ricId("ric_1") //
70             .baseUrl("baseUrl1") //
71             .managedElementIds(new Vector<String>(Arrays.asList("kista_1", "kista_2"))) //
72             .controllerName("controllerName") //
73             .build());
74
75     private static final String POLICY_1_ID = "policyId1";
76     private static final Policy POLICY_1 = Policy.builder() //
77             .id(POLICY_1_ID) //
78             .json("") //
79             .ownerServiceId("service") //
80             .ric(RIC_1) //
81             .type(POLICY_TYPE_1) //
82             .lastModified(Instant.now()) //
83             .isTransient(false) //
84             .statusNotificationUri("statusNotificationUri") //
85             .build();
86
87     private static final Policy POLICY_2 = Policy.builder() //
88             .id("policyId2") //
89             .json("") //
90             .ownerServiceId("service") //
91             .ric(RIC_1) //
92             .type(POLICY_TYPE_1) //
93             .lastModified(Instant.now()) //
94             .isTransient(false) //
95             .statusNotificationUri("statusNotificationUri") //
96             .build();
97
98     @Mock
99     private A1Client a1ClientMock;
100
101     @Mock
102     private A1ClientFactory a1ClientFactory;
103
104     @Mock
105     private RicSynchronizationTask synchronizationTaskMock;
106
107     private final ApplicationConfig appConfig = new ApplicationConfig();
108
109     private PolicyTypes types;
110     private Policies policies;
111     private Rics rics = new Rics();
112
113     @BeforeEach
114     void init() {
115         types = new PolicyTypes(appConfig);
116         policies = new Policies(appConfig);
117
118         rics.clear();
119         RIC_1.setState(RicState.UNAVAILABLE);
120         RIC_1.clearSupportedPolicyTypes();
121     }
122
123     @AfterEach
124     void verifyNoRicLocks() {
125         for (Ric ric : this.rics.getRics()) {
126             Lock.Grant grant = ric.getLock().lockBlocking(LockType.EXCLUSIVE, "");
127             grant.unlockBlocking();
128             assertThat(ric.getLock().getLockCounter()).isZero();
129         }
130     }
131
132     @Test
133     void whenRicIdleAndNoChangedPoliciesOrPolicyTypes_thenNoSynchronization() {
134         doReturn(Mono.just(a1ClientMock)).when(a1ClientFactory).createA1Client(any(Ric.class));
135         RIC_1.setState(RicState.AVAILABLE);
136         RIC_1.addSupportedPolicyType(POLICY_TYPE_1);
137         rics.put(RIC_1);
138
139         types.put(POLICY_TYPE_1);
140
141         policies.put(POLICY_1);
142
143         setUpGetPolicyIdentitiesToReturn(new ArrayList<>(Arrays.asList(POLICY_1_ID)));
144         setUpGetPolicyTypeIdentitiesToReturn(new ArrayList<>(Arrays.asList(POLICY_TYPE_1_NAME)));
145
146         RicSupervision supervisorUnderTest = spy(createRicSupervision());
147
148         supervisorUnderTest.checkAllRics();
149
150         verify(supervisorUnderTest).checkAllRics();
151         verifyNoMoreInteractions(supervisorUnderTest);
152         assertThat(RIC_1.getState()).isEqualTo(RicState.AVAILABLE);
153     }
154
155     @Test
156     void whenRicUndefined_thenSynchronization() {
157         doReturn(Mono.just(a1ClientMock)).when(a1ClientFactory).createA1Client(any(Ric.class));
158         RIC_1.setState(RicState.UNAVAILABLE);
159         rics.put(RIC_1);
160         RicSupervision supervisorUnderTest = spy(createRicSupervision());
161         doReturn(synchronizationTaskMock).when(supervisorUnderTest).createSynchronizationTask();
162         doReturn(Mono.just(RIC_1)).when(synchronizationTaskMock).synchronizeRic(any());
163         supervisorUnderTest.checkAllRics();
164         verify(supervisorUnderTest).checkAllRics();
165         verify(supervisorUnderTest).createSynchronizationTask();
166         verify(synchronizationTaskMock).synchronizeRic(RIC_1);
167         verifyNoMoreInteractions(supervisorUnderTest);
168         assertThat(RIC_1.getState()).isEqualTo(RicState.UNAVAILABLE);
169     }
170
171     @Test
172     void whenRicSynchronizing_thenNoSynchronization() {
173         doReturn(Mono.just(a1ClientMock)).when(a1ClientFactory).createA1Client(any(Ric.class));
174         RIC_1.setState(RicState.SYNCHRONIZING);
175         rics.put(RIC_1);
176
177         RicSupervision supervisorUnderTest = spy(createRicSupervision());
178
179         supervisorUnderTest.checkAllRics();
180
181         verify(supervisorUnderTest).checkAllRics();
182         verifyNoMoreInteractions(supervisorUnderTest);
183         assertThat(RIC_1.getState()).isEqualTo(RicState.SYNCHRONIZING);
184     }
185
186     @Test
187     void whenRicIdleAndErrorGettingPolicyIdentities_thenNoSynchronization() {
188         doReturn(Mono.just(a1ClientMock)).when(a1ClientFactory).createA1Client(any(Ric.class));
189         RIC_1.setState(RicState.AVAILABLE);
190         RIC_1.addSupportedPolicyType(POLICY_TYPE_1);
191         rics.put(RIC_1);
192
193         setUpGetPolicyIdentitiesToReturn(new Exception("Failed"));
194
195         RicSupervision supervisorUnderTest = spy(createRicSupervision());
196         supervisorUnderTest.checkAllRics();
197
198         verify(supervisorUnderTest).checkAllRics();
199         verifyNoMoreInteractions(supervisorUnderTest);
200         assertThat(RIC_1.getState()).isEqualTo(RicState.UNAVAILABLE);
201     }
202
203     @Test
204     void whenRicIdleAndNotSameAmountOfPolicies_thenSynchronization() {
205         doReturn(Mono.just(a1ClientMock)).when(a1ClientFactory).createA1Client(any(Ric.class));
206         RIC_1.setState(RicState.AVAILABLE);
207         rics.put(RIC_1);
208
209         policies.put(POLICY_1);
210         policies.put(POLICY_2);
211
212         setUpGetPolicyIdentitiesToReturn(new ArrayList<>(Arrays.asList(POLICY_1_ID)));
213
214         RicSupervision supervisorUnderTest = spy(createRicSupervision());
215
216         doReturn(synchronizationTaskMock).when(supervisorUnderTest).createSynchronizationTask();
217
218         supervisorUnderTest.checkAllRics();
219
220         verify(supervisorUnderTest).checkAllRics();
221         verify(supervisorUnderTest).createSynchronizationTask();
222         verify(synchronizationTaskMock).synchronizeRic(RIC_1);
223         verifyNoMoreInteractions(supervisorUnderTest);
224         assertThat(RIC_1.getState()).isEqualTo(RicState.UNAVAILABLE);
225     }
226
227     @Test
228     void whenRicIdleAndSameAmountOfPoliciesButNotSamePolicies_thenSynchronization() {
229         doReturn(Mono.just(a1ClientMock)).when(a1ClientFactory).createA1Client(any(Ric.class));
230         RIC_1.setState(RicState.AVAILABLE);
231         rics.put(RIC_1);
232
233         policies.put(POLICY_1);
234         policies.put(POLICY_2);
235
236         setUpGetPolicyIdentitiesToReturn(new ArrayList<>(Arrays.asList(POLICY_1_ID, "Another_policy")));
237
238         RicSupervision supervisorUnderTest = spy(createRicSupervision());
239
240         doReturn(synchronizationTaskMock).when(supervisorUnderTest).createSynchronizationTask();
241
242         supervisorUnderTest.checkAllRics();
243
244         verify(supervisorUnderTest).checkAllRics();
245         verify(supervisorUnderTest).createSynchronizationTask();
246         verify(synchronizationTaskMock).synchronizeRic(RIC_1);
247         verifyNoMoreInteractions(supervisorUnderTest);
248         assertThat(RIC_1.getState()).isEqualTo(RicState.UNAVAILABLE);
249
250     }
251
252     @Test
253     void whenRicIdleAndErrorGettingPolicyTypes_thenNoSynchronization() {
254         doReturn(Mono.just(a1ClientMock)).when(a1ClientFactory).createA1Client(any(Ric.class));
255         RIC_1.setState(RicState.AVAILABLE);
256         RIC_1.addSupportedPolicyType(POLICY_TYPE_1);
257         rics.put(RIC_1);
258
259         setUpGetPolicyIdentitiesToReturn(Collections.emptyList());
260         setUpGetPolicyTypeIdentitiesToReturn(new Exception("Failed"));
261
262         RicSupervision supervisorUnderTest = spy(createRicSupervision());
263         supervisorUnderTest.checkAllRics();
264
265         verify(supervisorUnderTest).checkAllRics();
266         verifyNoMoreInteractions(supervisorUnderTest);
267         assertThat(RIC_1.getState()).isEqualTo(RicState.UNAVAILABLE);
268     }
269
270     @Test
271     void whenRicIdleAndNotSameAmountOfPolicyTypes_thenSynchronization() {
272         doReturn(Mono.just(a1ClientMock)).when(a1ClientFactory).createA1Client(any(Ric.class));
273         RIC_1.setState(RicState.AVAILABLE);
274         RIC_1.addSupportedPolicyType(POLICY_TYPE_1);
275         rics.put(RIC_1);
276
277         types.put(POLICY_TYPE_1);
278
279         setUpGetPolicyIdentitiesToReturn(Collections.emptyList());
280         setUpGetPolicyTypeIdentitiesToReturn(new ArrayList<>(Arrays.asList(POLICY_TYPE_1_NAME, "another_policy_type")));
281
282         RicSupervision supervisorUnderTest = spy(createRicSupervision());
283
284         doReturn(synchronizationTaskMock).when(supervisorUnderTest).createSynchronizationTask();
285
286         supervisorUnderTest.checkAllRics();
287
288         verify(supervisorUnderTest).checkAllRics();
289         verify(supervisorUnderTest).createSynchronizationTask();
290         verify(synchronizationTaskMock).synchronizeRic(RIC_1);
291         verifyNoMoreInteractions(supervisorUnderTest);
292         assertThat(RIC_1.getState()).isEqualTo(RicState.UNAVAILABLE);
293     }
294
295     @Test
296     void whenRicIdleAndSameAmountOfPolicyTypesButNotSameTypes_thenSynchronization() {
297         doReturn(Mono.just(a1ClientMock)).when(a1ClientFactory).createA1Client(any(Ric.class));
298         PolicyType policyType2 = PolicyType.builder() //
299                 .id("policyType2") //
300                 .schema("") //
301                 .build();
302
303         RIC_1.setState(RicState.AVAILABLE);
304         RIC_1.addSupportedPolicyType(POLICY_TYPE_1);
305         RIC_1.addSupportedPolicyType(policyType2);
306         rics.put(RIC_1);
307
308         setUpGetPolicyIdentitiesToReturn(Collections.emptyList());
309         setUpGetPolicyTypeIdentitiesToReturn(new ArrayList<>(Arrays.asList(POLICY_TYPE_1_NAME, "another_policy_type")));
310
311         RicSupervision supervisorUnderTest = spy(createRicSupervision());
312
313         doReturn(synchronizationTaskMock).when(supervisorUnderTest).createSynchronizationTask();
314
315         supervisorUnderTest.checkAllRics();
316
317         verify(supervisorUnderTest).checkAllRics();
318         verify(supervisorUnderTest).createSynchronizationTask();
319         verify(synchronizationTaskMock).synchronizeRic(RIC_1);
320         verifyNoMoreInteractions(supervisorUnderTest);
321         assertThat(RIC_1.getState()).isEqualTo(RicState.UNAVAILABLE);
322     }
323
324     @SuppressWarnings("unchecked")
325     private void setUpGetPolicyIdentitiesToReturn(Object returnValue) {
326         if (returnValue instanceof List<?>) {
327             when(a1ClientMock.getPolicyIdentities()).thenReturn(Mono.just((List<String>) returnValue));
328         } else if (returnValue instanceof Exception) {
329             when(a1ClientMock.getPolicyIdentities()).thenReturn(Mono.error((Exception) returnValue));
330         }
331     }
332
333     @SuppressWarnings("unchecked")
334     private void setUpGetPolicyTypeIdentitiesToReturn(Object returnValue) {
335         if (returnValue instanceof List<?>) {
336             when(a1ClientMock.getPolicyTypeIdentities()).thenReturn(Mono.just((List<String>) returnValue));
337         } else if (returnValue instanceof Exception) {
338             when(a1ClientMock.getPolicyTypeIdentities()).thenReturn(Mono.error((Exception) returnValue));
339         }
340     }
341
342     private RicSupervision createRicSupervision() {
343         ApplicationConfig config = new ApplicationConfig();
344         return new RicSupervision(rics, policies, a1ClientFactory, types, null, config, new SecurityContext(""));
345     }
346 }