Allow state upgraders to modify ID

Before this change, Pulumi would correctly run migrations on the resource state if those are specified in the upstream provider. However, in the rare situation where the migrations would intentionally modify the ID field, the bridged provider would ignore this modification. After the change, migrations of the ID field are respected. Fixes #923.
pulumi · Jun 20, 2023 · 38b69f4 · 38b69f4
1 parent 9f35d93
commit 38b69f4
Show file tree

Hide file tree

Showing 2 changed files with 187 additions and 0 deletions.
diff --git a/pkg/tests/regress_923_test.go b/pkg/tests/regress_923_test.go
@@ -0,0 +1,166 @@
+// Copyright 2016-2023, Pulumi Corporation.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package tests
+
+import (
+	"context"
+	"fmt"
+	"strings"
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	testutils "github.com/pulumi/pulumi-terraform-bridge/testing/x"
+	"github.com/pulumi/pulumi-terraform-bridge/v3/pkg/tfbridge"
+	shimv2 "github.com/pulumi/pulumi-terraform-bridge/v3/pkg/tfshim/sdk-v2"
+)
+
+func TestRegress923(t *testing.T) {
+	ctx := context.Background()
+
+	resource := &schema.Resource{
+		Read: func(d *schema.ResourceData, meta interface{}) error {
+			d.Set("name", "webhookname")
+			if strings.Contains(d.Id(), "webhooks") {
+				return fmt.Errorf("ID should not contain 'webhooks'")
+			}
+			return nil
+		},
+		Schema: map[string]*schema.Schema{
+			"name": {
+				Type:     schema.TypeString,
+				Required: true,
+				ForceNew: true,
+			},
+		},
+		SchemaVersion: 1,
+		StateUpgraders: []schema.StateUpgrader{
+			{
+				Version: 0,
+			},
+		},
+	}
+
+	resource.StateUpgraders = []schema.StateUpgrader{
+		{
+			Version: 0,
+			Type:    resource.CoreConfigSchema().ImpliedType(),
+			Upgrade: func(
+				ctx context.Context,
+				rawState map[string]interface{},
+				meta interface{},
+			) (map[string]interface{}, error) {
+				copy := map[string]interface{}{}
+				for k, v := range rawState {
+					if k == "id" {
+						v = strings.ReplaceAll(v.(string), "webhooks", "webHooks")
+					}
+					copy[k] = v
+				}
+				return copy, nil
+			},
+		},
+	}
+
+	tfProvider := &schema.Provider{
+		Schema: map[string]*schema.Schema{},
+		ResourcesMap: map[string]*schema.Resource{
+			"az_webhook": resource,
+		},
+	}
+
+	p := shimv2.NewProvider(tfProvider)
+
+	info := tfbridge.ProviderInfo{
+		P:          p,
+		Name:       "azure",
+		Keywords:   []string{"pulumi", "azure"},
+		License:    "Apache-2.0",
+		Homepage:   "https://pulumi.io",
+		Repository: "https://github.com/pulumi/pulumi-azure",
+		Version:    "0.0.2",
+		Resources: map[string]*tfbridge.ResourceInfo{
+			"az_webhook": {Tok: "azure:containerservice/registryWebhook:RegistryWebhook"},
+		},
+	}
+
+	server := tfbridge.NewProvider(ctx,
+		nil,      /* hostClient */
+		"azure",  /* module */
+		"",       /* version */
+		p,        /* tf */
+		info,     /* info */
+		[]byte{}, /* pulumiSchema */
+	)
+
+	testCase := `
+	{
+	  "method": "/pulumirpc.ResourceProvider/Read",
+	  "request": {
+	    "id": "/subscriptions/0282681f-7a9e-424b-80b2-96babd57a8a1/resourceGroups/example9e974ca4/providers/Microsoft.ContainerRegistry/registries/acr1963930c/webhooks/webhookca218fd",
+	    "urn": "urn:pulumi:dev::bridge-923::azure:containerservice/registryWebhook:RegistryWebhook::webhook",
+	    "properties": {
+	      "__meta": "{\"e2bfb730-ecaa-11e6-8f88-34363bc7c4c0\":{\"create\":1800000000000,\"delete\":1800000000000,\"read\":300000000000,\"update\":1800000000000}}",
+	      "actions": [
+		"push"
+	      ],
+	      "customHeaders": {
+		"Content-Type": "application/json"
+	      },
+	      "id": "/subscriptions/0282681f-7a9e-424b-80b2-96babd57a8a1/resourceGroups/example9e974ca4/providers/Microsoft.ContainerRegistry/registries/acr1963930c/webhooks/webhookca218fd",
+	      "location": "eastus",
+	      "name": "webhookca218fd",
+	      "registryName": "acr1963930c",
+	      "resourceGroupName": "example9e974ca4",
+	      "scope": "mytag:*",
+	      "serviceUri": "https://mywebhookreceiver.example/mytag",
+	      "status": "enabled",
+	      "tags": {}
+	    },
+	    "inputs": {
+	      "__defaults": [
+		"name"
+	      ],
+	      "actions": [
+		"push"
+	      ],
+	      "customHeaders": {
+		"Content-Type": "application/json",
+		"__defaults": []
+	      },
+	      "location": "eastus",
+	      "name": "webhookca218fd",
+	      "registryName": "acr1963930c",
+	      "resourceGroupName": "example9e974ca4",
+	      "scope": "mytag:*",
+	      "serviceUri": "https://mywebhookreceiver.example/mytag",
+	      "status": "enabled"
+	    }
+	  },
+	  "response": {
+            "id": "*",
+            "inputs": {
+              "__defaults": [],
+              "name": "webhookname"
+            },
+            "properties": {
+              "id": "*",
+              "__meta": "*",
+              "name": "webhookname"
+            }
+          }
+	}
+        `
+	testutils.Replay(t, server, testCase)
+}
diff --git a/pkg/tfshim/sdk-v2/upgrade_state.go b/pkg/tfshim/sdk-v2/upgrade_state.go
@@ -5,6 +5,7 @@ import (
 	"fmt"
 	"strconv"
 
+	"github.com/hashicorp/go-cty/cty"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/terraform"
 )
@@ -77,6 +78,12 @@ func upgradeResourceState(p *schema.Provider, res *schema.Resource,
 
 	// Copy the original ID and meta to the new state and stamp in the new version.
 	newState.ID = instanceState.ID
+
+	// If state upgraders have modified the ID, respect that modifeid ID instead.
+	if updatedID, ok := findID(v); ok {
+		newState.ID = updatedID
+	}
+
 	newState.Meta = instanceState.Meta
 	if hasVersion || version > 0 {
 		if newState.Meta == nil {
@@ -86,3 +93,17 @@ func upgradeResourceState(p *schema.Provider, res *schema.Resource,
 	}
 	return newState, nil
 }
+
+func findID(v cty.Value) (string, bool) {
+	if !v.Type().IsObjectType() {
+		return "", false
+	}
+	id, ok := v.AsValueMap()["id"]
+	if !ok {
+		return "", false
+	}
+	if !id.Type().Equals(cty.String) {
+		return "", false
+	}
+	return id.AsString(), true
+}