Add unit tests for serializer (#1380)

* Add unit tests for serializer

Author: 3vilhamster

internal/common/serializer/history_serializer.go

@@ -107,7 +107,7 @@ func DeserializeBatchEvents(data *shared.DataBlob) ([]*shared.HistoryEvent, erro
 		return nil, nil
 	}
 	var events []*shared.HistoryEvent
-	if data != nil && len(data.Data) == 0 {
+	if len(data.Data) == 0 {
 		return events, nil
 	}
 	err := deserialize(data, &events)
@@ -171,7 +171,6 @@ func deserialize(data *shared.DataBlob, target interface{}) error {
 		err = thriftrwDecode(data.Data, target)
 	case shared.EncodingTypeJSON: // For backward-compatibility
 		err = json.Unmarshal(data.Data, target)
-
 	}
 
 	if err != nil {

internal/common/serializer/history_serializer_test.go

@@ -0,0 +1,203 @@
+// Copyright (c) 2017-2021 Uber Technologies Inc.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+package serializer
+
+import (
+	"reflect"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+
+	"go.uber.org/cadence/.gen/go/shared"
+	"go.uber.org/cadence/internal/common"
+)
+
+func TestSerializationRoundup(t *testing.T) {
+	for _, encoding := range []shared.EncodingType{shared.EncodingTypeJSON, shared.EncodingTypeThriftRW} {
+		t.Run(encoding.String(), func(t *testing.T) {
+
+			events := []*shared.HistoryEvent{
+				{
+					EventId:   common.Int64Ptr(1),
+					Timestamp: common.Int64Ptr(1),
+					EventType: common.EventTypePtr(shared.EventTypeActivityTaskCompleted),
+					Version:   common.Int64Ptr(1),
+					ActivityTaskCompletedEventAttributes: &shared.ActivityTaskCompletedEventAttributes{
+						Result: []byte("result"),
+					},
+				},
+			}
+
+			serialized, err := SerializeBatchEvents(events, encoding)
+			require.NoError(t, err)
+
+			deserialized, err := DeserializeBatchEvents(serialized)
+			require.NoError(t, err)
+
+			assert.Equal(t, events, deserialized)
+		})
+	}
+}
+
+func TestDeserializeBlobDataToHistoryEvents(t *testing.T) {
+	events := []*shared.HistoryEvent{
+		{
+			EventId:   common.Int64Ptr(1),
+			Timestamp: common.Int64Ptr(1),
+			EventType: common.EventTypePtr(shared.EventTypeDecisionTaskStarted),
+			Version:   common.Int64Ptr(1),
+			DecisionTaskStartedEventAttributes: &shared.DecisionTaskStartedEventAttributes{
+				ScheduledEventId: common.Int64Ptr(1),
+			},
+		},
+		{
+			EventId:   common.Int64Ptr(1),
+			Timestamp: common.Int64Ptr(1),
+			EventType: common.EventTypePtr(shared.EventTypeActivityTaskCompleted),
+			Version:   common.Int64Ptr(1),
+			ActivityTaskCompletedEventAttributes: &shared.ActivityTaskCompletedEventAttributes{
+				Result: []byte("result"),
+			},
+		},
+	}
+
+	serialized, err := SerializeBatchEvents(events, shared.EncodingTypeThriftRW)
+	require.NoError(t, err)
+
+	deserialized, err := DeserializeBlobDataToHistoryEvents([]*shared.DataBlob{serialized}, shared.HistoryEventFilterTypeCloseEvent)
+	require.NoError(t, err)
+
+	assert.Equal(t, events[1], deserialized.Events[0])
+}
+
+func TestDeserializeBlobDataToHistoryEvents_failure(t *testing.T) {
+	for _, tc := range []struct {
+		name              string
+		serialized        *shared.DataBlob
+		expectedErrString string
+	}{
+		{
+			name:              "empty blob",
+			serialized:        &shared.DataBlob{},
+			expectedErrString: "corrupted history event batch, empty events",
+		},
+		{
+			name:              "corrupted blob",
+			serialized:        &shared.DataBlob{Data: []byte("corrupted"), EncodingType: shared.EncodingTypeThriftRW.Ptr()},
+			expectedErrString: "BadRequestError{Message: Invalid binary encoding version.}",
+		},
+	} {
+		t.Run(tc.name, func(t *testing.T) {
+			_, err := DeserializeBlobDataToHistoryEvents([]*shared.DataBlob{tc.serialized}, shared.HistoryEventFilterTypeCloseEvent)
+			assert.ErrorContains(t, err, tc.expectedErrString)
+		})
+	}
+}
+
+func TestThriftEncodingRoundtrip(t *testing.T) {
+	for _, tc := range []struct {
+		input interface{}
+	}{
+		{
+			input: &shared.HistoryEvent{
+				EventId:   common.Int64Ptr(1),
+				EventType: shared.EventTypeDecisionTaskStarted.Ptr(),
+			},
+		},
+		{
+			input: &shared.Memo{
+				Fields: map[string][]byte{"key": []byte("value")},
+			},
+		},
+		{
+			input: &shared.ResetPoints{
+				Points: []*shared.ResetPointInfo{
+					{
+						BinaryChecksum: common.StringPtr("checksum"),
+					},
+				},
+			},
+		},
+		{
+			input: &shared.BadBinaries{
+				Binaries: map[string]*shared.BadBinaryInfo{
+					"key": {
+						Reason: common.StringPtr("reason"),
+					},
+				},
+			},
+		},
+		{
+			input: &shared.VersionHistories{
+				CurrentVersionHistoryIndex: common.Int32Ptr(1),
+			},
+		},
+		{
+			input: nil,
+		},
+	} {
+		name := "nil"
+		if tc.input != nil {
+			name = reflect.TypeOf(tc.input).String()
+		}
+		t.Run(name, func(t *testing.T) {
+			serialized, err := thriftrwEncode(tc.input)
+			require.NoError(t, err)
+
+			var deserialized interface{}
+			if tc.input != nil {
+				deserialized = createEmptyPointer(tc.input)
+				err = thriftrwDecode(serialized, deserialized)
+				require.NoError(t, err)
+			}
+
+			assert.Equal(t, tc.input, deserialized)
+		})
+	}
+}
+
+func TestSerialization_corner_cases(t *testing.T) {
+	t.Run("nil", func(t *testing.T) {
+		res, err := serialize(nil, shared.EncodingTypeThriftRW)
+		assert.Nil(t, res)
+		assert.NoError(t, err)
+	})
+	t.Run("unsupported encoding", func(t *testing.T) {
+		_, err := SerializeBatchEvents(nil, -1)
+		assert.ErrorContains(t, err, "unknown or unsupported encoding type")
+	})
+	t.Run("serialization error", func(t *testing.T) {
+		res, err := Encode(nil)
+		assert.Nil(t, res)
+		assert.ErrorIs(t, err, MsgPayloadNotThriftEncoded)
+	})
+}
+
+func createEmptyPointer(input interface{}) interface{} {
+	inputType := reflect.TypeOf(input)
+	if inputType.Kind() != reflect.Ptr {
+		panic("input must be a pointer to a struct")
+	}
+	elemType := inputType.Elem()
+	newInstance := reflect.New(elemType)
+	return newInstance.Interface()
+}