Version: 29.5

DynamoDBを使用する場合

Global Setup/Deardown と Async Test Environment API を使用して、Jest は DynamoDB とスムーズに連携できます。

jest-dynamodb プリセットを使用する

Jest DynamoDB は、DynamoDB を使用してテストを実行するために必要なすべての設定を提供します。

まず、 @shelf/jest-dynamodb をインストールします。

npm
Yarn
pnpm

npm install --save-dev @shelf/jest-dynamodb

yarn add --dev @shelf/jest-dynamodb

pnpm add --save-dev @shelf/jest-dynamodb

テストを書きます

{
  "preset": "@shelf/jest-dynamodb"
}

DynamoDBクライアントを設定します。

テーブルAPIの作成を参照。

module.exports = {
  tables: [
    {
      TableName: `files`,
      KeySchema: [{AttributeName: 'id', KeyType: 'HASH'}],
      AttributeDefinitions: [{AttributeName: 'id', AttributeType: 'S'}],
      ProvisionedThroughput: {ReadCapacityUnits: 1, WriteCapacityUnits: 1},
    },
    // etc
  ],
};

テストを記述します。

const {DocumentClient} = require('aws-sdk/clients/dynamodb');

const isTest = process.env.JEST_WORKER_ID;
const config = {
  convertEmptyValues: true,
  ...(isTest && {
    endpoint: 'localhost:8000',
    sslEnabled: false,
    region: 'local-env',
  }),
};

const ddb = new DocumentClient(config);

テストを記述します。

it('should insert item into table', async () => {
  await ddb
    .put({TableName: 'files', Item: {id: '1', hello: 'world'}})
    .promise();

  const {Item} = await ddb.get({TableName: 'files', Key: {id: '1'}}).promise();

  expect(Item).toEqual({
    id: '1',
    hello: 'world',
  });
});

依存関係をロードする必要はありません。

詳細はドキュメントを参照してください。

jest-dynamodb プリセットを使用する​

jest-dynamodb プリセットを使用する