Event Mocks

A small library that includes details mocks of AWS Lambda event sources. Useful for use when unit testing your Lambda functions. Supported Event Sources are:

• API Gateway
• SNS
• SQS
• DynamoDB
• S3
• Scheduled
• Websocket
• Alexa Skill
• Alexa Smart Home
• CloudWatch
• CloudWatch Log
• Cognito Pool
• IoT

The library simply uses default event source mock templates and merge it with any overwrite you provide. Check out the JSON template files to learn more about the data structure of each event source.

Usage

SNS

1import createEvent from "@serverless/event-mocks"
2
3const mocked = createEvent(
4  "aws:sns",
5  {
6    Records: [{
7      Sns: {
8        Message: "trigger-email"
9      }
10    }]
11  });

API Gateway

1import createEvent from "@serverless/event-mocks"
2
3const event = createEvent(
4  "aws:apiGateway",
5  {
6    body: {
7      first_name: "Sam",
8      last_name: "Smith"
9    }
10  });

S3

1import createEvent from "@serverless/event-mocks"
2
3const event = createEvent(
4  "aws:s3",
5  {
6    Records: [{
7      eventName: "ObjectCreated:Put",
8      s3: {
9        bucket: {
10          name: "my-bucket-name"
11        },
12        object: {
13          key: "object-key"
14        }
15      }
16    }]
17  });

Scheduled

1import createEvent from "@serverless/event-mocks"
2
3const event = createEvent(
4  "aws:scheduled",
5  {
6    region: "us-west-2"
7  });

Kinesis

1import createEvent from "@serverless/event-mocks"
2
3const event = createEvent(
4  "aws:kinesis",
5  {
6    data: new Buffer("this is test data").toString("base64")
7  });

Dynamo

1import createEvent from "@serverless/event-mocks"
2
3const event = createEvent(
4  "aws:dynamo",
5  {
6    Records: [
7      {
8      eventID: "1",
9      eventVersion: "1.0",
10      dynamodb: {
11        Keys: {
12          Id: {
13            N: "101"
14          }
15        },
16        NewImage: {
17          Message: {
18            S: "New item!"
19          },
20          Id: {
21            N: "101"
22          }
23        },
24        StreamViewType: "NEW_AND_OLD_IMAGES",
25        SequenceNumber: "111",
26        SizeBytes: 26
27      },
28      awsRegion: "us-west-2",
29      eventName: "INSERT",
30      eventSourceARN: "arn:aws:dynamodb:us-east-1:123456789012:table/images",
31      eventSource: "aws:dynamodb"
32      }
33    ]
34  });

Websocket event

1  const event = createEvent("aws:websocket", {
2    body: {
3      first_name: "Sam",
4      last_name: "Smith",
5    },
6    requestContext: {
7      connectedAt: 123,
8      connectionId: "abc123",
9    },
10  });

CloudWatch event

1  const event = createEvent("aws:cloudWatch", {
2    "detail-type": "Something has been deleted.",
3    "region": "us-east-1"
4  });

CloudWatchLog event

1  const event = createEvent("aws:cloudWatchLog", {
2    awslogs: {
3      data: "Some gzipped, then base64 encoded data",
4    }
5  });

Alexa Skill event

1  const event = createEvent("aws:alexaSkill", {
2    request: {
3      type: "CanFulfillIntentRequest",
4    },
5    context: {
6      System: {
7        device: {
8          deviceId: "myDevice",
9        },
10      },
11    },
12  }

Alexa SmartHome event

1  const event = createEvent("aws:alexaSmartHome", {
2    payload: {
3      switchControlAction: "TURN_OFF",
4    },
5  }

IoT event

1  const event = createEvent("aws:iot", {
2    this: {
3      can: {
4        be: "anything I want",
5      },
6    }

Cognito Pool Event

1  const event = createEvent("aws:cognitoUserPool", {
2    userName: "Aaron Stuyvenberg",
3  }