Add test case

Author: iQQBot

components/scrubber/scrubber_test.go

@@ -5,6 +5,7 @@
 package scrubber
 
 import (
+	"encoding/json"
 	"math/rand"
 	"testing"
 
@@ -68,6 +69,10 @@ type TrustedStructToTest struct {
 	StructToTest
 }
 
+type TestWrap struct {
+	Test *StructToTest
+}
+
 type UnexportedStructToTest struct {
 	Exported      string
 	unexportedPtr *string
@@ -293,6 +298,171 @@ func TestJSON(t *testing.T) {
 	}
 }
 
+func TestDeepCopyStruct(t *testing.T) {
+	type Expectation struct {
+		Error  string
+		Result any
+	}
+	tests := []struct {
+		Name        string
+		Struct      any
+		Expectation Expectation
+		CmpOpts     []cmp.Option
+	}{
+		{
+			Name: "basic happy path",
+			Struct: &struct {
+				Username     string
+				Email        string
+				Password     string
+				WorkspaceID  string
+				LeaveMeAlone string
+			}{Username: "foo", Email: "[email protected]", Password: "foobar", WorkspaceID: "gitpodio-gitpod-uesaddev73c", LeaveMeAlone: "foo"},
+			Expectation: Expectation{
+				Result: &struct {
+					Username     string
+					Email        string
+					Password     string
+					WorkspaceID  string
+					LeaveMeAlone string
+				}{Username: "[redacted:md5:acbd18db4cc2f85cedef654fccc4a4d8]", Email: "[redacted]", Password: "[redacted]", WorkspaceID: "[redacted:md5:a35538939333def8477b5c19ac694b35]", LeaveMeAlone: "foo"},
+			},
+		},
+		{
+			Name: "stuct without pointer",
+			Struct: struct {
+				Username     string
+				Email        string
+				Password     string
+				WorkspaceID  string
+				LeaveMeAlone string
+			}{Username: "foo", Email: "[email protected]", Password: "foobar", WorkspaceID: "gitpodio-gitpod-uesaddev73c", LeaveMeAlone: "foo"},
+			Expectation: Expectation{
+				Result: struct {
+					Username     string
+					Email        string
+					Password     string
+					WorkspaceID  string
+					LeaveMeAlone string
+				}{Username: "[redacted:md5:acbd18db4cc2f85cedef654fccc4a4d8]", Email: "[redacted]", Password: "[redacted]", WorkspaceID: "[redacted:md5:a35538939333def8477b5c19ac694b35]", LeaveMeAlone: "foo"},
+			},
+		},
+		{
+			Name: "map field",
+			Struct: &struct {
+				WithMap map[string]interface{}
+			}{
+				WithMap: map[string]interface{}{
+					"email": "[email protected]",
+				},
+			},
+			Expectation: Expectation{
+				Result: &struct{ WithMap map[string]any }{WithMap: map[string]any{"email": string("[redacted]")}},
+			},
+		},
+		{
+			Name: "slices",
+			Struct: &struct {
+				Slice []string
+			}{Slice: []string{"foo", "bar", "[email protected]"}},
+			Expectation: Expectation{
+				Result: &struct {
+					Slice []string
+				}{Slice: []string{"foo", "bar", "[redacted:email]"}},
+			},
+		},
+		{
+			Name: "struct tags",
+			Struct: &struct {
+				Hashed   string `scrub:"hash"`
+				Redacted string `scrub:"redact"`
+				Email    string `scrub:"ignore"`
+			}{
+				Hashed:   "foo",
+				Redacted: "foo",
+				Email:    "foo",
+			},
+			Expectation: Expectation{
+				Result: &struct {
+					Hashed   string `scrub:"hash"`
+					Redacted string `scrub:"redact"`
+					Email    string `scrub:"ignore"`
+				}{
+					Hashed:   "[redacted:md5:acbd18db4cc2f85cedef654fccc4a4d8]",
+					Redacted: "[redacted]",
+					Email:    "foo",
+				},
+			},
+		},
+		{
+			Name: "trusted struct",
+			Struct: scrubStructToTest(&StructToTest{
+				Username: "foo",
+				Email:    "[email protected]",
+				Password: "foobar",
+			}),
+			Expectation: Expectation{
+				Result: &TrustedStructToTest{
+					StructToTest: StructToTest{
+						Username: "foo",
+						Email:    "trusted:[redacted:email]",
+						Password: "trusted:[redacted]",
+					},
+				},
+			},
+		},
+		{
+			Name: "trusted interface",
+			Struct: scrubStructToTestAsTrustedValue(&StructToTest{
+				Username: "foo",
+				Email:    "[email protected]",
+				Password: "foobar",
+			}),
+			Expectation: Expectation{
+				Result: &TrustedStructToTest{
+					StructToTest: StructToTest{
+						Username: "foo",
+						Email:    "trusted:[redacted:email]",
+						Password: "trusted:[redacted]",
+					},
+				},
+			},
+		},
+		{
+			Name: "contains unexported pointers",
+			Struct: UnexportedStructToTest{
+				Exported:      "foo",
+				unexportedPtr: nil,
+			},
+			Expectation: Expectation{
+				Result: UnexportedStructToTest{
+					Exported:      "foo",
+					unexportedPtr: nil,
+				},
+			},
+			CmpOpts: []cmp.Option{cmpopts.IgnoreUnexported(UnexportedStructToTest{})},
+		},
+	}
+
+	for _, test := range tests {
+		t.Run(test.Name, func(t *testing.T) {
+			var act Expectation
+			b, _ := json.Marshal(test.Struct)
+
+			act.Result = Default.DeepCopyStruct(test.Struct)
+			b2, _ := json.Marshal(test.Struct)
+
+			if diff := cmp.Diff(b, b2, test.CmpOpts...); diff != "" {
+				t.Errorf("DeepCopyStruct for origin struct modified (-want +got):\n%s", diff)
+			}
+
+			if diff := cmp.Diff(test.Expectation, act, test.CmpOpts...); diff != "" {
+				t.Errorf("DeepCopyStruct() mismatch (-want +got):\n%s", diff)
+			}
+		})
+	}
+}
+
 func BenchmarkKeyValue(b *testing.B) {
 	key := HashedFieldNames[rand.Intn(len(HashedFieldNames))]