policy-agent/src/main/java/org/oransc/policyagent/tasks/EnvironmentProcessor.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 java.util.Optional;
  24 import java.util.Properties;
  25
  26 import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.model.EnvProperties;
  27 import org.onap.dcaegen2.services.sdk.rest.services.cbs.client.model.ImmutableEnvProperties;
  28 import org.oransc.policyagent.exceptions.EnvironmentLoaderException;
  29 import org.slf4j.Logger;
  30 import org.slf4j.LoggerFactory;
  31 import reactor.core.publisher.Mono;
  32
  33 /**
  34  * This class reads a few environment variables used for locating the Consul
  35  * (Config Binding Service).
  36  */
  37 class EnvironmentProcessor {
  38
  39     private static final int DEFAULT_CONSUL_PORT = 8500;
  40     private static final Logger logger = LoggerFactory.getLogger(EnvironmentProcessor.class);
  41
  42     private EnvironmentProcessor() {
  43     }
  44
  45     static Mono<EnvProperties> readEnvironmentVariables(Properties systemEnvironment) {
  46
  47         EnvProperties envProperties;
  48         try {
  49             envProperties = ImmutableEnvProperties.builder() //
  50                 .consulHost(getConsulHost(systemEnvironment)) //
  51                 .consulPort(getConsultPort(systemEnvironment)) //
  52                 .cbsName(getConfigBindingService(systemEnvironment)) //
  53                 .appName(getService(systemEnvironment)) //
  54                 .build();
  55         } catch (EnvironmentLoaderException e) {
  56             return Mono.error(e);
  57         }
  58         logger.trace("Evaluated environment system variables {}", envProperties);
  59         return Mono.just(envProperties);
  60     }
  61
  62     private static String getConsulHost(Properties systemEnvironments) throws EnvironmentLoaderException {
  63         return Optional.ofNullable(systemEnvironments.getProperty("CONSUL_HOST"))
  64             .orElseThrow(() -> new EnvironmentLoaderException("$CONSUL_HOST environment has not been defined"));
  65     }
  66
  67     private static Integer getConsultPort(Properties systemEnvironments) {
  68         return Optional.ofNullable(systemEnvironments.getProperty("CONSUL_PORT")) //
  69             .map(Integer::valueOf) //
  70             .orElseGet(EnvironmentProcessor::getDefaultPortOfConsul);
  71     }
  72
  73     private static String getConfigBindingService(Properties systemEnvironments) throws EnvironmentLoaderException {
  74         return Optional.ofNullable(systemEnvironments.getProperty("CONFIG_BINDING_SERVICE")) //
  75             .orElseThrow(
  76                 () -> new EnvironmentLoaderException("$CONFIG_BINDING_SERVICE environment has not been defined"));
  77     }
  78
  79     private static String getService(Properties systemEnvironments) throws EnvironmentLoaderException {
  80         return Optional
  81             .ofNullable(Optional.ofNullable(systemEnvironments.getProperty("HOSTNAME"))
  82                 .orElse(systemEnvironments.getProperty("SERVICE_NAME")))
  83             .orElseThrow(() -> new EnvironmentLoaderException(
  84                 "Neither $HOSTNAME/$SERVICE_NAME have not been defined as system environment"));
  85     }
  86
  87     private static Integer getDefaultPortOfConsul() {
  88         logger.warn("$CONSUL_PORT variable will be set to default port {}", DEFAULT_CONSUL_PORT);
  89         return DEFAULT_CONSUL_PORT;
  90     }
  91 }