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 ch.qos.logback.classic.Level.WARN;
24 import static org.assertj.core.api.Assertions.assertThat;
25 import static org.mockito.ArgumentMatchers.any;
26 import static org.mockito.ArgumentMatchers.anyString;
27 import static org.mockito.Mockito.doReturn;
28 import static org.mockito.Mockito.mock;
29 import static org.mockito.Mockito.spy;
30 import static org.mockito.Mockito.times;
31 import static org.mockito.Mockito.verify;
32 import static org.mockito.Mockito.verifyNoInteractions;
33 import static org.mockito.Mockito.verifyNoMoreInteractions;
34 import static org.mockito.Mockito.when;
36 import ch.qos.logback.classic.spi.ILoggingEvent;
37 import ch.qos.logback.core.read.ListAppender;
39 import java.time.Duration;
40 import java.util.Arrays;
41 import java.util.Collections;
43 import org.junit.jupiter.api.BeforeEach;
44 import org.junit.jupiter.api.Test;
45 import org.junit.jupiter.api.extension.ExtendWith;
46 import org.mockito.Mock;
47 import org.mockito.junit.jupiter.MockitoExtension;
48 import org.oransc.policyagent.clients.A1Client;
49 import org.oransc.policyagent.clients.A1ClientFactory;
50 import org.oransc.policyagent.clients.AsyncRestClient;
51 import org.oransc.policyagent.configuration.ImmutableRicConfig;
52 import org.oransc.policyagent.repository.ImmutablePolicy;
53 import org.oransc.policyagent.repository.ImmutablePolicyType;
54 import org.oransc.policyagent.repository.Policies;
55 import org.oransc.policyagent.repository.Policy;
56 import org.oransc.policyagent.repository.PolicyType;
57 import org.oransc.policyagent.repository.PolicyTypes;
58 import org.oransc.policyagent.repository.Ric;
59 import org.oransc.policyagent.repository.Ric.RicState;
60 import org.oransc.policyagent.repository.Service;
61 import org.oransc.policyagent.repository.Services;
62 import org.oransc.policyagent.utils.LoggingUtils;
64 import reactor.core.publisher.Flux;
65 import reactor.core.publisher.Mono;
67 @ExtendWith(MockitoExtension.class)
68 public class RicSynchronizationTaskTest {
69 private static final String POLICY_TYPE_1_NAME = "type1";
70 private static final PolicyType POLICY_TYPE_1 = ImmutablePolicyType.builder() //
71 .name(POLICY_TYPE_1_NAME) //
75 private static final String RIC_1_NAME = "ric1";
76 private static final Ric RIC_1 = new Ric(ImmutableRicConfig.builder() //
78 .baseUrl("baseUrl1") //
79 .managedElementIds(Collections.emptyList()) //
82 private static final Policy POLICY_1 = ImmutablePolicy.builder() //
85 .ownerServiceName("service") //
87 .type(POLICY_TYPE_1) //
88 .lastModified("now") //
91 private static final String SERVICE_1_NAME = "service1";
92 private static final String SERVICE_1_CALLBACK_URL = "callbackUrl";
93 private static final Service SERVICE_1 = new Service(SERVICE_1_NAME, Duration.ofSeconds(1), SERVICE_1_CALLBACK_URL);
96 private A1Client a1ClientMock;
99 private A1ClientFactory a1ClientFactoryMock;
101 private PolicyTypes policyTypes;
102 private Policies policies;
103 private Services services;
107 policyTypes = new PolicyTypes();
108 policies = new Policies();
109 services = new Services();
110 RIC_1.setState(RicState.UNDEFINED);
111 RIC_1.clearSupportedPolicyTypes();
115 public void ricAlreadySynchronizing_thenNoSynchronization() {
116 RIC_1.setState(RicState.SYNCHRONIZING);
117 RIC_1.addSupportedPolicyType(POLICY_TYPE_1);
119 policyTypes.put(POLICY_TYPE_1);
120 policies.put(POLICY_1);
122 RicSynchronizationTask synchronizerUnderTest =
123 new RicSynchronizationTask(a1ClientFactoryMock, policyTypes, policies, services);
125 synchronizerUnderTest.run(RIC_1);
127 verifyNoInteractions(a1ClientMock);
129 assertThat(policyTypes.size()).isEqualTo(1);
130 assertThat(policies.size()).isEqualTo(1);
131 assertThat(RIC_1.getState()).isEqualTo(RicState.SYNCHRONIZING);
132 assertThat(RIC_1.getSupportedPolicyTypeNames().size()).isEqualTo(1);
136 public void ricIdlePolicyTypeInRepo_thenSynchronizationWithReuseOfTypeFromRepoAndCorrectServiceNotified() {
137 RIC_1.setState(RicState.IDLE);
139 policyTypes.put(POLICY_TYPE_1);
141 services.put(SERVICE_1);
142 Service serviceWithoutCallbackUrlShouldNotBeNotified = new Service("service2", Duration.ofSeconds(1), "");
143 services.put(serviceWithoutCallbackUrlShouldNotBeNotified);
145 setUpCreationOfA1Client();
146 simulateRicWithOnePolicyType();
148 RicSynchronizationTask synchronizerUnderTest =
149 spy(new RicSynchronizationTask(a1ClientFactoryMock, policyTypes, policies, services));
151 AsyncRestClient restClientMock = setUpCreationOfAsyncRestClient(synchronizerUnderTest);
152 when(restClientMock.put(anyString(), anyString())).thenReturn(Mono.just("Ok"));
154 synchronizerUnderTest.run(RIC_1);
156 verify(a1ClientMock, times(1)).getPolicyTypeIdentities();
157 verifyNoMoreInteractions(a1ClientMock);
159 verify(synchronizerUnderTest).run(RIC_1);
160 verify(synchronizerUnderTest).createNotificationClient(SERVICE_1_CALLBACK_URL);
161 verifyNoMoreInteractions(synchronizerUnderTest);
163 verify(restClientMock).put("", "Synchronization completed for:" + RIC_1_NAME);
164 verifyNoMoreInteractions(restClientMock);
166 assertThat(policyTypes.size()).isEqualTo(1);
167 assertThat(policies.size()).isEqualTo(0);
168 assertThat(RIC_1.getState()).isEqualTo(RicState.IDLE);
172 public void ricIdlePolicyTypeNotInRepo_thenSynchronizationWithTypeFromRic() throws Exception {
173 RIC_1.setState(RicState.IDLE);
175 setUpCreationOfA1Client();
176 simulateRicWithOnePolicyType();
177 String typeSchema = "schema";
178 when(a1ClientMock.getPolicyTypeSchema(POLICY_TYPE_1_NAME)).thenReturn(Mono.just(typeSchema));
180 RicSynchronizationTask synchronizerUnderTest =
181 new RicSynchronizationTask(a1ClientFactoryMock, policyTypes, policies, services);
183 synchronizerUnderTest.run(RIC_1);
185 verify(a1ClientMock).getPolicyTypeIdentities();
186 verifyNoMoreInteractions(a1ClientMock);
188 assertThat(policyTypes.size()).isEqualTo(1);
189 assertThat(policyTypes.getType(POLICY_TYPE_1_NAME).schema()).isEqualTo(typeSchema);
190 assertThat(policies.size()).isEqualTo(0);
191 assertThat(RIC_1.getState()).isEqualTo(RicState.IDLE);
195 public void ricIdleAndHavePolicies_thenSynchronizationWithRecreationOfPolicies() {
196 RIC_1.setState(RicState.IDLE);
198 policies.put(POLICY_1);
200 setUpCreationOfA1Client();
201 simulateRicWithNoPolicyTypes();
203 when(a1ClientMock.deleteAllPolicies()).thenReturn(Flux.just("OK"));
204 when(a1ClientMock.putPolicy(any(Policy.class))).thenReturn(Mono.just("OK"));
206 RicSynchronizationTask synchronizerUnderTest =
207 new RicSynchronizationTask(a1ClientFactoryMock, policyTypes, policies, services);
209 synchronizerUnderTest.run(RIC_1);
211 verify(a1ClientMock).deleteAllPolicies();
212 verify(a1ClientMock).putPolicy(POLICY_1);
213 verifyNoMoreInteractions(a1ClientMock);
215 assertThat(policyTypes.size()).isEqualTo(0);
216 assertThat(policies.size()).isEqualTo(1);
217 assertThat(RIC_1.getState()).isEqualTo(RicState.IDLE);
221 public void ricIdleAndErrorDeletingPoliciesFirstTime_thenSynchronizationWithDeletionOfPolicies() {
222 RIC_1.setState(RicState.IDLE);
224 policies.put(POLICY_1);
226 setUpCreationOfA1Client();
227 simulateRicWithNoPolicyTypes();
229 when(a1ClientMock.deleteAllPolicies()) //
230 .thenReturn(Flux.error(new Exception("Exception"))) //
231 .thenReturn(Flux.just("OK"));
233 RicSynchronizationTask synchronizerUnderTest =
234 new RicSynchronizationTask(a1ClientFactoryMock, policyTypes, policies, services);
236 synchronizerUnderTest.run(RIC_1);
238 verify(a1ClientMock, times(2)).deleteAllPolicies();
239 verifyNoMoreInteractions(a1ClientMock);
241 assertThat(policyTypes.size()).isEqualTo(0);
242 assertThat(policies.size()).isEqualTo(0);
243 assertThat(RIC_1.getState()).isEqualTo(RicState.IDLE);
247 public void ricIdleAndErrorDeletingPoliciesAllTheTime_thenSynchronizationWithFailedRecovery() {
248 RIC_1.setState(RicState.IDLE);
250 policies.put(POLICY_1);
252 setUpCreationOfA1Client();
253 simulateRicWithNoPolicyTypes();
255 String originalErrorMessage = "Exception";
256 when(a1ClientMock.deleteAllPolicies()).thenReturn(Flux.error(new Exception(originalErrorMessage)));
258 RicSynchronizationTask synchronizerUnderTest =
259 new RicSynchronizationTask(a1ClientFactoryMock, policyTypes, policies, services);
261 final ListAppender<ILoggingEvent> logAppender =
262 LoggingUtils.getLogListAppender(RicSynchronizationTask.class, WARN);
264 synchronizerUnderTest.run(RIC_1);
266 verifyCorrectLogMessage(0, logAppender,
267 "Synchronization failed for ric: " + RIC_1_NAME + ", reason: " + originalErrorMessage);
268 verifyCorrectLogMessage(1, logAppender,
269 "Synchronization failure recovery failed for ric: " + RIC_1_NAME + ", reason: " + originalErrorMessage);
271 verify(a1ClientMock, times(2)).deleteAllPolicies();
272 verifyNoMoreInteractions(a1ClientMock);
274 assertThat(policyTypes.size()).isEqualTo(0);
275 assertThat(policies.size()).isEqualTo(0);
276 assertThat(RIC_1.getState()).isEqualTo(RicState.UNDEFINED);
280 public void ricIdlePolicyTypeInRepo_thenSynchronizationWithErrorOnServiceNotificationErrorLogged() {
281 RIC_1.setState(RicState.IDLE);
283 policyTypes.put(POLICY_TYPE_1);
285 services.put(SERVICE_1);
287 setUpCreationOfA1Client();
288 simulateRicWithOnePolicyType();
290 final ListAppender<ILoggingEvent> logAppender =
291 LoggingUtils.getLogListAppender(RicSynchronizationTask.class, WARN);
293 RicSynchronizationTask synchronizerUnderTest =
294 spy(new RicSynchronizationTask(a1ClientFactoryMock, policyTypes, policies, services));
296 AsyncRestClient restClientMock = setUpCreationOfAsyncRestClient(synchronizerUnderTest);
297 String originalErrorMessage = "Exception";
298 when(restClientMock.put(anyString(), anyString())).thenReturn(Mono.error(new Exception(originalErrorMessage)));
300 synchronizerUnderTest.run(RIC_1);
302 ILoggingEvent loggingEvent = logAppender.list.get(0);
303 assertThat(loggingEvent.getThrowableProxy().getMessage()).isEqualTo(originalErrorMessage);
304 verifyCorrectLogMessage(0, logAppender, "Service notification failed for service: " + SERVICE_1_NAME);
307 private void setUpCreationOfA1Client() {
308 when(a1ClientFactoryMock.createA1Client(any(Ric.class))).thenReturn(Mono.just(a1ClientMock));
309 doReturn(Flux.empty()).when(a1ClientMock).deleteAllPolicies();
312 private AsyncRestClient setUpCreationOfAsyncRestClient(RicSynchronizationTask synchronizerUnderTest) {
313 AsyncRestClient restClientMock = mock(AsyncRestClient.class);
314 doReturn(restClientMock).when(synchronizerUnderTest).createNotificationClient(anyString());
315 return restClientMock;
318 private void simulateRicWithOnePolicyType() {
319 when(a1ClientMock.getPolicyTypeIdentities()).thenReturn(Mono.just(Arrays.asList(POLICY_TYPE_1_NAME)));
322 private void simulateRicWithNoPolicyTypes() {
323 when(a1ClientMock.getPolicyTypeIdentities()).thenReturn(Mono.just(Collections.emptyList()));
326 private void verifyCorrectLogMessage(int messageIndex, ListAppender<ILoggingEvent> logAppender,
327 String expectedMessage) {
328 ILoggingEvent loggingEvent = logAppender.list.get(messageIndex);
329 assertThat(loggingEvent.toString().contains(expectedMessage)).isTrue();