forked from cadence-workflow/cadence
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[code-coverage] Introduced first set of tests for taskHandler in serv…
…ice/history/decision (cadence-workflow#5960) * [code-coverage] More test cases for HandleDecisionTaskCompleted * Initial tests for task handler funcs * copyright & lint task_handler_test.go
- Loading branch information
1 parent
95a0c1e
commit bf088f2
Showing
2 changed files
with
387 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,254 @@ | ||
| // The MIT License (MIT) | ||
|
|
||
| // Copyright (c) 2017-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 decision | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "testing" | ||
|
|
||
| "github.com/golang/mock/gomock" | ||
| "github.com/stretchr/testify/assert" | ||
| "github.com/uber-go/tally" | ||
|
|
||
| "github.com/uber/cadence/common" | ||
| "github.com/uber/cadence/common/cache" | ||
| "github.com/uber/cadence/common/log/testlogger" | ||
| "github.com/uber/cadence/common/metrics" | ||
| "github.com/uber/cadence/common/persistence" | ||
| "github.com/uber/cadence/common/types" | ||
| "github.com/uber/cadence/common/types/testdata" | ||
| "github.com/uber/cadence/service/history/config" | ||
| "github.com/uber/cadence/service/history/constants" | ||
| "github.com/uber/cadence/service/history/execution" | ||
| ) | ||
|
|
||
| const ( | ||
| testTaskCompletedID = int64(123) | ||
| ) | ||
|
|
||
| func TestHandleDecisionRequestCancelExternalWorkflow(t *testing.T) { | ||
| tests := []struct { | ||
| name string | ||
| expectMockCalls func(taskHandler *taskHandlerImpl) | ||
| attributes *types.RequestCancelExternalWorkflowExecutionDecisionAttributes | ||
| asserts func(t *testing.T, taskHandler *taskHandlerImpl, err error) | ||
| }{ | ||
| { | ||
| name: "success", | ||
| attributes: &types.RequestCancelExternalWorkflowExecutionDecisionAttributes{ | ||
| Domain: constants.TestDomainName, | ||
| WorkflowID: constants.TestWorkflowID, | ||
| RunID: constants.TestRunID, | ||
| Control: nil, | ||
| ChildWorkflowOnly: false, | ||
| }, | ||
| expectMockCalls: func(taskHandler *taskHandlerImpl) { | ||
| taskHandler.domainCache.(*cache.MockDomainCache).EXPECT().GetDomain(constants.TestDomainName).Return(constants.TestLocalDomainEntry, nil) | ||
| }, | ||
| asserts: func(t *testing.T, taskHandler *taskHandlerImpl, err error) { | ||
| assert.False(t, taskHandler.failDecision) | ||
| assert.Empty(t, taskHandler.failMessage) | ||
| assert.Nil(t, taskHandler.failDecisionCause) | ||
| assert.Equal(t, nil, err) | ||
|
|
||
| }, | ||
| }, | ||
| { | ||
| name: "internal service error", | ||
| attributes: &types.RequestCancelExternalWorkflowExecutionDecisionAttributes{ | ||
| Domain: constants.TestDomainName, | ||
| WorkflowID: constants.TestWorkflowID, | ||
| RunID: constants.TestRunID, | ||
| Control: nil, | ||
| ChildWorkflowOnly: false, | ||
| }, | ||
| expectMockCalls: func(taskHandler *taskHandlerImpl) { | ||
| taskHandler.domainCache.(*cache.MockDomainCache).EXPECT().GetDomain(constants.TestDomainName).Return(nil, errors.New("some error getting domain cache")) | ||
| }, | ||
| asserts: func(t *testing.T, taskHandler *taskHandlerImpl, err error) { | ||
| assert.Equal(t, &types.InternalServiceError{Message: "Unable to cancel workflow across domain: some random domain name."}, err) | ||
| }, | ||
| }, | ||
| { | ||
| name: "attributes validation failure", | ||
| asserts: func(t *testing.T, taskHandler *taskHandlerImpl, err error) { | ||
| assert.True(t, taskHandler.failDecision) | ||
| assert.NotNil(t, taskHandler.failMessage) | ||
| assert.Equal(t, func(i int32) *types.DecisionTaskFailedCause { | ||
| cause := new(types.DecisionTaskFailedCause) | ||
| *cause = types.DecisionTaskFailedCause(i) | ||
| return cause | ||
| }(9), taskHandler.failDecisionCause) | ||
| }, | ||
| }, | ||
| } | ||
| for _, test := range tests { | ||
| t.Run(test.name, func(t *testing.T) { | ||
| taskHandler := newTaskHandlerForTest(t) | ||
| taskHandler.mutableState.(*execution.MockMutableState).EXPECT().GetExecutionInfo().Times(1).Return(&persistence.WorkflowExecutionInfo{ | ||
| DomainID: constants.TestDomainID, | ||
| WorkflowID: constants.TestWorkflowID, | ||
| RunID: constants.TestRunID, | ||
| }) | ||
| taskHandler.mutableState.(*execution.MockMutableState).EXPECT().AddRequestCancelExternalWorkflowExecutionInitiatedEvent(testTaskCompletedID, gomock.Any(), test.attributes).AnyTimes() | ||
| if test.expectMockCalls != nil { | ||
| test.expectMockCalls(taskHandler) | ||
| } | ||
| err := taskHandler.handleDecisionRequestCancelExternalWorkflow(context.Background(), test.attributes) | ||
| test.asserts(t, taskHandler, err) | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func TestHandleDecisionRequestCancelActivity(t *testing.T) { | ||
| tests := []struct { | ||
| name string | ||
| expectMockCalls func(taskHandler *taskHandlerImpl) | ||
| attributes *types.RequestCancelActivityTaskDecisionAttributes | ||
| asserts func(t *testing.T, taskHandler *taskHandlerImpl, err error) | ||
| }{ | ||
| { | ||
| name: "success", | ||
| attributes: &types.RequestCancelActivityTaskDecisionAttributes{ActivityID: testdata.ActivityID}, | ||
| expectMockCalls: func(taskHandler *taskHandlerImpl) { | ||
| taskHandler.mutableState.(*execution.MockMutableState).EXPECT().AddActivityTaskCancelRequestedEvent( | ||
| testTaskCompletedID, | ||
| testdata.ActivityID, | ||
| testdata.Identity, | ||
| ).Times(1).Return(&types.HistoryEvent{}, &persistence.ActivityInfo{StartedID: common.EmptyEventID}, nil) | ||
| taskHandler.mutableState.(*execution.MockMutableState).EXPECT().AddActivityTaskCanceledEvent(int64(0), int64(-23), int64(0), []byte(activityCancellationMsgActivityNotStarted), testdata.Identity).Return(nil, nil) | ||
| }, | ||
| asserts: func(t *testing.T, taskHandler *taskHandlerImpl, err error) { | ||
| assert.False(t, taskHandler.failDecision) | ||
| assert.Empty(t, taskHandler.failMessage) | ||
| assert.Nil(t, taskHandler.failDecisionCause) | ||
| assert.Equal(t, nil, err) | ||
|
|
||
| }, | ||
| }, | ||
| { | ||
| name: "AddActivityTaskCanceledEvent failure", | ||
| attributes: &types.RequestCancelActivityTaskDecisionAttributes{ActivityID: testdata.ActivityID}, | ||
| expectMockCalls: func(taskHandler *taskHandlerImpl) { | ||
| taskHandler.mutableState.(*execution.MockMutableState).EXPECT().AddActivityTaskCancelRequestedEvent( | ||
| testTaskCompletedID, | ||
| testdata.ActivityID, | ||
| testdata.Identity, | ||
| ).Times(1).Return(&types.HistoryEvent{}, &persistence.ActivityInfo{StartedID: common.EmptyEventID}, nil) | ||
| taskHandler.mutableState.(*execution.MockMutableState).EXPECT().AddActivityTaskCanceledEvent(int64(0), int64(-23), int64(0), []byte(activityCancellationMsgActivityNotStarted), testdata.Identity).Return(nil, errors.New("some random error")) | ||
| }, | ||
| asserts: func(t *testing.T, taskHandler *taskHandlerImpl, err error) { | ||
| assert.Equal(t, errors.New("some random error"), err) | ||
| }, | ||
| }, | ||
| { | ||
| name: "AddRequestCancelActivityTaskFailedEvent failure", | ||
| attributes: &types.RequestCancelActivityTaskDecisionAttributes{ActivityID: testdata.ActivityID}, | ||
| expectMockCalls: func(taskHandler *taskHandlerImpl) { | ||
| taskHandler.mutableState.(*execution.MockMutableState).EXPECT().AddActivityTaskCancelRequestedEvent( | ||
| testTaskCompletedID, | ||
| testdata.ActivityID, | ||
| testdata.Identity, | ||
| ).Times(1).Return(&types.HistoryEvent{}, &persistence.ActivityInfo{StartedID: common.EmptyEventID}, &types.BadRequestError{Message: "some types.BadRequestError error"}) | ||
| taskHandler.mutableState.(*execution.MockMutableState).EXPECT().AddRequestCancelActivityTaskFailedEvent(testTaskCompletedID, testdata.ActivityID, activityCancellationMsgActivityIDUnknown).Return(nil, errors.New("some random error")) | ||
| }, | ||
| asserts: func(t *testing.T, taskHandler *taskHandlerImpl, err error) { | ||
| assert.Equal(t, errors.New("some random error"), err) | ||
| }, | ||
| }, | ||
| { | ||
| name: "default switch case error", | ||
| attributes: &types.RequestCancelActivityTaskDecisionAttributes{ActivityID: testdata.ActivityID}, | ||
| expectMockCalls: func(taskHandler *taskHandlerImpl) { | ||
| taskHandler.mutableState.(*execution.MockMutableState).EXPECT().AddActivityTaskCancelRequestedEvent( | ||
| testTaskCompletedID, | ||
| testdata.ActivityID, | ||
| testdata.Identity, | ||
| ).Times(1).Return(&types.HistoryEvent{}, &persistence.ActivityInfo{StartedID: common.EmptyEventID}, errors.New("some default error")) | ||
| }, | ||
| asserts: func(t *testing.T, taskHandler *taskHandlerImpl, err error) { | ||
| assert.Equal(t, errors.New("some default error"), err) | ||
| }, | ||
| }, | ||
| { | ||
| name: "attributes validation failure", | ||
| asserts: func(t *testing.T, taskHandler *taskHandlerImpl, err error) { | ||
| assert.True(t, taskHandler.failDecision) | ||
| assert.NotNil(t, taskHandler.failMessage) | ||
| assert.Equal(t, func(i int32) *types.DecisionTaskFailedCause { | ||
| cause := new(types.DecisionTaskFailedCause) | ||
| *cause = types.DecisionTaskFailedCause(i) | ||
| return cause | ||
| }(2), taskHandler.failDecisionCause) | ||
| }, | ||
| }, | ||
| } | ||
| for _, test := range tests { | ||
| t.Run(test.name, func(t *testing.T) { | ||
| taskHandler := newTaskHandlerForTest(t) | ||
| taskHandler.mutableState.(*execution.MockMutableState).EXPECT().AddRequestCancelExternalWorkflowExecutionInitiatedEvent(testTaskCompletedID, gomock.Any(), test.attributes).AnyTimes() | ||
| if test.expectMockCalls != nil { | ||
| test.expectMockCalls(taskHandler) | ||
| } | ||
| err := taskHandler.handleDecisionRequestCancelActivity(context.Background(), test.attributes) | ||
| test.asserts(t, taskHandler, err) | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func newTaskHandlerForTest(t *testing.T) *taskHandlerImpl { | ||
| ctrl := gomock.NewController(t) | ||
| testLogger := testlogger.New(t) | ||
| testConfig := config.NewForTest() | ||
| mockMutableState := execution.NewMockMutableState(ctrl) | ||
| mockDomainCache := cache.NewMockDomainCache(ctrl) | ||
| workflowSizeChecker := newWorkflowSizeChecker( | ||
| testConfig.BlobSizeLimitWarn(constants.TestDomainName), | ||
| testConfig.BlobSizeLimitError(constants.TestDomainName), | ||
| testConfig.HistorySizeLimitWarn(constants.TestDomainName), | ||
| testConfig.HistorySizeLimitError(constants.TestDomainName), | ||
| testConfig.HistoryCountLimitWarn(constants.TestDomainName), | ||
| testConfig.HistoryCountLimitError(constants.TestDomainName), | ||
| testTaskCompletedID, | ||
| mockMutableState, | ||
| &persistence.ExecutionStats{}, | ||
| metrics.NewClient(tally.NoopScope, metrics.History).Scope(metrics.HistoryRespondDecisionTaskCompletedScope, metrics.DomainTag(constants.TestDomainName)), | ||
| testLogger, | ||
| ) | ||
| mockMutableState.EXPECT().HasBufferedEvents().Return(false) | ||
| taskHandler := newDecisionTaskHandler( | ||
| testdata.Identity, | ||
| testTaskCompletedID, | ||
| constants.TestLocalDomainEntry, | ||
| mockMutableState, | ||
| newAttrValidator(mockDomainCache, metrics.NewClient(tally.NoopScope, metrics.History), testConfig, testlogger.New(t)), | ||
| workflowSizeChecker, | ||
| common.NewMockTaskTokenSerializer(ctrl), | ||
| testLogger, | ||
| mockDomainCache, | ||
| metrics.NewClient(tally.NoopScope, metrics.History), | ||
| testConfig, | ||
| ) | ||
| return taskHandler | ||
| } |