fix: treat empty env as defaults

ammario · ammario · commit c7a67065e165 · 2023-03-09T19:50:57.000Z
diff --git a/cli/clibase/option.go b/cli/clibase/option.go
@@ -107,7 +107,12 @@ func (s *OptionSet) ParseEnv(globalPrefix string, environ []string) error {
 		}
 
 		envVal, ok := envs[opt.Env]
-		if !ok {
+		// Currently, empty values are treated as if the environment variable is
+		// unset. This behavior is technically not correct as there is now no
+		// way for a user to change a Default value to an empty string from
+		// the environment. Unfortunately, we have old configuration files
+		// that rely on the faulty behavior.
+		if !ok || envVal == "" {
 			continue
 		}
 
diff --git a/cli/clibase/option_test.go b/cli/clibase/option_test.go
@@ -91,4 +91,26 @@ func TestOptionSet_ParseEnv(t *testing.T) {
 		require.NoError(t, err)
 		require.EqualValues(t, "foo", workspaceName)
 	})
+
+	t.Run("EmptyValue", func(t *testing.T) {
+		t.Parallel()
+
+		var workspaceName clibase.String
+
+		os := clibase.OptionSet{
+			clibase.Option{
+				Name:    "Workspace Name",
+				Value:   &workspaceName,
+				Default: "defname",
+				Env:     "WORKSPACE_NAME",
+			},
+		}
+
+		err := os.SetDefaults()
+		require.NoError(t, err)
+
+		err = os.ParseEnv("CODER_", []string{"CODER_WORKSPACE_NAME="})
+		require.NoError(t, err)
+		require.EqualValues(t, "defname", workspaceName)
+	})
 }

Original file line number	Diff line number	Diff line change
`@@ -107,7 +107,12 @@ func (s *OptionSet) ParseEnv(globalPrefix string, environ []string) error {`
`107`	`107`	`}`
`108`	`108`
`109`	`109`	`envVal, ok := envs[opt.Env]`
`110`		`- if !ok {`
	`110`	`+ // Currently, empty values are treated as if the environment variable is`
	`111`	`+ // unset. This behavior is technically not correct as there is now no`
	`112`	`+ // way for a user to change a Default value to an empty string from`
	`113`	`+ // the environment. Unfortunately, we have old configuration files`
	`114`	`+ // that rely on the faulty behavior.`
	`115`	`+ if !ok \|\| envVal == "" {`
`111`	`116`	`continue`
`112`	`117`	`}`
`113`	`118`