Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into add-freeze-core-modules-configuration-option
- Loading branch information
Showing
69 changed files
with
1,742 additions
and
1,868 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| --- | ||
| id: dynamodb | ||
| title: Using with DynamoDB | ||
| --- | ||
|
|
||
| With the [Global Setup/Teardown](Configuration.md#globalsetup-string) and [Async Test Environment](Configuration.md#testenvironment-string) APIs, Jest can work smoothly with [DynamoDB](https://aws.amazon.com/dynamodb/). | ||
|
|
||
| ## Use jest-dynamodb Preset | ||
|
|
||
| [Jest DynamoDB](https://github.com/shelfio/jest-dynamodb) provides all required configuration to run your tests using DynamoDB. | ||
|
|
||
| 1. First install `@shelf/jest-dynamodb` | ||
|
|
||
| ``` | ||
| yarn add @shelf/jest-dynamodb --dev | ||
| ``` | ||
|
|
||
| 2. Specify preset in your Jest configuration: | ||
|
|
||
| ```json | ||
| { | ||
| "preset": "@shelf/jest-dynamodb" | ||
| } | ||
| ``` | ||
|
|
||
| 3. Create `jest-dynamodb-config.js` and define DynamoDB tables | ||
|
|
||
| See [Create Table API](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#createTable-property) | ||
|
|
||
| ```js | ||
| module.exports = { | ||
| tables: [ | ||
| { | ||
| TableName: `files`, | ||
| KeySchema: [{AttributeName: 'id', KeyType: 'HASH'}], | ||
| AttributeDefinitions: [{AttributeName: 'id', AttributeType: 'S'}], | ||
| ProvisionedThroughput: {ReadCapacityUnits: 1, WriteCapacityUnits: 1}, | ||
| }, | ||
| // etc | ||
| ], | ||
| }; | ||
| ``` | ||
|
|
||
| 4. Configure DynamoDB client | ||
|
|
||
| ```js | ||
| 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); | ||
| ``` | ||
|
|
||
| 5. Write tests | ||
|
|
||
| ```js | ||
| 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', | ||
| }); | ||
| }); | ||
| ``` | ||
|
|
||
| There's no need to load any dependencies. | ||
|
|
||
| See [documentation](https://github.com/shelfio/jest-dynamodb) for details. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.