2 * ========================LICENSE_START=================================
5 * Copyright (C) 2019 Nordix Foundation
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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===================================
21 package org.oransc.policyagent.tasks;
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.mockito.ArgumentMatchers.any;
27 import static org.mockito.Mockito.doNothing;
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;
34 import ch.qos.logback.classic.spi.ILoggingEvent;
35 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.JsonIOException;
40 import com.google.gson.JsonObject;
41 import com.google.gson.JsonParser;
42 import com.google.gson.JsonSyntaxException;
44 import java.io.ByteArrayInputStream;
45 import java.io.IOException;
46 import java.io.InputStream;
47 import java.io.InputStreamReader;
49 import java.nio.charset.StandardCharsets;
50 import java.time.Duration;
51 import java.util.Arrays;
52 import java.util.Collections;
53 import java.util.Properties;
54 import java.util.Vector;
56 import org.junit.jupiter.api.Test;
57 import org.junit.jupiter.api.extension.ExtendWith;
58 import org.mockito.Mock;
59 import org.mockito.Spy;
60 import org.mockito.junit.jupiter.MockitoExtension;
61 import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.api.CbsClient;
62 import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.model.EnvProperties;
63 import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.model.ImmutableEnvProperties;
64 import org.oransc.policyagent.clients.A1ClientFactory;
65 import org.oransc.policyagent.configuration.ApplicationConfig;
66 import org.oransc.policyagent.configuration.ApplicationConfig.RicConfigUpdate.Type;
67 import org.oransc.policyagent.configuration.ApplicationConfigParser;
68 import org.oransc.policyagent.configuration.ImmutableRicConfig;
69 import org.oransc.policyagent.configuration.RicConfig;
70 import org.oransc.policyagent.repository.ImmutablePolicy;
71 import org.oransc.policyagent.repository.ImmutablePolicyType;
72 import org.oransc.policyagent.repository.Policies;
73 import org.oransc.policyagent.repository.Policy;
74 import org.oransc.policyagent.repository.PolicyTypes;
75 import org.oransc.policyagent.repository.Ric;
76 import org.oransc.policyagent.repository.Rics;
77 import org.oransc.policyagent.repository.Services;
78 import org.oransc.policyagent.utils.LoggingUtils;
80 import reactor.core.publisher.Flux;
81 import reactor.core.publisher.Mono;
82 import reactor.test.StepVerifier;
84 @ExtendWith(MockitoExtension.class)
85 public class RefreshConfigTaskTest {
87 private static final boolean CONFIG_FILE_EXISTS = true;
88 private static final boolean CONFIG_FILE_DOES_NOT_EXIST = false;
90 private RefreshConfigTask refreshTaskUnderTest;
93 ApplicationConfig appConfig;
98 private static final String RIC_1_NAME = "ric1";
99 public static final ImmutableRicConfig CORRECT_RIC_CONIFG = ImmutableRicConfig.builder() //
101 .baseUrl("http://localhost:8080/") //
102 .managedElementIds(new Vector<String>(Arrays.asList("kista_1", "kista_2"))) //
105 private static EnvProperties properties() {
106 return ImmutableEnvProperties.builder() //
107 .consulHost("host") //
109 .cbsName("cbsName") //
110 .appName("appName") //
114 private RefreshConfigTask createTestObject(boolean configFileExists) {
115 return createTestObject(configFileExists, new Rics(), new Policies(), true);
118 private RefreshConfigTask createTestObject(boolean configFileExists, Rics rics, Policies policies,
119 boolean stubConfigFileExists) {
120 RefreshConfigTask obj = spy(new RefreshConfigTask(appConfig, rics, policies, new Services(), new PolicyTypes(),
121 new A1ClientFactory(appConfig)));
122 if (stubConfigFileExists) {
123 doReturn(configFileExists).when(obj).configFileExists();
129 public void startWithStubbedRefresh_thenTerminationLogged() {
130 refreshTaskUnderTest = this.createTestObject(CONFIG_FILE_DOES_NOT_EXIST, null, null, false);
131 doReturn(Flux.empty()).when(refreshTaskUnderTest).createRefreshTask();
133 final ListAppender<ILoggingEvent> logAppender = LoggingUtils.getLogListAppender(RefreshConfigTask.class, ERROR);
135 refreshTaskUnderTest.start();
137 assertThat(logAppender.list.toString().contains("Configuration refresh terminated")).isTrue();
141 public void startWithStubbedRefreshReturnError_thenErrorAndTerminationLogged() {
142 refreshTaskUnderTest = this.createTestObject(CONFIG_FILE_DOES_NOT_EXIST, null, null, false);
143 doReturn(Flux.error(new Exception("Error"))).when(refreshTaskUnderTest).createRefreshTask();
145 final ListAppender<ILoggingEvent> logAppender = LoggingUtils.getLogListAppender(RefreshConfigTask.class, ERROR);
147 refreshTaskUnderTest.start();
149 ILoggingEvent event = logAppender.list.get(0);
150 assertThat(event.getThrowableProxy().getMessage()).isEqualTo("Error");
151 assertThat(event.toString().contains("Configuration refresh terminated due to exception")).isTrue();
155 public void stop_thenTaskIsDisposed() throws Exception {
156 refreshTaskUnderTest = this.createTestObject(CONFIG_FILE_DOES_NOT_EXIST, null, null, false);
157 refreshTaskUnderTest.systemEnvironment = new Properties();
159 refreshTaskUnderTest.start();
160 refreshTaskUnderTest.stop();
162 assertThat(refreshTaskUnderTest.getRefreshTask().isDisposed()).isTrue();
166 public void whenTheConfigurationFits_thenConfiguredRicsArePutInRepository() throws Exception {
167 refreshTaskUnderTest = this.createTestObject(CONFIG_FILE_EXISTS);
168 refreshTaskUnderTest.systemEnvironment = new Properties();
170 doReturn(getCorrectJson()).when(refreshTaskUnderTest).createInputStream(any());
171 doReturn("fileName").when(appConfig).getLocalConfigurationFilePath();
173 StepVerifier.create(refreshTaskUnderTest.createRefreshTask()) //
174 .expectSubscription() //
175 .expectNext(Type.ADDED) //
176 .expectNext(Type.ADDED) //
181 verify(refreshTaskUnderTest).loadConfigurationFromFile();
183 verify(refreshTaskUnderTest, times(2)).runRicSynchronization(any(Ric.class));
185 Iterable<RicConfig> ricConfigs = appConfig.getRicConfigs();
186 RicConfig ricConfig = ricConfigs.iterator().next();
187 assertThat(ricConfigs).isNotNull();
188 assertThat(ricConfig).isEqualTo(CORRECT_RIC_CONIFG);
192 public void whenFileExistsButJsonIsIncorrect_thenNoRicsArePutInRepository() throws Exception {
193 refreshTaskUnderTest = this.createTestObject(CONFIG_FILE_EXISTS);
194 refreshTaskUnderTest.systemEnvironment = new Properties();
197 doReturn(getIncorrectJson()).when(refreshTaskUnderTest).createInputStream(any());
198 doReturn("fileName").when(appConfig).getLocalConfigurationFilePath();
200 StepVerifier.create(refreshTaskUnderTest.createRefreshTask()) //
201 .expectSubscription() //
202 .expectNoEvent(Duration.ofMillis(100)) //
207 verify(refreshTaskUnderTest).loadConfigurationFromFile();
208 assertThat(appConfig.getRicConfigs().size()).isEqualTo(0);
212 public void whenPeriodicConfigRefreshNoConsul_thenErrorIsLogged() {
213 refreshTaskUnderTest = this.createTestObject(CONFIG_FILE_DOES_NOT_EXIST);
214 refreshTaskUnderTest.systemEnvironment = new Properties();
216 EnvProperties props = properties();
217 doReturn(Mono.just(props)).when(refreshTaskUnderTest).getEnvironment(any());
219 doReturn(Mono.just(cbsClient)).when(refreshTaskUnderTest).createCbsClient(props);
220 when(cbsClient.updates(any(), any(), any())).thenReturn(Flux.error(new IOException()));
222 final ListAppender<ILoggingEvent> logAppender = LoggingUtils.getLogListAppender(RefreshConfigTask.class, WARN);
223 Flux<Type> task = refreshTaskUnderTest.createRefreshTask();
227 .expectSubscription() //
228 .expectNoEvent(Duration.ofMillis(100)) //
233 logAppender.list.toString().contains("Could not refresh application configuration. java.io.IOException"))
238 public void whenPeriodicConfigRefreshSuccess_thenNewConfigIsCreatedAndRepositoryUpdated() throws Exception {
239 Rics rics = new Rics();
240 Policies policies = new Policies();
241 refreshTaskUnderTest = this.createTestObject(CONFIG_FILE_DOES_NOT_EXIST, rics, policies, false);
242 refreshTaskUnderTest.systemEnvironment = new Properties();
244 RicConfig changedRicConfig = getRicConfig(RIC_1_NAME);
245 rics.put(new Ric(changedRicConfig));
246 RicConfig removedRicConfig = getRicConfig("removed");
247 Ric removedRic = new Ric(removedRicConfig);
248 rics.put(removedRic);
249 appConfig.setConfiguration(Arrays.asList(changedRicConfig, removedRicConfig), null, null);
251 Policy policy = getPolicy(removedRic);
252 policies.put(policy);
254 EnvProperties props = properties();
255 doReturn(Mono.just(props)).when(refreshTaskUnderTest).getEnvironment(any());
256 doReturn(Mono.just(cbsClient)).when(refreshTaskUnderTest).createCbsClient(props);
258 JsonObject configAsJson = getJsonRootObject();
259 String newBaseUrl = "newBaseUrl";
260 modifyTheRicConfiguration(configAsJson, newBaseUrl);
261 when(cbsClient.updates(any(), any(), any())).thenReturn(Flux.just(configAsJson));
262 doNothing().when(refreshTaskUnderTest).runRicSynchronization(any(Ric.class));
264 Flux<Type> task = refreshTaskUnderTest.createRefreshTask();
268 .expectSubscription() //
269 .expectNext(Type.CHANGED) //
270 .expectNext(Type.ADDED) //
271 .expectNext(Type.REMOVED) //
275 assertThat(appConfig.getRicConfigs().size()).isEqualTo(2);
276 assertThat(appConfig.getRic(RIC_1_NAME).baseUrl()).isEqualTo(newBaseUrl);
277 String ric2Name = "ric2";
278 assertThat(appConfig.getRic(ric2Name)).isNotNull();
280 assertThat(rics.size()).isEqualTo(2);
281 assertThat(rics.get(RIC_1_NAME).getConfig().baseUrl()).isEqualTo(newBaseUrl);
282 assertThat(rics.get(ric2Name)).isNotNull();
284 assertThat(policies.size()).isEqualTo(0);
287 private RicConfig getRicConfig(String name) {
288 RicConfig ricConfig = ImmutableRicConfig.builder() //
291 .managedElementIds(Collections.emptyList()) //
296 private Policy getPolicy(Ric ric) {
297 ImmutablePolicyType type = ImmutablePolicyType.builder() //
301 Policy policy = ImmutablePolicy.builder() //
304 .lastModified("lastModified") //
307 .ownerServiceName("ownerServiceName") //
312 private void modifyTheRicConfiguration(JsonObject configAsJson, String newBaseUrl) {
313 ((JsonObject) configAsJson.getAsJsonObject("config").getAsJsonArray("ric").get(0)).addProperty("baseUrl",
317 private JsonObject getJsonRootObject() throws JsonIOException, JsonSyntaxException, IOException {
318 JsonObject rootObject = JsonParser.parseReader(new InputStreamReader(getCorrectJson())).getAsJsonObject();
322 private static InputStream getCorrectJson() throws IOException {
323 URL url = ApplicationConfigParser.class.getClassLoader().getResource("test_application_configuration.json");
324 String string = Resources.toString(url, Charsets.UTF_8);
325 return new ByteArrayInputStream((string.getBytes(StandardCharsets.UTF_8)));
328 private static InputStream getIncorrectJson() {
329 String string = "{" + //
330 " \"config\": {" + //
332 return new ByteArrayInputStream((string.getBytes(StandardCharsets.UTF_8)));