2 * ========================LICENSE_START=================================
5 * Copyright (C) 2020 Nordix Foundation
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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===================================
21 package org.oransc.policyagent.tasks;
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;
31 import java.util.ArrayList;
32 import java.util.Arrays;
33 import java.util.Collections;
34 import java.util.List;
35 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.oransc.policyagent.clients.A1Client;
44 import org.oransc.policyagent.clients.A1ClientFactory;
45 import org.oransc.policyagent.configuration.ImmutableRicConfig;
46 import org.oransc.policyagent.repository.ImmutablePolicy;
47 import org.oransc.policyagent.repository.ImmutablePolicyType;
48 import org.oransc.policyagent.repository.Lock.LockType;
49 import org.oransc.policyagent.repository.Policies;
50 import org.oransc.policyagent.repository.Policy;
51 import org.oransc.policyagent.repository.PolicyType;
52 import org.oransc.policyagent.repository.PolicyTypes;
53 import org.oransc.policyagent.repository.Ric;
54 import org.oransc.policyagent.repository.Ric.RicState;
55 import org.oransc.policyagent.repository.Rics;
56 import reactor.core.publisher.Mono;
58 @ExtendWith(MockitoExtension.class)
59 public class RicSupervisionTest {
60 private static final String POLICY_TYPE_1_NAME = "type1";
61 private static final PolicyType POLICY_TYPE_1 = ImmutablePolicyType.builder() //
62 .name(POLICY_TYPE_1_NAME) //
66 private static final Ric RIC_1 = new Ric(ImmutableRicConfig.builder() //
68 .baseUrl("baseUrl1") //
69 .managedElementIds(new Vector<String>(Arrays.asList("kista_1", "kista_2"))) //
70 .controllerName("controllerName") //
73 private static final String POLICY_1_ID = "policyId1";
74 private static final Policy POLICY_1 = ImmutablePolicy.builder() //
77 .ownerServiceName("service") //
79 .type(POLICY_TYPE_1) //
80 .lastModified("now") //
83 private static final Policy POLICY_2 = ImmutablePolicy.builder() //
86 .ownerServiceName("service") //
88 .type(POLICY_TYPE_1) //
89 .lastModified("now") //
93 private A1Client a1ClientMock;
96 private A1ClientFactory a1ClientFactory;
99 private RicSynchronizationTask synchronizationTaskMock;
101 private final PolicyTypes types = new PolicyTypes();
102 private Policies policies = new Policies();
103 private Rics rics = new Rics();
110 RIC_1.setState(RicState.UNAVAILABLE);
111 RIC_1.clearSupportedPolicyTypes();
115 public void verifyNoRicLocks() {
116 for (Ric ric : this.rics.getRics()) {
117 ric.getLock().lockBlocking(LockType.EXCLUSIVE);
118 ric.getLock().unlockBlocking();
119 assertThat(ric.getLock().getLockCounter()).isEqualTo(0);
124 public void whenRicIdleAndNoChangedPoliciesOrPolicyTypes_thenNoSynchronization() {
125 doReturn(Mono.just(a1ClientMock)).when(a1ClientFactory).createA1Client(any(Ric.class));
126 RIC_1.setState(RicState.AVAILABLE);
127 RIC_1.addSupportedPolicyType(POLICY_TYPE_1);
130 types.put(POLICY_TYPE_1);
132 policies.put(POLICY_1);
134 setUpGetPolicyIdentitiesToReturn(new ArrayList<>(Arrays.asList(POLICY_1_ID)));
135 setUpGetPolicyTypeIdentitiesToReturn(new ArrayList<>(Arrays.asList(POLICY_TYPE_1_NAME)));
137 RicSupervision supervisorUnderTest = spy(new RicSupervision(rics, policies, a1ClientFactory, types, null));
139 supervisorUnderTest.checkAllRics();
141 verify(supervisorUnderTest).checkAllRics();
142 verifyNoMoreInteractions(supervisorUnderTest);
146 public void whenRicUndefined_thenSynchronization() {
147 doReturn(Mono.just(a1ClientMock)).when(a1ClientFactory).createA1Client(any(Ric.class));
148 RIC_1.setState(RicState.UNAVAILABLE);
151 RicSupervision supervisorUnderTest = spy(new RicSupervision(rics, policies, a1ClientFactory, types, null));
153 doReturn(synchronizationTaskMock).when(supervisorUnderTest).createSynchronizationTask();
155 supervisorUnderTest.checkAllRics();
157 verify(supervisorUnderTest).checkAllRics();
158 verify(supervisorUnderTest).createSynchronizationTask();
159 verify(synchronizationTaskMock).run(RIC_1);
160 verifyNoMoreInteractions(supervisorUnderTest);
164 public void whenRicSynchronizing_thenNoSynchronization() {
165 doReturn(Mono.just(a1ClientMock)).when(a1ClientFactory).createA1Client(any(Ric.class));
166 RIC_1.setState(RicState.SYNCHRONIZING);
169 RicSupervision supervisorUnderTest = spy(new RicSupervision(rics, policies, a1ClientFactory, types, null));
171 supervisorUnderTest.checkAllRics();
173 verify(supervisorUnderTest).checkAllRics();
174 verifyNoMoreInteractions(supervisorUnderTest);
178 public void whenRicIdleAndErrorGettingPolicyIdentities_thenNoSynchronization() {
179 doReturn(Mono.just(a1ClientMock)).when(a1ClientFactory).createA1Client(any(Ric.class));
180 RIC_1.setState(RicState.AVAILABLE);
181 RIC_1.addSupportedPolicyType(POLICY_TYPE_1);
184 setUpGetPolicyIdentitiesToReturn(new Exception("Failed"));
186 RicSupervision supervisorUnderTest = spy(new RicSupervision(rics, policies, a1ClientFactory, types, null));
187 supervisorUnderTest.checkAllRics();
189 verify(supervisorUnderTest).checkAllRics();
190 verifyNoMoreInteractions(supervisorUnderTest);
191 assertThat(RIC_1.getState()).isEqualTo(RicState.UNAVAILABLE);
195 public void whenRicIdleAndNotSameAmountOfPolicies_thenSynchronization() {
196 doReturn(Mono.just(a1ClientMock)).when(a1ClientFactory).createA1Client(any(Ric.class));
197 RIC_1.setState(RicState.AVAILABLE);
200 policies.put(POLICY_1);
201 policies.put(POLICY_2);
203 setUpGetPolicyIdentitiesToReturn(new ArrayList<>(Arrays.asList(POLICY_1_ID)));
205 RicSupervision supervisorUnderTest = spy(new RicSupervision(rics, policies, a1ClientFactory, types, null));
207 doReturn(synchronizationTaskMock).when(supervisorUnderTest).createSynchronizationTask();
209 supervisorUnderTest.checkAllRics();
211 verify(supervisorUnderTest).checkAllRics();
212 verify(supervisorUnderTest).createSynchronizationTask();
213 verify(synchronizationTaskMock).run(RIC_1);
214 verifyNoMoreInteractions(supervisorUnderTest);
218 public void whenRicIdleAndSameAmountOfPoliciesButNotSamePolicies_thenSynchronization() {
219 doReturn(Mono.just(a1ClientMock)).when(a1ClientFactory).createA1Client(any(Ric.class));
220 RIC_1.setState(RicState.AVAILABLE);
223 policies.put(POLICY_1);
224 policies.put(POLICY_2);
226 setUpGetPolicyIdentitiesToReturn(new ArrayList<>(Arrays.asList(POLICY_1_ID, "Another_policy")));
228 RicSupervision supervisorUnderTest = spy(new RicSupervision(rics, policies, a1ClientFactory, types, null));
230 doReturn(synchronizationTaskMock).when(supervisorUnderTest).createSynchronizationTask();
232 supervisorUnderTest.checkAllRics();
234 verify(supervisorUnderTest).checkAllRics();
235 verify(supervisorUnderTest).createSynchronizationTask();
236 verify(synchronizationTaskMock).run(RIC_1);
237 verifyNoMoreInteractions(supervisorUnderTest);
241 public void whenRicIdleAndErrorGettingPolicyTypes_thenNoSynchronization() {
242 doReturn(Mono.just(a1ClientMock)).when(a1ClientFactory).createA1Client(any(Ric.class));
243 RIC_1.setState(RicState.AVAILABLE);
244 RIC_1.addSupportedPolicyType(POLICY_TYPE_1);
247 setUpGetPolicyIdentitiesToReturn(Collections.emptyList());
248 setUpGetPolicyTypeIdentitiesToReturn(new Exception("Failed"));
250 RicSupervision supervisorUnderTest = spy(new RicSupervision(rics, policies, a1ClientFactory, types, null));
251 supervisorUnderTest.checkAllRics();
253 verify(supervisorUnderTest).checkAllRics();
254 verifyNoMoreInteractions(supervisorUnderTest);
258 public void whenRicIdleAndNotSameAmountOfPolicyTypes_thenSynchronization() {
259 doReturn(Mono.just(a1ClientMock)).when(a1ClientFactory).createA1Client(any(Ric.class));
260 RIC_1.setState(RicState.AVAILABLE);
261 RIC_1.addSupportedPolicyType(POLICY_TYPE_1);
264 types.put(POLICY_TYPE_1);
266 setUpGetPolicyIdentitiesToReturn(Collections.emptyList());
267 setUpGetPolicyTypeIdentitiesToReturn(new ArrayList<>(Arrays.asList(POLICY_TYPE_1_NAME, "another_policy_type")));
269 RicSupervision supervisorUnderTest = spy(new RicSupervision(rics, policies, a1ClientFactory, types, null));
271 doReturn(synchronizationTaskMock).when(supervisorUnderTest).createSynchronizationTask();
273 supervisorUnderTest.checkAllRics();
275 verify(supervisorUnderTest).checkAllRics();
276 verify(supervisorUnderTest).createSynchronizationTask();
277 verify(synchronizationTaskMock).run(RIC_1);
278 verifyNoMoreInteractions(supervisorUnderTest);
282 public void whenRicIdleAndSameAmountOfPolicyTypesButNotSameTypes_thenSynchronization() {
283 doReturn(Mono.just(a1ClientMock)).when(a1ClientFactory).createA1Client(any(Ric.class));
284 PolicyType policyType2 = ImmutablePolicyType.builder() //
285 .name("policyType2") //
289 RIC_1.setState(RicState.AVAILABLE);
290 RIC_1.addSupportedPolicyType(POLICY_TYPE_1);
291 RIC_1.addSupportedPolicyType(policyType2);
294 setUpGetPolicyIdentitiesToReturn(Collections.emptyList());
295 setUpGetPolicyTypeIdentitiesToReturn(new ArrayList<>(Arrays.asList(POLICY_TYPE_1_NAME, "another_policy_type")));
297 RicSupervision supervisorUnderTest = spy(new RicSupervision(rics, policies, a1ClientFactory, types, null));
299 doReturn(synchronizationTaskMock).when(supervisorUnderTest).createSynchronizationTask();
301 supervisorUnderTest.checkAllRics();
303 verify(supervisorUnderTest).checkAllRics();
304 verify(supervisorUnderTest).createSynchronizationTask();
305 verify(synchronizationTaskMock).run(RIC_1);
306 verifyNoMoreInteractions(supervisorUnderTest);
309 @SuppressWarnings("unchecked")
310 private void setUpGetPolicyIdentitiesToReturn(Object returnValue) {
311 if (returnValue instanceof List<?>) {
312 when(a1ClientMock.getPolicyIdentities()).thenReturn(Mono.just((List<String>) returnValue));
313 } else if (returnValue instanceof Exception) {
314 when(a1ClientMock.getPolicyIdentities()).thenReturn(Mono.error((Exception) returnValue));
318 @SuppressWarnings("unchecked")
319 private void setUpGetPolicyTypeIdentitiesToReturn(Object returnValue) {
320 if (returnValue instanceof List<?>) {
321 when(a1ClientMock.getPolicyTypeIdentities()).thenReturn(Mono.just((List<String>) returnValue));
322 } else if (returnValue instanceof Exception) {
323 when(a1ClientMock.getPolicyTypeIdentities()).thenReturn(Mono.error((Exception) returnValue));