Files
tasks/service/history/replication/sequential_batch_queue_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

180 lines
5.5 KiB
Go

package replication
import (
"testing"
"github.com/stretchr/testify/require"
"github.com/stretchr/testify/suite"
"go.temporal.io/server/common/log"
"go.temporal.io/server/common/metrics"
"go.uber.org/mock/gomock"
)
type (
sequentialBatchQueueSuite struct {
suite.Suite
*require.Assertions
controller *gomock.Controller
logger log.Logger
metricsHandler metrics.Handler
}
)
func (s *sequentialBatchQueueSuite) SetupTest() {
s.Assertions = require.New(s.T())
s.controller = gomock.NewController(s.T())
s.logger = log.NewTestLogger()
}
func TestSequentialBatchQueueSuite(t *testing.T) {
suite.Run(t, new(sequentialBatchQueueSuite))
}
func (s *sequentialBatchQueueSuite) TestAdd_EmptyQueue() {
newTask := NewMockTrackableExecutableTask(s.controller)
queueId := "abc"
newTask.EXPECT().QueueID().Return(queueId)
queue := NewSequentialBatchableTaskQueue(newTask, func(_ TrackableExecutableTask) {}, s.logger, s.metricsHandler)
s.Equal(0, queue.Len())
s.True(queue.IsEmpty())
}
func (s *sequentialBatchQueueSuite) TestAdd_EmptyQueue_AddNewBatchedTask() {
newTask := NewMockTrackableExecutableTask(s.controller)
queueId := "abc"
newTask.EXPECT().QueueID().Return(queueId)
queue := NewSequentialBatchableTaskQueue(newTask, func(_ TrackableExecutableTask) {}, s.logger, s.metricsHandler)
queue.Add(newTask)
s.Equal(1, queue.Len())
s.False(queue.IsEmpty())
taskRemoved := queue.Remove()
// check queue
s.True(queue.IsEmpty())
s.Equal(0, queue.Len())
// check task
batchTask, _ := taskRemoved.(*batchedTask)
s.True(batchTask.batchedTask == newTask)
}
func (s *sequentialBatchQueueSuite) TestAdd_NewTaskBatched() {
task1 := NewMockBatchableTask(s.controller)
task2 := NewMockBatchableTask(s.controller)
task3 := NewMockBatchableTask(s.controller)
id1 := int64(1)
id2 := int64(2)
id3 := int64(3)
task1.EXPECT().TaskID().Return(id1).AnyTimes()
task2.EXPECT().TaskID().Return(id2).AnyTimes()
task3.EXPECT().TaskID().Return(id3).AnyTimes()
queueId := "abc"
task1.EXPECT().QueueID().Return(queueId)
queue := NewSequentialBatchableTaskQueue(task1, func(_ TrackableExecutableTask) {}, s.logger, s.metricsHandler)
task1.EXPECT().CanBatch().Return(true).Times(1)
task2.EXPECT().CanBatch().Return(true).Times(1)
task3.EXPECT().CanBatch().Return(true).Times(1)
combinedTask := NewMockBatchableTask(s.controller)
task1.EXPECT().BatchWith(task2).Return(combinedTask, true).Times(1)
combinedTask.EXPECT().CanBatch().Return(true).Times(1)
combinedTask.EXPECT().BatchWith(task3).Return(NewMockBatchableTask(s.controller), true).Times(1)
queue.Add(task1)
queue.Add(task2)
queue.Add(task3)
// check queue
s.Equal(1, queue.Len())
s.False(queue.IsEmpty())
tr := queue.Remove()
s.Equal(id1, tr.TaskID())
}
func (s *sequentialBatchQueueSuite) TestAdd_NewTaskCannotBatched() {
task1 := NewMockBatchableTask(s.controller)
task2 := NewMockBatchableTask(s.controller)
queueId := "abc"
task1.EXPECT().QueueID().Return(queueId)
id1 := int64(1)
id2 := int64(2)
task1.EXPECT().TaskID().Return(id1).AnyTimes()
task2.EXPECT().TaskID().Return(id2).AnyTimes()
queue := NewSequentialBatchableTaskQueue(task1, func(_ TrackableExecutableTask) {}, s.logger, s.metricsHandler)
task2.EXPECT().CanBatch().Return(false).Times(1)
NewMockTrackableExecutableTask(s.controller)
queue.Add(task1)
queue.Add(task2)
// check queue
s.Equal(2, queue.Len())
s.False(queue.IsEmpty())
r1 := queue.Remove()
r2 := queue.Remove()
s.Equal(id1, r1.TaskID())
s.Equal(id2, r2.TaskID())
}
func (s *sequentialBatchQueueSuite) TestAdd_NewTaskIsAddedToQueueWhenBatchFailed() {
task1 := NewMockBatchableTask(s.controller)
task2 := NewMockBatchableTask(s.controller)
task3 := NewMockBatchableTask(s.controller)
id1 := int64(1)
id2 := int64(2)
id3 := int64(3)
task1.EXPECT().TaskID().Return(id1).AnyTimes()
task2.EXPECT().TaskID().Return(id2).AnyTimes()
task3.EXPECT().TaskID().Return(id3).AnyTimes()
queueId := "abc"
task1.EXPECT().QueueID().Return(queueId)
queue := NewSequentialBatchableTaskQueue(task1, func(_ TrackableExecutableTask) {}, s.logger, s.metricsHandler)
task1.EXPECT().CanBatch().Return(false).Times(1)
task2.EXPECT().CanBatch().Return(true).Times(2)
task3.EXPECT().CanBatch().Return(true).Times(1)
task2.EXPECT().BatchWith(task3).Return(NewMockBatchableTask(s.controller), true).Times(1)
queue.Add(task1)
queue.Add(task2)
queue.Add(task3)
// check queue
s.Equal(2, queue.Len())
s.False(queue.IsEmpty())
tr1 := queue.Remove()
s.Equal(id1, tr1.TaskID())
tr2 := queue.Remove()
s.Equal(id2, tr2.TaskID())
tr2BatchTask, _ := tr2.(*batchedTask)
s.Len(tr2BatchTask.individualTasks, 2)
}
func (s *sequentialBatchQueueSuite) TestAdd_NewTaskTryToBatchWithLastTask() {
task1 := NewMockBatchableTask(s.controller)
task2 := NewMockBatchableTask(s.controller)
task3 := NewMockBatchableTask(s.controller)
id1 := int64(1)
id2 := int64(2)
id3 := int64(3)
task1.EXPECT().TaskID().Return(id1).AnyTimes()
task2.EXPECT().TaskID().Return(id2).AnyTimes()
task3.EXPECT().TaskID().Return(id3).AnyTimes()
queueId := "abc"
task1.EXPECT().QueueID().Return(queueId)
queue := NewSequentialBatchableTaskQueue(task1, func(_ TrackableExecutableTask) {}, s.logger, s.metricsHandler)
task1.EXPECT().CanBatch().Return(true).Times(1)
task2.EXPECT().CanBatch().Return(true).Times(1)
task3.EXPECT().CanBatch().Return(false).Times(2)
queue.Add(task3)
queue.Add(task2)
queue.Add(task1)
// check queue
s.Equal(3, queue.Len())
s.Equal(id1, queue.Remove().TaskID())
s.Equal(id2, queue.Remove().TaskID())
s.Equal(id3, queue.Remove().TaskID())
}