feat(state_upgarder) refactor state upgrader for dns_record, page_rule

and load_balancer_pool

Author: tamas-jozsa

.github/workflows/migration-tests.yml

@@ -28,6 +28,7 @@ env:
   CLOUDFLARE_HYPERDRIVE_DATABASE_HOSTNAME: ${{ secrets.CLOUDFLARE_HYPERDRIVE_DATABASE_HOSTNAME }}
   TF_ACC: 1
   TF_MIGRATE_BINARY_PATH: ${{ github.workspace }}/tf-migrate
+  TF_MIG_TEST: true
 
 jobs:
   migration-tests:

internal/acctest/acctest.go

@@ -917,25 +917,6 @@ func RunMigrationV2Command(t *testing.T, v4Config string, tmpDir string, sourceV
 		t.Fatalf("tf-migrate binary not found at %s. Please set TF_MIGRATE_BINARY_PATH or ensure the binary is built.", migratorPath)
 	}
 
-	// TODO:: Needs to be commented so the state upgraders run
-	// Find state file in tmpDir
-	//entries, err := os.ReadDir(tmpDir)
-	//var stateDir string
-	//if err != nil {
-	//	t.Logf("Failed to read test directory: %v", err)
-	//} else {
-	//for _, entry := range entries {
-	//	if entry.IsDir() {
-	//		inner_entries, _ := os.ReadDir(filepath.Join(tmpDir, entry.Name()))
-	//		for _, inner_entry := range inner_entries {
-	//			if inner_entry.Name() == "terraform.tfstate" {
-	//				stateDir = filepath.Join(tmpDir, entry.Name())
-	//			}
-	//		}
-	//	}
-	//}
-	//}
-
 	// Build the command
 	args := []string{
 		"migrate",
@@ -944,11 +925,6 @@ func RunMigrationV2Command(t *testing.T, v4Config string, tmpDir string, sourceV
 		"--target-version", targetVersion,
 	}
 
-	// Add state file argument if found
-	//if stateDir != "" {
-	//	args = append(args, "--state-file", filepath.Join(stateDir, "terraform.tfstate"))
-	//}
-
 	// Add debug logging if TF_LOG is set
 	if strings.ToLower(os.Getenv("TF_LOG")) == "debug" {
 		args = append(args, "--log-level", "debug")
@@ -1022,8 +998,8 @@ func RunMigrationCommand(t *testing.T, v4Config string, tmpDir string) {
 	cmd = exec.Command("go", "run", "-C", migratePath, ".",
 		"-config", tmpDir,
 		"-state", filepath.Join(stateDir, "terraform.tfstate"),
-		"-grit=false",       // Disable Grit transformations
-		"-transformer=true", // Enable YAML transformations
+		"-grit=false",                      // Disable Grit transformations
+		"-transformer=true",                // Enable YAML transformations
 		"-transformer-dir", transformerDir) // Use local YAML configs
 	cmd.Dir = tmpDir
 	// Capture output for debugging
@@ -1071,6 +1047,16 @@ func MigrationTestStepWithPlan(t *testing.T, v4Config string, tmpDir string, exa
 	return []resource.TestStep{migrationStep, planStep, validationStep}
 }
 
+// DetermineSourceTargetVersion determines the source and target versions for migration tests
+// based on the test version being used. For v4 versions, returns "v4" -> "v5" migration.
+// For v5 versions, returns "v5" -> "v5" which tests StateUpgrader idempotency only.
+func DetermineSourceTargetVersion(version string) (source, target string) {
+	if strings.HasPrefix(version, "5.") {
+		return "v5", "v5"
+	}
+	return "v4", "v5"
+}
+
 // MigrationV2TestStepWithPlan creates multiple test steps for v2 migration with plan processing
 // This is similar to MigrationTestStepWithPlan but uses the v2 migration command with explicit version parameters
 func MigrationV2TestStepWithPlan(t *testing.T, v4Config string, tmpDir string, exactVersion string, sourceVersion string, targetVersion string, stateChecks []statecheck.StateCheck) []resource.TestStep {
@@ -1167,8 +1153,14 @@ func MigrationV2TestStep(t *testing.T, v4Config string, tmpDir string, exactVers
 	return resource.TestStep{
 		PreConfig: func() {
 			WriteOutConfig(t, v4Config, tmpDir)
-			debugLogf(t, "Running migration command for version: %s (%s -> %s)", exactVersion, sourceVersion, targetVersion)
-			RunMigrationV2Command(t, v4Config, tmpDir, sourceVersion, targetVersion)
+			// Only run migration command if source version is v4
+			// v5→v5 "migrations" only test StateUpgrader idempotency, no config changes needed
+			if sourceVersion == "v4" {
+				debugLogf(t, "Running migration command for version: %s (%s -> %s)", exactVersion, sourceVersion, targetVersion)
+				RunMigrationV2Command(t, v4Config, tmpDir, sourceVersion, targetVersion)
+			} else {
+				debugLogf(t, "Skipping migration command for version: %s (%s -> %s) - testing StateUpgrader only", exactVersion, sourceVersion, targetVersion)
+			}
 		},
 		ProtoV6ProviderFactories: TestAccProtoV6ProviderFactories,
 		ConfigDirectory:          config.StaticDirectory(tmpDir),

internal/services/dns_record/migration/v500/handler.go

@@ -0,0 +1,66 @@
+package v500
+
+import (
+	"context"
+
+	"github.com/hashicorp/terraform-plugin-framework/resource"
+	"github.com/hashicorp/terraform-plugin-log/tflog"
+)
+
+// UpgradeFromV0 handles state upgrades from earlier v500 versions (schema_version=0) to current v500.
+// This is a no-op upgrade since the schema is compatible - just copy state through.
+//
+// Why this exists: Terraform requires explicit upgraders to be defined for version tracking,
+// even when the schema is identical. This ensures the schema_version is updated in the statefile.
+func UpgradeFromV0(
+	ctx context.Context,
+	req resource.UpgradeStateRequest,
+	resp *resource.UpgradeStateResponse,
+) {
+	// No-op upgrade: schema is compatible, just copy raw state through
+	// We use the raw state value directly to avoid issues with custom field type serialization
+	resp.State.Raw = req.State.Raw
+}
+
+// UpgradeFromV4 handles state upgrades from v5 releases with schema_version=4 to current v500.
+// This is a no-op upgrade since we only changed the version number from 4 to 500.
+// All v5.x.x releases up to 5.16.0 used schema_version=4 for cloudflare_dns_record.
+func UpgradeFromV4(
+	ctx context.Context,
+	req resource.UpgradeStateRequest,
+	resp *resource.UpgradeStateResponse,
+) {
+	tflog.Info(ctx, "Upgrading DNS record state from schema_version=4 to schema_version=500")
+	// No-op upgrade: schema is identical, just copy raw state through
+	// We use the raw state value directly to avoid issues with custom field type serialization
+	resp.State.Raw = req.State.Raw
+}
+
+// UpgradeFromLegacyV3 handles state upgrades from the legacy cloudflare_record resource to cloudflare_dns_record.
+// This is triggered when users manually run `terraform state mv cloudflare_record.x cloudflare_dns_record.x`
+// (Terraform < 1.8), which preserves the source schema_version=3 from the legacy provider.
+//
+// Note: schema_version=3 was the final schema version of cloudflare_record in the legacy (SDKv2) provider
+// before it was deprecated. The state structure matches SourceCloudflareRecordModel.
+func UpgradeFromLegacyV3(ctx context.Context, req resource.UpgradeStateRequest, resp *resource.UpgradeStateResponse) {
+	tflog.Info(ctx, "Upgrading DNS record state from legacy cloudflare_record (schema_version=3)")
+
+	// Parse the state (schema_version=3, source resource type)
+	var sourceState SourceCloudflareRecordModel
+	resp.Diagnostics.Append(req.State.Get(ctx, &sourceState)...)
+	if resp.Diagnostics.HasError() {
+		return
+	}
+
+	// Transform to target
+	targetState, diags := Transform(ctx, sourceState)
+	resp.Diagnostics.Append(diags...)
+	if resp.Diagnostics.HasError() {
+		return
+	}
+
+	// Set the upgraded state
+	resp.Diagnostics.Append(resp.State.Set(ctx, targetState)...)
+
+	tflog.Info(ctx, "State upgrade from legacy cloudflare_record completed successfully")
+}