Mar 7, 2023 · Mar 3, 2023 · Mar 3, 2023 · Mar 3, 2023 · Mar 6, 2023 · Mar 6, 2023
diff --git a/cli/cliui/parameter.go b/cli/cliui/parameter.go
 }
 } else {
 text := "Enter a value"
 if templateVersionParameter.DefaultValue != "" {
 if!templateVersionParameter.Required {
 text += fmt.Sprintf(" (default: %q)", templateVersionParameter.DefaultValue)
 }
 text += ":"
 }

 func validateRichPrompt(value string, p codersdk.TemplateVersionParameter) error {
 return codersdk.ValidateWorkspaceBuildParameter(p, codersdk.WorkspaceBuildParameter{
 return codersdk.ValidateWorkspaceBuildParameter(p,&codersdk.WorkspaceBuildParameter{
 Name:  p.Name,
 Value: value,
 }, nil)
diff --git a/cli/update_test.go b/cli/update_test.go
 }
 <-doneChan
 })

 t.Run("RequiredParameterAdded", func(t *testing.T) {
 t.Parallel()

 client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerDaemon: true})
 user := coderdtest.CreateFirstUser(t, client)

 // Upload the initial template
 version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, prepareEchoResponses(stringRichParameters))
 coderdtest.AwaitTemplateVersionJob(t, client, version.ID)
 template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID)

 tempDir := t.TempDir()
 removeTmpDirUntilSuccessAfterTest(t, tempDir)
 parameterFile, _ := os.CreateTemp(tempDir, "testParameterFile*.yaml")
 _, _ = parameterFile.WriteString(
 stringParameterName + ": " + stringParameterValue)

 // Create workspace
 cmd, root := clitest.New(t, "create", "my-workspace", "--template", template.Name, "--rich-parameter-file", parameterFile.Name(), "-y")
 clitest.SetupConfig(t, client, root)
 err := cmd.Execute()
 require.NoError(t, err)

 // Modify template
 const addedParameterName = "added_parameter"

 var modifiedParameters []*proto.RichParameter
 modifiedParameters = append(modifiedParameters, stringRichParameters...)
 modifiedParameters = append(modifiedParameters, &proto.RichParameter{
 Name:     addedParameterName,
 Type:     "string",
 Mutable:  true,
 Required: true,
 })
 version = coderdtest.UpdateTemplateVersion(t, client, user.OrganizationID, prepareEchoResponses(modifiedParameters), template.ID)
 coderdtest.AwaitTemplateVersionJob(t, client, version.ID)
 err = client.UpdateActiveTemplateVersion(context.Background(), template.ID, codersdk.UpdateActiveTemplateVersion{
 ID: version.ID,
 })
 require.NoError(t, err)

 // Update the workspace
 cmd, root = clitest.New(t, "update", "my-workspace")
 clitest.SetupConfig(t, client, root)
 doneChan := make(chan struct{})
 pty := ptytest.New(t)
 cmd.SetIn(pty.Input())
 cmd.SetOut(pty.Output())
 go func() {
 defer close(doneChan)
 err := cmd.Execute()
 assert.NoError(t, err)
 }()

 matches := []string{
 "added_parameter", "",
 "Enter a value:", "abc",
 }
 for i := 0; i < len(matches); i += 2 {
 match := matches[i]
 value := matches[i+1]
 pty.ExpectMatch(match)

 if value != "" {
 pty.WriteLine(value)
 }
 }
 <-doneChan
 })

 t.Run("OptionalParameterAdded", func(t *testing.T) {
 t.Parallel()

 client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerDaemon: true})
 user := coderdtest.CreateFirstUser(t, client)

 // Upload the initial template
 version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, prepareEchoResponses(stringRichParameters))
 coderdtest.AwaitTemplateVersionJob(t, client, version.ID)
 template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID)

 tempDir := t.TempDir()
 removeTmpDirUntilSuccessAfterTest(t, tempDir)
 parameterFile, _ := os.CreateTemp(tempDir, "testParameterFile*.yaml")
 _, _ = parameterFile.WriteString(
 stringParameterName + ": " + stringParameterValue)

 // Create workspace
 cmd, root := clitest.New(t, "create", "my-workspace", "--template", template.Name, "--rich-parameter-file", parameterFile.Name(), "-y")
 clitest.SetupConfig(t, client, root)
 err := cmd.Execute()
 require.NoError(t, err)

 // Modify template
 const addedParameterName = "added_parameter"

 var modifiedParameters []*proto.RichParameter
 modifiedParameters = append(modifiedParameters, stringRichParameters...)
 modifiedParameters = append(modifiedParameters, &proto.RichParameter{
 Name:         addedParameterName,
 Type:         "string",
 Mutable:      true,
 DefaultValue: "foobar",
 Required:     false,
 })
 version = coderdtest.UpdateTemplateVersion(t, client, user.OrganizationID, prepareEchoResponses(modifiedParameters), template.ID)
 coderdtest.AwaitTemplateVersionJob(t, client, version.ID)
 err = client.UpdateActiveTemplateVersion(context.Background(), template.ID, codersdk.UpdateActiveTemplateVersion{
 ID: version.ID,
 })
 require.NoError(t, err)

 // Update the workspace
 cmd, root = clitest.New(t, "update", "my-workspace")
 clitest.SetupConfig(t, client, root)
 doneChan := make(chan struct{})
 pty := ptytest.New(t)
 cmd.SetIn(pty.Input())
 cmd.SetOut(pty.Output())
 go func() {
 defer close(doneChan)
 err := cmd.Execute()
 assert.NoError(t, err)
 }()

 matches := []string{
 "added_parameter", "",
 `Enter a value (default: "foobar")`, "abc",
 }
 for i := 0; i < len(matches); i += 2 {
 match := matches[i]
 value := matches[i+1]
 pty.ExpectMatch(match)
 pty.WriteLine(value)
 }
 <-doneChan
 })
 }
diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
diff --git a/coderd/database/dbfake/databasefake.go b/coderd/database/dbfake/databasefake.go
 ValidationMin:       arg.ValidationMin,
 ValidationMax:       arg.ValidationMax,
 ValidationMonotonic: arg.ValidationMonotonic,
 Required:            arg.Required,
 }
 q.templateVersionParameters = append(q.templateVersionParameters, param)
 return param, nil
diff --git a/coderd/database/dump.sql b/coderd/database/dump.sql
diff --git a/coderd/database/migrations/000105_rich_parameter_required.down.sql b/coderd/database/migrations/000105_rich_parameter_required.down.sql
 ALTER TABLE template_version_parameters DROP COLUMN required;
diff --git a/coderd/database/migrations/000105_rich_parameter_required.up.sql b/coderd/database/migrations/000105_rich_parameter_required.up.sql
 ALTER TABLE template_version_parameters ADD COLUMN required boolean NOT NULL DEFAULT true; -- default: true, as so far every parameter should be marked as required

 COMMENT ON COLUMN template_version_parameters.required IS 'Is parameter required?';
diff --git a/coderd/database/models.go b/coderd/database/models.go
diff --git a/coderd/database/queries.sql.go b/coderd/database/queries.sql.go
diff --git a/coderd/database/queries/templateversionparameters.sql b/coderd/database/queries/templateversionparameters.sql
        validation_min,
        validation_max,
        validation_error,
        validation_monotonic
        validation_monotonic,
        required
    )
 VALUES
    (
        $10,
        $11,
        $12,
        $13
        $13,
        $14
    ) RETURNING *;

 -- name: GetTemplateVersionParameters :many
diff --git a/coderd/provisionerdserver/provisionerdserver.go b/coderd/provisionerdserver/provisionerdserver.go
 ValidationMin:       richParameter.ValidationMin,
 ValidationMax:       richParameter.ValidationMax,
 ValidationMonotonic: richParameter.ValidationMonotonic,
 Required:            richParameter.Required,
 })
 if err != nil {
 return nil, xerrors.Errorf("insert parameter: %w", err)
diff --git a/coderd/templateversions.go b/coderd/templateversions.go
 ValidationMax:        param.ValidationMax,
 ValidationError:      param.ValidationError,
 ValidationMonotonic:  codersdk.ValidationMonotonicOrder(param.ValidationMonotonic),
 Required:             param.Required,
 }, nil
 }
