diff --git a/docs/modules/dynamodb.md b/docs/modules/dynamodb.md new file mode 100644 index 000000000..8ae64ea2b --- /dev/null +++ b/docs/modules/dynamodb.md @@ -0,0 +1,29 @@ +# 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 + + +[](../../packages/modules/dynamodb/src/dynamodb-container.test.ts) inside_block:connectEndpoint + + +### Use a shared database + + +[](../../packages/modules/dynamodb/src/dynamodb-container.test.ts) inside_block:sharedDB + 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..3bd0340eb --- /dev/null +++ b/packages/modules/dynamodb/src/dynamodb-container.test.ts @@ -0,0 +1,163 @@ +import { + CreateTableCommand, + DynamoDBClient, + GetItemCommand, + ListTablesCommand, + PutItemCommand, + waitUntilTableExists, +} from "@aws-sdk/client-dynamodb"; +import { getImage } from "../../../testcontainers/src/utils/test-helper"; +import { DynamoDBContainer } from "./dynamodb-container"; + +const IMAGE = getImage(__dirname); + +async function createTestTable(client: DynamoDBClient): Promise<{ + addUser: (userId: number, name: string) => Promise; + getUser: (userId: number) => Promise; +}> { + const command = new CreateTableCommand({ + TableName: "users", + BillingMode: "PAY_PER_REQUEST", + AttributeDefinitions: [ + { + AttributeName: "userId", + AttributeType: "N", + }, + ], + KeySchema: [ + { + AttributeName: "userId", + KeyType: "HASH", + }, + ], + }); + + await client.send(command); + await waitUntilTableExists({ client, maxWaitTime: 30 }, { TableName: "users" }); + + return { + addUser: async (userId, name) => { + const putCommand = new PutItemCommand({ + TableName: "users", + Item: { + userId: { N: userId.toString() }, + name: { S: name }, + }, + }); + await client.send(putCommand); + }, + getUser: async (userId) => { + const getCommand = new GetItemCommand({ + TableName: "users", + Key: { + userId: { N: userId.toString() }, + }, + ConsistentRead: true, + }); + const result = await client.send(getCommand); + return result.Item?.name?.S ?? null; + }, + }; +} + +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 { + 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 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 = createClient(container.getEndpoint()); + + const { addUser, getUser } = await createTestTable(client); + 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"); + }); + + it("separates data by client by default", async () => { + await using container = await new DynamoDBContainer(IMAGE).start(); + + // Uses dummy credentials from the documentation + const clientA = createClient(container.getEndpoint(), "AKIAIOSFODNN7EXAMPL1"); + const clientB = createClient(container.getEndpoint(), "AKIAIOSFODNN7EXAMPL2"); + + await createTestTable(clientA); + + 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 createTestTable(clientA); + + 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"]); + }); +}); diff --git a/packages/modules/dynamodb/src/dynamodb-container.ts b/packages/modules/dynamodb/src/dynamodb-container.ts new file mode 100644 index 000000000..066281522 --- /dev/null +++ b/packages/modules/dynamodb/src/dynamodb-container.ts @@ -0,0 +1,41 @@ +import { AbstractStartedContainer, GenericContainer, Wait } from "testcontainers"; + +// https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBLocal.UsageNotes.html#DynamoDBLocal.Endpoint +const DYNAMODB_PORT = 8000; + +export class DynamoDBContainer extends GenericContainer { + private sharedDB: boolean = false; + + constructor(image: string) { + super(image); + this.withExposedPorts(DYNAMODB_PORT) + .withStartupTimeout(120_000) + .withWaitStrategy(Wait.forHttp("/", DYNAMODB_PORT).forStatusCode(400)); + } + + public withSharedDB(): this { + this.sharedDB = true; + return this; + } + + public override async start(): Promise { + this.withCommand(["-jar", "DynamoDBLocal.jar", "-inMemory", ...(this.sharedDB ? ["-sharedDb"] : [])]); + this.withEnvironment({ + DDB_LOCAL_TELEMETRY: "0", + }); + + const started = await super.start(); + return new StartedDynamoDBContainer(started); + } +} + +export class StartedDynamoDBContainer extends AbstractStartedContainer { + public getPort(): number { + return this.startedTestContainer.getMappedPort(DYNAMODB_PORT); + } + + public getEndpoint(): string { + const url = `http://${this.getHost()}:${this.getPort()}`; + return url; + } +} 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" + } + ] +}