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 stop_thenTaskIsDisposed() throws Exception {
 148         refreshTaskUnderTest = this.createTestObject(CONFIG_FILE_DOES_NOT_EXIST, null, null, false);
 149         refreshTaskUnderTest.systemEnvironment = new Properties();
 150
 151         refreshTaskUnderTest.start();
 152         refreshTaskUnderTest.stop();
 153
 154         assertThat(refreshTaskUnderTest.getRefreshTask().isDisposed()).as("Refresh task is disposed").isTrue();
 155     }
 156
 157     @Test
 158     void whenTheConfigurationFits_thenConfiguredRicsArePutInRepository() throws Exception {
 159         refreshTaskUnderTest = this.createTestObject(CONFIG_FILE_EXISTS);
 160         refreshTaskUnderTest.systemEnvironment = new Properties();
 161         // When
 162         doReturn(getCorrectJson()).when(refreshTaskUnderTest).createInputStream(any());
 163         doReturn("fileName").when(appConfig).getLocalConfigurationFilePath();
 164
 165         StepVerifier //
 166                 .create(refreshTaskUnderTest.createRefreshTask()) //
 167                 .expectSubscription() //
 168                 .expectNext(Type.ADDED) //
 169                 .expectNext(Type.ADDED) //
 170                 .thenCancel() //
 171                 .verify();
 172
 173         // Then
 174         verify(refreshTaskUnderTest).loadConfigurationFromFile();
 175
 176         verify(refreshTaskUnderTest, times(2)).runRicSynchronization(any(Ric.class));
 177
 178         Iterable<RicConfig> ricConfigs = appConfig.getRicConfigs();
 179         RicConfig ricConfig = ricConfigs.iterator().next();
 180         assertThat(ricConfigs).isNotNull();
 181         assertThat(ricConfig).isEqualTo(CORRECT_RIC_CONIFG);
 182     }
 183
 184     @Test
 185     void whenFileExistsButJsonIsIncorrect_thenNoRicsArePutInRepositoryAndErrorIsLogged() throws Exception {
 186         refreshTaskUnderTest = this.createTestObject(CONFIG_FILE_EXISTS);
 187         refreshTaskUnderTest.systemEnvironment = new Properties();
 188
 189         // When
 190         final String JUNK_JSON = "{\"junk }";
 191         doReturn(getJsonSteam(JUNK_JSON)).when(refreshTaskUnderTest).createInputStream(any());
 192         doReturn("fileName").when(appConfig).getLocalConfigurationFilePath();
 193
 194         final ListAppender<ILoggingEvent> logAppender = LoggingUtils.getLogListAppender(RefreshConfigTask.class, ERROR);
 195
 196         StepVerifier //
 197                 .create(refreshTaskUnderTest.createRefreshTask()) //
 198                 .expectSubscription() //
 199                 .expectNoEvent(Duration.ofMillis(100)) //
 200                 .thenCancel() //
 201                 .verify();
 202
 203         // Then
 204         verify(refreshTaskUnderTest).loadConfigurationFromFile();
 205         assertThat(appConfig.getRicConfigs()).isEmpty();
 206
 207         await().until(() -> logAppender.list.size() > 0);
 208         assertThat(logAppender.list.get(0).getFormattedMessage())
 209                 .startsWith("Local configuration file not loaded: fileName, ");
 210     }
 211
 212     @Test
 213     void whenPeriodicConfigRefreshNoConsul_thenErrorIsLogged() {
 214         refreshTaskUnderTest = this.createTestObject(CONFIG_FILE_DOES_NOT_EXIST);
 215         refreshTaskUnderTest.systemEnvironment = new Properties();
 216
 217         EnvProperties props = properties();
 218         doReturn(Mono.just(props)).when(refreshTaskUnderTest).getEnvironment(any());
 219
 220         doReturn(Mono.just(cbsClient)).when(refreshTaskUnderTest).createCbsClient(props);
 221         when(cbsClient.get(any())).thenReturn(Mono.error(new IOException()));
 222
 223         final ListAppender<ILoggingEvent> logAppender = LoggingUtils.getLogListAppender(RefreshConfigTask.class, WARN);
 224
 225         StepVerifier //
 226                 .create(refreshTaskUnderTest.createRefreshTask()) //
 227                 .expectSubscription() //
 228                 .expectNoEvent(Duration.ofMillis(1000)) //
 229                 .thenCancel() //
 230                 .verify();
 231
 232         await().until(() -> logAppender.list.size() > 0);
 233         assertThat(logAppender.list.get(0).getFormattedMessage())
 234                 .isEqualTo("Could not refresh application configuration. java.io.IOException");
 235     }
 236
 237     @Test
 238     void whenPeriodicConfigRefreshSuccess_thenNewConfigIsCreatedAndRepositoryUpdated() throws Exception {
 239         Rics rics = new Rics();
 240         Policies policies = new Policies();
 241         refreshTaskUnderTest = this.createTestObject(CONFIG_FILE_DOES_NOT_EXIST, rics, policies, false);
 242         refreshTaskUnderTest.systemEnvironment = new Properties();
 243
 244         RicConfig changedRicConfig = getRicConfig(RIC_1_NAME);
 245         rics.put(new Ric(changedRicConfig));
 246         RicConfig removedRicConfig = getRicConfig("removed");
 247         Ric removedRic = new Ric(removedRicConfig);
 248         rics.put(removedRic);
 249         appConfig.setConfiguration(configParserResult(changedRicConfig, removedRicConfig));
 250
 251         Policy policy = getPolicy(removedRic);
 252         policies.put(policy);
 253
 254         EnvProperties props = properties();
 255         doReturn(Mono.just(props)).when(refreshTaskUnderTest).getEnvironment(any());
 256         doReturn(Mono.just(cbsClient)).when(refreshTaskUnderTest).createCbsClient(props);
 257
 258         JsonObject configAsJson = getJsonRootObject(getCorrectJson());
 259         String newBaseUrl = "newBaseUrl";
 260         modifyTheRicConfiguration(configAsJson, newBaseUrl);
 261         when(cbsClient.get(any())).thenReturn(Mono.just(configAsJson));
 262         doNothing().when(refreshTaskUnderTest).runRicSynchronization(any(Ric.class));
 263
 264         StepVerifier //
 265                 .create(refreshTaskUnderTest.createRefreshTask()) //
 266                 .expectSubscription() //
 267                 .expectNext(Type.CHANGED) //
 268                 .expectNext(Type.ADDED) //
 269                 .expectNext(Type.REMOVED) //
 270                 .thenCancel() //
 271                 .verify();
 272
 273         assertThat(appConfig.getRicConfigs()).hasSize(2);
 274         assertThat(appConfig.getRic(RIC_1_NAME).baseUrl()).isEqualTo(newBaseUrl);
 275         String ric2Name = "ric2";
 276         assertThat(appConfig.getRic(ric2Name)).isNotNull();
 277
 278         assertThat(rics.size()).isEqualTo(2);
 279         assertThat(rics.get(RIC_1_NAME).getConfig().baseUrl()).isEqualTo(newBaseUrl);
 280         assertThat(rics.get(ric2Name)).isNotNull();
 281
 282         assertThat(policies.size()).isZero();
 283     }
 284
 285     @Test
 286     void whenPeriodicConfigRefreshInvalidJson_thenErrorIsLogged() throws Exception {
 287         Rics rics = new Rics();
 288         Policies policies = new Policies();
 289         refreshTaskUnderTest = this.createTestObject(CONFIG_FILE_DOES_NOT_EXIST, rics, policies, false);
 290         refreshTaskUnderTest.systemEnvironment = new Properties();
 291
 292         appConfig.setConfiguration(configParserResult());
 293
 294         EnvProperties props = properties();
 295         doReturn(Mono.just(props)).when(refreshTaskUnderTest).getEnvironment(any());
 296         doReturn(Mono.just(cbsClient)).when(refreshTaskUnderTest).createCbsClient(props);
 297
 298         JsonObject emptyJsonObject = new JsonObject();
 299         when(cbsClient.get(any())).thenReturn(Mono.just(emptyJsonObject));
 300
 301         final ListAppender<ILoggingEvent> logAppender = LoggingUtils.getLogListAppender(RefreshConfigTask.class, ERROR);
 302
 303         StepVerifier //
 304                 .create(refreshTaskUnderTest.createRefreshTask()) //
 305                 .expectSubscription() //
 306                 .expectNoEvent(Duration.ofMillis(1000)) //
 307                 .thenCancel() //
 308                 .verify();
 309
 310         await().until(() -> logAppender.list.size() > 0);
 311         assertThat(logAppender.list.get(0).getFormattedMessage()).startsWith(
 312                 "Could not parse configuration org.onap.ccsdk.oran.a1policymanagementservice.exceptions.ServiceException: ");
 313     }
 314
 315     private RicConfig getRicConfig(String name) {
 316         RicConfig ricConfig = ImmutableRicConfig.builder() //
 317                 .ricId(name) //
 318                 .baseUrl("url") //
 319                 .managedElementIds(Collections.emptyList()) //
 320                 .controllerName("controllerName") //
 321                 .build();
 322         return ricConfig;
 323     }
 324
 325     private Policy getPolicy(Ric ric) {
 326         ImmutablePolicyType type = ImmutablePolicyType.builder() //
 327                 .id("type") //
 328                 .schema("{}") //
 329                 .build();
 330         Policy policy = ImmutablePolicy.builder() //
 331                 .id("id") //
 332                 .type(type) //
 333                 .lastModified(Instant.now()) //
 334                 .ric(ric) //
 335                 .json("{}") //
 336                 .ownerServiceId("ownerServiceId") //
 337                 .isTransient(false) //
 338                 .build();
 339         return policy;
 340     }
 341
 342     ConfigParserResult configParserResult(RicConfig... rics) {
 343         return ImmutableConfigParserResult.builder() //
 344                 .ricConfigs(Arrays.asList(rics)) //
 345                 .dmaapConsumerTopicUrl("") //
 346                 .dmaapProducerTopicUrl("") //
 347                 .controllerConfigs(new HashMap<>()) //
 348                 .build();
 349     }
 350
 351     private void modifyTheRicConfiguration(JsonObject configAsJson, String newBaseUrl) {
 352         ((JsonObject) configAsJson.getAsJsonObject("config") //
 353                 .getAsJsonArray("ric").get(0)) //
 354                         .addProperty("baseUrl", newBaseUrl);
 355     }
 356
 357     private JsonObject getJsonRootObject(InputStream inStream)
 358             throws JsonIOException, JsonSyntaxException, IOException {
 359         JsonObject rootObject = JsonParser.parseReader(new InputStreamReader(inStream)).getAsJsonObject();
 360         return rootObject;
 361     }
 362
 363     private static InputStream getCorrectJson() throws IOException {
 364         URL url = ApplicationConfigParser.class.getClassLoader().getResource("test_application_configuration.json");
 365         String string = Resources.toString(url, Charsets.UTF_8);
 366         return new ByteArrayInputStream((string.getBytes(StandardCharsets.UTF_8)));
 367     }
 368
 369     private static InputStream getJsonSteam(String json) {
 370         return new ByteArrayInputStream((json.getBytes(StandardCharsets.UTF_8)));
 371     }
 372 }