diff options
Diffstat (limited to 'dcae-analytics/dcae-analytics-web')
4 files changed, 307 insertions, 111 deletions
diff --git a/dcae-analytics/dcae-analytics-web/src/main/java/org/onap/dcae/analytics/web/config/SystemConfig.java b/dcae-analytics/dcae-analytics-web/src/main/java/org/onap/dcae/analytics/web/config/SystemConfig.java new file mode 100644 index 0000000..946c2f2 --- /dev/null +++ b/dcae-analytics/dcae-analytics-web/src/main/java/org/onap/dcae/analytics/web/config/SystemConfig.java @@ -0,0 +1,84 @@ +/*- + * ============LICENSE_START====================================================================== + * Copyright (C) 2019-2020 China Mobile. 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.dcae.analytics.web.config; + +import java.util.Optional; + +import org.onap.dcae.analytics.model.configbindingservice.ConfigBindingServiceConstants; +import org.onap.dcae.analytics.web.exception.EnvironmentLoaderException; + +/** + * + * get consul config and cbs config. + * + * @author Kai Lu + */ +public class SystemConfig { + + /** + * + * private constructor. + * + */ + private SystemConfig() { + } + + /** + * getConsulHost. + * + * @return consulHost consulHost + * + */ + public static String getConsulHost() throws EnvironmentLoaderException { + return Optional.ofNullable(ConfigBindingServiceConstants.CONSUL_HOST_ENV_VARIABLE_VALUE) + .orElseThrow(() -> new EnvironmentLoaderException("$CONSUL_HOST environment has not been defined")); + } + + /** + * getConsultPort. + * + * @return consulPort consulPort + * + */ + public static Integer getConsultPort() { + return ConfigBindingServiceConstants.DEFAULT_CONSUL_PORT_ENV_VARIABLE_VALUE; + } + + /** + * getConfigBindingService. + * + * @return configBindingService configBindingService + * + */ + public static String getConfigBindingService() throws EnvironmentLoaderException { + return Optional.ofNullable(ConfigBindingServiceConstants.CONFIG_BINDING_SERVICE_ENV_VARIABLE_VALUE) // + .orElseThrow(() -> new EnvironmentLoaderException( + "$CONFIG_BINDING_SERVICE environment has not been defined")); + } + + /** + * getService. + * + * @return service service + * + */ + public static String getService() throws EnvironmentLoaderException { + return Optional.ofNullable(ConfigBindingServiceConstants.SERVICE_NAME_ENV_VARIABLE_VALUE).orElseThrow( + () -> new EnvironmentLoaderException("$HOSTNAME have not been defined as system environment")); + } + +} diff --git a/dcae-analytics/dcae-analytics-web/src/main/java/org/onap/dcae/analytics/web/exception/EnvironmentLoaderException.java b/dcae-analytics/dcae-analytics-web/src/main/java/org/onap/dcae/analytics/web/exception/EnvironmentLoaderException.java new file mode 100644 index 0000000..0a5c14d --- /dev/null +++ b/dcae-analytics/dcae-analytics-web/src/main/java/org/onap/dcae/analytics/web/exception/EnvironmentLoaderException.java @@ -0,0 +1,33 @@ +/*- + * ============LICENSE_START======================================================= + * Copyright (C) 2019-2020 China Mobile. 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.dcae.analytics.web.exception; + +/** + * Exception thrown when there is a problem with the Consul environment. + * + * @author Kai Lu + */ +public class EnvironmentLoaderException extends Exception { + + private static final long serialVersionUID = 1L; + + public EnvironmentLoaderException(String message) { + super(message); + } +} diff --git a/dcae-analytics/dcae-analytics-web/src/main/java/org/onap/dcae/analytics/web/spring/ConfigBindingServiceEnvironmentPostProcessor.java b/dcae-analytics/dcae-analytics-web/src/main/java/org/onap/dcae/analytics/web/spring/ConfigBindingServiceEnvironmentPostProcessor.java index 2073127..59fca64 100644 --- a/dcae-analytics/dcae-analytics-web/src/main/java/org/onap/dcae/analytics/web/spring/ConfigBindingServiceEnvironmentPostProcessor.java +++ b/dcae-analytics/dcae-analytics-web/src/main/java/org/onap/dcae/analytics/web/spring/ConfigBindingServiceEnvironmentPostProcessor.java @@ -19,6 +19,7 @@ package org.onap.dcae.analytics.web.spring; +import java.time.Duration; import java.util.Arrays; import java.util.Collections; import java.util.Map; @@ -29,8 +30,16 @@ import java.util.stream.Collectors; import org.onap.dcae.analytics.model.AnalyticsProfile; import org.onap.dcae.analytics.model.configbindingservice.ConfigBindingServiceConstants; import org.onap.dcae.analytics.model.util.function.JsonStringToMapFunction; -import org.onap.dcae.analytics.model.util.supplier.ConfigBindingServiceJsonSupplier; +import org.onap.dcae.analytics.web.config.SystemConfig; import org.onap.dcae.analytics.web.exception.AnalyticsValidationException; +import org.onap.dcae.analytics.web.exception.EnvironmentLoaderException; +import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.api.CbsClient; +import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.api.CbsClientFactory; +import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.api.CbsRequests; +import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.model.CbsRequest; +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 org.onap.dcaegen2.services.sdk.rest.services.model.logging.RequestDiagnosticContext; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.boot.SpringApplication; @@ -44,6 +53,13 @@ import org.springframework.core.env.StandardEnvironment; import org.springframework.util.ClassUtils; import org.springframework.web.context.support.StandardServletEnvironment; +import com.google.gson.JsonElement; +import com.google.gson.JsonObject; + +import reactor.core.Disposable; +import reactor.core.publisher.Flux; +import reactor.core.publisher.Mono; + /** * A custom spring framework environment post processor which can fetch and populate spring context with * Config Binding Service application properties. @@ -60,63 +76,33 @@ public class ConfigBindingServiceEnvironmentPostProcessor implements Environment private static final int DEFAULT_ORDER = Ordered.HIGHEST_PRECEDENCE; + private Disposable refreshConfigTask = null; + + private ConfigurableEnvironment env = null; + + private Map<String, Object> filterKeyMap = null; + + private String configServicePropertiesKey = + ConfigBindingServiceConstants.CONFIG_BINDING_SERVICE_PROPERTIES_KEY; + @Override - public void postProcessEnvironment(final ConfigurableEnvironment environment, final SpringApplication application) { + public void postProcessEnvironment(final ConfigurableEnvironment environment, + final SpringApplication application) { final boolean isConfigServiceProfilePresent = Arrays.stream(environment.getActiveProfiles()) .anyMatch(p -> p.equalsIgnoreCase(AnalyticsProfile.CONFIG_BINDING_SERVICE_PROFILE_NAME)); if (!isConfigServiceProfilePresent) { - logger.info("Config Binding Service Profile is not active. " + - "Skipping Adding config binding service properties"); + logger.info("Config Binding Service Profile is not active. " + + "Skipping Adding config binding service properties"); return; } - logger.info("Config Binding Service Profile is active. " + - "Application properties will be fetched from config binding service"); - - // Fetch config binding service json - final Optional<String> configServiceJsonOptional = new ConfigBindingServiceJsonSupplier().get(); + logger.info("Config Binding Service Profile is active. " + + "Application properties will be fetched from config binding service"); - if (!configServiceJsonOptional.isPresent()) { - final String errorMessage = "Unable to get fetch application configuration from config binding service"; - throw new AnalyticsValidationException(errorMessage, new IllegalStateException(errorMessage)); - } - - final String configServicePropertiesKey = ConfigBindingServiceConstants.CONFIG_BINDING_SERVICE_PROPERTIES_KEY; - - // convert fetch config binding service json string to Map of property key and values - final Map<String, Object> configPropertiesMap = configServiceJsonOptional - .map(new JsonStringToMapFunction(configServicePropertiesKey)) - .orElse(Collections.emptyMap()); - - if (configPropertiesMap.isEmpty()) { - - logger.warn("No properties found in config binding service"); - - } else { - - // remove config service key prefix on spring reserved property key prefixes - final Set<String> springKeyPrefixes = ConfigBindingServiceConstants.SPRING_RESERVED_PROPERTIES_KEY_PREFIXES; - final Set<String> springKeys = springKeyPrefixes.stream() - .map(springKeyPrefix -> configServicePropertiesKey + "." + springKeyPrefix) - .collect(Collectors.toSet()); - - final Map<String, Object> filterKeyMap = configPropertiesMap.entrySet() - .stream() - .collect(Collectors.toMap( - (Map.Entry<String, Object> e) -> - springKeys.stream().anyMatch(springKey -> e.getKey().startsWith(springKey)) ? - e.getKey().substring(configServicePropertiesKey.toCharArray().length + 1) : - e.getKey(), - Map.Entry::getValue) - ); - - filterKeyMap.forEach((key, value) -> - logger.info("Adding property from config service in spring context: {} -> {}", key, value)); - - addJsonPropertySource(environment, new MapPropertySource(configServicePropertiesKey, filterKeyMap)); - } + env = environment; + initialize(); } @@ -125,9 +111,8 @@ public class ConfigBindingServiceEnvironmentPostProcessor implements Environment return DEFAULT_ORDER; } - - private void addJsonPropertySource(final ConfigurableEnvironment environment, final PropertySource<?> source) { - final MutablePropertySources sources = environment.getPropertySources(); + public synchronized void addJsonPropertySource(final MutablePropertySources sources, + final PropertySource<?> source) { final String name = findPropertySource(sources); if (sources.contains(name)) { sources.addBefore(name, source); @@ -137,12 +122,164 @@ public class ConfigBindingServiceEnvironmentPostProcessor implements Environment } private String findPropertySource(final MutablePropertySources sources) { - if (ClassUtils.isPresent(SERVLET_ENVIRONMENT_CLASS, null) && - sources.contains(StandardServletEnvironment.JNDI_PROPERTY_SOURCE_NAME)) { + if (ClassUtils.isPresent(SERVLET_ENVIRONMENT_CLASS, null) + && sources.contains(StandardServletEnvironment.JNDI_PROPERTY_SOURCE_NAME)) { return StandardServletEnvironment.JNDI_PROPERTY_SOURCE_NAME; } return StandardEnvironment.SYSTEM_PROPERTIES_PROPERTY_SOURCE_NAME; } + /** + * + * Fetch the configuration. + * + */ + public void initialize() { + stop(); + + refreshConfigTask = createRefreshTask() // + .subscribe(e -> logger.info("Refreshed configuration data"), + throwable -> logger.error("Configuration refresh terminated due to exception", throwable), + () -> logger.error("Configuration refresh terminated")); + } + + /** + * Fetch the configuration task from CBS. + * + */ + private Flux<String> createRefreshTask() { + return readEnvironmentVariables() // + .flatMap(this::createCbsClient) // + .flatMapMany(this::periodicConfigurationUpdates) // + .map(this::parseTcaConfig) // + .onErrorResume(this::onErrorResume); + } + + /** + * periodicConfigurationUpdates. + * + * @param cbsClient cbsClient + * @return configuration refreshed + * + */ + public Flux<JsonObject> periodicConfigurationUpdates(CbsClient cbsClient) { + final Duration initialDelay = Duration.ZERO; + final Duration refreshPeriod = + Duration.ofMinutes(ConfigBindingServiceConstants.CONFIG_SERVICE_REFRESHPERIOD); + final CbsRequest getConfigRequest = CbsRequests.getAll(RequestDiagnosticContext.create()); + return cbsClient.updates(getConfigRequest, initialDelay, refreshPeriod); + } + + /** + * + * get environment variables. + * + * @return environment properties. + * + */ + public Mono<EnvProperties> readEnvironmentVariables() { + logger.trace("Loading configuration from system environment variables"); + EnvProperties envProperties; + try { + envProperties = ImmutableEnvProperties.builder() // + .consulHost(SystemConfig.getConsulHost()) // + .consulPort(SystemConfig.getConsultPort()) // + .cbsName(SystemConfig.getConfigBindingService()) // + .appName(SystemConfig.getService()) // + .build(); + } catch (EnvironmentLoaderException e) { + return Mono.error(e); + } + logger.trace("Evaluated environment system variables {}", envProperties); + return Mono.just(envProperties); + } + + /** + * Stops the refreshing of the configuration. + * + */ + public void stop() { + if (refreshConfigTask != null) { + refreshConfigTask.dispose(); + refreshConfigTask = null; + } + } + + /** + * periodicConfigurationUpdates. + * + * @param throwable throwable + * @return Mono + * + */ + private <R> Mono<R> onErrorResume(Throwable throwable) { + logger.error("Could not refresh application configuration {}", throwable.toString()); + return Mono.empty(); + } + + /** + * create CbsClient. + * + * @param env environment properties + * @return cbsclient + * + */ + public Mono<CbsClient> createCbsClient(EnvProperties env) { + return CbsClientFactory.createCbsClient(env); + } + + /** + * Parse configuration. + * + * @param jsonObject the TCA service's configuration + * @return this + * + */ + public String parseTcaConfig(JsonObject jsonObject) { + + JsonElement jsonConfig = jsonObject.get(ConfigBindingServiceConstants.CONFIG); + + Optional<String> configServiceJsonOptional = Optional.of(jsonConfig.toString()); + if (!configServiceJsonOptional.isPresent()) { + final String errorMessage = + "Unable to get fetch application configuration from config binding service"; + throw new AnalyticsValidationException(errorMessage, + new IllegalStateException(errorMessage)); + } + + // convert fetch config binding service json string to Map of property key and + // values + Map<String, Object> configPropertiesMap = configServiceJsonOptional + .map(new JsonStringToMapFunction(configServicePropertiesKey)).orElse(Collections.emptyMap()); + + if (configPropertiesMap.isEmpty()) { + + logger.warn("No properties found in config binding service"); + + } else { + + // remove config service key prefix on spring reserved property key prefixes + final Set<String> springKeyPrefixes = + ConfigBindingServiceConstants.SPRING_RESERVED_PROPERTIES_KEY_PREFIXES; + final Set<String> springKeys = springKeyPrefixes.stream() + .map(springKeyPrefix -> configServicePropertiesKey + "." + springKeyPrefix) + .collect(Collectors.toSet()); + + filterKeyMap = configPropertiesMap.entrySet().stream() + .collect(Collectors.toMap((Map.Entry<String, Object> e) -> springKeys.stream() + .anyMatch(springKey -> e.getKey().startsWith(springKey)) + ? e.getKey().substring(configServicePropertiesKey.toCharArray().length + 1) + : e.getKey(), + Map.Entry::getValue)); + + filterKeyMap.forEach((key, value) -> logger + .info("Adding property from config service in spring context: {} -> {}", key, value)); + MutablePropertySources sources = env.getPropertySources(); + addJsonPropertySource(sources, new MapPropertySource(configServicePropertiesKey, filterKeyMap)); + + } + return configServiceJsonOptional.get(); + } + } diff --git a/dcae-analytics/dcae-analytics-web/src/test/java/org/onap/dcae/analytics/web/spring/ConfigBindingServiceEnvironmentPostProcessorTest.java b/dcae-analytics/dcae-analytics-web/src/test/java/org/onap/dcae/analytics/web/spring/ConfigBindingServiceEnvironmentPostProcessorTest.java deleted file mode 100644 index 5506342..0000000 --- a/dcae-analytics/dcae-analytics-web/src/test/java/org/onap/dcae/analytics/web/spring/ConfigBindingServiceEnvironmentPostProcessorTest.java +++ /dev/null @@ -1,58 +0,0 @@ -/* - * ================================================================================ - * Copyright (c) 2018 AT&T Intellectual Property. 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.dcae.analytics.web.spring; - -import org.junit.jupiter.api.Assertions; -import org.junit.jupiter.api.BeforeAll; -import org.junit.jupiter.api.Test; -import org.mockito.Mockito; -import org.onap.dcae.analytics.model.AnalyticsProfile; -import org.onap.dcae.analytics.web.BaseAnalyticsWebTest; -import org.onap.dcae.analytics.web.exception.AnalyticsValidationException; -import org.springframework.boot.SpringApplication; -import org.springframework.core.env.ConfigurableEnvironment; -import org.springframework.core.env.MutablePropertySources; - -class ConfigBindingServiceEnvironmentPostProcessorTest extends BaseAnalyticsWebTest { - - @BeforeAll - static void beforeAll() throws Exception { - BaseAnalyticsWebTest.initializeConfigBindingServiceEnvironmentVariables(); - } - - - @Test - void postProcessEnvironment() { - - Assertions.assertThrows(AnalyticsValidationException.class, () -> { - - final ConfigBindingServiceEnvironmentPostProcessor configBindingServiceEnvironmentPostProcessor = - new ConfigBindingServiceEnvironmentPostProcessor(); - - final ConfigurableEnvironment configurableEnvironment = Mockito.mock(ConfigurableEnvironment.class); - final SpringApplication springApplication = Mockito.mock(SpringApplication.class); - final String[] activeProfiles = {AnalyticsProfile.CONFIG_BINDING_SERVICE_PROFILE_NAME}; - Mockito.when(configurableEnvironment.getActiveProfiles()).thenReturn(activeProfiles); - - configBindingServiceEnvironmentPostProcessor - .postProcessEnvironment(configurableEnvironment, springApplication); - }); - } -} |