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::ignoreErrorFlux) //
 128             .doOnNext(json -> logger.debug("loadFromFile succeeded")) //
 129             .doOnTerminate(() -> logger.error("loadFromFile Terminate"));
 130
 131         Flux<JsonObject> loadFromConsul = Flux.interval(Duration.ZERO, CONSUL_CONFIG_REFRESH_INTERVAL) //
 132             .flatMap(i -> getEnvironment(systemEnvironment)) //
 133             .flatMap(this::createCbsClient) //
 134             .flatMap(this::getFromCbs) //
 135             .doOnNext(json -> logger.debug("loadFromConsul succeeded")) //
 136             .doOnNext(json -> this.isConsulUsed = true) //
 137             .doOnTerminate(() -> logger.error("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(() -> logger.error("Configuration refresh task is terminated"));
 145     }
 146
 147     Mono<EnvProperties> getEnvironment(Properties systemEnvironment) {
 148         return EnvironmentProcessor.readEnvironmentVariables(systemEnvironment) //
 149             .onErrorResume(t -> Mono.empty());
 150     }
 151
 152     Mono<CbsClient> createCbsClient(EnvProperties env) {
 153         return CbsClientFactory.createCbsClient(env) //
 154             .onErrorResume(this::ignoreErrorMono);
 155     }
 156
 157     private Mono<JsonObject> getFromCbs(CbsClient cbsClient) {
 158         final CbsRequest getConfigRequest = CbsRequests.getAll(RequestDiagnosticContext.create());
 159         return cbsClient.get(getConfigRequest) //
 160             .onErrorResume(this::ignoreErrorMono);
 161     }
 162
 163     private <R> Flux<R> ignoreErrorFlux(Throwable throwable) {
 164         String errMsg = throwable.toString();
 165         logger.warn("Could not refresh application configuration. {}", errMsg);
 166         return Flux.empty();
 167     }
 168
 169     private <R> Mono<R> ignoreErrorMono(Throwable throwable) {
 170         String errMsg = throwable.toString();
 171         logger.warn("Could not refresh application configuration. {}", errMsg);
 172         return Mono.empty();
 173     }
 174
 175     private Mono<ApplicationConfigParser.ConfigParserResult> parseConfiguration(JsonObject jsonObject) {
 176         try {
 177             ApplicationConfigParser parser = new ApplicationConfigParser();
 178             return Mono.just(parser.parse(jsonObject));
 179         } catch (ServiceException e) {
 180             String str = e.toString();
 181             logger.error("Could not parse configuration {}", str);
 182             return Mono.empty();
 183         }
 184     }
 185
 186     private Flux<RicConfigUpdate> updateConfig(ApplicationConfigParser.ConfigParserResult config) {
 187         return this.appConfig.setConfiguration(config);
 188     }
 189
 190     boolean configFileExists() {
 191         String filepath = appConfig.getLocalConfigurationFilePath();
 192         return (filepath != null && (new File(filepath).exists()));
 193     }
 194
 195     private void handleUpdatedRicConfig(RicConfigUpdate updatedInfo) {
 196         synchronized (this.rics) {
 197             String ricName = updatedInfo.getRicConfig().name();
 198             RicConfigUpdate.Type event = updatedInfo.getType();
 199             if (event == RicConfigUpdate.Type.ADDED) {
 200                 addRic(updatedInfo.getRicConfig());
 201             } else if (event == RicConfigUpdate.Type.REMOVED) {
 202                 rics.remove(ricName);
 203                 this.policies.removePoliciesForRic(ricName);
 204             } else if (event == RicConfigUpdate.Type.CHANGED) {
 205                 Ric ric = this.rics.get(ricName);
 206                 if (ric == null) {
 207                     // Should not happen,just for robustness
 208                     addRic(updatedInfo.getRicConfig());
 209                 } else {
 210                     ric.setRicConfig(updatedInfo.getRicConfig());
 211                 }
 212             }
 213         }
 214     }
 215
 216     private void addRic(RicConfig config) {
 217         Ric ric = new Ric(config);
 218         this.rics.put(ric);
 219         runRicSynchronization(ric);
 220     }
 221
 222     void runRicSynchronization(Ric ric) {
 223         RicSynchronizationTask synchronizationTask =
 224             new RicSynchronizationTask(a1ClientFactory, policyTypes, policies, services);
 225         synchronizationTask.run(ric);
 226     }
 227
 228     /**
 229      * Reads the configuration from file.
 230      */
 231     Flux<JsonObject> loadConfigurationFromFile() {
 232         String filepath = appConfig.getLocalConfigurationFilePath();
 233         GsonBuilder gsonBuilder = new GsonBuilder();
 234         ServiceLoader.load(TypeAdapterFactory.class).forEach(gsonBuilder::registerTypeAdapterFactory);
 235
 236         try (InputStream inputStream = createInputStream(filepath)) {
 237             JsonObject rootObject = getJsonElement(inputStream).getAsJsonObject();
 238             ApplicationConfigParser appParser = new ApplicationConfigParser();
 239             appParser.parse(rootObject);
 240             logger.debug("Local configuration file loaded: {}", filepath);
 241             return Flux.just(rootObject);
 242         } catch (Exception e) {
 243             logger.error("Local configuration file not loaded: {}, {}", filepath, e.getMessage());
 244             return Flux.empty();
 245         }
 246     }
 247
 248     JsonElement getJsonElement(InputStream inputStream) {
 249         return JsonParser.parseReader(new InputStreamReader(inputStream));
 250     }
 251
 252     InputStream createInputStream(@NotNull String filepath) throws IOException {
 253         return new BufferedInputStream(new FileInputStream(filepath));
 254     }
 255 }