servicemanager/internal/envreader/envreader.go

   1 // -
   2 //   ========================LICENSE_START=================================
   3 //   O-RAN-SC
   4 //   %%
   5 //   Copyright (C) 2024: OpenInfra Foundation Europe
   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 envreader
  22
  23 import (
  24         "os"
  25         "path/filepath"
  26         "runtime"
  27         "strconv"
  28
  29         "github.com/joho/godotenv"
  30         log "github.com/sirupsen/logrus"
  31 )
  32
  33 type ConfigReader interface {
  34     ReadDotEnv() (map[string]string, map[string]int, error)
  35 }
  36
  37 // RealConfigReader implements ConfigReader
  38 type RealConfigReader struct {
  39 }
  40
  41 func (r *RealConfigReader) ReadDotEnv() (map[string]string, map[string]int, error) {
  42         log.SetFormatter(&log.TextFormatter{
  43                 FullTimestamp: true,
  44         })
  45         setLogLevel("Info")
  46
  47         env := os.Getenv("SERVICE_MANAGER_ENV")
  48         log.Infof("read SERVICE_MANAGER_ENV: %s", env)
  49
  50         if env == "" {
  51                 env = "development"
  52         }
  53
  54         // Root folder of this project
  55         _, file, _, _ := runtime.Caller(0)
  56         basePath := filepath.Join(filepath.Dir(file), "../..")
  57         basePath += "/"
  58
  59         var myEnv map[string]string
  60         envFile := basePath + ".env." + env
  61         myEnv, err := godotenv.Read(envFile)
  62
  63         if err != nil {
  64                 log.Warnf("error reading .env file: %s", err)
  65
  66                 envFile = basePath + ".env"
  67                 myEnv, err = godotenv.Read(envFile)
  68                 if err != nil {
  69                         log.Fatalf("error reading .env file: %s", err)
  70                         return nil, nil, err
  71                 }
  72         }
  73
  74         setLogLevel(myEnv["LOG_LEVEL"])
  75         logConfig(myEnv, envFile)
  76
  77         myPorts, err := createMapPorts(myEnv)
  78         return myEnv, myPorts, err
  79 }
  80
  81 func setLogLevel(logLevel string) error {
  82         log.SetFormatter(&log.TextFormatter{
  83                 FullTimestamp: true,
  84         })
  85
  86         loglevel, err := log.ParseLevel(logLevel)
  87         if err != nil {
  88                 log.Fatalf("error loading LOG_LEVEL from .env file: %v", err)
  89                 return err
  90         }
  91         log.SetLevel(loglevel)
  92         return nil
  93 }
  94
  95 func logConfig(myEnv map[string]string, envFile string) {
  96         log.Infof("imported .env: %s", envFile)
  97
  98         log.Infof("KONG_DOMAIN %s", myEnv["KONG_DOMAIN"])
  99         log.Infof("KONG_PROTOCOL %s", myEnv["KONG_PROTOCOL"])
 100         log.Infof("KONG_CONTROL_PLANE_IPV4 %s", myEnv["KONG_CONTROL_PLANE_IPV4"])
 101         log.Infof("KONG_CONTROL_PLANE_PORT %s", myEnv["KONG_CONTROL_PLANE_PORT"])
 102         log.Infof("KONG_DATA_PLANE_IPV4 %s", myEnv["KONG_DATA_PLANE_IPV4"])
 103         log.Infof("KONG_DATA_PLANE_PORT %s", myEnv["KONG_DATA_PLANE_PORT"])
 104         log.Infof("CAPIF_PROTOCOL %s", myEnv["CAPIF_PROTOCOL"])
 105         log.Infof("CAPIF_IPV4 %s", myEnv["CAPIF_IPV4"])
 106         log.Infof("CAPIF_PORT %s", myEnv["CAPIF_PORT"])
 107         log.Infof("LOG_LEVEL %s", myEnv["LOG_LEVEL"])
 108         log.Infof("SERVICE_MANAGER_PORT %s", myEnv["SERVICE_MANAGER_PORT"])
 109         log.Infof("TEST_SERVICE_IPV4 %s", myEnv["TEST_SERVICE_IPV4"])
 110         log.Infof("TEST_SERVICE_PORT %s", myEnv["TEST_SERVICE_PORT"])
 111 }
 112
 113 func createMapPorts(myEnv map[string]string) (map[string]int, error) {
 114     myPorts := make(map[string]int)
 115         var err error
 116
 117         myPorts["KONG_DATA_PLANE_PORT"], err = strconv.Atoi(myEnv["KONG_DATA_PLANE_PORT"])
 118         if err != nil {
 119                 log.Fatalf("error loading KONG_DATA_PLANE_PORT from .env file: %s", err)
 120                 return nil, err
 121         }
 122
 123         myPorts["KONG_CONTROL_PLANE_PORT"], err = strconv.Atoi(myEnv["KONG_CONTROL_PLANE_PORT"])
 124         if err != nil {
 125                 log.Fatalf("error loading KONG_CONTROL_PLANE_PORT from .env file: %s", err)
 126                 return nil, err
 127         }
 128
 129         myPorts["CAPIF_PORT"], err = strconv.Atoi(myEnv["CAPIF_PORT"])
 130         if err != nil {
 131                 log.Fatalf("error loading CAPIF_PORT from .env file: %s", err)
 132                 return nil, err
 133         }
 134
 135         myPorts["SERVICE_MANAGER_PORT"], err = strconv.Atoi(myEnv["SERVICE_MANAGER_PORT"])
 136         if err != nil {
 137                 log.Fatalf("error loading SERVICE_MANAGER_PORT from .env file: %s", err)
 138                 return nil, err
 139         }
 140
 141         // TEST_SERVICE_PORT is required for unit testing, but not required for production
 142         if myEnv["TEST_SERVICE_PORT"] != "" {
 143                 myPorts["TEST_SERVICE_PORT"], err = strconv.Atoi(myEnv["TEST_SERVICE_PORT"])
 144                 if err != nil {
 145                         log.Fatalf("error loading TEST_SERVICE_PORT from .env file: %s", err)
 146                         return nil, err
 147                 }
 148         }
 149
 150         return myPorts, err
 151 }
 152
 153 // MockConfigReader is a mock implementation for testing
 154 type MockConfigReader struct {
 155     MockedConfig map[string]string
 156 }
 157
 158 func (m *MockConfigReader) ReadDotEnv() (map[string]string, map[string]int, error) {
 159         const envFile = "mock"
 160
 161         setLogLevel(m.MockedConfig["LOG_LEVEL"])
 162         logConfig(m.MockedConfig, envFile)
 163
 164         // Return the mocked configuration for testing
 165         myPorts, err := createMapPorts(m.MockedConfig)
 166     return m.MockedConfig, myPorts, err
 167 }