875698a879108f9dabcf21a5e2ed3a190041a537
[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
161         RicSupervision supervisorUnderTest = spy(createRicSupervision());
162
163         doReturn(synchronizationTaskMock).when(supervisorUnderTest).createSynchronizationTask();
164         doReturn(Mono.just(RIC_1)).when(synchronizationTaskMock).synchronizeRic(any());
165
166         supervisorUnderTest.checkAllRics();
167
168         verify(supervisorUnderTest).checkAllRics();
169         verify(supervisorUnderTest).createSynchronizationTask();
170         verify(synchronizationTaskMock).synchronizeRic(RIC_1);
171         verifyNoMoreInteractions(supervisorUnderTest);
172         assertThat(RIC_1.getState()).isEqualTo(RicState.UNAVAILABLE);
173     }
174
175     @Test
176     void whenRicSynchronizing_thenNoSynchronization() {
177         doReturn(Mono.just(a1ClientMock)).when(a1ClientFactory).createA1Client(any(Ric.class));
178         RIC_1.setState(RicState.SYNCHRONIZING);
179         rics.put(RIC_1);
180
181         RicSupervision supervisorUnderTest = spy(createRicSupervision());
182
183         supervisorUnderTest.checkAllRics();
184
185         verify(supervisorUnderTest).checkAllRics();
186         verifyNoMoreInteractions(supervisorUnderTest);
187         assertThat(RIC_1.getState()).isEqualTo(RicState.SYNCHRONIZING);
188     }
189
190     @Test
191     void whenRicIdleAndErrorGettingPolicyIdentities_thenNoSynchronization() {
192         doReturn(Mono.just(a1ClientMock)).when(a1ClientFactory).createA1Client(any(Ric.class));
193         RIC_1.setState(RicState.AVAILABLE);
194         RIC_1.addSupportedPolicyType(POLICY_TYPE_1);
195         rics.put(RIC_1);
196
197         setUpGetPolicyIdentitiesToReturn(new Exception("Failed"));
198
199         RicSupervision supervisorUnderTest = spy(createRicSupervision());
200         supervisorUnderTest.checkAllRics();
201
202         verify(supervisorUnderTest).checkAllRics();
203         verifyNoMoreInteractions(supervisorUnderTest);
204         assertThat(RIC_1.getState()).isEqualTo(RicState.UNAVAILABLE);
205     }
206
207     @Test
208     void whenRicIdleAndNotSameAmountOfPolicies_thenSynchronization() {
209         doReturn(Mono.just(a1ClientMock)).when(a1ClientFactory).createA1Client(any(Ric.class));
210         RIC_1.setState(RicState.AVAILABLE);
211         rics.put(RIC_1);
212
213         policies.put(POLICY_1);
214         policies.put(POLICY_2);
215
216         setUpGetPolicyIdentitiesToReturn(new ArrayList<>(Arrays.asList(POLICY_1_ID)));
217
218         RicSupervision supervisorUnderTest = spy(createRicSupervision());
219
220         doReturn(synchronizationTaskMock).when(supervisorUnderTest).createSynchronizationTask();
221
222         supervisorUnderTest.checkAllRics();
223
224         verify(supervisorUnderTest).checkAllRics();
225         verify(supervisorUnderTest).createSynchronizationTask();
226         verify(synchronizationTaskMock).synchronizeRic(RIC_1);
227         verifyNoMoreInteractions(supervisorUnderTest);
228         assertThat(RIC_1.getState()).isEqualTo(RicState.UNAVAILABLE);
229     }
230
231     @Test
232     void whenRicIdleAndSameAmountOfPoliciesButNotSamePolicies_thenSynchronization() {
233         doReturn(Mono.just(a1ClientMock)).when(a1ClientFactory).createA1Client(any(Ric.class));
234         RIC_1.setState(RicState.AVAILABLE);
235         rics.put(RIC_1);
236
237         policies.put(POLICY_1);
238         policies.put(POLICY_2);
239
240         setUpGetPolicyIdentitiesToReturn(new ArrayList<>(Arrays.asList(POLICY_1_ID, "Another_policy")));
241
242         RicSupervision supervisorUnderTest = spy(createRicSupervision());
243
244         doReturn(synchronizationTaskMock).when(supervisorUnderTest).createSynchronizationTask();
245
246         supervisorUnderTest.checkAllRics();
247
248         verify(supervisorUnderTest).checkAllRics();
249         verify(supervisorUnderTest).createSynchronizationTask();
250         verify(synchronizationTaskMock).synchronizeRic(RIC_1);
251         verifyNoMoreInteractions(supervisorUnderTest);
252         assertThat(RIC_1.getState()).isEqualTo(RicState.UNAVAILABLE);
253
254     }
255
256     @Test
257     void whenRicIdleAndErrorGettingPolicyTypes_thenNoSynchronization() {
258         doReturn(Mono.just(a1ClientMock)).when(a1ClientFactory).createA1Client(any(Ric.class));
259         RIC_1.setState(RicState.AVAILABLE);
260         RIC_1.addSupportedPolicyType(POLICY_TYPE_1);
261         rics.put(RIC_1);
262
263         setUpGetPolicyIdentitiesToReturn(Collections.emptyList());
264         setUpGetPolicyTypeIdentitiesToReturn(new Exception("Failed"));
265
266         RicSupervision supervisorUnderTest = spy(createRicSupervision());
267         supervisorUnderTest.checkAllRics();
268
269         verify(supervisorUnderTest).checkAllRics();
270         verifyNoMoreInteractions(supervisorUnderTest);
271         assertThat(RIC_1.getState()).isEqualTo(RicState.UNAVAILABLE);
272     }
273
274     @Test
275     void whenRicIdleAndNotSameAmountOfPolicyTypes_thenSynchronization() {
276         doReturn(Mono.just(a1ClientMock)).when(a1ClientFactory).createA1Client(any(Ric.class));
277         RIC_1.setState(RicState.AVAILABLE);
278         RIC_1.addSupportedPolicyType(POLICY_TYPE_1);
279         rics.put(RIC_1);
280
281         types.put(POLICY_TYPE_1);
282
283         setUpGetPolicyIdentitiesToReturn(Collections.emptyList());
284         setUpGetPolicyTypeIdentitiesToReturn(new ArrayList<>(Arrays.asList(POLICY_TYPE_1_NAME, "another_policy_type")));
285
286         RicSupervision supervisorUnderTest = spy(createRicSupervision());
287
288         doReturn(synchronizationTaskMock).when(supervisorUnderTest).createSynchronizationTask();
289
290         supervisorUnderTest.checkAllRics();
291
292         verify(supervisorUnderTest).checkAllRics();
293         verify(supervisorUnderTest).createSynchronizationTask();
294         verify(synchronizationTaskMock).synchronizeRic(RIC_1);
295         verifyNoMoreInteractions(supervisorUnderTest);
296         assertThat(RIC_1.getState()).isEqualTo(RicState.UNAVAILABLE);
297     }
298
299     @Test
300     void whenRicIdleAndSameAmountOfPolicyTypesButNotSameTypes_thenSynchronization() {
301         doReturn(Mono.just(a1ClientMock)).when(a1ClientFactory).createA1Client(any(Ric.class));
302         PolicyType policyType2 = PolicyType.builder() //
303                 .id("policyType2") //
304                 .schema("") //
305                 .build();
306
307         RIC_1.setState(RicState.AVAILABLE);
308         RIC_1.addSupportedPolicyType(POLICY_TYPE_1);
309         RIC_1.addSupportedPolicyType(policyType2);
310         rics.put(RIC_1);
311
312         setUpGetPolicyIdentitiesToReturn(Collections.emptyList());
313         setUpGetPolicyTypeIdentitiesToReturn(new ArrayList<>(Arrays.asList(POLICY_TYPE_1_NAME, "another_policy_type")));
314
315         RicSupervision supervisorUnderTest = spy(createRicSupervision());
316
317         doReturn(synchronizationTaskMock).when(supervisorUnderTest).createSynchronizationTask();
318
319         supervisorUnderTest.checkAllRics();
320
321         verify(supervisorUnderTest).checkAllRics();
322         verify(supervisorUnderTest).createSynchronizationTask();
323         verify(synchronizationTaskMock).synchronizeRic(RIC_1);
324         verifyNoMoreInteractions(supervisorUnderTest);
325         assertThat(RIC_1.getState()).isEqualTo(RicState.UNAVAILABLE);
326     }
327
328     @SuppressWarnings("unchecked")
329     private void setUpGetPolicyIdentitiesToReturn(Object returnValue) {
330         if (returnValue instanceof List<?>) {
331             when(a1ClientMock.getPolicyIdentities()).thenReturn(Mono.just((List<String>) returnValue));
332         } else if (returnValue instanceof Exception) {
333             when(a1ClientMock.getPolicyIdentities()).thenReturn(Mono.error((Exception) returnValue));
334         }
335     }
336
337     @SuppressWarnings("unchecked")
338     private void setUpGetPolicyTypeIdentitiesToReturn(Object returnValue) {
339         if (returnValue instanceof List<?>) {
340             when(a1ClientMock.getPolicyTypeIdentities()).thenReturn(Mono.just((List<String>) returnValue));
341         } else if (returnValue instanceof Exception) {
342             when(a1ClientMock.getPolicyTypeIdentities()).thenReturn(Mono.error((Exception) returnValue));
343         }
344     }
345
346     private RicSupervision createRicSupervision() {
347         ApplicationConfig config = new ApplicationConfig();
348         return new RicSupervision(rics, policies, a1ClientFactory, types, null, config, new SecurityContext(""));
349     }
350 }