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