chore: rename build options to ephemeral parameters in cli

coder · defelmnq · Oct 16, 2024 · Oct 9, 2024 · Oct 9, 2024 · Oct 9, 2024
commit fa3b28f015b3f5f36552e3a7c9b82b7a1c9b1ec2
diff --git a/cli/create.go b/cli/create.go
@@ -355,8 +355,8 @@ type prepWorkspaceBuildArgs struct {
 	LastBuildParameters       []codersdk.WorkspaceBuildParameter
 	SourceWorkspaceParameters []codersdk.WorkspaceBuildParameter
 
-	PromptBuildOptions bool
-	BuildOptions       []codersdk.WorkspaceBuildParameter
+	PromptEphemeralParameters bool
+	EphemeralParameters       []codersdk.WorkspaceBuildParameter
 
 	PromptRichParameters  bool
 	RichParameters        []codersdk.WorkspaceBuildParameter
@@ -390,8 +390,8 @@ func prepWorkspaceBuild(inv *serpent.Invocation, client *codersdk.Client, args p
 	resolver := new(ParameterResolver).
 		WithLastBuildParameters(args.LastBuildParameters).
 		WithSourceWorkspaceParameters(args.SourceWorkspaceParameters).
-		WithPromptBuildOptions(args.PromptBuildOptions).
-		WithBuildOptions(args.BuildOptions).
+		WithPromptEphemeralParameters(args.PromptEphemeralParameters).
+		WithEphemeralParameters(args.EphemeralParameters).
 		WithPromptRichParameters(args.PromptRichParameters).
 		WithRichParameters(args.RichParameters).
 		WithRichParametersFile(parameterFile).

diff --git a/cli/parameter.go b/cli/parameter.go
@@ -15,8 +15,9 @@ import (
 
 // workspaceParameterFlags are used by commands processing rich parameters and/or build options.
 type workspaceParameterFlags struct {
-	promptBuildOptions bool
-	buildOptions       []string
+	promptEphemeralParameters bool
+
+	ephemeralParameters []string
 
 	richParameterFile     string
 	richParameters        []string
@@ -26,23 +27,40 @@ type workspaceParameterFlags struct {
 }
 
 func (wpf *workspaceParameterFlags) allOptions() []serpent.Option {
-	options := append(wpf.cliBuildOptions(), wpf.cliParameters()...)
+	options := append(wpf.cliEphemeralParameters(), wpf.cliParameters()...)
 	options = append(options, wpf.cliParameterDefaults()...)
 	return append(options, wpf.alwaysPrompt())
 }
 
-func (wpf *workspaceParameterFlags) cliBuildOptions() []serpent.Option {
+func (wpf *workspaceParameterFlags) cliEphemeralParameters() []serpent.Option {
 	return serpent.OptionSet{
+		// Deprecated - replaced with ephemeral-parameter
 		{
 			Flag:        "build-option",
 			Env:         "CODER_BUILD_OPTION",
 			Description: `Build option value in the format "name=value".`,
-			Value:       serpent.StringArrayOf(&wpf.buildOptions),
+			UseInstead:  []serpent.Option{{Flag: "ephemeral-parameter"}},
+			Hidden:      true,
+			Value:       serpent.StringArrayOf(&wpf.ephemeralParameters),
 		},
+		// Deprecated - replaced with prompt-ephemeral-parameters
 		{
 			Flag:        "build-options",
 			Description: "Prompt for one-time build options defined with ephemeral parameters.",
-			Value:       serpent.BoolOf(&wpf.promptBuildOptions),
+			UseInstead:  []serpent.Option{{Flag: "prompt-ephemeral-parameters"}},
+			Value:       serpent.BoolOf(&wpf.promptEphemeralParameters),
+		},
+		{
+			Flag:        "ephemeral-parameter",
+			Env:         "CODER_EPHEMERAL_PARAMETER",
+			Description: `Define ephemeral parameters in the format "name=value".`,
+			Value:       serpent.StringArrayOf(&wpf.ephemeralParameters),
+		},
+		{
+			Flag:        "prompt-ephemeral-parameters",
+			Env:         "CODER_PROMPT_EPHEMERAL_PARAMETERS",
+			Description: "Prompt for values of ephemeral parameters described in the template.",
+			Value:       serpent.BoolOf(&wpf.promptEphemeralParameters),
 		},
 	}
 }

diff --git a/cli/parameterresolver.go b/cli/parameterresolver.go
@@ -29,10 +29,10 @@ type ParameterResolver struct {
 	richParameters         []codersdk.WorkspaceBuildParameter
 	richParametersDefaults map[string]string
 	richParametersFile     map[string]string
-	buildOptions           []codersdk.WorkspaceBuildParameter
+	ephemeralParameters    []codersdk.WorkspaceBuildParameter
 
-	promptRichParameters bool
-	promptBuildOptions   bool
+	promptRichParameters      bool
+	promptEphemeralParameters bool
 }
 
 func (pr *ParameterResolver) WithLastBuildParameters(params []codersdk.WorkspaceBuildParameter) *ParameterResolver {
@@ -50,8 +50,8 @@ func (pr *ParameterResolver) WithRichParameters(params []codersdk.WorkspaceBuild
 	return pr
 }
 
-func (pr *ParameterResolver) WithBuildOptions(params []codersdk.WorkspaceBuildParameter) *ParameterResolver {
-	pr.buildOptions = params
+func (pr *ParameterResolver) WithEphemeralParameters(params []codersdk.WorkspaceBuildParameter) *ParameterResolver {
+	pr.ephemeralParameters = params
 	return pr
 }
 
@@ -75,8 +75,8 @@ func (pr *ParameterResolver) WithPromptRichParameters(promptRichParameters bool)
 	return pr
 }
 
-func (pr *ParameterResolver) WithPromptBuildOptions(promptBuildOptions bool) *ParameterResolver {
-	pr.promptBuildOptions = promptBuildOptions
+func (pr *ParameterResolver) WithPromptEphemeralParameters(promptEphemeralParameters bool) *ParameterResolver {
+	pr.promptEphemeralParameters = promptEphemeralParameters
 	return pr
 }
 
@@ -128,16 +128,16 @@ nextRichParameter:
 		resolved = append(resolved, richParameter)
 	}
 
-nextBuildOption:
-	for _, buildOption := range pr.buildOptions {
+nextEphemeralParameter:
+	for _, ephemeralParameter := range pr.ephemeralParameters {
 		for i, r := range resolved {
-			if r.Name == buildOption.Name {
-				resolved[i].Value = buildOption.Value
-				continue nextBuildOption
+			if r.Name == ephemeralParameter.Name {
+				resolved[i].Value = ephemeralParameter.Value
+				continue nextEphemeralParameter
 			}
 		}
 
-		resolved = append(resolved, buildOption)
+		resolved = append(resolved, ephemeralParameter)
 	}
 	return resolved
 }
@@ -209,8 +209,8 @@ func (pr *ParameterResolver) verifyConstraints(resolved []codersdk.WorkspaceBuil
 			return templateVersionParametersNotFound(r.Name, templateVersionParameters)
 		}
 
-		if tvp.Ephemeral && !pr.promptBuildOptions && findWorkspaceBuildParameter(tvp.Name, pr.buildOptions) == nil {
-			return xerrors.Errorf("ephemeral parameter %q can be used only with --build-options or --build-option flag", r.Name)
+		if tvp.Ephemeral && !pr.promptEphemeralParameters && findWorkspaceBuildParameter(tvp.Name, pr.ephemeralParameters) == nil {
+			return xerrors.Errorf("ephemeral parameter %q can be used only with --prompt-ephemeral-parameters or --ephemeral-parameter flag", r.Name)
 		}
 
 		if !tvp.Mutable && action != WorkspaceCreate {
@@ -231,7 +231,7 @@ func (pr *ParameterResolver) resolveWithInput(resolved []codersdk.WorkspaceBuild
 		firstTimeUse := pr.isFirstTimeUse(tvp.Name)
 		promptParameterOption := pr.isLastBuildParameterInvalidOption(tvp)
 
-		if (tvp.Ephemeral && pr.promptBuildOptions) ||
+		if (tvp.Ephemeral && pr.promptEphemeralParameters) ||
 			(action == WorkspaceCreate && tvp.Required) ||
 			(action == WorkspaceCreate && !tvp.Ephemeral) ||
 			(action == WorkspaceUpdate && promptParameterOption) ||

diff --git a/cli/restart_test.go b/cli/restart_test.go
@@ -60,7 +60,7 @@ func TestRestart(t *testing.T) {
 		require.NoError(t, err, "execute failed")
 	})
 
-	t.Run("BuildOptions", func(t *testing.T) {
+	t.Run("PromptEphemeralParameters", func(t *testing.T) {
 		t.Parallel()
 
 		client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerDaemon: true})
@@ -72,7 +72,7 @@ func TestRestart(t *testing.T) {
 		workspace := coderdtest.CreateWorkspace(t, member, template.ID)
 		coderdtest.AwaitWorkspaceBuildJobCompleted(t, client, workspace.LatestBuild.ID)
 
-		inv, root := clitest.New(t, "restart", workspace.Name, "--build-options")
+		inv, root := clitest.New(t, "restart", workspace.Name, "--prompt-ephemeral-parameters")
 		clitest.SetupConfig(t, member, root)
 		doneChan := make(chan struct{})
 		pty := ptytest.New(t).Attach(inv)
@@ -114,7 +114,7 @@ func TestRestart(t *testing.T) {
 		})
 	})
 
-	t.Run("BuildOptionFlags", func(t *testing.T) {
+	t.Run("EphemeralParameterFlags", func(t *testing.T) {
 		t.Parallel()
 
 		client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerDaemon: true})
@@ -127,7 +127,7 @@ func TestRestart(t *testing.T) {
 		coderdtest.AwaitWorkspaceBuildJobCompleted(t, client, workspace.LatestBuild.ID)
 
 		inv, root := clitest.New(t, "restart", workspace.Name,
-			"--build-option", fmt.Sprintf("%s=%s", ephemeralParameterName, ephemeralParameterValue))
+			"--ephemeral-parameter", fmt.Sprintf("%s=%s", ephemeralParameterName, ephemeralParameterValue))
 		clitest.SetupConfig(t, member, root)
 		doneChan := make(chan struct{})
 		pty := ptytest.New(t).Attach(inv)

diff --git a/cli/start.go b/cli/start.go
@@ -96,7 +96,7 @@ func buildWorkspaceStartRequest(inv *serpent.Invocation, client *codersdk.Client
 		return codersdk.CreateWorkspaceBuildRequest{}, err
 	}
 
-	buildOptions, err := asWorkspaceBuildParameters(parameterFlags.buildOptions)
+	ephemeralParameters, err := asWorkspaceBuildParameters(parameterFlags.ephemeralParameters)
 	if err != nil {
 		return codersdk.CreateWorkspaceBuildRequest{}, xerrors.Errorf("unable to parse build options: %w", err)
 	}
@@ -117,12 +117,12 @@ func buildWorkspaceStartRequest(inv *serpent.Invocation, client *codersdk.Client
 		NewWorkspaceName:    workspace.Name,
 		LastBuildParameters: lastBuildParameters,
 
-		PromptBuildOptions:    parameterFlags.promptBuildOptions,
-		BuildOptions:          buildOptions,
-		PromptRichParameters:  parameterFlags.promptRichParameters,
-		RichParameters:        cliRichParameters,
-		RichParameterFile:     parameterFlags.richParameterFile,
-		RichParameterDefaults: cliRichParameterDefaults,
+		PromptEphemeralParameters: parameterFlags.promptEphemeralParameters,
+		EphemeralParameters:       ephemeralParameters,
+		PromptRichParameters:      parameterFlags.promptRichParameters,
+		RichParameters:            cliRichParameters,
+		RichParameterFile:         parameterFlags.richParameterFile,
+		RichParameterDefaults:     cliRichParameterDefaults,
 	})
 	if err != nil {
 		return codersdk.CreateWorkspaceBuildRequest{}, err

diff --git a/cli/start_test.go b/cli/start_test.go
@@ -115,7 +115,7 @@ func TestStart(t *testing.T) {
 		workspaceBuild := coderdtest.CreateWorkspaceBuild(t, client, workspace, database.WorkspaceTransitionStop)
 		coderdtest.AwaitWorkspaceBuildJobCompleted(t, client, workspaceBuild.ID)
 
-		inv, root := clitest.New(t, "start", workspace.Name, "--build-options")
+		inv, root := clitest.New(t, "start", workspace.Name, "--prompt-ephemeral-parameters")
 		clitest.SetupConfig(t, member, root)
 		doneChan := make(chan struct{})
 		pty := ptytest.New(t).Attach(inv)
@@ -140,7 +140,7 @@ func TestStart(t *testing.T) {
 		}
 		<-doneChan
 
-		// Verify if build option is set
+		// Verify if ephemeral parameter is set
 		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitShort)
 		defer cancel()
 
@@ -154,7 +154,7 @@ func TestStart(t *testing.T) {
 		})
 	})
 
-	t.Run("BuildOptionFlags", func(t *testing.T) {
+	t.Run("EphemeralParameterFlags", func(t *testing.T) {
 		t.Parallel()
 
 		client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerDaemon: true})
@@ -170,7 +170,7 @@ func TestStart(t *testing.T) {
 		coderdtest.AwaitWorkspaceBuildJobCompleted(t, client, workspaceBuild.ID)
 
 		inv, root := clitest.New(t, "start", workspace.Name,
-			"--build-option", fmt.Sprintf("%s=%s", ephemeralParameterName, ephemeralParameterValue))
+			"--ephemeral-parameter", fmt.Sprintf("%s=%s", ephemeralParameterName, ephemeralParameterValue))
 		clitest.SetupConfig(t, member, root)
 		doneChan := make(chan struct{})
 		pty := ptytest.New(t).Attach(inv)
@@ -183,7 +183,7 @@ func TestStart(t *testing.T) {
 		pty.ExpectMatch("workspace has been started")
 		<-doneChan
 
-		// Verify if build option is set
+		// Verify if ephemeral parameter is set
 		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitShort)
 		defer cancel()
 

diff --git a/cli/update.go b/cli/update.go
@@ -29,7 +29,7 @@ func (r *RootCmd) update() *serpent.Command {
 			if err != nil {
 				return err
 			}
-			if !workspace.Outdated && !parameterFlags.promptRichParameters && !parameterFlags.promptBuildOptions && len(parameterFlags.buildOptions) == 0 {
+			if !workspace.Outdated && !parameterFlags.promptRichParameters && !parameterFlags.promptEphemeralParameters && len(parameterFlags.ephemeralParameters) == 0 {
 				_, _ = fmt.Fprintf(inv.Stdout, "Workspace isn't outdated!\n")
 				return nil
 			}

diff --git a/cli/update_test.go b/cli/update_test.go
@@ -160,7 +160,7 @@ func TestUpdateWithRichParameters(t *testing.T) {
 		<-doneChan
 	})
 
-	t.Run("BuildOptions", func(t *testing.T) {
+	t.Run("PromptEphemeralParameters", func(t *testing.T) {
 		t.Parallel()
 
 		client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerDaemon: true})
@@ -186,7 +186,7 @@ func TestUpdateWithRichParameters(t *testing.T) {
 		err := inv.Run()
 		assert.NoError(t, err)
 
-		inv, root = clitest.New(t, "update", workspaceName, "--build-options")
+		inv, root = clitest.New(t, "update", workspaceName, "--prompt-ephemeral-parameters")
 		clitest.SetupConfig(t, member, root)
 
 		doneChan := make(chan struct{})
@@ -211,7 +211,7 @@ func TestUpdateWithRichParameters(t *testing.T) {
 		}
 		<-doneChan
 
-		// Verify if build option is set
+		// Verify if ephemeral parameter is set
 		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitShort)
 		defer cancel()
 
@@ -225,7 +225,7 @@ func TestUpdateWithRichParameters(t *testing.T) {
 		})
 	})
 
-	t.Run("BuildOptionFlags", func(t *testing.T) {
+	t.Run("EphemeralParameterFlags", func(t *testing.T) {
 		t.Parallel()
 
 		client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerDaemon: true})
@@ -247,7 +247,7 @@ func TestUpdateWithRichParameters(t *testing.T) {
 		assert.NoError(t, err)
 
 		inv, root = clitest.New(t, "update", workspaceName,
-			"--build-option", fmt.Sprintf("%s=%s", ephemeralParameterName, ephemeralParameterValue))
+			"--ephemeral-parameter", fmt.Sprintf("%s=%s", ephemeralParameterName, ephemeralParameterValue))
 		clitest.SetupConfig(t, member, root)
 
 		doneChan := make(chan struct{})
@@ -261,7 +261,7 @@ func TestUpdateWithRichParameters(t *testing.T) {
 		pty.ExpectMatch("Planning workspace")
 		<-doneChan
 
-		// Verify if build option is set
+		// Verify if ephemeral parameter is set
 		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitShort)
 		defer cancel()