policy-agent/src/main/java/org/oransc/policyagent/tasks/RefreshConfigTask.java

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