chore: migrate to gopkg.in/dnaeon/go-vcr.v3 (#2488)

* chore: migrate to gopkg.in/dnaeon/go-vcr.v3

* Fix linter

Author: remyleone

go.mod

@@ -2,7 +2,6 @@ module github.com/scaleway/terraform-provider-scaleway/v2
 
 require (
 	github.com/aws/aws-sdk-go v1.51.8
-	github.com/dnaeon/go-vcr v1.2.0
 	github.com/docker/docker v26.0.0+incompatible
 	github.com/dustin/go-humanize v1.0.1
 	github.com/google/go-cmp v0.6.0
@@ -19,6 +18,7 @@ require (
 	github.com/scaleway/scaleway-sdk-go v1.0.0-beta.25.0.20240325161646-a49fad6abe89
 	github.com/stretchr/testify v1.9.0
 	golang.org/x/crypto v0.21.0
+	gopkg.in/dnaeon/go-vcr.v3 v3.2.0
 )
 
 require (

go.sum

@@ -177,7 +177,6 @@ github.com/moby/docker-image-spec v1.3.1 h1:jMKff3w6PgbfSa69GfNg+zN/XLhfXJGnEx3N
 github.com/moby/docker-image-spec v1.3.1/go.mod h1:eKmb5VW8vQEh/BAr2yvVNvuiJuY6UIocYsFu/DxxRpo=
 github.com/moby/term v0.0.0-20210619224110-3f7ff695adc6 h1:dcztxKSvZ4Id8iPpHERQBbIJfabdt4wUm5qy3wOL2Zc=
 github.com/moby/term v0.0.0-20210619224110-3f7ff695adc6/go.mod h1:E2VnQOmVuvZB6UYnnDB0qG5Nq/1tD9acaOpo6xmt0Kw=
-github.com/modocache/gover v0.0.0-20171022184752-b58185e213c5/go.mod h1:caMODM3PzxT8aQXRPkAt8xlV/e7d7w8GM5g0fa5F0D8=
 github.com/morikuni/aec v1.0.0 h1:nP9CBfwrvYnBRgY6qfDQkygYDmYwOilePFkwzv4dU8A=
 github.com/morikuni/aec v1.0.0/go.mod h1:BbKIizmSmc5MMPqRYbxO4ZU0S0+P200+tUnFx7PXmsc=
 github.com/nats-io/jwt/v2 v2.5.5 h1:ROfXb50elFq5c9+1ztaUbdlrArNFl2+fQWP6B8HGEq4=
@@ -335,6 +334,8 @@ google.golang.org/protobuf v1.33.0/go.mod h1:c6P6GXX6sHbq/GpV6MGZEdwhWPcYBgnhAHh
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 h1:qIbj1fsPNlZgppZ+VLlY7N33q108Sa+fhmuc+sWQYwY=
 gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/dnaeon/go-vcr.v3 v3.2.0 h1:Rltp0Vf+Aq0u4rQXgmXgtgoRDStTnFN83cWgSGSoRzM=
+gopkg.in/dnaeon/go-vcr.v3 v3.2.0/go.mod h1:2IMOnnlx9I6u9x+YBsM3tAMx6AlOxnJ0pWxQAzZ79Ag=
 gopkg.in/warnings.v0 v0.1.2 h1:wFXVbFY8DY5/xOe1ECiWdKCzZlxgshcYVNkBHstARME=
 gopkg.in/warnings.v0 v0.1.2/go.mod h1:jksf8JmL6Qr/oQM2OXTHunEvvTAsrWBLb6OOjuVWRNI=
 gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=

internal/acctest/vcr.go

@@ -14,12 +14,12 @@ import (
 	"strings"
 	"testing"
 
-	"github.com/dnaeon/go-vcr/cassette"
-	"github.com/dnaeon/go-vcr/recorder"
 	"github.com/scaleway/scaleway-sdk-go/scw"
 	"github.com/scaleway/scaleway-sdk-go/strcase"
 	"github.com/scaleway/terraform-provider-scaleway/v2/internal/transport"
 	"github.com/stretchr/testify/require"
+	"gopkg.in/dnaeon/go-vcr.v3/cassette"
+	"gopkg.in/dnaeon/go-vcr.v3/recorder"
 )
 
 // UpdateCassettes will update all cassettes of a given test
@@ -253,31 +253,38 @@ func cassetteSensitiveFieldsAnonymizer(i *cassette.Interaction) error {
 // closed and saved after the requests.
 func getHTTPRecoder(t *testing.T, update bool) (client *http.Client, cleanup func(), err error) {
 	t.Helper()
-	recorderMode := recorder.ModeReplaying
+	recorderMode := recorder.ModeReplayOnly
 	if update {
-		recorderMode = recorder.ModeRecording
+		recorderMode = recorder.ModeRecordOnly
 	}
 
 	// Setup recorder and scw client
-	r, err := recorder.NewAsMode(getTestFilePath(t, ".cassette"), recorderMode, nil)
+	r, err := recorder.NewWithOptions(&recorder.Options{
+		CassetteName:       getTestFilePath(t, ".cassette"),
+		Mode:               recorderMode,
+		SkipRequestLatency: true,
+	})
 	if err != nil {
 		return nil, nil, err
 	}
+	defer func(r *recorder.Recorder) {
+		_ = r.Stop()
+	}(r)
 
 	// Add custom matcher for requests and cassettes
 	r.SetMatcher(cassetteMatcher)
 
 	// Add a filter which removes Authorization headers from all requests:
-	r.AddFilter(func(i *cassette.Interaction) error {
+	r.AddHook(func(i *cassette.Interaction) error {
 		i.Request.Headers = i.Request.Headers.Clone()
 		delete(i.Request.Headers, "x-auth-token")
 		delete(i.Request.Headers, "X-Auth-Token")
 		delete(i.Request.Headers, "Authorization")
 		return nil
-	})
+	}, recorder.BeforeSaveHook)
 
 	// Add a filter that will replace sensitive values with fixed values
-	r.AddSaveFilter(cassetteSensitiveFieldsAnonymizer)
+	r.AddHook(cassetteSensitiveFieldsAnonymizer, recorder.BeforeSaveHook)
 
 	retryOptions := transport.RetryableTransportOptions{}
 	if !*UpdateCassettes {

internal/provider/testdata/provider-instance-ip-zones.cassette.yaml

@@ -1,5 +1,5 @@
 ---
-version: 1
+version: 2
 interactions:
 - request:
     body: '{"project":"105bdce1-64c0-48ab-899d-868455867ecf"}'
@@ -37,7 +37,6 @@ interactions:
       - 481f50a6-13f2-4121-ae71-6896640cfb46
     status: 201 Created
     code: 201
-    duration: ""
 - request:
     body: ""
     form: {}
@@ -70,7 +69,6 @@ interactions:
       - 2fe01085-071a-4183-a825-486b2634739c
     status: 200 OK
     code: 200
-    duration: ""
 - request:
     body: '{"project":"105bdce1-64c0-48ab-899d-868455867ecf"}'
     form: {}
@@ -107,7 +105,6 @@ interactions:
       - 9faa5ef0-733d-46d4-966b-ce1981d5ad7b
     status: 201 Created
     code: 201
-    duration: ""
 - request:
     body: ""
     form: {}
@@ -140,7 +137,6 @@ interactions:
       - cd089545-570d-4c49-a8c7-d9494e099790
     status: 200 OK
     code: 200
-    duration: ""
 - request:
     body: ""
     form: {}
@@ -173,7 +169,6 @@ interactions:
       - 61001aa0-72f3-464f-8a26-7ff1d88d68f3
     status: 200 OK
     code: 200
-    duration: ""
 - request:
     body: ""
     form: {}
@@ -206,7 +201,6 @@ interactions:
       - 95b9318f-b680-4084-a5b7-591dc6a1c155
     status: 200 OK
     code: 200
-    duration: ""
 - request:
     body: ""
     form: {}
@@ -239,7 +233,6 @@ interactions:
       - 0bce2aa0-aa99-4178-a6f5-242c71851fa0
     status: 200 OK
     code: 200
-    duration: ""
 - request:
     body: ""
     form: {}
@@ -272,7 +265,6 @@ interactions:
       - 0d24db31-70ba-41ce-bc45-6393fbf0373d
     status: 200 OK
     code: 200
-    duration: ""
 - request:
     body: ""
     form: {}
@@ -301,7 +293,6 @@ interactions:
       - 1573b6a2-618a-49dd-aa7e-d4c699113b1b
     status: 204 No Content
     code: 204
-    duration: ""
 - request:
     body: ""
     form: {}
@@ -330,4 +321,3 @@ interactions:
       - 7f82f027-dd62-450d-b2b9-43116fddb87b
     status: 204 No Content
     code: 204
-    duration: ""

internal/provider/testdata/provider-ssh-keys.cassette.yaml

@@ -1,5 +1,5 @@
 ---
-version: 1
+version: 2
 interactions:
 - request:
     body: '{"name":"TestAccScalewayProvider_SSHKeys","public_key":"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIEEYrzDOZmhItdKaDAEqJQ4ORS2GyBMtBozYsK5kiXXX
@@ -39,7 +39,6 @@ interactions:
       - 315996bf-a523-48d7-8d5a-a12aa282fb0f
     status: 200 OK
     code: 200
-    duration: ""
 - request:
     body: '{"name":"TestAccScalewayProvider_SSHKeys","public_key":"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIEEYrzDOZmhItdKaDAEqJQ4ORS2GyBMtBozYsK5kiXXX
       [email protected]","project_id":"63a66ec9-a385-4194-bc15-04aa6921274a"}'
@@ -78,7 +77,6 @@ interactions:
       - 05d4b0e8-b3c4-4fff-84df-31dcd07ab4e1
     status: 200 OK
     code: 200
-    duration: ""
 - request:
     body: ""
     form: {}
@@ -114,7 +112,6 @@ interactions:
       - ce8f29ed-a237-4089-95b3-8c714234732d
     status: 200 OK
     code: 200
-    duration: ""
 - request:
     body: ""
     form: {}
@@ -150,7 +147,6 @@ interactions:
       - 12ec83c7-8530-432f-87cb-3fc789028520
     status: 200 OK
     code: 200
-    duration: ""
 - request:
     body: ""
     form: {}
@@ -186,7 +182,6 @@ interactions:
       - 7d587edf-3068-4d46-8cd6-08de61afb4a5
     status: 200 OK
     code: 200
-    duration: ""
 - request:
     body: ""
     form: {}
@@ -222,7 +217,6 @@ interactions:
       - 3f3e5183-e841-4c49-be76-f7a6b51bd00a
     status: 200 OK
     code: 200
-    duration: ""
 - request:
     body: ""
     form: {}
@@ -258,7 +252,6 @@ interactions:
       - e8108464-9ed5-412e-8d42-c6f0960e4c90
     status: 200 OK
     code: 200
-    duration: ""
 - request:
     body: ""
     form: {}
@@ -294,7 +287,6 @@ interactions:
       - bde2aa4e-e6bd-4123-b40c-5e0f87eeb161
     status: 200 OK
     code: 200
-    duration: ""
 - request:
     body: ""
     form: {}
@@ -325,7 +317,6 @@ interactions:
       - c2890cd4-d433-48e9-a766-182e1fdc9607
     status: 204 No Content
     code: 204
-    duration: ""
 - request:
     body: ""
     form: {}
@@ -356,4 +347,3 @@ interactions:
       - 976cf13f-6ac0-42e1-9527-67e9677319c4
     status: 204 No Content
     code: 204
-    duration: ""

scaleway/data_source_registry_image_test.go

@@ -12,11 +12,11 @@ import (
 )
 
 func TestAccScalewayDataSourceRegistryImage_Basic(t *testing.T) {
+	t.Skip("It is difficult to test this datasource as we cannot create registry images with Terraform.")
 	tt := acctest.NewTestTools(t)
 	defer tt.Cleanup()
 	ubuntuImageID := "4b5a47c0-6fbf-4388-8783-c07c28d3c2eb"
 
-	t.Skip("It is difficult to test this datasource as we cannot create registry images with Terraform.")
 	resource.ParallelTest(t, resource.TestCase{
 		PreCheck:          func() { acctest.PreCheck(t) },
 		ProviderFactories: tt.ProviderFactories,

scaleway/testdata/account-project-basic.cassette.yaml

@@ -1,5 +1,5 @@
 ---
-version: 1
+version: 2
 interactions:
 - request:
     body: '{"name":"tf_tests_project_basic","organization_id":"ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b","description":"a
@@ -36,7 +36,6 @@ interactions:
       - c2c045e3-33ca-4bcc-ace0-d871f44fbf5b
     status: 200 OK
     code: 200
-    duration: ""
 - request:
     body: ""
     form: {}
@@ -69,7 +68,6 @@ interactions:
       - 47e77065-ba13-4789-8f0d-f3f58064c450
     status: 200 OK
     code: 200
-    duration: ""
 - request:
     body: ""
     form: {}
@@ -102,7 +100,6 @@ interactions:
       - fc50603e-8a55-43f3-b3e4-90f76abdfba6
     status: 200 OK
     code: 200
-    duration: ""
 - request:
     body: ""
     form: {}
@@ -135,7 +132,6 @@ interactions:
       - ec865323-84e2-4938-9c41-e91248370cdf
     status: 200 OK
     code: 200
-    duration: ""
 - request:
     body: ""
     form: {}
@@ -168,7 +164,6 @@ interactions:
       - 6bf64467-b4f9-4b0c-8e3e-164fa96edd6c
     status: 200 OK
     code: 200
-    duration: ""
 - request:
     body: '{"name":"tf_tests_project_basic_rename","description":"another description"}'
     form: {}
@@ -203,7 +198,6 @@ interactions:
       - 02593e1b-3e7b-4ecf-825d-b2585c55e61d
     status: 200 OK
     code: 200
-    duration: ""
 - request:
     body: ""
     form: {}
@@ -236,7 +230,6 @@ interactions:
       - 93b06042-3354-4b7e-833d-622b452022ac
     status: 200 OK
     code: 200
-    duration: ""
 - request:
     body: ""
     form: {}
@@ -269,7 +262,6 @@ interactions:
       - 508e6381-5fba-4f8d-b1ea-8b6afccc09f9
     status: 200 OK
     code: 200
-    duration: ""
 - request:
     body: ""
     form: {}
@@ -302,7 +294,6 @@ interactions:
       - 0ef8aac6-8e1e-46ed-a248-80998b71e274
     status: 200 OK
     code: 200
-    duration: ""
 - request:
     body: ""
     form: {}
@@ -333,7 +324,6 @@ interactions:
       - a59aebd5-0b57-4a68-b243-c1c7cf71a13c
     status: 204 No Content
     code: 204
-    duration: ""
 - request:
     body: ""
     form: {}
@@ -366,4 +356,3 @@ interactions:
       - 53cd4e53-4faf-4624-9ad1-abb9dc2ac467
     status: 404 Not Found
     code: 404
-    duration: ""