Convert resourceGithubRepositoryWebhook and resourceGithubOrganizationWebhook schema migrations to use StateUpgraders

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Author: deiga

github/migrate_github_organization_webhook.go

@@ -0,0 +1,70 @@
+package github
+
+import (
+	"context"
+	"log"
+	"strings"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+)
+
+func resourceGithubOrganizationWebhookResourceV0() *schema.Resource {
+	return &schema.Resource{
+		Schema: map[string]*schema.Schema{
+			"name": {
+				Type:     schema.TypeString,
+				Required: true,
+				ForceNew: true,
+			},
+			"events": {
+				Type:     schema.TypeSet,
+				Required: true,
+				Elem:     &schema.Schema{Type: schema.TypeString},
+				Set:      schema.HashString,
+			},
+			"configuration": {
+				Type:     schema.TypeMap,
+				Optional: true,
+			},
+			"url": {
+				Type:     schema.TypeString,
+				Computed: true,
+			},
+			"active": {
+				Type:     schema.TypeBool,
+				Optional: true,
+				Default:  true,
+			},
+		},
+	}
+}
+
+func resourceGithubOrganizationWebhookInstanceStateUpgradeV0(ctx context.Context, rawState map[string]any, meta any) (map[string]any, error) {
+	log.Printf("[DEBUG] GitHub Organization Webhook State before migration: %#v", rawState)
+
+	prefix := "configuration."
+	delete(rawState, prefix+"%")
+
+	// Read & delete old keys
+	oldKeys := make(map[string]any)
+	for k, v := range rawState {
+		if strings.HasPrefix(k, prefix) {
+			oldKeys[k] = v
+
+			// Delete old keys
+			delete(rawState, k)
+		}
+	}
+
+	// Write new keys
+	for k, v := range oldKeys {
+		newKey := "configuration.0." + strings.TrimPrefix(k, prefix)
+		rawState[newKey] = v
+	}
+
+	rawState[prefix+"#"] = "1"
+
+	log.Printf("[DEBUG] GitHub Organization Webhook State after migration: %#v", rawState)
+
+	return rawState, nil
+}

github/migrate_github_organization_webhook_test.go

@@ -0,0 +1,20 @@
+package github
+
+import (
+	"reflect"
+	"testing"
+)
+
+func TestGithub_MigrateOrganizationWebhookStateV0toV1(t *testing.T) {
+	t.Run("migrates state without errors", func(t *testing.T) {
+		expected := testResourceGithubWebhookInstanceStateDataV1()
+		actual, err := resourceGithubOrganizationWebhookInstanceStateUpgradeV0(t.Context(), testResourceGithubWebhookInstanceStateDataV0(), nil)
+		if err != nil {
+			t.Fatalf("error migrating state: %s", err)
+		}
+
+		if !reflect.DeepEqual(expected, actual) {
+			t.Fatalf("\n\nexpected:\n\n%#v\n\ngot:\n\n%#v\n\n", expected, actual)
+		}
+	})
+}

github/migrate_github_repository_webhook.go

@@ -1,54 +1,75 @@
 package github
 
 import (
-	"fmt"
+	"context"
 	"log"
 	"strings"
 
-	"github.com/hashicorp/terraform-plugin-sdk/v2/terraform"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 )
 
