@driimus/aws-event-factory

Test data factories for different AWS Lambda event sources. Built using fishery.

Supported Lambda event sources

• Amazon API Gateway
• Amazon CloudWatch Logs
• Amazon Cognito
• Amazon DynamoDB Streams
• Amazon EventBridge
• Amazon Kinesis Data Streams
• Amazon Lex v2
• Amazon MSK
• Amazon S3
• Amazon SNS
• Amazon SQS
• Amazon SecretsManager

Goals

This package prioritizes structural integrity over veracity. While some of the generated data is truthful, explicit inputs should always be provided for the parts of an event that you really care about.

Installation

[!WARNING] This is an ES only package. Before installing, make sure that your project's configuration supports ECMAScript modules.

1pnpm add --save-dev @faker-js/faker fishery @driimus/aws-event-factory

Type hints

For types to work as expected, @types/aws-lambda must be installed:

1pnpm add --save-dev @types/aws-lambda
2

Usage

Make sure to check out fishery's documentation for a more detailed API Reference of the exposed factories.

1import {
2  dynamodbEventFactory,
3  dynamodbRecordFactory,
4  sqsEventFactory,
5} from '@driimus/aws-event-factory';
6
7const sqsEvent = sqsEventFactory.build(); // { Records: [...] }
8
9const ddbEvent = dynamodbEventFactory.build({
10  Records: [
11    dynamodbRecordFactory.insert().build(), // { eventName: 'INSERT', ...}
12    dynamodbRecordFactory.modify().build(), // { eventName: 'MODIFY', ...}
13    dynamodbRecordFactory.remove().build(), // { eventName: 'REMOVE', ...}
14  ],
15}); // { Records: [...] }

More examples:

• test SQS events
• test DynamoDB Streams events

Prior art

• @serverless/event-mocks
• mock-aws-events