Added unit tests.

Author: bennovw

.gitignore

@@ -0,0 +1,3 @@
+# Ignore files generated by the build process
+test_coverage.html
+coverage.out

firestruct_test.go

@@ -0,0 +1,69 @@
+package firestruct
+
+import (
+	"encoding/json"
+	"testing"
+
+	"github.com/bennovw/firestruct/internal/testutil"
+)
+
+func TestFirestoreCloudEvent(t *testing.T) {
+	var testEvent = testutil.TestFirebaseCloudEvents[0]
+	var testCloudEventBytes, _ = json.Marshal(testEvent)
+	var testCloudEvent = []byte(testCloudEventBytes)
+	var FirestoreCloudEventTests = []testutil.TableTest{
+		{
+			Name:       "data to simple struct",
+			TargetType: "DataToSimple",
+			Input:      testCloudEvent,
+			Expected:   testutil.StructResults[0],
+		},
+		{
+			Name:       "data to tagged struct",
+			TargetType: "DataToTagged",
+			Input:      testCloudEvent,
+			Expected:   testutil.StructResults[1],
+		},
+		{
+			Name:       "data to flattened map",
+			TargetType: "ToMap",
+			Input:      testCloudEvent,
+			Expected:   testutil.FlattenedMapResults[12],
+		},
+	}
+
+	for _, test := range FirestoreCloudEventTests {
+		thisMethodName := "FirestoreCloudEvent"
+
+		receivedCloudEvent := FirestoreCloudEvent{}
+		err := json.Unmarshal(testCloudEvent, &receivedCloudEvent)
+		if err != nil {
+			t.Errorf("%v() test \"%v\" returned error: %v", thisMethodName, test.Name, err)
+		}
+
+		switch test.TargetType {
+		case "DataToSimple":
+			var result testutil.TestSimpleStruct
+			err = receivedCloudEvent.DataTo(&result)
+			if err != nil {
+				t.Errorf("%v() test \"%v\" returned error: %v", thisMethodName, test.Name, err)
+			}
+			testutil.IsDeepEqual(t, thisMethodName, test.Name, result, test.Expected)
+		case "DataToTagged":
+			var result testutil.TestTaggedStruct
+			err = receivedCloudEvent.DataTo(&result)
+			if err != nil {
+				t.Errorf("%v() test \"%v\" returned error: %v", thisMethodName, test.Name, err)
+			}
+			testutil.IsDeepEqual(t, thisMethodName, test.Name, result, test.Expected)
+		case "ToMap":
+			result, err := receivedCloudEvent.ToMap()
+			if err != nil {
+				t.Errorf("%v() test \"%v\" returned error: %v", thisMethodName, test.Name, err)
+			}
+			testutil.IsDeepEqual(t, thisMethodName, test.Name, result, test.Expected)
+		default:
+			t.Errorf("%v() test \"%v\" method not covered", thisMethodName, test.Name)
+		}
+	}
+}

go.mod

@@ -16,6 +16,7 @@ require (
 require (
 	github.com/cloudevents/sdk-go/v2 v2.15.2
 	github.com/davecgh/go-spew v1.1.1
+	github.com/fatih/structs v1.1.0
 	github.com/golang/protobuf v1.5.4
 	github.com/google/go-cmp v0.6.0
 	google.golang.org/protobuf v1.34.2 // indirect

go.sum

@@ -3,6 +3,8 @@ github.com/cloudevents/sdk-go/v2 v2.15.2/go.mod h1:lL7kSWAE/V8VI4Wh0jbL2v/jvqsm6
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/fatih/structs v1.1.0 h1:Q7juDM0QtcnhCpeyLGQKyg4TOIghuNXrkL32pHAUMxo=
+github.com/fatih/structs v1.1.0/go.mod h1:9NiDSp5zOcgEDl+j00MP/WkGVPOlPRLejGD8Ga6PJ7M=
 github.com/golang/protobuf v1.5.4 h1:i7eJL8qZTpSEXOPTxNKhASYpMn+8e5Q6AdndVa1dWek=
 github.com/golang/protobuf v1.5.4/go.mod h1:lnTiLA8Wa4RWRcIUkrtSVa5nRhsEGBg48fD6rSs7xps=
 github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=

internal/testutil/cmp.go

@@ -17,7 +17,10 @@ package testutil
 import (
 	"math"
 	"math/big"
+	"reflect"
+	"testing"
 
+	"github.com/fatih/structs"
 	"github.com/golang/protobuf/proto"
 	"github.com/google/go-cmp/cmp"
 )
@@ -59,3 +62,34 @@ func Diff(x, y interface{}, opts ...cmp.Option) string {
 	opts = append(opts[:len(opts):len(opts)], defaultCmpOptions...)
 	return cmp.Diff(x, y, opts...)
 }
+
+// IsDeepEqual performs both IsMapVersionDeepEqual and IsStringVersionDeepEqual checks
+func IsDeepEqual(t *testing.T, funcName string, testSectionName string, result interface{}, expected interface{}) {
+	IsMapVersionDeepEqual(t, funcName, testSectionName, result, expected)
+	IsStringVersionDeepEqual(t, funcName, testSectionName, result, expected)
+}
+
+// IsMapVersionDeepEqual checks if the result is equal to the expected result
+func IsMapVersionDeepEqual(t *testing.T, funcName string, testSectionName string, result interface{}, expected interface{}) {
+	// Convert to maps if not already maps
+	expectedMap := asMap(expected)
+	resultMap := asMap(result)
+
+	if !reflect.DeepEqual(resultMap, expectedMap) {
+		t.Errorf("%v() test \"%v\" Result: %v Want: %v", funcName, testSectionName, result, expected)
+		return
+	}
+}
+
+// asMap converts a value to a map representation.
+func asMap(v interface{}) interface{} {
+	if v == nil {
+		return nil
+	}
+
+	t := reflect.TypeOf(v)
+	if t != nil && t.Kind() == reflect.Map {
+		return v
+	}
+	return structs.Map(v)
+}