The EventBridge Test Helper is a helper service that can be included in any javascript tests. The helper allows the tests to set up an architecture in the cloud that allows us to test our stacks from event in to event out.

🏠 WorkCast Homepage

Requirements

• AWS Account with the ability to:
  • Put Events
  • Create a SQS Queue
  • Create an Rule
  • Create an Event Target

Installation

NPM:

npm install @workcast-org/event-bridge-test-helper

Yarn:

yarn add @workcast-org/event-bridge-test-helper

Usage

The usage examples include the addition on an env file, this is a json/javascript file that contains the following:

• The stage that we are testing e.g ote. This is used to construct the eventbridge name.
• The region that the service is in that we are testing.

In your tests import the library:

const { eventTestingClient } = require('event-bridge-test-helper');

Create a client passing in the required values:

// This prefix allows us to track events made during this test cycle
let correlationPrefix = "integration-tests";
const helperClient = eventTestingClient({
  serviceName: "XXX",
  serviceSource: "com.workcast.XXX",
  correlationPrefix: correlationPrefix,
  busName: `eventbridge-${env.Testing.STAGE_NAME}`, // The event bus name that the service is attached to 
  region: env.Testing.REGION
});

For more information on the client inputs, the code is documented

Before and after your test you need to spin up the testing architecture:

before(async () => {
  await helperClient.createTestArchitecture();
});

after(async () => {
  await helperClient.destroyTestArchitecture();
});

In the test, construct your event how you expect the rule to fire and call teh fire event function:

await helperClient.fireEvent(request);

Immediately following firing the event you can then run the following to check for resultant messages:

const raisedEvents = await helperClient.getMessagesFromSQS();

If you have multiple events you can call this multiple times.

It's possible to increase the number of messages received but that can be funky, its better to get them one at a time from the queue

Author

👤 WorkCast

• Website: www.workcast.com
• Twitter: @WorkCast
• Github: @The-WorkCast-Corporation
• LinkedIn: @workcast

Show your support

Give a ⭐️ if this project helped you!