chore: add support for vcr compression and trim k8s cassettes

Author: remyleone

cmd/vcr-compressor/main.go

@@ -0,0 +1,92 @@
+package main
+
+import (
+	"encoding/json"
+	"fmt"
+	"github.com/scaleway/scaleway-sdk-go/api/k8s/v1"
+	"gopkg.in/dnaeon/go-vcr.v3/cassette"
+	"log"
+	"os"
+)
+
+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,
+}
+
+func main() {
+	if len(os.Args) < 2 {
+		log.Fatalf("Usage: %s <chemin_du_fichier_yaml>\n", os.Args[0])
+	}
+
+	chemin := os.Args[1]
+	inputCassette, err := cassette.Load(chemin)
+	if err != nil {
+		log.Fatalf("Erreur de lecture du fichier : %v\n", err)
+	}
+
+	outputCassette := cassette.New(chemin)
+	transitioning := false
+	for i := 0; i < len(inputCassette.Interactions); i++ {
+		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]interface{}
+		err := json.Unmarshal([]byte(responseBody), &m)
+		if err != nil {
+			fmt.Printf("Interaction %d have an error with unmarshalling reponse 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
+		}
+
+		if m["status"] != nil {
+			// We test if the state is transient
+			if _, ok := transientStates[m["status"].(string)]; ok {
+				if transitioning {
+					fmt.Printf("Interaction %d is in a transient state while we are already in transitient state. No need to record it: %s\n", i, m["status"])
+					continue
+				} else {
+					transitioning = true
+					fmt.Printf("Interaction %d is in a transient state: %s, Recording it\n", i, m["status"])
+					outputCassette.AddInteraction(interaction)
+				}
+			} else {
+				if transitioning {
+					fmt.Printf("Interaction %d is not in a transient state anymore: %s, Recording it\n", i, m["status"])
+					outputCassette.AddInteraction(interaction)
+					transitioning = false
+				} else {
+					fmt.Printf("Interaction %d is not in a transient state: %s, Recording it\n", i, m["status"])
+					outputCassette.AddInteraction(interaction)
+				}
+
+			}
+		}
+	}
+
+	outputCassette.Save()
+}

cmd/vcr-viewer/main.go

@@ -0,0 +1,48 @@
+package main
+
+import (
+	"encoding/json"
+	"fmt"
+	"gopkg.in/dnaeon/go-vcr.v3/cassette"
+	"log"
+	"os"
+)
+
+func main() {
+	if len(os.Args) < 2 {
+		log.Fatalf("Usage: %s <chemin_du_fichier_yaml>\n", os.Args[0])
+	}
+
+	chemin := os.Args[1]
+	data, err := cassette.Load(chemin)
+	if err != nil {
+		log.Fatalf("Erreur de lecture du fichier : %v\n", err)
+	}
+
+	for i := 0; i < len(data.Interactions); i++ {
+		interaction := data.Interactions[i]
+		fmt.Println("--------------")
+		fmt.Printf("Interaction %d:\n", i+1)
+		fmt.Printf("  Request:\n")
+		fmt.Printf("    Method: %s\n", interaction.Request.Method)
+		fmt.Printf("    URL: %s\n", interaction.Request.URL)
+		if interaction.Request.Body != "" {
+			fmt.Printf("    Body: %s\n", interaction.Request.Body)
+		}
+		fmt.Printf("  Response:\n")
+		fmt.Printf("    Status: %s\n", interaction.Response.Status)
+		fmt.Printf("    Body: %s\n", interaction.Response.Body)
+
+		var m map[string]interface{}
+		err := json.Unmarshal([]byte(interaction.Response.Body), &m)
+		if err != nil {
+			continue
+		}
+		if m["status"] != nil {
+			fmt.Println("++++++++++++++++")
+			fmt.Printf("status: %s\n", m["status"]) // Modifie le champ "status" pour qu'il soit "ok"
+			fmt.Println("++++++++++++++++")
+		}
+		fmt.Println("--------------")
+	}
+}

internal/acctest/compress_cassettes_test.go

@@ -0,0 +1,28 @@
+package acctest_test
+
+import (
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	"gopkg.in/dnaeon/go-vcr.v3/cassette"
+	"testing"
+)
+
+func TestAccCassettes_Compressed(t *testing.T) {
+	paths, err := getTestFiles()
+	require.NoError(t, err)
+
+	for path := range paths {
+		c, err := cassette.Load(path)
+		require.NoError(t, err)
+		assert.NoError(t, checkCassetteCompressed(t, c))
+	}
+}
+
+func checkCassetteCompressed(t *testing.T, c *cassette.Cassette) error {
+	for i := 0; i < len(c.Interactions)-1; i++ {
+		if c.Interactions[i].Response.Body == c.Interactions[i+1].Response.Body {
+			t.Errorf("cassette %s contains two consecutive interactions with the same response body. Interaction %d and %d have the same body", c.Name, i, i+1)
+		}
+	}
+	return nil
+}