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
Other Functionality
Usage
Set your sqs client to be the mock with a testing flag.
// sqs.js
import { SQS } from 'aws-sdk'
import { SQSMock } from 'sqs-mock'
export const sqs = process.env.NODE_ENV === 'production'
? new SQS()
: new SQSMock() as any as SQS // cast SQSMock as SQS if using typescript
Use SQSMock client in tests
// test.js
import { sqs } from './sqs'
const QueueUrl = 'test'
afterEach(async () => {
await sqs.purgeQueue({
QueueUrl
}).promise()
})
it('adds, receives then deletes message in queue', async () => {
await sqs
sendMessage({
QueueUrl,
MessageBody: 'test'
})
promise();
const result = await sqs
receiveMessage({
QueueUrl
})
promise();
expect(result.Messages!.length).toBe(1);
await sqs
deleteMessage({
QueueUrl,
ReceiptHandle: result.Messages![0].ReceiptHandle
})
promise();
const result2 = await sqs
receiveMessage({
QueueUrl
})
promise();
expect(result2.Messages).toBeUndefined();
})
