Files
tasks/common/persistence/serialization/task_serializer_test.go
Yu XiaandGitHub e062de1ff6 Handle delete history branch (#2591)
* Add branch token to workflow cleanup task
2022-03-08 15:52:43 -08:00

342 lines
11 KiB
Go

// The MIT License
//
// Copyright (c) 2020 Temporal Technologies Inc. All rights reserved.
//
// Copyright (c) 2020 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 serialization
import (
"math/rand"
"testing"
"time"
"github.com/google/uuid"
"github.com/stretchr/testify/require"
"github.com/stretchr/testify/suite"
enumspb "go.temporal.io/api/enums/v1"
enumsspb "go.temporal.io/server/api/enums/v1"
"go.temporal.io/server/common/definition"
"go.temporal.io/server/common/shuffle"
"go.temporal.io/server/service/history/tasks"
)
type (
taskSerializerSuite struct {
suite.Suite
*require.Assertions
workflowKey definition.WorkflowKey
taskSerializer *TaskSerializer
}
)
func TestTaskSerializerSuite(t *testing.T) {
suite.Run(t, new(taskSerializerSuite))
}
func (s *taskSerializerSuite) SetupSuite() {
}
func (s *taskSerializerSuite) TearDownSuite() {
}
func (s *taskSerializerSuite) SetupTest() {
s.Assertions = require.New(s.T())
s.workflowKey = definition.NewWorkflowKey(
"random namespace ID",
"random workflow ID",
"random run ID",
)
s.taskSerializer = NewTaskSerializer()
}
func (s *taskSerializerSuite) TearDownTest() {
}
func (s *taskSerializerSuite) TestTransferWorkflowTask() {
workflowTask := &tasks.WorkflowTask{
WorkflowKey: s.workflowKey,
VisibilityTimestamp: time.Unix(0, rand.Int63()).UTC(),
TaskID: rand.Int63(),
TaskQueue: shuffle.String("random task queue name"),
ScheduleID: rand.Int63(),
Version: rand.Int63(),
}
s.assertEqualTasks(workflowTask)
}
func (s *taskSerializerSuite) TestTransferActivityTask() {
activityTask := &tasks.ActivityTask{
WorkflowKey: s.workflowKey,
VisibilityTimestamp: time.Unix(0, rand.Int63()).UTC(),
TaskID: rand.Int63(),
TargetNamespaceID: uuid.New().String(),
TaskQueue: shuffle.String("random task queue name"),
ScheduleID: rand.Int63(),
Version: rand.Int63(),
}
s.assertEqualTasks(activityTask)
}
func (s *taskSerializerSuite) TestTransferRequestCancelTask() {
requestCancelTask := &tasks.CancelExecutionTask{
WorkflowKey: s.workflowKey,
VisibilityTimestamp: time.Unix(0, rand.Int63()).UTC(),
TaskID: rand.Int63(),
TargetNamespaceID: uuid.New().String(),
TargetWorkflowID: uuid.New().String(),
TargetRunID: uuid.New().String(),
TargetChildWorkflowOnly: rand.Int63()%2 == 0,
InitiatedID: rand.Int63(),
Version: rand.Int63(),
}
s.assertEqualTasks(requestCancelTask)
}
func (s *taskSerializerSuite) TestTransferSignalTask() {
signalTask := &tasks.SignalExecutionTask{
WorkflowKey: s.workflowKey,
VisibilityTimestamp: time.Unix(0, rand.Int63()).UTC(),
TaskID: rand.Int63(),
TargetNamespaceID: uuid.New().String(),
TargetWorkflowID: uuid.New().String(),
TargetRunID: uuid.New().String(),
TargetChildWorkflowOnly: rand.Int63()%2 == 0,
InitiatedID: rand.Int63(),
Version: rand.Int63(),
}
s.assertEqualTasks(signalTask)
}
func (s *taskSerializerSuite) TestTransferChildWorkflowTask() {
childWorkflowTask := &tasks.StartChildExecutionTask{
WorkflowKey: s.workflowKey,
VisibilityTimestamp: time.Unix(0, rand.Int63()).UTC(),
TaskID: rand.Int63(),
TargetNamespaceID: uuid.New().String(),
TargetWorkflowID: uuid.New().String(),
InitiatedID: rand.Int63(),
Version: rand.Int63(),
}
s.assertEqualTasks(childWorkflowTask)
}
func (s *taskSerializerSuite) TestTransferCloseTask() {
closeTask := &tasks.CloseExecutionTask{
WorkflowKey: s.workflowKey,
VisibilityTimestamp: time.Unix(0, rand.Int63()).UTC(),
TaskID: rand.Int63(),
Version: rand.Int63(),
}
s.assertEqualTasks(closeTask)
}
func (s *taskSerializerSuite) TestTransferResetTask() {
resetTask := &tasks.ResetWorkflowTask{
WorkflowKey: s.workflowKey,
VisibilityTimestamp: time.Unix(0, rand.Int63()).UTC(),
TaskID: rand.Int63(),
Version: rand.Int63(),
}
s.assertEqualTasks(resetTask)
}
func (s *taskSerializerSuite) TestTimerWorkflowTask() {
workflowTaskTimer := &tasks.WorkflowTaskTimeoutTask{
WorkflowKey: s.workflowKey,
VisibilityTimestamp: time.Unix(0, rand.Int63()).UTC(),
TaskID: rand.Int63(),
EventID: rand.Int63(),
ScheduleAttempt: rand.Int31(),
TimeoutType: enumspb.TimeoutType(rand.Int31n(int32(len(enumspb.TimeoutType_name)))),
Version: rand.Int63(),
}
s.assertEqualTasks(workflowTaskTimer)
}
func (s *taskSerializerSuite) TestTimerWorkflowDelayTask() {
workflowDelayTimer := &tasks.WorkflowBackoffTimerTask{
WorkflowKey: s.workflowKey,
VisibilityTimestamp: time.Unix(0, rand.Int63()).UTC(),
TaskID: rand.Int63(),
WorkflowBackoffType: enumsspb.WorkflowBackoffType(rand.Int31n(int32(len(enumsspb.WorkflowBackoffType_name)))),
Version: rand.Int63(),
}
s.assertEqualTasks(workflowDelayTimer)
}
func (s *taskSerializerSuite) TestTimerActivityTask() {
activityTaskTimer := &tasks.ActivityTimeoutTask{
WorkflowKey: s.workflowKey,
VisibilityTimestamp: time.Unix(0, rand.Int63()).UTC(),
TaskID: rand.Int63(),
EventID: rand.Int63(),
Attempt: rand.Int31(),
TimeoutType: enumspb.TimeoutType(rand.Int31n(int32(len(enumspb.TimeoutType_name)))),
Version: rand.Int63(),
}
s.assertEqualTasks(activityTaskTimer)
}
func (s *taskSerializerSuite) TestTimerActivityRetryTask() {
activityRetryTimer := &tasks.ActivityRetryTimerTask{
WorkflowKey: s.workflowKey,
VisibilityTimestamp: time.Unix(0, rand.Int63()).UTC(),
TaskID: rand.Int63(),
EventID: rand.Int63(),
Attempt: rand.Int31(),
Version: rand.Int63(),
}
s.assertEqualTasks(activityRetryTimer)
}
func (s *taskSerializerSuite) TestTimerUserTask() {
userTimer := &tasks.UserTimerTask{
WorkflowKey: s.workflowKey,
VisibilityTimestamp: time.Unix(0, rand.Int63()).UTC(),
TaskID: rand.Int63(),
EventID: rand.Int63(),
Version: rand.Int63(),
}
s.assertEqualTasks(userTimer)
}
func (s *taskSerializerSuite) TestTimerWorkflowRun() {
workflowTimer := &tasks.WorkflowTimeoutTask{
WorkflowKey: s.workflowKey,
VisibilityTimestamp: time.Unix(0, rand.Int63()).UTC(),
TaskID: rand.Int63(),
Version: rand.Int63(),
}
s.assertEqualTasks(workflowTimer)
}
func (s *taskSerializerSuite) TestTimerWorkflowCleanupTask() {
workflowCleanupTimer := &tasks.DeleteHistoryEventTask{
WorkflowKey: s.workflowKey,
VisibilityTimestamp: time.Unix(0, rand.Int63()).UTC(),
TaskID: rand.Int63(),
Version: rand.Int63(),
BranchToken: []byte{123},
}
s.assertEqualTasks(workflowCleanupTimer)
}
func (s *taskSerializerSuite) TestVisibilityStartTask() {
visibilityStart := &tasks.StartExecutionVisibilityTask{
WorkflowKey: s.workflowKey,
VisibilityTimestamp: time.Unix(0, rand.Int63()).UTC(),
TaskID: rand.Int63(),
Version: rand.Int63(),
}
s.assertEqualTasks(visibilityStart)
}
func (s *taskSerializerSuite) TestVisibilityUpsertTask() {
visibilityUpsert := &tasks.UpsertExecutionVisibilityTask{
WorkflowKey: s.workflowKey,
VisibilityTimestamp: time.Unix(0, rand.Int63()).UTC(),
TaskID: rand.Int63(),
Version: rand.Int63(),
}
s.assertEqualTasks(visibilityUpsert)
}
func (s *taskSerializerSuite) TestVisibilityCloseTask() {
visibilityClose := &tasks.CloseExecutionVisibilityTask{
WorkflowKey: s.workflowKey,
VisibilityTimestamp: time.Unix(0, rand.Int63()).UTC(),
TaskID: rand.Int63(),
Version: rand.Int63(),
}
s.assertEqualTasks(visibilityClose)
}
func (s *taskSerializerSuite) TestVisibilityDeleteTask() {
visibilityDelete := &tasks.CloseExecutionVisibilityTask{
WorkflowKey: s.workflowKey,
VisibilityTimestamp: time.Unix(0, rand.Int63()).UTC(),
TaskID: rand.Int63(),
Version: rand.Int63(),
}
s.assertEqualTasks(visibilityDelete)
}
func (s *taskSerializerSuite) TestReplicateActivityTask() {
replicateActivityTask := &tasks.SyncActivityTask{
WorkflowKey: s.workflowKey,
VisibilityTimestamp: time.Unix(0, 0).UTC(), // go == compare for location as well which is striped during marshaling/unmarshaling
TaskID: rand.Int63(),
Version: rand.Int63(),
ScheduledID: rand.Int63(),
}
s.assertEqualTasks(replicateActivityTask)
}
func (s *taskSerializerSuite) TestReplicateHistoryTask() {
replicateHistoryTask := &tasks.HistoryReplicationTask{
WorkflowKey: s.workflowKey,
VisibilityTimestamp: time.Unix(0, 0).UTC(), // go == compare for location as well which is striped during marshaling/unmarshaling
TaskID: rand.Int63(),
Version: rand.Int63(),
FirstEventID: rand.Int63(),
NextEventID: rand.Int63(),
BranchToken: shuffle.Bytes([]byte("random branch token")),
NewRunBranchToken: shuffle.Bytes([]byte("random new branch token")),
}
s.assertEqualTasks(replicateHistoryTask)
}
func (s *taskSerializerSuite) assertEqualTasks(
task tasks.Task,
) {
blob, err := s.taskSerializer.SerializeTask(task)
s.NoError(err)
deserializedTask, err := s.taskSerializer.DeserializeTask(task.GetCategory(), blob)
s.NoError(err)
s.Equal(task, deserializedTask)
}