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