add tests

f0ssel · f0ssel · commit 7084cebfff5d · 2022-12-07T19:55:41.000Z
diff --git a/coderd/files.go b/coderd/files.go
@@ -20,7 +20,7 @@ import (
 )
 
 const (
-	uploadFileContentTypeHeader = "application/x-tar"
+	tarMimeType = "application/x-tar"
 )
 
 func (api *API) postFile(rw http.ResponseWriter, r *http.Request) {
@@ -36,7 +36,7 @@ func (api *API) postFile(rw http.ResponseWriter, r *http.Request) {
 	contentType := r.Header.Get("Content-Type")
 
 	switch contentType {
-	case uploadFileContentTypeHeader:
+	case tarMimeType:
 	default:
 		httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
 			Message: fmt.Sprintf("Unsupported content type header %q.", contentType),
diff --git a/coderd/templateversions.go b/coderd/templateversions.go
@@ -883,7 +883,7 @@ func (api *API) postTemplateVersionsByOrganization(rw http.ResponseWriter, r *ht
 			Hash:      hash,
 			CreatedBy: apiKey.UserID,
 			CreatedAt: database.Now(),
-			Mimetype:  uploadFileContentTypeHeader,
+			Mimetype:  tarMimeType,
 			Data:      tar,
 		})
 		if err != nil {
diff --git a/coderd/templateversions_test.go b/coderd/templateversions_test.go
@@ -15,6 +15,7 @@ import (
 	"github.com/coder/coder/coderd/database"
 	"github.com/coder/coder/coderd/provisionerdserver"
 	"github.com/coder/coder/codersdk"
+	"github.com/coder/coder/examples"
 	"github.com/coder/coder/provisioner/echo"
 	"github.com/coder/coder/provisionersdk/proto"
 	"github.com/coder/coder/testutil"
@@ -128,6 +129,31 @@ func TestPostTemplateVersionsByOrganization(t *testing.T) {
 		require.Len(t, auditor.AuditLogs, 1)
 		assert.Equal(t, database.AuditActionCreate, auditor.AuditLogs[0].Action)
 	})
+	t.Run("Example", func(t *testing.T) {
+		t.Parallel()
+		client := coderdtest.New(t, nil)
+		user := coderdtest.CreateFirstUser(t, client)
+
+		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
+		defer cancel()
+
+		ls, err := examples.List()
+		require.NoError(t, err)
+
+		tv, err := client.CreateTemplateVersion(ctx, user.OrganizationID, codersdk.CreateTemplateVersionRequest{
+			Name:          "my-example",
+			StorageMethod: codersdk.ProvisionerStorageMethodFile,
+			ExampleID:     ls[0].ID,
+			Provisioner:   codersdk.ProvisionerTypeEcho,
+		})
+		require.NoError(t, err)
+		fl, ct, err := client.Download(ctx, tv.Job.FileID)
+		require.NoError(t, err)
+		require.Equal(t, "application/x-tar", ct)
+		tar, err := examples.Archive(ls[0].ID)
+		require.NoError(t, err)
+		require.EqualValues(t, tar, fl)
+	})
 }
 
 func TestPatchCancelTemplateVersion(t *testing.T) {
@@ -997,3 +1023,23 @@ func TestPreviousTemplateVersion(t *testing.T) {
 		require.Equal(t, previousVersion.ID, result.ID)
 	})
 }
+
+func TestTemplateExamples(t *testing.T) {
+	t.Parallel()
+	t.Run("OK", 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)
+
+		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
+		defer cancel()
+
+		ex, err := client.TemplateExamples(ctx, user.OrganizationID)
+		require.NoError(t, err)
+		ls, err := examples.List()
+		require.NoError(t, err)
+		require.EqualValues(t, ls, ex)
+	})
+}
diff --git a/codersdk/templates.go b/codersdk/templates.go
@@ -246,3 +246,17 @@ type AgentStatsReportResponse struct {
 	// TxBytes is the number of transmitted bytes.
 	TxBytes int64 `json:"tx_bytes"`
 }
+
+// TemplateExamples lists example templates embedded in coder.
+func (c *Client) TemplateExamples(ctx context.Context, organizationID uuid.UUID) ([]TemplateExample, error) {
+	res, err := c.Request(ctx, http.MethodGet, fmt.Sprintf("/api/v2/organizations/%s/templates/examples", organizationID), nil)
+	if err != nil {
+		return nil, err
+	}
+	defer res.Body.Close()
+	if res.StatusCode != http.StatusOK {
+		return nil, readBodyAsError(res)
+	}
+	var templateExamples []TemplateExample
+	return templateExamples, json.NewDecoder(res.Body).Decode(&templateExamples)
+}

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ import (`
`20`	`20`	`)`
`21`	`21`
`22`	`22`	`const (`
`23`		`- uploadFileContentTypeHeader = "application/x-tar"`
	`23`	`+ tarMimeType = "application/x-tar"`
`24`	`24`	`)`
`25`	`25`
`26`	`26`	`func (api API) postFile(rw http.ResponseWriter, r http.Request) {`
`@@ -36,7 +36,7 @@ func (api API) postFile(rw http.ResponseWriter, r http.Request) {`
`36`	`36`	`contentType := r.Header.Get("Content-Type")`
`37`	`37`
`38`	`38`	`switch contentType {`
`39`		`- case uploadFileContentTypeHeader:`
	`39`	`+ case tarMimeType:`
`40`	`40`	`default:`
`41`	`41`	`httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{`
`42`	`42`	`Message: fmt.Sprintf("Unsupported content type header %q.", contentType),`