feat: Add icon to templates

coder · BrunoQuaresma · Aug 19, 2022 · Aug 18, 2022 · Aug 18, 2022 · Aug 18, 2022
commit c04bc484a338832c4ec4f4a5b094a1d463989ed8
diff --git a/cli/templateedit.go b/cli/templateedit.go
@@ -15,6 +15,7 @@ func templateEdit() *cobra.Command {
 	var (
 		name                 string
 		description          string
+		icon                 string
 		maxTTL               time.Duration
 		minAutostartInterval time.Duration
 	)
@@ -41,6 +42,7 @@ func templateEdit() *cobra.Command {
 			req := codersdk.UpdateTemplateMeta{
 				Name:                       name,
 				Description:                description,
+				Icon:                       icon,
 				MaxTTLMillis:               maxTTL.Milliseconds(),
 				MinAutostartIntervalMillis: minAutostartInterval.Milliseconds(),
 			}
@@ -56,6 +58,7 @@ func templateEdit() *cobra.Command {
 
 	cmd.Flags().StringVarP(&name, "name", "", "", "Edit the template 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")
 	cmd.Flags().DurationVarP(&minAutostartInterval, "min-autostart-interval", "", 0, "Edit the template minimum autostart interval")
 	cliui.AllowSkipPrompt(cmd)

diff --git a/coderd/database/dump.sql b/coderd/database/dump.sql
diff --git a/coderd/database/migrations/000036_template_icon.down.sql b/coderd/database/migrations/000036_template_icon.down.sql
@@ -0,0 +1 @@
+ALTER TABLE templates DROP COLUMN icon;
diff --git a/coderd/database/migrations/000036_template_icon.up.sql b/coderd/database/migrations/000036_template_icon.up.sql
@@ -0,0 +1 @@
+ALTER TABLE templates ADD COLUMN icon VARCHAR(256) 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
@@ -67,10 +67,11 @@ INSERT INTO
 		description,
 		max_ttl,
 		min_autostart_interval,
-		created_by
+		created_by,
+		icon
 	)
 VALUES
-	($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11) RETURNING *;
+	($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, $12) RETURNING *;
 
 -- name: UpdateTemplateActiveVersionByID :exec
 UPDATE
@@ -98,7 +99,8 @@ SET
 	description = $3,
 	max_ttl = $4,
 	min_autostart_interval = $5,
-	name = $6
+	name = $6,
+	icon = $7
 WHERE
 	id = $1
 RETURNING

diff --git a/coderd/templates.go b/coderd/templates.go
@@ -411,6 +411,7 @@ func (api *API) patchTemplateMeta(rw http.ResponseWriter, r *http.Request) {
 
 		if req.Name == template.Name &&
 			req.Description == template.Description &&
+			req.Icon == template.Icon &&
 			req.MaxTTLMillis == time.Duration(template.MaxTtl).Milliseconds() &&
 			req.MinAutostartIntervalMillis == time.Duration(template.MinAutostartInterval).Milliseconds() {
 			return nil
@@ -419,6 +420,7 @@ func (api *API) patchTemplateMeta(rw http.ResponseWriter, r *http.Request) {
 		// Update template metadata -- empty fields are not overwritten.
 		name := req.Name
 		desc := req.Description
+		icon := req.Icon
 		maxTTL := time.Duration(req.MaxTTLMillis) * time.Millisecond
 		minAutostartInterval := time.Duration(req.MinAutostartIntervalMillis) * time.Millisecond
 
@@ -428,6 +430,9 @@ func (api *API) patchTemplateMeta(rw http.ResponseWriter, r *http.Request) {
 		if desc == "" {
 			desc = template.Description
 		}
+		if icon == "" {
+			name = template.Icon
+		}
 		if maxTTL == 0 {
 			maxTTL = time.Duration(template.MaxTtl)
 		}
@@ -440,6 +445,7 @@ func (api *API) patchTemplateMeta(rw http.ResponseWriter, r *http.Request) {
 			UpdatedAt:            database.Now(),
 			Name:                 name,
 			Description:          desc,
+			Icon:                 icon,
 			MaxTtl:               int64(maxTTL),
 			MinAutostartInterval: int64(minAutostartInterval),
 		}); err != nil {
@@ -519,6 +525,7 @@ func convertTemplate(template database.Template, workspaceOwnerCount uint32, cre
 		ActiveVersionID:            template.ActiveVersionID,
 		WorkspaceOwnerCount:        workspaceOwnerCount,
 		Description:                template.Description,
+		Icon:                       template.Icon,
 		MaxTTLMillis:               time.Duration(template.MaxTtl).Milliseconds(),
 		MinAutostartIntervalMillis: time.Duration(template.MinAutostartInterval).Milliseconds(),
 		CreatedByID:                template.CreatedBy,

diff --git a/coderd/templates_test.go b/coderd/templates_test.go
@@ -233,12 +233,14 @@ func TestPatchTemplateMeta(t *testing.T) {
 		version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, nil)
 		template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID, func(ctr *codersdk.CreateTemplateRequest) {
 			ctr.Description = "original description"
+			ctr.Icon = "/icons/original-icon.png"
 			ctr.MaxTTLMillis = ptr.Ref(24 * time.Hour.Milliseconds())
 			ctr.MinAutostartIntervalMillis = ptr.Ref(time.Hour.Milliseconds())
 		})
 		req := codersdk.UpdateTemplateMeta{
 			Name:                       "new-template-name",
 			Description:                "lorem ipsum dolor sit amet et cetera",
+			Icon:                       "/icons/new-icon.png",
 			MaxTTLMillis:               12 * time.Hour.Milliseconds(),
 			MinAutostartIntervalMillis: time.Minute.Milliseconds(),
 		}
@@ -254,6 +256,7 @@ func TestPatchTemplateMeta(t *testing.T) {
 		assert.Greater(t, updated.UpdatedAt, template.UpdatedAt)
 		assert.Equal(t, req.Name, updated.Name)
 		assert.Equal(t, req.Description, updated.Description)
+		assert.Equal(t, req.Icon, updated.Icon)
 		assert.Equal(t, req.MaxTTLMillis, updated.MaxTTLMillis)
 		assert.Equal(t, req.MinAutostartIntervalMillis, updated.MinAutostartIntervalMillis)
 
@@ -263,6 +266,7 @@ func TestPatchTemplateMeta(t *testing.T) {
 		assert.Greater(t, updated.UpdatedAt, template.UpdatedAt)
 		assert.Equal(t, req.Name, updated.Name)
 		assert.Equal(t, req.Description, updated.Description)
+		assert.Equal(t, req.Icon, updated.Icon)
 		assert.Equal(t, req.MaxTTLMillis, updated.MaxTTLMillis)
 		assert.Equal(t, req.MinAutostartIntervalMillis, updated.MinAutostartIntervalMillis)
 	})
@@ -275,6 +279,7 @@ func TestPatchTemplateMeta(t *testing.T) {
 		version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, nil)
 		template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID, func(ctr *codersdk.CreateTemplateRequest) {
 			ctr.Description = "original description"
+			ctr.Icon = "/icons/original-icon.png"
 			ctr.MaxTTLMillis = ptr.Ref(24 * time.Hour.Milliseconds())
 			ctr.MinAutostartIntervalMillis = ptr.Ref(time.Hour.Milliseconds())
 		})
@@ -285,6 +290,7 @@ func TestPatchTemplateMeta(t *testing.T) {
 		req := codersdk.UpdateTemplateMeta{
 			Name:                       template.Name,
 			Description:                template.Description,
+			Icon:                       template.Icon,
 			MaxTTLMillis:               template.MaxTTLMillis,
 			MinAutostartIntervalMillis: template.MinAutostartIntervalMillis,
 		}
@@ -295,6 +301,7 @@ func TestPatchTemplateMeta(t *testing.T) {
 		assert.Equal(t, updated.UpdatedAt, template.UpdatedAt)
 		assert.Equal(t, template.Name, updated.Name)
 		assert.Equal(t, template.Description, updated.Description)
+		assert.Equal(t, template.Icon, updated.Icon)
 		assert.Equal(t, template.MaxTTLMillis, updated.MaxTTLMillis)
 		assert.Equal(t, template.MinAutostartIntervalMillis, updated.MinAutostartIntervalMillis)
 	})
@@ -331,6 +338,7 @@ func TestPatchTemplateMeta(t *testing.T) {
 		assert.WithinDuration(t, template.UpdatedAt, updated.UpdatedAt, time.Minute)
 		assert.Equal(t, template.Name, updated.Name)
 		assert.Equal(t, template.Description, updated.Description)
+		assert.Equal(t, template.Icon, updated.Icon)
 		assert.Equal(t, template.MaxTTLMillis, updated.MaxTTLMillis)
 		assert.Equal(t, template.MinAutostartIntervalMillis, updated.MinAutostartIntervalMillis)
 	})

diff --git a/codersdk/organizations.go b/codersdk/organizations.go
@@ -52,6 +52,9 @@ type CreateTemplateRequest struct {
 	// Description is a description of what the template contains. It must be
 	// less than 128 bytes.
 	Description string `json:"description,omitempty" validate:"lt=128"`
+	// Icon is a relative path or external URL that specifies
+	// an icon to be displayed in the dashboard.
+	Icon string `json:"icon,omitempty"`
 
 	// VersionID is an in-progress or completed job to use as an initial version
 	// of the template.

diff --git a/codersdk/templates.go b/codersdk/templates.go
@@ -23,6 +23,7 @@ type Template struct {
 	ActiveVersionID            uuid.UUID       `json:"active_version_id"`
 	WorkspaceOwnerCount        uint32          `json:"workspace_owner_count"`
 	Description                string          `json:"description"`
+	Icon                       string          `json:"icon"`
 	MaxTTLMillis               int64           `json:"max_ttl_ms"`
 	MinAutostartIntervalMillis int64           `json:"min_autostart_interval_ms"`
 	CreatedByID                uuid.UUID       `json:"created_by_id"`
@@ -36,6 +37,7 @@ type UpdateActiveTemplateVersion struct {
 type UpdateTemplateMeta struct {
 	Name                       string `json:"name,omitempty" validate:"omitempty,username"`
 	Description                string `json:"description,omitempty"`
+	Icon                       string `json:"icon,omitempty"`
 	MaxTTLMillis               int64  `json:"max_ttl_ms,omitempty"`
 	MinAutostartIntervalMillis int64  `json:"min_autostart_interval_ms,omitempty"`
 }
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		ALTER TABLE templates ADD COLUMN icon VARCHAR(256) NOT NULL DEFAULT '';