ts-local-dynamo

Test locally with Amazon DynamoDB Local Docker image

Installing

npm install ts-local-dynamo

Usage

Use the class that corresponds to the version of the AWS SDK for JavaScript you are using.

For v2:

import { LocalDynamoV2 } from "ts-local-dynamo/dist/v2";

For v3

import { LocalDynamoV3 } from "ts-local-dynamo/dist/v3";

Starting

Start a local container using the static start method on your class. Provide any tables you'd like to have created in the config parameter.

For example, with AWS SDK V3:

import { LocalDynamoV3 } from "ts-local-dynamo/dist/v3";

const tables: CreateTableInput[] = []; // add your tables here
const localDynamo = await LocalDynamoV3.start({ tables });

Recreating Tables

To clear the database in between unit test runs, use await localDynamo.recreateTables().

Getting a new Dynamo client

Use localDynamo.newClient() to get a new AWS SDK Dynamo client configured to work with the container instance.

Stopping

Stop the local container using localDynamo.stop().

Unit Testing

1. Start the local instance before running any tests.
2. Recreate tables before each test.
3. Stop the local instance after all tests are run.

For example, with SDK v3 and jest:

import { LocalDynamoV3 } from "ts-local-dynamo/dist/v3";

let dynamo: LocalDynamoV3;

beforeAll(async () => {
  const tables: CreateTableInput[] = []; // add your table definitions
  dynamo = await LocalDynamoV3.start({ tables });
});

beforeEach(async () => {
  if (dynamo) await dynamo.recreateTables();
});

afterAll(async () => {
  if (dynamo) await dynamo.stop();
});

test("my test", async () => {
  const client = dynamo.newClient();
  // do something with client
});

Configuration

You can specify an alternative Docker image name. See LocalDynamoConfig for details.

Thanks

Since v1.1.0 this library is built on top of testcontainers. Thanks!

Contributing

We're happy to accept contributions! Please open an issue before sending a PR to discuss proposed changes. This is so we can discuss implementation and make sure there is no duplicate effort