Add orphanage to CLI

coder · ammario · Sep 6, 2022 · Sep 2, 2022 · Sep 2, 2022 · Sep 2, 2022
commit eba7329219eb1a895259f4a6ed8ac90a82043ad7
diff --git a/cli/delete.go b/cli/delete.go
@@ -12,6 +12,7 @@ import (
 
 // nolint
 func deleteWorkspace() *cobra.Command {
+	var orphan bool
 	cmd := &cobra.Command{
 		Annotations: workspaceCommand,
 		Use:         "delete <workspace>",
@@ -36,9 +37,29 @@ func deleteWorkspace() *cobra.Command {
 			if err != nil {
 				return err
 			}
+
+			var state []byte
+			if orphan {
+				cliui.Warn(cmd.ErrOrStderr(), "Orphaning workspace",
+					"Template edit permission is required to orphan workspaces.",
+				)
+
+				state, err = client.WorkspaceBuildState(cmd.Context(), workspace.LatestBuild.ID)
+				if err != nil {
+					return err
+				}
+
+				state, err = codersdk.OrphanTerraformState(state)
+				if err != nil {
+					return err
+				}
+				fmt.Printf("new state: %s\n", state)
+			}
+
 			before := time.Now()
 			build, err := client.CreateWorkspaceBuild(cmd.Context(), workspace.ID, codersdk.CreateWorkspaceBuildRequest{
-				Transition: codersdk.WorkspaceTransitionDelete,
+				Transition:       codersdk.WorkspaceTransitionDelete,
+				ProvisionerState: state,
 			})
 			if err != nil {
 				return err
@@ -53,6 +74,10 @@ func deleteWorkspace() *cobra.Command {
 			return nil
 		},
 	}
+	cmd.Flags().BoolVar(&orphan, "orphan", false,
+		`Delete workspace without deleting its resources. This can delete a
+workspace in a broken state, but may also lead to unaccounted cloud resources.`,
+	)
 	cliui.AllowSkipPrompt(cmd)
 	return cmd
 }
diff --git a/cli/delete_test.go b/cli/delete_test.go
@@ -43,6 +43,34 @@ func TestDelete(t *testing.T) {
 		<-doneChan
 	})
 
+	t.Run("Orphan", func(t *testing.T) {
+		t.Parallel()
+		client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerD: true})
+		user := coderdtest.CreateFirstUser(t, client)
+		version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, nil)
+		coderdtest.AwaitTemplateVersionJob(t, client, version.ID)
+		template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID)
+		workspace := coderdtest.CreateWorkspace(t, client, user.OrganizationID, template.ID)
+		coderdtest.AwaitWorkspaceBuildJob(t, client, workspace.LatestBuild.ID)
+		cmd, root := clitest.New(t, "delete", workspace.Name, "-y", "--orphan")
+
+		clitest.SetupConfig(t, client, root)
+		doneChan := make(chan struct{})
+		pty := ptytest.New(t)
+		cmd.SetIn(pty.Input())
+		cmd.SetOut(pty.Output())
+		go func() {
+			defer close(doneChan)
+			err := cmd.Execute()
+			// When running with the race detector on, we sometimes get an EOF.
+			if err != nil {
+				assert.ErrorIs(t, err, io.EOF)
+			}
+		}()
+		pty.ExpectMatch("Cleaning Up")
+		<-doneChan
+	})
+
 	t.Run("DifferentUser", func(t *testing.T) {
 		t.Parallel()
 		adminClient := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerD: true})

diff --git a/coderd/workspacebuilds_test.go b/coderd/workspacebuilds_test.go
@@ -165,60 +165,6 @@ func TestWorkspaceBuilds(t *testing.T) {
 		require.NoError(t, err)
 	})
 
