policy-agent/src/test/java/org/oransc/policyagent/tasks/RefreshConfigTaskTest.java

   1 /*-
   2  * ========================LICENSE_START=================================
   3  * O-RAN-SC
   4  * %%
   5  * Copyright (C) 2019 Nordix Foundation
   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.oransc.policyagent.tasks;
  22
  23 import static org.assertj.core.api.Assertions.assertThat;
  24 import static org.mockito.ArgumentMatchers.any;
  25 import static org.mockito.Mockito.doReturn;
  26 import static org.mockito.Mockito.spy;
  27 import static org.mockito.Mockito.times;
  28 import static org.mockito.Mockito.verify;
  29
  30 import ch.qos.logback.classic.spi.ILoggingEvent;
  31 import ch.qos.logback.core.read.ListAppender;
  32
  33 import com.google.common.base.Charsets;
  34 import com.google.common.io.Resources;
  35 import com.google.gson.JsonIOException;
  36 import com.google.gson.JsonObject;
  37 import com.google.gson.JsonParser;
  38 import com.google.gson.JsonSyntaxException;
  39
  40 import java.io.ByteArrayInputStream;
  41 import java.io.IOException;
  42 import java.io.InputStream;
  43 import java.io.InputStreamReader;
  44 import java.net.URL;
  45 import java.nio.charset.StandardCharsets;
  46 import java.time.Duration;
  47 import java.util.Arrays;
  48 import java.util.Properties;
  49 import java.util.Vector;
  50
  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.dcaegen2.services.sdk.rest.services.cbs.client.api.CbsClient;
  57 import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.model.EnvProperties;
  58 import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.model.ImmutableEnvProperties;
  59 import org.oransc.policyagent.clients.A1ClientFactory;
  60 import org.oransc.policyagent.configuration.ApplicationConfig;
  61 import org.oransc.policyagent.configuration.ApplicationConfigParser;
  62 import org.oransc.policyagent.configuration.ImmutableRicConfig;
  63 import org.oransc.policyagent.configuration.RicConfig;
  64 import org.oransc.policyagent.repository.Policies;
  65 import org.oransc.policyagent.repository.PolicyTypes;
  66 import org.oransc.policyagent.repository.Rics;
  67 import org.oransc.policyagent.repository.Services;
  68 import org.oransc.policyagent.utils.LoggingUtils;
  69
  70 import reactor.core.publisher.Flux;
  71 import reactor.core.publisher.Mono;
  72 import reactor.test.StepVerifier;
  73
  74 @ExtendWith(MockitoExtension.class)
  75 public class RefreshConfigTaskTest {
  76
  77     private RefreshConfigTask refreshTaskUnderTest;
  78
  79     @Spy
  80     ApplicationConfig appConfig;
  81
  82     @Mock
  83     CbsClient cbsClient;
  84
  85     private static final String RIC_1_NAME = "ric1";
  86     public static final ImmutableRicConfig CORRECT_RIC_CONIFG = ImmutableRicConfig.builder() //
  87         .name(RIC_1_NAME) //
  88         .baseUrl("http://localhost:8080/") //
  89         .managedElementIds(new Vector<String>(Arrays.asList("kista_1", "kista_2"))) //
  90         .build();
  91
  92     private static EnvProperties properties() {
  93         return ImmutableEnvProperties.builder() //
  94             .consulHost("host") //
  95             .consulPort(123) //
  96             .cbsName("cbsName") //
  97             .appName("appName") //
  98             .build();
  99     }
 100
 101     private RefreshConfigTask createTestObject(boolean configFileExists) {
 102         RefreshConfigTask obj = spy(new RefreshConfigTask(appConfig, new Rics(), new Policies(), new Services(),
 103             new PolicyTypes(), new A1ClientFactory(appConfig)));
 104         doReturn(configFileExists).when(obj).configFileExists();
 105         return obj;
 106     }
 107
 108     @Test
 109     public void whenTheConfigurationFits_thenConfiguredRicsArePutInRepository() throws Exception {
 110         refreshTaskUnderTest = this.createTestObject(true);
 111         refreshTaskUnderTest.systemEnvironment = new Properties();
 112         // When
 113         doReturn(getCorrectJson()).when(refreshTaskUnderTest).createInputStream(any());
 114         doReturn("fileName").when(appConfig).getLocalConfigurationFilePath();
 115
 116         StepVerifier.create(refreshTaskUnderTest.createRefreshTask()) //
 117             .expectSubscription() //
 118             .expectNext(this.appConfig) //
 119             .expectNext(this.appConfig) //
 120             .thenCancel() //
 121             .verify();
 122
 123         // Then
 124         verify(refreshTaskUnderTest, times(1)).loadConfigurationFromFile();
 125
 126         Iterable<RicConfig> ricConfigs = appConfig.getRicConfigs();
 127         RicConfig ricConfig = ricConfigs.iterator().next();
 128         assertThat(ricConfigs).isNotNull();
 129         assertThat(ricConfig).isEqualTo(CORRECT_RIC_CONIFG);
 130     }
 131
 132     @Test
 133     public void whenFileExistsButJsonIsIncorrect_thenNoRicsArePutInRepository() throws Exception {
 134         refreshTaskUnderTest = this.createTestObject(true);
 135         refreshTaskUnderTest.systemEnvironment = new Properties();
 136
 137         // When
 138         doReturn(getIncorrectJson()).when(refreshTaskUnderTest).createInputStream(any());
 139         doReturn("fileName").when(appConfig).getLocalConfigurationFilePath();
 140
 141         StepVerifier.create(refreshTaskUnderTest.createRefreshTask()) //
 142             .expectSubscription() //
 143             .expectNoEvent(Duration.ofMillis(100)) //
 144             .thenCancel() //
 145             .verify();
 146
 147         // Then
 148         verify(refreshTaskUnderTest, times(1)).loadConfigurationFromFile();
 149         assertThat(appConfig.getRicConfigs().size()).isEqualTo(0);
 150     }
 151
 152     @Test
 153     public void whenPeriodicConfigRefreshNoConsul_thenErrorIsLogged() {
 154         refreshTaskUnderTest = this.createTestObject(false);
 155         refreshTaskUnderTest.systemEnvironment = new Properties();
 156
 157         EnvProperties props = properties();
 158         doReturn(Mono.just(props)).when(refreshTaskUnderTest).getEnvironment(any());
 159
 160         doReturn(Mono.just(cbsClient)).when(refreshTaskUnderTest).createCbsClient(props);
 161         Flux<?> err = Flux.error(new IOException());
 162         doReturn(err).when(cbsClient).updates(any(), any(), any());
 163
 164         final ListAppender<ILoggingEvent> logAppender = LoggingUtils.getLogListAppender(RefreshConfigTask.class);
 165         Flux<?> task = refreshTaskUnderTest.createRefreshTask();
 166
 167         StepVerifier //
 168             .create(task) //
 169             .expectSubscription() //
 170             .expectNoEvent(Duration.ofMillis(100)) //
 171             .thenCancel() //
 172             .verify();
 173
 174         assertThat(
 175             logAppender.list.toString().contains("Could not refresh application configuration. java.io.IOException"))
 176                 .isTrue();
 177     }
 178
 179     @Test
 180     public void whenPeriodicConfigRefreshSuccess_thenNewConfigIsCreated() throws Exception {
 181         refreshTaskUnderTest = this.createTestObject(false);
 182         refreshTaskUnderTest.systemEnvironment = new Properties();
 183
 184         EnvProperties props = properties();
 185         doReturn(Mono.just(props)).when(refreshTaskUnderTest).getEnvironment(any());
 186         doReturn(Mono.just(cbsClient)).when(refreshTaskUnderTest).createCbsClient(props);
 187
 188         JsonObject configAsJson = getJsonRootObject();
 189         String newBaseUrl = "newBaseUrl";
 190         modifyTheRicConfiguration(configAsJson, newBaseUrl);
 191         Flux<JsonObject> json = Flux.just(configAsJson);
 192         doReturn(json).when(cbsClient).updates(any(), any(), any());
 193
 194         Flux<ApplicationConfig> task = refreshTaskUnderTest.createRefreshTask();
 195
 196         StepVerifier //
 197             .create(task) //
 198             .expectSubscription() //
 199             .expectNext(appConfig) //
 200             .expectNext(appConfig) //
 201             .thenCancel() //
 202             .verify();
 203
 204         verify(refreshTaskUnderTest, times(2)).runRicSynchronization(any());
 205         assertThat(appConfig.getRicConfigs()).isNotNull();
 206         assertThat(appConfig.getRic(RIC_1_NAME).baseUrl()).isEqualTo(newBaseUrl);
 207     }
 208
 209     private void modifyTheRicConfiguration(JsonObject configAsJson, String newBaseUrl) {
 210         ((JsonObject) configAsJson.getAsJsonObject("config").getAsJsonArray("ric").get(0)).addProperty("baseUrl",
 211             newBaseUrl);
 212     }
 213
 214     private JsonObject getJsonRootObject() throws JsonIOException, JsonSyntaxException, IOException {
 215         JsonObject rootObject = JsonParser.parseReader(new InputStreamReader(getCorrectJson())).getAsJsonObject();
 216         return rootObject;
 217     }
 218
 219     private static InputStream getCorrectJson() throws IOException {
 220         URL url = ApplicationConfigParser.class.getClassLoader().getResource("test_application_configuration.json");
 221         String string = Resources.toString(url, Charsets.UTF_8);
 222         return new ByteArrayInputStream((string.getBytes(StandardCharsets.UTF_8)));
 223     }
 224
 225     private static InputStream getIncorrectJson() {
 226         String string = "{" + //
 227             "    \"config\": {" + //
 228             "        \"ric\": {"; //
 229         return new ByteArrayInputStream((string.getBytes(StandardCharsets.UTF_8)));
 230     }
 231 }