-func resourceGithubWebhookMigrateState(v int, is *terraform.InstanceState, meta any) (*terraform.InstanceState, error) {
-	switch v {
-	case 0:
-		log.Printf("[INFO] Found GitHub Webhook State v0; migrating to v1")
-		return migrateGithubWebhookStateV0toV1(is)
-	default:
-		return is, fmt.Errorf("unexpected schema version: %d", v)
+func resourceGithubRepositoryWebhookResourceV0() *schema.Resource {
+	return &schema.Resource{
+		Schema: map[string]*schema.Schema{
+			"name": {
+				Type:     schema.TypeString,
+				Required: true,
+				ForceNew: true,
+			},
+			"repository": {
+				Type:     schema.TypeString,
+				Required: true,
+				ForceNew: true,
+			},
+			"events": {
+				Type:     schema.TypeSet,
+				Required: true,
+				Elem:     &schema.Schema{Type: schema.TypeString},
+				Set:      schema.HashString,
+			},
+			"configuration": {
+				Type:     schema.TypeMap,
+				Optional: true,
+			},
+			"url": {
+				Type:     schema.TypeString,
+				Computed: true,
+			},
+			"active": {
+				Type:     schema.TypeBool,
+				Optional: true,
+				Default:  true,
+			},
+		},
 	}
 }
 
-func migrateGithubWebhookStateV0toV1(is *terraform.InstanceState) (*terraform.InstanceState, error) {
-	if is.Empty() {
-		log.Printf("[DEBUG] Empty InstanceState; nothing to migrate.")
-		return is, nil
-	}
-
-	log.Printf("[DEBUG] GitHub Webhook Attributes before migration: %#v", is.Attributes)
+func resourceGithubRepositoryWebhookInstanceStateUpgradeV0(ctx context.Context, rawState map[string]any, meta any) (map[string]any, error) {
+	log.Printf("[DEBUG] GitHub Repository Webhook State before migration: %#v", rawState)
 
 	prefix := "configuration."
-
-	delete(is.Attributes, prefix+"%")
+	delete(rawState, prefix+"%")
 
 	// Read & delete old keys
-	oldKeys := make(map[string]string)
-	for k, v := range is.Attributes {
+	oldKeys := make(map[string]any)
+	for k, v := range rawState {
 		if strings.HasPrefix(k, prefix) {
 			oldKeys[k] = v
 
 			// Delete old keys
-			delete(is.Attributes, k)
+			delete(rawState, k)
 		}
 	}
 
 	// Write new keys
 	for k, v := range oldKeys {
 		newKey := "configuration.0." + strings.TrimPrefix(k, prefix)
-		is.Attributes[newKey] = v
+		rawState[newKey] = v
 	}
 
-	is.Attributes[prefix+"#"] = "1"
-	log.Printf("[DEBUG] GitHub Webhook Attributes after State Migration: %#v", is.Attributes)
+	rawState[prefix+"#"] = "1"
+
+	log.Printf("[DEBUG] GitHub Repository Webhook State after migration: %#v", rawState)
 
-	return is, nil
+	return rawState, nil
 }

github/migrate_github_repository_webhook_test.go

@@ -3,36 +3,39 @@ package github
 import (
 	"reflect"
 	"testing"
-
-	"github.com/hashicorp/terraform-plugin-sdk/v2/terraform"
 )
 
-func TestMigrateGithubWebhookStateV0toV1(t *testing.T) {
-	oldAttributes := map[string]string{
+func testResourceGithubWebhookInstanceStateDataV0() map[string]any {
+	return map[string]any{
 		"configuration.%":            "4",
 		"configuration.content_type": "form",
 		"configuration.insecure_ssl": "0",
 		"configuration.secret":       "blablah",
 		"configuration.url":          "https://google.co.uk/",
 	}
+}
 
-	newState, err := migrateGithubWebhookStateV0toV1(&terraform.InstanceState{
-		ID:         "nonempty",
-		Attributes: oldAttributes,
-	})
-	if err != nil {
-		t.Fatal(err)
-	}
-
-	expectedAttributes := map[string]string{
+func testResourceGithubWebhookInstanceStateDataV1() map[string]any {
+	v0 := testResourceGithubWebhookInstanceStateDataV0()
+	return map[string]any{
 		"configuration.#":              "1",
-		"configuration.0.content_type": "form",
-		"configuration.0.insecure_ssl": "0",
-		"configuration.0.secret":       "blablah",
-		"configuration.0.url":          "https://google.co.uk/",
-	}
-	if !reflect.DeepEqual(newState.Attributes, expectedAttributes) {
-		t.Fatalf("Expected attributes:\n%#v\n\nGiven:\n%#v\n",
-			expectedAttributes, newState.Attributes)
+		"configuration.0.content_type": v0["configuration.content_type"],
+		"configuration.0.insecure_ssl": v0["configuration.insecure_ssl"],
+		"configuration.0.secret":       v0["configuration.secret"],
+		"configuration.0.url":          v0["configuration.url"],
 	}
 }
+
+func TestGithub_MigrateRepositoryWebhookStateV0toV1(t *testing.T) {
+	t.Run("migrates state without errors", func(t *testing.T) {
+		expected := testResourceGithubWebhookInstanceStateDataV1()
+		actual, err := resourceGithubRepositoryWebhookInstanceStateUpgradeV0(t.Context(), testResourceGithubWebhookInstanceStateDataV0(), nil)
+		if err != nil {
+			t.Fatalf("error migrating state: %s", err)
+		}
+
+		if !reflect.DeepEqual(expected, actual) {
+			t.Fatalf("\n\nexpected:\n\n%#v\n\ngot:\n\n%#v\n\n", expected, actual)
+		}
+	})
+}

github/resource_github_organization_webhook.go

@@ -22,7 +22,13 @@ func resourceGithubOrganizationWebhook() *schema.Resource {
 		},
 
 		SchemaVersion: 1,
-		MigrateState:  resourceGithubWebhookMigrateState,
+		StateUpgraders: []schema.StateUpgrader{
+			{
+				Type:    resourceGithubOrganizationWebhookResourceV0().CoreConfigSchema().ImpliedType(),
+				Upgrade: resourceGithubOrganizationWebhookInstanceStateUpgradeV0,
+				Version: 0,
+			},
+		},
 
 		Schema: map[string]*schema.Schema{
 			"events": {

github/resource_github_repository_webhook.go

@@ -34,7 +34,13 @@ func resourceGithubRepositoryWebhook() *schema.Resource {
 		},
 
 		SchemaVersion: 1,
-		MigrateState:  resourceGithubWebhookMigrateState,
+		StateUpgraders: []schema.StateUpgrader{
+			{
+				Type:    resourceGithubRepositoryWebhookResourceV0().CoreConfigSchema().ImpliedType(),
+				Upgrade: resourceGithubRepositoryWebhookInstanceStateUpgradeV0,
+				Version: 0,
+			},
+		},
 
 		Schema: map[string]*schema.Schema{
 			"repository": {