-	t.Run("OrphanNotOwner", func(t *testing.T) {
-		t.Parallel()
-		client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerD: true})
-		first := coderdtest.CreateFirstUser(t, client)
-
-		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
-		defer cancel()
-
-		version := coderdtest.CreateTemplateVersion(t, client, first.OrganizationID, nil)
-		template := coderdtest.CreateTemplate(t, client, first.OrganizationID, version.ID)
-		coderdtest.AwaitTemplateVersionJob(t, client, version.ID)
-
-		regularUser := coderdtest.CreateAnotherUser(t, client, first.OrganizationID)
-
-		workspace := coderdtest.CreateWorkspace(t, regularUser, first.OrganizationID, template.ID)
-		coderdtest.AwaitWorkspaceBuildJob(t, regularUser, workspace.LatestBuild.ID)
-
-		_, err := regularUser.CreateWorkspaceBuild(ctx, workspace.ID, codersdk.CreateWorkspaceBuildRequest{
-			TemplateVersionID: workspace.LatestBuild.TemplateVersionID,
-			Transition:        workspace.LatestBuild.Transition,
-			ProvisionerState:  []byte(" "),
-		})
-		require.Error(t, err)
-
-		var cerr *codersdk.Error
-		require.True(t, errors.As(err, &cerr))
-
-		code := cerr.StatusCode()
-		require.Equal(t, http.StatusForbidden, code, "unexpected status %s", http.StatusText(code))
-	})
-
-	t.Run("Orphan", func(t *testing.T) {
-		t.Parallel()
-		client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerD: true})
-		first := coderdtest.CreateFirstUser(t, client)
-
-		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
-		defer cancel()
-
-		version := coderdtest.CreateTemplateVersion(t, client, first.OrganizationID, nil)
-		template := coderdtest.CreateTemplate(t, client, first.OrganizationID, version.ID)
-		coderdtest.AwaitTemplateVersionJob(t, client, version.ID)
-
-		workspace := coderdtest.CreateWorkspace(t, client, first.OrganizationID, template.ID)
-		coderdtest.AwaitWorkspaceBuildJob(t, client, workspace.LatestBuild.ID)
-
-		_, err := client.CreateWorkspaceBuild(ctx, workspace.ID, codersdk.CreateWorkspaceBuildRequest{
-			TemplateVersionID: workspace.LatestBuild.TemplateVersionID,
-			Transition:        workspace.LatestBuild.Transition,
-			ProvisionerState:  []byte(" "),
-		})
-		require.Nil(t, err)
-	})
-
 	t.Run("PaginateNonExistentRow", func(t *testing.T) {
 		t.Parallel()
 		client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerD: true})
@@ -285,6 +231,66 @@ func TestWorkspaceBuilds(t *testing.T) {
 	})
 }
 
