a1-policy-management/src/test/java/org/onap/ccsdk/oran/a1policymanagementservice/tasks/RicSynchronizationTaskTest.java

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