|
| 1 | +package config |
| 2 | + |
| 3 | +import ( |
| 4 | + "fmt" |
| 5 | + "strings" |
| 6 | + "testing" |
| 7 | + |
| 8 | + "github.com/stretchr/testify/require" |
| 9 | +) |
| 10 | + |
| 11 | +func TestEnvironmentConfig(t *testing.T) { |
| 12 | + t.Run("ParsingValidInput", func(t *testing.T) { |
| 13 | + cases := []struct { |
| 14 | + Name string |
| 15 | + Input []string |
| 16 | + Expected map[string]string |
| 17 | + }{ |
| 18 | + { |
| 19 | + Name: "ValidInput", |
| 20 | + Input: []string{"NAME=VALUE"}, |
| 21 | + Expected: map[string]string{"NAME": "VALUE"}, |
| 22 | + }, |
| 23 | + { |
| 24 | + Name: "ValidInputWithSpaces", |
| 25 | + Input: []string{"NAME=VALUE WITH SPACES"}, |
| 26 | + Expected: map[string]string{"NAME": "VALUE WITH SPACES"}, |
| 27 | + }, |
| 28 | + { |
| 29 | + Name: "ValidInputWithQuotes", |
| 30 | + Input: []string{"NAME=\"VALUE WITH QUOTES\""}, |
| 31 | + Expected: map[string]string{"NAME": `"VALUE WITH QUOTES"`}, |
| 32 | + }, |
| 33 | + { |
| 34 | + Name: "DelimitedValue", |
| 35 | + Input: []string{"NAME=VALUE1,VALUE2"}, |
| 36 | + Expected: map[string]string{"NAME": "VALUE1,VALUE2"}, |
| 37 | + }, |
| 38 | + { |
| 39 | + Name: "EmptyValue", |
| 40 | + Input: []string{"NAME="}, |
| 41 | + Expected: map[string]string{"NAME": ""}, |
| 42 | + }, |
| 43 | + { |
| 44 | + Name: "EmptyValueWithSpaces", |
| 45 | + Input: []string{"NAME= "}, |
| 46 | + Expected: map[string]string{"NAME": " "}, |
| 47 | + }, |
| 48 | + { |
| 49 | + Name: "LowerCaseName", |
| 50 | + Input: []string{"name=VALUE"}, |
| 51 | + Expected: map[string]string{"name": "VALUE"}, |
| 52 | + }, |
| 53 | + { |
| 54 | + Name: "MixedCaseName", |
| 55 | + Input: []string{"MiXeD_Case=VALUE"}, |
| 56 | + Expected: map[string]string{"MiXeD_Case": "VALUE"}, |
| 57 | + }, |
| 58 | + { |
| 59 | + Name: "EqualSignInValue", |
| 60 | + Input: []string{"NAME=VALUE=EQUAL"}, |
| 61 | + Expected: map[string]string{"NAME": "VALUE=EQUAL"}, |
| 62 | + }, |
| 63 | + { |
| 64 | + Name: "EqualSignInValueWithSpaces", |
| 65 | + Input: []string{"NAME=VALUE=EQUAL WITH SPACES"}, |
| 66 | + Expected: map[string]string{"NAME": "VALUE=EQUAL WITH SPACES"}, |
| 67 | + }, |
| 68 | + { |
| 69 | + Name: "MultiLineValue", |
| 70 | + Input: []string{"NAME=VALUE1\nVALUE2"}, |
| 71 | + Expected: map[string]string{"NAME": "VALUE1\nVALUE2"}, |
| 72 | + }, |
| 73 | + { |
| 74 | + Name: "MultiplePairs", |
| 75 | + Input: []string{"NAME1=VALUE1", "NAME2=VALUE2"}, |
| 76 | + Expected: map[string]string{"NAME1": "VALUE1", "NAME2": "VALUE2"}, |
| 77 | + }, |
| 78 | + } |
| 79 | + |
| 80 | + for _, c := range cases { |
| 81 | + t.Run(c.Name, func(t *testing.T) { |
| 82 | + parsed, err := parseAndValidateEnvironment(c.Input) |
| 83 | + require.NoError(t, err) |
| 84 | + require.Equal(t, c.Expected, parsed) |
| 85 | + }) |
| 86 | + } |
| 87 | + }) |
| 88 | + |
| 89 | + t.Run("ParsingInvalidInput", func(t *testing.T) { |
| 90 | + cases := []struct { |
| 91 | + Name string |
| 92 | + Input []string |
| 93 | + ExpectedErrorMessage string |
| 94 | + }{ |
| 95 | + { |
| 96 | + Name: "NameWithoutValue", |
| 97 | + Input: []string{"NAME"}, |
| 98 | + ExpectedErrorMessage: `environment variable "NAME" is not in the KEY=VALUE format`, |
| 99 | + }, |
| 100 | + { |
| 101 | + Name: "EmptyName", |
| 102 | + Input: []string{"=VALUE"}, |
| 103 | + ExpectedErrorMessage: `environment variable "=VALUE" is not in the KEY=VALUE format`, |
| 104 | + }, |
| 105 | + } |
| 106 | + |
| 107 | + for _, c := range cases { |
| 108 | + t.Run(c.Name, func(t *testing.T) { |
| 109 | + _, err := parseAndValidateEnvironment(c.Input) |
| 110 | + require.Error(t, err) |
| 111 | + require.ErrorContains(t, err, c.ExpectedErrorMessage) |
| 112 | + }) |
| 113 | + } |
| 114 | + }) |
| 115 | + |
| 116 | + t.Run("EnforceDenyList", func(t *testing.T) { |
| 117 | + for _, pattern := range EnvironmentVariableDenyList { |
| 118 | + // test that exact matches are rejected |
| 119 | + t.Run(fmt.Sprintf("Rejects %q", pattern), func(t *testing.T) { |
| 120 | + input := fmt.Sprintf("%s=VALUE", pattern) |
| 121 | + _, err := parseAndValidateEnvironment([]string{input}) |
| 122 | + require.Error(t, err) |
| 123 | + require.ErrorContains(t, err, fmt.Sprintf("environment variable %q is not allowed", pattern)) |
| 124 | + }) |
| 125 | + |
| 126 | + // test that prefix matches are rejected |
| 127 | + if strings.HasSuffix(pattern, "*") { |
| 128 | + t.Run(fmt.Sprintf("Rejects %q prefix", pattern), func(t *testing.T) { |
| 129 | + name := strings.TrimSuffix(pattern, "*") + "SUFFIX" |
| 130 | + input := fmt.Sprintf("%s=VALUE", name) |
| 131 | + _, err := parseAndValidateEnvironment([]string{input}) |
| 132 | + require.Error(t, err) |
| 133 | + require.ErrorContains(t, err, fmt.Sprintf("environment variable %q is not allowed", name)) |
| 134 | + }) |
| 135 | + } |
| 136 | + } |
| 137 | + }) |
| 138 | + |
| 139 | + t.Run("DuplicateNamesAreRejected", func(t *testing.T) { |
| 140 | + input := []string{"NAME=VALUE", "NAME=VALUE2"} |
| 141 | + _, err := parseAndValidateEnvironment(input) |
| 142 | + require.Error(t, err) |
| 143 | + require.ErrorContains(t, err, "environment variable \"NAME\" is already defined") |
| 144 | + }) |
| 145 | +} |
0 commit comments