coder · mtojek · Nov 10, 2022 · Nov 8, 2022 · Nov 9, 2022 · Nov 9, 2022
diff --git a/cli/templateedit.go b/cli/templateedit.go
@@ -14,6 +14,7 @@ import (
 func templateEdit() *cobra.Command {
 	var (
 		name                 string
+		displayName          string
 		description          string
 		icon                 string
 		maxTTL               time.Duration
@@ -41,6 +42,7 @@ func templateEdit() *cobra.Command {
 			// NOTE: coderd will ignore empty fields.
 			req := codersdk.UpdateTemplateMeta{
 				Name:                       name,
+				DisplayName:                displayName,
 				Description:                description,
 				Icon:                       icon,
 				MaxTTLMillis:               maxTTL.Milliseconds(),
@@ -57,6 +59,7 @@ func templateEdit() *cobra.Command {
 	}
 
 	cmd.Flags().StringVarP(&name, "name", "", "", "Edit the template name")
+	cmd.Flags().StringVarP(&displayName, "display-name", "", "", "Edit the template display name")
 	cmd.Flags().StringVarP(&description, "description", "", "", "Edit the template description")
 	cmd.Flags().StringVarP(&icon, "icon", "", "", "Edit the template icon path")
 	cmd.Flags().DurationVarP(&maxTTL, "max-ttl", "", 0, "Edit the template maximum time before shutdown - workspaces created from this template cannot stay running longer than this.")

diff --git a/cli/templateedit_test.go b/cli/templateedit_test.go
@@ -10,8 +10,6 @@ import (
 
 	"github.com/coder/coder/cli/clitest"
 	"github.com/coder/coder/coderd/coderdtest"
-	"github.com/coder/coder/coderd/util/ptr"
-	"github.com/coder/coder/codersdk"
 )
 
 func TestTemplateEdit(t *testing.T) {
@@ -23,15 +21,11 @@ func TestTemplateEdit(t *testing.T) {
 		user := coderdtest.CreateFirstUser(t, client)
 		version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, nil)
 		_ = coderdtest.AwaitTemplateVersionJob(t, client, version.ID)
-		template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID, func(ctr *codersdk.CreateTemplateRequest) {
-			ctr.Description = "original description"
-			ctr.Icon = "/icons/default-icon.png"
-			ctr.MaxTTLMillis = ptr.Ref(24 * time.Hour.Milliseconds())
-			ctr.MinAutostartIntervalMillis = ptr.Ref(time.Hour.Milliseconds())
-		})
+		template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID)
 
 		// Test the cli command.
 		name := "new-template-name"
+		displayName := "New Display Name 789"
 		desc := "lorem ipsum dolor sit amet et cetera"
 		icon := "/icons/new-icon.png"
 		maxTTL := 12 * time.Hour
@@ -41,6 +35,7 @@ func TestTemplateEdit(t *testing.T) {
 			"edit",
 			template.Name,
 			"--name", name,
+			"--display-name", displayName,
 			"--description", desc,
 			"--icon", icon,
 			"--max-ttl", maxTTL.String(),
@@ -57,24 +52,19 @@ func TestTemplateEdit(t *testing.T) {
 		updated, err := client.Template(context.Background(), template.ID)
 		require.NoError(t, err)
 		assert.Equal(t, name, updated.Name)
+		assert.Equal(t, displayName, updated.DisplayName)
 		assert.Equal(t, desc, updated.Description)
 		assert.Equal(t, icon, updated.Icon)
 		assert.Equal(t, maxTTL.Milliseconds(), updated.MaxTTLMillis)
 		assert.Equal(t, minAutostartInterval.Milliseconds(), updated.MinAutostartIntervalMillis)
 	})
-
 	t.Run("NotModified", func(t *testing.T) {
 		t.Parallel()
 		client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerDaemon: true})
 		user := coderdtest.CreateFirstUser(t, client)
 		version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, nil)
 		_ = coderdtest.AwaitTemplateVersionJob(t, client, version.ID)
-		template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID, func(ctr *codersdk.CreateTemplateRequest) {
-			ctr.Description = "original description"
-			ctr.Icon = "/icons/default-icon.png"
-			ctr.MaxTTLMillis = ptr.Ref(24 * time.Hour.Milliseconds())
-			ctr.MinAutostartIntervalMillis = ptr.Ref(time.Hour.Milliseconds())
-		})
+		template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID)
 
 		// Test the cli command.
 		cmdArgs := []string{
@@ -103,4 +93,33 @@ func TestTemplateEdit(t *testing.T) {
 		assert.Equal(t, template.MaxTTLMillis, updated.MaxTTLMillis)
 		assert.Equal(t, template.MinAutostartIntervalMillis, updated.MinAutostartIntervalMillis)
 	})
+	t.Run("InvalidDisplayName", func(t *testing.T) {
+		t.Parallel()
+		client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerDaemon: true})
+		user := coderdtest.CreateFirstUser(t, client)
+		version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, nil)
+		_ = coderdtest.AwaitTemplateVersionJob(t, client, version.ID)
+		template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID)
+
+		// Test the cli command.
+		cmdArgs := []string{
+			"templates",
+			"edit",
+			template.Name,
+			"--name", template.Name,
+			"--display-name", "a-b-c",
+		}
+		cmd, root := clitest.New(t, cmdArgs...)
+		clitest.SetupConfig(t, client, root)
+
+		err := cmd.Execute()
+
+		require.ErrorContains(t, err, `Validation failed for tag "template_display_name"`)
+
+		// Assert that the template metadata did not change.
+		updated, err := client.Template(context.Background(), template.ID)
+		require.NoError(t, err)
+		assert.Equal(t, template.Name, updated.Name)
+		assert.Equal(t, "", template.DisplayName)
+	})
 }