Original file line number	Diff line number	Diff line change
Expand Up		@@ -85,7 +85,7 @@ func RichParameter(cmd *cobra.Command, templateVersionParameter codersdk.Templat
		}
		} else {
		text := "Enter a value"
		if templateVersionParameter.DefaultValue != "" {
		if!templateVersionParameter.Required {
		text += fmt.Sprintf(" (default: %q)", templateVersionParameter.DefaultValue)
		}
		text += ":"
Expand All		@@ -111,7 +111,7 @@ func RichParameter(cmd *cobra.Command, templateVersionParameter codersdk.Templat
		}

		func validateRichPrompt(value string, p codersdk.TemplateVersionParameter) error {
		return codersdk.ValidateWorkspaceBuildParameter(p, codersdk.WorkspaceBuildParameter{
		return codersdk.ValidateWorkspaceBuildParameter(p,&codersdk.WorkspaceBuildParameter{
		Name: p.Name,
		Value: value,
		}, nil)
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -424,4 +424,142 @@ func TestUpdateValidateRichParameters(t *testing.T) {
		}
		<-doneChan
		})

		t.Run("RequiredParameterAdded", func(t *testing.T) {
		t.Parallel()

		client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerDaemon: true})
		user := coderdtest.CreateFirstUser(t, client)

		// Upload the initial template
		version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, prepareEchoResponses(stringRichParameters))
		coderdtest.AwaitTemplateVersionJob(t, client, version.ID)
		template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID)

		tempDir := t.TempDir()
		removeTmpDirUntilSuccessAfterTest(t, tempDir)
		parameterFile, _ := os.CreateTemp(tempDir, "testParameterFile*.yaml")
		_, _ = parameterFile.WriteString(
		stringParameterName + ": " + stringParameterValue)

		// Create workspace
		cmd, root := clitest.New(t, "create", "my-workspace", "--template", template.Name, "--rich-parameter-file", parameterFile.Name(), "-y")
		clitest.SetupConfig(t, client, root)
		err := cmd.Execute()
		require.NoError(t, err)

		// Modify template
		const addedParameterName = "added_parameter"

		var modifiedParameters []*proto.RichParameter
		modifiedParameters = append(modifiedParameters, stringRichParameters...)
		modifiedParameters = append(modifiedParameters, &proto.RichParameter{
		Name: addedParameterName,
		Type: "string",
		Mutable: true,
		Required: true,
		})
		version = coderdtest.UpdateTemplateVersion(t, client, user.OrganizationID, prepareEchoResponses(modifiedParameters), template.ID)
		coderdtest.AwaitTemplateVersionJob(t, client, version.ID)
		err = client.UpdateActiveTemplateVersion(context.Background(), template.ID, codersdk.UpdateActiveTemplateVersion{
		ID: version.ID,
		})
		require.NoError(t, err)

		// Update the workspace
		cmd, root = clitest.New(t, "update", "my-workspace")
		clitest.SetupConfig(t, client, root)
		doneChan := make(chan struct{})
		pty := ptytest.New(t)
		cmd.SetIn(pty.Input())
		cmd.SetOut(pty.Output())
		go func() {
		defer close(doneChan)
		err := cmd.Execute()
		assert.NoError(t, err)
		}()

		matches := []string{
		"added_parameter", "",
		"Enter a value:", "abc",
		}
		for i := 0; i < len(matches); i += 2 {
		match := matches[i]
		value := matches[i+1]
		pty.ExpectMatch(match)

		if value != "" {
		pty.WriteLine(value)
		}
		}
		<-doneChan
		})

		t.Run("OptionalParameterAdded", func(t *testing.T) {
		t.Parallel()

		client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerDaemon: true})
		user := coderdtest.CreateFirstUser(t, client)

		// Upload the initial template
		version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, prepareEchoResponses(stringRichParameters))
		coderdtest.AwaitTemplateVersionJob(t, client, version.ID)
		template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID)

		tempDir := t.TempDir()
		removeTmpDirUntilSuccessAfterTest(t, tempDir)
		parameterFile, _ := os.CreateTemp(tempDir, "testParameterFile*.yaml")
		_, _ = parameterFile.WriteString(
		stringParameterName + ": " + stringParameterValue)

		// Create workspace
		cmd, root := clitest.New(t, "create", "my-workspace", "--template", template.Name, "--rich-parameter-file", parameterFile.Name(), "-y")
		clitest.SetupConfig(t, client, root)
		err := cmd.Execute()
		require.NoError(t, err)

		// Modify template
		const addedParameterName = "added_parameter"

		var modifiedParameters []*proto.RichParameter
		modifiedParameters = append(modifiedParameters, stringRichParameters...)
		modifiedParameters = append(modifiedParameters, &proto.RichParameter{
		Name: addedParameterName,
		Type: "string",
		Mutable: true,
		DefaultValue: "foobar",
		Required: false,
		})
		version = coderdtest.UpdateTemplateVersion(t, client, user.OrganizationID, prepareEchoResponses(modifiedParameters), template.ID)
		coderdtest.AwaitTemplateVersionJob(t, client, version.ID)
		err = client.UpdateActiveTemplateVersion(context.Background(), template.ID, codersdk.UpdateActiveTemplateVersion{
		ID: version.ID,
		})
		require.NoError(t, err)

		// Update the workspace
		cmd, root = clitest.New(t, "update", "my-workspace")
		clitest.SetupConfig(t, client, root)
		doneChan := make(chan struct{})
		pty := ptytest.New(t)
		cmd.SetIn(pty.Input())
		cmd.SetOut(pty.Output())
		go func() {
		defer close(doneChan)
		err := cmd.Execute()
		assert.NoError(t, err)
		}()

		matches := []string{
		"added_parameter", "",
		`Enter a value (default: "foobar")`, "abc",
		}
		for i := 0; i < len(matches); i += 2 {
		match := matches[i]
		value := matches[i+1]
		pty.ExpectMatch(match)
		pty.WriteLine(value)
		}
		<-doneChan
		})
		}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2696,6 +2696,7 @@ func (q *fakeQuerier) InsertTemplateVersionParameter(_ context.Context, arg data
		ValidationMin: arg.ValidationMin,
		ValidationMax: arg.ValidationMax,
		ValidationMonotonic: arg.ValidationMonotonic,
		Required: arg.Required,
		}
		q.templateVersionParameters = append(q.templateVersionParameters, param)
		return param, nil
