feat: Add dry run for provisioners (#178)

* refactor: Rename ProjectParameter to ProjectVersionParameter This was confusing with ParameterValue before. It still is a bit, but this should help distinguish scope. * Add project version resources table * Allow project parameters to optionally have user and workspace * Add dry run for provisioners * Add resource detection on project import
coder · Feb 8, 2022 · 795bba2 · 795bba2
1 parent 427fdc6
commit 795bba2
Show file tree

Hide file tree

Showing 20 changed files with 756 additions and 317 deletions.
diff --git a/coderd/coderdtest/coderdtest_test.go b/coderd/coderdtest/coderdtest_test.go
@@ -28,7 +28,7 @@ func TestNew(t *testing.T) {
 	workspace := coderdtest.CreateWorkspace(t, client, "me", project.ID)
 	history, err := client.CreateWorkspaceHistory(context.Background(), "me", workspace.Name, coderd.CreateWorkspaceHistoryRequest{
 		ProjectVersionID: version.ID,
-		Transition:       database.WorkspaceTransitionCreate,
+		Transition:       database.WorkspaceTransitionStart,
 	})
 	require.NoError(t, err)
 	coderdtest.AwaitWorkspaceHistoryProvisioned(t, client, "me", workspace.Name, history.Name)

diff --git a/coderd/projectparameter/projectparameter.go b/coderd/projectparameter/projectparameter.go
@@ -15,12 +15,11 @@ import (
 
 // Scope targets identifiers to pull parameters from.
 type Scope struct {
-	OrganizationID     string
-	ProjectID          uuid.UUID
-	ProjectVersionID   uuid.UUID
-	UserID             string
-	WorkspaceID        uuid.UUID
-	WorkspaceHistoryID uuid.UUID
+	OrganizationID   string
+	ProjectID        uuid.UUID
+	ProjectVersionID uuid.UUID
+	UserID           sql.NullString
+	WorkspaceID      uuid.NullUUID
 }
 
 // Value represents a computed parameter.
@@ -106,22 +105,26 @@ func Compute(ctx context.Context, db database.Store, scope Scope) ([]Value, erro
 		return nil, err
 	}
 
-	// User parameters come fourth!
-	err = compute.inject(ctx, database.GetParameterValuesByScopeParams{
-		Scope:   database.ParameterScopeUser,
-		ScopeID: scope.UserID,
-	})
-	if err != nil {
-		return nil, err
+	if scope.UserID.Valid {
+		// User parameters come fourth!
+		err = compute.inject(ctx, database.GetParameterValuesByScopeParams{
+			Scope:   database.ParameterScopeUser,
+			ScopeID: scope.UserID.String,
+		})
+		if err != nil {
+			return nil, err
+		}
 	}
 
-	// Workspace parameters come last!
-	err = compute.inject(ctx, database.GetParameterValuesByScopeParams{
-		Scope:   database.ParameterScopeWorkspace,
-		ScopeID: scope.WorkspaceID.String(),
-	})
-	if err != nil {
-		return nil, err
+	if scope.WorkspaceID.Valid {
+		// Workspace parameters come last!
+		err = compute.inject(ctx, database.GetParameterValuesByScopeParams{
+			Scope:   database.ParameterScopeWorkspace,
+			ScopeID: scope.WorkspaceID.UUID.String(),
+		})
+		if err != nil {
+			return nil, err
+		}
 	}
 
 	for _, projectVersionParameter := range compute.projectVersionParametersByName {

diff --git a/coderd/projectparameter/projectparameter_test.go b/coderd/projectparameter/projectparameter_test.go
@@ -22,7 +22,14 @@ func TestCompute(t *testing.T) {
 			OrganizationID:   uuid.New().String(),
 			ProjectID:        uuid.New(),
 			ProjectVersionID: uuid.New(),
-			UserID:           uuid.NewString(),
+			WorkspaceID: uuid.NullUUID{
+				UUID:  uuid.New(),
+				Valid: true,
+			},
+			UserID: sql.NullString{
+				String: uuid.NewString(),
+				Valid:  true,
+			},
 		}
 	}
 	type projectParameterOptions struct {
@@ -163,7 +170,7 @@ func TestCompute(t *testing.T) {
 			ID:                uuid.New(),
 			Name:              parameter.Name,
 			Scope:             database.ParameterScopeWorkspace,
-			ScopeID:           scope.WorkspaceID.String(),
+			ScopeID:           scope.WorkspaceID.UUID.String(),
 			SourceScheme:      database.ParameterSourceSchemeData,
 			SourceValue:       "nop",
 			DestinationScheme: database.ParameterDestinationSchemeEnvironmentVariable,
@@ -189,7 +196,7 @@ func TestCompute(t *testing.T) {
 			ID:                uuid.New(),
 			Name:              parameter.Name,
 			Scope:             database.ParameterScopeWorkspace,
-			ScopeID:           scope.WorkspaceID.String(),
+			ScopeID:           scope.WorkspaceID.UUID.String(),
 			SourceScheme:      database.ParameterSourceSchemeData,
 			SourceValue:       "nop",
 			DestinationScheme: database.ParameterDestinationSchemeEnvironmentVariable,

diff --git a/coderd/projectversion_test.go b/coderd/projectversion_test.go
@@ -120,6 +120,7 @@ func TestProjectVersionParametersByOrganizationAndName(t *testing.T) {
 					},
 				},
 			}},
+			Provision: echo.ProvisionComplete,
 		})
 		coderdtest.AwaitProjectVersionImported(t, client, user.Organization, project.Name, version.Name)
 		params, err := client.ProjectVersionParameters(context.Background(), user.Organization, project.Name, version.Name)

diff --git a/coderd/provisionerdaemons.go b/coderd/provisionerdaemons.go
@@ -207,12 +207,17 @@ func (server *provisionerdServer) AcquireJob(ctx context.Context, _ *proto.Empty
 
 		// Compute parameters for the workspace to consume.
 		parameters, err := projectparameter.Compute(ctx, server.Database, projectparameter.Scope{
-			OrganizationID:     organization.ID,
-			ProjectID:          project.ID,
-			ProjectVersionID:   projectVersion.ID,
-			UserID:             user.ID,
-			WorkspaceID:        workspace.ID,
-			WorkspaceHistoryID: workspaceHistory.ID,
+			OrganizationID:   organization.ID,
+			ProjectID:        project.ID,
+			ProjectVersionID: projectVersion.ID,
+			UserID: sql.NullString{
+				String: user.ID,
+				Valid:  true,
+			},
+			WorkspaceID: uuid.NullUUID{
+				UUID:  workspace.ID,
+				Valid: true,
+			},
 		})
 		if err != nil {
 			return nil, failJob(fmt.Sprintf("compute parameters: %s", err))

diff --git a/coderd/provisionerjoblogs_test.go b/coderd/provisionerjoblogs_test.go
@@ -41,7 +41,7 @@ func TestProvisionerJobLogsByName(t *testing.T) {
 		workspace := coderdtest.CreateWorkspace(t, client, "me", project.ID)
 		history, err := client.CreateWorkspaceHistory(context.Background(), "", workspace.Name, coderd.CreateWorkspaceHistoryRequest{
 			ProjectVersionID: version.ID,
-			Transition:       database.WorkspaceTransitionCreate,
+			Transition:       database.WorkspaceTransitionStart,
 		})
 		require.NoError(t, err)
 		coderdtest.AwaitWorkspaceHistoryProvisioned(t, client, "", workspace.Name, history.Name)
@@ -79,7 +79,7 @@ func TestProvisionerJobLogsByName(t *testing.T) {
 		before := time.Now().UTC()
 		history, err := client.CreateWorkspaceHistory(context.Background(), "", workspace.Name, coderd.CreateWorkspaceHistoryRequest{
 			ProjectVersionID: version.ID,
-			Transition:       database.WorkspaceTransitionCreate,
+			Transition:       database.WorkspaceTransitionStart,
 		})
 		require.NoError(t, err)
 		coderdtest.AwaitWorkspaceHistoryProvisioned(t, client, "", workspace.Name, history.Name)
@@ -120,7 +120,7 @@ func TestProvisionerJobLogsByName(t *testing.T) {
 		before := database.Now()
 		history, err := client.CreateWorkspaceHistory(context.Background(), "", workspace.Name, coderd.CreateWorkspaceHistoryRequest{
 			ProjectVersionID: version.ID,
-			Transition:       database.WorkspaceTransitionCreate,
+			Transition:       database.WorkspaceTransitionStart,
 		})
 		require.NoError(t, err)
 		logs, err := client.FollowProvisionerJobLogsAfter(context.Background(), history.Provision.ID, before)

diff --git a/coderd/workspacehistory_test.go b/coderd/workspacehistory_test.go
@@ -26,7 +26,7 @@ func TestPostWorkspaceHistoryByUser(t *testing.T) {
 		workspace := coderdtest.CreateWorkspace(t, client, "me", project.ID)
 		_, err := client.CreateWorkspaceHistory(context.Background(), "", workspace.Name, coderd.CreateWorkspaceHistoryRequest{
 			ProjectVersionID: uuid.New(),
-			Transition:       database.WorkspaceTransitionCreate,
+			Transition:       database.WorkspaceTransitionStart,
 		})
 		require.Error(t, err)
 		var apiErr *codersdk.Error
@@ -47,7 +47,7 @@ func TestPostWorkspaceHistoryByUser(t *testing.T) {
 		workspace := coderdtest.CreateWorkspace(t, client, "me", project.ID)
 		_, err := client.CreateWorkspaceHistory(context.Background(), "", workspace.Name, coderd.CreateWorkspaceHistoryRequest{
 			ProjectVersionID: version.ID,
-			Transition:       database.WorkspaceTransitionCreate,
+			Transition:       database.WorkspaceTransitionStart,
 		})
 		require.Error(t, err)
 		var apiErr *codersdk.Error
@@ -68,12 +68,12 @@ func TestPostWorkspaceHistoryByUser(t *testing.T) {
 		workspace := coderdtest.CreateWorkspace(t, client, "me", project.ID)
 		_, err := client.CreateWorkspaceHistory(context.Background(), "", workspace.Name, coderd.CreateWorkspaceHistoryRequest{
 			ProjectVersionID: version.ID,
-			Transition:       database.WorkspaceTransitionCreate,
+			Transition:       database.WorkspaceTransitionStart,
 		})
 		require.NoError(t, err)
 		_, err = client.CreateWorkspaceHistory(context.Background(), "", workspace.Name, coderd.CreateWorkspaceHistoryRequest{
 			ProjectVersionID: version.ID,
-			Transition:       database.WorkspaceTransitionCreate,
+			Transition:       database.WorkspaceTransitionStart,
 		})
 		require.Error(t, err)
 		var apiErr *codersdk.Error
@@ -92,13 +92,13 @@ func TestPostWorkspaceHistoryByUser(t *testing.T) {
 		workspace := coderdtest.CreateWorkspace(t, client, "me", project.ID)
 		firstHistory, err := client.CreateWorkspaceHistory(context.Background(), "", workspace.Name, coderd.CreateWorkspaceHistoryRequest{
 			ProjectVersionID: version.ID,
-			Transition:       database.WorkspaceTransitionCreate,
+			Transition:       database.WorkspaceTransitionStart,
 		})
 		require.NoError(t, err)
 		coderdtest.AwaitWorkspaceHistoryProvisioned(t, client, "me", workspace.Name, firstHistory.Name)
 		secondHistory, err := client.CreateWorkspaceHistory(context.Background(), "", workspace.Name, coderd.CreateWorkspaceHistoryRequest{
 			ProjectVersionID: version.ID,
-			Transition:       database.WorkspaceTransitionCreate,
+			Transition:       database.WorkspaceTransitionStart,
 		})
 		require.NoError(t, err)
 		require.Equal(t, firstHistory.ID.String(), secondHistory.BeforeID.String())
@@ -135,7 +135,7 @@ func TestWorkspaceHistoryByUser(t *testing.T) {
 		workspace := coderdtest.CreateWorkspace(t, client, "me", project.ID)
 		_, err := client.CreateWorkspaceHistory(context.Background(), "", workspace.Name, coderd.CreateWorkspaceHistoryRequest{
 			ProjectVersionID: version.ID,
-			Transition:       database.WorkspaceTransitionCreate,
+			Transition:       database.WorkspaceTransitionStart,
 		})
 		require.NoError(t, err)
 		history, err := client.ListWorkspaceHistory(context.Background(), "me", workspace.Name)
@@ -156,7 +156,7 @@ func TestWorkspaceHistoryByName(t *testing.T) {
 	workspace := coderdtest.CreateWorkspace(t, client, "me", project.ID)
 	history, err := client.CreateWorkspaceHistory(context.Background(), "", workspace.Name, coderd.CreateWorkspaceHistoryRequest{
 		ProjectVersionID: version.ID,
-		Transition:       database.WorkspaceTransitionCreate,
+		Transition:       database.WorkspaceTransitionStart,
 	})
 	require.NoError(t, err)
 	_, err = client.WorkspaceHistory(context.Background(), "me", workspace.Name, history.Name)

diff --git a/codersdk/provisioners_test.go b/codersdk/provisioners_test.go
@@ -70,7 +70,7 @@ func TestProvisionerJobLogs(t *testing.T) {
 		workspace := coderdtest.CreateWorkspace(t, client, "", project.ID)
 		history, err := client.CreateWorkspaceHistory(context.Background(), "", workspace.Name, coderd.CreateWorkspaceHistoryRequest{
 			ProjectVersionID: version.ID,
-			Transition:       database.WorkspaceTransitionCreate,
+			Transition:       database.WorkspaceTransitionStart,
 		})
 		require.NoError(t, err)
 		_, err = client.ProvisionerJobLogs(context.Background(), history.Provision.ID)
@@ -112,7 +112,7 @@ func TestFollowProvisionerJobLogsAfter(t *testing.T) {
 		after := database.Now()
 		history, err := client.CreateWorkspaceHistory(context.Background(), "", workspace.Name, coderd.CreateWorkspaceHistoryRequest{
 			ProjectVersionID: version.ID,
-			Transition:       database.WorkspaceTransitionCreate,
+			Transition:       database.WorkspaceTransitionStart,
 		})
 		require.NoError(t, err)
 		logs, err := client.FollowProvisionerJobLogsAfter(context.Background(), history.Provision.ID, after)

diff --git a/codersdk/workspaces_test.go b/codersdk/workspaces_test.go
@@ -108,7 +108,7 @@ func TestWorkspaceHistory(t *testing.T) {
 		workspace := coderdtest.CreateWorkspace(t, client, "", project.ID)
 		_, err := client.CreateWorkspaceHistory(context.Background(), "", workspace.Name, coderd.CreateWorkspaceHistoryRequest{
 			ProjectVersionID: version.ID,
-			Transition:       database.WorkspaceTransitionCreate,
+			Transition:       database.WorkspaceTransitionStart,
 		})
 		require.NoError(t, err)
 	})
@@ -152,7 +152,7 @@ func TestCreateWorkspaceHistory(t *testing.T) {
 		workspace := coderdtest.CreateWorkspace(t, client, "", project.ID)
 		_, err := client.CreateWorkspaceHistory(context.Background(), "", workspace.Name, coderd.CreateWorkspaceHistoryRequest{
 			ProjectVersionID: version.ID,
-			Transition:       database.WorkspaceTransitionCreate,
+			Transition:       database.WorkspaceTransitionStart,
 		})
 		require.NoError(t, err)
 	})

diff --git a/database/dump.sql b/database/dump.sql
diff --git a/database/migrations/000003_workspaces.up.sql b/database/migrations/000003_workspaces.up.sql
@@ -9,7 +9,6 @@ CREATE TABLE workspace (
 );
 
 CREATE TYPE workspace_transition AS ENUM (
-    'create',
     'start',
     'stop',
     'delete'
@@ -50,8 +49,7 @@ CREATE TABLE workspace_resource (
     -- If an agent has been conencted for this resource,
     -- the agent table is not null.
     workspace_agent_id uuid,
-
-    UNIQUE(workspace_history_id, name)
+    UNIQUE(workspace_history_id, type, name)
 );
 
 CREATE TABLE workspace_agent (

diff --git a/database/models.go b/database/models.go