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.JsonElement;
  24 import com.google.gson.JsonObject;
  25 import com.google.gson.JsonParser;
  26
  27 import java.io.BufferedInputStream;
  28 import java.io.File;
  29 import java.io.FileInputStream;
  30 import java.io.IOException;
  31 import java.io.InputStream;
  32 import java.io.InputStreamReader;
  33 import java.time.Duration;
  34 import java.util.Properties;
  35
  36 import javax.validation.constraints.NotNull;
  37
  38 import lombok.AccessLevel;
  39 import lombok.Getter;
  40
  41 import org.onap.ccsdk.oran.a1policymanagementservice.clients.A1ClientFactory;
  42 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfig;
  43 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfig.RicConfigUpdate;
  44 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfigParser;
  45 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.RicConfig;
  46 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policies;
  47 import org.onap.ccsdk.oran.a1policymanagementservice.repository.PolicyTypes;
  48 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Ric;
  49 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Rics;
  50 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Services;
  51 import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.api.CbsClient;
  52 import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.api.CbsClientFactory;
  53 import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.api.CbsRequests;
  54 import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.model.CbsRequest;
  55 import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.model.EnvProperties;
  56 import org.onap.dcaegen2.services.sdk.rest.services.model.logging.RequestDiagnosticContext;
  57 import org.slf4j.Logger;
  58 import org.slf4j.LoggerFactory;
  59 import org.springframework.beans.factory.annotation.Autowired;
  60 import org.springframework.beans.factory.annotation.Value;
  61 import org.springframework.stereotype.Component;
  62
  63 import reactor.core.Disposable;
  64 import reactor.core.publisher.Flux;
  65 import reactor.core.publisher.Mono;
  66
  67 /**
  68  * Regularly refreshes the configuration from Consul or from a local
  69  * configuration file.
  70  */
  71 @Component
  72 public class RefreshConfigTask {
  73
  74     private static final Logger logger = LoggerFactory.getLogger(RefreshConfigTask.class);
  75
  76     @Value("#{systemEnvironment}")
  77     public Properties systemEnvironment;
  78
  79     /**
  80      * The time between refreshes of the configuration.
  81      */
  82     static final Duration CONFIG_REFRESH_INTERVAL = Duration.ofMinutes(1);
  83
  84     final ApplicationConfig appConfig;
  85     @Getter(AccessLevel.PROTECTED)
  86     private Disposable refreshTask = null;
  87     private boolean isConsulUsed = false;
  88
  89     private final Rics rics;
  90     private final A1ClientFactory a1ClientFactory;
  91     private final Policies policies;
  92     private final Services services;
  93     private final PolicyTypes policyTypes;
  94
  95     @Autowired
  96     public RefreshConfigTask(ApplicationConfig appConfig, Rics rics, Policies policies, Services services,
  97         PolicyTypes policyTypes, A1ClientFactory a1ClientFactory) {
  98         this.appConfig = appConfig;
  99         this.rics = rics;
 100         this.policies = policies;
 101         this.services = services;
 102         this.policyTypes = policyTypes;
 103         this.a1ClientFactory = a1ClientFactory;
 104     }
 105
 106     public void start() {
 107         logger.debug("Starting refreshConfigTask");
 108         stop();
 109         refreshTask = createRefreshTask() //
 110             .subscribe(notUsed -> logger.debug("Refreshed configuration data"),
 111                 throwable -> logger.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, CONFIG_REFRESH_INTERVAL) //
 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, CONFIG_REFRESH_INTERVAL) //
 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     boolean fileExists(String filepath) {
 194         return (filepath != null && (new File(filepath).exists()));
 195     }
 196
 197     private void handleUpdatedRicConfig(RicConfigUpdate updatedInfo) {
 198         synchronized (this.rics) {
 199             String ricId = updatedInfo.getRicConfig().ricId();
 200             RicConfigUpdate.Type event = updatedInfo.getType();
 201             if (event == RicConfigUpdate.Type.ADDED) {
 202                 addRic(updatedInfo.getRicConfig());
 203             } else if (event == RicConfigUpdate.Type.REMOVED) {
 204                 rics.remove(ricId);
 205                 this.policies.removePoliciesForRic(ricId);
 206             } else if (event == RicConfigUpdate.Type.CHANGED) {
 207                 Ric ric = this.rics.get(ricId);
 208                 if (ric == null) {
 209                     // Should not happen,just for robustness
 210                     addRic(updatedInfo.getRicConfig());
 211                 } else {
 212                     ric.setRicConfig(updatedInfo.getRicConfig());
 213                 }
 214             }
 215         }
 216     }
 217
 218     private void addRic(RicConfig config) {
 219         Ric ric = new Ric(config);
 220         this.rics.put(ric);
 221         runRicSynchronization(ric);
 222     }
 223
 224     void runRicSynchronization(Ric ric) {
 225         RicSynchronizationTask synchronizationTask =
 226             new RicSynchronizationTask(a1ClientFactory, policyTypes, policies, services);
 227         synchronizationTask.run(ric);
 228     }
 229
 230     /**
 231      * Reads the configuration from file.
 232      */
 233     Flux<JsonObject> loadConfigurationFromFile() {
 234         String filepath = appConfig.getLocalConfigurationFilePath();
 235         if (!fileExists(filepath)) {
 236             return Flux.empty();
 237         }
 238
 239         try (InputStream inputStream = createInputStream(filepath)) {
 240             JsonObject rootObject = getJsonElement(inputStream).getAsJsonObject();
 241             ApplicationConfigParser appParser = new ApplicationConfigParser();
 242             appParser.parse(rootObject);
 243             logger.debug("Local configuration file loaded: {}", filepath);
 244             return Flux.just(rootObject);
 245         } catch (Exception e) {
 246             logger.error("Local configuration file not loaded: {}, {}", filepath, e.getMessage());
 247             return Flux.empty();
 248         }
 249     }
 250
 251     JsonElement getJsonElement(InputStream inputStream) {
 252         return JsonParser.parseReader(new InputStreamReader(inputStream));
 253     }
 254
 255     InputStream createInputStream(@NotNull String filepath) throws IOException {
 256         return new BufferedInputStream(new FileInputStream(filepath));
 257     }
 258 }