feat(tests): bump go-vcr to v4

cmd/vcr-viewer/main.go

@@ -5,7 +5,7 @@ import (
 	"log"
 	"os"
 
-	"gopkg.in/dnaeon/go-vcr.v3/cassette"
+	"gopkg.in/dnaeon/go-vcr.v4/pkg/cassette"
 )
 
 func main() {

go.mod

@@ -35,6 +35,7 @@ require (
 	golang.org/x/crypto v0.43.0
 	golang.org/x/sync v0.17.0
 	gopkg.in/dnaeon/go-vcr.v3 v3.2.0
+	gopkg.in/dnaeon/go-vcr.v4 v4.0.5
 )
 
 require (
@@ -85,6 +86,7 @@ require (
 	github.com/fsnotify/fsnotify v1.8.0 // indirect
 	github.com/go-logr/logr v1.4.3 // indirect
 	github.com/go-logr/stdr v1.2.2 // indirect
+	github.com/goccy/go-yaml v1.18.0 // indirect
 	github.com/golang/protobuf v1.5.4 // indirect
 	github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510 // indirect
 	github.com/gookit/color v1.5.1 // indirect

internal/acctest/acctest.go

@@ -1,21 +1,32 @@
 package acctest
 
 import (
+	"encoding/base64"
+	"encoding/json"
+	"encoding/xml"
+	"flag"
+	"net/http"
 	"os"
-	"strconv"
 	"strings"
 	"testing"
 	"time"
 
 	"github.com/hashicorp/terraform-plugin-go/tfprotov6"
 	"github.com/hashicorp/terraform-plugin-mux/tf6muxserver"
+	"github.com/scaleway/scaleway-sdk-go/scw"
+	"github.com/scaleway/scaleway-sdk-go/vcr"
 	"github.com/scaleway/terraform-provider-scaleway/v2/internal/env"
 	"github.com/scaleway/terraform-provider-scaleway/v2/internal/meta"
 	"github.com/scaleway/terraform-provider-scaleway/v2/internal/transport"
 	"github.com/scaleway/terraform-provider-scaleway/v2/provider"
 	"github.com/stretchr/testify/require"
+	"gopkg.in/dnaeon/go-vcr.v4/pkg/cassette"
+	"gopkg.in/dnaeon/go-vcr.v4/pkg/recorder"
 )
 
+// UpdateCassettes will update all cassettes of a given test
+var UpdateCassettes = flag.Bool("cassettes", os.Getenv(env.UpdateCassettes) == "true", "Record Cassettes")
+
 func PreCheck(_ *testing.T) {}
 
 type TestTools struct {
@@ -25,6 +36,58 @@ type TestTools struct {
 	Cleanup           func()
 }
 
+// s3Encoder encodes binary payloads as base64 because serialization changed on go-vcr.v4
+func s3Encoder(i *cassette.Interaction) error {
+	if strings.HasSuffix(i.Request.Host, "scw.cloud") {
+		if i.Request.Body != "" && i.Request.Headers.Get("Content-Type") == "application/octet-stream" {
+			requestBody := []byte(i.Request.Body)
+			if !json.Valid(requestBody) {
+				err := xml.Unmarshal(requestBody, new(any))
+				if err != nil {
+					i.Request.Body = base64.StdEncoding.EncodeToString(requestBody)
+				}
+			}
+		}
+
+		if i.Response.Body != "" && i.Response.Headers.Get("Content-Type") == "binary/octet-stream" {
+			responseBody := []byte(i.Response.Body)
+			if !json.Valid(responseBody) {
+				err := xml.Unmarshal(responseBody, new(any))
+				if err != nil {
+					i.Response.Body = base64.StdEncoding.EncodeToString(responseBody)
+				}
+			}
+		}
+	}
+
+	return nil
+}
+
+func NewRecordedClient(t *testing.T, pkgFolder string, update bool) (client *http.Client, cleanup func(), err error) {
+	t.Helper()
+
+	s3EncoderHook := vcr.AdditionalHook{
+		HookFunc: s3Encoder,
+		Kind:     recorder.AfterCaptureHook,
+	}
+
+	r, err := vcr.NewHTTPRecorder(t, pkgFolder, update, nil, s3EncoderHook)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	retryOptions := transport.RetryableTransportOptions{}
+	if !update {
+		retryOptions.RetryWaitMax = scw.TimeDurationPtr(0)
+	}
+
+	return &http.Client{
+			Transport: transport.NewRetryableTransportWithOptions(r, retryOptions),
+		}, func() {
+			require.NoError(t, r.Stop()) // Make sure recorder is stopped once done with it
+		}, nil
+}
+
 func NewTestTools(t *testing.T) *TestTools {
 	t.Helper()
 
@@ -35,8 +98,8 @@ func NewTestTools(t *testing.T) *TestTools {
 		t.Fatalf("cannot detect working directory for testing")
 	}
 
-	// Create a http client with recording capabilities
-	httpClient, cleanup, err := getHTTPRecoder(t, folder, *UpdateCassettes)
+	// Create an HTTP client with recording capabilities
+	httpClient, cleanup, err := NewRecordedClient(t, folder, *UpdateCassettes)
 	require.NoError(t, err)
 
 	// Create meta that will be passed in the provider config
@@ -84,46 +147,6 @@ func NewTestTools(t *testing.T) *TestTools {
 	}
 }
 
-// Test Generated name has format: "{prefix}-{generated_number}
-// example: test-acc-scaleway-project-3723338038624371236
-func extractTestGeneratedNamePrefix(name string) string {
-	// {prefix}-{generated}
-	//         ^
-	dashIndex := strings.LastIndex(name, "-")
-
-	generated := name[dashIndex+1:]
-	_, generatedToIntErr := strconv.ParseInt(generated, 10, 64)
-
-	if dashIndex == -1 || generatedToIntErr != nil {
-		// some are only {name}
-		return name
-	}
-
-	// {prefix}
-	return name[:dashIndex]
-}
-
-// Generated names have format: "tf-{prefix}-{generated1}-{generated2}"
-// example: tf-sg-gifted-yonath
-func extractGeneratedNamePrefix(name string) string {
-	if strings.Count(name, "-") < 3 {
-		return name
-	}
-	// tf-{prefix}-gifted-yonath
-	name = strings.TrimPrefix(name, "tf-")
-
-	// {prefix}-gifted-yonath
-	//                ^
-	dashIndex := strings.LastIndex(name, "-")
-	name = name[:dashIndex]
-	// {prefix}-gifted
-	//         ^
-	dashIndex = strings.LastIndex(name, "-")
-	name = name[:dashIndex]
-
-	return name
-}
-
 // IsTestResource returns true if given resource identifier is from terraform test
 // identifier should be resource name but some resource don't have names
 // return true if identifier match regex "tf[-_]test"

internal/acctest/acctest_test.go

@@ -7,8 +7,8 @@ import (
 	"strings"
 	"testing"
 
-	"github.com/scaleway/terraform-provider-scaleway/v2/internal/acctest"
-	"gopkg.in/dnaeon/go-vcr.v3/cassette"
+	"github.com/scaleway/scaleway-sdk-go/vcr"
+	"gopkg.in/dnaeon/go-vcr.v4/pkg/cassette"
 )
 
 var barMemberCreationBody = `{
@@ -488,7 +488,7 @@ var testBodyMatcherCases = []struct {
 
 func TestCassetteMatcher(t *testing.T) {
 	for i, test := range testBodyMatcherCases {
-		shouldMatch := acctest.CassetteMatcher(test.requestBody, *test.cassetteBody)
+		shouldMatch := vcr.CassetteMatcher(test.requestBody, *test.cassetteBody)
 		if shouldMatch != test.shouldMatch {
 			t.Errorf("test %d: expected %v, got %v", i, test.shouldMatch, shouldMatch)
 			t.Errorf("requestBody: %s", test.requestBody.Body)