d9b36d9cd22bb4f241556d79a517a5531a1ddeeb
[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 import org.junit.jupiter.api.AfterEach;
38 import org.junit.jupiter.api.BeforeEach;
39 import org.junit.jupiter.api.Test;
40 import org.junit.jupiter.api.extension.ExtendWith;
41 import org.mockito.Mock;
42 import org.mockito.junit.jupiter.MockitoExtension;
43 import org.onap.ccsdk.oran.a1policymanagementservice.clients.A1Client;
44 import org.onap.ccsdk.oran.a1policymanagementservice.clients.A1ClientFactory;
45 import org.onap.ccsdk.oran.a1policymanagementservice.clients.SecurityContext;
46 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfig;
47 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.RicConfig;
48 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Lock;
49 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Lock.LockType;
50 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policies;
51 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policy;
52 import org.onap.ccsdk.oran.a1policymanagementservice.repository.PolicyType;
53 import org.onap.ccsdk.oran.a1policymanagementservice.repository.PolicyTypes;
54 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Ric;
55 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Ric.RicState;
56 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Rics;
57 import reactor.core.publisher.Mono;
58
59 @ExtendWith(MockitoExtension.class)
60 class RicSupervisionTest {
61     private static final String POLICY_TYPE_1_NAME = "type1";
62     private static final PolicyType POLICY_TYPE_1 = PolicyType.builder() //
63             .id(POLICY_TYPE_1_NAME) //
64             .schema("") //
65             .build();
66
67     private static final Ric RIC_1 = new Ric(RicConfig.builder() //
68             .ricId("ric_1") //
69             .baseUrl("baseUrl1") //
70             .managedElementIds(new Vector<String>(Arrays.asList("kista_1", "kista_2"))) //
71             .controllerName("controllerName") //
72             .build());
73
74     private static final String POLICY_1_ID = "policyId1";
75     private static final Policy POLICY_1 = Policy.builder() //
76             .id(POLICY_1_ID) //
77             .json("") //
78             .ownerServiceId("service") //
79             .ric(RIC_1) //
80             .type(POLICY_TYPE_1) //
81             .lastModified(Instant.now()) //
82             .isTransient(false) //
83             .statusNotificationUri("statusNotificationUri") //
84             .build();
85
86     private static final Policy POLICY_2 = Policy.builder() //
87             .id("policyId2") //
88             .json("") //
89             .ownerServiceId("service") //
90             .ric(RIC_1) //
91             .type(POLICY_TYPE_1) //
92             .lastModified(Instant.now()) //
93             .isTransient(false) //
94             .statusNotificationUri("statusNotificationUri") //
95             .build();
96
97     @Mock
98     private A1Client a1ClientMock;
99
100     @Mock
101     private A1ClientFactory a1ClientFactory;
102
103     @Mock
104     private RicSynchronizationTask synchronizationTaskMock;
105
106     private final ApplicationConfig appConfig = new ApplicationConfig();
107
108     private PolicyTypes types;
109     private Policies policies;
110     private Rics rics = new Rics();
111
112     @BeforeEach
113     void init() {
114         types = new PolicyTypes(appConfig);
115         policies = new Policies(appConfig);
116
117         rics.clear();
118         RIC_1.setState(RicState.UNAVAILABLE);
119         RIC_1.clearSupportedPolicyTypes();
120     }
121
122     @AfterEach
123     void verifyNoRicLocks() {
124         for (Ric ric : this.rics.getRics()) {
125             Lock.Grant grant = ric.getLock().lockBlocking(LockType.EXCLUSIVE, "");
126             grant.unlockBlocking();
127             assertThat(ric.getLock().getLockCounter()).isZero();
128         }
129     }
130
131     @Test
132     void whenRicIdleAndNoChangedPoliciesOrPolicyTypes_thenNoSynchronization() {
133         doReturn(Mono.just(a1ClientMock)).when(a1ClientFactory).createA1Client(any(Ric.class));
134         RIC_1.setState(RicState.AVAILABLE);
135         RIC_1.addSupportedPolicyType(POLICY_TYPE_1);
136         rics.put(RIC_1);
137
138         types.put(POLICY_TYPE_1);
139
140         policies.put(POLICY_1);
141
142         setUpGetPolicyIdentitiesToReturn(new ArrayList<>(Arrays.asList(POLICY_1_ID)));
143         setUpGetPolicyTypeIdentitiesToReturn(new ArrayList<>(Arrays.asList(POLICY_TYPE_1_NAME)));
144
145         RicSupervision supervisorUnderTest = spy(createRicSupervision());
146
147         supervisorUnderTest.checkAllRics();
148
149         verify(supervisorUnderTest).checkAllRics();
150         verify(synchronizationTaskMock, times(0)).synchronizeRic(RIC_1);
151         assertThat(RIC_1.getState()).isEqualTo(RicState.AVAILABLE);
152     }
153
154     @Test
155     void whenRicUndefined_thenSynchronization() {
156         doReturn(Mono.just(a1ClientMock)).when(a1ClientFactory).createA1Client(any(Ric.class));
157         RIC_1.setState(RicState.UNAVAILABLE);
158         rics.put(RIC_1);
159         RicSupervision supervisorUnderTest = spy(createRicSupervision());
160         doReturn(synchronizationTaskMock).when(supervisorUnderTest).createSynchronizationTask();
161         doReturn(Mono.just(RIC_1)).when(synchronizationTaskMock).synchronizeRic(any());
162         supervisorUnderTest.checkAllRics();
163         verify(synchronizationTaskMock).synchronizeRic(RIC_1);
164
165         assertThat(RIC_1.getState()).isEqualTo(RicState.UNAVAILABLE);
166     }
167
168     @Test
169     void whenRicSynchronizing_thenNoSynchronization() {
170         doReturn(Mono.just(a1ClientMock)).when(a1ClientFactory).createA1Client(any(Ric.class));
171         RIC_1.setState(RicState.SYNCHRONIZING);
172         rics.put(RIC_1);
173
174         RicSupervision supervisorUnderTest = spy(createRicSupervision());
175
176         supervisorUnderTest.checkAllRics();
177
178         verify(supervisorUnderTest).checkAllRics();
179         verify(synchronizationTaskMock, times(0)).synchronizeRic(RIC_1);
180         assertThat(RIC_1.getState()).isEqualTo(RicState.SYNCHRONIZING);
181     }
182
183     @Test
184     void whenRicIdleAndErrorGettingPolicyIdentities_thenNoSynchronization() {
185         doReturn(Mono.just(a1ClientMock)).when(a1ClientFactory).createA1Client(any(Ric.class));
186         RIC_1.setState(RicState.AVAILABLE);
187         RIC_1.addSupportedPolicyType(POLICY_TYPE_1);
188         rics.put(RIC_1);
189
190         setUpGetPolicyIdentitiesToReturn(new Exception("Failed"));
191
192         RicSupervision supervisorUnderTest = spy(createRicSupervision());
193         supervisorUnderTest.checkAllRics();
194
195         verify(supervisorUnderTest).checkAllRics();
196         verify(synchronizationTaskMock, times(0)).synchronizeRic(RIC_1);
197
198         assertThat(RIC_1.getState()).isEqualTo(RicState.UNAVAILABLE);
199     }
200
201     @Test
202     void whenRicIdleAndNotSameAmountOfPolicies_thenSynchronization() {
203         doReturn(Mono.just(a1ClientMock)).when(a1ClientFactory).createA1Client(any(Ric.class));
204         RIC_1.setState(RicState.AVAILABLE);
205         rics.put(RIC_1);
206
207         policies.put(POLICY_1);
208         policies.put(POLICY_2);
209
210         setUpGetPolicyIdentitiesToReturn(new ArrayList<>(Arrays.asList(POLICY_1_ID)));
211
212         RicSupervision supervisorUnderTest = spy(createRicSupervision());
213
214         doReturn(synchronizationTaskMock).when(supervisorUnderTest).createSynchronizationTask();
215
216         supervisorUnderTest.checkAllRics();
217
218         verify(supervisorUnderTest).checkAllRics();
219         verify(synchronizationTaskMock).synchronizeRic(RIC_1);
220
221         assertThat(RIC_1.getState()).isEqualTo(RicState.UNAVAILABLE);
222     }
223
224     @Test
225     void whenRicIdleAndSameAmountOfPoliciesButNotSamePolicies_thenSynchronization() {
226         doReturn(Mono.just(a1ClientMock)).when(a1ClientFactory).createA1Client(any(Ric.class));
227         RIC_1.setState(RicState.AVAILABLE);
228         rics.put(RIC_1);
229
230         policies.put(POLICY_1);
231         policies.put(POLICY_2);
232
233         setUpGetPolicyIdentitiesToReturn(new ArrayList<>(Arrays.asList(POLICY_1_ID, "Another_policy")));
234
235         RicSupervision supervisorUnderTest = spy(createRicSupervision());
236
237         doReturn(synchronizationTaskMock).when(supervisorUnderTest).createSynchronizationTask();
238
239         supervisorUnderTest.checkAllRics();
240
241         verify(supervisorUnderTest).checkAllRics();
242         verify(synchronizationTaskMock).synchronizeRic(RIC_1);
243
244         assertThat(RIC_1.getState()).isEqualTo(RicState.UNAVAILABLE);
245     }
246
247     @Test
248     void whenRicIdleAndErrorGettingPolicyTypes_thenNoSynchronization() {
249         doReturn(Mono.just(a1ClientMock)).when(a1ClientFactory).createA1Client(any(Ric.class));
250         RIC_1.setState(RicState.AVAILABLE);
251         RIC_1.addSupportedPolicyType(POLICY_TYPE_1);
252         rics.put(RIC_1);
253
254         setUpGetPolicyIdentitiesToReturn(Collections.emptyList());
255         setUpGetPolicyTypeIdentitiesToReturn(new Exception("Failed"));
256
257         RicSupervision supervisorUnderTest = spy(createRicSupervision());
258         supervisorUnderTest.checkAllRics();
259
260         verify(supervisorUnderTest).checkAllRics();
261         verify(synchronizationTaskMock, times(0)).synchronizeRic(RIC_1);
262
263         assertThat(RIC_1.getState()).isEqualTo(RicState.UNAVAILABLE);
264     }
265
266     @Test
267     void whenRicIdleAndNotSameAmountOfPolicyTypes_thenSynchronization() {
268         doReturn(Mono.just(a1ClientMock)).when(a1ClientFactory).createA1Client(any(Ric.class));
269         RIC_1.setState(RicState.AVAILABLE);
270         RIC_1.addSupportedPolicyType(POLICY_TYPE_1);
271         rics.put(RIC_1);
272
273         types.put(POLICY_TYPE_1);
274
275         setUpGetPolicyIdentitiesToReturn(Collections.emptyList());
276         setUpGetPolicyTypeIdentitiesToReturn(new ArrayList<>(Arrays.asList(POLICY_TYPE_1_NAME, "another_policy_type")));
277
278         RicSupervision supervisorUnderTest = spy(createRicSupervision());
279
280         doReturn(synchronizationTaskMock).when(supervisorUnderTest).createSynchronizationTask();
281
282         supervisorUnderTest.checkAllRics();
283
284         verify(supervisorUnderTest).checkAllRics();
285         verify(synchronizationTaskMock).synchronizeRic(RIC_1);
286
287         assertThat(RIC_1.getState()).isEqualTo(RicState.UNAVAILABLE);
288     }
289
290     @Test
291     void whenRicIdleAndSameAmountOfPolicyTypesButNotSameTypes_thenSynchronization() {
292         doReturn(Mono.just(a1ClientMock)).when(a1ClientFactory).createA1Client(any(Ric.class));
293         PolicyType policyType2 = PolicyType.builder() //
294                 .id("policyType2") //
295                 .schema("") //
296                 .build();
297
298         RIC_1.setState(RicState.AVAILABLE);
299         RIC_1.addSupportedPolicyType(POLICY_TYPE_1);
300         RIC_1.addSupportedPolicyType(policyType2);
301         rics.put(RIC_1);
302
303         setUpGetPolicyIdentitiesToReturn(Collections.emptyList());
304         setUpGetPolicyTypeIdentitiesToReturn(new ArrayList<>(Arrays.asList(POLICY_TYPE_1_NAME, "another_policy_type")));
305
306         RicSupervision supervisorUnderTest = spy(createRicSupervision());
307
308         doReturn(synchronizationTaskMock).when(supervisorUnderTest).createSynchronizationTask();
309
310         supervisorUnderTest.checkAllRics();
311
312         verify(supervisorUnderTest).checkAllRics();
313         verify(synchronizationTaskMock).synchronizeRic(RIC_1);
314         assertThat(RIC_1.getState()).isEqualTo(RicState.UNAVAILABLE);
315     }
316
317     @SuppressWarnings("unchecked")
318     private void setUpGetPolicyIdentitiesToReturn(Object returnValue) {
319         if (returnValue instanceof List<?>) {
320             when(a1ClientMock.getPolicyIdentities()).thenReturn(Mono.just((List<String>) returnValue));
321         } else if (returnValue instanceof Exception) {
322             when(a1ClientMock.getPolicyIdentities()).thenReturn(Mono.error((Exception) returnValue));
323         }
324     }
325
326     @SuppressWarnings("unchecked")
327     private void setUpGetPolicyTypeIdentitiesToReturn(Object returnValue) {
328         if (returnValue instanceof List<?>) {
329             when(a1ClientMock.getPolicyTypeIdentities()).thenReturn(Mono.just((List<String>) returnValue));
330         } else if (returnValue instanceof Exception) {
331             when(a1ClientMock.getPolicyTypeIdentities()).thenReturn(Mono.error((Exception) returnValue));
332         }
333     }
334
335     private RicSupervision createRicSupervision() {
336         ApplicationConfig config = new ApplicationConfig();
337         return new RicSupervision(rics, policies, a1ClientFactory, types, null, config, new SecurityContext(""));
338     }
339 }