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