func TestQueueConsumerRunStopsGracefullyWhenCancelled(t *testing.T) {
// log to /dev/null because the deleter is chatty
log.SetOutput(ioutil.Discard)
defer func() {
log.SetOutput(os.Stderr)
}()
ctl := gomock.NewController(t)
defer ctl.Finish()
// delay so that the cancel occurs mid-receive
delay := func(x interface{}) {
time.Sleep(10 * time.Millisecond)
}
m := mock.NewMockSQSAPI(ctl)
m.EXPECT().ReceiveMessage(gomock.Any()).Do(delay).Return(&sqs.ReceiveMessageOutput{}, nil).AnyTimes()
m.EXPECT().DeleteMessageBatch(gomock.Any()).AnyTimes().Return(&sqs.DeleteMessageBatchOutput{}, nil)
m.EXPECT().ChangeMessageVisibilityBatch(gomock.Any()).AnyTimes()
s := &SQSService{Svc: m}
q := NewConsumer(s, noop)
q.delayAfterReceiveError = time.Millisecond
ngo := runtime.NumGoroutine()
// wait long enough to ensure ReceiveMessage is running
ctx, _ := context.WithTimeout(context.Background(), 5*time.Millisecond)
err := q.Run(ctx)
assert.Error(t, err)
time.Sleep(time.Millisecond) // time for goroutines to end
assert.InDelta(t, ngo, runtime.NumGoroutine(), 2, "Should not leak goroutines")
}
func TestQueueConsumerRunDoesNotFetchMoreMessagesThanItCanProcess(t *testing.T) {
// log to /dev/null because the deleter is chatty
log.SetOutput(ioutil.Discard)
defer func() {
log.SetOutput(os.Stderr)
}()
ctl := gomock.NewController(t)
defer ctl.Finish()
m := mock.NewMockSQSAPI(ctl)
received := &sqs.ReceiveMessageOutput{
Messages: []*sqs.Message{
&sqs.Message{MessageId: aws.String("i1"), ReceiptHandle: aws.String("r1")},
&sqs.Message{MessageId: aws.String("i2"), ReceiptHandle: aws.String("r2")},
&sqs.Message{MessageId: aws.String("i3"), ReceiptHandle: aws.String("r3")},
&sqs.Message{MessageId: aws.String("i4"), ReceiptHandle: aws.String("r4")},
&sqs.Message{MessageId: aws.String("i5"), ReceiptHandle: aws.String("r5")},
&sqs.Message{MessageId: aws.String("i6"), ReceiptHandle: aws.String("r6")},
&sqs.Message{MessageId: aws.String("i7"), ReceiptHandle: aws.String("r7")},
&sqs.Message{MessageId: aws.String("i8"), ReceiptHandle: aws.String("r8")},
&sqs.Message{MessageId: aws.String("i9"), ReceiptHandle: aws.String("r9")},
&sqs.Message{MessageId: aws.String("i10"), ReceiptHandle: aws.String("r10")},
},
}
// return 10 messages - the first 10 will never finish so the second batch will block and there will be no third request
m.EXPECT().ReceiveMessage(gomock.Any()).Return(received, nil).Times(2)
m.EXPECT().DeleteMessageBatch(gomock.Any()).AnyTimes().Return(&sqs.DeleteMessageBatchOutput{}, nil)
m.EXPECT().ChangeMessageVisibilityBatch(gomock.Any()).AnyTimes()
// hang until cancelled
fn := func(ctx context.Context, msg string) error {
<-ctx.Done()
return nil
}
s := &SQSService{Svc: m}
q := NewConsumer(s, fn)
q.delayAfterReceiveError = time.Millisecond
q.DeleteMessageDrainTimeout = 25 * time.Millisecond
// wait long enough to ensure ReceiveMessage would have been invoked multiple times if it was too greedy
ctx, _ := context.WithTimeout(context.Background(), 500*time.Millisecond)
// record number of goroutines before run to ensure no leaks
ngo := runtime.NumGoroutine()
// run the fetcher
q.Run(ctx)
// ensure no routines were leaked
time.Sleep(time.Millisecond)
assert.InDelta(t, ngo, runtime.NumGoroutine(), 2, "Should not leak goroutines")
}
func TestQueueConsumerRunProcessesMessages(t *testing.T) {
// log to /dev/null because the deleter is chatty
log.SetOutput(ioutil.Discard)
defer func() {
log.SetOutput(os.Stderr)
}()
ctl := gomock.NewController(t)
defer ctl.Finish()
// delay so that the cancel occurs during 2nd receive
delay := func(x interface{}) {
time.Sleep(10 * time.Millisecond)
}
m := mock.NewMockSQSAPI(ctl)
received := &sqs.ReceiveMessageOutput{
Messages: []*sqs.Message{
&sqs.Message{MessageId: aws.String("i1"), ReceiptHandle: aws.String("r1")},
&sqs.Message{MessageId: aws.String("i2"), ReceiptHandle: aws.String("r2")},
},
}
// return 2 messages the first time, and an error the second time
first := m.EXPECT().ReceiveMessage(gomock.Any()).Do(delay).Return(received, nil)
m.EXPECT().ReceiveMessage(gomock.Any()).Do(delay).Return(nil, assert.AnError).After(first).AnyTimes()
m.EXPECT().DeleteMessageBatch(gomock.Any()).AnyTimes().Return(&sqs.DeleteMessageBatchOutput{}, nil)
// count messages processed
var callCount int64
fn := func(ctx context.Context, msg string) error {
atomic.AddInt64(&callCount, 1)
return nil
}
s := &SQSService{Svc: m}
q := NewConsumer(s, fn)
q.delayAfterReceiveError = time.Millisecond
q.DeleteMessageDrainTimeout = 25 * time.Millisecond
// wait long enough to ensure ReceiveMessage is running
ctx, _ := context.WithTimeout(context.Background(), 15*time.Millisecond)
// record number of goroutines before run to ensure no leaks
ngo := runtime.NumGoroutine()
// run the fetcher
q.Run(ctx)
// ensure no routines were leaked other than the receive messages goroutine (leaks on purpose)
time.Sleep(time.Millisecond)
assert.InDelta(t, ngo, runtime.NumGoroutine(), 2, "Should not leak goroutines")
// ensure all messages were processed
assert.Equal(t, int64(2), callCount)
}
func TestSetupQueueExists(t *testing.T) {
ctl := gomock.NewController(t)
defer ctl.Finish()
name := "fake_queue_name"
svc := mock.NewMockSQSAPI(ctl)
svc.EXPECT().GetQueueUrl(&sqs.GetQueueUrlInput{QueueName: aws.String(name)}).Return(&sqs.GetQueueUrlOutput{QueueUrl: aws.String("http://example.com/queue/" + name)}, nil)
url, err := SetupQueue(svc, name)
assert.Regexp(t, "/fake_queue_name$", *url)
assert.Nil(t, err)
}
func TestSetupQueue(t *testing.T) {
ctl := gomock.NewController(t)
defer ctl.Finish()
name := "fake_queue_name"
svc := mock.NewMockSQSAPI(ctl)
// Given SQS creates the new queue successfully
svc.EXPECT().GetQueueUrl(gomock.Any()).Return(nil, assert.AnError)
svc.EXPECT().CreateQueue(gomock.Any()).Return(&sqs.CreateQueueOutput{QueueUrl: aws.String("http://example.com/queue/" + name)}, nil)
url, err := SetupQueue(svc, name)
assert.Regexp(t, "/fake_queue_name$", *url)
assert.Nil(t, err)
}
func TestSetupQueueFails(t *testing.T) {
ctl := gomock.NewController(t)
defer ctl.Finish()
name := "fake_queue_name"
svc := mock.NewMockSQSAPI(ctl)
// Given SQS returns an error
svc.EXPECT().GetQueueUrl(gomock.Any()).Return(nil, assert.AnError)
svc.EXPECT().CreateQueue(gomock.Any()).Return(nil, assert.AnError)
url, err := SetupQueue(svc, name)
assert.Nil(t, url)
assert.NotNil(t, err)
}
func TestQueueConsumerRunRetriesOnErrors(t *testing.T) {
// log to /dev/null because the deleter is chatty
log.SetOutput(ioutil.Discard)
defer func() {
log.SetOutput(os.Stderr)
}()
ctl := gomock.NewController(t)
defer ctl.Finish()
// delay so that the cancel occurs after 2 receives
var receiveCount int64
delay := func(x interface{}) {
atomic.AddInt64(&receiveCount, 1)
time.Sleep(2 * time.Millisecond)
}
m := mock.NewMockSQSAPI(ctl)
m.EXPECT().ReceiveMessage(gomock.Any()).Do(delay).Return(nil, assert.AnError).AnyTimes()
m.EXPECT().DeleteMessageBatch(gomock.Any()).AnyTimes().Return(&sqs.DeleteMessageBatchOutput{}, nil)
m.EXPECT().ChangeMessageVisibilityBatch(gomock.Any()).AnyTimes()
s := &SQSService{Svc: m}
q := NewConsumer(s, noop)
q.delayAfterReceiveError = time.Millisecond
q.DeleteMessageDrainTimeout = 25 * time.Millisecond
ngo := runtime.NumGoroutine()
// wait long enough to ensure ReceiveMessage ran at least twice
ctx, _ := context.WithTimeout(context.Background(), 5*time.Millisecond)
q.Run(ctx)
assert.InDelta(t, 2, atomic.LoadInt64(&receiveCount), 1, "ReceiveMessage should have been retried 1-3 times")
time.Sleep(time.Millisecond) // time for goroutines to end
assert.InDelta(t, ngo, runtime.NumGoroutine(), 2, "Should not leak goroutines")
}
func TestQueueConsumerExtendsLongJobs(t *testing.T) {
// log to /dev/null because the deleter is chatty
log.SetOutput(ioutil.Discard)
defer func() {
log.SetOutput(os.Stderr)
}()
ctl := gomock.NewController(t)
defer ctl.Finish()
// delay so that the cancel occurs during 2nd receive
delay := func(x interface{}) {
time.Sleep(150 * time.Millisecond)
}
m := mock.NewMockSQSAPI(ctl)
received := &sqs.ReceiveMessageOutput{
Messages: []*sqs.Message{
&sqs.Message{MessageId: aws.String("i1"), ReceiptHandle: aws.String("r1")},
&sqs.Message{MessageId: aws.String("i2"), ReceiptHandle: aws.String("r2")},
},
}
// return messages the first time, and an error the second time
first := m.EXPECT().ReceiveMessage(gomock.Any()).Return(received, nil)
m.EXPECT().ReceiveMessage(gomock.Any()).Do(delay).Return(nil, assert.AnError).After(first).AnyTimes()
m.EXPECT().DeleteMessageBatch(gomock.Any()).Return(&sqs.DeleteMessageBatchOutput{}, nil).AnyTimes()
var extendCount int64
m.EXPECT().ChangeMessageVisibilityBatch(gomock.Any()).
Do(func(r *sqs.ChangeMessageVisibilityBatchInput) {
atomic.AddInt64(&extendCount, 1)
}).
AnyTimes().
Return(&sqs.ChangeMessageVisibilityBatchOutput{}, nil)
fn := func(ctx context.Context, msg string) error {
time.Sleep(100 * time.Millisecond)
return nil
}
s := &SQSService{Svc: m}
q := NewConsumer(s, fn)
q.DeleteMessageAccumulatorTimeout = 10 * time.Millisecond
q.DeleteMessageDrainTimeout = 100 * time.Millisecond
q.ExtendVisibilityTimeoutBySeconds = 2
q.ExtendVisibilityTimeoutEvery = 10 * time.Millisecond
q.delayAfterReceiveError = time.Second
// wait long enough to ensure ReceiveMessage is running
ctx, _ := context.WithTimeout(context.Background(), 25*time.Millisecond)
// record number of goroutines before run to ensure no leaks
ngo := runtime.NumGoroutine()
// run the fetcher
q.Run(ctx)
// ensure no routines were leaked other than the receive messages goroutine (leaks on purpose)
time.Sleep(150 * time.Millisecond)
assert.InDelta(t, ngo, runtime.NumGoroutine(), 2, "Should not leak goroutines")
// ensure visibility timeout was extended at least once
assert.NotZero(t, atomic.LoadInt64(&extendCount))
}