Add schema migration

Author: nickfloyd

github/migrate_github_actions_secret.go

@@ -0,0 +1,36 @@
+package github
+
+import (
+	"fmt"
+	"log"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/terraform"
+)
+
+func resourceGithubActionsSecretMigrateState(v int, is *terraform.InstanceState, meta interface{}) (*terraform.InstanceState, error) {
+	switch v {
+	case 0:
+		log.Printf("[INFO] Found GitHub Actions Secret State v0; migrating to v1")
+		return migrateGithubActionsSecretStateV0toV1(is)
+	default:
+		return is, fmt.Errorf("unexpected schema version: %d", v)
+	}
+}
+
+func migrateGithubActionsSecretStateV0toV1(is *terraform.InstanceState) (*terraform.InstanceState, error) {
+	if is.Empty() {
+		log.Printf("[DEBUG] Empty InstanceState; nothing to migrate.")
+		return is, nil
+	}
+
+	log.Printf("[DEBUG] GitHub Actions Secret Attributes before migration: %#v", is.Attributes)
+
+	// Add the destroy_on_drift field with default value true if it doesn't exist
+	if _, ok := is.Attributes["destroy_on_drift"]; !ok {
+		is.Attributes["destroy_on_drift"] = "true"
+	}
+
+	log.Printf("[DEBUG] GitHub Actions Secret Attributes after State Migration: %#v", is.Attributes)
+
+	return is, nil
+}

github/migrate_github_actions_secret_test.go

@@ -0,0 +1,69 @@
+package github
+
+import (
+	"reflect"
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/terraform"
+)
+
+func TestMigrateGithubActionsSecretStateV0toV1(t *testing.T) {
+	// Secret without destroy_on_drift should get default value
+	oldAttributes := map[string]string{
+		"id":              "test-secret",
+		"repository":      "test-repo",
+		"secret_name":     "test-secret",
+		"created_at":      "2023-01-01T00:00:00Z",
+		"updated_at":      "2023-01-01T00:00:00Z",
+		"plaintext_value": "secret-value",
+	}
+
+	newState, err := migrateGithubActionsSecretStateV0toV1(&terraform.InstanceState{
+		ID:         "test-secret",
+		Attributes: oldAttributes,
+	})
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	expectedAttributes := map[string]string{
+		"id":               "test-secret",
+		"repository":       "test-repo",
+		"secret_name":      "test-secret",
+		"created_at":       "2023-01-01T00:00:00Z",
+		"updated_at":       "2023-01-01T00:00:00Z",
+		"plaintext_value":  "secret-value",
+		"destroy_on_drift": "true",
+	}
+	if !reflect.DeepEqual(newState.Attributes, expectedAttributes) {
+		t.Fatalf("Expected attributes:\n%#v\n\nGiven:\n%#v\n",
+			expectedAttributes, newState.Attributes)
+	}
+
+	// Secret with existing destroy_on_drift should be preserved
+	oldAttributesWithDrift := map[string]string{
+		"id":               "test-secret",
+		"repository":       "test-repo",
+		"secret_name":      "test-secret",
+		"destroy_on_drift": "false",
+	}
+
+	newState2, err := migrateGithubActionsSecretStateV0toV1(&terraform.InstanceState{
+		ID:         "test-secret",
+		Attributes: oldAttributesWithDrift,
+	})
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	expectedAttributesWithDrift := map[string]string{
+		"id":               "test-secret",
+		"repository":       "test-repo",
+		"secret_name":      "test-secret",
+		"destroy_on_drift": "false",
+	}
+	if !reflect.DeepEqual(newState2.Attributes, expectedAttributesWithDrift) {
+		t.Fatalf("Expected attributes:\n%#v\n\nGiven:\n%#v\n",
+			expectedAttributesWithDrift, newState2.Attributes)
+	}
+}

github/resource_github_actions_secret.go

@@ -22,6 +22,11 @@ func resourceGithubActionsSecret() *schema.Resource {
 			State: resourceGithubActionsSecretImport,
 		},
 
+		// Schema migration added to handle the addition of destroy_on_drift field
+		// Resources created before this field was added need it populated with default value
+		SchemaVersion: 1,
+		MigrateState:  resourceGithubActionsSecretMigrateState,
+
 		Schema: map[string]*schema.Schema{
 			"repository": {
 				Type:        schema.TypeString,