config

Documentation

Overview

Package config provides the functionality to read environment variables it has the power to read from a static config file or from a remote config server

Index

• type GoDotEnvProvider
  • func NewGoDotEnvProvider(l logger, configFolder string) *GoDotEnvProvider
  • func (g *GoDotEnvProvider) Get(key string) string
  • func (g *GoDotEnvProvider) GetOrDefault(key, defaultValue string) string
• type MockConfig
  • func (m *MockConfig) Get(key string) string
  • func (m *MockConfig) GetOrDefault(key, defaultValue string) string
• type RemoteConfig
  • func NewRemoteConfigProvider(localConfig config, remoteConfigURL, appName string, logger logger) *RemoteConfig
  • func (r *RemoteConfig) Get(key string) string
  • func (r *RemoteConfig) GetOrDefault(key, defaultValue string) string

Types

type GoDotEnvProvider

type GoDotEnvProvider struct {
	// contains filtered or unexported fields
}

func NewGoDotEnvProvider

func NewGoDotEnvProvider(l logger, configFolder string) *GoDotEnvProvider

NewGoDotEnvProvider creates a new instance of GoDotEnvProvider.

func (*GoDotEnvProvider) Get

func (g *GoDotEnvProvider) Get(key string) string

Get retrieves the value of an environment variable by its key.

func (*GoDotEnvProvider) GetOrDefault

func (g *GoDotEnvProvider) GetOrDefault(key, defaultValue string) string

GetOrDefault retrieves the value of an environment variable by its key, or returns a default value if the variable is not set.

type MockConfig

type MockConfig struct {
	Data map[string]string
}

MockConfig is a mock type that can be used for testing purposes wherever GoDotEnvProvider's methods are called

func (*MockConfig) Get

func (m *MockConfig) Get(key string) string

Get retrieves the value of a configuration parameter by its key. If the key exists in the map, it returns the corresponding value else it returns the empty string.

func (*MockConfig) GetOrDefault

func (m *MockConfig) GetOrDefault(key, defaultValue string) string

GetOrDefault retrieves the value of a configuration parameter by its key. If the key exists in the map, it returns the corresponding value else it returns the specified defaultValue.

type RemoteConfig

type RemoteConfig struct {
	// contains filtered or unexported fields
}

RemoteConfig holds the information about the remote config server to maintain and manage the configs for the application using a Remote Override Service

func NewRemoteConfigProvider

func NewRemoteConfigProvider(localConfig config, remoteConfigURL, appName string, logger logger) *RemoteConfig

NewRemoteConfigProvider creates a new instance of RemoteConfig for fetching remote configurations.

func (*RemoteConfig) Get

func (r *RemoteConfig) Get(key string) string

Get retrieves a configuration value by its key. It first checks the remote configurations, and if not found, falls back to the local configurations.

func (*RemoteConfig) GetOrDefault

func (r *RemoteConfig) GetOrDefault(key, defaultValue string) string

GetOrDefault retrieves a configuration value by its key and returns a default value if not found.