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

   1 /*-
   2  * ========================LICENSE_START=================================
   3  * ONAP : ccsdk oran
   4  * ======================================================================
   5  * Copyright (C) 2019-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.ERROR;
  24 import static ch.qos.logback.classic.Level.WARN;
  25 import static org.assertj.core.api.Assertions.assertThat;
  26 import static org.awaitility.Awaitility.await;
  27 import static org.mockito.ArgumentMatchers.any;
  28 import static org.mockito.Mockito.doNothing;
  29 import static org.mockito.Mockito.doReturn;
  30 import static org.mockito.Mockito.spy;
  31 import static org.mockito.Mockito.times;
  32 import static org.mockito.Mockito.verify;
  33 import static org.mockito.Mockito.when;
  34
  35 import ch.qos.logback.classic.spi.ILoggingEvent;
  36 import ch.qos.logback.core.read.ListAppender;
  37
  38 import com.google.common.base.Charsets;
  39 import com.google.common.io.Resources;
  40 import com.google.gson.JsonObject;
  41 import com.google.gson.JsonParser;
  42
  43 import java.io.IOException;
  44 import java.net.URL;
  45 import java.time.Duration;
  46 import java.time.Instant;
  47 import java.util.Arrays;
  48 import java.util.Collections;
  49 import java.util.HashMap;
  50 import java.util.Optional;
  51 import java.util.Properties;
  52 import java.util.Vector;
  53
  54 import org.junit.jupiter.api.Test;
  55 import org.junit.jupiter.api.extension.ExtendWith;
  56 import org.mockito.Mock;
  57 import org.mockito.Spy;
  58 import org.mockito.junit.jupiter.MockitoExtension;
  59 import org.onap.ccsdk.oran.a1policymanagementservice.clients.A1ClientFactory;
  60 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfig;
  61 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfig.RicConfigUpdate.Type;
  62 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfigParser;
  63 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfigParser.ConfigParserResult;
  64 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ConfigurationFile;
  65 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ImmutableConfigParserResult;
  66 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ImmutableRicConfig;
  67 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.RicConfig;
  68 import org.onap.ccsdk.oran.a1policymanagementservice.repository.ImmutablePolicy;
  69 import org.onap.ccsdk.oran.a1policymanagementservice.repository.ImmutablePolicyType;
  70 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policies;
  71 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policy;
  72 import org.onap.ccsdk.oran.a1policymanagementservice.repository.PolicyTypes;
  73 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Ric;
  74 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Rics;
  75 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Services;
  76 import org.onap.ccsdk.oran.a1policymanagementservice.utils.LoggingUtils;
  77 import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.api.CbsClient;
  78 import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.model.EnvProperties;
  79 import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.model.ImmutableEnvProperties;
  80
  81 import reactor.core.publisher.Mono;
  82 import reactor.test.StepVerifier;
  83
  84 @ExtendWith(MockitoExtension.class)
  85 class RefreshConfigTaskTest {
  86
  87     private static final boolean CONFIG_FILE_EXISTS = true;
  88     private static final boolean CONFIG_FILE_DOES_NOT_EXIST = false;
  89
  90     private RefreshConfigTask refreshTaskUnderTest;
  91
  92     @Spy
  93     ApplicationConfig appConfig;
  94
  95     @Mock
  96     CbsClient cbsClient;
  97
  98     @Mock
  99     ConfigurationFile configurationFileMock;
 100
 101     private static final String RIC_1_NAME = "ric1";
 102     private static final RicConfig CORRECT_RIC_CONIFG = ImmutableRicConfig.builder() //
 103             .ricId(RIC_1_NAME) //
 104             .baseUrl("http://localhost:8080/") //
 105             .managedElementIds(new Vector<String>(Arrays.asList("kista_1", "kista_2"))) //
 106             .controllerName("") //
 107             .build();
 108
 109     private static EnvProperties properties() {
 110         return ImmutableEnvProperties.builder() //
 111                 .consulHost("host") //
 112                 .consulPort(123) //
 113                 .cbsName("cbsName") //
 114                 .appName("appName") //
 115                 .build();
 116     }
 117
 118     private RefreshConfigTask createTestObject(boolean configFileExists) {
 119         return createTestObject(configFileExists, new Rics(), new Policies(), true);
 120     }
 121
 122     private RefreshConfigTask createTestObject(boolean configFileExists, Rics rics, Policies policies,
 123             boolean stubConfigFileExists) {
 124
 125         RefreshConfigTask obj = spy(new RefreshConfigTask(configurationFileMock, appConfig, rics, policies,
 126                 new Services(), new PolicyTypes(), new A1ClientFactory(appConfig)));
 127         if (stubConfigFileExists) {
 128             when(configurationFileMock.readFile()).thenReturn(Optional.empty());
 129         }
 130         return obj;
 131     }
 132
 133     @Test
 134     void whenTheConfigurationFits_thenConfiguredRicsArePutInRepository() throws Exception {
 135         refreshTaskUnderTest = this.createTestObject(CONFIG_FILE_EXISTS);
 136         refreshTaskUnderTest.systemEnvironment = new Properties();
 137         // When
 138         when(configurationFileMock.readFile()).thenReturn(getCorrectJson());
 139
 140         StepVerifier //
 141                 .create(refreshTaskUnderTest.createRefreshTask()) //
 142                 .expectSubscription() //
 143                 .expectNext(Type.ADDED) //
 144                 .expectNext(Type.ADDED) //
 145                 .thenCancel() //
 146                 .verify();
 147
 148         // Then
 149         verify(refreshTaskUnderTest).loadConfigurationFromFile();
 150
 151         verify(refreshTaskUnderTest, times(2)).runRicSynchronization(any(Ric.class));
 152
 153         Iterable<RicConfig> ricConfigs = appConfig.getRicConfigs();
 154         RicConfig ricConfig = ricConfigs.iterator().next();
 155         assertThat(ricConfigs).isNotNull();
 156         assertThat(ricConfig).isEqualTo(CORRECT_RIC_CONIFG);
 157     }
 158
 159     @Test
 160     void whenFileExistsButJsonIsIncorrect_thenNoRicsArePutInRepository() throws Exception {
 161         refreshTaskUnderTest = this.createTestObject(CONFIG_FILE_EXISTS);
 162
 163         // When
 164         when(configurationFileMock.readFile()).thenReturn(Optional.empty());
 165
 166         StepVerifier //
 167                 .create(refreshTaskUnderTest.createRefreshTask()) //
 168                 .expectSubscription() //
 169                 .expectNoEvent(Duration.ofMillis(100)) //
 170                 .thenCancel() //
 171                 .verify();
 172
 173         // Then
 174         verify(refreshTaskUnderTest).loadConfigurationFromFile();
 175         assertThat(appConfig.getRicConfigs()).isEmpty();
 176     }
 177
 178     @Test
 179     void whenPeriodicConfigRefreshNoConsul_thenErrorIsLogged() {
 180         refreshTaskUnderTest = this.createTestObject(CONFIG_FILE_DOES_NOT_EXIST);
 181         refreshTaskUnderTest.systemEnvironment = new Properties();
 182
 183         EnvProperties props = properties();
 184         doReturn(Mono.just(props)).when(refreshTaskUnderTest).getEnvironment(any());
 185
 186         doReturn(Mono.just(cbsClient)).when(refreshTaskUnderTest).createCbsClient(props);
 187         when(cbsClient.get(any())).thenReturn(Mono.error(new IOException()));
 188
 189         final ListAppender<ILoggingEvent> logAppender = LoggingUtils.getLogListAppender(RefreshConfigTask.class, WARN);
 190
 191         StepVerifier //
 192                 .create(refreshTaskUnderTest.createRefreshTask()) //
 193                 .expectSubscription() //
 194                 .expectNoEvent(Duration.ofMillis(1000)) //
 195                 .thenCancel() //
 196                 .verify();
 197
 198         await().until(() -> logAppender.list.size() > 0);
 199         assertThat(logAppender.list.get(0).getFormattedMessage())
 200                 .isEqualTo("Could not refresh application configuration. java.io.IOException");
 201     }
 202
 203     @Test
 204     void whenPeriodicConfigRefreshSuccess_thenNewConfigIsCreatedAndRepositoryUpdated() throws Exception {
 205         Rics rics = new Rics();
 206         Policies policies = new Policies();
 207         refreshTaskUnderTest = this.createTestObject(CONFIG_FILE_DOES_NOT_EXIST, rics, policies, false);
 208         refreshTaskUnderTest.systemEnvironment = new Properties();
 209
 210         RicConfig changedRicConfig = getRicConfig(RIC_1_NAME);
 211         rics.put(new Ric(changedRicConfig));
 212         RicConfig removedRicConfig = getRicConfig("removed");
 213         Ric removedRic = new Ric(removedRicConfig);
 214         rics.put(removedRic);
 215         appConfig.setConfiguration(configParserResult(changedRicConfig, removedRicConfig));
 216
 217         Policy policy = getPolicy(removedRic);
 218         policies.put(policy);
 219
 220         EnvProperties props = properties();
 221         doReturn(Mono.just(props)).when(refreshTaskUnderTest).getEnvironment(any());
 222         doReturn(Mono.just(cbsClient)).when(refreshTaskUnderTest).createCbsClient(props);
 223
 224         JsonObject configAsJson = getCorrectJson().get();
 225         String newBaseUrl = "newBaseUrl";
 226         modifyTheRicConfiguration(configAsJson, newBaseUrl);
 227         when(cbsClient.get(any())).thenReturn(Mono.just(configAsJson));
 228         doNothing().when(refreshTaskUnderTest).runRicSynchronization(any(Ric.class));
 229
 230         StepVerifier //
 231                 .create(refreshTaskUnderTest.createRefreshTask()) //
 232                 .expectSubscription() //
 233                 .expectNext(Type.CHANGED) //
 234                 .expectNext(Type.ADDED) //
 235                 .expectNext(Type.REMOVED) //
 236                 .thenCancel() //
 237                 .verify();
 238
 239         assertThat(appConfig.getRicConfigs()).hasSize(2);
 240         assertThat(appConfig.getRic(RIC_1_NAME).baseUrl()).isEqualTo(newBaseUrl);
 241         String ric2Name = "ric2";
 242         assertThat(appConfig.getRic(ric2Name)).isNotNull();
 243
 244         assertThat(rics.size()).isEqualTo(2);
 245         assertThat(rics.get(RIC_1_NAME).getConfig().baseUrl()).isEqualTo(newBaseUrl);
 246         assertThat(rics.get(ric2Name)).isNotNull();
 247
 248         assertThat(policies.size()).isZero();
 249     }
 250
 251     @Test
 252     void whenPeriodicConfigRefreshInvalidJson_thenErrorIsLogged() throws Exception {
 253         Rics rics = new Rics();
 254         Policies policies = new Policies();
 255         refreshTaskUnderTest = this.createTestObject(CONFIG_FILE_DOES_NOT_EXIST, rics, policies, false);
 256         refreshTaskUnderTest.systemEnvironment = new Properties();
 257
 258         appConfig.setConfiguration(configParserResult());
 259
 260         EnvProperties props = properties();
 261         doReturn(Mono.just(props)).when(refreshTaskUnderTest).getEnvironment(any());
 262         doReturn(Mono.just(cbsClient)).when(refreshTaskUnderTest).createCbsClient(props);
 263
 264         JsonObject emptyJsonObject = new JsonObject();
 265         when(cbsClient.get(any())).thenReturn(Mono.just(emptyJsonObject));
 266
 267         final ListAppender<ILoggingEvent> logAppender = LoggingUtils.getLogListAppender(RefreshConfigTask.class, ERROR);
 268
 269         StepVerifier //
 270                 .create(refreshTaskUnderTest.createRefreshTask()) //
 271                 .expectSubscription() //
 272                 .expectNoEvent(Duration.ofMillis(1000)) //
 273                 .thenCancel() //
 274                 .verify();
 275
 276         await().until(() -> logAppender.list.size() > 0);
 277         assertThat(logAppender.list.get(0).getFormattedMessage()).startsWith(
 278                 "Could not parse configuration org.onap.ccsdk.oran.a1policymanagementservice.exceptions.ServiceException: ");
 279     }
 280
 281     private RicConfig getRicConfig(String name) {
 282         RicConfig ricConfig = ImmutableRicConfig.builder() //
 283                 .ricId(name) //
 284                 .baseUrl("url") //
 285                 .managedElementIds(Collections.emptyList()) //
 286                 .controllerName("controllerName") //
 287                 .build();
 288         return ricConfig;
 289     }
 290
 291     private Policy getPolicy(Ric ric) {
 292         ImmutablePolicyType type = ImmutablePolicyType.builder() //
 293                 .id("type") //
 294                 .schema("{}") //
 295                 .build();
 296         Policy policy = ImmutablePolicy.builder() //
 297                 .id("id") //
 298                 .type(type) //
 299                 .lastModified(Instant.now()) //
 300                 .ric(ric) //
 301                 .json("{}") //
 302                 .ownerServiceId("ownerServiceId") //
 303                 .isTransient(false) //
 304                 .statusNotificationUri("/policy_status?id=XXX") //
 305                 .build();
 306         return policy;
 307     }
 308
 309     ConfigParserResult configParserResult(RicConfig... rics) {
 310         return ImmutableConfigParserResult.builder() //
 311                 .ricConfigs(Arrays.asList(rics)) //
 312                 .dmaapConsumerTopicUrl("") //
 313                 .dmaapProducerTopicUrl("") //
 314                 .controllerConfigs(new HashMap<>()) //
 315                 .build();
 316     }
 317
 318     private void modifyTheRicConfiguration(JsonObject configAsJson, String newBaseUrl) {
 319         ((JsonObject) configAsJson.getAsJsonObject("config") //
 320                 .getAsJsonArray("ric").get(0)) //
 321                         .addProperty("baseUrl", newBaseUrl);
 322     }
 323
 324     private static Optional<JsonObject> getCorrectJson() throws IOException {
 325         URL url = ApplicationConfigParser.class.getClassLoader().getResource("test_application_configuration.json");
 326         String string = Resources.toString(url, Charsets.UTF_8);
 327         return Optional.of(JsonParser.parseString(string).getAsJsonObject());
 328     }
 329 }