Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

More detailed test for env variables migration #709

Merged
merged 15 commits into from
Jun 24, 2024
Merged

More detailed test for env variables migration #709

Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
5b8a8dc
changed env variable prefix from NMS to NGINX_AGENT
spencerugbo Jun 13, 2024
1997ecd
changed env variable prefix from NMS to NGINX_AGENT
spencerugbo Jun 13, 2024
3c5157c
renamed env prefix constants
spencerugbo Jun 17, 2024
aa1a5ea
renamed env prefix constants
spencerugbo Jun 17, 2024
5ff0aa5
refactored string building of oldKey and newKey
spencerugbo Jun 17, 2024
8873427
refactored string building of oldKey and newKey
spencerugbo Jun 17, 2024
596b764
added test for env prefix migration
spencerugbo Jun 17, 2024
f1d4a55
added test for env prefix migration
spencerugbo Jun 17, 2024
e4e8ca6
refactored string builing of oldKey and newKey
spencerugbo Jun 17, 2024
c3c01d3
refactored string builing of oldKey and newKey
spencerugbo Jun 17, 2024
a31da69
fixed deprecated env prefix migration test
spencerugbo Jun 17, 2024
f711e49
more robust test
oliveromahony Jun 17, 2024
4087ebe
merge from main
oliveromahony Jun 17, 2024
683b128
env tidy up
oliveromahony Jun 24, 2024
28ad278
Merge branch 'main' into more-detailed-test
oliveromahony Jun 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 32 additions & 22 deletions src/core/config/config_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ func TestGetConfig(t *testing.T) {
require.NoError(t, err)

// Initialize environment with the empty configs
cleanEnv(t, tempCfgFile, fmt.Sprintf("%s/%s", curDir, tempDynamicCfgFile))
cleanEnv(t, tempCfgFile, fmt.Sprintf("%s/%s", curDir, tempDynamicCfgFile), true)

config, err := GetConfig("12345")
require.NoError(t, err)
Expand Down Expand Up @@ -183,7 +183,7 @@ func TestGetConfig(t *testing.T) {
require.NoError(t, err)

// Initialize environment with the empty configs
cleanEnv(t, tempCfgFile, fmt.Sprintf("%s/%s", curDir, tempDynamicCfgFile))
cleanEnv(t, tempCfgFile, fmt.Sprintf("%s/%s", curDir, tempDynamicCfgFile), true)

updatedTag := "updated-tag"
updatedLogLevel := "fatal"
Expand Down Expand Up @@ -226,7 +226,7 @@ func TestGetConfig(t *testing.T) {
require.NoError(t, err)

// Initialize environment with the empty configs
cleanEnv(t, tempCfgFile, fmt.Sprintf("%s/%s", curDir, tempDynamicCfgFile))
cleanEnv(t, tempCfgFile, fmt.Sprintf("%s/%s", curDir, tempDynamicCfgFile), true)

// Copy config file with updated values to current directory
updatedTempConfDeleteFunc, err := sysutils.CopyFile(fmt.Sprintf("%s/%s", testCfgDir, updateCfgFile), updatedTempCfgFile)
Expand Down Expand Up @@ -292,13 +292,13 @@ func TestGetConfig(t *testing.T) {
require.NoError(t, err)

// Initialize environment with specified configs
cleanEnv(t, tempCfgFile, fmt.Sprintf("%s/%s", curDir, tempDynamicCfgFile))
cleanEnv(t, tempCfgFile, fmt.Sprintf("%s/%s", curDir, tempDynamicCfgFile), true)

envTags := "env tags"
setEnvVariable(t, ServerHost, updatedServerHost)
setEnvVariable(t, LogLevel, updatedLogLevel)
setEnvVariable(t, LogPath, updatedLogPath)
setEnvVariable(t, TagsKey, envTags)
setEnvVariable(t, EnvPrefix, ServerHost, updatedServerHost)
setEnvVariable(t, EnvPrefix, LogLevel, updatedLogLevel)
setEnvVariable(t, EnvPrefix, LogPath, updatedLogPath)
setEnvVariable(t, EnvPrefix, TagsKey, envTags)

config, err := GetConfig("5678")
require.NoError(t, err)
Expand Down Expand Up @@ -331,13 +331,13 @@ func TestGetConfig(t *testing.T) {
require.NoError(t, err)

// Initialize environment with the empty configs
cleanEnv(t, tempCfgFile, fmt.Sprintf("%s/%s", curDir, tempDynamicCfgFile))
cleanEnv(t, tempCfgFile, fmt.Sprintf("%s/%s", curDir, tempDynamicCfgFile), true)

envTags := "env tags"
setEnvVariable(t, ServerHost, updatedServerHost)
setEnvVariable(t, LogLevel, updatedLogLevel)
setEnvVariable(t, LogPath, updatedLogPath)
setEnvVariable(t, TagsKey, envTags)
setEnvVariable(t, EnvPrefix, ServerHost, updatedServerHost)
setEnvVariable(t, EnvPrefix, LogLevel, updatedLogLevel)
setEnvVariable(t, EnvPrefix, LogPath, updatedLogPath)
setEnvVariable(t, EnvPrefix, TagsKey, envTags)

config, err := GetConfig("5678")
require.NoError(t, err)
Expand Down Expand Up @@ -370,7 +370,7 @@ extensions:
require.NoError(t, err)

// Initialize environment with specified configs
cleanEnv(t, tempCfgFile, fmt.Sprintf("%s/%s", curDir, tempDynamicCfgFile))
cleanEnv(t, tempCfgFile, fmt.Sprintf("%s/%s", curDir, tempDynamicCfgFile), true)

config, err := GetConfig("5678")
require.NoError(t, err)
Expand All @@ -394,7 +394,7 @@ func TestUpdateAgentConfig(t *testing.T) {
}()
require.NoError(t, err)

cleanEnv(t, "empty_config.conf", fmt.Sprintf("%s/%s", curDir, tempDynamicCfgFile))
cleanEnv(t, "empty_config.conf", fmt.Sprintf("%s/%s", curDir, tempDynamicCfgFile), true)

// Get the current config so we can correctly set a few testcase variables
curConf, err := GetConfig("12345")
Expand Down Expand Up @@ -499,8 +499,11 @@ func TestDeprecatedEnvPrefixMigration(t *testing.T) {
}()
require.NoError(t, err)

cleanEnv(t, tempCfgFile, fmt.Sprintf("%s/%s", curDir, tempDynamicCfgFile))
setEnvVariable(t, "tls_skip_verify", "true")
cleanEnv(t, tempCfgFile, fmt.Sprintf("%s/%s", curDir, tempDynamicCfgFile), false)
setEnvVariable(t, LegacyEnvPrefix, "tls_skip_verify", "true")
setEnvVariable(t, EnvPrefix, "tls_skip_verify", "")

RegisterFlags()

config, err := GetConfig("1234")
require.NoError(t, err)
Expand All @@ -509,19 +512,26 @@ func TestDeprecatedEnvPrefixMigration(t *testing.T) {
assert.Equal(t, want, got)
}

func setEnvVariable(t *testing.T, name string, value string) {
key := strings.ToUpper(EnvPrefix + agent_config.KeyDelimiter + name)
err := os.Setenv(key, value)
func setEnvVariable(t *testing.T, prefix, name, value string) {
var err error
key := strings.ToUpper(prefix + agent_config.KeyDelimiter + name)
if value == "" {
err = os.Unsetenv(key)
} else {
t.Setenv(key, value)
}
require.NoError(t, err)
}

func cleanEnv(t *testing.T, confFileName, dynamicConfFileAbsPath string) {
func cleanEnv(t *testing.T, confFileName, dynamicConfFileAbsPath string, register bool) {
os.Clearenv()
ROOT_COMMAND.ResetFlags()
ROOT_COMMAND.ResetCommands()
Viper = viper.NewWithOptions(viper.KeyDelimiter(agent_config.KeyDelimiter))
SetDefaults()
RegisterFlags()
if register {
RegisterFlags()
}

cfg, err := RegisterConfigFile(dynamicConfFileAbsPath, confFileName, searchPaths...)
require.NoError(t, err)
Expand Down
Loading