feat: add template description (#1489)

coadler · web-flow · commit e925818526de · 2022-05-16T20:56:11.000Z
diff --git a/coderd/audit/table.go b/coderd/audit/table.go
@@ -69,6 +69,7 @@ var AuditableResources = auditMap(map[any]map[string]Action{
 		"name":              ActionTrack,
 		"provisioner":       ActionTrack,
 		"active_version_id": ActionTrack,
+		"description":       ActionTrack,
 	},
 	&database.TemplateVersion{}: {
 		"id":              ActionTrack,
diff --git a/coderd/coderd.go b/coderd/coderd.go
@@ -144,7 +144,7 @@ func New(options *Options) (http.Handler, func()) {
 			r.Get("/provisionerdaemons", api.provisionerDaemonsByOrganization)
 			r.Post("/templateversions", api.postTemplateVersionsByOrganization)
 			r.Route("/templates", func(r chi.Router) {
-				r.Post("/", api.postTemplatesByOrganization)
+				r.Post("/", api.postTemplateByOrganization)
 				r.Get("/", api.templatesByOrganization)
 				r.Get("/{templatename}", api.templateByOrganizationAndName)
 			})
diff --git a/coderd/coderdtest/coderdtest.go b/coderd/coderdtest/coderdtest.go
@@ -291,8 +291,9 @@ func CreateTemplateVersion(t *testing.T, client *codersdk.Client, organizationID
 // compatibility with testing. The name assigned is randomly generated.
 func CreateTemplate(t *testing.T, client *codersdk.Client, organization uuid.UUID, version uuid.UUID) codersdk.Template {
 	template, err := client.CreateTemplate(context.Background(), organization, codersdk.CreateTemplateRequest{
-		Name:      randomUsername(),
-		VersionID: version,
+		Name:        randomUsername(),
+		Description: randomUsername(),
+		VersionID:   version,
 	})
 	require.NoError(t, err)
 	return template
diff --git a/coderd/database/databasefake/databasefake.go b/coderd/database/databasefake/databasefake.go
@@ -1171,6 +1171,7 @@ func (q *fakeQuerier) InsertTemplate(_ context.Context, arg database.InsertTempl
 		Name:            arg.Name,
 		Provisioner:     arg.Provisioner,
 		ActiveVersionID: arg.ActiveVersionID,
+		Description:     arg.Description,
 	}
 	q.templates = append(q.templates, template)
 	return template, nil
diff --git a/coderd/database/dump.sql b/coderd/database/dump.sql
diff --git a/coderd/database/migrations/000011_template_description.down.sql b/coderd/database/migrations/000011_template_description.down.sql
@@ -0,0 +1 @@
+ALTER TABLE templates DROP COLUMN description;
diff --git a/coderd/database/migrations/000011_template_description.up.sql b/coderd/database/migrations/000011_template_description.up.sql
@@ -0,0 +1 @@
+ALTER TABLE templates ADD COLUMN description VARCHAR(128) 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
@@ -46,10 +46,11 @@ INSERT INTO
 		organization_id,
 		"name",
 		provisioner,
-		active_version_id
+		active_version_id,
+		description
 	)
 VALUES
-	($1, $2, $3, $4, $5, $6, $7) RETURNING *;
+	($1, $2, $3, $4, $5, $6, $7, $8) RETURNING *;
 
 -- name: UpdateTemplateActiveVersionByID :exec
 UPDATE
diff --git a/coderd/templates.go b/coderd/templates.go
@@ -75,7 +75,7 @@ func (api *api) deleteTemplate(rw http.ResponseWriter, r *http.Request) {
 }
 
 // Create a new template in an organization.
-func (api *api) postTemplatesByOrganization(rw http.ResponseWriter, r *http.Request) {
+func (api *api) postTemplateByOrganization(rw http.ResponseWriter, r *http.Request) {
 	var createTemplate codersdk.CreateTemplateRequest
 	if !httpapi.Read(rw, r, &createTemplate) {
 		return
@@ -90,7 +90,7 @@ func (api *api) postTemplatesByOrganization(rw http.ResponseWriter, r *http.Requ
 			Message: fmt.Sprintf("template %q already exists", createTemplate.Name),
 			Errors: []httpapi.Error{{
 				Field:  "name",
-				Detail: "this value is already in use and should be unique",
+				Detail: "This value is already in use and should be unique.",
 			}},
 		})
 		return
@@ -133,6 +133,7 @@ func (api *api) postTemplatesByOrganization(rw http.ResponseWriter, r *http.Requ
 			Name:            createTemplate.Name,
 			Provisioner:     importJob.Provisioner,
 			ActiveVersionID: templateVersion.ID,
+			Description:     createTemplate.Description,
 		})
 		if err != nil {
 			return xerrors.Errorf("insert template: %s", err)
@@ -280,5 +281,6 @@ func convertTemplate(template database.Template, workspaceOwnerCount uint32) cod
 		Provisioner:         template.Provisioner,
 		ActiveVersionID:     template.ActiveVersionID,
 		WorkspaceOwnerCount: workspaceOwnerCount,
+		Description:         template.Description,
 	}
 }
diff --git a/coderd/templates_test.go b/coderd/templates_test.go
@@ -6,6 +6,7 @@ import (
 	"testing"
 
 	"github.com/google/uuid"
+	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
 	"github.com/coder/coder/coderd/coderdtest"
@@ -26,14 +27,21 @@ func TestTemplate(t *testing.T) {
 	})
 }
 
-func TestPostTemplatesByOrganization(t *testing.T) {
+func TestPostTemplateByOrganization(t *testing.T) {
 	t.Parallel()
 	t.Run("Create", func(t *testing.T) {
 		t.Parallel()
 		client := coderdtest.New(t, nil)
 		user := coderdtest.CreateFirstUser(t, client)
 		version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, nil)
-		_ = coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID)
+
+		expected := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID)
+
+		got, err := client.Template(context.Background(), expected.ID)
+		require.NoError(t, err)
+
+		assert.Equal(t, expected.Name, got.Name)
+		assert.Equal(t, expected.Description, got.Description)
 	})
 
 	t.Run("AlreadyExists", func(t *testing.T) {
diff --git a/codersdk/organizations.go b/codersdk/organizations.go
@@ -36,14 +36,18 @@ type CreateTemplateVersionRequest struct {
 
 // CreateTemplateRequest provides options when creating a template.
 type CreateTemplateRequest struct {
+	// Name is the name of the template.
 	Name string `json:"name" validate:"username,required"`
+	// Description is a description of what the template contains. It must be
+	// less than 128 bytes.
+	Description string `json:"description,omitempty" validate:"lt=128"`
 
-	// VersionID is an in-progress or completed job to use as
-	// an initial version of the template.
+	// VersionID is an in-progress or completed job to use as an initial version
+	// of the template.
 	//
 	// This is required on creation to enable a user-flow of validating a
-	// template works. There is no reason the data-model cannot support
-	// empty templates, but it doesn't make sense for users.
+	// template works. There is no reason the data-model cannot support empty
+	// templates, but it doesn't make sense for users.
 	VersionID       uuid.UUID                `json:"template_version_id" validate:"required"`
 	ParameterValues []CreateParameterRequest `json:"parameter_values,omitempty"`
 }
diff --git a/codersdk/templates.go b/codersdk/templates.go
@@ -23,6 +23,7 @@ type Template struct {
 	Provisioner         database.ProvisionerType `json:"provisioner"`
 	ActiveVersionID     uuid.UUID                `json:"active_version_id"`
 	WorkspaceOwnerCount uint32                   `json:"workspace_owner_count"`
+	Description         string                   `json:"description"`
 }
 
 type UpdateActiveTemplateVersion struct {
diff --git a/site/src/api/typesGenerated.ts b/site/src/api/typesGenerated.ts
@@ -62,6 +62,7 @@ export interface CreateParameterRequest {
 // From codersdk/organizations.go:38:6
 export interface CreateTemplateRequest {
   readonly name: string
+  readonly description?: string
   readonly template_version_id: string
   readonly parameter_values?: CreateParameterRequest[]
 }
@@ -94,7 +95,7 @@ export interface CreateWorkspaceBuildRequest {
   readonly state?: string
 }
 
-// From codersdk/organizations.go:52:6
+// From codersdk/organizations.go:56:6
 export interface CreateWorkspaceRequest {
   readonly template_id: string
   readonly name: string
@@ -219,6 +220,7 @@ export interface Template {
   readonly provisioner: string
   readonly active_version_id: string
   readonly workspace_owner_count: number
+  readonly description: string
 }
 
 // From codersdk/templateversions.go:17:6
@@ -263,12 +265,12 @@ export interface TemplateVersionParameterSchema {
   readonly validation_value_type: string
 }
 
-// From codersdk/templates.go:74:6
+// From codersdk/templates.go:75:6
 export interface TemplateVersionsByTemplateRequest extends Pagination {
   readonly template_id: string
 }
 
-// From codersdk/templates.go:28:6
+// From codersdk/templates.go:29:6
 export interface UpdateActiveTemplateVersion {
   readonly id: string
 }
diff --git a/site/src/testHelpers/entities.ts b/site/src/testHelpers/entities.ts
@@ -87,6 +87,7 @@ export const MockTemplate: TypesGen.Template = {
   provisioner: MockProvisioner.id,
   active_version_id: "",
   workspace_owner_count: 1,
+  description: "This is a test description.",
 }
 
 export const MockWorkspaceAutostartDisabled: TypesGen.UpdateWorkspaceAutostartRequest = {

Original file line number	Diff line number	Diff line change
`@@ -1171,6 +1171,7 @@ func (q *fakeQuerier) InsertTemplate(_ context.Context, arg database.InsertTempl`
`1171`	`1171`	`Name: arg.Name,`
`1172`	`1172`	`Provisioner: arg.Provisioner,`
`1173`	`1173`	`ActiveVersionID: arg.ActiveVersionID,`
	`1174`	`+ Description: arg.Description,`
`1174`	`1175`	`}`
`1175`	`1176`	`q.templates = append(q.templates, template)`
`1176`	`1177`	`return template, nil`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+ALTER TABLE templates DROP COLUMN description;`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+ALTER TABLE templates ADD COLUMN description VARCHAR(128) NOT NULL DEFAULT '';`