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