chore: compress cassettes and test that cassettes are compressed (#3388)

* chore: compress cassettes and test that cassettes are compressed

* go mod tidy

* golangci-lint fix

* fix lint

* Fix tfproviderlint

* Add other state to the compress list

Author: remyleone

cmd/vcr-compressor/main.go

@@ -1,118 +1,23 @@
 package main
 
 import (
-	"encoding/json"
 	"log"
 	"os"
 
-	"github.com/scaleway/scaleway-sdk-go/api/k8s/v1"
-	"github.com/scaleway/scaleway-sdk-go/api/rdb/v1"
-	"gopkg.in/dnaeon/go-vcr.v3/cassette"
+	"github.com/scaleway/terraform-provider-scaleway/v2/internal/acctest"
 )
 
-var transientStates = map[string]bool{
-	k8s.ClusterStatusCreating.String(): true,
-	k8s.ClusterStatusDeleting.String(): true,
-	k8s.ClusterStatusUpdating.String(): true,
-	k8s.PoolStatusDeleting.String():    true,
-	k8s.PoolStatusScaling.String():     true,
-	k8s.PoolStatusUpgrading.String():   true,
-
-	rdb.DatabaseBackupStatusCreating.String():  true,
-	rdb.DatabaseBackupStatusDeleting.String():  true,
-	rdb.DatabaseBackupStatusExporting.String(): true,
-	rdb.DatabaseBackupStatusRestoring.String(): true,
-	rdb.InstanceStatusAutohealing.String():     true,
-	rdb.InstanceStatusBackuping.String():       true,
-	rdb.InstanceStatusConfiguring.String():     true,
-	rdb.InstanceStatusDeleting.String():        true,
-	rdb.InstanceStatusInitializing.String():    true,
-	rdb.InstanceStatusProvisioning.String():    true,
-	rdb.InstanceStatusRestarting.String():      true,
-	rdb.InstanceStatusSnapshotting.String():    true,
-}
-
 func main() {
 	if len(os.Args) < 2 {
 		log.Fatalf("Usage: %s <cassette_file_name_without_yaml>\n", os.Args[0])
 	}
 
 	path := os.Args[1]
 
-	inputCassette, err := cassette.Load(path)
+	report, err := acctest.CompressCassette(path)
 	if err != nil {
-		log.Fatalf("Error while reading file : %v\n", err)
+		log.Fatalf("%s", err)
 	}
 
-	outputCassette := cassette.New(path)
-	transitioning := false
-
-	for i := range len(inputCassette.Interactions) {
-		interaction := inputCassette.Interactions[i]
-		responseBody := interaction.Response.Body
-		requestMethod := interaction.Request.Method
-
-		if requestMethod != "GET" {
-			transitioning = false
-
-			log.Printf("Interaction %d is not a GET request. Recording it\n", i)
-			outputCassette.AddInteraction(interaction)
-
-			continue
-		}
-
-		if responseBody == "" {
-			log.Printf("Interaction %d got an empty response body. Recording it\n", i)
-			outputCassette.AddInteraction(interaction)
-
-			continue
-		}
-
-		var m map[string]any
-
-		err := json.Unmarshal([]byte(responseBody), &m)
-		if err != nil {
-			log.Printf("Interaction %d have an error with unmarshalling response body: %v. Recording it\n", i, err)
-			outputCassette.AddInteraction(interaction)
-
-			continue
-		}
-
-		if m["status"] == nil {
-			log.Printf("Interaction %d does not contain a status field. Recording it\n", i)
-			outputCassette.AddInteraction(interaction)
-
-			continue
-		}
-
-		status := m["status"].(string)
-		// We test if the state is transient
-		if _, ok := transientStates[status]; ok {
-			if transitioning {
-				log.Printf("Interaction %d is in a transient state while we are already in transitient state. No need to record it: %s\n", i, status)
-			} else {
-				log.Printf("Interaction %d is in a transient state: %s, Recording it\n", i, status)
-
-				transitioning = true
-
-				outputCassette.AddInteraction(interaction)
-			}
-		} else {
-			if transitioning {
-				log.Printf("Interaction %d is not in a transient state anymore: %s, Recording it\n", i, status)
-
-				outputCassette.AddInteraction(interaction)
-
-				transitioning = false
-			} else {
-				log.Printf("Interaction %d is not in a transient state: %s, Recording it\n", i, status)
-				outputCassette.AddInteraction(interaction)
-			}
-		}
-	}
-
-	err = outputCassette.Save()
-	if err != nil {
-		log.Fatalf("error while saving file: %v", err)
-	}
+	report.Print()
 }

go.mod

@@ -32,6 +32,7 @@ require (
 	github.com/scaleway/scaleway-sdk-go v1.0.0-beta.35
 	github.com/stretchr/testify v1.11.1
 	golang.org/x/crypto v0.42.0
+	golang.org/x/sync v0.17.0
 	gopkg.in/dnaeon/go-vcr.v3 v3.2.0
 )
 
@@ -161,7 +162,6 @@ require (
 	golang.org/x/exp v0.0.0-20250911091902-df9299821621 // indirect
 	golang.org/x/mod v0.28.0 // indirect
 	golang.org/x/net v0.44.0 // indirect
-	golang.org/x/sync v0.17.0 // indirect
 	golang.org/x/sys v0.36.0 // indirect
 	golang.org/x/term v0.35.0 // indirect
 	golang.org/x/text v0.29.0 // indirect

internal/acctest/compress_cassettes_test.go

@@ -0,0 +1,30 @@
+package acctest_test
+
+import (
+	"testing"
+
+	"github.com/scaleway/terraform-provider-scaleway/v2/internal/acctest"
+	"github.com/stretchr/testify/require"
+	"golang.org/x/sync/errgroup"
+)
+
+func TestAccCassettes_Compressed(t *testing.T) {
+	paths, err := getTestFiles(false)
+	require.NoError(t, err)
+
+	var g errgroup.Group
+
+	for path := range paths {
+		g.Go(func() error {
+			report, errCompression := acctest.CompressCassette(path)
+			require.NoError(t, errCompression)
+			require.Zero(t, report.SkippedInteraction, "Issue with cassette: %s", report.Path)
+
+			return nil
+		})
+	}
+
+	if err := g.Wait(); err != nil {
+		t.Errorf("error: %s", err)
+	}
+}

internal/acctest/vcr_compress.go

@@ -0,0 +1,202 @@
+package acctest
+
+import (
+	"encoding/json"
+	"fmt"
+	"log"
+
+	applesilicon "github.com/scaleway/scaleway-sdk-go/api/applesilicon/v1alpha1"
+	"github.com/scaleway/scaleway-sdk-go/api/baremetal/v1"
+	block "github.com/scaleway/scaleway-sdk-go/api/block/v1alpha1"
+	container "github.com/scaleway/scaleway-sdk-go/api/container/v1beta1"
+	domain "github.com/scaleway/scaleway-sdk-go/api/domain/v2beta1"
+	file "github.com/scaleway/scaleway-sdk-go/api/file/v1alpha1"
+	function "github.com/scaleway/scaleway-sdk-go/api/function/v1beta1"
+	"github.com/scaleway/scaleway-sdk-go/api/instance/v1"
+	"github.com/scaleway/scaleway-sdk-go/api/k8s/v1"
+	"github.com/scaleway/scaleway-sdk-go/api/mongodb/v1"
+	"github.com/scaleway/scaleway-sdk-go/api/rdb/v1"
+	"github.com/scaleway/scaleway-sdk-go/api/redis/v1"
+	tem "github.com/scaleway/scaleway-sdk-go/api/tem/v1alpha1"
+	"gopkg.in/dnaeon/go-vcr.v3/cassette"
+)
+
+var transientStates = map[string]bool{
+	applesilicon.ServerStatusStarting.String():     true,
+	applesilicon.ServerStatusRebooting.String():    true,
+	applesilicon.ServerStatusReinstalling.String(): true,
+
+	baremetal.ServerStatusDeleting.String():          true,
+	baremetal.ServerStatusStarting.String():          true,
+	baremetal.ServerStatusDelivering.String():        true,
+	baremetal.ServerStatusStarting.String():          true,
+	baremetal.ServerStatusMigrating.String():         true,
+	baremetal.ServerInstallStatusInstalling.String(): true,
+
+	block.VolumeStatusCreating.String():     true,
+	block.VolumeStatusUpdating.String():     true,
+	block.VolumeStatusDeleting.String():     true,
+	block.VolumeStatusResizing.String():     true,
+	block.VolumeStatusSnapshotting.String(): true,
+
+	container.ContainerStatusCreating.String(): true,
+	container.ContainerStatusDeleting.String(): true,
+	container.ContainerStatusPending.String():  true,
+
+	domain.DNSZoneStatusPending.String(): true,
+
+	file.FileSystemStatusCreating.String(): true,
+
+	function.FunctionStatusCreating.String(): true,
+	function.FunctionStatusDeleting.String(): true,
+	function.FunctionStatusPending.String():  true,
+
+	instance.ServerStateStarting.String(): true,
+	instance.ServerStateStopping.String(): true,
+
+	k8s.ClusterStatusCreating.String(): true,
+	k8s.ClusterStatusDeleting.String(): true,
+	k8s.ClusterStatusUpdating.String(): true,
+	k8s.PoolStatusDeleting.String():    true,
+	k8s.PoolStatusScaling.String():     true,
+	k8s.PoolStatusUpgrading.String():   true,
+
+	mongodb.InstanceStatusDeleting.String():     true,
+	mongodb.InstanceStatusSnapshotting.String(): true,
+	mongodb.InstanceStatusConfiguring.String():  true,
+	mongodb.InstanceStatusInitializing.String(): true,
+	mongodb.InstanceStatusProvisioning.String(): true,
+
+	rdb.DatabaseBackupStatusCreating.String():  true,
+	rdb.DatabaseBackupStatusDeleting.String():  true,
+	rdb.DatabaseBackupStatusExporting.String(): true,
+	rdb.DatabaseBackupStatusRestoring.String(): true,
+	rdb.InstanceStatusAutohealing.String():     true,
+	rdb.InstanceStatusBackuping.String():       true,
+	rdb.InstanceStatusConfiguring.String():     true,
+	rdb.InstanceStatusDeleting.String():        true,
+	rdb.InstanceStatusInitializing.String():    true,
+	rdb.InstanceStatusProvisioning.String():    true,
+	rdb.InstanceStatusRestarting.String():      true,
+	rdb.InstanceStatusSnapshotting.String():    true,
+
+	redis.ClusterStatusAutohealing.String():  true,
+	redis.ClusterStatusConfiguring.String():  true,
+	redis.ClusterStatusProvisioning.String(): true,
+	redis.ClusterStatusDeleting.String():     true,
+	redis.ClusterStatusInitializing.String(): true,
+
+	tem.DomainStatusPending.String(): true,
+}
+
+type CompressReport struct {
+	Path               string
+	Logs               []string
+	ErrorLogs          []string
+	SkippedInteraction int
+}
+
+func (report *CompressReport) AddLog(log string) {
+	report.Logs = append(report.Logs, log)
+}
+
+func (report *CompressReport) AddErrorLog(log string) {
+	report.ErrorLogs = append(report.ErrorLogs, log)
+}
+
+func (report *CompressReport) Print() {
+	log.Printf("On cassette: %s\n", report.Path)
+	log.Printf("%d skipped interactions\n", report.SkippedInteraction)
+
+	for _, msg := range report.ErrorLogs {
+		log.Println(msg)
+	}
+}
+
+func CompressCassette(path string) (CompressReport, error) {
+	inputCassette, err := cassette.Load(path)
+	if err != nil {
+		log.Fatalf("Error while reading file : %v\n", err)
+	}
+
+	outputCassette := cassette.New(path)
+	transitioning := false
+
+	report := CompressReport{
+		SkippedInteraction: 0,
+		Path:               path,
+		ErrorLogs:          []string{},
+		Logs:               []string{},
+	}
+
+	for i := range len(inputCassette.Interactions) {
+		interaction := inputCassette.Interactions[i]
+		responseBody := interaction.Response.Body
+		requestMethod := interaction.Request.Method
+
+		if requestMethod != "GET" {
+			transitioning = false
+
+			report.AddLog(fmt.Sprintf("Interaction %d in test %s is not a GET request. Recording it\n", i, path))
+			outputCassette.AddInteraction(interaction)
+
+			continue
+		}
+
+		if responseBody == "" {
+			report.AddLog(fmt.Sprintf("Interaction %d in test %s got an empty response body. Recording it\n", i, path))
+			outputCassette.AddInteraction(interaction)
+
+			continue
+		}
+
+		var m map[string]any
+
+		err := json.Unmarshal([]byte(responseBody), &m)
+		if err != nil {
+			report.AddErrorLog(fmt.Sprintf("Interaction %d in test %s have an error with unmarshalling response body: %v. Recording it\n", i, path, err))
+			outputCassette.AddInteraction(interaction)
+
+			continue
+		}
+
+		if m["status"] == nil {
+			report.AddLog(fmt.Sprintf("Interaction %d in test %s does not contain a status field. Recording it\n", i, path))
+			outputCassette.AddInteraction(interaction)
+
+			continue
+		}
+
+		status := m["status"].(string)
+		// We test if the state is transient
+		if _, ok := transientStates[status]; ok {
+			if transitioning {
+				report.AddLog(fmt.Sprintf("Interaction %d in test %s is in a transient state while we are already in transitient state. No need to record it: %s\n", i, path, status))
+				report.SkippedInteraction++
+			} else {
+				report.AddLog(fmt.Sprintf("Interaction %d in test %s is in a transient state: %s, Recording it\n", i, path, status))
+
+				transitioning = true
+
+				outputCassette.AddInteraction(interaction)
+			}
+		} else {
+			if transitioning {
+				report.AddLog(fmt.Sprintf("Interaction %d in test %s is not in a transient state anymore: %s, Recording it\n", i, path, status))
+				outputCassette.AddInteraction(interaction)
+
+				transitioning = false
+			} else {
+				report.AddLog(fmt.Sprintf("Interaction %d in test %s is not in a transient state: %s, Recording it\n", i, path, status))
+				outputCassette.AddInteraction(interaction)
+			}
+		}
+	}
+
+	err = outputCassette.Save()
+	if err != nil {
+		return report, fmt.Errorf("error while saving file: %w", err)
+	}
+
+	return report, nil
+}