Expand Down
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		ALTER TABLE template_version_parameters DROP COLUMN required;
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		ALTER TABLE template_version_parameters ADD COLUMN required boolean NOT NULL DEFAULT true; -- default: true, as so far every parameter should be marked as required

		COMMENT ON COLUMN template_version_parameters.required IS 'Is parameter required?';
Original file line number	Diff line number	Diff line change
Expand Up		@@ -13,7 +13,8 @@ INSERT INTO
		validation_min,
		validation_max,
		validation_error,
		validation_monotonic
		validation_monotonic,
		required
		)
		VALUES
		(
Expand All		@@ -29,7 +30,8 @@ VALUES
		$10,
		$11,
		$12,
		$13
		$13,
		$14
		) RETURNING *;

		-- name: GetTemplateVersionParameters :many
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -808,6 +808,7 @@ func (server Server) CompleteJob(ctx context.Context, completed proto.Complete
		ValidationMin: richParameter.ValidationMin,
		ValidationMax: richParameter.ValidationMax,
		ValidationMonotonic: richParameter.ValidationMonotonic,
		Required: richParameter.Required,
		})
		if err != nil {
		return nil, xerrors.Errorf("insert parameter: %w", err)
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -1621,6 +1621,7 @@ func convertTemplateVersionParameter(param database.TemplateVersionParameter) (c
		ValidationMax: param.ValidationMax,
		ValidationError: param.ValidationError,
		ValidationMonotonic: codersdk.ValidationMonotonicOrder(param.ValidationMonotonic),
		Required: param.Required,
		}, nil
		}

Expand Down