Use rich parameter flags

coder · mtojek · Aug 9, 2023 · Aug 4, 2023 · Aug 4, 2023 · Aug 4, 2023
commit 30e99a5a2846376bc8def3a6ee94b9b9f3ab256f
diff --git a/cli/create.go b/cli/create.go
@@ -18,11 +18,12 @@ import (
 
 func (r *RootCmd) create() *clibase.Cmd {
 	var (
-		richParameterFile string
-		templateName      string
-		startAt           string
-		stopAfter         time.Duration
-		workspaceName     string
+		templateName  string
+		startAt       string
+		stopAfter     time.Duration
+		workspaceName string
+
+		parameterFlags workspaceParameterFlags
 	)
 	client := new(codersdk.Client)
 	cmd := &clibase.Cmd{
@@ -131,7 +132,7 @@ func (r *RootCmd) create() *clibase.Cmd {
 
 			buildParams, err := prepWorkspaceBuild(inv, client, prepWorkspaceBuildArgs{
 				Template:          template,
-				RichParameterFile: richParameterFile,
+				RichParameterFile: parameterFlags.richParameterFile,
 				NewWorkspaceName:  workspaceName,
 			})
 			if err != nil {
@@ -179,12 +180,6 @@ func (r *RootCmd) create() *clibase.Cmd {
 			Description:   "Specify a template name.",
 			Value:         clibase.StringOf(&templateName),
 		},
-		clibase.Option{
-			Flag:        "rich-parameter-file",
-			Env:         "CODER_RICH_PARAMETER_FILE",
-			Description: "Specify a file path with values for rich parameters defined in the template.",
-			Value:       clibase.StringOf(&richParameterFile),
-		},
 		clibase.Option{
 			Flag:        "start-at",
 			Env:         "CODER_WORKSPACE_START_AT",
@@ -199,6 +194,7 @@ func (r *RootCmd) create() *clibase.Cmd {
 		},
 		cliui.SkipPromptOption(),
 	)
+	cmd.Options = append(cmd.Options, parameterFlags.richParameters()...)
 	return cmd
 }
 

diff --git a/cli/restart.go b/cli/restart.go
@@ -37,8 +37,8 @@ func (r *RootCmd) restart() *clibase.Cmd {
 			}
 
 			buildParams, err := prepStartWorkspace(inv, client, prepStartWorkspaceArgs{
-				Template:     template,
-				BuildOptions: parameterFlags.buildOptions,
+				Template:           template,
+				PromptBuildOptions: parameterFlags.promptBuildOptions,
 			})
 			if err != nil {
 				return err

diff --git a/cli/start.go b/cli/start.go
@@ -11,17 +11,44 @@ import (
 	"github.com/coder/coder/codersdk"
 )
 
-// workspaceParameterFlags are used by "start", "restart", and "update".
+// workspaceParameterFlags are used by commands requiring rich parameters and/or build options.
 type workspaceParameterFlags struct {
-	buildOptions bool
+	promptBuildOptions bool
+	buildOptions       []string
+
+	richParameterFile string
+	parameters        []string
 }
 
 func (wpf *workspaceParameterFlags) options() []clibase.Option {
 	return clibase.OptionSet{
+		clibase.Option{
+			Flag:        "parameter",
+			Env:         "CODER_BUILD_OPTION",
+			Description: `Build option value in the format "name=value"`,
+			Value:       clibase.StringArrayOf(&wpf.buildOptions),
+		},
 		{
 			Flag:        "build-options",
 			Description: "Prompt for one-time build options defined with ephemeral parameters.",
-			Value:       clibase.BoolOf(&wpf.buildOptions),
+			Value:       clibase.BoolOf(&wpf.promptBuildOptions),
+		},
+	}
+}
+
+func (wpf *workspaceParameterFlags) richParameters() []clibase.Option {
+	return clibase.OptionSet{
+		clibase.Option{
+			Flag:        "parameter",
+			Env:         "CODER_RICH_PARAMETER",
+			Description: `Rich parameter value in the format "name=value"`,
+			Value:       clibase.StringArrayOf(&wpf.parameters),
+		},
+		clibase.Option{
+			Flag:        "rich-parameter-file",
+			Env:         "CODER_RICH_PARAMETER_FILE",
+			Description: "Specify a file path with values for rich parameters defined in the template.",
+			Value:       clibase.StringOf(&wpf.richParameterFile),
 		},
 	}
 }
@@ -51,8 +78,8 @@ func (r *RootCmd) start() *clibase.Cmd {
 			}
 
 			buildParams, err := prepStartWorkspace(inv, client, prepStartWorkspaceArgs{
-				Template:     template,
-				BuildOptions: parameterFlags.buildOptions,
+				Template:           template,
+				PromptBuildOptions: parameterFlags.promptBuildOptions,
 			})
 			if err != nil {
 				return err
@@ -79,8 +106,8 @@ func (r *RootCmd) start() *clibase.Cmd {
 }
 
 type prepStartWorkspaceArgs struct {
-	Template     codersdk.Template
-	BuildOptions bool
+	Template           codersdk.Template
+	PromptBuildOptions bool
 }
 
 func prepStartWorkspace(inv *clibase.Invocation, client *codersdk.Client, args prepStartWorkspaceArgs) (*buildParameters, error) {
@@ -97,7 +124,7 @@ func prepStartWorkspace(inv *clibase.Invocation, client *codersdk.Client, args p
 	}
 
 	richParameters := make([]codersdk.WorkspaceBuildParameter, 0)
-	if !args.BuildOptions {
+	if !args.PromptBuildOptions {
 		return &buildParameters{
 			richParameters: richParameters,
 		}, nil

diff --git a/cli/update.go b/cli/update.go
@@ -9,8 +9,7 @@ import (
 
 func (r *RootCmd) update() *clibase.Cmd {
 	var (
-		richParameterFile string
-		alwaysPrompt      bool
+		alwaysPrompt bool
 
 		parameterFlags workspaceParameterFlags
 	)
@@ -30,7 +29,7 @@ func (r *RootCmd) update() *clibase.Cmd {
 			if err != nil {
 				return err
 			}
-			if !workspace.Outdated && !alwaysPrompt && !parameterFlags.buildOptions {
+			if !workspace.Outdated && !alwaysPrompt && !parameterFlags.promptBuildOptions {
 				_, _ = fmt.Fprintf(inv.Stdout, "Workspace isn't outdated!\n")
 				return nil
 			}
@@ -50,13 +49,13 @@ func (r *RootCmd) update() *clibase.Cmd {
 			buildParams, err := prepWorkspaceBuild(inv, client, prepWorkspaceBuildArgs{
 				Template:           template,
 				ExistingRichParams: existingRichParams,
-				RichParameterFile:  richParameterFile,
+				RichParameterFile:  parameterFlags.richParameterFile,
 				NewWorkspaceName:   workspace.Name,
 
 				UpdateWorkspace: true,
 				WorkspaceID:     workspace.LatestBuild.ID,
 
-				BuildOptions: parameterFlags.buildOptions,
+				BuildOptions: parameterFlags.promptBuildOptions,
 			})
 			if err != nil {
 				return err
@@ -92,13 +91,8 @@ func (r *RootCmd) update() *clibase.Cmd {
 			Description: "Always prompt all parameters. Does not pull parameter values from existing workspace.",
 			Value:       clibase.BoolOf(&alwaysPrompt),
 		},
-		{
-			Flag:        "rich-parameter-file",
-			Description: "Specify a file path with values for rich parameters defined in the template.",
-			Env:         "CODER_RICH_PARAMETER_FILE",
-			Value:       clibase.StringOf(&richParameterFile),
-		},
 	}
 	cmd.Options = append(cmd.Options, parameterFlags.options()...)
+	cmd.Options = append(cmd.Options, parameterFlags.richParameters()...)
 	return cmd
 }