Apr 7, 2023 · Mar 30, 2023 · Mar 30, 2023 · Mar 30, 2023 · Mar 30, 2023 · Mar 30, 2023
diff --git a/.golangci.yaml b/.golangci.yaml
      linters:
        # We use assertions rather than explicitly checking errors in tests
        - errcheck
        - forcetypeassert

  fix: true
  max-issues-per-linter: 0
diff --git a/Makefile b/Makefile
 .PHONY: update-golden-files

 cli/testdata/.gen-golden: $(wildcard cli/testdata/*.golden) $(wildcard cli/*.tpl) $(GO_SRC_FILES)
 go test ./cli -run=TestCommandHelp -update
 go test ./cli -run="Test(CommandHelp|ServerYAML)" -update
 touch "$@"

 helm/tests/testdata/.gen-golden: $(wildcard helm/tests/testdata/*.golden) $(GO_SRC_FILES)
diff --git a/cli/clibase/clibase.go b/cli/clibase/clibase.go

 // Group describes a hierarchy of groups that an option or command belongs to.
 type Group struct {
 Parent      *Group  `json:"parent,omitempty"`
 Name        string  `json:"name,omitempty"`
 Children    []Group `json:"children,omitempty"`
 Description string  `json:"description,omitempty"`
 }

 func (g *Group) AddChild(child Group) {
 child.Parent = g
 g.Children = append(g.Children, child)
 Parent      *Group `json:"parent,omitempty"`
 Name        string `json:"name,omitempty"`
 YAML        string `json:"yaml,omitempty"`
 Description string `json:"description,omitempty"`
 }

 // Ancestry returns the group and all of its parents, in order.
diff --git a/cli/clibase/cmd.go b/cli/clibase/cmd.go
 "github.com/spf13/pflag"
 "golang.org/x/exp/slices"
 "golang.org/x/xerrors"
 "gopkg.in/yaml.v3"
 )

 // Cmd describes an executable command.
 }
 var merr error

 slices.SortFunc(c.Options, func(a, b Option) bool {
 return a.Flag < b.Flag
 })
 for _, opt := range c.Options {
 for i := range c.Options {
 opt := &c.Options[i]
 if opt.Name == "" {
 switch {
 case opt.Flag != "":
 }
 }
 }

 slices.SortFunc(c.Options, func(a, b Option) bool {
 return a.Name < b.Name
 })
 slices.SortFunc(c.Children, func(a, b *Cmd) bool {
 return a.Name() < b.Name()
 })
 parsedArgs = inv.parsedFlags.Args()
 }

 // Set defaults for flags that weren't set by the user.
 skipDefaults := make(map[int]struct{}, len(inv.Command.Options))
 // Set value sources for flags.
 for i, opt := range inv.Command.Options {
 if fl := inv.parsedFlags.Lookup(opt.Flag); fl != nil && fl.Changed {
 skipDefaults[i] = struct{}{}
 inv.Command.Options[i].ValueSource = ValueSourceFlag
 }
 }

 // Read YAML configs, if any.
 for _, opt := range inv.Command.Options {
 path, ok := opt.Value.(*YAMLConfigPath)
 if !ok || path.String() == "" {
 continue
 }
 if opt.envChanged {
 skipDefaults[i] = struct{}{}

 byt, err := os.ReadFile(path.String())
 if err != nil {
 return xerrors.Errorf("reading yaml: %w", err)
 }

 var n yaml.Node
 err = yaml.Unmarshal(byt, &n)
 if err != nil {
 return xerrors.Errorf("decoding yaml: %w", err)
 }

 err = inv.Command.Options.UnmarshalYAML(&n)
 if err != nil {
 return xerrors.Errorf("applying yaml: %w", err)
 }
 }
 err = inv.Command.Options.SetDefaults(skipDefaults)

 err = inv.Command.Options.SetDefaults()
 if err != nil {
 return xerrors.Errorf("setting defaults: %w", err)
 }
diff --git a/cli/clibase/cmd_test.go b/cli/clibase/cmd_test.go
 "bytes"
 "context"
 "fmt"
 "os"
 "strings"
 "testing"

 func TestCommand_DefaultsOverride(t *testing.T) {
 t.Parallel()

 var got string
 cmd := &clibase.Cmd{
 Options: clibase.OptionSet{
 {
 Name:    "url",
 Flag:    "url",
 Default: "def.com",
 Env:     "URL",
 Value:   clibase.StringOf(&got),
 },
 },
 Handler: (func(i *clibase.Invocation) error {
 _, _ = fmt.Fprintf(i.Stdout, "%s", got)
 return nil
 }),
 test := func(name string, want string, fn func(t *testing.T, inv *clibase.Invocation)) {
 t.Run(name, func(t *testing.T) {
 t.Parallel()

 var (
 got    string
 config clibase.YAMLConfigPath
 )
 cmd := &clibase.Cmd{
 Options: clibase.OptionSet{
 {
 Name:    "url",
 Flag:    "url",
 Default: "def.com",
 Env:     "URL",
 Value:   clibase.StringOf(&got),
 YAML:    "url",
 },
 {
 Name:    "config",
 Flag:    "config",
 Default: "",
 Value:   &config,
 },
 },
 Handler: (func(i *clibase.Invocation) error {
 _, _ = fmt.Fprintf(i.Stdout, "%s", got)
 return nil
 }),
 }

 inv := cmd.Invoke()
 stdio := fakeIO(inv)
 fn(t, inv)
 err := inv.Run()
 require.NoError(t, err)
 require.Equal(t, want, stdio.Stdout.String())
 })
 }

 // Base case
 inv := cmd.Invoke()
 stdio := fakeIO(inv)
 err := inv.Run()
 require.NoError(t, err)
 require.Equal(t, "def.com", stdio.Stdout.String())
 test("DefaultOverNothing", "def.com", func(t *testing.T, inv *clibase.Invocation) {})

 // Flag overrides
 inv = cmd.Invoke("--url", "good.com")
 stdio = fakeIO(inv)
 err = inv.Run()
 require.NoError(t, err)
 require.Equal(t, "good.com", stdio.Stdout.String())
 test("FlagOverDefault", "good.com", func(t *testing.T, inv *clibase.Invocation) {
 inv.Args = []string{"--url", "good.com"}
 })

 // Env overrides
 inv = cmd.Invoke()
 inv.Environ.Set("URL", "good.com")
 stdio = fakeIO(inv)
 err = inv.Run()
 require.NoError(t, err)
 require.Equal(t, "good.com", stdio.Stdout.String())
 test("EnvOverDefault", "good.com", func(t *testing.T, inv *clibase.Invocation) {
 inv.Environ.Set("URL", "good.com")
 })

 test("FlagOverEnv", "good.com", func(t *testing.T, inv *clibase.Invocation) {
 inv.Environ.Set("URL", "bad.com")
 inv.Args = []string{"--url", "good.com"}
 })

 test("FlagOverYAML", "good.com", func(t *testing.T, inv *clibase.Invocation) {
 fi, err := os.CreateTemp(t.TempDir(), "config.yaml")
 require.NoError(t, err)
 defer fi.Close()

 _, err = fi.WriteString("url: bad.com")
 require.NoError(t, err)

 inv.Args = []string{"--config", fi.Name(), "--url", "good.com"}
 })

 test("YAMLOverDefault", "good.com", func(t *testing.T, inv *clibase.Invocation) {
 fi, err := os.CreateTemp(t.TempDir(), "config.yaml")
 require.NoError(t, err)
 defer fi.Close()

 _, err = fi.WriteString("url: good.com")
 require.NoError(t, err)

 inv.Args = []string{"--config", fi.Name()}
 })
 }
diff --git a/cli/clibase/option.go b/cli/clibase/option.go

 import (
 "os"
 "strings"

 "github.com/hashicorp/go-multierror"
 "github.com/spf13/pflag"
 "golang.org/x/xerrors"
 )

 type ValueSource string

 const (
 ValueSourceNone    ValueSource = ""
 ValueSourceFlag    ValueSource = "flag"
 ValueSourceEnv     ValueSource = "env"
 ValueSourceYAML    ValueSource = "yaml"
 ValueSourceDefault ValueSource = "default"
 )

 // Option is a configuration option for a CLI application.
 type Option struct {
 Name        string `json:"name,omitempty"`

 Hidden bool `json:"hidden,omitempty"`

 envChanged bool
 ValueSource ValueSource `json:"value_source,omitempty"`
 }

 func (o Option) YAMLPath() string {
 if o.YAML == "" {
 return ""
 }
 var gs []string
 for _, g := range o.Group.Ancestry() {
 gs = append(gs, g.YAML)
 }
 return strings.Join(append(gs, o.YAML), ".")
 }

 // OptionSet is a group of options that can be applied to a command.
 continue
 }

 opt.envChanged = true
 (*s)[i] = opt
 (*s)[i].ValueSource = ValueSourceEnv
 if err := opt.Value.Set(envVal); err != nil {
 merr = multierror.Append(
 merr, xerrors.Errorf("parse %q: %w", opt.Name, err),
 }

 // SetDefaults sets the default values for each Option, skipping values
 // thathavealreadybeen set as indicated by the skip map.
 func (s *OptionSet) SetDefaults(skip map[int]struct{}) error {
 // that alreadyhave a value source.
 func (s *OptionSet) SetDefaults() error {
 if s == nil {
 return nil
 }

 for i, opt := range *s {
 // Skip values that may have already been set by the user.
 if len(skip) > 0 {
 if _, ok := skip[i]; ok {
 continue
 }
 if opt.ValueSource != ValueSourceNone {
 continue
 }

 if opt.Default == "" {
 )
 continue
 }
 (*s)[i].ValueSource = ValueSourceDefault
 if err := opt.Value.Set(opt.Default); err != nil {
 merr = multierror.Append(
 merr, xerrors.Errorf("parse %q: %w", opt.Name, err),
 }
 return merr.ErrorOrNil()
 }

 // ByName returns the Option with the given name, or nil if no such option
 // exists.
 func (s *OptionSet) ByName(name string) *Option {
 for i := range *s {
 opt := &(*s)[i]
 if opt.Name == name {
 return opt
 }
 }
 return nil
 }
diff --git a/cli/clibase/option_test.go b/cli/clibase/option_test.go
 },
 }

 err := os.SetDefaults(nil)
 err := os.SetDefaults()
 require.NoError(t, err)

 err = os.FlagSet().Parse([]string{"--name", "foo", "--name", "bar"})
 },
 }

 err := os.SetDefaults(nil)
 err := os.SetDefaults()
 require.NoError(t, err)

 err = os.ParseEnv(clibase.ParseEnviron([]string{"CODER_WORKSPACE_NAME="}, "CODER_"))
 },
 }

 err := os.SetDefaults(nil)
 err := os.SetDefaults()
 require.NoError(t, err)

 err = os.ParseEnv([]clibase.EnvVar{
 },
 }

 err := os.SetDefaults(nil)
 err := os.SetDefaults()
 require.NoError(t, err)

 err = os.ParseEnv([]clibase.EnvVar{
Original file line number	Diff line number	Diff line change
Expand Up		@@ -194,6 +194,7 @@ issues:
		linters:
		# We use assertions rather than explicitly checking errors in tests
		- errcheck
		- forcetypeassert

		fix: true
		max-issues-per-linter: 0
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -518,7 +518,7 @@ update-golden-files: cli/testdata/.gen-golden helm/tests/testdata/.gen-golden sc
		.PHONY: update-golden-files

		cli/testdata/.gen-golden: $(wildcard cli/testdata/.golden) $(wildcard cli/.tpl) $(GO_SRC_FILES)
		go test ./cli -run=TestCommandHelp -update
		go test ./cli -run="Test(CommandHelp\|ServerYAML)" -update
		touch "$@"

		helm/tests/testdata/.gen-golden: $(wildcard helm/tests/testdata/*.golden) $(GO_SRC_FILES)
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -14,15 +14,10 @@ import (

		// Group describes a hierarchy of groups that an option or command belongs to.
		type Group struct {
		Parent *Group `json:"parent,omitempty"`
		Name string `json:"name,omitempty"`
		Children []Group `json:"children,omitempty"`
		Description string `json:"description,omitempty"`
		}

		func (g *Group) AddChild(child Group) {
		child.Parent = g
		g.Children = append(g.Children, child)
		Parent *Group `json:"parent,omitempty"`
		Name string `json:"name,omitempty"`
		YAML string `json:"yaml,omitempty"`
		Description string `json:"description,omitempty"`
		}

		// Ancestry returns the group and all of its parents, in order.
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -13,6 +13,7 @@ import (
		"github.com/spf13/pflag"
		"golang.org/x/exp/slices"
		"golang.org/x/xerrors"
		"gopkg.in/yaml.v3"
		)

		// Cmd describes an executable command.
Expand DownExpand Up		@@ -76,10 +77,8 @@ func (c *Cmd) PrepareAll() error {
		}
		var merr error

		slices.SortFunc(c.Options, func(a, b Option) bool {
		return a.Flag < b.Flag
		})
		for _, opt := range c.Options {
		for i := range c.Options {
		opt := &c.Options[i]
		if opt.Name == "" {
		switch {
		case opt.Flag != "":
Expand All		@@ -102,6 +101,10 @@ func (c *Cmd) PrepareAll() error {
		}
		}
		}

		slices.SortFunc(c.Options, func(a, b Option) bool {
		return a.Name < b.Name
		})
		slices.SortFunc(c.Children, func(a, b *Cmd) bool {
		return a.Name() < b.Name()
		})
Expand DownExpand Up		@@ -262,17 +265,38 @@ func (inv Invocation) run(state runState) error {
		parsedArgs = inv.parsedFlags.Args()
		}

		// Set defaults for flags that weren't set by the user.
		skipDefaults := make(map[int]struct{}, len(inv.Command.Options))
		// Set value sources for flags.
		for i, opt := range inv.Command.Options {
		if fl := inv.parsedFlags.Lookup(opt.Flag); fl != nil && fl.Changed {
		skipDefaults[i] = struct{}{}
		inv.Command.Options[i].ValueSource = ValueSourceFlag
		}
		}

		// Read YAML configs, if any.
		for _, opt := range inv.Command.Options {
		path, ok := opt.Value.(*YAMLConfigPath)
		if !ok \|\| path.String() == "" {
		continue
		}
		if opt.envChanged {
		skipDefaults[i] = struct{}{}

		byt, err := os.ReadFile(path.String())
		if err != nil {
		return xerrors.Errorf("reading yaml: %w", err)
		}

		var n yaml.Node
		err = yaml.Unmarshal(byt, &n)
		if err != nil {
		return xerrors.Errorf("decoding yaml: %w", err)
		}

		err = inv.Command.Options.UnmarshalYAML(&n)
		if err != nil {
		return xerrors.Errorf("applying yaml: %w", err)
		}
		}
		err = inv.Command.Options.SetDefaults(skipDefaults)

		err = inv.Command.Options.SetDefaults()
		if err != nil {
		return xerrors.Errorf("setting defaults: %w", err)
		}
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -4,6 +4,7 @@ import (
		"bytes"
		"context"
		"fmt"
		"os"
		"strings"
		"testing"

Expand DownExpand Up		@@ -555,42 +556,80 @@ func TestCommand_EmptySlice(t *testing.T) {
		func TestCommand_DefaultsOverride(t *testing.T) {
		t.Parallel()

		var got string
		cmd := &clibase.Cmd{
		Options: clibase.OptionSet{
		{
		Name: "url",
		Flag: "url",
		Default: "def.com",
		Env: "URL",
		Value: clibase.StringOf(&got),
		},
		},
		Handler: (func(i *clibase.Invocation) error {
		_, _ = fmt.Fprintf(i.Stdout, "%s", got)
		return nil
		}),
		test := func(name string, want string, fn func(t testing.T, inv clibase.Invocation)) {
		t.Run(name, func(t *testing.T) {
		t.Parallel()

		var (
		got string
		config clibase.YAMLConfigPath
		)
		cmd := &clibase.Cmd{
		Options: clibase.OptionSet{
		{
		Name: "url",
		Flag: "url",
		Default: "def.com",
		Env: "URL",
		Value: clibase.StringOf(&got),
		YAML: "url",
		},
		{
		Name: "config",
		Flag: "config",
		Default: "",
		Value: &config,
		},
		},
		Handler: (func(i *clibase.Invocation) error {
		_, _ = fmt.Fprintf(i.Stdout, "%s", got)
		return nil
		}),
		}

		inv := cmd.Invoke()
		stdio := fakeIO(inv)
		fn(t, inv)
		err := inv.Run()
		require.NoError(t, err)
		require.Equal(t, want, stdio.Stdout.String())
		})
		}

		// Base case
		inv := cmd.Invoke()
		stdio := fakeIO(inv)
		err := inv.Run()
		require.NoError(t, err)
		require.Equal(t, "def.com", stdio.Stdout.String())
		test("DefaultOverNothing", "def.com", func(t testing.T, inv clibase.Invocation) {})

		// Flag overrides
		inv = cmd.Invoke("--url", "good.com")
		stdio = fakeIO(inv)
		err = inv.Run()
		require.NoError(t, err)
		require.Equal(t, "good.com", stdio.Stdout.String())
		test("FlagOverDefault", "good.com", func(t testing.T, inv clibase.Invocation) {
		inv.Args = []string{"--url", "good.com"}
		})

		// Env overrides
		inv = cmd.Invoke()
		inv.Environ.Set("URL", "good.com")
		stdio = fakeIO(inv)
		err = inv.Run()
		require.NoError(t, err)
		require.Equal(t, "good.com", stdio.Stdout.String())
		test("EnvOverDefault", "good.com", func(t testing.T, inv clibase.Invocation) {
		inv.Environ.Set("URL", "good.com")
		})

		test("FlagOverEnv", "good.com", func(t testing.T, inv clibase.Invocation) {
		inv.Environ.Set("URL", "bad.com")
		inv.Args = []string{"--url", "good.com"}
		})

		test("FlagOverYAML", "good.com", func(t testing.T, inv clibase.Invocation) {
		fi, err := os.CreateTemp(t.TempDir(), "config.yaml")
		require.NoError(t, err)
		defer fi.Close()

		_, err = fi.WriteString("url: bad.com")
		require.NoError(t, err)

		inv.Args = []string{"--config", fi.Name(), "--url", "good.com"}
		})

		test("YAMLOverDefault", "good.com", func(t testing.T, inv clibase.Invocation) {
		fi, err := os.CreateTemp(t.TempDir(), "config.yaml")
		require.NoError(t, err)
		defer fi.Close()

		_, err = fi.WriteString("url: good.com")
		require.NoError(t, err)

		inv.Args = []string{"--config", fi.Name()}
		})
		}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,12 +2,23 @@ package clibase

		import (
		"os"
		"strings"

		"github.com/hashicorp/go-multierror"
		"github.com/spf13/pflag"
		"golang.org/x/xerrors"
		)

		type ValueSource string

		const (
		ValueSourceNone ValueSource = ""
		ValueSourceFlag ValueSource = "flag"
		ValueSourceEnv ValueSource = "env"
		ValueSourceYAML ValueSource = "yaml"
		ValueSourceDefault ValueSource = "default"
		)

		// Option is a configuration option for a CLI application.
		type Option struct {
		Name string `json:"name,omitempty"`
Expand DownExpand Up		@@ -47,7 +58,18 @@ type Option struct {

		Hidden bool `json:"hidden,omitempty"`

		envChanged bool
		ValueSource ValueSource `json:"value_source,omitempty"`
		}

		func (o Option) YAMLPath() string {
		if o.YAML == "" {
		return ""
		}
		var gs []string
		for _, g := range o.Group.Ancestry() {
		gs = append(gs, g.YAML)
		}
		return strings.Join(append(gs, o.YAML), ".")
		}

		// OptionSet is a group of options that can be applied to a command.
Expand DownExpand Up		@@ -135,8 +157,7 @@ func (s *OptionSet) ParseEnv(vs []EnvVar) error {
		continue
		}

		opt.envChanged = true
		(*s)[i] = opt
		(*s)[i].ValueSource = ValueSourceEnv
		if err := opt.Value.Set(envVal); err != nil {
		merr = multierror.Append(
		merr, xerrors.Errorf("parse %q: %w", opt.Name, err),
Expand All		@@ -148,8 +169,8 @@ func (s *OptionSet) ParseEnv(vs []EnvVar) error {
		}

		// SetDefaults sets the default values for each Option, skipping values
		// thathavealreadybeen set as indicated by the skip map.
		func (s *OptionSet) SetDefaults(skip map[int]struct{}) error {
		// that alreadyhave a value source.
		func (s *OptionSet) SetDefaults() error {
		if s == nil {
		return nil
		}
Expand All		@@ -158,10 +179,8 @@ func (s *OptionSet) SetDefaults(skip map[int]struct{}) error {

		for i, opt := range *s {
		// Skip values that may have already been set by the user.
		if len(skip) > 0 {
		if _, ok := skip[i]; ok {
		continue
		}
		if opt.ValueSource != ValueSourceNone {
		continue
		}

		if opt.Default == "" {
Expand All		@@ -178,6 +197,7 @@ func (s *OptionSet) SetDefaults(skip map[int]struct{}) error {
		)
		continue
		}
		(*s)[i].ValueSource = ValueSourceDefault
		if err := opt.Value.Set(opt.Default); err != nil {
		merr = multierror.Append(
		merr, xerrors.Errorf("parse %q: %w", opt.Name, err),
Expand All		@@ -186,3 +206,15 @@ func (s *OptionSet) SetDefaults(skip map[int]struct{}) error {
		}
		return merr.ErrorOrNil()
		}

		// ByName returns the Option with the given name, or nil if no such option
		// exists.
		func (s OptionSet) ByName(name string) Option {
		for i := range *s {
		opt := &(*s)[i]
		if opt.Name == name {
		return opt
		}
		}
		return nil
		}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -49,7 +49,7 @@ func TestOptionSet_ParseFlags(t *testing.T) {
		},
		}

		err := os.SetDefaults(nil)
		err := os.SetDefaults()
		require.NoError(t, err)

		err = os.FlagSet().Parse([]string{"--name", "foo", "--name", "bar"})
Expand DownExpand Up		@@ -111,7 +111,7 @@ func TestOptionSet_ParseEnv(t *testing.T) {
		},
		}

		err := os.SetDefaults(nil)
		err := os.SetDefaults()
		require.NoError(t, err)

		err = os.ParseEnv(clibase.ParseEnviron([]string{"CODER_WORKSPACE_NAME="}, "CODER_"))
Expand All		@@ -133,7 +133,7 @@ func TestOptionSet_ParseEnv(t *testing.T) {
		},
		}

		err := os.SetDefaults(nil)
		err := os.SetDefaults()
		require.NoError(t, err)

		err = os.ParseEnv([]clibase.EnvVar{
Expand All		@@ -157,7 +157,7 @@ func TestOptionSet_ParseEnv(t *testing.T) {
		},
		}

		err := os.SetDefaults(nil)
		err := os.SetDefaults()
		require.NoError(t, err)

		err = os.ParseEnv([]clibase.EnvVar{
Expand Down