chore: Add test helpers to improve coverage (#166)

* chore: Rename ProjectHistory to ProjectVersion Version more accurately represents version storage. This forks from the WorkspaceHistory name, but I think it's easier to understand Workspace history. * Rename files * Standardize tests a bit more * Remove Server struct from coderdtest * Improve test coverage for workspace history * Fix linting errors * Fix coderd test leak * Fix coderd test leak * Improve workspace history logs * Standardize test structure for codersdk * Fix linting errors * Fix WebSocket compression * Update coderd/workspaces.go Co-authored-by: Bryan <bryan@coder.com> * Add test for listing project parameters * Cache npm dependencies with setup node * Remove windows npm cache key Co-authored-by: Bryan <bryan@coder.com>
2026-09-24 15:04:27 +08:00 · 2022-02-05 18:24:51 -06:00
parent f19770b2c6
commit 1796dc6c2f
38 changed files with 1466 additions and 1057 deletions
@@ -1,103 +1,129 @@
 package coderd_test

 import (
-	"archive/tar"
-	"bytes"
 	"context"
+	"net/http"
 	"testing"

 	"github.com/stretchr/testify/require"

 	"github.com/coder/coder/coderd"
 	"github.com/coder/coder/coderd/coderdtest"
+	"github.com/coder/coder/codersdk"
 	"github.com/coder/coder/database"
 	"github.com/coder/coder/provisioner/echo"
 	"github.com/coder/coder/provisionersdk/proto"
 )

-func TestProjectVersion(t *testing.T) {
+func TestProjectVersionsByOrganization(t *testing.T) {
 	t.Parallel()
-
-	t.Run("NoHistory", func(t *testing.T) {
+	t.Run("ListEmpty", func(t *testing.T) {
 		t.Parallel()
-		server := coderdtest.New(t)
-		user := server.RandomInitialUser(t)
-		project, err := server.Client.CreateProject(context.Background(), user.Organization, coderd.CreateProjectRequest{
-			Name:        "someproject",
-			Provisioner: database.ProvisionerTypeEcho,
-		})
-		require.NoError(t, err)
-		versions, err := server.Client.ProjectVersions(context.Background(), user.Organization, project.Name)
+		client := coderdtest.New(t)
+		user := coderdtest.CreateInitialUser(t, client)
+		project := coderdtest.CreateProject(t, client, user.Organization)
+		versions, err := client.ProjectVersions(context.Background(), user.Organization, project.Name)
 		require.NoError(t, err)
+		require.NotNil(t, versions)
 		require.Len(t, versions, 0)
 	})

-	t.Run("CreateVersion", func(t *testing.T) {
+	t.Run("List", func(t *testing.T) {
 		t.Parallel()
-		server := coderdtest.New(t)
-		user := server.RandomInitialUser(t)
-		project, err := server.Client.CreateProject(context.Background(), user.Organization, coderd.CreateProjectRequest{
-			Name:        "someproject",
-			Provisioner: database.ProvisionerTypeEcho,
-		})
-		require.NoError(t, err)
-		data, err := echo.Tar([]*proto.Parse_Response{{
-			Type: &proto.Parse_Response_Complete{
-				Complete: &proto.Parse_Complete{},
-			},
-		}}, nil)
-		require.NoError(t, err)
-		version, err := server.Client.CreateProjectVersion(context.Background(), user.Organization, project.Name, coderd.CreateProjectVersionRequest{
-			StorageMethod: database.ProjectStorageMethodInlineArchive,
-			StorageSource: data,
-		})
-		require.NoError(t, err)
-		versions, err := server.Client.ProjectVersions(context.Background(), user.Organization, project.Name)
+		client := coderdtest.New(t)
+		user := coderdtest.CreateInitialUser(t, client)
+		project := coderdtest.CreateProject(t, client, user.Organization)
+		_ = coderdtest.CreateProjectVersion(t, client, user.Organization, project.Name, nil)
+		versions, err := client.ProjectVersions(context.Background(), user.Organization, project.Name)
 		require.NoError(t, err)
 		require.Len(t, versions, 1)
+	})
+}

-		_, err = server.Client.ProjectVersion(context.Background(), user.Organization, project.Name, version.Name)
-		require.NoError(t, err)
+func TestProjectVersionByOrganizationAndName(t *testing.T) {
+	t.Parallel()
+	t.Run("Get", func(t *testing.T) {
+		t.Parallel()
+		client := coderdtest.New(t)
+		user := coderdtest.CreateInitialUser(t, client)
+		project := coderdtest.CreateProject(t, client, user.Organization)
+		version := coderdtest.CreateProjectVersion(t, client, user.Organization, project.Name, nil)
+		require.Equal(t, version.Import.Status, coderd.ProvisionerJobStatusPending)
+	})
+}
+
+func TestPostProjectVersionByOrganization(t *testing.T) {
+	t.Parallel()
+	t.Run("Create", func(t *testing.T) {
+		t.Parallel()
+		client := coderdtest.New(t)
+		user := coderdtest.CreateInitialUser(t, client)
+		project := coderdtest.CreateProject(t, client, user.Organization)
+		_ = coderdtest.CreateProjectVersion(t, client, user.Organization, project.Name, nil)
 	})

-	t.Run("CreateHistoryArchiveTooBig", func(t *testing.T) {
+	t.Run("InvalidStorage", func(t *testing.T) {
 		t.Parallel()
-		server := coderdtest.New(t)
-		user := server.RandomInitialUser(t)
-		project, err := server.Client.CreateProject(context.Background(), user.Organization, coderd.CreateProjectRequest{
-			Name:        "someproject",
-			Provisioner: database.ProvisionerTypeEcho,
-		})
-		require.NoError(t, err)
-		var buffer bytes.Buffer
-		writer := tar.NewWriter(&buffer)
-		err = writer.WriteHeader(&tar.Header{
-			Name: "file",
-			Size: 1 << 21,
-		})
-		require.NoError(t, err)
-		_, err = writer.Write(make([]byte, 1<<21))
-		require.NoError(t, err)
-		_, err = server.Client.CreateProjectVersion(context.Background(), user.Organization, project.Name, coderd.CreateProjectVersionRequest{
-			StorageMethod: database.ProjectStorageMethodInlineArchive,
-			StorageSource: buffer.Bytes(),
-		})
-		require.Error(t, err)
-	})
-
-	t.Run("CreateHistoryInvalidArchive", func(t *testing.T) {
-		t.Parallel()
-		server := coderdtest.New(t)
-		user := server.RandomInitialUser(t)
-		project, err := server.Client.CreateProject(context.Background(), user.Organization, coderd.CreateProjectRequest{
-			Name:        "someproject",
-			Provisioner: database.ProvisionerTypeEcho,
-		})
-		require.NoError(t, err)
-		_, err = server.Client.CreateProjectVersion(context.Background(), user.Organization, project.Name, coderd.CreateProjectVersionRequest{
-			StorageMethod: database.ProjectStorageMethodInlineArchive,
+		client := coderdtest.New(t)
+		user := coderdtest.CreateInitialUser(t, client)
+		project := coderdtest.CreateProject(t, client, user.Organization)
+		_, err := client.CreateProjectVersion(context.Background(), user.Organization, project.Name, coderd.CreateProjectVersionRequest{
+			StorageMethod: database.ProjectStorageMethod("invalid"),
 			StorageSource: []byte{},
 		})
 		require.Error(t, err)
 	})
 }
+
+func TestProjectVersionParametersByOrganizationAndName(t *testing.T) {
+	t.Parallel()
+	t.Run("NotImported", func(t *testing.T) {
+		t.Parallel()
+		client := coderdtest.New(t)
+		user := coderdtest.CreateInitialUser(t, client)
+		project := coderdtest.CreateProject(t, client, user.Organization)
+		version := coderdtest.CreateProjectVersion(t, client, user.Organization, project.Name, nil)
+		_, err := client.ProjectVersionParameters(context.Background(), user.Organization, project.Name, version.Name)
+		var apiErr *codersdk.Error
+		require.ErrorAs(t, err, &apiErr)
+		require.Equal(t, http.StatusPreconditionRequired, apiErr.StatusCode())
+	})
+
+	t.Run("FailedImport", func(t *testing.T) {
+		t.Parallel()
+		client := coderdtest.New(t)
+		user := coderdtest.CreateInitialUser(t, client)
+		_ = coderdtest.NewProvisionerDaemon(t, client)
+		project := coderdtest.CreateProject(t, client, user.Organization)
+		version := coderdtest.CreateProjectVersion(t, client, user.Organization, project.Name, &echo.Responses{
+			Provision: []*proto.Provision_Response{{}},
+		})
+		coderdtest.AwaitProjectVersionImported(t, client, user.Organization, project.Name, version.Name)
+		_, err := client.ProjectVersionParameters(context.Background(), user.Organization, project.Name, version.Name)
+		var apiErr *codersdk.Error
+		require.ErrorAs(t, err, &apiErr)
+		require.Equal(t, http.StatusPreconditionFailed, apiErr.StatusCode())
+	})
+	t.Run("List", func(t *testing.T) {
+		t.Parallel()
+		client := coderdtest.New(t)
+		user := coderdtest.CreateInitialUser(t, client)
+		_ = coderdtest.NewProvisionerDaemon(t, client)
+		project := coderdtest.CreateProject(t, client, user.Organization)
+		version := coderdtest.CreateProjectVersion(t, client, user.Organization, project.Name, &echo.Responses{
+			Parse: []*proto.Parse_Response{{
+				Type: &proto.Parse_Response_Complete{
+					Complete: &proto.Parse_Complete{
+						ParameterSchemas: []*proto.ParameterSchema{{
+							Name: "example",
+						}},
+					},
+				},
+			}},
+		})
+		coderdtest.AwaitProjectVersionImported(t, client, user.Organization, project.Name, version.Name)
+		params, err := client.ProjectVersionParameters(context.Background(), user.Organization, project.Name, version.Name)
+		require.NoError(t, err)
+		require.Len(t, params, 1)
+	})
+}