From a97577db5e6bf875e8d60b570cda62147cefe603 Mon Sep 17 00:00:00 2001 From: Stefan Schulte Date: Tue, 13 Oct 2026 19:55:21 +0200 Subject: [PATCH 01/11] New module DynamoDB Adds a new `DynamoDBContainer` to help running a local AWS DynamoDB container as described [in the docs][1] [1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBLocal.DownloadingAndRunning.html#docker --- docs/modules/dynamodb.md | 47 +++ mkdocs.yml | 1 + package-lock.json | 365 +++++++++++------- packages/modules/dynamodb/Dockerfile | 1 + packages/modules/dynamodb/package.json | 37 ++ .../dynamodb/src/dynamodb-container.test.ts | 268 +++++++++++++ .../dynamodb/src/dynamodb-container.ts | 182 +++++++++ packages/modules/dynamodb/src/index.ts | 1 + packages/modules/dynamodb/tsconfig.build.json | 9 + packages/modules/dynamodb/tsconfig.json | 16 + 10 files changed, 795 insertions(+), 132 deletions(-) create mode 100644 docs/modules/dynamodb.md create mode 100644 packages/modules/dynamodb/Dockerfile create mode 100644 packages/modules/dynamodb/package.json create mode 100644 packages/modules/dynamodb/src/dynamodb-container.test.ts create mode 100644 packages/modules/dynamodb/src/dynamodb-container.ts create mode 100644 packages/modules/dynamodb/src/index.ts create mode 100644 packages/modules/dynamodb/tsconfig.build.json create mode 100644 packages/modules/dynamodb/tsconfig.json diff --git a/docs/modules/dynamodb.md b/docs/modules/dynamodb.md new file mode 100644 index 000000000..c1ff070b7 --- /dev/null +++ b/docs/modules/dynamodb.md @@ -0,0 +1,47 @@ +# DynamoDB + +## Install + +```bash +npm install @testcontainers/dynamodb --save-dev +``` + +## Examples + +These examples use the following libraries: + +- [@aws-sdk/client-dynamodb](https://www.npmjs.com/package/@aws-sdk/client-dynamodb) + + npm install @aws-sdk/client-dynamodb + +Choose an image from the [container registry](https://hub.docker.com/r/amazon/dynamodb-local) and substitute `IMAGE`. + +### Connect to local endpoint + +In order to use a DynamoDB Client we have to specify +at least `region`, `credentials` and `endpoint` eventhough `region` and `credentials` +will not be used: + + +[](../../packages/modules/dynamodb/src/dynamodb-container.test.ts) inside_block:connectEndpoint + + +### Connect via client config + +The above can also be written as + + +[](../../packages/modules/dynamodb/src/dynamodb-container.test.ts) inside_block:connectClientConfig + + +### Use a shared database + + +[](../../packages/modules/dynamodb/src/dynamodb-container.test.ts) inside_block:sharedDB + + +### Disable telemetry + + +[](../../packages/modules/dynamodb/src/dynamodb-container.test.ts) inside_block:disabledTelemetry + diff --git a/mkdocs.yml b/mkdocs.yml index 7e70bc96e..4a2dd3027 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -64,6 +64,7 @@ nav: - CosmosDB: modules/cosmosdb.md - Couchbase: modules/couchbase.md - CouchDB: modules/couchdb.md + - DynamoDB: modules/dynamodb.md - Elasticsearch: modules/elasticsearch.md - Etcd: modules/etcd.md - GCloud: modules/gcloud.md diff --git a/package-lock.json b/package-lock.json index 77aacbafb..4f3cadd0c 100644 --- a/package-lock.json +++ b/package-lock.json @@ -61,6 +61,28 @@ "node": ">=20.0.0" } }, + "node_modules/@aws-sdk/client-dynamodb": { + "version": "3.1166.0", + "resolved": "https://registry.npmjs.org/@aws-sdk/client-dynamodb/-/client-dynamodb-3.1166.0.tgz", + "integrity": "sha512-VXqtlcCDiiP5lIC2aisfn2wG345cCbNpa3d9rC/m/ujcUT3n0gCmGOxDR9sg+EAidm1Ip7KxZQ4aIEQoVmK97A==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "@aws-sdk/core": "^3.981.0", + "@aws-sdk/credential-provider-node": "^3.972.96", + "@aws-sdk/dynamodb-codec": "^3.973.58", + "@aws-sdk/middleware-endpoint-discovery": "^3.972.39", + "@aws-sdk/types": "^3.975.1", + "@smithy/core": "^3.40.0", + "@smithy/fetch-http-handler": "^5.8.1", + "@smithy/node-http-handler": "^4.14.2", + "@smithy/types": "^4.20.0", + "tslib": "^2.6.2" + }, + "engines": { + "node": ">=20.0.0" + } + }, "node_modules/@aws-sdk/client-s3": { "version": "3.1161.0", "resolved": "https://registry.npmjs.org/@aws-sdk/client-s3/-/client-s3-3.1161.0.tgz", @@ -85,18 +107,18 @@ } }, "node_modules/@aws-sdk/core": { - "version": "3.979.1", - "resolved": "https://registry.npmjs.org/@aws-sdk/core/-/core-3.979.1.tgz", - "integrity": "sha512-ayOlV1VhLNMiq8PW9ZkVobG4gkldnUoHjG69yy2b8j+VYFlhz/uAL7ZdYQAoQ+eShtGUdNDnnG5rxDg6yUJrOg==", + "version": "3.981.0", + "resolved": "https://registry.npmjs.org/@aws-sdk/core/-/core-3.981.0.tgz", + "integrity": "sha512-Mnu7gaDrC5UCdyH8uLxLfB2eWbjE/HbjKX1U1J2VQxG3TTATUDObW2wU3I8iH3e9YH5NN2CY6w1mlAIe2XJ3jg==", "dev": true, "license": "Apache-2.0", "dependencies": { - "@aws-sdk/types": "^3.975.0", - "@aws-sdk/xml-builder": "^3.972.42", + "@aws-sdk/types": "^3.975.1", + "@aws-sdk/xml-builder": "^3.972.43", "@aws/lambda-invoke-store": "^0.3.0", - "@smithy/core": "^3.38.0", + "@smithy/core": "^3.40.0", "@smithy/signature-v4": "^5.7.5", - "@smithy/types": "^4.19.0", + "@smithy/types": "^4.20.0", "bowser": "^2.11.0", "tslib": "^2.6.2" }, @@ -105,16 +127,16 @@ } }, "node_modules/@aws-sdk/credential-provider-env": { - "version": "3.972.80", - "resolved": "https://registry.npmjs.org/@aws-sdk/credential-provider-env/-/credential-provider-env-3.972.80.tgz", - "integrity": "sha512-uO5TiSvb6j1w9RTe5z28OaOmsrOxVQUPaC5+wZl50RfOXcrYD/KgnS8I9lfyGXc7sGbkCopK6VnhNIAoLqfewQ==", + "version": "3.972.84", + "resolved": "https://registry.npmjs.org/@aws-sdk/credential-provider-env/-/credential-provider-env-3.972.84.tgz", + "integrity": "sha512-akZJetiMVeLRHsKzYh3LamDCo74ZUCeo0XoyRKMEMZT5qP7ReM6LhpioBCyuqKP5Vav5gEOeCmaQV0VVQr1Meg==", "dev": true, "license": "Apache-2.0", "dependencies": { - "@aws-sdk/core": "^3.979.1", - "@aws-sdk/types": "^3.975.0", - "@smithy/core": "^3.38.0", - "@smithy/types": "^4.19.0", + "@aws-sdk/core": "^3.981.0", + "@aws-sdk/types": "^3.975.1", + "@smithy/core": "^3.40.0", + "@smithy/types": "^4.20.0", "tslib": "^2.6.2" }, "engines": { @@ -122,18 +144,18 @@ } }, "node_modules/@aws-sdk/credential-provider-http": { - "version": "3.972.82", - "resolved": "https://registry.npmjs.org/@aws-sdk/credential-provider-http/-/credential-provider-http-3.972.82.tgz", - "integrity": "sha512-vQzlDHlC24Yz42p+rT4NBoP/5VdetkBoujbOLq9h6QYWC8THuZSPYnXIR9OP3XcOrdMgPBBipOrdssfxnIiWUg==", + "version": "3.972.86", + "resolved": "https://registry.npmjs.org/@aws-sdk/credential-provider-http/-/credential-provider-http-3.972.86.tgz", + "integrity": "sha512-U4mHaDRPWAn63yhl7FXIzbppNmW1F+4dSLeuiUpej2v3Xb6rGwvayEJ8SdlrdMV+/mZtd+GStTEP2HqurEzXtw==", "dev": true, "license": "Apache-2.0", "dependencies": { - "@aws-sdk/core": "^3.979.1", - "@aws-sdk/types": "^3.975.0", - "@smithy/core": "^3.38.0", - "@smithy/fetch-http-handler": "^5.8.0", - "@smithy/node-http-handler": "^4.14.0", - "@smithy/types": "^4.19.0", + "@aws-sdk/core": "^3.981.0", + "@aws-sdk/types": "^3.975.1", + "@smithy/core": "^3.40.0", + "@smithy/fetch-http-handler": "^5.8.1", + "@smithy/node-http-handler": "^4.14.2", + "@smithy/types": "^4.20.0", "tslib": "^2.6.2" }, "engines": { @@ -141,24 +163,24 @@ } }, "node_modules/@aws-sdk/credential-provider-ini": { - "version": "3.973.25", - "resolved": "https://registry.npmjs.org/@aws-sdk/credential-provider-ini/-/credential-provider-ini-3.973.25.tgz", - "integrity": "sha512-b5xl71uCRdWsu7P1VeGpiGuCf6zfYETsSNOv8AmYVTrsgbvTJRXdmmOPVfxkvGGVNsiKkGctClQW3jAn0SZLug==", - "dev": true, - "license": "Apache-2.0", - "dependencies": { - "@aws-sdk/core": "^3.979.1", - "@aws-sdk/credential-provider-env": "^3.972.80", - "@aws-sdk/credential-provider-http": "^3.972.82", - "@aws-sdk/credential-provider-login": "^3.972.87", - "@aws-sdk/credential-provider-process": "^3.972.80", - "@aws-sdk/credential-provider-sso": "^3.973.24", - "@aws-sdk/credential-provider-web-identity": "^3.972.86", - "@aws-sdk/nested-clients": "^3.997.54", - "@aws-sdk/types": "^3.975.0", - "@smithy/core": "^3.38.0", + "version": "3.973.29", + "resolved": "https://registry.npmjs.org/@aws-sdk/credential-provider-ini/-/credential-provider-ini-3.973.29.tgz", + "integrity": "sha512-/idO4bVjw34b1OiNxDqFNr3BsPg9dRm1iS6XM/rTqA33RfUgTuwBCFFCz/TwxNHkrQ45tp+RpKE8P609Ino8XQ==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "@aws-sdk/core": "^3.981.0", + "@aws-sdk/credential-provider-env": "^3.972.84", + "@aws-sdk/credential-provider-http": "^3.972.86", + "@aws-sdk/credential-provider-login": "^3.972.91", + "@aws-sdk/credential-provider-process": "^3.972.84", + "@aws-sdk/credential-provider-sso": "^3.973.28", + "@aws-sdk/credential-provider-web-identity": "^3.972.90", + "@aws-sdk/nested-clients": "^3.998.3", + "@aws-sdk/types": "^3.975.1", + "@smithy/core": "^3.40.0", "@smithy/credential-provider-imds": "^4.5.2", - "@smithy/types": "^4.19.0", + "@smithy/types": "^4.20.0", "tslib": "^2.6.2" }, "engines": { @@ -166,17 +188,17 @@ } }, "node_modules/@aws-sdk/credential-provider-login": { - "version": "3.972.87", - "resolved": "https://registry.npmjs.org/@aws-sdk/credential-provider-login/-/credential-provider-login-3.972.87.tgz", - "integrity": "sha512-C4ZFmcwM+Zj14Z8huVUk54Gv4uzT1ZdzG9cY3Gdh8FePakq7Bss1OFsgZjAhWFOkFOGpBvFBeu0OWjWf8HNKRQ==", + "version": "3.972.91", + "resolved": "https://registry.npmjs.org/@aws-sdk/credential-provider-login/-/credential-provider-login-3.972.91.tgz", + "integrity": "sha512-MujcVZc7mnodrsp85NX0QpnQrt7kY6zbVUl+TcvzJEZzgEQkRj4iopj0kNs3uXJUArpkA64Rxa0ga86qdx0gag==", "dev": true, "license": "Apache-2.0", "dependencies": { - "@aws-sdk/core": "^3.979.1", - "@aws-sdk/nested-clients": "^3.997.54", - "@aws-sdk/types": "^3.975.0", - "@smithy/core": "^3.38.0", - "@smithy/types": "^4.19.0", + "@aws-sdk/core": "^3.981.0", + "@aws-sdk/nested-clients": "^3.998.3", + "@aws-sdk/types": "^3.975.1", + "@smithy/core": "^3.40.0", + "@smithy/types": "^4.20.0", "tslib": "^2.6.2" }, "engines": { @@ -184,22 +206,22 @@ } }, "node_modules/@aws-sdk/credential-provider-node": { - "version": "3.972.92", - "resolved": "https://registry.npmjs.org/@aws-sdk/credential-provider-node/-/credential-provider-node-3.972.92.tgz", - "integrity": "sha512-jC3zmOo7Qxlk+oBivvSsS1Ph7sFGm0QfuhqDGbqgRXi4cxUYMG+dWtBwS2XYYXgc8TIVXJiwgQ65sbNpbYupTA==", + "version": "3.972.96", + "resolved": "https://registry.npmjs.org/@aws-sdk/credential-provider-node/-/credential-provider-node-3.972.96.tgz", + "integrity": "sha512-tBunyyRnxMvKsCn/pu1QrIxUYZ4Z25LkV8zGkFGpSE/YmI2W4m8SLQzloG/hZlelGP2vLRGtIQc5w1+DoXCK1A==", "dev": true, "license": "Apache-2.0", "dependencies": { - "@aws-sdk/credential-provider-env": "^3.972.80", - "@aws-sdk/credential-provider-http": "^3.972.82", - "@aws-sdk/credential-provider-ini": "^3.973.25", - "@aws-sdk/credential-provider-process": "^3.972.80", - "@aws-sdk/credential-provider-sso": "^3.973.24", - "@aws-sdk/credential-provider-web-identity": "^3.972.86", - "@aws-sdk/types": "^3.975.0", - "@smithy/core": "^3.38.0", + "@aws-sdk/credential-provider-env": "^3.972.84", + "@aws-sdk/credential-provider-http": "^3.972.86", + "@aws-sdk/credential-provider-ini": "^3.973.29", + "@aws-sdk/credential-provider-process": "^3.972.84", + "@aws-sdk/credential-provider-sso": "^3.973.28", + "@aws-sdk/credential-provider-web-identity": "^3.972.90", + "@aws-sdk/types": "^3.975.1", + "@smithy/core": "^3.40.0", "@smithy/credential-provider-imds": "^4.5.2", - "@smithy/types": "^4.19.0", + "@smithy/types": "^4.20.0", "tslib": "^2.6.2" }, "engines": { @@ -207,16 +229,16 @@ } }, "node_modules/@aws-sdk/credential-provider-process": { - "version": "3.972.80", - "resolved": "https://registry.npmjs.org/@aws-sdk/credential-provider-process/-/credential-provider-process-3.972.80.tgz", - "integrity": "sha512-xqfixO5aclje7tbQJDias+iNND5wp/3QZixCdZcVQpgWPTZ0V5DfTW9A804A5Z7ezu7sH3WRO+vzUjtiJBA8yg==", + "version": "3.972.84", + "resolved": "https://registry.npmjs.org/@aws-sdk/credential-provider-process/-/credential-provider-process-3.972.84.tgz", + "integrity": "sha512-199C6OpNejd0nq9GFAkEFIKids1FL0R6LJtL9c1OTiDOXki7S1OduuPxW4+hE0LwndcYJ7YHOuYTlqScfpCocA==", "dev": true, "license": "Apache-2.0", "dependencies": { - "@aws-sdk/core": "^3.979.1", - "@aws-sdk/types": "^3.975.0", - "@smithy/core": "^3.38.0", - "@smithy/types": "^4.19.0", + "@aws-sdk/core": "^3.981.0", + "@aws-sdk/types": "^3.975.1", + "@smithy/core": "^3.40.0", + "@smithy/types": "^4.20.0", "tslib": "^2.6.2" }, "engines": { @@ -224,18 +246,18 @@ } }, "node_modules/@aws-sdk/credential-provider-sso": { - "version": "3.973.24", - "resolved": "https://registry.npmjs.org/@aws-sdk/credential-provider-sso/-/credential-provider-sso-3.973.24.tgz", - "integrity": "sha512-nlg3BKG03Cgzvv/dMnhxvDJPhAhQSpaN0RUdwgU7ziwkasoev7iI8el8Xy4Rd5sqzgaDUbV269fOXck5SargqA==", + "version": "3.973.28", + "resolved": "https://registry.npmjs.org/@aws-sdk/credential-provider-sso/-/credential-provider-sso-3.973.28.tgz", + "integrity": "sha512-bGg7wH8wVDJQIcJggO9lg1ZYbG7l+PbLwHuM3Bi/e1TlCZhU712JS1W3tdRpyptdJD1UGyhBNGO/YrhrQCHKbg==", "dev": true, "license": "Apache-2.0", "dependencies": { - "@aws-sdk/core": "^3.979.1", - "@aws-sdk/nested-clients": "^3.997.54", - "@aws-sdk/token-providers": "3.1161.0", - "@aws-sdk/types": "^3.975.0", - "@smithy/core": "^3.38.0", - "@smithy/types": "^4.19.0", + "@aws-sdk/core": "^3.981.0", + "@aws-sdk/nested-clients": "^3.998.3", + "@aws-sdk/token-providers": "3.1166.0", + "@aws-sdk/types": "^3.975.1", + "@smithy/core": "^3.40.0", + "@smithy/types": "^4.20.0", "tslib": "^2.6.2" }, "engines": { @@ -243,17 +265,64 @@ } }, "node_modules/@aws-sdk/credential-provider-web-identity": { - "version": "3.972.86", - "resolved": "https://registry.npmjs.org/@aws-sdk/credential-provider-web-identity/-/credential-provider-web-identity-3.972.86.tgz", - "integrity": "sha512-zKTyLJBEyfQBVlYqT6Jt+mYV4r8kGbWM7dn6v4Y4MRARizhYafjDXP/iMu76UMRhToSPNmIKX1XAb24gtpBFIA==", + "version": "3.972.90", + "resolved": "https://registry.npmjs.org/@aws-sdk/credential-provider-web-identity/-/credential-provider-web-identity-3.972.90.tgz", + "integrity": "sha512-duLeE3xlf0viHeH+1RM4z5duR3b32BCZTWVMu+MbxFPjQBxy7hmIGEqt5hekuFPRuXoyhMovjNl+PNNsb5oiGQ==", "dev": true, "license": "Apache-2.0", "dependencies": { - "@aws-sdk/core": "^3.979.1", - "@aws-sdk/nested-clients": "^3.997.54", - "@aws-sdk/types": "^3.975.0", - "@smithy/core": "^3.38.0", - "@smithy/types": "^4.19.0", + "@aws-sdk/core": "^3.981.0", + "@aws-sdk/nested-clients": "^3.998.3", + "@aws-sdk/types": "^3.975.1", + "@smithy/core": "^3.40.0", + "@smithy/types": "^4.20.0", + "tslib": "^2.6.2" + }, + "engines": { + "node": ">=20.0.0" + } + }, + "node_modules/@aws-sdk/dynamodb-codec": { + "version": "3.973.58", + "resolved": "https://registry.npmjs.org/@aws-sdk/dynamodb-codec/-/dynamodb-codec-3.973.58.tgz", + "integrity": "sha512-OrqMNzvjk37ssH/qoD6Cd25TLk2cT1lCMwCNM+frwbOQAKJuAbFSgH6OOtaI71l5fA8F7GPuMr9Ck57SAtY98g==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "@aws-sdk/core": "^3.981.0", + "@smithy/core": "^3.40.0", + "@smithy/types": "^4.20.0", + "tslib": "^2.6.2" + }, + "engines": { + "node": ">=20.0.0" + } + }, + "node_modules/@aws-sdk/endpoint-cache": { + "version": "3.972.11", + "resolved": "https://registry.npmjs.org/@aws-sdk/endpoint-cache/-/endpoint-cache-3.972.11.tgz", + "integrity": "sha512-8q1ICxcDjHId3bBryuu/j+1L9y5/3uQnwzLDt5j2ElcjZSoWmFtymdJy7OjLrluSMe0Z4mq5bcH4fxBXvlEHfw==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "mnemonist": "0.38.3", + "tslib": "^2.6.2" + }, + "engines": { + "node": ">=20.0.0" + } + }, + "node_modules/@aws-sdk/middleware-endpoint-discovery": { + "version": "3.972.39", + "resolved": "https://registry.npmjs.org/@aws-sdk/middleware-endpoint-discovery/-/middleware-endpoint-discovery-3.972.39.tgz", + "integrity": "sha512-AtZS+UK7CciPbdiszPoG08A23kUojFxFnWIv155uPieSPcHR9D9Sovtp19U0j5qmD2DzHpG9OI7mb0Kiyvf3mA==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "@aws-sdk/endpoint-cache": "^3.972.11", + "@aws-sdk/types": "^3.975.1", + "@smithy/core": "^3.40.0", + "@smithy/types": "^4.20.0", "tslib": "^2.6.2" }, "engines": { @@ -279,19 +348,19 @@ } }, "node_modules/@aws-sdk/nested-clients": { - "version": "3.997.54", - "resolved": "https://registry.npmjs.org/@aws-sdk/nested-clients/-/nested-clients-3.997.54.tgz", - "integrity": "sha512-/OczlavsS7U5sOodRO10Ug4R/AKFVZiXTstKipWe68EfjPkmdDFNXNl9FCJyXWkg1DG6RBm3qAuVB8FNW9O8KQ==", + "version": "3.998.3", + "resolved": "https://registry.npmjs.org/@aws-sdk/nested-clients/-/nested-clients-3.998.3.tgz", + "integrity": "sha512-acHTTzMB13CU6dU4sxABYExMI3PQM2zStWH2MiUwJp/7QKTrLg2f7mbzSXoegW2kYOk2tdqQYagsZrWB8Xv7eA==", "dev": true, "license": "Apache-2.0", "dependencies": { - "@aws-sdk/core": "^3.979.1", - "@aws-sdk/signature-v4-multi-region": "^3.996.51", - "@aws-sdk/types": "^3.975.0", - "@smithy/core": "^3.38.0", - "@smithy/fetch-http-handler": "^5.8.0", - "@smithy/node-http-handler": "^4.14.0", - "@smithy/types": "^4.19.0", + "@aws-sdk/core": "^3.981.0", + "@aws-sdk/signature-v4-multi-region": "^3.996.52", + "@aws-sdk/types": "^3.975.1", + "@smithy/core": "^3.40.0", + "@smithy/fetch-http-handler": "^5.8.1", + "@smithy/node-http-handler": "^4.14.2", + "@smithy/types": "^4.20.0", "tslib": "^2.6.2" }, "engines": { @@ -299,15 +368,15 @@ } }, "node_modules/@aws-sdk/signature-v4-multi-region": { - "version": "3.996.51", - "resolved": "https://registry.npmjs.org/@aws-sdk/signature-v4-multi-region/-/signature-v4-multi-region-3.996.51.tgz", - "integrity": "sha512-+aHvUugVBuMPXxgkPfWnTMyGdE/yWS8GHi5+qQ37HowS0YqzrbuaDLznj+Dtmtu5jgCdqz36gXmujOToUhNNWw==", + "version": "3.996.52", + "resolved": "https://registry.npmjs.org/@aws-sdk/signature-v4-multi-region/-/signature-v4-multi-region-3.996.52.tgz", + "integrity": "sha512-6W6SjGc8OXUhMzNxU1X922ghD+PP1XvzmCk5Scui0jaYsLezycMYR1RaLp5xTIOUrhTXyb4DnAbPr3fBgmdnzg==", "dev": true, "license": "Apache-2.0", "dependencies": { - "@aws-sdk/types": "^3.975.0", + "@aws-sdk/types": "^3.975.1", "@smithy/signature-v4": "^5.7.5", - "@smithy/types": "^4.19.0", + "@smithy/types": "^4.20.0", "tslib": "^2.6.2" }, "engines": { @@ -315,17 +384,17 @@ } }, "node_modules/@aws-sdk/token-providers": { - "version": "3.1161.0", - "resolved": "https://registry.npmjs.org/@aws-sdk/token-providers/-/token-providers-3.1161.0.tgz", - "integrity": "sha512-ypbXSofNcSHwf/KA40bFCXJb0MLaAKrfT7sot4dFaA+2lsuXNah4zLRJIAU7Qmvs9PFJ6rnY0bZFEC+mE7attA==", + "version": "3.1166.0", + "resolved": "https://registry.npmjs.org/@aws-sdk/token-providers/-/token-providers-3.1166.0.tgz", + "integrity": "sha512-ngJ8mxXqtQ9mnp7QV6TWKJCxkpjVfPWxKQSc2FYhCyCfOVFIGdFv7P+/RqVffFrJAorwBPpktnv32gNlcEgF4g==", "dev": true, "license": "Apache-2.0", "dependencies": { - "@aws-sdk/core": "^3.979.1", - "@aws-sdk/nested-clients": "^3.997.54", - "@aws-sdk/types": "^3.975.0", - "@smithy/core": "^3.38.0", - "@smithy/types": "^4.19.0", + "@aws-sdk/core": "^3.981.0", + "@aws-sdk/nested-clients": "^3.998.3", + "@aws-sdk/types": "^3.975.1", + "@smithy/core": "^3.40.0", + "@smithy/types": "^4.20.0", "tslib": "^2.6.2" }, "engines": { @@ -333,13 +402,13 @@ } }, "node_modules/@aws-sdk/types": { - "version": "3.975.0", - "resolved": "https://registry.npmjs.org/@aws-sdk/types/-/types-3.975.0.tgz", - "integrity": "sha512-WQlhs6juByzWOzj5fwxOx0mPJaEqMcG/sDpl3Id61B3XhKE63xY+0QWcnG+sWR/sCfprmreyUo1lM7IKZmHMzw==", + "version": "3.975.1", + "resolved": "https://registry.npmjs.org/@aws-sdk/types/-/types-3.975.1.tgz", + "integrity": "sha512-7rGxUkCB2QPoQOeJmonmAICTN2zrH+fpmi1p4Iwu72lnxNaMhOgqcbpyddifnM1DBb19TWQ1u6z/XjkaFNEDWw==", "dev": true, "license": "Apache-2.0", "dependencies": { - "@smithy/types": "^4.19.0", + "@smithy/types": "^4.20.0", "tslib": "^2.6.2" }, "engines": { @@ -347,13 +416,13 @@ } }, "node_modules/@aws-sdk/xml-builder": { - "version": "3.972.42", - "resolved": "https://registry.npmjs.org/@aws-sdk/xml-builder/-/xml-builder-3.972.42.tgz", - "integrity": "sha512-smX8/gNP8Kjq+CWTBMZQLQ912vOQjiWExzwzvMO+eujPB5RY8IbtF0AGdUUXHKN7KoDWK9dIcuW0WG269kiP6w==", + "version": "3.972.43", + "resolved": "https://registry.npmjs.org/@aws-sdk/xml-builder/-/xml-builder-3.972.43.tgz", + "integrity": "sha512-rG8QVx4DOrJWptsogu1Aq+CDsnPKaBrAlJpKLxrJrIDXAq1ElnW0yQjjBnlWSXll0cDakCG6UDvaqwz0A9d9Og==", "dev": true, "license": "Apache-2.0", "dependencies": { - "@smithy/types": "^4.19.0", + "@smithy/types": "^4.20.0", "tslib": "^2.6.2" }, "engines": { @@ -4876,13 +4945,13 @@ "peer": true }, "node_modules/@smithy/core": { - "version": "3.38.1", - "resolved": "https://registry.npmjs.org/@smithy/core/-/core-3.38.1.tgz", - "integrity": "sha512-U/mB2XiwTLaf+NSgLSWwJfptsMT/H8aBi0aTAA/E5e2/TagFeGCqAyhKGG0w0A9IWTkm4qYEmLoD/HB6aYfnRA==", + "version": "3.40.0", + "resolved": "https://registry.npmjs.org/@smithy/core/-/core-3.40.0.tgz", + "integrity": "sha512-DssGno52pzZ5m6RlDtyKuBIpZNPg9pqgs0CnNDKz9IatxCsmvNmJNn5Zn6rf77MthZo9wf89OvZFhTY/RwxhxQ==", "dev": true, "license": "Apache-2.0", "dependencies": { - "@smithy/types": "^4.19.0", + "@smithy/types": "^4.20.0", "tslib": "^2.6.2" }, "engines": { @@ -4905,14 +4974,14 @@ } }, "node_modules/@smithy/fetch-http-handler": { - "version": "5.8.0", - "resolved": "https://registry.npmjs.org/@smithy/fetch-http-handler/-/fetch-http-handler-5.8.0.tgz", - "integrity": "sha512-ycSJu3tFAQ4v04CBB0agqFMVsSQ1iG3yw+SpgxRqKfaURpQD4CZ8Wn0zPMmSnOuTpTh65Vz+EA0rMrw089wvkA==", + "version": "5.8.1", + "resolved": "https://registry.npmjs.org/@smithy/fetch-http-handler/-/fetch-http-handler-5.8.1.tgz", + "integrity": "sha512-h8BdMUrUBhMhMaeK7QqAdINRZezCGuYOCpcOZZ1ewxbHST9rdTd09xwNpvLTYfzDRehxQiReK4SKbdYZxBA+ew==", "dev": true, "license": "Apache-2.0", "dependencies": { - "@smithy/core": "^3.33.3", - "@smithy/types": "^4.18.0", + "@smithy/core": "^3.39.0", + "@smithy/types": "^4.20.0", "tslib": "^2.6.2" }, "engines": { @@ -4920,14 +4989,14 @@ } }, "node_modules/@smithy/node-http-handler": { - "version": "4.14.1", - "resolved": "https://registry.npmjs.org/@smithy/node-http-handler/-/node-http-handler-4.14.1.tgz", - "integrity": "sha512-/T6E1jzCL0fErS9uq8JqES/5yYQQ4ppVmmYHwXw2nlov8KFzLb+3QqHR5iAun1BsuAB50IPxZliV8YMgghLwhA==", + "version": "4.14.2", + "resolved": "https://registry.npmjs.org/@smithy/node-http-handler/-/node-http-handler-4.14.2.tgz", + "integrity": "sha512-i1uORV1v3qBqP43ayRKzIdm1q5x14tf8N4Dd06/QUX1Szm6VxHMrTsu20X5E63UFsaNZCRjI4SXG0jDmqYa+3w==", "dev": true, "license": "Apache-2.0", "dependencies": { - "@smithy/core": "^3.38.1", - "@smithy/types": "^4.19.0", + "@smithy/core": "^3.39.0", + "@smithy/types": "^4.20.0", "tslib": "^2.6.2" }, "engines": { @@ -4950,9 +5019,9 @@ } }, "node_modules/@smithy/types": { - "version": "4.19.0", - "resolved": "https://registry.npmjs.org/@smithy/types/-/types-4.19.0.tgz", - "integrity": "sha512-r7jh49VJxGerfAcTQA6gXcKc+98zOp/tqRwzYjgOE+iSQsP6cEU1hq2QzbuipmP68QtYdY9wKEhiCQZIzHgZ4Q==", + "version": "4.20.0", + "resolved": "https://registry.npmjs.org/@smithy/types/-/types-4.20.0.tgz", + "integrity": "sha512-lCA6QG22dPk9ecHbv91jDQZsmtPUjdS1aE2Il6NNPqe7DrYc0dZQi6DhcESk2KYXH2sp5xbAcGdYMZDFnuzA2A==", "dev": true, "license": "Apache-2.0", "dependencies": { @@ -5016,6 +5085,10 @@ "resolved": "packages/modules/couchdb", "link": true }, + "node_modules/@testcontainers/dynamodb": { + "resolved": "packages/modules/dynamodb", + "link": true + }, "node_modules/@testcontainers/elasticsearch": { "resolved": "packages/modules/elasticsearch", "link": true @@ -10557,6 +10630,16 @@ "integrity": "sha512-gKLcREMhtuZRwRAfqP3RFW+TK4JqApVBtOIftVgjuABpAtpxhPGaDcfvbhNvD0B8iD1oUr/txX35NjcaY6Ns/A==", "license": "MIT" }, + "node_modules/mnemonist": { + "version": "0.38.3", + "resolved": "https://registry.npmjs.org/mnemonist/-/mnemonist-0.38.3.tgz", + "integrity": "sha512-2K9QYubXx/NAjv4VLq1d1Ly8pWNC5L3BrixtdkyTegXWJIqY+zLNDhhX/A+ZwWt70tB1S8H4BE8FLYEFyNoOBw==", + "dev": true, + "license": "MIT", + "dependencies": { + "obliterator": "^1.6.1" + } + }, "node_modules/mockserver-client": { "version": "9.2.0", "resolved": "https://registry.npmjs.org/mockserver-client/-/mockserver-client-9.2.0.tgz", @@ -11221,6 +11304,13 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/obliterator": { + "version": "1.6.1", + "resolved": "https://registry.npmjs.org/obliterator/-/obliterator-1.6.1.tgz", + "integrity": "sha512-9WXswnqINnnhOG/5SLimUlzuU1hFJUc8zkwyD59Sd+dPOMf05PmnYG/d6Q7HZ+KmgkZJa1PxRso6QdM3sTNHig==", + "dev": true, + "license": "MIT" + }, "node_modules/obug": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/obug/-/obug-3.0.0.tgz", @@ -14494,6 +14584,17 @@ "nano": "^11.0.7" } }, + "packages/modules/dynamodb": { + "name": "@testcontainers/dynamodb", + "version": "12.2.1", + "license": "MIT", + "dependencies": { + "testcontainers": "^12.2.1" + }, + "devDependencies": { + "@aws-sdk/client-dynamodb": "^3.1166.0" + } + }, "packages/modules/elasticsearch": { "name": "@testcontainers/elasticsearch", "version": "12.2.1", diff --git a/packages/modules/dynamodb/Dockerfile b/packages/modules/dynamodb/Dockerfile new file mode 100644 index 000000000..4fc11a57d --- /dev/null +++ b/packages/modules/dynamodb/Dockerfile @@ -0,0 +1 @@ +FROM amazon/dynamodb-local:3.3.2 diff --git a/packages/modules/dynamodb/package.json b/packages/modules/dynamodb/package.json new file mode 100644 index 000000000..c5fc96855 --- /dev/null +++ b/packages/modules/dynamodb/package.json @@ -0,0 +1,37 @@ +{ + "name": "@testcontainers/dynamodb", + "version": "12.2.1", + "license": "MIT", + "keywords": [ + "dynamodb", + "testing", + "docker", + "testcontainers" + ], + "description": "DynamoDB module for Testcontainers", + "homepage": "https://github.com/testcontainers/testcontainers-node#readme", + "repository": { + "type": "git", + "url": "git+https://github.com/testcontainers/testcontainers-node.git" + }, + "bugs": { + "url": "https://github.com/testcontainers/testcontainers-node/issues" + }, + "main": "build/index.js", + "files": [ + "build" + ], + "publishConfig": { + "access": "public" + }, + "scripts": { + "prepack": "shx cp ../../../README.md . && shx cp ../../../LICENSE .", + "build": "tsc --project tsconfig.build.json" + }, + "dependencies": { + "testcontainers": "^12.2.1" + }, + "devDependencies": { + "@aws-sdk/client-dynamodb": "^3.1166.0" + } +} diff --git a/packages/modules/dynamodb/src/dynamodb-container.test.ts b/packages/modules/dynamodb/src/dynamodb-container.test.ts new file mode 100644 index 000000000..0af0e79c2 --- /dev/null +++ b/packages/modules/dynamodb/src/dynamodb-container.test.ts @@ -0,0 +1,268 @@ +import { + CreateTableCommand, + DeleteTableCommand, + DynamoDBClient, + GetItemCommand, + ListTablesCommand, + PutItemCommand, + waitUntilTableExists, + waitUntilTableNotExists, +} from "@aws-sdk/client-dynamodb"; +import { describe, it } from "vitest"; +import { getImage } from "../../../testcontainers/src/utils/test-helper"; +import { DynamoDBContainer } from "./dynamodb-container"; + +const IMAGE = getImage(__dirname); + +/** + * Create an empty dummy user table + * + * This function can be used in test cases + * to easily add a new table. + * + * @param client - DynamoDBClient pointing to the container + * @param tableName - The desired table name + * @returns - Three functions: teardown, addUser, getUser + */ +async function createDummyTable( + client: DynamoDBClient, + tableName: string +): Promise<{ + teardown: () => Promise; + addUser: (userId: number, name: string) => Promise; + getUser: (userId: number) => Promise; +}> { + const command = new CreateTableCommand({ + TableName: tableName, + BillingMode: "PAY_PER_REQUEST", + AttributeDefinitions: [ + { + AttributeName: "userId", + AttributeType: "N", + }, + ], + KeySchema: [ + { + AttributeName: "userId", + KeyType: "HASH", + }, + ], + }); + + await client.send(command); + await waitUntilTableExists({ client, maxWaitTime: 30 }, { TableName: tableName }); + + return { + teardown: async (): Promise => { + const deleteCommand = new DeleteTableCommand({ TableName: tableName }); + await client.send(deleteCommand); + await waitUntilTableNotExists({ client, maxWaitTime: 30 }, { TableName: tableName }); + }, + addUser: async (userId, name) => { + const putCommand = new PutItemCommand({ + TableName: tableName, + Item: { + userId: { N: userId.toString() }, + name: { S: name }, + }, + }); + await client.send(putCommand); + }, + getUser: async (userId) => { + const getCommand = new GetItemCommand({ + TableName: tableName, + Key: { + userId: { N: userId.toString() }, + }, + ConsistentRead: true, + }); + const response = await client.send(getCommand); + if (response.Item?.name?.S) { + return response.Item.name.S; + } + return null; + }, + }; +} + +describe("DynamoDBContainer", { timeout: 180_000 }, () => { + it("starts a container", async () => { + // connectClientConfig { + await using container = await new DynamoDBContainer(IMAGE).start(); + const client = new DynamoDBClient(container.clientConfig()); + + const command = new ListTablesCommand({}); + const result = await client.send(command); + + expect(result.TableNames).toStrictEqual([]); + // } + }); + + it("connects with endpoint", async () => { + // connectEndpoint { + await using container = await new DynamoDBContainer(IMAGE).start(); + const client = new DynamoDBClient({ + region: "us-east-1", + credentials: { + accessKeyId: "AKIAIOSFODNN7EXAMPLE", + secretAccessKey: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + }, + endpoint: container.getEndpoint(), + }); + + const command = new ListTablesCommand({}); + const result = await client.send(command); + + expect(result.TableNames).toStrictEqual([]); + // } + }); + + it("stores data", async () => { + await using container = await new DynamoDBContainer(IMAGE).start(); + const client = new DynamoDBClient(container.clientConfig()); + + const { teardown, addUser, getUser } = await createDummyTable(client, "users"); + + await addUser(1, "Bob"); + await addUser(2, "Alice"); + + const userA = await getUser(1); + const userB = await getUser(2); + expect(userA).toBe("Bob"); + expect(userB).toBe("Alice"); + + await teardown(); + }); + + it("separates data by client by default", async () => { + await using container = await new DynamoDBContainer(IMAGE).start(); + + // Uses dummy credentials from the documentation + const clientA = new DynamoDBClient({ + region: "eu-central-1", + endpoint: container.getEndpoint(), + credentials: { + accessKeyId: "AKIAIOSFODNN7EXAMPLE", + secretAccessKey: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + }, + }); + + // Uses slightly different credentials to simulate another + // AWS account + const clientB = new DynamoDBClient({ + region: "eu-central-1", + endpoint: container.getEndpoint(), + credentials: { + accessKeyId: "AKIAIOSFODNN7EXAMPL2", + secretAccessKey: "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", + }, + }); + + await createDummyTable(clientA, "users"); + + const resultA = await clientA.send(new ListTablesCommand()); + const resultB = await clientB.send(new ListTablesCommand()); + + // Since clientA created the table, only clientA should see it + expect(resultA.TableNames).toStrictEqual(["users"]); + expect(resultB.TableNames).toStrictEqual([]); + }); + + it("uses a shared table when requested", async () => { + // sharedDB { + await using container = await new DynamoDBContainer(IMAGE).withSharedDB().start(); + + // Both clients will see the same data eventhough the + // ACCESS_KEY_ID differ + const clientA = new DynamoDBClient({ + region: "us-east-1", + endpoint: container.getEndpoint(), + credentials: { + accessKeyId: "AKIAIOSFODNN7EXAMPLE", + secretAccessKey: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + }, + }); + + const clientB = new DynamoDBClient({ + region: "us-east-1", + endpoint: container.getEndpoint(), + credentials: { + accessKeyId: "AKIAIOSFODNN7EXAMPL2", + secretAccessKey: "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", + }, + }); + // } + + await createDummyTable(clientA, "users"); + + const resultA = await clientA.send(new ListTablesCommand()); + const resultB = await clientB.send(new ListTablesCommand()); + + // Eventhough clientA created the table, both should see it due to + // the shared table design + expect(resultA.TableNames).toStrictEqual(["users"]); + expect(resultB.TableNames).toStrictEqual(["users"]); + }); + + it("persists data when dbPath is set", async () => { + // persistWithDbPath { + await using container = await new DynamoDBContainer(IMAGE).withDbPath(".").start(); + const client = new DynamoDBClient(container.clientConfig()); + // } + + const { addUser } = await createDummyTable(client, "users"); + await addUser(1, "Bob"); + + await container.restart(); + + // restarting will change the mapped port so we need a new client + const clientAfterRestart = new DynamoDBClient(container.clientConfig()); + + // The table should still be there including its content + const command = new GetItemCommand({ + TableName: "users", + Key: { userId: { N: "1" } }, + ConsistentRead: true, + }); + const response = await clientAfterRestart.send(command); + expect(response.Item).toStrictEqual({ + userId: { N: "1" }, + name: { S: "Bob" }, + }); + }); + + it("stores data only in memory when requested", async () => { + // withInMemory { + await using container = await new DynamoDBContainer(IMAGE).withInMemory().start(); + const client = new DynamoDBClient(container.clientConfig()); + // } + + const { addUser } = await createDummyTable(client, "users"); + await addUser(1, "Bob"); + + await container.restart(); + + // restarting will change the mapped port so we need a new client + const clientAfterRestart = new DynamoDBClient(container.clientConfig()); + + // We should not be able to see the table anymore + const result = await clientAfterRestart.send(new ListTablesCommand()); + expect(result.TableNames).toStrictEqual([]); + }); + + it("allows to disable telemetry", async () => { + /* Unfortunately there is no way to validate this right now, but at + * least we know it does not pass something invalid to the container + */ + + // disabledTelemetry { + await using container = await new DynamoDBContainer(IMAGE).withDisableTelemetry().start(); + const client = new DynamoDBClient(container.clientConfig()); + // } + + const command = new ListTablesCommand({}); + const result = await client.send(command); + + expect(result.TableNames).toStrictEqual([]); + }); +}); diff --git a/packages/modules/dynamodb/src/dynamodb-container.ts b/packages/modules/dynamodb/src/dynamodb-container.ts new file mode 100644 index 000000000..556608f35 --- /dev/null +++ b/packages/modules/dynamodb/src/dynamodb-container.ts @@ -0,0 +1,182 @@ +import { AbstractStartedContainer, GenericContainer } from "testcontainers"; + +// https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBLocal.UsageNotes.html#DynamoDBLocal.Endpoint +const DYNAMODB_PORT = 8000; + +/* When running in AWS we do not have to pass any client configuration: + * + * * The default endpoint will be used + * * The region will be inferred from the lambda region + * * The credentials are taken from the lambda IAM role + * + * When connecting locally, we have to provide all three eventhough region + * and credentials are not really relevant. We want to help the user with + * a minimal configuration that works + */ +type DynamoDBLocalClientConfig = { + endpoint: string; + region: string; + credentials: { + readonly accessKeyId: string; + readonly secretAccessKey: string; + }; +}; + +export class DynamoDBContainer extends GenericContainer { + private sharedDB: boolean = false; + private inMemory: boolean = false; + private disableTelemetry: boolean = false; + private dbPath?: string; + + constructor(image: string) { + super(image); + this.withExposedPorts(DYNAMODB_PORT).withStartupTimeout(120_000); + } + + /** + * Share table between clients + * + * By default the DynamoDB container will present different tables + * depending on the current AWS access key. + * + * Use this option to use a shared database instead. This will + * pass ´-sharedDb` to the container. For more information please read + * https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBLocal.UsageNotes.html#DynamoDBLocal.CommandLineOptions + */ + public withSharedDB(): this { + this.sharedDB = true; + return this; + } + + /** + * Specify a database path + * + * Specify a directory (for example `.`) to persist the + * database. This can be used to preserve tables between container + * restarts but in general is not required. + * + * This option will set `-dbPath` when invoking the container. + * Fore more information please read + * https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBLocal.UsageNotes.html#DynamoDBLocal.CommandLineOptions + * + * @param dbPath - The path to the database file inside the container + */ + public withDbPath(dbPath: string): this { + this.dbPath = dbPath; + return this; + } + + /** + * Ensure the database is kept in memory + * + * Use this option to keep the complete database in memory. This will + * pass `-inMemory` to the container. + * Fore more information please read + * https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBLocal.UsageNotes.html#DynamoDBLocal.CommandLineOptions + */ + public withInMemory(): this { + this.inMemory = true; + return this; + } + + /** + * Do not sent any telemetry + * + * By default the AWS DynamoDB container will sent telemetry information. + * Use this option to pass `-disableTelemetry` to the container + * Fore more information please read + * https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBLocal.UsageNotes.html#DynamoDBLocal.CommandLineOptions + */ + public withDisableTelemetry(): this { + this.disableTelemetry = true; + return this; + } + + private createCommand(): string[] | null { + const command: string[] = []; + if (this.sharedDB) { + command.push("-sharedDb"); + } + if (this.inMemory) { + command.push("-inMemory"); + } + if (this.disableTelemetry) { + command.push("-disableTelemetry"); + } + if (this.dbPath) { + command.push("-dbPath", this.dbPath); + } + + if (command.length === 0) { + return null; + } + + // If we pass arguments we also have to pass + // -jar DynamoDBLocal.jar + return ["-jar", "DynamoDBLocal.jar", ...command]; + } + + /** + * Start the DynamoDB container + */ + public override async start(): Promise { + const command = this.createCommand(); + if (command) { + this.withCommand(command); + } + + const started = await super.start(); + return new StartedDynamoDBContainer(started); + } +} + +export class StartedDynamoDBContainer extends AbstractStartedContainer { + public getPort(): number { + return this.startedTestContainer.getMappedPort(DYNAMODB_PORT); + } + + /*+ + * Returns the endpoint to reach the DynamoDB service + * + * The returned endpoint can be used to pass to your DynamoDB client. You + * can also use `clientConfig` instead which provides you a complete + * client configuration suitable for most usecases + */ + public getEndpoint(): string { + const hostname = this.getHost(); + const url = new URL(`http://${hostname}`); + url.port = this.getPort().toString(); + return url.toString(); + } + + /** + * Returns a partial DynamoDBConfig + * + * When intializing a DynamoDB client inside AWS itself (e.g. inside a + * lambda) we do not have to pass any configuration settings. When + * connecting locally, we have to set at least `endpoint`, + * `region` (can be a dummy) and `credentials` (can also be a dummy). + * + * `clientConfig` will return minimal configuration with `endpoint`, a dummy + * `region` of `us-east-1` and dummy credentials. + * + * This allows you to intialize a client through + * + * ```js + * const client = new DynamoDBClient(container.clientConfig()); + * ``` + */ + public clientConfig(): DynamoDBLocalClientConfig { + // The AWS credentials you see here are fake credentials and taken from the + // following example: + // https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html + return { + endpoint: this.getEndpoint(), + region: "us-east-1", + credentials: { + accessKeyId: "AKIAIOSFODNN7EXAMPLE", + secretAccessKey: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + }, + }; + } +} diff --git a/packages/modules/dynamodb/src/index.ts b/packages/modules/dynamodb/src/index.ts new file mode 100644 index 000000000..9c6beccd5 --- /dev/null +++ b/packages/modules/dynamodb/src/index.ts @@ -0,0 +1 @@ +export { DynamoDBContainer, StartedDynamoDBContainer } from "./dynamodb-container"; diff --git a/packages/modules/dynamodb/tsconfig.build.json b/packages/modules/dynamodb/tsconfig.build.json new file mode 100644 index 000000000..91dc68846 --- /dev/null +++ b/packages/modules/dynamodb/tsconfig.build.json @@ -0,0 +1,9 @@ +{ + "extends": "./tsconfig.json", + "exclude": ["build", "src/**/*.test.ts"], + "references": [ + { + "path": "../../testcontainers" + } + ] +} diff --git a/packages/modules/dynamodb/tsconfig.json b/packages/modules/dynamodb/tsconfig.json new file mode 100644 index 000000000..a06097b42 --- /dev/null +++ b/packages/modules/dynamodb/tsconfig.json @@ -0,0 +1,16 @@ +{ + "extends": "../../../tsconfig.base.json", + "compilerOptions": { + "rootDir": "src", + "outDir": "build", + "paths": { + "testcontainers": ["../../testcontainers/src"] + } + }, + "exclude": ["build"], + "references": [ + { + "path": "../../testcontainers" + } + ] +} From d9353dc19503c7df1d464acb339ecd329bc1c311 Mon Sep 17 00:00:00 2001 From: Stefan Schulte Date: Mon, 26 Oct 2026 17:49:02 +0100 Subject: [PATCH 02/11] DynamoDB: Move helper beyond caller The project coding guidelines wants helper functions go beyond the caller, so we now move `createCommand` to the bottom. --- .../dynamodb/src/dynamodb-container.ts | 26 +++++++++---------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/packages/modules/dynamodb/src/dynamodb-container.ts b/packages/modules/dynamodb/src/dynamodb-container.ts index 556608f35..fd3cb4507 100644 --- a/packages/modules/dynamodb/src/dynamodb-container.ts +++ b/packages/modules/dynamodb/src/dynamodb-container.ts @@ -92,6 +92,19 @@ export class DynamoDBContainer extends GenericContainer { return this; } + /** + * Start the DynamoDB container + */ + public override async start(): Promise { + const command = this.createCommand(); + if (command) { + this.withCommand(command); + } + + const started = await super.start(); + return new StartedDynamoDBContainer(started); + } + private createCommand(): string[] | null { const command: string[] = []; if (this.sharedDB) { @@ -115,19 +128,6 @@ export class DynamoDBContainer extends GenericContainer { // -jar DynamoDBLocal.jar return ["-jar", "DynamoDBLocal.jar", ...command]; } - - /** - * Start the DynamoDB container - */ - public override async start(): Promise { - const command = this.createCommand(); - if (command) { - this.withCommand(command); - } - - const started = await super.start(); - return new StartedDynamoDBContainer(started); - } } export class StartedDynamoDBContainer extends AbstractStartedContainer { From 9d1ce09c46a844066a0fb46083391afe599b75bd Mon Sep 17 00:00:00 2001 From: Stefan Schulte Date: Mon, 26 Oct 2026 17:56:54 +0100 Subject: [PATCH 03/11] DynamoDB: Remove withInMemory The default arguments of `dynamodb-local` already include `-inMemory` so we do not need a helper to enable it. Disabling should be possible when specifying a database path. --- .../dynamodb/src/dynamodb-container.test.ts | 6 ++--- .../dynamodb/src/dynamodb-container.ts | 25 ++++--------------- 2 files changed, 7 insertions(+), 24 deletions(-) diff --git a/packages/modules/dynamodb/src/dynamodb-container.test.ts b/packages/modules/dynamodb/src/dynamodb-container.test.ts index 0af0e79c2..004da208e 100644 --- a/packages/modules/dynamodb/src/dynamodb-container.test.ts +++ b/packages/modules/dynamodb/src/dynamodb-container.test.ts @@ -231,11 +231,9 @@ describe("DynamoDBContainer", { timeout: 180_000 }, () => { }); }); - it("stores data only in memory when requested", async () => { - // withInMemory { - await using container = await new DynamoDBContainer(IMAGE).withInMemory().start(); + it("stores data in memory when no dbPath set", async () => { + await using container = await new DynamoDBContainer(IMAGE).start(); const client = new DynamoDBClient(container.clientConfig()); - // } const { addUser } = await createDummyTable(client, "users"); await addUser(1, "Bob"); diff --git a/packages/modules/dynamodb/src/dynamodb-container.ts b/packages/modules/dynamodb/src/dynamodb-container.ts index fd3cb4507..1421b3176 100644 --- a/packages/modules/dynamodb/src/dynamodb-container.ts +++ b/packages/modules/dynamodb/src/dynamodb-container.ts @@ -24,7 +24,6 @@ type DynamoDBLocalClientConfig = { export class DynamoDBContainer extends GenericContainer { private sharedDB: boolean = false; - private inMemory: boolean = false; private disableTelemetry: boolean = false; private dbPath?: string; @@ -66,19 +65,6 @@ export class DynamoDBContainer extends GenericContainer { return this; } - /** - * Ensure the database is kept in memory - * - * Use this option to keep the complete database in memory. This will - * pass `-inMemory` to the container. - * Fore more information please read - * https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBLocal.UsageNotes.html#DynamoDBLocal.CommandLineOptions - */ - public withInMemory(): this { - this.inMemory = true; - return this; - } - /** * Do not sent any telemetry * @@ -107,26 +93,25 @@ export class DynamoDBContainer extends GenericContainer { private createCommand(): string[] | null { const command: string[] = []; + let skipInMemory = false; if (this.sharedDB) { command.push("-sharedDb"); } - if (this.inMemory) { - command.push("-inMemory"); - } if (this.disableTelemetry) { command.push("-disableTelemetry"); } if (this.dbPath) { command.push("-dbPath", this.dbPath); + skipInMemory = true; } if (command.length === 0) { return null; } - // If we pass arguments we also have to pass - // -jar DynamoDBLocal.jar - return ["-jar", "DynamoDBLocal.jar", ...command]; + // The defaut command is + // -jar DynamoDBLocal.jar -inMemory + return ["-jar", "DynamoDBLocal.jar", ...(skipInMemory ? [] : ["-inMemory"]), ...command]; } } From c4a6bd85ad31915478d7a9e04ec35c28db7ced67 Mon Sep 17 00:00:00 2001 From: Stefan Schulte Date: Mon, 26 Oct 2026 20:26:25 +0100 Subject: [PATCH 04/11] DynamoDB: Drop support for client config --- docs/modules/dynamodb.md | 8 -- .../dynamodb/src/dynamodb-container.test.ts | 73 ++++++++++++++----- .../dynamodb/src/dynamodb-container.ts | 50 ------------- 3 files changed, 55 insertions(+), 76 deletions(-) diff --git a/docs/modules/dynamodb.md b/docs/modules/dynamodb.md index c1ff070b7..d93da13e2 100644 --- a/docs/modules/dynamodb.md +++ b/docs/modules/dynamodb.md @@ -26,14 +26,6 @@ will not be used: [](../../packages/modules/dynamodb/src/dynamodb-container.test.ts) inside_block:connectEndpoint -### Connect via client config - -The above can also be written as - - -[](../../packages/modules/dynamodb/src/dynamodb-container.test.ts) inside_block:connectClientConfig - - ### Use a shared database diff --git a/packages/modules/dynamodb/src/dynamodb-container.test.ts b/packages/modules/dynamodb/src/dynamodb-container.test.ts index 004da208e..97253d721 100644 --- a/packages/modules/dynamodb/src/dynamodb-container.test.ts +++ b/packages/modules/dynamodb/src/dynamodb-container.test.ts @@ -86,24 +86,13 @@ async function createDummyTable( } describe("DynamoDBContainer", { timeout: 180_000 }, () => { - it("starts a container", async () => { - // connectClientConfig { - await using container = await new DynamoDBContainer(IMAGE).start(); - const client = new DynamoDBClient(container.clientConfig()); - - const command = new ListTablesCommand({}); - const result = await client.send(command); - - expect(result.TableNames).toStrictEqual([]); - // } - }); - it("connects with endpoint", async () => { // connectEndpoint { await using container = await new DynamoDBContainer(IMAGE).start(); const client = new DynamoDBClient({ region: "us-east-1", credentials: { + // use any credentials accessKeyId: "AKIAIOSFODNN7EXAMPLE", secretAccessKey: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", }, @@ -119,7 +108,15 @@ describe("DynamoDBContainer", { timeout: 180_000 }, () => { it("stores data", async () => { await using container = await new DynamoDBContainer(IMAGE).start(); - const client = new DynamoDBClient(container.clientConfig()); + const client = new DynamoDBClient({ + region: "us-east-1", + credentials: { + // use any credentials + accessKeyId: "AKIAIOSFODNN7EXAMPLE", + secretAccessKey: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + }, + endpoint: container.getEndpoint(), + }); const { teardown, addUser, getUser } = await createDummyTable(client, "users"); @@ -207,7 +204,15 @@ describe("DynamoDBContainer", { timeout: 180_000 }, () => { it("persists data when dbPath is set", async () => { // persistWithDbPath { await using container = await new DynamoDBContainer(IMAGE).withDbPath(".").start(); - const client = new DynamoDBClient(container.clientConfig()); + const client = new DynamoDBClient({ + region: "us-east-1", + credentials: { + // use any credentials + accessKeyId: "AKIAIOSFODNN7EXAMPLE", + secretAccessKey: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + }, + endpoint: container.getEndpoint(), + }); // } const { addUser } = await createDummyTable(client, "users"); @@ -216,7 +221,15 @@ describe("DynamoDBContainer", { timeout: 180_000 }, () => { await container.restart(); // restarting will change the mapped port so we need a new client - const clientAfterRestart = new DynamoDBClient(container.clientConfig()); + const clientAfterRestart = new DynamoDBClient({ + region: "us-east-1", + credentials: { + // use any credentials + accessKeyId: "AKIAIOSFODNN7EXAMPLE", + secretAccessKey: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + }, + endpoint: container.getEndpoint(), + }); // The table should still be there including its content const command = new GetItemCommand({ @@ -233,7 +246,15 @@ describe("DynamoDBContainer", { timeout: 180_000 }, () => { it("stores data in memory when no dbPath set", async () => { await using container = await new DynamoDBContainer(IMAGE).start(); - const client = new DynamoDBClient(container.clientConfig()); + const client = new DynamoDBClient({ + region: "us-east-1", + credentials: { + // use any credentials + accessKeyId: "AKIAIOSFODNN7EXAMPLE", + secretAccessKey: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + }, + endpoint: container.getEndpoint(), + }); const { addUser } = await createDummyTable(client, "users"); await addUser(1, "Bob"); @@ -241,7 +262,15 @@ describe("DynamoDBContainer", { timeout: 180_000 }, () => { await container.restart(); // restarting will change the mapped port so we need a new client - const clientAfterRestart = new DynamoDBClient(container.clientConfig()); + const clientAfterRestart = new DynamoDBClient({ + region: "us-east-1", + credentials: { + // use any credentials + accessKeyId: "AKIAIOSFODNN7EXAMPLE", + secretAccessKey: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + }, + endpoint: container.getEndpoint(), + }); // We should not be able to see the table anymore const result = await clientAfterRestart.send(new ListTablesCommand()); @@ -255,7 +284,15 @@ describe("DynamoDBContainer", { timeout: 180_000 }, () => { // disabledTelemetry { await using container = await new DynamoDBContainer(IMAGE).withDisableTelemetry().start(); - const client = new DynamoDBClient(container.clientConfig()); + const client = new DynamoDBClient({ + region: "us-east-1", + credentials: { + // use any credentials + accessKeyId: "AKIAIOSFODNN7EXAMPLE", + secretAccessKey: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + }, + endpoint: container.getEndpoint(), + }); // } const command = new ListTablesCommand({}); diff --git a/packages/modules/dynamodb/src/dynamodb-container.ts b/packages/modules/dynamodb/src/dynamodb-container.ts index 1421b3176..f7ff6bce5 100644 --- a/packages/modules/dynamodb/src/dynamodb-container.ts +++ b/packages/modules/dynamodb/src/dynamodb-container.ts @@ -3,25 +3,6 @@ import { AbstractStartedContainer, GenericContainer } from "testcontainers"; // https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBLocal.UsageNotes.html#DynamoDBLocal.Endpoint const DYNAMODB_PORT = 8000; -/* When running in AWS we do not have to pass any client configuration: - * - * * The default endpoint will be used - * * The region will be inferred from the lambda region - * * The credentials are taken from the lambda IAM role - * - * When connecting locally, we have to provide all three eventhough region - * and credentials are not really relevant. We want to help the user with - * a minimal configuration that works - */ -type DynamoDBLocalClientConfig = { - endpoint: string; - region: string; - credentials: { - readonly accessKeyId: string; - readonly secretAccessKey: string; - }; -}; - export class DynamoDBContainer extends GenericContainer { private sharedDB: boolean = false; private disableTelemetry: boolean = false; @@ -133,35 +114,4 @@ export class StartedDynamoDBContainer extends AbstractStartedContainer { url.port = this.getPort().toString(); return url.toString(); } - - /** - * Returns a partial DynamoDBConfig - * - * When intializing a DynamoDB client inside AWS itself (e.g. inside a - * lambda) we do not have to pass any configuration settings. When - * connecting locally, we have to set at least `endpoint`, - * `region` (can be a dummy) and `credentials` (can also be a dummy). - * - * `clientConfig` will return minimal configuration with `endpoint`, a dummy - * `region` of `us-east-1` and dummy credentials. - * - * This allows you to intialize a client through - * - * ```js - * const client = new DynamoDBClient(container.clientConfig()); - * ``` - */ - public clientConfig(): DynamoDBLocalClientConfig { - // The AWS credentials you see here are fake credentials and taken from the - // following example: - // https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html - return { - endpoint: this.getEndpoint(), - region: "us-east-1", - credentials: { - accessKeyId: "AKIAIOSFODNN7EXAMPLE", - secretAccessKey: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", - }, - }; - } } From bcc3ca19b3135b53b72da19b4e4b9de11a457693 Mon Sep 17 00:00:00 2001 From: Stefan Schulte Date: Mon, 26 Oct 2026 20:43:28 +0100 Subject: [PATCH 05/11] DynamoDB: Improve testcase for withDisableTelemetry We cannot really observe a change in behaviour to validate telemetry is disabled but we can at least validate we are passing the correct command to our container. --- .../modules/dynamodb/src/dynamodb-container.test.ts | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/packages/modules/dynamodb/src/dynamodb-container.test.ts b/packages/modules/dynamodb/src/dynamodb-container.test.ts index 97253d721..c6abcdd2d 100644 --- a/packages/modules/dynamodb/src/dynamodb-container.test.ts +++ b/packages/modules/dynamodb/src/dynamodb-container.test.ts @@ -283,7 +283,13 @@ describe("DynamoDBContainer", { timeout: 180_000 }, () => { */ // disabledTelemetry { - await using container = await new DynamoDBContainer(IMAGE).withDisableTelemetry().start(); + const container = new DynamoDBContainer(IMAGE).withDisableTelemetry(); + await using startedContainer = await container.start(); + // } + + // @ts-expect-error - accessing private property for testing + expect(container.createOpts.Cmd).toEqual(["-jar", "DynamoDBLocal.jar", "-inMemory", "-disableTelemetry"]); + const client = new DynamoDBClient({ region: "us-east-1", credentials: { @@ -291,9 +297,8 @@ describe("DynamoDBContainer", { timeout: 180_000 }, () => { accessKeyId: "AKIAIOSFODNN7EXAMPLE", secretAccessKey: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", }, - endpoint: container.getEndpoint(), + endpoint: startedContainer.getEndpoint(), }); - // } const command = new ListTablesCommand({}); const result = await client.send(command); From 02cd61a80512e3c2f416d7cc9c3afa2cc14fc2ee Mon Sep 17 00:00:00 2001 From: Stefan Schulte Date: Mon, 26 Oct 2026 20:45:52 +0100 Subject: [PATCH 06/11] DynamoDB: Do not import globals Vitest is currently configured with ```typescript export default defineConfig({ test: { globals: true, } } ``` So we do not have to import `describe`, `it`, `expect`, etc. Drop those imports. --- packages/modules/dynamodb/src/dynamodb-container.test.ts | 1 - 1 file changed, 1 deletion(-) diff --git a/packages/modules/dynamodb/src/dynamodb-container.test.ts b/packages/modules/dynamodb/src/dynamodb-container.test.ts index c6abcdd2d..aaaa75842 100644 --- a/packages/modules/dynamodb/src/dynamodb-container.test.ts +++ b/packages/modules/dynamodb/src/dynamodb-container.test.ts @@ -8,7 +8,6 @@ import { waitUntilTableExists, waitUntilTableNotExists, } from "@aws-sdk/client-dynamodb"; -import { describe, it } from "vitest"; import { getImage } from "../../../testcontainers/src/utils/test-helper"; import { DynamoDBContainer } from "./dynamodb-container"; From 24ffd5638a8b02666347cc7e6cb39fde59a8541c Mon Sep 17 00:00:00 2001 From: Stefan Schulte Date: Mon, 26 Oct 2026 21:19:32 +0100 Subject: [PATCH 07/11] DynamoDB: Adapt wait strategy We now adopt the same wait strategy that is used in other languages that support DynamoDB --- packages/modules/dynamodb/src/dynamodb-container.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/modules/dynamodb/src/dynamodb-container.ts b/packages/modules/dynamodb/src/dynamodb-container.ts index f7ff6bce5..9332c399e 100644 --- a/packages/modules/dynamodb/src/dynamodb-container.ts +++ b/packages/modules/dynamodb/src/dynamodb-container.ts @@ -1,4 +1,4 @@ -import { AbstractStartedContainer, GenericContainer } from "testcontainers"; +import { AbstractStartedContainer, GenericContainer, Wait } from "testcontainers"; // https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBLocal.UsageNotes.html#DynamoDBLocal.Endpoint const DYNAMODB_PORT = 8000; @@ -10,7 +10,7 @@ export class DynamoDBContainer extends GenericContainer { constructor(image: string) { super(image); - this.withExposedPorts(DYNAMODB_PORT).withStartupTimeout(120_000); + this.withExposedPorts(DYNAMODB_PORT).withWaitStrategy(Wait.forHttp("/", DYNAMODB_PORT).forStatusCode(400)); } /** From 834e4994a52a06b0b6c4180a07c4d0e5091e7e21 Mon Sep 17 00:00:00 2001 From: Stefan Schulte Date: Mon, 26 Oct 2026 21:24:45 +0100 Subject: [PATCH 08/11] DynamoDB: Shorten documentation Most of the documentation seems to assume the application inside the behaviour is well understood so we now also drop additional explanation around the usage of the DynamoDB container. --- docs/modules/dynamodb.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/modules/dynamodb.md b/docs/modules/dynamodb.md index d93da13e2..6d2faead8 100644 --- a/docs/modules/dynamodb.md +++ b/docs/modules/dynamodb.md @@ -18,10 +18,6 @@ Choose an image from the [container registry](https://hub.docker.com/r/amazon/dy ### Connect to local endpoint -In order to use a DynamoDB Client we have to specify -at least `region`, `credentials` and `endpoint` eventhough `region` and `credentials` -will not be used: - [](../../packages/modules/dynamodb/src/dynamodb-container.test.ts) inside_block:connectEndpoint From b957a286e4897e28545b7e82904ebeccc938b1a2 Mon Sep 17 00:00:00 2001 From: Stefan Schulte Date: Mon, 26 Oct 2026 22:01:29 +0100 Subject: [PATCH 09/11] DynamoDB: Simplify helper function In order to easily create a table with dummy data inside our tests we introduced a small helper function. We now cut functionality we don't really require like changing the table name or returning a function to destroy the table. Since we throw away the whole container there is not reason to delete a single table. --- .../dynamodb/src/dynamodb-container.test.ts | 51 +++++-------------- 1 file changed, 12 insertions(+), 39 deletions(-) diff --git a/packages/modules/dynamodb/src/dynamodb-container.test.ts b/packages/modules/dynamodb/src/dynamodb-container.test.ts index aaaa75842..d904e008c 100644 --- a/packages/modules/dynamodb/src/dynamodb-container.test.ts +++ b/packages/modules/dynamodb/src/dynamodb-container.test.ts @@ -1,38 +1,22 @@ import { CreateTableCommand, - DeleteTableCommand, DynamoDBClient, GetItemCommand, ListTablesCommand, PutItemCommand, waitUntilTableExists, - waitUntilTableNotExists, } from "@aws-sdk/client-dynamodb"; import { getImage } from "../../../testcontainers/src/utils/test-helper"; import { DynamoDBContainer } from "./dynamodb-container"; const IMAGE = getImage(__dirname); -/** - * Create an empty dummy user table - * - * This function can be used in test cases - * to easily add a new table. - * - * @param client - DynamoDBClient pointing to the container - * @param tableName - The desired table name - * @returns - Three functions: teardown, addUser, getUser - */ -async function createDummyTable( - client: DynamoDBClient, - tableName: string -): Promise<{ - teardown: () => Promise; +async function createTestTable(client: DynamoDBClient): Promise<{ addUser: (userId: number, name: string) => Promise; getUser: (userId: number) => Promise; }> { const command = new CreateTableCommand({ - TableName: tableName, + TableName: "users", BillingMode: "PAY_PER_REQUEST", AttributeDefinitions: [ { @@ -49,17 +33,12 @@ async function createDummyTable( }); await client.send(command); - await waitUntilTableExists({ client, maxWaitTime: 30 }, { TableName: tableName }); + await waitUntilTableExists({ client, maxWaitTime: 30 }, { TableName: "users" }); return { - teardown: async (): Promise => { - const deleteCommand = new DeleteTableCommand({ TableName: tableName }); - await client.send(deleteCommand); - await waitUntilTableNotExists({ client, maxWaitTime: 30 }, { TableName: tableName }); - }, addUser: async (userId, name) => { const putCommand = new PutItemCommand({ - TableName: tableName, + TableName: "users", Item: { userId: { N: userId.toString() }, name: { S: name }, @@ -69,17 +48,14 @@ async function createDummyTable( }, getUser: async (userId) => { const getCommand = new GetItemCommand({ - TableName: tableName, + TableName: "users", Key: { userId: { N: userId.toString() }, }, ConsistentRead: true, }); - const response = await client.send(getCommand); - if (response.Item?.name?.S) { - return response.Item.name.S; - } - return null; + const result = await client.send(getCommand); + return result.Item?.name?.S ?? null; }, }; } @@ -117,8 +93,7 @@ describe("DynamoDBContainer", { timeout: 180_000 }, () => { endpoint: container.getEndpoint(), }); - const { teardown, addUser, getUser } = await createDummyTable(client, "users"); - + const { addUser, getUser } = await createTestTable(client); await addUser(1, "Bob"); await addUser(2, "Alice"); @@ -126,8 +101,6 @@ describe("DynamoDBContainer", { timeout: 180_000 }, () => { const userB = await getUser(2); expect(userA).toBe("Bob"); expect(userB).toBe("Alice"); - - await teardown(); }); it("separates data by client by default", async () => { @@ -154,7 +127,7 @@ describe("DynamoDBContainer", { timeout: 180_000 }, () => { }, }); - await createDummyTable(clientA, "users"); + await createTestTable(clientA); const resultA = await clientA.send(new ListTablesCommand()); const resultB = await clientB.send(new ListTablesCommand()); @@ -189,7 +162,7 @@ describe("DynamoDBContainer", { timeout: 180_000 }, () => { }); // } - await createDummyTable(clientA, "users"); + await createTestTable(clientA); const resultA = await clientA.send(new ListTablesCommand()); const resultB = await clientB.send(new ListTablesCommand()); @@ -214,7 +187,7 @@ describe("DynamoDBContainer", { timeout: 180_000 }, () => { }); // } - const { addUser } = await createDummyTable(client, "users"); + const { addUser } = await createTestTable(client); await addUser(1, "Bob"); await container.restart(); @@ -255,7 +228,7 @@ describe("DynamoDBContainer", { timeout: 180_000 }, () => { endpoint: container.getEndpoint(), }); - const { addUser } = await createDummyTable(client, "users"); + const { addUser } = await createTestTable(client); await addUser(1, "Bob"); await container.restart(); From 81de6281d934d98deba435d2ba2e5e7549dc141d Mon Sep 17 00:00:00 2001 From: Stefan Schulte Date: Mon, 26 Oct 2026 22:27:22 +0100 Subject: [PATCH 10/11] DynamoDB: Simplify construction of getEndpoint There a a lot of ways to construct a URL, so use what seems to be best practice inside this repository. --- packages/modules/dynamodb/src/dynamodb-container.ts | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/packages/modules/dynamodb/src/dynamodb-container.ts b/packages/modules/dynamodb/src/dynamodb-container.ts index 9332c399e..0c1503171 100644 --- a/packages/modules/dynamodb/src/dynamodb-container.ts +++ b/packages/modules/dynamodb/src/dynamodb-container.ts @@ -109,9 +109,7 @@ export class StartedDynamoDBContainer extends AbstractStartedContainer { * client configuration suitable for most usecases */ public getEndpoint(): string { - const hostname = this.getHost(); - const url = new URL(`http://${hostname}`); - url.port = this.getPort().toString(); - return url.toString(); + const url = `http://${this.getHost()}:${this.getPort().toString()}`; + return url; } } From 633d41c0e5f109e74604ee45a47e2dcfd8c994b6 Mon Sep 17 00:00:00 2001 From: Stefan Schulte Date: Wed, 18 Nov 2026 12:14:38 +0100 Subject: [PATCH 11/11] DynamoDB: Disable dbPath and withTelemetry After PR comments we now drop dbPath since there is no current usecase for it and we disable telemetry by default instead of providing it as an option. --- docs/modules/dynamodb.md | 6 - .../dynamodb/src/dynamodb-container.test.ts | 149 ++---------------- .../dynamodb/src/dynamodb-container.ts | 90 +---------- 3 files changed, 24 insertions(+), 221 deletions(-) diff --git a/docs/modules/dynamodb.md b/docs/modules/dynamodb.md index 6d2faead8..8ae64ea2b 100644 --- a/docs/modules/dynamodb.md +++ b/docs/modules/dynamodb.md @@ -27,9 +27,3 @@ Choose an image from the [container registry](https://hub.docker.com/r/amazon/dy [](../../packages/modules/dynamodb/src/dynamodb-container.test.ts) inside_block:sharedDB - -### Disable telemetry - - -[](../../packages/modules/dynamodb/src/dynamodb-container.test.ts) inside_block:disabledTelemetry - diff --git a/packages/modules/dynamodb/src/dynamodb-container.test.ts b/packages/modules/dynamodb/src/dynamodb-container.test.ts index d904e008c..3bd0340eb 100644 --- a/packages/modules/dynamodb/src/dynamodb-container.test.ts +++ b/packages/modules/dynamodb/src/dynamodb-container.test.ts @@ -60,6 +60,19 @@ async function createTestTable(client: DynamoDBClient): Promise<{ }; } +function createClient(endpoint: string, accessKeyId: string = "AKIAIOSFODNN7EXAMPLE"): DynamoDBClient { + const client = new DynamoDBClient({ + region: "us-east-1", + credentials: { + // use any credentials + accessKeyId, + secretAccessKey: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + }, + endpoint, + }); + return client; +} + describe("DynamoDBContainer", { timeout: 180_000 }, () => { it("connects with endpoint", async () => { // connectEndpoint { @@ -83,15 +96,7 @@ describe("DynamoDBContainer", { timeout: 180_000 }, () => { it("stores data", async () => { await using container = await new DynamoDBContainer(IMAGE).start(); - const client = new DynamoDBClient({ - region: "us-east-1", - credentials: { - // use any credentials - accessKeyId: "AKIAIOSFODNN7EXAMPLE", - secretAccessKey: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", - }, - endpoint: container.getEndpoint(), - }); + const client = createClient(container.getEndpoint()); const { addUser, getUser } = await createTestTable(client); await addUser(1, "Bob"); @@ -107,25 +112,8 @@ describe("DynamoDBContainer", { timeout: 180_000 }, () => { await using container = await new DynamoDBContainer(IMAGE).start(); // Uses dummy credentials from the documentation - const clientA = new DynamoDBClient({ - region: "eu-central-1", - endpoint: container.getEndpoint(), - credentials: { - accessKeyId: "AKIAIOSFODNN7EXAMPLE", - secretAccessKey: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", - }, - }); - - // Uses slightly different credentials to simulate another - // AWS account - const clientB = new DynamoDBClient({ - region: "eu-central-1", - endpoint: container.getEndpoint(), - credentials: { - accessKeyId: "AKIAIOSFODNN7EXAMPL2", - secretAccessKey: "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", - }, - }); + const clientA = createClient(container.getEndpoint(), "AKIAIOSFODNN7EXAMPL1"); + const clientB = createClient(container.getEndpoint(), "AKIAIOSFODNN7EXAMPL2"); await createTestTable(clientA); @@ -172,109 +160,4 @@ describe("DynamoDBContainer", { timeout: 180_000 }, () => { expect(resultA.TableNames).toStrictEqual(["users"]); expect(resultB.TableNames).toStrictEqual(["users"]); }); - - it("persists data when dbPath is set", async () => { - // persistWithDbPath { - await using container = await new DynamoDBContainer(IMAGE).withDbPath(".").start(); - const client = new DynamoDBClient({ - region: "us-east-1", - credentials: { - // use any credentials - accessKeyId: "AKIAIOSFODNN7EXAMPLE", - secretAccessKey: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", - }, - endpoint: container.getEndpoint(), - }); - // } - - const { addUser } = await createTestTable(client); - await addUser(1, "Bob"); - - await container.restart(); - - // restarting will change the mapped port so we need a new client - const clientAfterRestart = new DynamoDBClient({ - region: "us-east-1", - credentials: { - // use any credentials - accessKeyId: "AKIAIOSFODNN7EXAMPLE", - secretAccessKey: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", - }, - endpoint: container.getEndpoint(), - }); - - // The table should still be there including its content - const command = new GetItemCommand({ - TableName: "users", - Key: { userId: { N: "1" } }, - ConsistentRead: true, - }); - const response = await clientAfterRestart.send(command); - expect(response.Item).toStrictEqual({ - userId: { N: "1" }, - name: { S: "Bob" }, - }); - }); - - it("stores data in memory when no dbPath set", async () => { - await using container = await new DynamoDBContainer(IMAGE).start(); - const client = new DynamoDBClient({ - region: "us-east-1", - credentials: { - // use any credentials - accessKeyId: "AKIAIOSFODNN7EXAMPLE", - secretAccessKey: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", - }, - endpoint: container.getEndpoint(), - }); - - const { addUser } = await createTestTable(client); - await addUser(1, "Bob"); - - await container.restart(); - - // restarting will change the mapped port so we need a new client - const clientAfterRestart = new DynamoDBClient({ - region: "us-east-1", - credentials: { - // use any credentials - accessKeyId: "AKIAIOSFODNN7EXAMPLE", - secretAccessKey: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", - }, - endpoint: container.getEndpoint(), - }); - - // We should not be able to see the table anymore - const result = await clientAfterRestart.send(new ListTablesCommand()); - expect(result.TableNames).toStrictEqual([]); - }); - - it("allows to disable telemetry", async () => { - /* Unfortunately there is no way to validate this right now, but at - * least we know it does not pass something invalid to the container - */ - - // disabledTelemetry { - const container = new DynamoDBContainer(IMAGE).withDisableTelemetry(); - await using startedContainer = await container.start(); - // } - - // @ts-expect-error - accessing private property for testing - expect(container.createOpts.Cmd).toEqual(["-jar", "DynamoDBLocal.jar", "-inMemory", "-disableTelemetry"]); - - const client = new DynamoDBClient({ - region: "us-east-1", - credentials: { - // use any credentials - accessKeyId: "AKIAIOSFODNN7EXAMPLE", - secretAccessKey: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", - }, - endpoint: startedContainer.getEndpoint(), - }); - - const command = new ListTablesCommand({}); - const result = await client.send(command); - - expect(result.TableNames).toStrictEqual([]); - }); }); diff --git a/packages/modules/dynamodb/src/dynamodb-container.ts b/packages/modules/dynamodb/src/dynamodb-container.ts index 0c1503171..066281522 100644 --- a/packages/modules/dynamodb/src/dynamodb-container.ts +++ b/packages/modules/dynamodb/src/dynamodb-container.ts @@ -5,95 +5,28 @@ const DYNAMODB_PORT = 8000; export class DynamoDBContainer extends GenericContainer { private sharedDB: boolean = false; - private disableTelemetry: boolean = false; - private dbPath?: string; constructor(image: string) { super(image); - this.withExposedPorts(DYNAMODB_PORT).withWaitStrategy(Wait.forHttp("/", DYNAMODB_PORT).forStatusCode(400)); + this.withExposedPorts(DYNAMODB_PORT) + .withStartupTimeout(120_000) + .withWaitStrategy(Wait.forHttp("/", DYNAMODB_PORT).forStatusCode(400)); } - /** - * Share table between clients - * - * By default the DynamoDB container will present different tables - * depending on the current AWS access key. - * - * Use this option to use a shared database instead. This will - * pass ´-sharedDb` to the container. For more information please read - * https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBLocal.UsageNotes.html#DynamoDBLocal.CommandLineOptions - */ public withSharedDB(): this { this.sharedDB = true; return this; } - /** - * Specify a database path - * - * Specify a directory (for example `.`) to persist the - * database. This can be used to preserve tables between container - * restarts but in general is not required. - * - * This option will set `-dbPath` when invoking the container. - * Fore more information please read - * https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBLocal.UsageNotes.html#DynamoDBLocal.CommandLineOptions - * - * @param dbPath - The path to the database file inside the container - */ - public withDbPath(dbPath: string): this { - this.dbPath = dbPath; - return this; - } - - /** - * Do not sent any telemetry - * - * By default the AWS DynamoDB container will sent telemetry information. - * Use this option to pass `-disableTelemetry` to the container - * Fore more information please read - * https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBLocal.UsageNotes.html#DynamoDBLocal.CommandLineOptions - */ - public withDisableTelemetry(): this { - this.disableTelemetry = true; - return this; - } - - /** - * Start the DynamoDB container - */ public override async start(): Promise { - const command = this.createCommand(); - if (command) { - this.withCommand(command); - } + this.withCommand(["-jar", "DynamoDBLocal.jar", "-inMemory", ...(this.sharedDB ? ["-sharedDb"] : [])]); + this.withEnvironment({ + DDB_LOCAL_TELEMETRY: "0", + }); const started = await super.start(); return new StartedDynamoDBContainer(started); } - - private createCommand(): string[] | null { - const command: string[] = []; - let skipInMemory = false; - if (this.sharedDB) { - command.push("-sharedDb"); - } - if (this.disableTelemetry) { - command.push("-disableTelemetry"); - } - if (this.dbPath) { - command.push("-dbPath", this.dbPath); - skipInMemory = true; - } - - if (command.length === 0) { - return null; - } - - // The defaut command is - // -jar DynamoDBLocal.jar -inMemory - return ["-jar", "DynamoDBLocal.jar", ...(skipInMemory ? [] : ["-inMemory"]), ...command]; - } } export class StartedDynamoDBContainer extends AbstractStartedContainer { @@ -101,15 +34,8 @@ export class StartedDynamoDBContainer extends AbstractStartedContainer { return this.startedTestContainer.getMappedPort(DYNAMODB_PORT); } - /*+ - * Returns the endpoint to reach the DynamoDB service - * - * The returned endpoint can be used to pass to your DynamoDB client. You - * can also use `clientConfig` instead which provides you a complete - * client configuration suitable for most usecases - */ public getEndpoint(): string { - const url = `http://${this.getHost()}:${this.getPort().toString()}`; + const url = `http://${this.getHost()}:${this.getPort()}`; return url; } }