updating tests for first release

Author: samkreter

go.mod

@@ -0,0 +1,5 @@
+module github.com/samkreter/redact
+
+go 1.16
+
+require github.com/stretchr/testify v1.7.0

go.sum

@@ -0,0 +1,11 @@
+github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
+github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

redact.go

@@ -6,7 +6,8 @@ import (
 )
 
 const (
-	tagName = "redact"
+	tagName        = "redact"
+	RedactStrConst = "REDACTED"
 )
 
 type redactor func(string) string
@@ -125,7 +126,7 @@ func transformString(input, tagVal string) string {
 	default:
 		redactor, ok := redactors[tagVal]
 		if !ok {
-			return "REDACTED"
+			return RedactStrConst
 		}
 
 		return redactor(input)

redact_test.go

@@ -0,0 +1,105 @@
+package redact_test
+
+import (
+	"testing"
+
+	"github.com/samkreter/redact"
+	"github.com/stretchr/testify/assert"
+)
+
+const (
+	secretVal    = "thisIsASecret"
+	nonSecretVal = "thisIsAStandardVal"
+)
+
+var (
+	secretPtrVal = "thisIsAPtrSecret"
+)
+
+type TestStruct struct {
+	Secret    string
+	SecretPtr *string
+	NonSecret string `redact:"nonsecret"`
+}
+
+type TestStructList struct {
+	Data []*TestStruct
+}
+
+func TestStringTestStruct(t *testing.T) {
+	t.Run("Basic Secret Redaction", func(t *testing.T) {
+		tStruct := &TestStruct{
+			NonSecret: nonSecretVal,
+			Secret:    secretVal,
+			SecretPtr: &secretPtrVal,
+		}
+
+		err := redact.Redact(tStruct)
+		assert.NoError(t, err, "should not fail to redact struct")
+
+		assert.Equal(t, nonSecretVal, tStruct.NonSecret, "should contain non secret value")
+		assert.Equal(t, redact.RedactStrConst, tStruct.Secret, "should redact secret value")
+		assert.Equal(t, redact.RedactStrConst, *tStruct.SecretPtr, "should redact secret value")
+	})
+
+	t.Run("Should still redact empty strings", func(t *testing.T) {
+		emptyStrVal := ""
+
+		tStruct := &TestStruct{
+			NonSecret: nonSecretVal,
+			Secret:    "",
+			SecretPtr: &emptyStrVal,
+		}
+
+		err := redact.Redact(tStruct)
+		assert.NoError(t, err, "should not fail to redact struct")
+
+		assert.Equal(t, nonSecretVal, tStruct.NonSecret, "should contain non secret value")
+		assert.Equal(t, redact.RedactStrConst, tStruct.Secret, "should redact secret value")
+		assert.Equal(t, redact.RedactStrConst, *tStruct.SecretPtr, "should redact secret value")
+	})
+
+}
+
+func TestStringTestStructList(t *testing.T) {
+	t.Run("Basic Secret Redaction", func(t *testing.T) {
+		tStruct := &TestStruct{
+			NonSecret: nonSecretVal,
+			Secret:    secretVal,
+			SecretPtr: &secretPtrVal,
+		}
+
+		list := &TestStructList{
+			Data: []*TestStruct{tStruct},
+		}
+
+		err := redact.Redact(list)
+		assert.NoError(t, err, "should not fail to redact struct")
+
+		assert.Equal(t, nonSecretVal, list.Data[0].NonSecret, "should contain non secret value")
+		assert.Equal(t, redact.RedactStrConst, list.Data[0].Secret, "should redact secret value")
+		assert.Equal(t, redact.RedactStrConst, *list.Data[0].SecretPtr, "should redact secret value")
+	})
+
+	t.Run("Should still redact empty strings", func(t *testing.T) {
+		emptyStrVal := ""
+
+		tStruct := &TestStruct{
+			NonSecret: nonSecretVal,
+			Secret:    "",
+			SecretPtr: &emptyStrVal,
+		}
+
+		list := &TestStructList{
+			Data: []*TestStruct{tStruct},
+		}
+
+		err := redact.Redact(list)
+		assert.NoError(t, err, "should not fail to redact struct")
+
+		assert.Equal(t, nonSecretVal, list.Data[0].NonSecret, "should contain non secret value")
+		assert.Equal(t, redact.RedactStrConst, list.Data[0].Secret, "should redact secret value")
+		assert.Equal(t, redact.RedactStrConst, *list.Data[0].SecretPtr, "should redact secret value")
+	})
+
+}