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 com.google.gson.JsonObject;
  24
  25 import java.time.Duration;
  26 import java.util.Optional;
  27 import java.util.Properties;
  28
  29 import lombok.AccessLevel;
  30 import lombok.Getter;
  31
  32 import org.onap.ccsdk.oran.a1policymanagementservice.clients.A1ClientFactory;
  33 import org.onap.ccsdk.oran.a1policymanagementservice.clients.AsyncRestClientFactory;
  34 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfig;
  35 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfig.RicConfigUpdate;
  36 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfigParser;
  37 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ConfigurationFile;
  38 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.RicConfig;
  39 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policies;
  40 import org.onap.ccsdk.oran.a1policymanagementservice.repository.PolicyTypes;
  41 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Ric;
  42 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Rics;
  43 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Services;
  44 import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.api.CbsClient;
  45 import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.api.CbsClientFactory;
  46 import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.api.CbsRequests;
  47 import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.model.CbsRequest;
  48 import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.model.EnvProperties;
  49 import org.onap.dcaegen2.services.sdk.rest.services.model.logging.RequestDiagnosticContext;
  50 import org.slf4j.Logger;
  51 import org.slf4j.LoggerFactory;
  52 import org.springframework.beans.factory.annotation.Autowired;
  53 import org.springframework.beans.factory.annotation.Value;
  54 import org.springframework.stereotype.Component;
  55
  56 import reactor.core.Disposable;
  57 import reactor.core.publisher.Flux;
  58 import reactor.core.publisher.Mono;
  59 import reactor.util.annotation.Nullable;
  60
  61 /**
  62  * Regularly refreshes the configuration from Consul or from a local
  63  * configuration file.
  64  */
  65 @Component
  66 public class RefreshConfigTask {
  67
  68     private static final Logger logger = LoggerFactory.getLogger(RefreshConfigTask.class);
  69
  70     @Value("#{systemEnvironment}")
  71     public Properties systemEnvironment;
  72
  73     /**
  74      * The time between refreshes of the configuration. Not final so tests can
  75      * modify it.
  76      */
  77     private static Duration configRefreshInterval = Duration.ofMinutes(1);
  78
  79     final ConfigurationFile configurationFile;
  80     final ApplicationConfig appConfig;
  81     @Getter(AccessLevel.PROTECTED)
  82     private Disposable refreshTask = null;
  83     private boolean isConsulUsed = false;
  84
  85     private final Rics rics;
  86     private final A1ClientFactory a1ClientFactory;
  87     private final Policies policies;
  88     private final Services services;
  89     private final PolicyTypes policyTypes;
  90     private final AsyncRestClientFactory restClientFactory;
  91
  92     @Autowired
  93     public RefreshConfigTask(ConfigurationFile configurationFile, ApplicationConfig appConfig, Rics rics,
  94             Policies policies, Services services, PolicyTypes policyTypes, A1ClientFactory a1ClientFactory) {
  95         this.configurationFile = configurationFile;
  96         this.appConfig = appConfig;
  97         this.rics = rics;
  98         this.policies = policies;
  99         this.services = services;
 100         this.policyTypes = policyTypes;
 101         this.a1ClientFactory = a1ClientFactory;
 102         this.restClientFactory = new AsyncRestClientFactory(appConfig.getWebClientConfig());
 103     }
 104
 105     public void start() {
 106         logger.debug("Starting refreshConfigTask");
 107         stop();
 108         refreshTask = createRefreshTask() //
 109                 .subscribe(
 110                         notUsed -> logger.debug("Refreshed configuration data"), throwable -> logger
 111                                 .error("Configuration refresh terminated due to exception {}", throwable.toString()),
 112                         () -> logger.error("Configuration refresh terminated"));
 113     }
 114
 115     public void stop() {
 116         if (refreshTask != null) {
 117             refreshTask.dispose();
 118         }
 119     }
 120
 121     Flux<RicConfigUpdate.Type> createRefreshTask() {
 122         Flux<JsonObject> loadFromFile = Flux.interval(Duration.ZERO, configRefreshInterval) //
 123                 .filter(notUsed -> !this.isConsulUsed) //
 124                 .flatMap(notUsed -> loadConfigurationFromFile()) //
 125                 .onErrorResume(this::ignoreErrorFlux) //
 126                 .doOnNext(json -> logger.debug("loadFromFile succeeded")) //
 127                 .doOnTerminate(() -> logger.error("loadFromFile Terminate"));
 128
 129         Flux<JsonObject> loadFromConsul = Flux.interval(Duration.ZERO, configRefreshInterval) //
 130                 .flatMap(i -> getEnvironment(systemEnvironment)) //
 131                 .flatMap(this::createCbsClient) //
 132                 .flatMap(this::getFromCbs) //
 133                 .onErrorResume(this::ignoreErrorMono) //
 134                 .doOnNext(json -> logger.debug("loadFromConsul succeeded")) //
 135                 .doOnNext(json -> this.isConsulUsed = true) //
 136                 .doOnTerminate(() -> logger.error("loadFromConsul Terminated"));
 137
 138         return Flux.merge(loadFromFile, loadFromConsul) //
 139                 .flatMap(this::parseConfiguration) //
 140                 .flatMap(this::updateConfig) //
 141                 .doOnNext(this::handleUpdatedRicConfig) //
 142                 .flatMap(configUpdate -> Flux.just(configUpdate.getType())) //
 143                 .doOnTerminate(() -> logger.error("Configuration refresh task is terminated"));
 144     }
 145
 146     Mono<EnvProperties> getEnvironment(Properties systemEnvironment) {
 147         return EnvironmentProcessor.readEnvironmentVariables(systemEnvironment) //
 148                 .onErrorResume(t -> Mono.empty());
 149     }
 150
 151     Mono<CbsClient> createCbsClient(EnvProperties env) {
 152         return CbsClientFactory.createCbsClient(env) //
 153                 .onErrorResume(this::ignoreErrorMono);
 154     }
 155
 156     private Mono<JsonObject> getFromCbs(CbsClient cbsClient) {
 157         try {
 158             final CbsRequest getConfigRequest = CbsRequests.getAll(RequestDiagnosticContext.create());
 159             return cbsClient.get(getConfigRequest) //
 160                     .onErrorResume(this::ignoreErrorMono);
 161         } catch (Exception e) {
 162             return ignoreErrorMono(e);
 163         }
 164     }
 165
 166     private <R> Flux<R> ignoreErrorFlux(Throwable throwable) {
 167         String errMsg = throwable.toString();
 168         logger.warn("Could not refresh application configuration. {}", errMsg);
 169         return Flux.empty();
 170     }
 171
 172     private <R> Mono<R> ignoreErrorMono(Throwable throwable) {
 173         String errMsg = throwable.toString();
 174         logger.warn("Could not refresh application configuration. {}", errMsg);
 175         return Mono.empty();
 176     }
 177
 178     private Mono<ApplicationConfigParser.ConfigParserResult> parseConfiguration(JsonObject jsonObject) {
 179         try {
 180             ApplicationConfigParser parser = new ApplicationConfigParser();
 181             return Mono.just(parser.parse(jsonObject));
 182         } catch (Exception e) {
 183             String str = e.toString();
 184             logger.error("Could not parse configuration {}", str);
 185             return Mono.empty();
 186         }
 187     }
 188
 189     private Flux<RicConfigUpdate> updateConfig(ApplicationConfigParser.ConfigParserResult config) {
 190         return this.appConfig.setConfiguration(config);
 191     }
 192
 193     private void removePoliciciesInRic(@Nullable Ric ric) {
 194         if (ric != null) {
 195             RicSynchronizationTask synch = new RicSynchronizationTask(a1ClientFactory, policyTypes, policies, services,
 196                     restClientFactory, rics);
 197             synch.run(ric);
 198         }
 199     }
 200
 201     private void handleUpdatedRicConfig(RicConfigUpdate updatedInfo) {
 202         synchronized (this.rics) {
 203             String ricId = updatedInfo.getRicConfig().ricId();
 204             RicConfigUpdate.Type event = updatedInfo.getType();
 205             if (event == RicConfigUpdate.Type.ADDED) {
 206                 logger.debug("RIC added {}", ricId);
 207                 addRic(updatedInfo.getRicConfig());
 208             } else if (event == RicConfigUpdate.Type.REMOVED) {
 209                 logger.debug("RIC removed {}", ricId);
 210                 Ric ric = rics.remove(ricId);
 211                 this.policies.removePoliciesForRic(ricId);
 212                 removePoliciciesInRic(ric);
 213             } else if (event == RicConfigUpdate.Type.CHANGED) {
 214                 logger.debug("RIC config updated {}", ricId);
 215                 Ric ric = this.rics.get(ricId);
 216                 if (ric == null) {
 217                     logger.error("An non existing RIC config is changed, should not happen (just for robustness)");
 218                     addRic(updatedInfo.getRicConfig());
 219                 } else {
 220                     ric.setRicConfig(updatedInfo.getRicConfig());
 221                 }
 222             }
 223         }
 224     }
 225
 226     private void addRic(RicConfig config) {
 227         Ric ric = new Ric(config);
 228         this.rics.put(ric);
 229         if (this.appConfig.getVardataDirectory() != null) {
 230             this.policies.restoreFromDatabase(ric, this.policyTypes);
 231         }
 232         runRicSynchronization(ric);
 233     }
 234
 235     void runRicSynchronization(Ric ric) {
 236         RicSynchronizationTask synchronizationTask =
 237                 new RicSynchronizationTask(a1ClientFactory, policyTypes, policies, services, restClientFactory, rics);
 238         synchronizationTask.run(ric);
 239     }
 240
 241     /**
 242      * Reads the configuration from file.
 243      */
 244     Flux<JsonObject> loadConfigurationFromFile() {
 245         Optional<JsonObject> readJson = configurationFile.readFile();
 246         if (readJson.isPresent()) {
 247             return Flux.just(readJson.get());
 248         }
 249         return Flux.empty();
 250     }
 251 }