mirror of
https://github.com/hanzoai/tasks.git
synced 2026-10-30 14:56:19 +00:00
Michael SnowdenandGitHub
db9879882f
<!-- Describe what has changed in this PR --> **What changed?** 1. I added an `AfterFunc` so that we can also test timers. I wanted to do this using clockwork, but they don't use synchronous timers, and, after discussing with @cretz , I think it's probably best that we just write our own here because it's not that big anyway. 2. I removed all references to clockwork, so that we only use this new type of test clock 3. I fixed `liveness_test.go` to use the new `AfterFunc` approach. <!-- Tell your future self why have you made these changes --> **Why?** Reasons for individual changes are given above, but the overall idea here is to drastically speed up our tests, make them more deterministic, and make them easier to write. <!-- How have you verified this change? Tested locally? Added a unit test? Checked in staging env? --> **How did you test it?** There's 100% test coverage for all the new code and none of it relies on `time.Sleep`. <!-- Assuming the worst case, what can be broken when deploying this change to production? --> **Potential risks** Some users may have custom implementations of clock.TimeSource which will no longer work because they don't also implement AfterFunc. <!-- Is this PR a hotfix candidate or require that a notification be sent to the broader community? (Yes/No) --> **Is hotfix candidate?** No.
86 lines
2.9 KiB
Go
86 lines
2.9 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 history
|
|
|
|
import (
|
|
"testing"
|
|
|
|
"github.com/golang/mock/gomock"
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
"go.temporal.io/server/common/clock"
|
|
|
|
persistencespb "go.temporal.io/server/api/persistence/v1"
|
|
"go.temporal.io/server/common/log"
|
|
"go.temporal.io/server/common/metrics"
|
|
"go.temporal.io/server/common/primitives/timestamp"
|
|
"go.temporal.io/server/service/history/shard"
|
|
"go.temporal.io/server/service/history/tasks"
|
|
"go.temporal.io/server/service/history/tests"
|
|
)
|
|
|
|
func TestArchivalQueueFactory(t *testing.T) {
|
|
ctrl := gomock.NewController(t)
|
|
defer ctrl.Finish()
|
|
|
|
metricsHandler := metrics.NewMockHandler(ctrl)
|
|
metricsHandler.EXPECT().WithTags(gomock.Any()).Do(func(tags ...metrics.Tag) metrics.Handler {
|
|
require.Len(t, tags, 1)
|
|
assert.Equal(t, metrics.OperationTagName, tags[0].Key())
|
|
assert.Equal(t, "ArchivalQueueProcessor", tags[0].Value())
|
|
return metricsHandler
|
|
}).Times(2)
|
|
|
|
mockShard := shard.NewTestContext(
|
|
ctrl,
|
|
&persistencespb.ShardInfo{
|
|
ShardId: 0,
|
|
RangeId: 1,
|
|
QueueStates: map[int32]*persistencespb.QueueState{
|
|
tasks.CategoryIDArchival: {
|
|
ReaderStates: nil,
|
|
ExclusiveReaderHighWatermark: &persistencespb.TaskKey{
|
|
FireTime: timestamp.TimeNowPtrUtc(),
|
|
},
|
|
},
|
|
},
|
|
},
|
|
tests.NewDynamicConfig(),
|
|
)
|
|
|
|
queueFactory := NewArchivalQueueFactory(ArchivalQueueFactoryParams{
|
|
QueueFactoryBaseParams: QueueFactoryBaseParams{
|
|
Config: tests.NewDynamicConfig(),
|
|
TimeSource: clock.NewEventTimeSource(),
|
|
MetricsHandler: metricsHandler,
|
|
Logger: log.NewNoopLogger(),
|
|
},
|
|
})
|
|
queue := queueFactory.CreateQueue(mockShard, nil)
|
|
|
|
require.NotNil(t, queue)
|
|
assert.Equal(t, tasks.CategoryArchival, queue.Category())
|
|
}
|