feat: add required flag to cli options

Emyrk · Emyrk · commit 1681c996214d · 2023-07-07T11:09:36.000-04:00
diff --git a/cli/clibase/cmd.go b/cli/clibase/cmd.go
@@ -311,6 +311,18 @@ func (inv *Invocation) run(state *runState) error {
 		return xerrors.Errorf("setting defaults: %w", err)
 	}
 
+	// All options should be set. Check all required options have sources,
+	// meaning they were set by the user in some way (env, flag, etc).
+	var missing []string
+	for _, opt := range inv.Command.Options {
+		if opt.Required && opt.ValueSource == ValueSourceNone {
+			missing = append(missing, opt.Flag)
+		}
+	}
+	if len(missing) > 0 {
+		return xerrors.Errorf("Missing values for the required flags: %s", strings.Join(missing, ", "))
+	}
+
 	// Run child command if found (next child only)
 	// We must do subcommand detection after flag parsing so we don't mistake flag
 	// values for subcommand names.
diff --git a/cli/clibase/option.go b/cli/clibase/option.go
@@ -23,6 +23,10 @@ const (
 type Option struct {
 	Name        string `json:"name,omitempty"`
 	Description string `json:"description,omitempty"`
+	// Required means this value must be set by some means. It requires
+	// `ValueSource != ValueSourceNone`
+	// If `Default` is set, then `Required` is ignored.
+	Required bool `json:"required,omitempty"`
 
 	// Flag is the long name of the flag used to configure this option. If unset,
 	// flag configuring is disabled.
diff --git a/cli/clibase/values.go b/cli/clibase/values.go
@@ -20,23 +20,23 @@ import (
 // of the value after or before it has been set.
 type Validator[T pflag.Value] struct {
 	Value T
-	// ValidateBefore is called before the value is set.
-	ValidateBefore func(input string) error
-	// ValidateAfter is called after the value is set.
-	ValidateAfter func(T) error
+	// validateBefore is called before the value is set.
+	validateBefore func(input string) error
+	// validateAfter is called after the value is set.
+	validateAfter func(T) error
 }
 
 func Validate[T pflag.Value](opt T) *Validator[T] {
 	return &Validator[T]{Value: opt}
 }
 
 func (i *Validator[T]) Before(fn func(input string) error) *Validator[T] {
-	i.ValidateBefore = fn
+	i.validateBefore = fn
 	return i
 }
 
 func (i *Validator[T]) After(fn func(value T) error) *Validator[T] {
-	i.ValidateAfter = fn
+	i.validateAfter = fn
 	return i
 }
 
@@ -45,8 +45,8 @@ func (i *Validator[T]) String() string {
 }
 
 func (i *Validator[T]) Set(input string) error {
-	if i.ValidateBefore != nil {
-		err := i.ValidateBefore(input)
+	if i.validateBefore != nil {
+		err := i.validateBefore(input)
 		if err != nil {
 			return err
 		}
@@ -56,8 +56,8 @@ func (i *Validator[T]) Set(input string) error {
 	if err != nil {
 		return err
 	}
-	if i.ValidateAfter != nil {
-		err = i.ValidateAfter(i.Value)
+	if i.validateAfter != nil {
+		err = i.validateAfter(i.Value)
 		if err != nil {
 			return err
 		}
diff --git a/enterprise/cli/proxyserver.go b/enterprise/cli/proxyserver.go
@@ -65,7 +65,7 @@ func (*RootCmd) proxyServer() *clibase.Cmd {
 			Flag:        "proxy-session-token",
 			Env:         "CODER_PROXY_SESSION_TOKEN",
 			YAML:        "proxySessionToken",
-			Default:     "",
+			Required:    true,
 			Value:       &proxySessionToken,
 			Group:       &externalProxyOptionGroup,
 			Hidden:      false,
@@ -77,10 +77,15 @@ func (*RootCmd) proxyServer() *clibase.Cmd {
 			Flag:        "primary-access-url",
 			Env:         "CODER_PRIMARY_ACCESS_URL",
 			YAML:        "primaryAccessURL",
-			Default:     "",
-			Value:       &primaryAccessURL,
-			Group:       &externalProxyOptionGroup,
-			Hidden:      false,
+			Required:    true,
+			Value: clibase.Validate(&primaryAccessURL).After(func(value *clibase.URL) error {
+				if !(value.Scheme == "http" || value.Scheme == "https") {
+					return xerrors.Errorf("'--primary-access-url' value must be http or https: url=%s", primaryAccessURL.String())
+				}
+				return nil
+			}),
+			Group:  &externalProxyOptionGroup,
+			Hidden: false,
 		},
 	)
 
@@ -94,10 +99,6 @@ func (*RootCmd) proxyServer() *clibase.Cmd {
 			clibase.RequireNArgs(0),
 		),
 		Handler: func(inv *clibase.Invocation) error {
-			if !(primaryAccessURL.Scheme == "http" || primaryAccessURL.Scheme == "https") {
-				return xerrors.Errorf("'--primary-access-url' value must be http or https: url=%s", primaryAccessURL.String())
-			}
-
 			var closers closers
 			// Main command context for managing cancellation of running
 			// services.
