Skip to content

fix: clarify env variable deny-list error message #2813

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

Open
bfirsh wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: clarify env variable deny-list error message #2813

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions pkg/config/env.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,13 +41,13 @@ func validateEnvName(name string) error {
for _, pattern := range environmentVariableDenyList {
// Check for exact match
if pattern == name {
return fmt.Errorf("environment variable %q is not allowed", name)
return fmt.Errorf("environment variable %q is not allowed: reserved for internal use", name)
}

// Check for wildcard pattern
if strings.HasSuffix(pattern, "*") {
if strings.HasPrefix(name, pattern[:len(pattern)-1]) {
return fmt.Errorf("environment variable %q is not allowed", name)
return fmt.Errorf("environment variable %q is not allowed: reserved for internal use", name)
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions pkg/config/env_variables_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ func TestEnvironmentConfig(t *testing.T) {
input := fmt.Sprintf("%s=VALUE", pattern)
_, err := parseAndValidateEnvironment([]string{input})
require.Error(t, err)
require.ErrorContains(t, err, fmt.Sprintf("environment variable %q is not allowed", pattern))
require.ErrorContains(t, err, fmt.Sprintf("environment variable %q is not allowed: reserved for internal use", pattern))
})

// test that prefix matches are rejected
Expand All @@ -135,7 +135,7 @@ func TestEnvironmentConfig(t *testing.T) {
input := fmt.Sprintf("%s=VALUE", name)
_, err := parseAndValidateEnvironment([]string{input})
require.Error(t, err)
require.ErrorContains(t, err, fmt.Sprintf("environment variable %q is not allowed", name))
require.ErrorContains(t, err, fmt.Sprintf("environment variable %q is not allowed: reserved for internal use", name))
})
}
}
Expand Down