sqs-mock

A functional, in-memory mock of the SQS client from AWS-SDK. Queues are automatically created in-memory per QueueUrl provided.

Supports aws-sdk-v2 method and aws-sdk-v3 command APIs.

See documentation for AWS SDK usage: aws-sdk-v2, aws-sdk-v3.

Functional Methods

• Constructor
• addPermission
• changeMessageVisibility
• changeMessageVisibilityBatch
• createQueue
• deleteMessage
• deleteMessageBatch
• deleteQueue
• getQueueAttributes
• getQueueUrl
• listDeadLetterSourceQueues
• listQueues
• listQueueTags
• purgeQueue
• receiveMessage
• removePermission
• sendMessage
• sendMessageBatch
• setQueueAttributes
• tagQueue
• untagQueue

Other Functionality

• Message timing (DelaySeconds, VisibilityTimeout)
• Message attributes and attribute querying (ApproximateNumberOfMessages, ApproximateNumberOfMessagesNotVisible, etc.)
• Queue attributes and management

---

Usage

Set your sqs client to be the mock with a testing flag.

1// sqs.js
2import { SQS } from 'aws-sdk'
3import { SQSMock } from 'sqs-mock'
4
5export const sqs = process.env.NODE_ENV === 'production'
6 ? new SQS()
7 : new SQSMock() as any as SQS // cast SQSMock as SQS if using typescript

Use SQSMock client in tests

1// test.js
2import { sqs } from './sqs'
3
4const QueueUrl = 'test'
5
6afterEach(async () => {
7 await sqs.purgeQueue({
8  QueueUrl
9 }).promise()
10})
11
12it('adds, receives then deletes message in queue', async () => {
13 await sqs
14  sendMessage({
15   QueueUrl,
16   MessageBody: 'test'
17  })
18  promise();
19
20 const result = await sqs
21  receiveMessage({
22   QueueUrl
23  })
24  promise();
25
26 expect(result.Messages!.length).toBe(1);
27
28 await sqs
29  deleteMessage({
30   QueueUrl,
31   ReceiptHandle: result.Messages![0].ReceiptHandle
32  })
33  promise();
34
35 const result2 = await sqs
36  receiveMessage({
37   QueueUrl
38  })
39  promise();
40
41 expect(result2.Messages).toBeUndefined();
42})