helmfile/pkg/plugins/vals_test.go

392 lines
9.2 KiB
Go

package plugins
import (
"io"
"os"
"strings"
"sync"
"testing"
"github.com/helmfile/vals"
"github.com/helmfile/helmfile/pkg/envvar"
)
// resetInstance resets the singleton for testing
func resetInstance() {
instance = nil
once = sync.Once{}
}
func TestValsInstance(t *testing.T) {
resetInstance()
defer resetInstance()
i, err := ValsInstance()
if err != nil {
t.Errorf("unexpected error: %v", err)
}
i2, _ := ValsInstance()
if i != i2 {
t.Error("Instances should be equal")
}
}
func TestDisableVals(t *testing.T) {
resetInstance()
defer resetInstance()
os.Setenv(envvar.DisableVals, "true")
defer os.Unsetenv(envvar.DisableVals)
evaluator, err := ValsInstance()
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
// Should pass through values unchanged
input := map[string]any{"key": "ref+echo://secret"}
output, err := evaluator.Eval(input)
if err != nil {
t.Fatalf("passthrough should not error: %v", err)
}
if output["key"] != "ref+echo://secret" {
t.Errorf("expected ref+ to pass through unchanged, got %v", output["key"])
}
}
func TestDisableValsStrict(t *testing.T) {
resetInstance()
defer resetInstance()
os.Setenv(envvar.DisableValsStrict, "true")
defer os.Unsetenv(envvar.DisableValsStrict)
evaluator, err := ValsInstance()
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
// Should error on ref+
input := map[string]any{"key": "ref+echo://secret"}
_, err = evaluator.Eval(input)
if err == nil {
t.Fatal("strict mode should error on ref+")
}
if err != ErrValsDisabled {
t.Errorf("expected ErrValsDisabled, got %v", err)
}
}
func TestDisableValsStrictAllowsNonRef(t *testing.T) {
resetInstance()
defer resetInstance()
os.Setenv(envvar.DisableValsStrict, "true")
defer os.Unsetenv(envvar.DisableValsStrict)
evaluator, err := ValsInstance()
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
// Should pass through non-ref+ values
input := map[string]any{"key": "normal-value"}
output, err := evaluator.Eval(input)
if err != nil {
t.Fatalf("strict mode should allow non-ref+ values: %v", err)
}
if output["key"] != "normal-value" {
t.Errorf("expected value to pass through, got %v", output["key"])
}
}
func TestDisableValsStrictNestedRef(t *testing.T) {
resetInstance()
defer resetInstance()
os.Setenv(envvar.DisableValsStrict, "true")
defer os.Unsetenv(envvar.DisableValsStrict)
evaluator, err := ValsInstance()
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
// Should detect nested ref+ in map[string]any
input := map[string]any{
"outer": map[string]any{
"inner": "ref+vault://secret",
},
}
_, err = evaluator.Eval(input)
if err == nil {
t.Fatal("strict mode should detect nested ref+")
}
}
func TestDisableValsStrictMapAnyAny(t *testing.T) {
resetInstance()
defer resetInstance()
os.Setenv(envvar.DisableValsStrict, "true")
defer os.Unsetenv(envvar.DisableValsStrict)
evaluator, err := ValsInstance()
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
// Should detect ref+ inside map[any]any (yaml.v2 nested maps)
input := map[string]any{
"outer": map[any]any{
"inner": "ref+vault://secret",
},
}
_, err = evaluator.Eval(input)
if err == nil {
t.Fatal("strict mode should detect ref+ in map[any]any")
}
}
func TestDisableValsStrictArrayRef(t *testing.T) {
resetInstance()
defer resetInstance()
os.Setenv(envvar.DisableValsStrict, "true")
defer os.Unsetenv(envvar.DisableValsStrict)
evaluator, err := ValsInstance()
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
// Should detect ref+ in []any arrays
input := map[string]any{
"values": []any{"normal", "ref+awssecrets://db/password"},
}
_, err = evaluator.Eval(input)
if err == nil {
t.Fatal("strict mode should detect ref+ in arrays")
}
}
func TestDisableValsStrictStringSlice(t *testing.T) {
resetInstance()
defer resetInstance()
os.Setenv(envvar.DisableValsStrict, "true")
defer os.Unsetenv(envvar.DisableValsStrict)
evaluator, err := ValsInstance()
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
// Should detect ref+ in []string arrays (matches renderValsSecrets usage)
input := map[string]any{
"values": []string{"normal", "ref+awssecrets://db/password"},
}
_, err = evaluator.Eval(input)
if err == nil {
t.Fatal("strict mode should detect ref+ in []string arrays")
}
}
func TestDisableValsPassThroughStringSlice(t *testing.T) {
resetInstance()
defer resetInstance()
os.Setenv(envvar.DisableVals, "true")
defer os.Unsetenv(envvar.DisableVals)
os.Unsetenv(envvar.DisableValsStrict)
evaluator, err := ValsInstance()
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
input := map[string]any{
"values": []string{"normal", "ref+awssecrets://db/password"},
}
out, err := evaluator.Eval(input)
if err != nil {
t.Fatalf("pass-through should not error: %v", err)
}
values, ok := out["values"].([]any)
if !ok {
t.Fatalf("expected out[\"values\"] to be []any, got %T", out["values"])
}
if values[0] != "normal" || values[1] != "ref+awssecrets://db/password" {
t.Errorf("unexpected values: %v", values)
}
}
func TestNormalValsProcessing(t *testing.T) {
resetInstance()
defer resetInstance()
// Ensure both are unset
os.Unsetenv(envvar.DisableVals)
os.Unsetenv(envvar.DisableValsStrict)
evaluator, err := ValsInstance()
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
// ref+echo should expand to the value after ://
input := map[string]any{"key": "ref+echo://myvalue"}
output, err := evaluator.Eval(input)
if err != nil {
t.Fatalf("normal vals should process ref+echo: %v", err)
}
if output["key"] != "myvalue" {
t.Errorf("expected 'myvalue', got %v", output["key"])
}
}
// TestAWSSDKLogLevelConfiguration tests the AWS SDK log level configuration logic
func TestAWSSDKLogLevelConfiguration(t *testing.T) {
tests := []struct {
name string
envValue string
expectedLogLevel string
expectedLogOutput bool // true if LogOutput should be io.Discard
}{
{
name: "no env var defaults to off",
envValue: "",
expectedLogLevel: "off",
expectedLogOutput: true, // LogOutput should be io.Discard
},
{
name: "explicit off",
envValue: "off",
expectedLogLevel: "off",
expectedLogOutput: true,
},
{
name: "minimal logging",
envValue: "minimal",
expectedLogLevel: "minimal",
expectedLogOutput: false, // LogOutput should NOT be io.Discard
},
{
name: "standard logging",
envValue: "standard",
expectedLogLevel: "standard",
expectedLogOutput: false,
},
{
name: "verbose logging",
envValue: "verbose",
expectedLogLevel: "verbose",
expectedLogOutput: false,
},
{
name: "custom logging",
envValue: "request,response",
expectedLogLevel: "request,response",
expectedLogOutput: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
// Note: This test verifies the configuration logic, not the actual vals.New() call
// since ValsInstance() uses sync.Once and can only be initialized once per test run.
// Simulate the logic from ValsInstance()
var logLevel string
if tt.envValue != "" {
logLevel = strings.TrimSpace(tt.envValue)
}
// Default to "off" for security if not specified
if logLevel == "" {
logLevel = "off"
}
// Verify expected log level
if logLevel != tt.expectedLogLevel {
t.Errorf("Expected log level %q, got %q", tt.expectedLogLevel, logLevel)
}
// Verify LogOutput configuration logic
opts := vals.Options{
CacheSize: valsCacheSize,
}
opts.AWSLogLevel = logLevel
// Verify LogOutput is set to io.Discard only when level is "off"
if tt.expectedLogOutput {
opts.LogOutput = io.Discard
if opts.LogOutput != io.Discard {
t.Error("Expected LogOutput to be io.Discard for 'off' level")
}
}
})
}
}
// TestEnvironmentVariableReading verifies that the HELMFILE_AWS_SDK_LOG_LEVEL env var is read correctly
func TestEnvironmentVariableReading(t *testing.T) {
tests := []struct {
name string
envValue string
expectedValue string
}{
{
name: "empty defaults to off",
envValue: "",
expectedValue: "off",
},
{
name: "whitespace trimmed",
envValue: " minimal ",
expectedValue: "minimal",
},
{
name: "standard value preserved",
envValue: "standard",
expectedValue: "standard",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
// Save and restore env var
original := os.Getenv(envvar.AWSSDKLogLevel)
defer func() {
if original == "" {
os.Unsetenv(envvar.AWSSDKLogLevel)
} else {
os.Setenv(envvar.AWSSDKLogLevel, original)
}
}()
// Set test env var
if tt.envValue == "" {
os.Unsetenv(envvar.AWSSDKLogLevel)
} else {
os.Setenv(envvar.AWSSDKLogLevel, tt.envValue)
}
// Read and process like ValsInstance() does
logLevel := strings.TrimSpace(os.Getenv(envvar.AWSSDKLogLevel))
if logLevel == "" {
logLevel = "off"
}
if logLevel != tt.expectedValue {
t.Errorf("Expected %q, got %q", tt.expectedValue, logLevel)
}
})
}
}