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