Skip to content
This repository has been archived by the owner on May 23, 2024. It is now read-only.

Commit

Permalink
Allow config.FromEnv() to enrich an existing config object (#436)
Browse files Browse the repository at this point in the history 
* Allow config.FromEnv() to enrich an existing config object

Added an other method with config receiver and modified the existing method to call the method with config receiver.

Resolves: 430
Signed-off-by: vineeth <vineeth.pothulapati@aquasec.com>

* Made chnages to sampler and reperter config and added necessary unit tests.

Signed-off-by: vineeth <vineeth.pothulapati@aquasec.com>

* made chnages to support allow FromEnv for sampler and reporter + Unit tests

Signed-off-by: vineeth <vineeth.pothulapati@aquasec.com>

made chnages to support allow FromEnv for sampler and reporter + Unit tests

Signed-off-by: vineeth <vineeth.pothulapati@aquasec.com>

* modified the unit tests to validate pre env-set & post env-set

Signed-off-by: vineeth <vineeth.pothulapati@aquasec.com>

* fixed the linting issue.

Signed-off-by: vineeth <vineeth.pothulapati@aquasec.com>

* fixed the linting issue unseen formatting issue.

Signed-off-by: vineeth <vineeth.pothulapati@aquasec.com>

* fixed the fmt issue.

Signed-off-by: vineeth <vineeth.pothulapati@aquasec.com>
  • Loading branch information
@VineethReddy02 @yurishkuro
VineethReddy02 authored and yurishkuro committed Oct 2, 2019
1 parent 6c4e7ad commit 0be28c3
Show file tree
Hide file tree
Showing 2 changed files with 167 additions and 8 deletions.
24 changes: 16 additions & 8 deletions config/config_env.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,11 @@ const (
// FromEnv uses environment variables to set the tracer's Configuration
func FromEnv() (*Configuration, error) {
c := &Configuration{}
return c.FromEnv()
}

// FromEnv uses environment variables and overrides existing tracer's Configuration
func (c *Configuration) FromEnv() (*Configuration, error) {
if e := os.Getenv(envServiceName); e != "" {
c.ServiceName = e
}
Expand All @@ -77,13 +81,21 @@ func FromEnv() (*Configuration, error) {
c.Tags = parseTags(e)
}

if s, err := samplerConfigFromEnv(); err == nil {
if c.Sampler == nil {
c.Sampler = &SamplerConfig{}
}

if s, err := c.Sampler.samplerConfigFromEnv(); err == nil {
c.Sampler = s
} else {
return nil, errors.Wrap(err, "cannot obtain sampler config from env")
}

if r, err := reporterConfigFromEnv(); err == nil {
if c.Reporter == nil {
c.Reporter = &ReporterConfig{}
}

if r, err := c.Reporter.reporterConfigFromEnv(); err == nil {
c.Reporter = r
} else {
return nil, errors.Wrap(err, "cannot obtain reporter config from env")
Expand All @@ -93,9 +105,7 @@ func FromEnv() (*Configuration, error) {
}

// samplerConfigFromEnv creates a new SamplerConfig based on the environment variables
func samplerConfigFromEnv() (*SamplerConfig, error) {
sc := &SamplerConfig{}

func (sc *SamplerConfig) samplerConfigFromEnv() (*SamplerConfig, error) {
if e := os.Getenv(envSamplerType); e != "" {
sc.Type = e
}
Expand Down Expand Up @@ -135,9 +145,7 @@ func samplerConfigFromEnv() (*SamplerConfig, error) {
}

// reporterConfigFromEnv creates a new ReporterConfig based on the environment variables
func reporterConfigFromEnv() (*ReporterConfig, error) {
rc := &ReporterConfig{}

func (rc *ReporterConfig) reporterConfigFromEnv() (*ReporterConfig, error) {
if e := os.Getenv(envReporterMaxQueueSize); e != "" {
if value, err := strconv.ParseInt(e, 10, 0); err == nil {
rc.QueueSize = int(value)
Expand Down
151 changes: 151 additions & 0 deletions config/config_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,156 @@ func TestServiceNameFromEnv(t *testing.T) {
os.Unsetenv(envServiceName)
}

func TestConfigFromEnv(t *testing.T) {
cfg := &Configuration{
ServiceName: "my-config-service",
Disabled: true,
RPCMetrics: false,
Tags: []opentracing.Tag{{Key: "KEY01", Value: "VALUE01"}},
}

// test
cfg, err := cfg.FromEnv()
assert.NoError(t, err)

// verify
assert.Equal(t, "my-config-service", cfg.ServiceName)
assert.Equal(t, true, cfg.Disabled)
assert.Equal(t, false, cfg.RPCMetrics)
assert.Equal(t, "KEY01", cfg.Tags[0].Key)
assert.Equal(t, "VALUE01", cfg.Tags[0].Value)

// prepare
os.Setenv(envServiceName, "my-service")
os.Setenv(envDisabled, "false")
os.Setenv(envRPCMetrics, "true")
os.Setenv(envTags, "KEY=VALUE")

// test with env set
cfg, err = cfg.FromEnv()
assert.NoError(t, err)

// verify
assert.Equal(t, "my-service", cfg.ServiceName)
assert.Equal(t, false, cfg.Disabled)
assert.Equal(t, true, cfg.RPCMetrics)
assert.Equal(t, "KEY", cfg.Tags[0].Key)
assert.Equal(t, "VALUE", cfg.Tags[0].Value)

// cleanup
os.Unsetenv(envServiceName)
os.Unsetenv(envDisabled)
os.Unsetenv(envRPCMetrics)
os.Unsetenv(envTags)
}

func TestSamplerConfig(t *testing.T) {
// prepare
os.Setenv(envSamplerType, "const")
os.Setenv(envSamplerParam, "1")
os.Setenv(envSamplerManagerHostPort, "http://themaster")
os.Setenv(envSamplerMaxOperations, "10")
os.Setenv(envSamplerRefreshInterval, "1m1s") // 61 seconds

//existing SamplerConfig data
sc := SamplerConfig{
Type: "const-sample-config",
Param: 2,
SamplingServerURL: "http://themaster-sample-config",
MaxOperations: 20,
SamplingRefreshInterval: 2,
}

// test
cfg, err := sc.samplerConfigFromEnv()
assert.NoError(t, err)

// verify
assert.Equal(t, "const", cfg.Type)
assert.Equal(t, float64(1), cfg.Param)
assert.Equal(t, "http://themaster", cfg.SamplingServerURL)
assert.Equal(t, int(10), cfg.MaxOperations)
assert.Equal(t, 61000000000, int(cfg.SamplingRefreshInterval))

// cleanup
os.Unsetenv(envSamplerType)
os.Unsetenv(envSamplerParam)
os.Unsetenv(envSamplerManagerHostPort)
os.Unsetenv(envSamplerMaxOperations)
os.Unsetenv(envSamplerRefreshInterval)

}

func TestReporter(t *testing.T) {
// prepare
os.Setenv(envReporterMaxQueueSize, "10")
os.Setenv(envReporterFlushInterval, "1m1s") // 61 seconds
os.Setenv(envReporterLogSpans, "true")
os.Setenv(envAgentHost, "nonlocalhost")
os.Setenv(envAgentPort, "6832")
os.Setenv(envUser, "user")
os.Setenv(envPassword, "password")

// Existing ReporterConfig data
rc := ReporterConfig{
QueueSize: 20,
BufferFlushInterval: 2,
LogSpans: false,
LocalAgentHostPort: "localhost01",
CollectorEndpoint: "9999",
User: "user01",
Password: "password01",
}

// test
cfg, err := rc.reporterConfigFromEnv()
assert.NoError(t, err)

// verify
assert.Equal(t, int(10), cfg.QueueSize)
assert.Equal(t, 61000000000, int(cfg.BufferFlushInterval))
assert.Equal(t, true, cfg.LogSpans)
assert.Equal(t, "nonlocalhost:6832", cfg.LocalAgentHostPort)
assert.Equal(t, "user01", cfg.User)
assert.Equal(t, "password01", cfg.Password)

// Prepare
os.Setenv(envEndpoint, "http://1.2.3.4:5678/api/traces")
os.Setenv(envUser, "user")
os.Setenv(envPassword, "password")

// Existing ReprterConfig data for JAEGAR-ENDPOINT validation check
rc = ReporterConfig{
QueueSize: 20,
BufferFlushInterval: 2,
LogSpans: false,
LocalAgentHostPort: "localhost",
CollectorEndpoint: "9999",
User: "user",
Password: "password",
}

// test
cfg, err = rc.reporterConfigFromEnv()
assert.NoError(t, err)

// verify
assert.Equal(t, "http://1.2.3.4:5678/api/traces", cfg.CollectorEndpoint)
assert.Equal(t, "localhost", cfg.LocalAgentHostPort)
assert.Equal(t, "user", cfg.User)
assert.Equal(t, "password", cfg.Password)

// cleanup
os.Unsetenv(envReporterMaxQueueSize)
os.Unsetenv(envReporterFlushInterval)
os.Unsetenv(envReporterLogSpans)
os.Unsetenv(envEndpoint)
os.Unsetenv(envUser)
os.Unsetenv(envPassword)
os.Unsetenv(envAgentHost)
os.Unsetenv(envAgentPort)
}

func TestFromEnv(t *testing.T) {
os.Setenv(envServiceName, "my-service")
os.Setenv(envDisabled, "false")
Expand All @@ -102,6 +252,7 @@ func TestFromEnv(t *testing.T) {
os.Unsetenv(envServiceName)
os.Unsetenv(envDisabled)
os.Unsetenv(envRPCMetrics)
os.Unsetenv(envTags)
}

func TestNoServiceNameFromEnv(t *testing.T) {
Expand Down

0 comments on commit 0be28c3

Please sign in to comment.