History engine start/stop unit tests #5985
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
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,36 @@ | ||
| // Copyright (c) 2017-2021 Uber Technologies Inc. | ||
| // Portions of the Software are attributed to Copyright (c) 2021 Temporal 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 engineimpl | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/uber/cadence/service/history/engine/testdata" | ||
| ) | ||
|
|
||
| func TestHistoryEngineStartStop(t *testing.T) { | ||
| eft := testdata.NewEngineForTest(t, NewEngineWithShardContext) | ||
| defer eft.Cleanup() | ||
|
|
||
| eft.Engine.Start() | ||
| eft.Engine.Stop() | ||
| } |
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,187 @@ | ||
| // 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 testdata | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/golang/mock/gomock" | ||
| "go.uber.org/cadence/.gen/go/cadence/workflowserviceclient" | ||
| "go.uber.org/cadence/.gen/go/cadence/workflowservicetest" | ||
|
|
||
| "github.com/uber/cadence/client/matching" | ||
| "github.com/uber/cadence/common/clock" | ||
| "github.com/uber/cadence/common/dynamicconfig" | ||
| "github.com/uber/cadence/common/persistence" | ||
| "github.com/uber/cadence/common/quotas" | ||
| "github.com/uber/cadence/service/history/config" | ||
| "github.com/uber/cadence/service/history/constants" | ||
| "github.com/uber/cadence/service/history/engine" | ||
| "github.com/uber/cadence/service/history/events" | ||
| "github.com/uber/cadence/service/history/failover" | ||
| "github.com/uber/cadence/service/history/queue" | ||
| "github.com/uber/cadence/service/history/replication" | ||
| "github.com/uber/cadence/service/history/shard" | ||
| "github.com/uber/cadence/service/history/task" | ||
| "github.com/uber/cadence/service/history/workflowcache" | ||
| ) | ||
|
|
||
| type EngineForTest struct { | ||
| Engine engine.Engine | ||
| Cleanup func() | ||
| // Add mocks or other fields here | ||
| } | ||
|
|
||
| // NewEngineFn is defined as an alias for engineimpl.NewEngineWithShardContext to avoid circular dependency | ||
| type NewEngineFn func( | ||
taylanisikdemir marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| shard shard.Context, | ||
| visibilityMgr persistence.VisibilityManager, | ||
| matching matching.Client, | ||
| publicClient workflowserviceclient.Interface, | ||
| historyEventNotifier events.Notifier, | ||
| config *config.Config, | ||
| crossClusterTaskFetchers task.Fetchers, | ||
| replicationTaskFetchers replication.TaskFetchers, | ||
| rawMatchingClient matching.Client, | ||
| queueTaskProcessor task.Processor, | ||
| failoverCoordinator failover.Coordinator, | ||
| wfIDCache workflowcache.WFCache, | ||
| ratelimitInternalPerWorkflowID dynamicconfig.BoolPropertyFnWithDomainFilter, | ||
| queueProcessorFactory queue.ProcessorFactory, | ||
| ) engine.Engine | ||
|
|
||
| func NewEngineForTest(t *testing.T, newEngineFn NewEngineFn) *EngineForTest { | ||
| t.Helper() | ||
| controller := gomock.NewController(t) | ||
| historyCfg := config.NewForTest() | ||
| shardCtx := shard.NewTestContext( | ||
| t, | ||
| controller, | ||
| &persistence.ShardInfo{ | ||
| RangeID: 1, | ||
| TransferAckLevel: 0, | ||
| }, | ||
| historyCfg, | ||
| ) | ||
|
|
||
| domainCache := shardCtx.Resource.DomainCache | ||
| domainCache.EXPECT().GetDomainByID(constants.TestDomainID).Return(constants.TestLocalDomainEntry, nil).AnyTimes() | ||
| domainCache.EXPECT().GetDomainName(constants.TestDomainID).Return(constants.TestDomainName, nil).AnyTimes() | ||
| domainCache.EXPECT().GetDomain(constants.TestDomainName).Return(constants.TestLocalDomainEntry, nil).AnyTimes() | ||
| domainCache.EXPECT().GetDomainID(constants.TestDomainName).Return(constants.TestDomainID, nil).AnyTimes() | ||
| domainCache.EXPECT().RegisterDomainChangeCallback(gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any()).AnyTimes() | ||
| domainCache.EXPECT().UnregisterDomainChangeCallback(gomock.Any()).Times(1) | ||
|
|
||
| membershipResolver := shardCtx.Resource.MembershipResolver | ||
| membershipResolver.EXPECT().MemberCount(gomock.Any()).Return(1, nil).AnyTimes() | ||
|
|
||
| eventsCache := events.NewCache( | ||
| shardCtx.GetShardID(), | ||
| shardCtx.GetHistoryManager(), | ||
| historyCfg, | ||
| shardCtx.GetLogger(), | ||
| shardCtx.GetMetricsClient(), | ||
| domainCache, | ||
| ) | ||
| shardCtx.SetEventsCache(eventsCache) | ||
|
|
||
| historyEventNotifier := events.NewNotifier( | ||
| clock.NewRealTimeSource(), | ||
| shardCtx.Resource.MetricsClient, | ||
| func(workflowID string) int { | ||
| return len(workflowID) | ||
| }, | ||
| ) | ||
|
|
||
| visibilityMgr := persistence.NewMockVisibilityManager(controller) | ||
| mockWFServiceClient := workflowservicetest.NewMockClient(controller) | ||
| xClusterTaskFetcher := task.NewMockFetcher(controller) | ||
|
|
||
| replicatonTaskFetchers := replication.NewMockTaskFetchers(controller) | ||
| replicationTaskFetcher := replication.NewMockTaskFetcher(controller) | ||
| // TODO: this should probably return another cluster name, not current | ||
| replicationTaskFetcher.EXPECT().GetSourceCluster().Return(constants.TestClusterMetadata.GetCurrentClusterName()).AnyTimes() | ||
| replicationTaskFetcher.EXPECT().GetRateLimiter().Return(quotas.NewDynamicRateLimiter(func() float64 { return 100 })).AnyTimes() | ||
| replicationTaskFetcher.EXPECT().GetRequestChan().Return(nil).AnyTimes() | ||
| replicatonTaskFetchers.EXPECT().GetFetchers().Return([]replication.TaskFetcher{replicationTaskFetcher}).AnyTimes() | ||
|
|
||
| queueTaskProcessor := task.NewMockProcessor(controller) | ||
| queueTaskProcessor.EXPECT().StopShardProcessor(gomock.Any()).Return().Times(1) | ||
|
|
||
| failoverCoordinator := failover.NewMockCoordinator(controller) | ||
| wfIDCache := workflowcache.NewMockWFCache(controller) | ||
| ratelimitInternalPerWorkflowID := dynamicconfig.GetBoolPropertyFnFilteredByDomain(false) | ||
|
|
||
| queueProcessorFactory := queue.NewMockProcessorFactory(controller) | ||
| timerQProcessor := queue.NewMockProcessor(controller) | ||
| timerQProcessor.EXPECT().Start().Return().Times(1) | ||
| timerQProcessor.EXPECT().NotifyNewTask(gomock.Any(), gomock.Any()).Return().AnyTimes() | ||
| timerQProcessor.EXPECT().Stop().Return().Times(1) | ||
| queueProcessorFactory.EXPECT(). | ||
| NewTimerQueueProcessor(gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any()). | ||
| Return(timerQProcessor). | ||
| Times(1) | ||
|
|
||
| transferQProcessor := queue.NewMockProcessor(controller) | ||
| transferQProcessor.EXPECT().Start().Return().Times(1) | ||
| transferQProcessor.EXPECT().NotifyNewTask(gomock.Any(), gomock.Any()).Return().AnyTimes() | ||
| transferQProcessor.EXPECT().Stop().Return().Times(1) | ||
| queueProcessorFactory.EXPECT(). | ||
| NewTransferQueueProcessor(gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any()). | ||
| Return(transferQProcessor). | ||
| Times(1) | ||
|
|
||
| xClusterQProcessor := queue.NewMockProcessor(controller) | ||
| xClusterQProcessor.EXPECT().Start().Return().Times(1) | ||
| xClusterQProcessor.EXPECT().NotifyNewTask(gomock.Any(), gomock.Any()).Return().AnyTimes() | ||
| xClusterQProcessor.EXPECT().Stop().Return().Times(1) | ||
| queueProcessorFactory.EXPECT(). | ||
| NewCrossClusterQueueProcessor(gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any()). | ||
| Return(xClusterQProcessor). | ||
| Times(1) | ||
|
|
||
| engine := newEngineFn( | ||
| shardCtx, | ||
| visibilityMgr, | ||
| shardCtx.Resource.MatchingClient, | ||
| mockWFServiceClient, | ||
| historyEventNotifier, | ||
| historyCfg, | ||
| task.Fetchers{xClusterTaskFetcher}, | ||
| replicatonTaskFetchers, | ||
| shardCtx.Resource.MatchingClient, | ||
| queueTaskProcessor, | ||
| failoverCoordinator, | ||
| wfIDCache, | ||
| ratelimitInternalPerWorkflowID, | ||
| queueProcessorFactory, | ||
| ) | ||
|
|
||
| shardCtx.SetEngine(engine) | ||
|
|
||
| historyEventNotifier.Start() | ||
| return &EngineForTest{ | ||
| Engine: engine, | ||
| Cleanup: func() { | ||
| historyEventNotifier.Stop() | ||
| }, | ||
| } | ||
| } | ||
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
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Planning to attach mock objects created inline inside
NewEngineForTestfunction here so different unit test scenarios can adjust the behavior/expectations