github.com/argoproj/argo-cd/v3@v3.2.1/util/env/env_test.go

package env

import (
	"fmt"
	"math"
	"strconv"
	"testing"
	"time"

	"github.com/stretchr/testify/assert"
	"k8s.io/utils/ptr"
)

func TestParseNumFromEnv(t *testing.T) {
	const envKey = "SOMEKEY"
	const minimum = math.MinInt + 1
	const maximum = math.MaxInt - 1
	const def = 10
	testCases := []struct {
		name     string
		env      string
		expected int
	}{
		{"Valid positive number", "200", 200},
		{"Valid negative number", "-200", -200},
		{"Invalid number", "abc", def},
		{"Equals minimum", strconv.Itoa(math.MinInt + 1), minimum},
		{"Equals maximum", strconv.Itoa(math.MaxInt - 1), maximum},
		{"Less than minimum", strconv.Itoa(math.MinInt), def},
		{"Greater than maximum", strconv.Itoa(math.MaxInt), def},
		{"Variable not set", "", def},
	}

	for _, tt := range testCases {
		t.Run(tt.name, func(t *testing.T) {
			t.Setenv(envKey, tt.env)
			n := ParseNumFromEnv(envKey, def, minimum, maximum)
			assert.Equal(t, tt.expected, n)
		})
	}
}

func TestParseFloatFromEnv(t *testing.T) {
	const envKey = "SOMEKEY"
	var minimum float32 = -1000.5
	var maximum float32 = 1000.5
	const def float32 = 10.5
	testCases := []struct {
		name     string
		env      string
		expected float32
	}{
		{"Valid positive float", "2.0", 2.0},
		{"Valid negative float", "-2.0", -2.0},
		{"Valid integer as float", "2", 2.0},
		{"Text as invalid float", "abc", def},
		{"Equals maximum", fmt.Sprintf("%v", maximum), maximum},
		{"Equals minimum", fmt.Sprintf("%v", minimum), minimum},
		{"Greater than maximum", fmt.Sprintf("%f", maximum+1), def},
		{"Lesser than minimum", fmt.Sprintf("%f", minimum-1), def},
		{"Environment not set at", "", def},
	}

	for _, tt := range testCases {
		t.Run(tt.name, func(t *testing.T) {
			t.Setenv(envKey, tt.env)
			f := ParseFloatFromEnv(envKey, def, minimum, maximum)
			assert.InEpsilon(t, tt.expected, f, 0.0001)
		})
	}
}

func TestParseInt64FromEnv(t *testing.T) {
	const envKey = "SOMEKEY"
	const minimum int64 = 1
	const maximum int64 = math.MaxInt64 - 1
	const def int64 = 10
	testCases := []struct {
		name     string
		env      string
		expected int64
	}{
		{"Valid int64", "200", 200},
		{"Text as invalid int64", "abc", def},
		{"Equals maximum", strconv.FormatInt(maximum, 10), maximum},
		{"Equals minimum", strconv.FormatInt(minimum, 10), minimum},
		{"Greater than maximum", strconv.FormatInt(maximum+1, 10), def},
		{"Less than minimum", strconv.FormatInt(minimum-1, 10), def},
		{"Environment not set", "", def},
	}

	for _, tt := range testCases {
		t.Run(tt.name, func(t *testing.T) {
			t.Setenv(envKey, tt.env)
			n := ParseInt64FromEnv(envKey, def, minimum, maximum)
			assert.Equal(t, tt.expected, n)
		})
	}
}

func TestParseDurationFromEnv(t *testing.T) {
	envKey := "SOMEKEY"
	def := 3 * time.Second
	minimum := 2 * time.Second
	maximum := 5 * time.Second

	testCases := []struct {
		name     string
		env      string
		expected time.Duration
	}{{
		name:     "EnvNotSet",
		expected: def,
	}, {
		name:     "ValidValueSet",
		env:      "2s",
		expected: time.Second * 2,
	}, {
		name:     "ValidValueSetMs",
		env:      "2500ms",
		expected: time.Millisecond * 2500,
	}, {
		name:     "MoreThanMaxSet",
		env:      "6s",
		expected: def,
	}, {
		name:     "LessThanMinSet",
		env:      "1s",
		expected: def,
	}, {
		name:     "InvalidSet",
		env:      "hello",
		expected: def,
	}}

	for _, tc := range testCases {
		t.Run(tc.name, func(t *testing.T) {
			t.Setenv(envKey, tc.env)
			val := ParseDurationFromEnv(envKey, def, minimum, maximum)
			assert.Equal(t, tc.expected, val)
		})
	}
}

