[dynamic] Support delete on sdkv1 based providers (#2513)

Explicitly set `PlannedState: null` instead of leaving it empty.

As described by
https://github.com/hashicorp/terraform-plugin-framework/blob/ce2519cf40d45d28eebd81776019e68d1bddca6f/internal/fwserver/server_applyresourcechange.go#L63,
PF allows Null (not just nil) values to be used to send a delete. SDKv1
providers *always* attempt to deserialize planned state. This is fine if
it's null, but hits a nil pointer panic when it is nil.

Fixes pulumi/pulumi-terraform-provider#36

Author: iwahbe

dynamic/go.mod

@@ -15,6 +15,7 @@ replace (
 
 require (
 	github.com/blang/semver v3.5.1+incompatible
+	github.com/hashicorp/terraform-plugin-sdk v1.7.0
 	github.com/hexops/autogold/v2 v2.2.1
 	github.com/opentofu/opentofu/shim v0.0.0-00010101000000-000000000000
 	github.com/pulumi/pulumi-terraform-bridge/v3 v3.92.0

dynamic/go.sum

@@ -1,10 +1,44 @@
 package testing
 
-import "testing"
+import (
+	"fmt"
+	"os"
+	"os/exec"
+	"path/filepath"
+	"sync"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
 
 func Integration(t *testing.T) {
 	t.Helper()
 	if testing.Short() {
 		t.Skipf("Skipping integration test during -short")
 	}
 }
+
+func BuildOnce(globalTempDir *string, dir, name string) func(t *testing.T) string {
+	mkBin := sync.OnceValues(func() (string, error) {
+		wd, err := os.Getwd()
+		if err != nil {
+			return "", err
+		}
+
+		out := filepath.Join(*globalTempDir, name)
+		cmd := exec.Command("go", "build", "-o", out, ".")
+		cmd.Dir = filepath.Join(wd, dir)
+		stdoutput, err := cmd.CombinedOutput()
+		if err != nil {
+			return "", fmt.Errorf("failed to build provider: %w:\n%s", err, string(stdoutput))
+		}
+		return out, nil
+	})
+
+	return func(t *testing.T) string {
+		t.Helper()
+		path, err := mkBin()
+		require.NoErrorf(t, err, "failed find provider path")
+		return path
+	}
+}

dynamic/internal/testing/testing.go

@@ -6,11 +6,9 @@ import (
 	"encoding/json"
 	"fmt"
 	"os"
-	"os/exec"
 	"path/filepath"
 	"runtime"
 	"strings"
-	"sync"
 	"testing"
 
 	"github.com/hexops/autogold/v2"
@@ -53,7 +51,7 @@ func TestStacktraceDisplayed(t *testing.T) {
 	skipWindows(t)
 
 	ctx := context.Background()
-	grpc := pfProviderTestServer(ctx, t)
+	grpc := parameterizedTestServer(ctx, t, pfProviderPath)
 
 	_, err := grpc.Create(ctx, &pulumirpc.CreateRequest{
 		Urn: string(resource.NewURN(
@@ -366,30 +364,12 @@ func assertGRPC(t *testing.T, msg proto.Message, v autogold.Value) {
 // pfProviderPath returns the path the the PF provider binary for use in testing.
 //
 // It builds the binary running "go build" once per session.
-var pfProviderPath = func() func(t *testing.T) string {
-	mkBin := sync.OnceValues(func() (string, error) {
-		wd, err := os.Getwd()
-		if err != nil {
-			return "", err
-		}
-
-		out := filepath.Join(globalTempDir, "terraform-provider-pfprovider")
-		cmd := exec.Command("go", "build", "-o", out, "github.com/pulumi/pulumi-terraform-bridge/dynamic/tests/pfprovider")
-		cmd.Dir = filepath.Join(wd, "test", "pfprovider")
-		stdoutput, err := cmd.CombinedOutput()
-		if err != nil {
-			return "", fmt.Errorf("failed to build provider: %w:\n%s", err, string(stdoutput))
-		}
-		return out, nil
-	})
-
-	return func(t *testing.T) string {
-		t.Helper()
-		path, err := mkBin()
-		require.NoErrorf(t, err, "failed find provider path")
-		return path
-	}
-}()
+var (
+	pfProviderPath = helper.BuildOnce(&globalTempDir,
+		"test/pfprovider", "terraform-provider-pfprovider")
+	sdkv1ProviderPath = helper.BuildOnce(&globalTempDir,
+		"test/sdkv1provider", "terraform-provider-sdkv1")
+)
 
 // grpcTestServer returns an unparameterized in-memory gRPC server.
 func grpcTestServer(ctx context.Context, t *testing.T) pulumirpc.ResourceProviderServer {
@@ -400,14 +380,15 @@ func grpcTestServer(ctx context.Context, t *testing.T) pulumirpc.ResourceProvide
 	return s
 }
 
-// pfProviderTestServer returns an in-memory gRPC server already parameterized by the
-// pfprovider test Terraform provider.
-func pfProviderTestServer(ctx context.Context, t *testing.T) pulumirpc.ResourceProviderServer {
+func parameterizedTestServer(
+	ctx context.Context, t *testing.T,
+	pathHelper func(t *testing.T) string,
+) pulumirpc.ResourceProviderServer {
 	grpc := grpcTestServer(ctx, t)
 	t.Run("parameterize", assertGRPCCall(grpc.Parameterize, &pulumirpc.ParameterizeRequest{
 		Parameters: &pulumirpc.ParameterizeRequest_Args{
 			Args: &pulumirpc.ParameterizeRequest_ParametersArgs{
-				Args: []string{pfProviderPath(t)},
+				Args: []string{pathHelper(t)},
 			},
 		},
 	}, noParallel))
@@ -536,6 +517,30 @@ func TestRandomCreate(t *testing.T) {
 	})
 }
 
+func TestSDKv1Provider(t *testing.T) {
+	t.Parallel()
+	helper.Integration(t)
+	skipWindows(t)
+
+	ctx := context.Background()
+
+	server := parameterizedTestServer(ctx, t, sdkv1ProviderPath)
+
+	const typ = "sdkv1:index/res:Res"
+	urn := string(resource.NewURN(
+		"test", "test", "", typ, "res",
+	))
+
+	t.Run("delete", assertGRPCCall(server.Delete, &pulumirpc.DeleteRequest{
+		Id:  "example-id-delete",
+		Urn: urn,
+		Properties: marshal(resource.PropertyMap{
+			"f0": resource.NewProperty("123"),
+			"f1": resource.NewProperty(123.0),
+		}),
+	}))
+}
+
 func must[T any](v T, err error) T {
 	if err != nil {
 		panic(err)

dynamic/provider_test.go

@@ -0,0 +1,37 @@
+package main
+
+import (
+	"github.com/hashicorp/terraform-plugin-sdk/helper/schema"
+	"github.com/hashicorp/terraform-plugin-sdk/plugin"
+	"github.com/hashicorp/terraform-plugin-sdk/terraform"
+)
+
+func Provider() *schema.Provider {
+	return &schema.Provider{
+		ConfigureFunc: func(*schema.ResourceData) (any, error) {
+			return nil, nil
+		},
+		ResourcesMap: map[string]*schema.Resource{
+			"test_res": {
+				Schema: map[string]*schema.Schema{
+					"f0": {Type: schema.TypeString, Required: true},
+					"f1": {Type: schema.TypeInt, Computed: true},
+				},
+				Update: func(*schema.ResourceData, interface{}) error {
+					return nil
+				},
+				Delete: func(*schema.ResourceData, any) error {
+					return nil
+				},
+			},
+		},
+	}
+}
+
+func main() {
+	plugin.Serve(&plugin.ServeOpts{
+		ProviderFunc: func() terraform.ResourceProvider {
+			return Provider()
+		},
+	})
+}

dynamic/test/sdkv1provider/main.go

@@ -0,0 +1 @@
+{}

dynamic/testdata/TestSDKv1Provider/delete.golden

@@ -0,0 +1,4 @@
+{
+  "name": "sdkv1",
+  "version": "0.0.0"
+}

dynamic/testdata/TestSDKv1Provider/parameterize.golden

@@ -20,6 +20,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-go/tfprotov6"
 	"github.com/hashicorp/terraform-plugin-go/tftypes"
 	"github.com/pulumi/pulumi/sdk/v3/go/common/resource"
+	"github.com/pulumi/pulumi/sdk/v3/go/common/util/contract"
 
 	"github.com/pulumi/pulumi-terraform-bridge/v3/pkg/convert"
 )
@@ -52,13 +53,17 @@ func (p *provider) DeleteWithContext(
 		return resource.StatusOK, err
 	}
 
+	plannedState, err := tfprotov6.NewDynamicValue(tfType, tftypes.NewValue(tfType, nil))
+	contract.AssertNoErrorf(err, "nil is always a valid value to marshal to a dynamic state")
+
 	// terraform-plugin-framework recognizes PlannedState=nil ApplyResourceChangeRequest request as DELETE.
 	//
 	//nolint:lll // See
 	// https://github.com/hashicorp/terraform-plugin-framework/blob/ce2519cf40d45d28eebd81776019e68d1bddca6f/internal/fwserver/server_applyresourcechange.go#L63
 	req := tfprotov6.ApplyResourceChangeRequest{
-		TypeName:   rh.terraformResourceName,
-		PriorState: priorState,
+		TypeName:     rh.terraformResourceName,
+		PriorState:   priorState,
+		PlannedState: &plannedState,
 	}
 
 	resp, err := p.tfServer.ApplyResourceChange(ctx, &req)