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