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