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.repository.Policies;
  39 import org.onap.ccsdk.oran.a1policymanagementservice.repository.PolicyTypes;
  40 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Ric;
  41 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Ric.RicState;
  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 @SuppressWarnings("squid:S2629") // Invoke method(s) only conditionally
  67 public class RefreshConfigTask {
  68
  69     private static final Logger logger = LoggerFactory.getLogger(RefreshConfigTask.class);
  70
  71     @Value("#{systemEnvironment}")
  72     public Properties systemEnvironment;
  73
  74     /**
  75      * The time between refreshes of the configuration. Not final so tests can
  76      * modify it.
  77      */
  78     private static Duration configRefreshInterval = Duration.ofMinutes(1);
  79
  80     final ConfigurationFile configurationFile;
  81     final ApplicationConfig appConfig;
  82     @Getter(AccessLevel.PROTECTED)
  83     private Disposable refreshTask = null;
  84     private boolean isConsulUsed = false;
  85
  86     private final Rics rics;
  87     private final A1ClientFactory a1ClientFactory;
  88     private final Policies policies;
  89     private final Services services;
  90     private final PolicyTypes policyTypes;
  91     private final AsyncRestClientFactory restClientFactory;
  92
  93     @Autowired
  94     public RefreshConfigTask(ConfigurationFile configurationFile, ApplicationConfig appConfig, Rics rics,
  95             Policies policies, Services services, PolicyTypes policyTypes, A1ClientFactory a1ClientFactory) {
  96         this.configurationFile = configurationFile;
  97         this.appConfig = appConfig;
  98         this.rics = rics;
  99         this.policies = policies;
 100         this.services = services;
 101         this.policyTypes = policyTypes;
 102         this.a1ClientFactory = a1ClientFactory;
 103         this.restClientFactory = new AsyncRestClientFactory(appConfig.getWebClientConfig());
 104     }
 105
 106     public void start() {
 107         logger.debug("Starting refreshConfigTask");
 108         stop();
 109         refreshTask = createRefreshTask() //
 110                 .subscribe(
 111                         notUsed -> logger.debug("Refreshed configuration data"), throwable -> logger
 112                                 .error("Configuration refresh terminated due to exception {}", throwable.toString()),
 113                         () -> logger.error("Configuration refresh terminated"));
 114     }
 115
 116     public void stop() {
 117         if (refreshTask != null) {
 118             refreshTask.dispose();
 119         }
 120     }
 121
 122     Flux<RicConfigUpdate.Type> createRefreshTask() {
 123         Flux<JsonObject> loadFromFile = regularInterval() //
 124                 .filter(notUsed -> !this.isConsulUsed) //
 125                 .flatMap(notUsed -> loadConfigurationFromFile()) //
 126                 .onErrorResume(this::ignoreErrorFlux) //
 127                 .doOnNext(json -> logger.debug("loadFromFile succeeded")) //
 128                 .doOnTerminate(() -> logger.error("loadFromFile Terminate"));
 129
 130         Flux<JsonObject> loadFromConsul = regularInterval() //
 131                 .flatMap(i -> getEnvironment(systemEnvironment)) //
 132                 .flatMap(this::createCbsClient) //
 133                 .flatMap(this::getFromCbs) //
 134                 .onErrorResume(this::ignoreErrorMono) //
 135                 .doOnNext(json -> logger.debug("loadFromConsul succeeded")) //
 136                 .doOnNext(json -> this.isConsulUsed = true) //
 137                 .doOnTerminate(() -> logger.error("loadFromConsul Terminated"));
 138
 139         final int CONCURRENCY = 50; // Number of RIC synched in paralell
 140
 141         return Flux.merge(loadFromFile, loadFromConsul) //
 142                 .flatMap(this::parseConfiguration) //
 143                 .flatMap(this::updateConfig, CONCURRENCY) //
 144                 .flatMap(this::handleUpdatedRicConfig) //
 145                 .doOnTerminate(() -> logger.error("Configuration refresh task is terminated"));
 146     }
 147
 148     private Flux<Long> regularInterval() {
 149         return Flux.interval(Duration.ZERO, configRefreshInterval) //
 150                 .onBackpressureDrop() //
 151                 .limitRate(1); // Limit so that only one event is emitted at a time
 152     }
 153
 154     Mono<EnvProperties> getEnvironment(Properties systemEnvironment) {
 155         return EnvironmentProcessor.readEnvironmentVariables(systemEnvironment) //
 156                 .onErrorResume(t -> Mono.empty());
 157     }
 158
 159     Mono<CbsClient> createCbsClient(EnvProperties env) {
 160         return CbsClientFactory.createCbsClient(env) //
 161                 .onErrorResume(this::ignoreErrorMono);
 162     }
 163
 164     private Mono<JsonObject> getFromCbs(CbsClient cbsClient) {
 165         try {
 166             final CbsRequest getConfigRequest = CbsRequests.getAll(RequestDiagnosticContext.create());
 167             return cbsClient.get(getConfigRequest) //
 168                     .onErrorResume(this::ignoreErrorMono);
 169         } catch (Exception e) {
 170             return ignoreErrorMono(e);
 171         }
 172     }
 173
 174     private <R> Flux<R> ignoreErrorFlux(Throwable throwable) {
 175         String errMsg = throwable.toString();
 176         logger.warn("Could not refresh application configuration. {}", errMsg);
 177         return Flux.empty();
 178     }
 179
 180     private <R> Mono<R> ignoreErrorMono(Throwable throwable) {
 181         String errMsg = throwable.toString();
 182         logger.warn("Could not refresh application configuration. {}", errMsg);
 183         return Mono.empty();
 184     }
 185
 186     private Mono<ApplicationConfigParser.ConfigParserResult> parseConfiguration(JsonObject jsonObject) {
 187         try {
 188             ApplicationConfigParser parser = new ApplicationConfigParser();
 189             return Mono.just(parser.parse(jsonObject));
 190         } catch (Exception e) {
 191             String str = e.toString();
 192             logger.error("Could not parse configuration {}", str);
 193             return Mono.empty();
 194         }
 195     }
 196
 197     private Flux<RicConfigUpdate> updateConfig(ApplicationConfigParser.ConfigParserResult config) {
 198         return this.appConfig.setConfiguration(config);
 199     }
 200
 201     private void removePoliciciesInRic(@Nullable Ric ric) {
 202         if (ric != null) {
 203             synchronizationTask().run(ric);
 204         }
 205     }
 206
 207     private RicSynchronizationTask synchronizationTask() {
 208         return new RicSynchronizationTask(a1ClientFactory, policyTypes, policies, services, restClientFactory, rics);
 209     }
 210
 211     /**
 212      * for an added RIC after a restart it is nesessary to get the suypported policy
 213      * types from the RIC unless a full synchronization is wanted.
 214      *
 215      * @param ric the ric to get supprted types from
 216      * @return the same ric
 217      */
 218     private Mono<Ric> trySyncronizeSupportedTypes(Ric ric) {
 219         logger.debug("Synchronizing policy types for new RIC: {}", ric.id());
 220         // Synchronize the policy types
 221         return this.a1ClientFactory.createA1Client(ric) //
 222                 .flatMapMany(client -> synchronizationTask().synchronizePolicyTypes(ric, client)) //
 223                 .collectList() //
 224                 .flatMap(list -> Mono.just(ric)) //
 225                 .doOnError(t -> logger.warn("Failed to synchronize types in new RIC: {}, reason: {}", ric.id(),
 226                         t.getMessage())) //
 227                 .onErrorResume(t -> Mono.just(ric));
 228     }
 229
 230     public Mono<RicConfigUpdate.Type> handleUpdatedRicConfig(RicConfigUpdate updatedInfo) {
 231         synchronized (this.rics) {
 232             String ricId = updatedInfo.getRicConfig().ricId();
 233             RicConfigUpdate.Type event = updatedInfo.getType();
 234             if (event == RicConfigUpdate.Type.ADDED) {
 235                 logger.debug("RIC added {}", ricId);
 236                 Ric ric = new Ric(updatedInfo.getRicConfig());
 237                 return trySyncronizeSupportedTypes(ric) //
 238                         .flatMap(this::addRic) //
 239                         .flatMap(notUsed -> Mono.just(event));
 240             } else if (event == RicConfigUpdate.Type.REMOVED) {
 241                 logger.debug("RIC removed {}", ricId);
 242                 Ric ric = rics.remove(ricId);
 243                 this.policies.removePoliciesForRic(ricId);
 244                 removePoliciciesInRic(ric);
 245             } else if (event == RicConfigUpdate.Type.CHANGED) {
 246                 logger.debug("RIC config updated {}", ricId);
 247                 Ric ric = this.rics.get(ricId);
 248                 if (ric == null) {
 249                     logger.error("An non existing RIC config is changed, should not happen (just for robustness)");
 250                     addRic(new Ric(updatedInfo.getRicConfig())).block();
 251                 } else {
 252                     ric.setRicConfig(updatedInfo.getRicConfig());
 253                 }
 254             }
 255             return Mono.just(event);
 256         }
 257     }
 258
 259     Mono<Ric> addRic(Ric ric) {
 260         this.rics.put(ric);
 261         if (this.appConfig.getVardataDirectory() != null) {
 262             this.policies.restoreFromDatabase(ric, this.policyTypes);
 263         }
 264         logger.debug("Added RIC: {}", ric.id());
 265
 266         ric.setState(RicState.AVAILABLE);
 267
 268         return Mono.just(ric);
 269     }
 270
 271     /**
 272      * Reads the configuration from file.
 273      */
 274     Flux<JsonObject> loadConfigurationFromFile() {
 275         Optional<JsonObject> readJson = configurationFile.readFile();
 276         if (readJson.isPresent()) {
 277             return Flux.just(readJson.get());
 278         }
 279         return Flux.empty();
 280     }
 281 }