fix: treat empty env as defaults (#6538)

ammario · ammario · commit 2884aa6550e7 · 2023-03-09T20:35:47.000Z
diff --git a/cli/clibase/option.go b/cli/clibase/option.go
@@ -121,7 +121,12 @@ func (s *OptionSet) ParseEnv(vs []EnvVar) 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
@@ -93,4 +93,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(clibase.ParseEnviron([]string{"CODER_WORKSPACE_NAME="}, "CODER_"))
+		require.NoError(t, err)
+		require.EqualValues(t, "defname", workspaceName)
+	})
 }

Original file line number	Diff line number	Diff line change
`@@ -121,7 +121,12 @@ func (s *OptionSet) ParseEnv(vs []EnvVar) error {`
`121`	`121`	`}`
`122`	`122`
`123`	`123`	`envVal, ok := envs[opt.Env]`
`124`		`- if !ok {`
	`124`	`+ // Currently, empty values are treated as if the environment variable is`
	`125`	`+ // unset. This behavior is technically not correct as there is now no`
	`126`	`+ // way for a user to change a Default value to an empty string from`
	`127`	`+ // the environment. Unfortunately, we have old configuration files`
	`128`	`+ // that rely on the faulty behavior.`
	`129`	`+ if !ok \|\| envVal == "" {`
`125`	`130`	`continue`
`126`	`131`	`}`
`127`	`132`