diff options
11 files changed, 334 insertions, 149 deletions
diff --git a/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/configuration/ConfigurationFile.java b/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/configuration/ConfigurationFile.java new file mode 100644 index 00000000..345722cb --- /dev/null +++ b/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/configuration/ConfigurationFile.java @@ -0,0 +1,93 @@ +/*- + * ========================LICENSE_START================================= + * Copyright (C) 2020 Nordix Foundation. All rights reserved. + * ====================================================================== + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ========================LICENSE_END=================================== + */ + +package org.onap.ccsdk.oran.a1policymanagementservice.configuration; + +import com.google.gson.Gson; +import com.google.gson.JsonElement; +import com.google.gson.JsonObject; +import com.google.gson.JsonParser; +import java.io.BufferedInputStream; +import java.io.File; +import java.io.FileInputStream; +import java.io.FileWriter; +import java.io.IOException; +import java.io.InputStream; +import java.io.InputStreamReader; +import java.util.Optional; +import javax.validation.constraints.NotNull; +import org.onap.ccsdk.oran.a1policymanagementservice.exceptions.ServiceException; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Component; + +@Component +public class ConfigurationFile { + private static final Logger logger = LoggerFactory.getLogger(ConfigurationFile.class); + + final ApplicationConfig appConfig; + final Gson gson = new Gson(); + + @Autowired + public ConfigurationFile(ApplicationConfig appConfig) { + this.appConfig = appConfig; + } + + public synchronized Optional<JsonObject> readFile() { + String filepath = appConfig.getLocalConfigurationFilePath(); + if (!fileExists(filepath)) { + return Optional.empty(); + } + + try (InputStream inputStream = createInputStream(filepath)) { + JsonObject rootObject = getJsonElement(inputStream).getAsJsonObject(); + logger.debug("Local configuration file loaded: {}", filepath); + return Optional.of(rootObject); + } catch (Exception e) { + logger.error("Local configuration file not loaded: {}, {}", filepath, e.getMessage()); + return Optional.empty(); + } + } + + public synchronized void writeFile(JsonObject content) throws ServiceException { + String filepath = appConfig.getLocalConfigurationFilePath(); + try (FileWriter fileWriter = getFileWriter(filepath)) { + gson.toJson(content, fileWriter); + } catch (IOException e) { + logger.error("Local configuration file not written: {}, {}", filepath, e.getMessage()); + throw new ServiceException("Local configuration file not written"); + } + } + + FileWriter getFileWriter(String filepath) throws IOException { + return new FileWriter(filepath); + } + + private boolean fileExists(String filepath) { + return (new File(filepath).exists()); + } + + private JsonElement getJsonElement(InputStream inputStream) { + return JsonParser.parseReader(new InputStreamReader(inputStream)); + } + + private InputStream createInputStream(@NotNull String filepath) throws IOException { + return new BufferedInputStream(new FileInputStream(filepath)); + } +} diff --git a/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/PolicyController.java b/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/PolicyController.java index ec776042..ea047cb5 100644 --- a/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/PolicyController.java +++ b/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/PolicyController.java @@ -262,12 +262,6 @@ public class PolicyController { return Mono.just("{}"); } - private void assertRicStateIdleSync(Ric ric) throws ServiceException { - if (ric.getState() != Ric.RicState.AVAILABLE) { - throw new ServiceException("Near-RT RIC: " + ric.id() + " is " + ric.getState()); - } - } - private Mono<Object> assertRicStateIdle(Ric ric) { if (ric.getState() == Ric.RicState.AVAILABLE) { return Mono.just("{}"); @@ -408,6 +402,7 @@ public class PolicyController { policyInfo.ricId = p.ric().id(); policyInfo.policyTypeId = p.type().id(); policyInfo.serviceId = p.ownerServiceId(); + policyInfo.isTransient = p.isTransient(); if (!p.statusNotificationUri().isEmpty()) { policyInfo.statusNotificationUri = p.statusNotificationUri(); } diff --git a/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/PolicyInfo.java b/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/PolicyInfo.java index c032e3ad..43684a33 100644 --- a/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/PolicyInfo.java +++ b/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/PolicyInfo.java @@ -57,10 +57,12 @@ public class PolicyInfo { @SerializedName("service_id") public String serviceId; - @ApiModelProperty(value = "the name of the service owning the policy", required = false) - @JsonProperty(value = "transient", required = false) + @ApiModelProperty( + value = "if true, the policy is deleted at RIC restart. If false, its value is maintained by this service until explicitly deleted. Default false.", + required = false) + @JsonProperty(value = "transient", required = false, defaultValue = "false") @SerializedName("transient") - public boolean isTransient; + public boolean isTransient = false; @ApiModelProperty(value = "Callback URI for policy status updates", required = false) @JsonProperty(value = "status_notification_uri", required = false) diff --git a/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/tasks/RefreshConfigTask.java b/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/tasks/RefreshConfigTask.java index e4d7d8d7..75fd16cf 100644 --- a/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/tasks/RefreshConfigTask.java +++ b/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/tasks/RefreshConfigTask.java @@ -20,21 +20,12 @@ package org.onap.ccsdk.oran.a1policymanagementservice.tasks; -import com.google.gson.JsonElement; import com.google.gson.JsonObject; -import com.google.gson.JsonParser; -import java.io.BufferedInputStream; -import java.io.File; -import java.io.FileInputStream; -import java.io.IOException; -import java.io.InputStream; -import java.io.InputStreamReader; import java.time.Duration; +import java.util.Optional; import java.util.Properties; -import javax.validation.constraints.NotNull; - import lombok.AccessLevel; import lombok.Getter; @@ -43,6 +34,7 @@ import org.onap.ccsdk.oran.a1policymanagementservice.clients.AsyncRestClientFact import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfig; import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfig.RicConfigUpdate; import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfigParser; +import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ConfigurationFile; import org.onap.ccsdk.oran.a1policymanagementservice.configuration.RicConfig; import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policies; import org.onap.ccsdk.oran.a1policymanagementservice.repository.PolicyTypes; @@ -83,6 +75,7 @@ public class RefreshConfigTask { */ static final Duration CONFIG_REFRESH_INTERVAL = Duration.ofMinutes(1); + final ConfigurationFile configurationFile; final ApplicationConfig appConfig; @Getter(AccessLevel.PROTECTED) private Disposable refreshTask = null; @@ -96,8 +89,9 @@ public class RefreshConfigTask { private final AsyncRestClientFactory restClientFactory; @Autowired - public RefreshConfigTask(ApplicationConfig appConfig, Rics rics, Policies policies, Services services, - PolicyTypes policyTypes, A1ClientFactory a1ClientFactory) { + public RefreshConfigTask(ConfigurationFile configurationFile, ApplicationConfig appConfig, Rics rics, + Policies policies, Services services, PolicyTypes policyTypes, A1ClientFactory a1ClientFactory) { + this.configurationFile = configurationFile; this.appConfig = appConfig; this.rics = rics; this.policies = policies; @@ -195,14 +189,10 @@ public class RefreshConfigTask { return this.appConfig.setConfiguration(config); } - boolean fileExists(String filepath) { - return (filepath != null && (new File(filepath).exists())); - } - private void removePoliciciesInRic(@Nullable Ric ric) { if (ric != null) { - RicSynchronizationTask synch = - new RicSynchronizationTask(a1ClientFactory, policyTypes, policies, services, restClientFactory); + RicSynchronizationTask synch = new RicSynchronizationTask(a1ClientFactory, policyTypes, policies, services, + restClientFactory, rics); synch.run(ric); } } @@ -212,15 +202,18 @@ public class RefreshConfigTask { String ricId = updatedInfo.getRicConfig().ricId(); RicConfigUpdate.Type event = updatedInfo.getType(); if (event == RicConfigUpdate.Type.ADDED) { + logger.debug("RIC added {}", ricId); addRic(updatedInfo.getRicConfig()); } else if (event == RicConfigUpdate.Type.REMOVED) { + logger.debug("RIC removed {}", ricId); Ric ric = rics.remove(ricId); this.policies.removePoliciesForRic(ricId); removePoliciciesInRic(ric); } else if (event == RicConfigUpdate.Type.CHANGED) { + logger.debug("RIC config updated {}", ricId); Ric ric = this.rics.get(ricId); if (ric == null) { - // Should not happen,just for robustness + logger.error("An non existing RIC config is changed, should not happen (just for robustness)"); addRic(updatedInfo.getRicConfig()); } else { ric.setRicConfig(updatedInfo.getRicConfig()); @@ -237,7 +230,7 @@ public class RefreshConfigTask { void runRicSynchronization(Ric ric) { RicSynchronizationTask synchronizationTask = - new RicSynchronizationTask(a1ClientFactory, policyTypes, policies, services, restClientFactory); + new RicSynchronizationTask(a1ClientFactory, policyTypes, policies, services, restClientFactory, rics); synchronizationTask.run(ric); } @@ -245,28 +238,10 @@ public class RefreshConfigTask { * Reads the configuration from file. */ Flux<JsonObject> loadConfigurationFromFile() { - String filepath = appConfig.getLocalConfigurationFilePath(); - if (!fileExists(filepath)) { - return Flux.empty(); - } - - try (InputStream inputStream = createInputStream(filepath)) { - JsonObject rootObject = getJsonElement(inputStream).getAsJsonObject(); - ApplicationConfigParser appParser = new ApplicationConfigParser(); - appParser.parse(rootObject); - logger.debug("Local configuration file loaded: {}", filepath); - return Flux.just(rootObject); - } catch (Exception e) { - logger.error("Local configuration file not loaded: {}, {}", filepath, e.getMessage()); - return Flux.empty(); + Optional<JsonObject> readJson = configurationFile.readFile(); + if (readJson.isPresent()) { + return Flux.just(readJson.get()); } - } - - JsonElement getJsonElement(InputStream inputStream) { - return JsonParser.parseReader(new InputStreamReader(inputStream)); - } - - InputStream createInputStream(@NotNull String filepath) throws IOException { - return new BufferedInputStream(new FileInputStream(filepath)); + return Flux.empty(); } } diff --git a/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/tasks/RicSupervision.java b/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/tasks/RicSupervision.java index cae257cd..c13df8c3 100644 --- a/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/tasks/RicSupervision.java +++ b/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/tasks/RicSupervision.java @@ -211,6 +211,6 @@ public class RicSupervision { } RicSynchronizationTask createSynchronizationTask() { - return new RicSynchronizationTask(a1ClientFactory, policyTypes, policies, services, restClientFactory); + return new RicSynchronizationTask(a1ClientFactory, policyTypes, policies, services, restClientFactory, rics); } } diff --git a/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/tasks/RicSynchronizationTask.java b/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/tasks/RicSynchronizationTask.java index 825418b5..b38a36b2 100644 --- a/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/tasks/RicSynchronizationTask.java +++ b/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/tasks/RicSynchronizationTask.java @@ -33,6 +33,7 @@ import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policy; import org.onap.ccsdk.oran.a1policymanagementservice.repository.PolicyType; import org.onap.ccsdk.oran.a1policymanagementservice.repository.PolicyTypes; import org.onap.ccsdk.oran.a1policymanagementservice.repository.Ric; +import org.onap.ccsdk.oran.a1policymanagementservice.repository.Rics; import org.onap.ccsdk.oran.a1policymanagementservice.repository.Services; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -64,15 +65,17 @@ public class RicSynchronizationTask { private final PolicyTypes policyTypes; private final Policies policies; private final Services services; + private final Rics rics; private final AsyncRestClientFactory restClientFactory; public RicSynchronizationTask(A1ClientFactory a1ClientFactory, PolicyTypes policyTypes, Policies policies, - Services services, AsyncRestClientFactory restClientFactory) { + Services services, AsyncRestClientFactory restClientFactory, Rics rics) { this.a1ClientFactory = a1ClientFactory; this.policyTypes = policyTypes; this.policies = policies; this.services = services; this.restClientFactory = restClientFactory; + this.rics = rics; } public void run(Ric ric) { @@ -129,6 +132,10 @@ public class RicSynchronizationTask { } private void onSynchronizationComplete(Ric ric) { + if (this.rics.get(ric.id()) == null) { + logger.debug("Policies removed in removed ric: {}", ric.id()); + return; + } logger.debug("Synchronization completed for: {}", ric.id()); ric.setState(RicState.AVAILABLE); notifyServices(ric); diff --git a/a1-policy-management/src/test/java/org/onap/ccsdk/oran/a1policymanagementservice/configuration/ApplicationConfigTest.java b/a1-policy-management/src/test/java/org/onap/ccsdk/oran/a1policymanagementservice/configuration/ApplicationConfigTest.java index cf4739c8..7a075428 100644 --- a/a1-policy-management/src/test/java/org/onap/ccsdk/oran/a1policymanagementservice/configuration/ApplicationConfigTest.java +++ b/a1-policy-management/src/test/java/org/onap/ccsdk/oran/a1policymanagementservice/configuration/ApplicationConfigTest.java @@ -21,12 +21,11 @@ package org.onap.ccsdk.oran.a1policymanagementservice.configuration; import static org.junit.jupiter.api.Assertions.assertEquals; -import static org.junit.jupiter.api.Assertions.assertNull; -import static org.junit.jupiter.api.Assertions.assertThrows; import static org.junit.jupiter.api.Assertions.assertTrue; import java.util.Arrays; import java.util.HashMap; +import java.util.List; import java.util.Vector; import org.junit.jupiter.api.Test; @@ -34,7 +33,6 @@ import org.junit.jupiter.api.extension.ExtendWith; import org.mockito.junit.jupiter.MockitoExtension; import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfig.RicConfigUpdate; import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfigParser.ConfigParserResult; -import org.onap.ccsdk.oran.a1policymanagementservice.exceptions.ServiceException; @ExtendWith(MockitoExtension.class) class ApplicationConfigTest { @@ -46,6 +44,20 @@ class ApplicationConfigTest { .controllerName("") // .build(); + private static final ImmutableRicConfig RIC_CONFIG_2 = ImmutableRicConfig.builder() // + .ricId("ric2") // + .baseUrl("ric1_url") // + .managedElementIds(new Vector<>()) // + .controllerName("") // + .build(); + + private static final ImmutableRicConfig RIC_CONFIG_3 = ImmutableRicConfig.builder() // + .ricId("ric3") // + .baseUrl("ric1_url") // + .managedElementIds(new Vector<>()) // + .controllerName("") // + .build(); + ConfigParserResult configParserResult(RicConfig... rics) { return ImmutableConfigParserResult.builder() // .ricConfigs(Arrays.asList(rics)) // @@ -56,72 +68,67 @@ class ApplicationConfigTest { } @Test - void gettingNotAddedRicShouldThrowException() { - ApplicationConfig appConfigUnderTest = new ApplicationConfig(); - - appConfigUnderTest.setConfiguration(configParserResult(RIC_CONFIG_1)); - - Exception exception = assertThrows(ServiceException.class, () -> { - appConfigUnderTest.getRic("name"); - }); - - assertEquals("Could not find ric configuration: name", exception.getMessage()); - } - - @Test - void addRicShouldNotifyAllObserversOfRicAdded() throws Exception { + void addRics() throws Exception { ApplicationConfig appConfigUnderTest = new ApplicationConfig(); - RicConfigUpdate update = appConfigUnderTest.setConfiguration(configParserResult(RIC_CONFIG_1)).blockFirst(); - assertEquals(RicConfigUpdate.Type.ADDED, update.getType()); + List<RicConfigUpdate> update = appConfigUnderTest.setConfiguration(configParserResult(RIC_CONFIG_1)) // + .collectList().block(); + assertEquals(1, update.size()); + assertEquals(RicConfigUpdate.Type.ADDED, update.get(0).getType()); assertTrue(appConfigUnderTest.getRicConfigs().contains(RIC_CONFIG_1), "Ric not added to configurations."); assertEquals(RIC_CONFIG_1, appConfigUnderTest.getRic(RIC_CONFIG_1.ricId()), "Not correct Ric retrieved from configurations."); - update = appConfigUnderTest.setConfiguration(configParserResult(RIC_CONFIG_1)).blockFirst(); - assertNull(update, "Nothing should be updated"); - assertTrue(appConfigUnderTest.getRicConfigs().contains(RIC_CONFIG_1), "Ric should remain."); + update = appConfigUnderTest.setConfiguration(configParserResult(RIC_CONFIG_1)).collectList().block(); + assertEquals(0, update.size()); + + update = appConfigUnderTest.setConfiguration(configParserResult(RIC_CONFIG_1, RIC_CONFIG_2)).collectList() + .block(); + assertEquals(1, update.size()); + assertEquals(RicConfigUpdate.Type.ADDED, update.get(0).getType()); } @Test - void changedRicShouldNotifyAllObserversOfRicChanged() throws Exception { + void changedRic() throws Exception { ApplicationConfig appConfigUnderTest = new ApplicationConfig(); - appConfigUnderTest.setConfiguration(configParserResult(RIC_CONFIG_1)); + List<RicConfigUpdate> update = appConfigUnderTest + .setConfiguration(configParserResult(RIC_CONFIG_1, RIC_CONFIG_2, RIC_CONFIG_3)).collectList().block(); + assertEquals(3, update.size()); ImmutableRicConfig changedRicConfig = ImmutableRicConfig.builder() // - .ricId("ric1") // + .ricId(RIC_CONFIG_1.ricId()) // .baseUrl("changed_ric1_url") // .managedElementIds(new Vector<>()) // .controllerName("") // .build(); - RicConfigUpdate update = appConfigUnderTest.setConfiguration(configParserResult(changedRicConfig)).blockFirst(); + update = appConfigUnderTest.setConfiguration(configParserResult(changedRicConfig, RIC_CONFIG_2, RIC_CONFIG_3)) + .collectList().block(); + assertEquals(1, update.size()); - assertEquals(RicConfigUpdate.Type.CHANGED, update.getType()); + assertEquals(RicConfigUpdate.Type.CHANGED, update.get(0).getType()); assertEquals(changedRicConfig, appConfigUnderTest.getRic(RIC_CONFIG_1.ricId()), "Changed Ric not retrieved from configurations."); } @Test - void removedRicShouldNotifyAllObserversOfRicRemoved() { + void removedRic() { ApplicationConfig appConfigUnderTest = new ApplicationConfig(); - ImmutableRicConfig ricConfig2 = ImmutableRicConfig.builder() // - .ricId("ric2") // - .baseUrl("ric2_url") // - .managedElementIds(new Vector<>()) // - .controllerName("") // - .build(); - - appConfigUnderTest.setConfiguration(configParserResult(RIC_CONFIG_1, ricConfig2)); - - RicConfigUpdate update = appConfigUnderTest.setConfiguration(configParserResult(ricConfig2)).blockFirst(); - - assertEquals(RicConfigUpdate.Type.REMOVED, update.getType()); - assertEquals(1, appConfigUnderTest.getRicConfigs().size(), "Ric not deleted from configurations."); + List<RicConfigUpdate> update = appConfigUnderTest + .setConfiguration(configParserResult(RIC_CONFIG_1, RIC_CONFIG_2, RIC_CONFIG_3)).collectList().block(); + assertEquals(3, update.size()); + + update = appConfigUnderTest.setConfiguration(configParserResult(RIC_CONFIG_2, RIC_CONFIG_3)) // + .collectList() // + .block(); + assertEquals(1, update.size()); + assertEquals(RicConfigUpdate.Type.REMOVED, update.get(0).getType()); + assertEquals(RIC_CONFIG_1, update.get(0).getRicConfig()); + assertEquals(2, appConfigUnderTest.getRicConfigs().size(), "Ric not deleted from configurations."); } } diff --git a/a1-policy-management/src/test/java/org/onap/ccsdk/oran/a1policymanagementservice/configuration/ConfigurationFileTest.java b/a1-policy-management/src/test/java/org/onap/ccsdk/oran/a1policymanagementservice/configuration/ConfigurationFileTest.java new file mode 100644 index 00000000..ad4cbb81 --- /dev/null +++ b/a1-policy-management/src/test/java/org/onap/ccsdk/oran/a1policymanagementservice/configuration/ConfigurationFileTest.java @@ -0,0 +1,120 @@ +/*- + * ========================LICENSE_START================================= + * Copyright (C) 2020 Nordix Foundation. All rights reserved. + * ====================================================================== + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ========================LICENSE_END=================================== + */ + +package org.onap.ccsdk.oran.a1policymanagementservice.configuration; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.mockito.ArgumentMatchers.any; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.mockito.Mockito.doThrow; +import static org.mockito.Mockito.spy; +import static org.mockito.Mockito.when; + +import ch.qos.logback.classic.Level; +import ch.qos.logback.classic.spi.ILoggingEvent; +import ch.qos.logback.core.read.ListAppender; +import com.google.gson.JsonObject; +import com.google.gson.JsonParser; +import java.io.File; +import java.io.IOException; +import java.nio.file.Files; +import java.util.Optional; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.junit.jupiter.api.io.TempDir; +import org.mockito.Mock; +import org.mockito.junit.jupiter.MockitoExtension; +import org.onap.ccsdk.oran.a1policymanagementservice.exceptions.ServiceException; +import org.onap.ccsdk.oran.a1policymanagementservice.utils.LoggingUtils; + +@ExtendWith(MockitoExtension.class) +class ConfigurationFileTest { + @Mock + ApplicationConfig applicationConfigMock; + + @TempDir + public File temporaryFolder; + + @Test + void writeFileWithError_shouldThrowExceptionAndLogError() throws Exception { + File tempJsonFile = new File(temporaryFolder, "config.json"); + String filePath = tempJsonFile.getAbsolutePath(); + + ConfigurationFile configFileUnderTestSpy = spy(new ConfigurationFile(applicationConfigMock)); + + when(applicationConfigMock.getLocalConfigurationFilePath()).thenReturn(filePath); + doThrow(new IOException("Error")).when(configFileUnderTestSpy).getFileWriter(any(String.class)); + + ListAppender<ILoggingEvent> logAppender = LoggingUtils.getLogListAppender(ConfigurationFile.class, Level.ERROR); + Exception actualException = + assertThrows(ServiceException.class, () -> configFileUnderTestSpy.writeFile(new JsonObject())); + + assertThat(actualException.getMessage()).startsWith("Local configuration file not written"); + + assertThat(logAppender.list.get(0).getFormattedMessage()).startsWith("Local configuration file not written"); + } + + @Test + void writeAndReadFile_shouldBeOk() throws Exception { + File tempJsonFile = new File(temporaryFolder, "config.json"); + String filePath = tempJsonFile.getAbsolutePath(); + + ConfigurationFile configFileUnderTest = new ConfigurationFile(applicationConfigMock); + + JsonObject content = JsonParser.parseString("{\"test\":\"test\"}").getAsJsonObject(); + + when(applicationConfigMock.getLocalConfigurationFilePath()).thenReturn(filePath); + + configFileUnderTest.writeFile(content); + + Optional<JsonObject> readContent = configFileUnderTest.readFile(); + + assertThat(readContent).isNotEmpty().hasValue(content); + } + + @Test + void readWhenFileMissing_shouldReturnEmpty() { + ConfigurationFile configFileUnderTest = new ConfigurationFile(applicationConfigMock); + + String filePath = "configFile.json"; + when(applicationConfigMock.getLocalConfigurationFilePath()).thenReturn(filePath); + + Optional<JsonObject> readContent = configFileUnderTest.readFile(); + + assertThat(readContent).isEmpty(); + } + + @Test + void readWhenFileWithIoError_shouldReturnEmptyAndLogError() throws Exception { + File tempJsonFile = new File(temporaryFolder, "config.json"); + String filePath = tempJsonFile.getAbsolutePath(); + Files.write(tempJsonFile.toPath(), "".getBytes()); + + ConfigurationFile configFileUnderTest = new ConfigurationFile(applicationConfigMock); + + when(applicationConfigMock.getLocalConfigurationFilePath()).thenReturn(filePath); + + ListAppender<ILoggingEvent> logAppender = LoggingUtils.getLogListAppender(ConfigurationFile.class, Level.ERROR); + Optional<JsonObject> readContent = configFileUnderTest.readFile(); + + assertThat(readContent).isEmpty(); + + assertThat(logAppender.list.get(0).getFormattedMessage()) + .isEqualTo("Local configuration file not loaded: " + filePath + ", Not a JSON Object: null"); + } +} diff --git a/a1-policy-management/src/test/java/org/onap/ccsdk/oran/a1policymanagementservice/tasks/RefreshConfigTaskTest.java b/a1-policy-management/src/test/java/org/onap/ccsdk/oran/a1policymanagementservice/tasks/RefreshConfigTaskTest.java index 04951ee7..07a62010 100644 --- a/a1-policy-management/src/test/java/org/onap/ccsdk/oran/a1policymanagementservice/tasks/RefreshConfigTaskTest.java +++ b/a1-policy-management/src/test/java/org/onap/ccsdk/oran/a1policymanagementservice/tasks/RefreshConfigTaskTest.java @@ -34,28 +34,20 @@ import static org.mockito.Mockito.when; import ch.qos.logback.classic.spi.ILoggingEvent; import ch.qos.logback.core.read.ListAppender; - import com.google.common.base.Charsets; import com.google.common.io.Resources; -import com.google.gson.JsonIOException; import com.google.gson.JsonObject; import com.google.gson.JsonParser; -import com.google.gson.JsonSyntaxException; - -import java.io.ByteArrayInputStream; import java.io.IOException; -import java.io.InputStream; -import java.io.InputStreamReader; import java.net.URL; -import java.nio.charset.StandardCharsets; import java.time.Duration; import java.time.Instant; import java.util.Arrays; import java.util.Collections; import java.util.HashMap; +import java.util.Optional; import java.util.Properties; import java.util.Vector; - import org.junit.jupiter.api.Test; import org.junit.jupiter.api.extension.ExtendWith; import org.mockito.Mock; @@ -66,6 +58,7 @@ import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationCo import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfig.RicConfigUpdate.Type; import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfigParser; import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfigParser.ConfigParserResult; +import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ConfigurationFile; import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ImmutableConfigParserResult; import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ImmutableRicConfig; import org.onap.ccsdk.oran.a1policymanagementservice.configuration.RicConfig; @@ -81,7 +74,6 @@ import org.onap.ccsdk.oran.a1policymanagementservice.utils.LoggingUtils; import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.api.CbsClient; import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.model.EnvProperties; import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.model.ImmutableEnvProperties; - import reactor.core.publisher.Mono; import reactor.test.StepVerifier; @@ -99,6 +91,9 @@ class RefreshConfigTaskTest { @Mock CbsClient cbsClient; + @Mock + ConfigurationFile configurationFileMock; + private static final String RIC_1_NAME = "ric1"; private static final RicConfig CORRECT_RIC_CONIFG = ImmutableRicConfig.builder() // .ricId(RIC_1_NAME) // @@ -122,13 +117,11 @@ class RefreshConfigTaskTest { private RefreshConfigTask createTestObject(boolean configFileExists, Rics rics, Policies policies, boolean stubConfigFileExists) { - doReturn("fileName").when(appConfig).getLocalConfigurationFilePath(); - doReturn(null).when(appConfig).getWebClientConfig(); - RefreshConfigTask obj = spy(new RefreshConfigTask(appConfig, rics, policies, new Services(), new PolicyTypes(), - new A1ClientFactory(appConfig))); + RefreshConfigTask obj = spy(new RefreshConfigTask(configurationFileMock, appConfig, rics, policies, + new Services(), new PolicyTypes(), new A1ClientFactory(appConfig))); if (stubConfigFileExists) { - doReturn(configFileExists).when(obj).fileExists(any()); + when(configurationFileMock.readFile()).thenReturn(Optional.empty()); } return obj; } @@ -138,7 +131,7 @@ class RefreshConfigTaskTest { refreshTaskUnderTest = this.createTestObject(CONFIG_FILE_EXISTS); refreshTaskUnderTest.systemEnvironment = new Properties(); // When - doReturn(getCorrectJson()).when(refreshTaskUnderTest).createInputStream(any()); + when(configurationFileMock.readFile()).thenReturn(getCorrectJson()); StepVerifier // .create(refreshTaskUnderTest.createRefreshTask()) // @@ -160,13 +153,12 @@ class RefreshConfigTaskTest { } @Test - void whenFileExistsButJsonIsIncorrect_thenNoRicsArePutInRepositoryAndErrorIsLogged() throws Exception { + void whenFileExistsButJsonIsIncorrect_thenNoRicsArePutInRepository() throws Exception { refreshTaskUnderTest = this.createTestObject(CONFIG_FILE_EXISTS); refreshTaskUnderTest.systemEnvironment = new Properties(); // When - final String JUNK_JSON = "{\"junk }"; - doReturn(getJsonSteam(JUNK_JSON)).when(refreshTaskUnderTest).createInputStream(any()); + when(configurationFileMock.readFile()).thenReturn(Optional.empty()); final ListAppender<ILoggingEvent> logAppender = LoggingUtils.getLogListAppender(RefreshConfigTask.class, ERROR); @@ -180,10 +172,6 @@ class RefreshConfigTaskTest { // Then verify(refreshTaskUnderTest).loadConfigurationFromFile(); assertThat(appConfig.getRicConfigs()).isEmpty(); - - await().until(() -> logAppender.list.size() > 0); - assertThat(logAppender.list.get(0).getFormattedMessage()) - .startsWith("Local configuration file not loaded: fileName, "); } @Test @@ -232,7 +220,7 @@ class RefreshConfigTaskTest { doReturn(Mono.just(props)).when(refreshTaskUnderTest).getEnvironment(any()); doReturn(Mono.just(cbsClient)).when(refreshTaskUnderTest).createCbsClient(props); - JsonObject configAsJson = getJsonRootObject(getCorrectJson()); + JsonObject configAsJson = getCorrectJson().get(); String newBaseUrl = "newBaseUrl"; modifyTheRicConfiguration(configAsJson, newBaseUrl); when(cbsClient.get(any())).thenReturn(Mono.just(configAsJson)); @@ -332,19 +320,9 @@ class RefreshConfigTaskTest { .addProperty("baseUrl", newBaseUrl); } - private JsonObject getJsonRootObject(InputStream inStream) - throws JsonIOException, JsonSyntaxException, IOException { - JsonObject rootObject = JsonParser.parseReader(new InputStreamReader(inStream)).getAsJsonObject(); - return rootObject; - } - - private static InputStream getCorrectJson() throws IOException { + private static Optional<JsonObject> getCorrectJson() throws IOException { URL url = ApplicationConfigParser.class.getClassLoader().getResource("test_application_configuration.json"); String string = Resources.toString(url, Charsets.UTF_8); - return new ByteArrayInputStream((string.getBytes(StandardCharsets.UTF_8))); - } - - private static InputStream getJsonSteam(String json) { - return new ByteArrayInputStream((json.getBytes(StandardCharsets.UTF_8))); + return Optional.of(JsonParser.parseString(string).getAsJsonObject()); } } diff --git a/a1-policy-management/src/test/java/org/onap/ccsdk/oran/a1policymanagementservice/tasks/RicSynchronizationTaskTest.java b/a1-policy-management/src/test/java/org/onap/ccsdk/oran/a1policymanagementservice/tasks/RicSynchronizationTaskTest.java index 8029741e..ea4ca97b 100644 --- a/a1-policy-management/src/test/java/org/onap/ccsdk/oran/a1policymanagementservice/tasks/RicSynchronizationTaskTest.java +++ b/a1-policy-management/src/test/java/org/onap/ccsdk/oran/a1policymanagementservice/tasks/RicSynchronizationTaskTest.java @@ -57,6 +57,7 @@ import org.onap.ccsdk.oran.a1policymanagementservice.repository.PolicyType; import org.onap.ccsdk.oran.a1policymanagementservice.repository.PolicyTypes; import org.onap.ccsdk.oran.a1policymanagementservice.repository.Ric; import org.onap.ccsdk.oran.a1policymanagementservice.repository.Ric.RicState; +import org.onap.ccsdk.oran.a1policymanagementservice.repository.Rics; import org.onap.ccsdk.oran.a1policymanagementservice.repository.Service; import org.onap.ccsdk.oran.a1policymanagementservice.repository.Services; import org.onap.ccsdk.oran.a1policymanagementservice.utils.LoggingUtils; @@ -108,12 +109,14 @@ class RicSynchronizationTaskTest { private PolicyTypes policyTypes; private Policies policies; private Services services; + private Rics rics; @BeforeEach void init() { policyTypes = new PolicyTypes(); policies = new Policies(); services = new Services(); + rics = new Rics(); RIC_1.setState(RicState.UNAVAILABLE); RIC_1.clearSupportedPolicyTypes(); } @@ -121,7 +124,8 @@ class RicSynchronizationTaskTest { private RicSynchronizationTask createTask() { ApplicationConfig config = new ApplicationConfig(); AsyncRestClientFactory restClientFactory = new AsyncRestClientFactory(config.getWebClientConfig()); - return new RicSynchronizationTask(a1ClientFactoryMock, policyTypes, policies, services, restClientFactory); + return new RicSynchronizationTask(a1ClientFactoryMock, policyTypes, policies, services, restClientFactory, + rics); }; @Test @@ -146,6 +150,7 @@ class RicSynchronizationTaskTest { @Test void ricIdlePolicyTypeInRepo_thenSynchronizationWithReuseOfTypeFromRepoAndCorrectServiceNotified() { + rics.put(RIC_1); RIC_1.setState(RicState.AVAILABLE); policyTypes.put(POLICY_TYPE_1); @@ -176,6 +181,7 @@ class RicSynchronizationTaskTest { @Test void ricIdlePolicyTypeNotInRepo_thenSynchronizationWithTypeFromRic() throws Exception { RIC_1.setState(RicState.AVAILABLE); + rics.put(RIC_1); setUpCreationOfA1Client(); simulateRicWithOnePolicyType(); @@ -198,6 +204,7 @@ class RicSynchronizationTaskTest { @Test void ricIdleAndHavePolicies_thenSynchronizationWithRecreationOfPolicies() { RIC_1.setState(RicState.AVAILABLE); + rics.put(RIC_1); Policy transientPolicy = createPolicy("transientPolicyId", true); @@ -226,6 +233,7 @@ class RicSynchronizationTaskTest { @Test void ricIdleAndErrorDeletingPoliciesFirstTime_thenSynchronizationWithDeletionOfPolicies() { RIC_1.setState(RicState.AVAILABLE); + rics.put(RIC_1); policies.put(POLICY_1); diff --git a/docs/offeredapis/swagger/pms-api.json b/docs/offeredapis/swagger/pms-api.json index b503ac0c..6ece771b 100644 --- a/docs/offeredapis/swagger/pms-api.json +++ b/docs/offeredapis/swagger/pms-api.json @@ -5,7 +5,7 @@ "summary": "Query policy type names", "deprecated": false, "produces": ["*/*"], - "operationId": "getPolicyTypesUsingGET_1", + "operationId": "getPolicyTypesUsingGET", "responses": { "200": { "schema": { @@ -51,7 +51,7 @@ "summary": "Query policy type identities", "deprecated": false, "produces": ["application/json"], - "operationId": "getPolicyTypesUsingGET", + "operationId": "getPolicyTypesUsingGET_1", "responses": { "200": { "schema": {"$ref": "#/definitions/policytype_id_list_v2"}, @@ -169,7 +169,7 @@ "summary": "Returns a policy configuration", "deprecated": false, "produces": ["*/*"], - "operationId": "getPolicyUsingGET_1", + "operationId": "getPolicyUsingGET", "responses": { "200": { "schema": {"type": "object"}, @@ -193,7 +193,7 @@ "summary": "Delete a policy", "deprecated": false, "produces": ["*/*"], - "operationId": "deletePolicyUsingDELETE_1", + "operationId": "deletePolicyUsingDELETE", "responses": { "200": {"description": "Not used"}, "401": {"description": "Unauthorized"}, @@ -222,7 +222,7 @@ "summary": "Put a policy", "deprecated": false, "produces": ["*/*"], - "operationId": "putPolicyUsingPUT_1", + "operationId": "putPolicyUsingPUT", "responses": { "200": {"description": "Policy updated"}, "201": {"description": "Policy created"}, @@ -345,7 +345,7 @@ "summary": "Returns a policy", "deprecated": false, "produces": ["application/json"], - "operationId": "getPolicyUsingGET", + "operationId": "getPolicyUsingGET_1", "responses": { "200": { "schema": {"$ref": "#/definitions/policy_info_v2"}, @@ -371,7 +371,7 @@ "summary": "Delete a policy", "deprecated": false, "produces": ["*/*"], - "operationId": "deletePolicyUsingDELETE", + "operationId": "deletePolicyUsingDELETE_1", "responses": { "200": {"description": "Not used"}, "401": {"description": "Unauthorized"}, @@ -427,7 +427,7 @@ "summary": "Query Near-RT RIC information", "deprecated": false, "produces": ["*/*"], - "operationId": "getRicsUsingGET_1", + "operationId": "getRicsUsingGET", "responses": { "200": { "schema": { @@ -457,7 +457,7 @@ "summary": "Returns a policy status", "deprecated": false, "produces": ["*/*"], - "operationId": "getPolicyStatusUsingGET_1", + "operationId": "getPolicyStatusUsingGET", "responses": { "200": { "schema": {"type": "object"}, @@ -484,7 +484,7 @@ "summary": "Returns a policy status", "deprecated": false, "produces": ["application/json"], - "operationId": "getPolicyStatusUsingGET", + "operationId": "getPolicyStatusUsingGET_1", "responses": { "200": { "schema": {"$ref": "#/definitions/policy_status_info_v2"}, @@ -511,7 +511,7 @@ "deprecated": false, "produces": ["application/json"], "description": "The call returns all Near-RT RICs that supports a given policy type identity", - "operationId": "getRicsUsingGET", + "operationId": "getRicsUsingGET_1", "responses": { "200": { "schema": {"$ref": "#/definitions/ric_info_list_v2"}, @@ -538,7 +538,7 @@ "summary": "Query policies, only policy identities returned", "deprecated": false, "produces": ["*/*"], - "operationId": "getPolicyIdsUsingGET_1", + "operationId": "getPolicyIdsUsingGET", "responses": { "200": { "schema": { @@ -725,7 +725,7 @@ "summary": "Returns the name of a RIC managing one Mananged Element", "deprecated": false, "produces": ["*/*"], - "operationId": "getRicUsingGET_1", + "operationId": "getRicUsingGET", "responses": { "200": { "schema": {"type": "string"}, @@ -823,7 +823,7 @@ "deprecated": false, "produces": ["application/json"], "description": "Either a Near-RT RIC identity or a Mananged Element identity can be specified.<br>The intention with Mananged Element identity is the ID used in O1 for accessing the traffical element (such as the ID of CU).", - "operationId": "getRicUsingGET", + "operationId": "getRicUsingGET_1", "responses": { "200": { "schema": {"$ref": "#/definitions/ric_info_v2"}, @@ -943,7 +943,7 @@ "deprecated": false, "produces": ["application/json"], "description": "Returns a list of A1 policies matching given search criteria. <br>If several query parameters are defined, the policies matching all conditions are returned.", - "operationId": "getPolicyIdsUsingGET", + "operationId": "getPolicyIdsUsingGET_1", "responses": { "200": { "schema": {"$ref": "#/definitions/policy_id_list_v2"}, @@ -988,7 +988,7 @@ "summary": "Create or update a policy", "deprecated": false, "produces": ["application/json"], - "operationId": "putPolicyUsingPUT", + "operationId": "putPolicyUsingPUT_1", "responses": { "200": {"description": "Policy updated"}, "201": {"description": "Policy created"}, @@ -1015,7 +1015,7 @@ } } }, - "host": "localhost:36953", + "host": "localhost:38465", "definitions": { "error_information": { "description": "Problem as defined in https://tools.ietf.org/html/rfc7807", @@ -1307,7 +1307,7 @@ "type": "string" }, "transient": { - "description": "the name of the service owning the policy", + "description": "if true, the policy is deleted at RIC restart. If false, its value is maintained by this service until explicitly deleted. Default false.", "type": "boolean" }, "service_id": { |