Enable Destroy (#112)

This pull request adds the capability to destroy resources.

Author: guineveresaenger

pkg/modprovider/server.go

@@ -311,7 +311,7 @@ func (s *server) Delete(
 ) (*emptypb.Empty, error) {
 	switch {
 	case req.GetType() == string(moduleStateTypeToken(s.packageName)):
-		return s.moduleStateHandler.Delete(ctx, req)
+		return s.moduleStateHandler.Delete(ctx, req, s.params.TFModuleSource, s.params.TFModuleVersion)
 	case isChildResourceType(req.GetType()):
 		return s.childHandler.Delete(ctx, req)
 	default:

pkg/modprovider/state.go

@@ -31,6 +31,7 @@ import (
 	pulumirpc "github.com/pulumi/pulumi/sdk/v3/proto/go"
 
 	"github.com/pulumi/pulumi-terraform-module/pkg/property"
+	"github.com/pulumi/pulumi-terraform-module/pkg/tfsandbox"
 )
 
 const (
@@ -201,9 +202,44 @@ func (h *moduleStateHandler) Update(
 
 // Delete does not do anything. This could be reused to trigger deletion support in the future
 func (h *moduleStateHandler) Delete(
-	_ context.Context,
-	_ *pulumirpc.DeleteRequest,
+	ctx context.Context,
+	req *pulumirpc.DeleteRequest,
+	moduleSource TFModuleSource,
+	moduleVersion TFModuleVersion,
 ) (*emptypb.Empty, error) {
+	oldState := moduleState{}
+	oldState.Unmarshal(req.GetProperties())
+
+	tf, err := tfsandbox.NewTofu(ctx)
+	if err != nil {
+		return nil, fmt.Errorf("Sandbox construction failed: %w", err)
+	}
+
+	// For Destroy, Terraform needs the module source and version as specified in the json file, but it doesn't
+	// need the exact name of the moduleComponent resource.
+	// TODO: https://github.com/pulumi/pulumi-terraform-module/issues/118
+	tfName := "platypus"
+	err = tfsandbox.CreateTFFile(tfName, moduleSource, moduleVersion, tf.WorkingDir(), resource.PropertyMap{})
+	if err != nil {
+		return nil, fmt.Errorf("Seed file generation failed: %w", err)
+	}
+
+	err = tf.Init(ctx)
+	if err != nil {
+		return nil, fmt.Errorf("Init failed: %w", err)
+	}
+
+	err = tf.PushState(ctx, oldState.rawState)
+	if err != nil {
+		return nil, fmt.Errorf("PushState failed: %w", err)
+	}
+
+	err = tf.Destroy(ctx)
+	if err != nil {
+		return nil, fmt.Errorf("Delete failed: %w", err)
+	}
+
+	// Send back empty pb if no error.
 	return &emptypb.Empty{}, nil
 }
 

schema-terraform-module-provider.json

@@ -5,9 +5,11 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	"math/rand"
 	"os"
 	"os/exec"
 	"path/filepath"
+	"strconv"
 	"strings"
 	"testing"
 
@@ -305,6 +307,72 @@ func TestAwsLambdaModuleIntegration(t *testing.T) {
 	})
 }
 
+// TODO: Ensure Delete truly deletes from the cloud https://github.com/pulumi/pulumi-terraform-module/issues/119
+
+func TestIntegration(t *testing.T) {
+
+	type testCase struct {
+		name            string // Must be same as project folder in testdata/programs/ts
+		moduleName      string
+		moduleVersion   string
+		moduleNamespace string
+		previewExpect   map[apitype.OpType]int
+		upExpect        map[string]int
+		deleteExpect    map[string]int
+	}
+
+	testcases := []testCase{
+		{
+			name:            "s3bucketmod",
+			moduleName:      "terraform-aws-modules/s3-bucket/aws",
+			moduleVersion:   "4.5.0",
+			moduleNamespace: "bucket",
+			previewExpect: map[apitype.OpType]int{
+				apitype.OpType("create"): 5,
+			},
+			upExpect: map[string]int{
+				"create": 8,
+			},
+			deleteExpect: map[string]int{
+				"delete": 8,
+			},
+		},
+	}
+
+	for _, tc := range testcases {
+		tc := tc
+		localProviderBinPath := ensureCompiledProvider(t)
+		skipLocalRunsWithoutCreds(t)
+		t.Run(tc.name, func(t *testing.T) {
+			testProgram := filepath.Join("testdata", "programs", "ts", tc.name)
+			localPath := opttest.LocalProviderPath("terraform-module", filepath.Dir(localProviderBinPath))
+			integrationTest := pulumitest.NewPulumiTest(t, testProgram, localPath)
+
+			prefix := generateTestResourcePrefix()
+
+			// Get a prefix for resource names
+			integrationTest.SetConfig(t, "prefix", prefix)
+
+			// Generate package
+			pulumiPackageAdd(t, integrationTest, localProviderBinPath, tc.moduleName, tc.moduleVersion, tc.moduleNamespace)
+
+			// Preview
+			previewResult := integrationTest.Preview(t)
+			autogold.Expect(tc.previewExpect).Equal(t, previewResult.ChangeSummary)
+
+			// Up
+			upResult := integrationTest.Up(t)
+			autogold.Expect(&tc.upExpect).Equal(t, upResult.Summary.ResourceChanges)
+
+			// Delete
+			destroyResult := integrationTest.Destroy(t)
+			autogold.Expect(&tc.deleteExpect).Equal(t, destroyResult.Summary.ResourceChanges)
+
+		})
+	}
+
+}
+
 func getRoot(t *testing.T) string {
 	wd, err := os.Getwd()
 	require.NoError(t, err)
@@ -405,3 +473,12 @@ func pulumiPackageAdd(
 	require.NoError(t, err)
 	require.Equal(t, 0, exitCode)
 }
+
+//nolint:gosec
+func generateTestResourcePrefix() string {
+	low := 100000
+	high := 999999
+
+	num := low + rand.Intn(high-low)
+	return strconv.Itoa(num)
+}

tests/acc_test.go

@@ -0,0 +1,5 @@
+name: ts-s3bucketmod-program
+runtime:
+  name: nodejs
+  options:
+    packagemanager: npm

tests/testdata/programs/ts/s3bucketmod/Pulumi.yaml

@@ -0,0 +1,12 @@
+import * as pulumi from "@pulumi/pulumi";
+import * as bucket from "@pulumi/bucket";
+
+
+const config = new pulumi.Config();
+const prefix = config.get('prefix') ?? pulumi.getStack();
+
+const testbucket = new bucket.Module("test-bucket", {
+    bucket: `${prefix}-test-bucket`,
+})
+
+export const bucketARN =  testbucket.s3_bucket_arn

tests/testdata/programs/ts/s3bucketmod/index.ts

@@ -0,0 +1,12 @@
+{
+  "name": "ts-s3bucketmod-program",
+  "main": "index.ts",
+  "devDependencies": {
+    "@types/node": "^18",
+    "typescript": "^5.0.0"
+  },
+  "dependencies": {
+    "@pulumi/aws": "^6.0.0",
+    "@pulumi/pulumi": "^3.113.0"
+  }
+}