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.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.JsonObject;
  40 import com.google.gson.JsonParser;
  41
  42 import java.io.IOException;
  43 import java.net.URL;
  44 import java.time.Duration;
  45 import java.time.Instant;
  46 import java.util.Arrays;
  47 import java.util.Collections;
  48 import java.util.HashMap;
  49 import java.util.Optional;
  50 import java.util.Properties;
  51 import java.util.Vector;
  52
  53 import org.junit.jupiter.api.Test;
  54 import org.junit.jupiter.api.extension.ExtendWith;
  55 import org.mockito.Mock;
  56 import org.mockito.Spy;
  57 import org.mockito.junit.jupiter.MockitoExtension;
  58 import org.onap.ccsdk.oran.a1policymanagementservice.clients.A1ClientFactory;
  59 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfig;
  60 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfig.RicConfigUpdate.Type;
  61 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfigParser;
  62 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfigParser.ConfigParserResult;
  63 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ConfigurationFile;
  64 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ImmutableConfigParserResult;
  65 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ImmutableRicConfig;
  66 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.RicConfig;
  67 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policies;
  68 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policy;
  69 import org.onap.ccsdk.oran.a1policymanagementservice.repository.PolicyType;
  70 import org.onap.ccsdk.oran.a1policymanagementservice.repository.PolicyTypes;
  71 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Ric;
  72 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Rics;
  73 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Services;
  74 import org.onap.ccsdk.oran.a1policymanagementservice.utils.LoggingUtils;
  75 import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.api.CbsClient;
  76 import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.model.EnvProperties;
  77 import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.model.ImmutableEnvProperties;
  78
  79 import reactor.core.publisher.Mono;
  80 import reactor.test.StepVerifier;
  81
  82 @ExtendWith(MockitoExtension.class)
  83 class RefreshConfigTaskTest {
  84
  85     private static final boolean CONFIG_FILE_EXISTS = true;
  86     private static final boolean CONFIG_FILE_DOES_NOT_EXIST = false;
  87
  88     private RefreshConfigTask refreshTaskUnderTest;
  89
  90     @Spy
  91     ApplicationConfig appConfig;
  92
  93     @Mock
  94     CbsClient cbsClient;
  95
  96     @Mock
  97     ConfigurationFile configurationFileMock;
  98
  99     private static final String RIC_1_NAME = "ric1";
 100     private static final RicConfig CORRECT_RIC_CONIFG = ImmutableRicConfig.builder() //
 101             .ricId(RIC_1_NAME) //
 102             .baseUrl("http://localhost:8080/") //
 103             .managedElementIds(new Vector<String>(Arrays.asList("kista_1", "kista_2"))) //
 104             .controllerName("") //
 105             .build();
 106
 107     private static EnvProperties properties() {
 108         return ImmutableEnvProperties.builder() //
 109                 .consulHost("host") //
 110                 .consulPort(123) //
 111                 .cbsName("cbsName") //
 112                 .appName("appName") //
 113                 .build();
 114     }
 115
 116     private RefreshConfigTask createTestObject(boolean configFileExists) {
 117         return createTestObject(configFileExists, new Rics(), new Policies(appConfig), true);
 118     }
 119
 120     private RefreshConfigTask createTestObject(boolean configFileExists, Rics rics, Policies policies,
 121             boolean stubConfigFileExists) {
 122
 123         RefreshConfigTask obj = spy(new RefreshConfigTask(configurationFileMock, appConfig, rics, policies,
 124                 new Services(), new PolicyTypes(appConfig), new A1ClientFactory(appConfig)));
 125         if (stubConfigFileExists) {
 126             when(configurationFileMock.readFile()).thenReturn(Optional.empty());
 127         }
 128         return obj;
 129     }
 130
 131     @Test
 132     void whenTheConfigurationFits_thenConfiguredRicsArePutInRepository() throws Exception {
 133         refreshTaskUnderTest = this.createTestObject(CONFIG_FILE_EXISTS);
 134         refreshTaskUnderTest.systemEnvironment = new Properties();
 135         // When
 136         when(configurationFileMock.readFile()).thenReturn(getCorrectJson());
 137
 138         StepVerifier //
 139                 .create(refreshTaskUnderTest.createRefreshTask()) //
 140                 .expectSubscription() //
 141                 .expectNext(Type.ADDED) //
 142                 .expectNext(Type.ADDED) //
 143                 .thenCancel() //
 144                 .verify();
 145
 146         // Then
 147         verify(refreshTaskUnderTest).loadConfigurationFromFile();
 148
 149         verify(refreshTaskUnderTest, times(2)).addRic(any(Ric.class));
 150
 151         Iterable<RicConfig> ricConfigs = appConfig.getRicConfigs();
 152         RicConfig ricConfig = ricConfigs.iterator().next();
 153         assertThat(ricConfigs).isNotNull();
 154         assertThat(ricConfig).isEqualTo(CORRECT_RIC_CONIFG);
 155     }
 156
 157     @Test
 158     void whenFileExistsButJsonIsIncorrect_thenNoRicsArePutInRepository() throws Exception {
 159         refreshTaskUnderTest = this.createTestObject(CONFIG_FILE_EXISTS);
 160
 161         // When
 162         when(configurationFileMock.readFile()).thenReturn(Optional.empty());
 163
 164         StepVerifier //
 165                 .create(refreshTaskUnderTest.createRefreshTask()) //
 166                 .expectSubscription() //
 167                 .expectNoEvent(Duration.ofMillis(100)) //
 168                 .thenCancel() //
 169                 .verify();
 170
 171         // Then
 172         verify(refreshTaskUnderTest).loadConfigurationFromFile();
 173         assertThat(appConfig.getRicConfigs()).isEmpty();
 174     }
 175
 176     @Test
 177     void whenPeriodicConfigRefreshNoConsul_thenErrorIsLogged() {
 178         refreshTaskUnderTest = this.createTestObject(CONFIG_FILE_DOES_NOT_EXIST);
 179         refreshTaskUnderTest.systemEnvironment = new Properties();
 180
 181         EnvProperties props = properties();
 182         doReturn(Mono.just(props)).when(refreshTaskUnderTest).getEnvironment(any());
 183
 184         doReturn(Mono.just(cbsClient)).when(refreshTaskUnderTest).createCbsClient(props);
 185         when(cbsClient.get(any())).thenReturn(Mono.error(new IOException()));
 186
 187         final ListAppender<ILoggingEvent> logAppender = LoggingUtils.getLogListAppender(RefreshConfigTask.class, WARN);
 188
 189         StepVerifier //
 190                 .create(refreshTaskUnderTest.createRefreshTask()) //
 191                 .expectSubscription() //
 192                 .expectNoEvent(Duration.ofMillis(1000)) //
 193                 .thenCancel() //
 194                 .verify();
 195
 196         await().until(() -> logAppender.list.size() > 0);
 197         assertThat(logAppender.list.get(0).getFormattedMessage())
 198                 .isEqualTo("Could not refresh application configuration. java.io.IOException");
 199     }
 200
 201     @Test
 202     void whenPeriodicConfigRefreshSuccess_thenNewConfigIsCreatedAndRepositoryUpdated() throws Exception {
 203         Rics rics = new Rics();
 204         Policies policies = new Policies(appConfig);
 205         refreshTaskUnderTest = this.createTestObject(CONFIG_FILE_DOES_NOT_EXIST, rics, policies, false);
 206         refreshTaskUnderTest.systemEnvironment = new Properties();
 207
 208         RicConfig changedRicConfig = getRicConfig(RIC_1_NAME);
 209         rics.put(new Ric(changedRicConfig));
 210         RicConfig removedRicConfig = getRicConfig("removed");
 211         Ric removedRic = new Ric(removedRicConfig);
 212         rics.put(removedRic);
 213         appConfig.setConfiguration(configParserResult(changedRicConfig, removedRicConfig));
 214
 215         Policy policy = getPolicy(removedRic);
 216         policies.put(policy);
 217
 218         EnvProperties props = properties();
 219         doReturn(Mono.just(props)).when(refreshTaskUnderTest).getEnvironment(any());
 220         doReturn(Mono.just(cbsClient)).when(refreshTaskUnderTest).createCbsClient(props);
 221
 222         JsonObject configAsJson = getCorrectJson().get();
 223         String newBaseUrl = "newBaseUrl";
 224         modifyTheRicConfiguration(configAsJson, newBaseUrl);
 225         when(cbsClient.get(any())).thenReturn(Mono.just(configAsJson));
 226
 227         StepVerifier //
 228                 .create(refreshTaskUnderTest.createRefreshTask()) //
 229                 .expectSubscription() //
 230                 .expectNextCount(3) // CHANGED REMOVED ADDED
 231                 .thenCancel() //
 232                 .verify();
 233
 234         assertThat(appConfig.getRicConfigs()).hasSize(2);
 235         assertThat(appConfig.getRic(RIC_1_NAME).baseUrl()).isEqualTo(newBaseUrl);
 236         String ric2Name = "ric2";
 237         assertThat(appConfig.getRic(ric2Name)).isNotNull();
 238
 239         // assertThat(rics.size()).isEqualTo(2);
 240         assertThat(rics.get(RIC_1_NAME).getConfig().baseUrl()).isEqualTo(newBaseUrl);
 241         assertThat(rics.get(ric2Name)).isNotNull();
 242
 243         assertThat(policies.size()).isZero();
 244     }
 245
 246     @Test
 247     void whenPeriodicConfigRefreshInvalidJson_thenErrorIsLogged() throws Exception {
 248         Rics rics = new Rics();
 249         Policies policies = new Policies(appConfig);
 250         refreshTaskUnderTest = this.createTestObject(CONFIG_FILE_DOES_NOT_EXIST, rics, policies, false);
 251         refreshTaskUnderTest.systemEnvironment = new Properties();
 252
 253         appConfig.setConfiguration(configParserResult());
 254
 255         EnvProperties props = properties();
 256         doReturn(Mono.just(props)).when(refreshTaskUnderTest).getEnvironment(any());
 257         doReturn(Mono.just(cbsClient)).when(refreshTaskUnderTest).createCbsClient(props);
 258
 259         JsonObject emptyJsonObject = new JsonObject();
 260         when(cbsClient.get(any())).thenReturn(Mono.just(emptyJsonObject));
 261
 262         final ListAppender<ILoggingEvent> logAppender = LoggingUtils.getLogListAppender(RefreshConfigTask.class, ERROR);
 263
 264         StepVerifier //
 265                 .create(refreshTaskUnderTest.createRefreshTask()) //
 266                 .expectSubscription() //
 267                 .expectNoEvent(Duration.ofMillis(1000)) //
 268                 .thenCancel() //
 269                 .verify();
 270
 271         await().until(() -> logAppender.list.size() > 0);
 272         assertThat(logAppender.list.get(0).getFormattedMessage()).startsWith(
 273                 "Could not parse configuration org.onap.ccsdk.oran.a1policymanagementservice.exceptions.ServiceException: ");
 274     }
 275
 276     private RicConfig getRicConfig(String name) {
 277         RicConfig ricConfig = ImmutableRicConfig.builder() //
 278                 .ricId(name) //
 279                 .baseUrl("url") //
 280                 .managedElementIds(Collections.emptyList()) //
 281                 .controllerName("controllerName") //
 282                 .build();
 283         return ricConfig;
 284     }
 285
 286     private Policy getPolicy(Ric ric) {
 287         PolicyType type = PolicyType.builder() //
 288                 .id("type") //
 289                 .schema("{}") //
 290                 .build();
 291         Policy policy = Policy.builder() //
 292                 .id("id") //
 293                 .type(type) //
 294                 .lastModified(Instant.now()) //
 295                 .ric(ric) //
 296                 .json("{}") //
 297                 .ownerServiceId("ownerServiceId") //
 298                 .isTransient(false) //
 299                 .statusNotificationUri("/policy_status?id=XXX") //
 300                 .build();
 301         return policy;
 302     }
 303
 304     ConfigParserResult configParserResult(RicConfig... rics) {
 305         return ImmutableConfigParserResult.builder() //
 306                 .ricConfigs(Arrays.asList(rics)) //
 307                 .dmaapConsumerTopicUrl("") //
 308                 .dmaapProducerTopicUrl("") //
 309                 .controllerConfigs(new HashMap<>()) //
 310                 .build();
 311     }
 312
 313     private void modifyTheRicConfiguration(JsonObject configAsJson, String newBaseUrl) {
 314         ((JsonObject) configAsJson.getAsJsonObject("config") //
 315                 .getAsJsonArray("ric").get(0)) //
 316                         .addProperty("baseUrl", newBaseUrl);
 317     }
 318
 319     private static Optional<JsonObject> getCorrectJson() throws IOException {
 320         URL url = ApplicationConfigParser.class.getClassLoader().getResource("test_application_configuration.json");
 321         String string = Resources.toString(url, Charsets.UTF_8);
 322         return Optional.of(JsonParser.parseString(string).getAsJsonObject());
 323     }
 324 }