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