Log debug information in loadValuesSecrets [#34]

This commit is contained in:
Erin Call 2020-01-21 16:04:05 -08:00
parent e843b26759
commit 8f7b481934
No known key found for this signature in database
GPG key ID: 4071FF6C15B8DAD1
2 changed files with 33 additions and 0 deletions

View file

@ -108,13 +108,25 @@ func (cfg *Config) loadValuesSecrets() {
varName = sigils.ReplaceAllString(varName, "") varName = sigils.ReplaceAllString(varName, "")
if value, ok := os.LookupEnv(varName); ok { if value, ok := os.LookupEnv(varName); ok {
if cfg.Debug {
fmt.Fprintf(cfg.Stderr, "Replaced $%s with value in environment\n", varName)
}
return value return value
} }
if cfg.Debug {
fmt.Fprintf(cfg.Stderr, "$%s not present in environment, replaced with \"\"\n", varName)
}
return "" return ""
} }
if cfg.Debug {
fmt.Fprintf(cfg.Stderr, "Replacing environment variable references in Values\n")
}
cfg.Values = findVar.ReplaceAllStringFunc(cfg.Values, replacer) cfg.Values = findVar.ReplaceAllStringFunc(cfg.Values, replacer)
if cfg.Debug {
fmt.Fprintf(cfg.Stderr, "Replacing environment variable references in StringValues\n")
}
cfg.StringValues = findVar.ReplaceAllStringFunc(cfg.StringValues, replacer) cfg.StringValues = findVar.ReplaceAllStringFunc(cfg.StringValues, replacer)
} }

View file

@ -198,6 +198,27 @@ func (suite *ConfigTestSuite) TestNewConfigWithValuesSecrets() {
suite.Equal("rings=1", cfg.StringValues) suite.Equal("rings=1", cfg.StringValues)
} }
func (suite *ConfigTestSuite) TestValuesSecretsWithDebugLogging() {
suite.unsetenv("VALUES")
suite.setenv("SECRET_FIRE", "Eru_Ilúvatar")
suite.setenv("PLUGIN_DEBUG", "true")
suite.setenv("PLUGIN_STRING_VALUES", "fire=$SECRET_FIRE")
suite.setenv("PLUGIN_VALUES", "fire=$SECRET_FIRE,water=$SECRET_WATER")
stderr := strings.Builder{}
_, err := NewConfig(&strings.Builder{}, &stderr)
suite.Require().NoError(err)
// Make a good-faith effort to avoid putting secrets in the log output, but still mention they were found
suite.Contains(stderr.String(), "Values:fire=$SECRET_FIRE,water=$SECRET_WATER")
suite.Contains(stderr.String(), `
Replacing environment variable references in Values
Replaced $SECRET_FIRE with value in environment
$SECRET_WATER not present in environment, replaced with ""
Replacing environment variable references in StringValues
Replaced $SECRET_FIRE with value in environment
`)
}
func (suite *ConfigTestSuite) setenv(key, val string) { func (suite *ConfigTestSuite) setenv(key, val string) {
orig, ok := os.LookupEnv(key) orig, ok := os.LookupEnv(key)
if ok { if ok {