a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/tasks/RefreshConfigTask.java

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