Merge branch 'klauspost-add-remove-tls-option'

cassette.go

@@ -216,7 +216,8 @@ type cassette struct {
 	Tracks []track
 
 	// stats is not exported since it doesn't need serialising
-	stats Stats
+	stats     Stats
+	removeTLS bool
 }
 
 func (k7 *cassette) isLongPlay() bool {
@@ -286,6 +287,9 @@ func (k7 *cassette) gunzipFilter(data []byte) ([]byte, error) {
 
 // addTrack adds a track to a cassette.
 func (k7 *cassette) addTrack(track *track) {
+	if k7.removeTLS {
+		track.Response.TLS = nil
+	}
 	k7.Tracks = append(k7.Tracks, *track)
 }
 

cassette_test.go

@@ -2,6 +2,7 @@ package govcr
 
 import (
 	"bytes"
+	"crypto/tls"
 	"reflect"
 	"strings"
 	"testing"
@@ -202,3 +203,87 @@ func Test_cassetteNameToFilename(t *testing.T) {
 		})
 	}
 }
+
+func Test_cassette_addTrack(t *testing.T) {
+	type fields struct {
+		removeTLS bool
+	}
+	type args struct {
+		track track
+	}
+	tests := []struct {
+		name   string
+		fields fields
+		args   args
+	}{
+		{
+			name: "with tls, keep",
+			fields: fields{
+				removeTLS: false,
+			},
+			args: args{
+				track: track{
+					Response: response{
+						TLS: &tls.ConnectionState{},
+					},
+				},
+			},
+		},
+		{
+			name: "with tls, remove",
+			fields: fields{
+				removeTLS: true,
+			},
+			args: args{
+				track: track{
+					Response: response{
+						TLS: &tls.ConnectionState{},
+					},
+				},
+			},
+		},
+		{
+			name: "without tls, keep",
+			fields: fields{
+				removeTLS: false,
+			},
+			args: args{
+				track: track{
+					Response: response{
+						TLS: nil,
+					},
+				},
+			},
+		},
+		{
+			name: "without tls, remove",
+			fields: fields{
+				removeTLS: true,
+			},
+			args: args{
+				track: track{
+					Response: response{
+						TLS: nil,
+					},
+				},
+			},
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			k7 := &cassette{
+				Name:      tt.name,
+				Path:      tt.name,
+				removeTLS: tt.fields.removeTLS,
+			}
+			k7.addTrack(&tt.args.track)
+			gotTLS := k7.Tracks[0].Response.TLS != nil
+			if gotTLS && tt.fields.removeTLS {
+				t.Errorf("got TLS, but it should have been removed")
+			}
+			if !gotTLS && !tt.fields.removeTLS && tt.args.track.Response.TLS != nil {
+				t.Errorf("tls was removed, but shouldn't")
+			}
+		})
+	}
+}

govcr.go

@@ -39,6 +39,10 @@ type VCRConfig struct {
 	DisableRecording bool
 	Logging          bool
 	CassettePath     string
+
+	// RemoveTLS will remove TLS from the Response when recording.
+	// TLS information is rarely needed and takes up a lot of space.
+	RemoveTLS bool
 }
 
 // PCB stands for Printed Circuit Board. It is a structure that holds some
@@ -170,6 +174,7 @@ func NewVCR(cassetteName string, vcrConfig *VCRConfig) *VCRControlPanel {
 	if err != nil {
 		logger.Fatal(err)
 	}
+	cassette.removeTLS = vcrConfig.RemoveTLS
 
 	// create PCB
 	pcbr := &pcb{