Files
tasks/service/history/ndc/branch_manager_test.go
Alex ShtinandGitHub 8e8f1b0f7c Remove license header from every file (#7689)
## What changed?
<!-- Describe what has changed in this PR -->
Remove license header from every file. Because it is really hard to
follow in this PR here is the summary:
1. License header is removed from all `.go` and `.proto` files
:fireworks::fireworks:🎆.
2. `LICENSE` file in the root directory has only Temporal and Uber
copyrights.
3. 5 other `LICENSE` files added to the packages which have copyrights
different from Temporal and Uber: Datadog, Xargin, "Mat Ryer, Tyler
Bunnell and contributors".
4. `license_file` flag is removed from all code generation tools.
5. `copyright_file` flag is removed from `go:generate mockgen`
directive.
6. All copyright related targets are removed from `Makefile`.
7. Updated Temporal copyright year to 2025 everywhere.

## Why?
<!-- Tell your future self why have you made these changes -->
I double checked with legal department that it is not needed to have
license header in every file. One file per repo is enough. I put all
copyrights to the root `LICENSE` file and removed header from all other
files. Also updated tools and `Makefile`.
2025-05-01 18:50:21 -07:00

402 lines
14 KiB
Go

package ndc
import (
"context"
"testing"
"github.com/pborman/uuid"
"github.com/stretchr/testify/require"
"github.com/stretchr/testify/suite"
historyspb "go.temporal.io/server/api/history/v1"
persistencespb "go.temporal.io/server/api/persistence/v1"
"go.temporal.io/server/common/cluster"
"go.temporal.io/server/common/log"
"go.temporal.io/server/common/persistence"
"go.temporal.io/server/common/persistence/versionhistory"
serviceerrors "go.temporal.io/server/common/serviceerror"
historyi "go.temporal.io/server/service/history/interfaces"
"go.temporal.io/server/service/history/shard"
"go.temporal.io/server/service/history/tests"
"go.uber.org/mock/gomock"
)
type (
branchMgrSuite struct {
suite.Suite
*require.Assertions
controller *gomock.Controller
mockShard *shard.ContextTest
mockContext *historyi.MockWorkflowContext
mockMutableState *historyi.MockMutableState
mockClusterMetadata *cluster.MockMetadata
mockExecutionManager *persistence.MockExecutionManager
logger log.Logger
branchIndex int
namespaceID string
workflowID string
runID string
nDCBranchMgr *BranchMgrImpl
}
)
func TestBranchMgrSuite(t *testing.T) {
s := new(branchMgrSuite)
suite.Run(t, s)
}
func (s *branchMgrSuite) SetupTest() {
s.Assertions = require.New(s.T())
s.controller = gomock.NewController(s.T())
s.mockContext = historyi.NewMockWorkflowContext(s.controller)
s.mockMutableState = historyi.NewMockMutableState(s.controller)
s.mockShard = shard.NewTestContext(
s.controller,
&persistencespb.ShardInfo{
ShardId: 10,
RangeId: 1,
},
tests.NewDynamicConfig(),
)
s.mockExecutionManager = s.mockShard.Resource.ExecutionMgr
s.mockClusterMetadata = s.mockShard.Resource.ClusterMetadata
s.mockClusterMetadata.EXPECT().GetCurrentClusterName().Return(cluster.TestCurrentClusterName).AnyTimes()
s.logger = s.mockShard.GetLogger()
s.namespaceID = uuid.New()
s.workflowID = "some random workflow ID"
s.runID = uuid.New()
s.branchIndex = 0
s.nDCBranchMgr = NewBranchMgr(
s.mockShard, s.mockContext, s.mockMutableState, s.logger,
)
}
func (s *branchMgrSuite) TearDownTest() {
s.controller.Finish()
s.mockShard.StopForTest()
}
func (s *branchMgrSuite) TestCreateNewBranch() {
baseBranchToken := []byte("some random base branch token")
baseBranchLCAEventVersion := int64(200)
baseBranchLCAEventID := int64(1394)
baseBranchLastEventVersion := int64(400)
baseBranchLastEventID := int64(2333)
versionHistory := versionhistory.NewVersionHistory(baseBranchToken, []*historyspb.VersionHistoryItem{
versionhistory.NewVersionHistoryItem(10, 0),
versionhistory.NewVersionHistoryItem(50, 100),
versionhistory.NewVersionHistoryItem(baseBranchLCAEventID, baseBranchLCAEventVersion),
versionhistory.NewVersionHistoryItem(baseBranchLastEventID, baseBranchLastEventVersion),
})
versionHistories := versionhistory.NewVersionHistories(versionHistory)
newBranchToken := []byte("some random new branch token")
newVersionHistory, err := versionhistory.CopyVersionHistoryUntilLCAVersionHistoryItem(versionHistory,
versionhistory.NewVersionHistoryItem(baseBranchLCAEventID, baseBranchLCAEventVersion),
)
s.NoError(err)
s.mockMutableState.EXPECT().GetExecutionInfo().Return(&persistencespb.WorkflowExecutionInfo{
NamespaceId: s.namespaceID,
WorkflowId: s.workflowID,
VersionHistories: versionHistories,
}).AnyTimes()
s.mockMutableState.EXPECT().GetExecutionState().Return(&persistencespb.WorkflowExecutionState{
RunId: s.runID,
}).AnyTimes()
shardID := s.mockShard.GetShardID()
s.mockExecutionManager.EXPECT().ForkHistoryBranch(gomock.Any(), gomock.Any()).DoAndReturn(
func(_ context.Context, input *persistence.ForkHistoryBranchRequest) (*persistence.ForkHistoryBranchResponse, error) {
s.Equal(&persistence.ForkHistoryBranchRequest{
ForkBranchToken: baseBranchToken,
ForkNodeID: baseBranchLCAEventID + 1,
Info: input.Info,
ShardID: shardID,
NamespaceID: s.namespaceID,
NewRunID: input.NewRunID,
}, input)
return &persistence.ForkHistoryBranchResponse{
NewBranchToken: newBranchToken,
}, nil
})
newIndex, err := s.nDCBranchMgr.createNewBranch(context.Background(), baseBranchToken, baseBranchLCAEventID, newVersionHistory)
s.Nil(err)
s.Equal(int32(1), newIndex)
compareVersionHistory, err := versionhistory.CopyVersionHistoryUntilLCAVersionHistoryItem(
versionHistory,
versionhistory.NewVersionHistoryItem(baseBranchLCAEventID, baseBranchLCAEventVersion),
)
s.NoError(err)
versionhistory.SetVersionHistoryBranchToken(compareVersionHistory, newBranchToken)
newVersionHistory, err = versionhistory.GetVersionHistory(versionHistories, newIndex)
s.NoError(err)
s.True(compareVersionHistory.Equal(newVersionHistory))
}
func (s *branchMgrSuite) TestGetOrCreate_BranchAppendable_NoMissingEventInBetween() {
versionHistory := versionhistory.NewVersionHistory([]byte("some random base branch token"), []*historyspb.VersionHistoryItem{
versionhistory.NewVersionHistoryItem(10, 0),
versionhistory.NewVersionHistoryItem(50, 100),
versionhistory.NewVersionHistoryItem(100, 200),
versionhistory.NewVersionHistoryItem(150, 300),
})
versionHistories := versionhistory.NewVersionHistories(versionHistory)
incomingVersionHistory := versionhistory.CopyVersionHistory(versionHistory)
err := versionhistory.AddOrUpdateVersionHistoryItem(
incomingVersionHistory,
versionhistory.NewVersionHistoryItem(200, 300),
)
s.NoError(err)
s.mockMutableState.EXPECT().GetExecutionInfo().Return(&persistencespb.WorkflowExecutionInfo{
NamespaceId: s.namespaceID,
WorkflowId: s.workflowID,
VersionHistories: versionHistories,
}).AnyTimes()
doContinue, index, err := s.nDCBranchMgr.GetOrCreate(
context.Background(),
incomingVersionHistory,
150+1,
300)
s.NoError(err)
s.True(doContinue)
s.Equal(int32(0), index)
}
func (s *branchMgrSuite) TestGetOrCreate_BranchAppendable_MissingEventInBetween() {
versionHistory := versionhistory.NewVersionHistory([]byte("some random base branch token"), []*historyspb.VersionHistoryItem{
versionhistory.NewVersionHistoryItem(10, 0),
versionhistory.NewVersionHistoryItem(50, 100),
versionhistory.NewVersionHistoryItem(100, 200),
versionhistory.NewVersionHistoryItem(150, 300),
})
versionHistories := versionhistory.NewVersionHistories(versionHistory)
incomingVersionHistory := versionhistory.CopyVersionHistory(versionHistory)
incomingFirstEventVersionHistoryItem := versionhistory.NewVersionHistoryItem(200, 300)
err := versionhistory.AddOrUpdateVersionHistoryItem(
incomingVersionHistory,
incomingFirstEventVersionHistoryItem,
)
s.NoError(err)
s.mockMutableState.EXPECT().GetExecutionInfo().Return(&persistencespb.WorkflowExecutionInfo{
NamespaceId: s.namespaceID,
WorkflowId: s.workflowID,
VersionHistories: versionHistories,
}).AnyTimes()
s.mockMutableState.EXPECT().GetExecutionState().Return(&persistencespb.WorkflowExecutionState{
RunId: s.runID,
}).AnyTimes()
_, _, err = s.nDCBranchMgr.GetOrCreate(
context.Background(),
incomingVersionHistory,
150+2,
300)
s.IsType(&serviceerrors.RetryReplication{}, err)
}
func (s *branchMgrSuite) TestGetOrCreate_BranchNotAppendable_NoMissingEventInBetween() {
baseBranchToken := []byte("some random base branch token")
baseBranchLCAEventID := int64(85)
baseBranchLCAEventVersion := int64(200)
versionHistory := versionhistory.NewVersionHistory(baseBranchToken, []*historyspb.VersionHistoryItem{
versionhistory.NewVersionHistoryItem(10, 0),
versionhistory.NewVersionHistoryItem(50, 100),
versionhistory.NewVersionHistoryItem(baseBranchLCAEventID+10, baseBranchLCAEventVersion),
versionhistory.NewVersionHistoryItem(150, 300),
})
versionHistories := versionhistory.NewVersionHistories(versionHistory)
incomingVersionHistory := versionhistory.NewVersionHistory(nil, []*historyspb.VersionHistoryItem{
versionhistory.NewVersionHistoryItem(10, 0),
versionhistory.NewVersionHistoryItem(50, 100),
versionhistory.NewVersionHistoryItem(baseBranchLCAEventID, baseBranchLCAEventVersion),
versionhistory.NewVersionHistoryItem(200, 400),
})
newBranchToken := []byte("some random new branch token")
s.mockMutableState.EXPECT().GetExecutionInfo().Return(&persistencespb.WorkflowExecutionInfo{
NamespaceId: s.namespaceID,
WorkflowId: s.workflowID,
VersionHistories: versionHistories,
}).AnyTimes()
s.mockMutableState.EXPECT().GetExecutionState().Return(&persistencespb.WorkflowExecutionState{
RunId: s.runID,
}).AnyTimes()
shardID := s.mockShard.GetShardID()
s.mockExecutionManager.EXPECT().ForkHistoryBranch(gomock.Any(), gomock.Any()).DoAndReturn(
func(_ context.Context, input *persistence.ForkHistoryBranchRequest) (*persistence.ForkHistoryBranchResponse, error) {
s.Equal(&persistence.ForkHistoryBranchRequest{
ForkBranchToken: baseBranchToken,
ForkNodeID: baseBranchLCAEventID + 1,
Info: input.Info,
ShardID: shardID,
NamespaceID: s.namespaceID,
NewRunID: input.NewRunID,
}, input)
return &persistence.ForkHistoryBranchResponse{
NewBranchToken: newBranchToken,
}, nil
})
doContinue, index, err := s.nDCBranchMgr.GetOrCreate(
context.Background(),
incomingVersionHistory,
baseBranchLCAEventID+1,
baseBranchLCAEventVersion,
)
s.NoError(err)
s.True(doContinue)
s.Equal(int32(1), index)
}
func (s *branchMgrSuite) TestGetOrCreate_BranchNotAppendable_MissingEventInBetween() {
baseBranchToken := []byte("some random base branch token")
baseBranchLCAEventID := int64(85)
baseBranchLCAEventVersion := int64(200)
baseBranchLastEventID := int64(150)
baseBranchLastEventVersion := int64(300)
versionHistory := versionhistory.NewVersionHistory(baseBranchToken, []*historyspb.VersionHistoryItem{
versionhistory.NewVersionHistoryItem(10, 0),
versionhistory.NewVersionHistoryItem(50, 100),
versionhistory.NewVersionHistoryItem(baseBranchLCAEventID+10, baseBranchLCAEventVersion),
versionhistory.NewVersionHistoryItem(baseBranchLastEventID, baseBranchLastEventVersion),
})
versionHistories := versionhistory.NewVersionHistories(versionHistory)
incomingVersionHistory := versionhistory.NewVersionHistory(nil, []*historyspb.VersionHistoryItem{
versionhistory.NewVersionHistoryItem(10, 0),
versionhistory.NewVersionHistoryItem(50, 100),
versionhistory.NewVersionHistoryItem(baseBranchLCAEventID, baseBranchLCAEventVersion),
versionhistory.NewVersionHistoryItem(200, 400),
})
s.mockMutableState.EXPECT().GetExecutionInfo().Return(&persistencespb.WorkflowExecutionInfo{
NamespaceId: s.namespaceID,
WorkflowId: s.workflowID,
VersionHistories: versionHistories,
}).AnyTimes()
s.mockMutableState.EXPECT().GetExecutionState().Return(&persistencespb.WorkflowExecutionState{
RunId: s.runID,
}).AnyTimes()
_, _, err := s.nDCBranchMgr.GetOrCreate(
context.Background(),
incomingVersionHistory,
baseBranchLCAEventID+2,
baseBranchLCAEventVersion,
)
s.IsType(&serviceerrors.RetryReplication{}, err)
}
func (s *branchMgrSuite) TestCreate_NoMissingEventInBetween() {
baseBranchToken := []byte("some random base branch token")
baseBranchLCAEventID := int64(150)
baseBranchLCAEventVersion := int64(300)
versionHistory := versionhistory.NewVersionHistory([]byte("some random base branch token"), []*historyspb.VersionHistoryItem{
versionhistory.NewVersionHistoryItem(10, 0),
versionhistory.NewVersionHistoryItem(50, 100),
versionhistory.NewVersionHistoryItem(100, 200),
versionhistory.NewVersionHistoryItem(baseBranchLCAEventID, baseBranchLCAEventVersion),
})
versionHistories := versionhistory.NewVersionHistories(versionHistory)
incomingVersionHistory := versionhistory.CopyVersionHistory(versionHistory)
err := versionhistory.AddOrUpdateVersionHistoryItem(
incomingVersionHistory,
versionhistory.NewVersionHistoryItem(baseBranchLCAEventID+50, baseBranchLCAEventVersion),
)
s.NoError(err)
newBranchToken := []byte("some random new branch token")
s.mockMutableState.EXPECT().GetExecutionInfo().Return(&persistencespb.WorkflowExecutionInfo{
NamespaceId: s.namespaceID,
WorkflowId: s.workflowID,
VersionHistories: versionHistories,
}).AnyTimes()
s.mockMutableState.EXPECT().GetExecutionState().Return(&persistencespb.WorkflowExecutionState{
RunId: s.runID,
}).AnyTimes()
shardID := s.mockShard.GetShardID()
s.mockExecutionManager.EXPECT().ForkHistoryBranch(gomock.Any(), gomock.Any()).DoAndReturn(
func(_ context.Context, input *persistence.ForkHistoryBranchRequest) (*persistence.ForkHistoryBranchResponse, error) {
s.Equal(&persistence.ForkHistoryBranchRequest{
ForkBranchToken: baseBranchToken,
ForkNodeID: baseBranchLCAEventID + 1,
Info: input.Info,
ShardID: shardID,
NamespaceID: s.namespaceID,
NewRunID: input.NewRunID,
}, input)
return &persistence.ForkHistoryBranchResponse{
NewBranchToken: newBranchToken,
}, nil
})
doContinue, index, err := s.nDCBranchMgr.Create(
context.Background(),
incomingVersionHistory,
baseBranchLCAEventID+1,
baseBranchLCAEventVersion,
)
s.NoError(err)
s.True(doContinue)
s.Equal(int32(1), index)
}
func (s *branchMgrSuite) TestCreate_MissingEventInBetween() {
versionHistory := versionhistory.NewVersionHistory([]byte("some random base branch token"), []*historyspb.VersionHistoryItem{
versionhistory.NewVersionHistoryItem(10, 0),
versionhistory.NewVersionHistoryItem(50, 100),
versionhistory.NewVersionHistoryItem(100, 200),
versionhistory.NewVersionHistoryItem(150, 300),
})
versionHistories := versionhistory.NewVersionHistories(versionHistory)
incomingVersionHistory := versionhistory.CopyVersionHistory(versionHistory)
incomingFirstEventVersionHistoryItem := versionhistory.NewVersionHistoryItem(200, 300)
err := versionhistory.AddOrUpdateVersionHistoryItem(
incomingVersionHistory,
incomingFirstEventVersionHistoryItem,
)
s.NoError(err)
s.mockMutableState.EXPECT().GetExecutionInfo().Return(&persistencespb.WorkflowExecutionInfo{
NamespaceId: s.namespaceID,
WorkflowId: s.workflowID,
VersionHistories: versionHistories,
}).AnyTimes()
s.mockMutableState.EXPECT().GetExecutionState().Return(&persistencespb.WorkflowExecutionState{
RunId: s.runID,
}).AnyTimes()
_, _, err = s.nDCBranchMgr.Create(
context.Background(),
incomingVersionHistory,
150+2,
300)
s.IsType(&serviceerrors.RetryReplication{}, err)
}