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