+func TestWorkspaceBuilds_CustomState(t *testing.T) {
+	t.Parallel()
+
+	t.Run("Forbidden", func(t *testing.T) {
+		t.Parallel()
+		client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerD: true})
+		first := coderdtest.CreateFirstUser(t, client)
+
+		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
+		defer cancel()
+
+		version := coderdtest.CreateTemplateVersion(t, client, first.OrganizationID, nil)
+		template := coderdtest.CreateTemplate(t, client, first.OrganizationID, version.ID)
+		coderdtest.AwaitTemplateVersionJob(t, client, version.ID)
+
+		regularUser := coderdtest.CreateAnotherUser(t, client, first.OrganizationID)
+
+		workspace := coderdtest.CreateWorkspace(t, regularUser, first.OrganizationID, template.ID)
+		coderdtest.AwaitWorkspaceBuildJob(t, regularUser, workspace.LatestBuild.ID)
+
+		_, err := regularUser.CreateWorkspaceBuild(ctx, workspace.ID, codersdk.CreateWorkspaceBuildRequest{
+			TemplateVersionID: workspace.LatestBuild.TemplateVersionID,
+			Transition:        workspace.LatestBuild.Transition,
+			ProvisionerState:  []byte(" "),
+		})
+		require.Error(t, err)
+
+		var cerr *codersdk.Error
+		require.True(t, errors.As(err, &cerr))
+
+		code := cerr.StatusCode()
+		require.Equal(t, http.StatusForbidden, code, "unexpected status %s", http.StatusText(code))
+	})
+
+	t.Run("Success", func(t *testing.T) {
+		t.Parallel()
+		client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerD: true})
+		first := coderdtest.CreateFirstUser(t, client)
+
+		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
+		defer cancel()
+
+		version := coderdtest.CreateTemplateVersion(t, client, first.OrganizationID, nil)
+		template := coderdtest.CreateTemplate(t, client, first.OrganizationID, version.ID)
+		coderdtest.AwaitTemplateVersionJob(t, client, version.ID)
+
+		workspace := coderdtest.CreateWorkspace(t, client, first.OrganizationID, template.ID)
+		coderdtest.AwaitWorkspaceBuildJob(t, client, workspace.LatestBuild.ID)
+
+		build, err := client.CreateWorkspaceBuild(ctx, workspace.ID, codersdk.CreateWorkspaceBuildRequest{
+			TemplateVersionID: workspace.LatestBuild.TemplateVersionID,
+			Transition:        codersdk.WorkspaceTransitionDelete,
+			ProvisionerState:  []byte(" "),
+		})
+		require.Nil(t, err)
+
+		coderdtest.AwaitWorkspaceBuildJob(t, client, build.ID)
+	})
+}
+
 func TestPatchCancelWorkspaceBuild(t *testing.T) {
 	t.Parallel()
 	client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerD: true})

diff --git a/codersdk/workspaces.go b/codersdk/workspaces.go
@@ -33,6 +33,26 @@ type Workspace struct {
 	LastUsedAt        time.Time      `json:"last_used_at"`
 }
 
+// OrphanTerraformState removes all the resources from the provided Terraform
+// state. When the new state is used, Terraform will operate as if none
+// of the resources in the original state exist.
+func OrphanTerraformState(state []byte) ([]byte, error) {
+	stateMap := make(map[string]interface{})
+	err := json.Unmarshal(state, &stateMap)
+	if err != nil {
+		return nil, err
+	}
+
+	_, ok := stateMap["resources"]
+	if !ok {
+		return nil, xerrors.Errorf("no resources detected, is this terraform state?")
+	}
+
+	stateMap["resources"] = []int{}
+
+	return json.Marshal(stateMap)
+}
+
 // CreateWorkspaceBuildRequest provides options to update the latest workspace build.
 type CreateWorkspaceBuildRequest struct {
 	TemplateVersionID uuid.UUID           `json:"template_version_id,omitempty"`

diff --git a/codersdk/workspaces_test.go b/codersdk/workspaces_test.go
@@ -0,0 +1,41 @@
+package codersdk_test
+
+import (
+	"reflect"
+	"testing"
+
+	"github.com/coder/coder/codersdk"
+)
+
+func TestOrphanTerraformState(t *testing.T) {
+	t.Parallel()
+
+	type args struct {
+		state []byte
+	}
+	tests := []struct {
+		name    string
+		args    args
+		want    []byte
+		wantErr bool
+	}{
+		{"invalid json", args{[]byte("---")}, nil, true},
+		{"no resources", args{[]byte(`{"a":4}`)}, nil, true},
+		{"some resources", args{[]byte(`{"a":4, "resources":[1, 2, 3]}`)}, []byte(`{"a":4,"resources":[]}`), false},
+	}
+	for _, tt := range tests {
+		tt := tt
+		t.Run(tt.name, func(t *testing.T) {
+			t.Parallel()
+
+			got, err := codersdk.OrphanTerraformState(tt.args.state)
+			if (err != nil) != tt.wantErr {
+				t.Errorf("OrphanTerraformState() error = %v, wantErr %v", err, tt.wantErr)
+				return
+			}
+			if !reflect.DeepEqual(got, tt.want) {
+				t.Errorf("OrphanTerraformState() = %s, want %s", got, tt.want)
+			}
+		})
+	}
+}