gerrit.onap Code Review - ccsdk/oran.git/blob

   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 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;
  35
  36 import ch.qos.logback.classic.spi.ILoggingEvent;
  37 import ch.qos.logback.core.read.ListAppender;
  38
  39 import java.time.Duration;
  40 import java.time.Instant;
  41 import java.util.Arrays;
  42 import java.util.Collections;
  43
  44 import org.junit.jupiter.api.BeforeEach;
  45 import org.junit.jupiter.api.Test;
  46 import org.junit.jupiter.api.extension.ExtendWith;
  47 import org.mockito.Mock;
  48 import org.mockito.junit.jupiter.MockitoExtension;
  49 import org.onap.ccsdk.oran.a1policymanagementservice.clients.A1Client;
  50 import org.onap.ccsdk.oran.a1policymanagementservice.clients.A1ClientFactory;
  51 import org.onap.ccsdk.oran.a1policymanagementservice.clients.AsyncRestClient;
  52 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ImmutableRicConfig;
  53 import org.onap.ccsdk.oran.a1policymanagementservice.repository.ImmutablePolicy;
  54 import org.onap.ccsdk.oran.a1policymanagementservice.repository.ImmutablePolicyType;
  55 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policies;
  56 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policy;
  57 import org.onap.ccsdk.oran.a1policymanagementservice.repository.PolicyType;
  58 import org.onap.ccsdk.oran.a1policymanagementservice.repository.PolicyTypes;
  59 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Ric;
  60 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Ric.RicState;
  61 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Service;
  62 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Services;
  63 import org.onap.ccsdk.oran.a1policymanagementservice.utils.LoggingUtils;
  64
  65 import reactor.core.publisher.Flux;
  66 import reactor.core.publisher.Mono;
  67
  68 @ExtendWith(MockitoExtension.class)
  69 class RicSynchronizationTaskTest {
  70     private static final String POLICY_TYPE_1_NAME = "type1";
  71     private static final PolicyType POLICY_TYPE_1 = ImmutablePolicyType.builder() //
  72             .id(POLICY_TYPE_1_NAME) //
  73             .schema("") //
  74             .build();
  75
  76     private static final String RIC_1_NAME = "ric1";
  77     private static final Ric RIC_1 = new Ric(ImmutableRicConfig.builder() //
  78             .ricId(RIC_1_NAME) //
  79             .baseUrl("baseUrl1") //
  80             .managedElementIds(Collections.emptyList()) //
  81             .controllerName("controllerName") //
  82             .build());
  83
  84     private static Policy createPolicy(String policyId, boolean isTransient) {
  85         return ImmutablePolicy.builder() //
  86                 .id(policyId) //
  87                 .json("") //
  88                 .ownerServiceId("service") //
  89                 .ric(RIC_1) //
  90                 .type(POLICY_TYPE_1) //
  91                 .lastModified(Instant.now()) //
  92                 .isTransient(isTransient) //
  93                 .build();
  94     }
  95
  96     private static final Policy POLICY_1 = createPolicy("policyId1", false);
  97
  98     private static final String SERVICE_1_NAME = "service1";
  99     private static final String SERVICE_1_CALLBACK_URL = "callbackUrl";
 100     private static final Service SERVICE_1 = new Service(SERVICE_1_NAME, Duration.ofSeconds(1), SERVICE_1_CALLBACK_URL);
 101
 102     @Mock
 103     private A1Client a1ClientMock;
 104
 105     @Mock
 106     private A1ClientFactory a1ClientFactoryMock;
 107
 108     private PolicyTypes policyTypes;
 109     private Policies policies;
 110     private Services services;
 111
 112     @BeforeEach
 113     void init() {
 114         policyTypes = new PolicyTypes();
 115         policies = new Policies();
 116         services = new Services();
 117         RIC_1.setState(RicState.UNAVAILABLE);
 118         RIC_1.clearSupportedPolicyTypes();
 119     }
 120
 121     @Test
 122     void ricAlreadySynchronizing_thenNoSynchronization() {
 123         RIC_1.setState(RicState.SYNCHRONIZING);
 124         RIC_1.addSupportedPolicyType(POLICY_TYPE_1);
 125
 126         policyTypes.put(POLICY_TYPE_1);
 127         policies.put(POLICY_1);
 128
 129         RicSynchronizationTask synchronizerUnderTest =
 130                 new RicSynchronizationTask(a1ClientFactoryMock, policyTypes, policies, services);
 131
 132         synchronizerUnderTest.run(RIC_1);
 133
 134         verifyNoInteractions(a1ClientMock);
 135
 136         assertThat(policyTypes.size()).isEqualTo(1);
 137         assertThat(policies.size()).isEqualTo(1);
 138         assertThat(RIC_1.getState()).isEqualTo(RicState.SYNCHRONIZING);
 139         assertThat(RIC_1.getSupportedPolicyTypeNames()).hasSize(1);
 140     }
 141
 142     @Test
 143     void ricIdlePolicyTypeInRepo_thenSynchronizationWithReuseOfTypeFromRepoAndCorrectServiceNotified() {
 144         RIC_1.setState(RicState.AVAILABLE);
 145
 146         policyTypes.put(POLICY_TYPE_1);
 147
 148         services.put(SERVICE_1);
 149         Service serviceWithoutCallbackUrlShouldNotBeNotified = new Service("service2", Duration.ofSeconds(1), "");
 150         services.put(serviceWithoutCallbackUrlShouldNotBeNotified);
 151
 152         setUpCreationOfA1Client();
 153         simulateRicWithOnePolicyType();
 154
 155         RicSynchronizationTask synchronizerUnderTest =
 156                 spy(new RicSynchronizationTask(a1ClientFactoryMock, policyTypes, policies, services));
 157
 158         AsyncRestClient restClientMock = setUpCreationOfAsyncRestClient(synchronizerUnderTest);
 159         when(restClientMock.put(anyString(), anyString())).thenReturn(Mono.just("Ok"));
 160
 161         synchronizerUnderTest.run(RIC_1);
 162
 163         verify(a1ClientMock, times(1)).getPolicyTypeIdentities();
 164         verifyNoMoreInteractions(a1ClientMock);
 165
 166         verify(synchronizerUnderTest).run(RIC_1);
 167         verify(synchronizerUnderTest).createNotificationClient(SERVICE_1_CALLBACK_URL);
 168         verifyNoMoreInteractions(synchronizerUnderTest);
 169
 170         verify(restClientMock).put("", "Synchronization completed for:" + RIC_1_NAME);
 171         verifyNoMoreInteractions(restClientMock);
 172
 173         assertThat(policyTypes.size()).isEqualTo(1);
 174         assertThat(policies.size()).isZero();
 175         assertThat(RIC_1.getState()).isEqualTo(RicState.AVAILABLE);
 176     }
 177
 178     @Test
 179     void ricIdlePolicyTypeNotInRepo_thenSynchronizationWithTypeFromRic() throws Exception {
 180         RIC_1.setState(RicState.AVAILABLE);
 181
 182         setUpCreationOfA1Client();
 183         simulateRicWithOnePolicyType();
 184         String typeSchema = "schema";
 185         when(a1ClientMock.getPolicyTypeSchema(POLICY_TYPE_1_NAME)).thenReturn(Mono.just(typeSchema));
 186
 187         RicSynchronizationTask synchronizerUnderTest =
 188                 new RicSynchronizationTask(a1ClientFactoryMock, policyTypes, policies, services);
 189
 190         synchronizerUnderTest.run(RIC_1);
 191
 192         verify(a1ClientMock).getPolicyTypeIdentities();
 193         verifyNoMoreInteractions(a1ClientMock);
 194
 195         assertThat(policyTypes.size()).isEqualTo(1);
 196         assertThat(policyTypes.getType(POLICY_TYPE_1_NAME).schema()).isEqualTo(typeSchema);
 197         assertThat(policies.size()).isZero();
 198         assertThat(RIC_1.getState()).isEqualTo(RicState.AVAILABLE);
 199     }
 200
 201     @Test
 202     void ricIdleAndHavePolicies_thenSynchronizationWithRecreationOfPolicies() {
 203         RIC_1.setState(RicState.AVAILABLE);
 204
 205         Policy transientPolicy = createPolicy("transientPolicyId", true);
 206
 207         policies.put(transientPolicy);
 208         policies.put(POLICY_1);
 209
 210         setUpCreationOfA1Client();
 211         simulateRicWithNoPolicyTypes();
 212
 213         when(a1ClientMock.deleteAllPolicies()).thenReturn(Flux.just("OK"));
 214         when(a1ClientMock.putPolicy(any(Policy.class))).thenReturn(Mono.just("OK"));
 215
 216         RicSynchronizationTask synchronizerUnderTest =
 217                 new RicSynchronizationTask(a1ClientFactoryMock, policyTypes, policies, services);
 218
 219         synchronizerUnderTest.run(RIC_1);
 220
 221         verify(a1ClientMock).deleteAllPolicies();
 222         verify(a1ClientMock).putPolicy(POLICY_1);
 223         verifyNoMoreInteractions(a1ClientMock);
 224
 225         assertThat(policyTypes.size()).isZero();
 226         assertThat(policies.size()).isEqualTo(1); // The transient policy shall be deleted
 227         assertThat(RIC_1.getState()).isEqualTo(RicState.AVAILABLE);
 228     }
 229
 230     @Test
 231     void ricIdleAndErrorDeletingPoliciesFirstTime_thenSynchronizationWithDeletionOfPolicies() {
 232         RIC_1.setState(RicState.AVAILABLE);
 233
 234         policies.put(POLICY_1);
 235
 236         setUpCreationOfA1Client();
 237         simulateRicWithNoPolicyTypes();
 238
 239         when(a1ClientMock.deleteAllPolicies()) //
 240                 .thenReturn(Flux.error(new Exception("Exception"))) //
 241                 .thenReturn(Flux.just("OK"));
 242
 243         RicSynchronizationTask synchronizerUnderTest =
 244                 new RicSynchronizationTask(a1ClientFactoryMock, policyTypes, policies, services);
 245
 246         synchronizerUnderTest.run(RIC_1);
 247
 248         verify(a1ClientMock, times(2)).deleteAllPolicies();
 249         verifyNoMoreInteractions(a1ClientMock);
 250
 251         assertThat(policyTypes.size()).isZero();
 252         assertThat(policies.size()).isZero();
 253         assertThat(RIC_1.getState()).isEqualTo(RicState.AVAILABLE);
 254     }
 255
 256     @Test
 257     void ricIdleAndErrorDeletingPoliciesAllTheTime_thenSynchronizationWithFailedRecovery() {
 258         RIC_1.setState(RicState.AVAILABLE);
 259
 260         policies.put(POLICY_1);
 261
 262         setUpCreationOfA1Client();
 263         simulateRicWithNoPolicyTypes();
 264
 265         String originalErrorMessage = "Exception";
 266         when(a1ClientMock.deleteAllPolicies()).thenReturn(Flux.error(new Exception(originalErrorMessage)));
 267
 268         RicSynchronizationTask synchronizerUnderTest =
 269                 new RicSynchronizationTask(a1ClientFactoryMock, policyTypes, policies, services);
 270
 271         final ListAppender<ILoggingEvent> logAppender =
 272                 LoggingUtils.getLogListAppender(RicSynchronizationTask.class, WARN);
 273
 274         synchronizerUnderTest.run(RIC_1);
 275
 276         verifyCorrectLogMessage(0, logAppender,
 277                 "Synchronization failure for ric: " + RIC_1_NAME + ", reason: " + originalErrorMessage);
 278
 279         verify(a1ClientMock, times(2)).deleteAllPolicies();
 280         verifyNoMoreInteractions(a1ClientMock);
 281
 282         assertThat(policyTypes.size()).isZero();
 283         assertThat(policies.size()).isZero();
 284         assertThat(RIC_1.getState()).isEqualTo(RicState.UNAVAILABLE);
 285     }
 286
 287     @Test
 288     void ricIdlePolicyTypeInRepo_thenSynchronizationWithErrorOnServiceNotificationErrorLogged() {
 289         RIC_1.setState(RicState.AVAILABLE);
 290
 291         policyTypes.put(POLICY_TYPE_1);
 292
 293         services.put(SERVICE_1);
 294
 295         setUpCreationOfA1Client();
 296         simulateRicWithOnePolicyType();
 297
 298         final ListAppender<ILoggingEvent> logAppender =
 299                 LoggingUtils.getLogListAppender(RicSynchronizationTask.class, WARN);
 300
 301         RicSynchronizationTask synchronizerUnderTest =
 302                 spy(new RicSynchronizationTask(a1ClientFactoryMock, policyTypes, policies, services));
 303
 304         AsyncRestClient restClientMock = setUpCreationOfAsyncRestClient(synchronizerUnderTest);
 305         String originalErrorMessage = "Exception";
 306         when(restClientMock.put(anyString(), anyString())).thenReturn(Mono.error(new Exception(originalErrorMessage)));
 307
 308         synchronizerUnderTest.run(RIC_1);
 309
 310         ILoggingEvent loggingEvent = logAppender.list.get(0);
 311         assertThat(loggingEvent.getLevel()).isEqualTo(WARN);
 312         verifyCorrectLogMessage(0, logAppender,
 313                 "Service notification failed for service: " + SERVICE_1_NAME + ". Cause: " + originalErrorMessage);
 314     }
 315
 316     private void setUpCreationOfA1Client() {
 317         when(a1ClientFactoryMock.createA1Client(any(Ric.class))).thenReturn(Mono.just(a1ClientMock));
 318         doReturn(Flux.empty()).when(a1ClientMock).deleteAllPolicies();
 319     }
 320
 321     private AsyncRestClient setUpCreationOfAsyncRestClient(RicSynchronizationTask synchronizerUnderTest) {
 322         AsyncRestClient restClientMock = mock(AsyncRestClient.class);
 323         doReturn(restClientMock).when(synchronizerUnderTest).createNotificationClient(anyString());
 324         return restClientMock;
 325     }
 326
 327     private void simulateRicWithOnePolicyType() {
 328         when(a1ClientMock.getPolicyTypeIdentities()).thenReturn(Mono.just(Arrays.asList(POLICY_TYPE_1_NAME)));
 329     }
 330
 331     private void simulateRicWithNoPolicyTypes() {
 332         when(a1ClientMock.getPolicyTypeIdentities()).thenReturn(Mono.just(Collections.emptyList()));
 333     }
 334
 335     private void verifyCorrectLogMessage(int messageIndex, ListAppender<ILoggingEvent> logAppender,
 336             String expectedMessage) {
 337         ILoggingEvent loggingEvent = logAppender.list.get(messageIndex);
 338         assertThat(loggingEvent.getFormattedMessage()).isEqualTo(expectedMessage);
 339     }
 340 }