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