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.JsonIOException;
  41 import com.google.gson.JsonObject;
  42 import com.google.gson.JsonParser;
  43 import com.google.gson.JsonSyntaxException;
  44
  45 import java.io.ByteArrayInputStream;
  46 import java.io.IOException;
  47 import java.io.InputStream;
  48 import java.io.InputStreamReader;
  49 import java.net.URL;
  50 import java.nio.charset.StandardCharsets;
  51 import java.time.Duration;
  52 import java.time.Instant;
  53 import java.util.Arrays;
  54 import java.util.Collections;
  55 import java.util.HashMap;
  56 import java.util.Properties;
  57 import java.util.Vector;
  58
  59 import org.junit.jupiter.api.Test;
  60 import org.junit.jupiter.api.extension.ExtendWith;
  61 import org.mockito.Mock;
  62 import org.mockito.Spy;
  63 import org.mockito.junit.jupiter.MockitoExtension;
  64 import org.onap.ccsdk.oran.a1policymanagementservice.clients.A1ClientFactory;
  65 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfig;
  66 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfig.RicConfigUpdate.Type;
  67 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfigParser;
  68 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfigParser.ConfigParserResult;
  69 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ImmutableConfigParserResult;
  70 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ImmutableRicConfig;
  71 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.RicConfig;
  72 import org.onap.ccsdk.oran.a1policymanagementservice.repository.ImmutablePolicy;
  73 import org.onap.ccsdk.oran.a1policymanagementservice.repository.ImmutablePolicyType;
  74 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policies;
  75 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policy;
  76 import org.onap.ccsdk.oran.a1policymanagementservice.repository.PolicyTypes;
  77 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Ric;
  78 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Rics;
  79 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Services;
  80 import org.onap.ccsdk.oran.a1policymanagementservice.utils.LoggingUtils;
  81 import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.api.CbsClient;
  82 import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.model.EnvProperties;
  83 import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.model.ImmutableEnvProperties;
  84
  85 import reactor.core.publisher.Flux;
  86 import reactor.core.publisher.Mono;
  87 import reactor.test.StepVerifier;
  88
  89 @ExtendWith(MockitoExtension.class)
  90 class RefreshConfigTaskTest {
  91
  92     private static final boolean CONFIG_FILE_EXISTS = true;
  93     private static final boolean CONFIG_FILE_DOES_NOT_EXIST = false;
  94
  95     private RefreshConfigTask refreshTaskUnderTest;
  96
  97     @Spy
  98     ApplicationConfig appConfig;
  99
 100     @Mock
 101     CbsClient cbsClient;
 102
 103     private static final String RIC_1_NAME = "ric1";
 104     private static final RicConfig CORRECT_RIC_CONIFG = ImmutableRicConfig.builder() //
 105         .ricId(RIC_1_NAME) //
 106         .baseUrl("http://localhost:8080/") //
 107         .managedElementIds(new Vector<String>(Arrays.asList("kista_1", "kista_2"))) //
 108         .controllerName("") //
 109         .build();
 110
 111     private static EnvProperties properties() {
 112         return ImmutableEnvProperties.builder() //
 113             .consulHost("host") //
 114             .consulPort(123) //
 115             .cbsName("cbsName") //
 116             .appName("appName") //
 117             .build();
 118     }
 119
 120     private RefreshConfigTask createTestObject(boolean configFileExists) {
 121         return createTestObject(configFileExists, new Rics(), new Policies(), true);
 122     }
 123
 124     private RefreshConfigTask createTestObject(boolean configFileExists, Rics rics, Policies policies,
 125         boolean stubConfigFileExists) {
 126         RefreshConfigTask obj = spy(new RefreshConfigTask(appConfig, rics, policies, new Services(), new PolicyTypes(),
 127             new A1ClientFactory(appConfig)));
 128         if (stubConfigFileExists) {
 129             doReturn(configFileExists).when(obj).fileExists(any());
 130         }
 131         return obj;
 132     }
 133
 134     @Test
 135     void startWithStubbedRefresh_thenTerminationLogged() {
 136         refreshTaskUnderTest = this.createTestObject(CONFIG_FILE_DOES_NOT_EXIST, null, null, false);
 137         doReturn(Flux.empty()).when(refreshTaskUnderTest).createRefreshTask();
 138
 139         final ListAppender<ILoggingEvent> logAppender = LoggingUtils.getLogListAppender(RefreshConfigTask.class, ERROR);
 140
 141         refreshTaskUnderTest.start();
 142
 143         assertThat(logAppender.list.get(0).getFormattedMessage()).isEqualTo("Configuration refresh terminated");
 144     }
 145
 146     @Test
 147     void startWithStubbedRefreshReturnError_thenErrorAndTerminationLogged() {
 148         refreshTaskUnderTest = this.createTestObject(CONFIG_FILE_DOES_NOT_EXIST, null, null, false);
 149         String errorMessage = "Error";
 150         doReturn(Flux.error(new Exception(errorMessage))).when(refreshTaskUnderTest).createRefreshTask();
 151
 152         final ListAppender<ILoggingEvent> logAppender = LoggingUtils.getLogListAppender(RefreshConfigTask.class, ERROR);
 153
 154         refreshTaskUnderTest.start();
 155
 156         ILoggingEvent event = logAppender.list.get(0);
 157         assertThat(event.getFormattedMessage())
 158             .isEqualTo("Configuration refresh terminated due to exception java.lang.Exception: " + errorMessage);
 159     }
 160
 161     @Test
 162     void stop_thenTaskIsDisposed() throws Exception {
 163         refreshTaskUnderTest = this.createTestObject(CONFIG_FILE_DOES_NOT_EXIST, null, null, false);
 164         refreshTaskUnderTest.systemEnvironment = new Properties();
 165
 166         refreshTaskUnderTest.start();
 167         refreshTaskUnderTest.stop();
 168
 169         assertThat(refreshTaskUnderTest.getRefreshTask().isDisposed()).as("Refresh task is disposed").isTrue();
 170     }
 171
 172     @Test
 173     void whenTheConfigurationFits_thenConfiguredRicsArePutInRepository() throws Exception {
 174         refreshTaskUnderTest = this.createTestObject(CONFIG_FILE_EXISTS);
 175         refreshTaskUnderTest.systemEnvironment = new Properties();
 176         // When
 177         doReturn(getCorrectJson()).when(refreshTaskUnderTest).createInputStream(any());
 178         doReturn("fileName").when(appConfig).getLocalConfigurationFilePath();
 179
 180         StepVerifier //
 181             .create(refreshTaskUnderTest.createRefreshTask()) //
 182             .expectSubscription() //
 183             .expectNext(Type.ADDED) //
 184             .expectNext(Type.ADDED) //
 185             .thenCancel() //
 186             .verify();
 187
 188         // Then
 189         verify(refreshTaskUnderTest).loadConfigurationFromFile();
 190
 191         verify(refreshTaskUnderTest, times(2)).runRicSynchronization(any(Ric.class));
 192
 193         Iterable<RicConfig> ricConfigs = appConfig.getRicConfigs();
 194         RicConfig ricConfig = ricConfigs.iterator().next();
 195         assertThat(ricConfigs).isNotNull();
 196         assertThat(ricConfig).isEqualTo(CORRECT_RIC_CONIFG);
 197     }
 198
 199     @Test
 200     void whenFileExistsButJsonIsIncorrect_thenNoRicsArePutInRepositoryAndErrorIsLogged() throws Exception {
 201         refreshTaskUnderTest = this.createTestObject(CONFIG_FILE_EXISTS);
 202         refreshTaskUnderTest.systemEnvironment = new Properties();
 203
 204         // When
 205         doReturn(getIncorrectJson()).when(refreshTaskUnderTest).createInputStream(any());
 206         doReturn("fileName").when(appConfig).getLocalConfigurationFilePath();
 207
 208         final ListAppender<ILoggingEvent> logAppender = LoggingUtils.getLogListAppender(RefreshConfigTask.class, ERROR);
 209
 210         StepVerifier //
 211             .create(refreshTaskUnderTest.createRefreshTask()) //
 212             .expectSubscription() //
 213             .expectNoEvent(Duration.ofMillis(100)) //
 214             .thenCancel() //
 215             .verify();
 216
 217         // Then
 218         verify(refreshTaskUnderTest).loadConfigurationFromFile();
 219         assertThat(appConfig.getRicConfigs()).isEmpty();
 220
 221         await().until(() -> logAppender.list.size() > 0);
 222         assertThat(logAppender.list.get(0).getFormattedMessage())
 223             .startsWith("Local configuration file not loaded: fileName, ");
 224     }
 225
 226     @Test
 227     void whenPeriodicConfigRefreshNoConsul_thenErrorIsLogged() {
 228         refreshTaskUnderTest = this.createTestObject(CONFIG_FILE_DOES_NOT_EXIST);
 229         refreshTaskUnderTest.systemEnvironment = new Properties();
 230
 231         EnvProperties props = properties();
 232         doReturn(Mono.just(props)).when(refreshTaskUnderTest).getEnvironment(any());
 233
 234         doReturn(Mono.just(cbsClient)).when(refreshTaskUnderTest).createCbsClient(props);
 235         when(cbsClient.get(any())).thenReturn(Mono.error(new IOException()));
 236
 237         final ListAppender<ILoggingEvent> logAppender = LoggingUtils.getLogListAppender(RefreshConfigTask.class, WARN);
 238
 239         StepVerifier //
 240             .create(refreshTaskUnderTest.createRefreshTask()) //
 241             .expectSubscription() //
 242             .expectNoEvent(Duration.ofMillis(1000)) //
 243             .thenCancel() //
 244             .verify();
 245
 246         await().until(() -> logAppender.list.size() > 0);
 247         assertThat(logAppender.list.get(0).getFormattedMessage())
 248             .isEqualTo("Could not refresh application configuration. java.io.IOException");
 249     }
 250
 251     @Test
 252     void whenPeriodicConfigRefreshSuccess_thenNewConfigIsCreatedAndRepositoryUpdated() 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         RicConfig changedRicConfig = getRicConfig(RIC_1_NAME);
 259         rics.put(new Ric(changedRicConfig));
 260         RicConfig removedRicConfig = getRicConfig("removed");
 261         Ric removedRic = new Ric(removedRicConfig);
 262         rics.put(removedRic);
 263         appConfig.setConfiguration(configParserResult(changedRicConfig, removedRicConfig));
 264
 265         Policy policy = getPolicy(removedRic);
 266         policies.put(policy);
 267
 268         EnvProperties props = properties();
 269         doReturn(Mono.just(props)).when(refreshTaskUnderTest).getEnvironment(any());
 270         doReturn(Mono.just(cbsClient)).when(refreshTaskUnderTest).createCbsClient(props);
 271
 272         JsonObject configAsJson = getJsonRootObject(true);
 273         String newBaseUrl = "newBaseUrl";
 274         modifyTheRicConfiguration(configAsJson, newBaseUrl);
 275         when(cbsClient.get(any())).thenReturn(Mono.just(configAsJson));
 276         doNothing().when(refreshTaskUnderTest).runRicSynchronization(any(Ric.class));
 277
 278         StepVerifier //
 279             .create(refreshTaskUnderTest.createRefreshTask()) //
 280             .expectSubscription() //
 281             .expectNext(Type.CHANGED) //
 282             .expectNext(Type.ADDED) //
 283             .expectNext(Type.REMOVED) //
 284             .thenCancel() //
 285             .verify();
 286
 287         assertThat(appConfig.getRicConfigs()).hasSize(2);
 288         assertThat(appConfig.getRic(RIC_1_NAME).baseUrl()).isEqualTo(newBaseUrl);
 289         String ric2Name = "ric2";
 290         assertThat(appConfig.getRic(ric2Name)).isNotNull();
 291
 292         assertThat(rics.size()).isEqualTo(2);
 293         assertThat(rics.get(RIC_1_NAME).getConfig().baseUrl()).isEqualTo(newBaseUrl);
 294         assertThat(rics.get(ric2Name)).isNotNull();
 295
 296         assertThat(policies.size()).isZero();
 297     }
 298
 299     @Test
 300     void whenPeriodicConfigRefreshInvalidJson_thenErrorIsLogged() throws Exception {
 301         Rics rics = new Rics();
 302         Policies policies = new Policies();
 303         refreshTaskUnderTest = this.createTestObject(CONFIG_FILE_DOES_NOT_EXIST, rics, policies, false);
 304         refreshTaskUnderTest.systemEnvironment = new Properties();
 305
 306         appConfig.setConfiguration(configParserResult());
 307
 308         EnvProperties props = properties();
 309         doReturn(Mono.just(props)).when(refreshTaskUnderTest).getEnvironment(any());
 310         doReturn(Mono.just(cbsClient)).when(refreshTaskUnderTest).createCbsClient(props);
 311
 312         JsonObject configAsJson = getJsonRootObject(false);
 313         when(cbsClient.get(any())).thenReturn(Mono.just(configAsJson));
 314
 315         final ListAppender<ILoggingEvent> logAppender = LoggingUtils.getLogListAppender(RefreshConfigTask.class, ERROR);
 316
 317         StepVerifier //
 318             .create(refreshTaskUnderTest.createRefreshTask()) //
 319             .expectSubscription() //
 320             .expectNoEvent(Duration.ofMillis(1000)) //
 321             .thenCancel() //
 322             .verify();
 323
 324         await().until(() -> logAppender.list.size() > 0);
 325         assertThat(logAppender.list.get(0).getFormattedMessage()).startsWith(
 326             "Could not parse configuration org.onap.ccsdk.oran.a1policymanagementservice.exceptions.ServiceException: ");
 327     }
 328
 329     private RicConfig getRicConfig(String name) {
 330         RicConfig ricConfig = ImmutableRicConfig.builder() //
 331             .ricId(name) //
 332             .baseUrl("url") //
 333             .managedElementIds(Collections.emptyList()) //
 334             .controllerName("controllerName") //
 335             .build();
 336         return ricConfig;
 337     }
 338
 339     private Policy getPolicy(Ric ric) {
 340         ImmutablePolicyType type = ImmutablePolicyType.builder() //
 341             .id("type") //
 342             .schema("{}") //
 343             .build();
 344         Policy policy = ImmutablePolicy.builder() //
 345             .id("id") //
 346             .type(type) //
 347             .lastModified(Instant.now()) //
 348             .ric(ric) //
 349             .json("{}") //
 350             .ownerServiceId("ownerServiceId") //
 351             .isTransient(false) //
 352             .build();
 353         return policy;
 354     }
 355
 356     ConfigParserResult configParserResult(RicConfig... rics) {
 357         return ImmutableConfigParserResult.builder() //
 358             .ricConfigs(Arrays.asList(rics)) //
 359             .dmaapConsumerTopicUrl("") //
 360             .dmaapProducerTopicUrl("") //
 361             .controllerConfigs(new HashMap<>()) //
 362             .build();
 363     }
 364
 365     private void modifyTheRicConfiguration(JsonObject configAsJson, String newBaseUrl) {
 366         ((JsonObject) configAsJson.getAsJsonObject("config") //
 367             .getAsJsonArray("ric").get(0)) //
 368                 .addProperty("baseUrl", newBaseUrl);
 369     }
 370
 371     private JsonObject getJsonRootObject(boolean valid) throws JsonIOException, JsonSyntaxException, IOException {
 372         JsonObject rootObject = JsonParser
 373             .parseReader(new InputStreamReader(valid ? getCorrectJson() : getIncorrectJson())).getAsJsonObject();
 374         return rootObject;
 375     }
 376
 377     private static InputStream getCorrectJson() throws IOException {
 378         URL url = ApplicationConfigParser.class.getClassLoader().getResource("test_application_configuration.json");
 379         String string = Resources.toString(url, Charsets.UTF_8);
 380         return new ByteArrayInputStream((string.getBytes(StandardCharsets.UTF_8)));
 381     }
 382
 383     private static InputStream getIncorrectJson() {
 384         String string = "{}"; //
 385         return new ByteArrayInputStream((string.getBytes(StandardCharsets.UTF_8)));
 386     }
 387 }