func Test_ParseBoolFromEnv(t *testing.T) {
	envKey := "SOMEKEY"

	testCases := []struct {
		name     string
		env      string
		expected bool
		def      bool
	}{
		{"True value", "true", true, false},
		{"False value", "false", false, true},
		{"Invalid value with true default", "somevalue", true, true},
		{"Invalid value with false default", "somevalue", false, false},
		{"Env not set", "", false, false},
	}

	for _, tt := range testCases {
		t.Run(tt.name, func(t *testing.T) {
			t.Setenv(envKey, tt.env)
			b := ParseBoolFromEnv(envKey, tt.def)
			assert.Equal(t, tt.expected, b)
		})
	}
}

func TestStringFromEnv(t *testing.T) {
	envKey := "SOMEKEY"
	def := "somestring"

	testCases := []struct {
		name     string
		env      *string
		expected string
		def      string
		opts     []StringFromEnvOpts
	}{
		{"Some string", ptr.To("true"), "true", def, nil},
		{"Empty string with default", ptr.To(""), def, def, nil},
		{"Empty string without default", ptr.To(""), "", "", nil},
		{"No env variable with default allow empty", nil, "default", "default", []StringFromEnvOpts{{AllowEmpty: true}}},
		{"Some variable with default allow empty", ptr.To("true"), "true", "default", []StringFromEnvOpts{{AllowEmpty: true}}},
		{"Empty variable with default allow empty", ptr.To(""), "", "default", []StringFromEnvOpts{{AllowEmpty: true}}},
	}

	for _, tt := range testCases {
		t.Run(tt.name, func(t *testing.T) {
			if tt.env != nil {
				t.Setenv(envKey, *tt.env)
			}
			b := StringFromEnv(envKey, tt.def, tt.opts...)
			assert.Equal(t, tt.expected, b)
		})
	}
}

func TestStringsFromEnv(t *testing.T) {
	envKey := "SOMEKEY"
	def := []string{"one", "two"}

	testCases := []struct {
		name     string
		env      string
		expected []string
		def      []string
		sep      string
	}{
		{"List of strings", "one,two,three", []string{"one", "two", "three"}, def, ","},
		{"Comma separated with other delimeter", "one,two,three", []string{"one,two,three"}, def, ";"},
		{"With trimmed white space", "one, two   ,    three", []string{"one", "two", "three"}, def, ","},
		{"Env not set", "", def, def, ","},
	}

	for _, tt := range testCases {
		t.Run(tt.name, func(t *testing.T) {
			t.Setenv(envKey, tt.env)
			ss := StringsFromEnv(envKey, tt.def, tt.sep)
			assert.Equal(t, tt.expected, ss)
		})
	}
}

func TestParseStringToStringFromEnv(t *testing.T) {
	envKey := "SOMEKEY"
	def := map[string]string{}

	testCases := []struct {
		name     string
		env      string
		expected map[string]string
		def      map[string]string
		sep      string
	}{
		{"success, no key-value", "", map[string]string{}, def, ","},
		{"success, one key, no value", "key1=", map[string]string{"key1": ""}, def, ","},
		{"success, one key, no value, with spaces", "key1 = ", map[string]string{"key1": ""}, def, ","},
		{"success, one pair", "key1=value1", map[string]string{"key1": "value1"}, def, ","},
		{"success, one pair with spaces", "key1 = value1", map[string]string{"key1": "value1"}, def, ","},
		{"success, one pair with spaces and no value", "key1 = ", map[string]string{"key1": ""}, def, ","},
		{"success, two keys, no value", "key1=,key2=", map[string]string{"key1": "", "key2": ""}, def, ","},
		{"success, two keys, no value, with spaces", "key1 = , key2 = ", map[string]string{"key1": "", "key2": ""}, def, ","},
		{"success, two pairs", "key1=value1,key2=value2", map[string]string{"key1": "value1", "key2": "value2"}, def, ","},
		{"success, two pairs with semicolon as separator", "key1=value1;key2=value2", map[string]string{"key1": "value1", "key2": "value2"}, def, ";"},
		{"success, two pairs with spaces", "key1 = value1, key2 = value2", map[string]string{"key1": "value1", "key2": "value2"}, def, ","},
		{"failure, one key", "key1", map[string]string{}, def, ","},
		{"failure, duplicate keys", "key1=value1,key1=value2", map[string]string{}, def, ","},
		{"failure, one key ending with two successive equals to", "key1==", map[string]string{}, def, ","},
		{"failure, one valid pair and invalid one key", "key1=value1,key2", map[string]string{}, def, ","},
		{"failure, two valid pairs and invalid two keys", "key1=value1,key2=value2,key3,key4", map[string]string{}, def, ","},
	}

	for _, tt := range testCases {
		t.Run(tt.name, func(t *testing.T) {
			t.Setenv(envKey, tt.env)
			got := ParseStringToStringFromEnv(envKey, tt.def, tt.sep)
			assert.Equal(t, tt.expected, got)
		})
	}
}