policy-agent/src/test/java/org/oransc/policyagent/tasks/RefreshConfigTaskTest.java

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