diff --git a/coderd/database/databasefake/databasefake.go b/coderd/database/databasefake/databasefake.go
@@ -1452,6 +1452,7 @@ func (q *fakeQuerier) UpdateTemplateMetaByID(_ context.Context, arg database.Upd
 		}
 		tpl.UpdatedAt = database.Now()
 		tpl.Name = arg.Name
+		tpl.DisplayName = arg.DisplayName
 		tpl.Description = arg.Description
 		tpl.Icon = arg.Icon
 		tpl.MaxTtl = arg.MaxTtl

diff --git a/coderd/database/dump.sql b/coderd/database/dump.sql
diff --git a/coderd/database/migrations/000072_template_display_name.down.sql b/coderd/database/migrations/000072_template_display_name.down.sql
@@ -0,0 +1 @@
+ALTER TABLE templates DROP COLUMN display_name;
diff --git a/coderd/database/migrations/000072_template_display_name.up.sql b/coderd/database/migrations/000072_template_display_name.up.sql
@@ -0,0 +1 @@
+ALTER TABLE templates ADD COLUMN display_name VARCHAR(64) NOT NULL DEFAULT '';
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/templates.sql b/coderd/database/queries/templates.sql
@@ -70,10 +70,11 @@ INSERT INTO
 		created_by,
 		icon,
 		user_acl,
-		group_acl
+		group_acl,
+		display_name
 	)
 VALUES
-	($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, $12, $13, $14) RETURNING *;
+	($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, $12, $13, $14, $15) RETURNING *;
 
 -- name: UpdateTemplateActiveVersionByID :exec
 UPDATE
@@ -102,7 +103,8 @@ SET
 	max_ttl = $4,
 	min_autostart_interval = $5,
 	name = $6,
-	icon = $7
+	icon = $7,
+	display_name = $8
 WHERE
 	id = $1
 RETURNING

diff --git a/coderd/gitauth/config.go b/coderd/gitauth/config.go
@@ -47,7 +47,7 @@ func ConvertConfig(entries []codersdk.GitAuthConfig, accessURL *url.URL) ([]*Con
 			// Default to the type.
 			entry.ID = string(typ)
 		}
-		if valid := httpapi.UsernameValid(entry.ID); valid != nil {
+		if valid := httpapi.NameValid(entry.ID); valid != nil {
 			return nil, xerrors.Errorf("git auth provider %q doesn't have a valid id: %w", entry.ID, valid)
 		}
 

diff --git a/coderd/httpapi/httpapi.go b/coderd/httpapi/httpapi.go
@@ -33,13 +33,14 @@ func init() {
 		}
 		return name
 	})
+
 	nameValidator := func(fl validator.FieldLevel) bool {
 		f := fl.Field().Interface()
 		str, ok := f.(string)
 		if !ok {
 			return false
 		}
-		valid := UsernameValid(str)
+		valid := NameValid(str)
 		return valid == nil
 	}
 	for _, tag := range []string{"username", "template_name", "workspace_name"} {
@@ -48,6 +49,20 @@ func init() {
 			panic(err)
 		}
 	}
+
+	templateDisplayNameValidator := func(fl validator.FieldLevel) bool {
+		f := fl.Field().Interface()
+		str, ok := f.(string)
+		if !ok {
+			return false
+		}
+		valid := TemplateDisplayNameValid(str)
+		return valid == nil
+	}
+	err := validate.RegisterValidation("template_display_name", templateDisplayNameValidator)
+	if err != nil {
+		panic(err)
+	}
 }
 
 // Convenience error functions don't take contexts since their responses are
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		ALTER TABLE templates DROP COLUMN display_name;
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		ALTER TABLE templates ADD COLUMN display_name VARCHAR(64) NOT NULL DEFAULT '';
mafredri marked this conversation as resolved. Show resolved Hide resolved