@testcontainers/redis 10.5.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 - 2023 Cristian Greco
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,25 @@
+# Testcontainers
+
+[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=116414510&machine=standardLinux32gb&devcontainer_path=.devcontainer%2Fdevcontainer.json&location=EastUs)
+
+[![Test](https://github.com/testcontainers/testcontainers-node/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/testcontainers/testcontainers-node/actions/workflows/test.yml)
+[![npm version](https://badge.fury.io/js/testcontainers.svg)](https://www.npmjs.com/package/testcontainers)
+[![npm version](https://img.shields.io/npm/dm/testcontainers.svg)](https://www.npmjs.com/package/testcontainers)
+
+![Testcontainers Banner](https://github.com/testcontainers/testcontainers-node/raw/main/docs/site/logo.png)
+
+## [📖 Documentation](https://node.testcontainers.org/)
+
+## License
+
+See [LICENSE](https://github.com/testcontainers/testcontainers-node/blob/main/LICENSE).
+
+## Copyright
+
+Copyright (c) 2018 - 2023 Cristian Greco and other authors.
+
+See [contributors](https://github.com/testcontainers/testcontainers-node/graphs/contributors/) for all contributors.
+
+----
+
+Join our [Slack workspace](https://slack.testcontainers.org/) | [Testcontainers OSS](https://java.testcontainers.org/) | [Testcontainers Cloud](https://www.testcontainers.cloud/)

package/build/index.d.ts

@@ -0,0 +1 @@
+export { RedisContainer, StartedRedisContainer } from "./redis-container";

package/build/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StartedRedisContainer = exports.RedisContainer = void 0;
+var redis_container_1 = require("./redis-container");
+Object.defineProperty(exports, "RedisContainer", { enumerable: true, get: function () { return redis_container_1.RedisContainer; } });
+Object.defineProperty(exports, "StartedRedisContainer", { enumerable: true, get: function () { return redis_container_1.StartedRedisContainer; } });
+//# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,qDAA0E;AAAjE,iHAAA,cAAc,OAAA;AAAE,wHAAA,qBAAqB,OAAA"}

package/build/redis-container.d.ts

@@ -0,0 +1,21 @@
+import { AbstractStartedContainer, GenericContainer, StartedTestContainer } from "testcontainers";
+export declare class RedisContainer extends GenericContainer {
+    private readonly importFilePath;
+    private password?;
+    private persistenceVolume?;
+    private initialImportScriptFile?;
+    constructor(image?: string);
+    withPassword(password: string): this;
+    withPersistence(sourcePath: string): this;
+    withInitialData(importScriptFile: string): this;
+    start(): Promise<StartedRedisContainer>;
+    private importInitialData;
+}
+export declare class StartedRedisContainer extends AbstractStartedContainer {
+    private readonly password?;
+    constructor(startedTestContainer: StartedTestContainer, password?: string | undefined);
+    getPort(): number;
+    getPassword(): string;
+    getConnectionUrl(): string;
+    executeCliCmd(cmd: string, additionalFlags?: string[]): Promise<string>;
+}

package/build/redis-container.js

@@ -0,0 +1,101 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StartedRedisContainer = exports.RedisContainer = void 0;
+const testcontainers_1 = require("testcontainers");
+const path_1 = __importDefault(require("path"));
+const REDIS_PORT = 6379;
+class RedisContainer extends testcontainers_1.GenericContainer {
+    importFilePath = "/tmp/import.redis";
+    password = "";
+    persistenceVolume = "";
+    initialImportScriptFile = "";
+    constructor(image = "redis:7.2") {
+        super(image);
+    }
+    withPassword(password) {
+        this.password = password;
+        return this;
+    }
+    withPersistence(sourcePath) {
+        this.persistenceVolume = sourcePath;
+        return this;
+    }
+    /* Expect data to be in redis import script format, see https://developer.redis.com/explore/import/*/
+    withInitialData(importScriptFile) {
+        this.initialImportScriptFile = importScriptFile;
+        return this;
+    }
+    async start() {
+        this.withExposedPorts(...(this.hasExposedPorts ? this.exposedPorts : [REDIS_PORT]))
+            .withCommand([
+            "redis-server",
+            ...(this.password ? [`--requirepass "${this.password}"`] : []),
+            ...(this.persistenceVolume ? ["--save 1 1 ", "--appendonly yes"] : []),
+        ])
+            .withStartupTimeout(120000)
+            .withWaitStrategy(testcontainers_1.Wait.forLogMessage("Ready to accept connections tcp"));
+        if (this.persistenceVolume)
+            this.withBindMounts([{ mode: "rw", source: this.persistenceVolume, target: "/data" }]);
+        if (this.initialImportScriptFile) {
+            this.withCopyFilesToContainer([
+                {
+                    mode: 666,
+                    source: this.initialImportScriptFile,
+                    target: this.importFilePath,
+                },
+                {
+                    mode: 777,
+                    source: path_1.default.join(__dirname, "import.sh"),
+                    target: "/tmp/import.sh",
+                },
+            ]);
+        }
+        const startedRedisContainer = new StartedRedisContainer(await super.start(), this.password);
+        if (this.initialImportScriptFile)
+            await this.importInitialData(startedRedisContainer);
+        return startedRedisContainer;
+    }
+    async importInitialData(container) {
+        const re = await container.exec(`/tmp/import.sh ${this.password}`);
+        if (re.exitCode != 0 || re.output.includes("ERR"))
+            throw Error(`Could not import initial data from ${this.initialImportScriptFile}: ${re.output}`);
+    }
+}
+exports.RedisContainer = RedisContainer;
+class StartedRedisContainer extends testcontainers_1.AbstractStartedContainer {
+    password;
+    constructor(startedTestContainer, password) {
+        super(startedTestContainer);
+        this.password = password;
+    }
+    getPort() {
+        return this.getMappedPort(REDIS_PORT);
+    }
+    getPassword() {
+        return this.password ? this.password.toString() : "";
+    }
+    getConnectionUrl() {
+        const url = new URL("", "redis://");
+        url.hostname = this.getHost();
+        url.port = this.getPort().toString();
+        url.password = this.getPassword();
+        return url.toString();
+    }
+    async executeCliCmd(cmd, additionalFlags = []) {
+        const result = await this.startedTestContainer.exec([
+            "redis-cli",
+            ...(this.password != "" ? [`-a ${this.password}`] : []),
+            `${cmd}`,
+            ...additionalFlags,
+        ]);
+        if (result.exitCode !== 0) {
+            throw new Error(`executeQuery failed with exit code ${result.exitCode} for query: ${cmd}. ${result.output}`);
+        }
+        return result.output;
+    }
+}
+exports.StartedRedisContainer = StartedRedisContainer;
+//# sourceMappingURL=redis-container.js.map

package/build/redis-container.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"redis-container.js","sourceRoot":"","sources":["../src/redis-container.ts"],"names":[],"mappings":";;;;;;AAAA,mDAAwG;AACxG,gDAAwB;AAExB,MAAM,UAAU,GAAG,IAAI,CAAC;AAExB,MAAa,cAAe,SAAQ,iCAAgB;IACjC,cAAc,GAAG,mBAAmB,CAAC;IAC9C,QAAQ,GAAI,EAAE,CAAC;IACf,iBAAiB,GAAI,EAAE,CAAC;IACxB,uBAAuB,GAAI,EAAE,CAAC;IAEtC,YAAY,KAAK,GAAG,WAAW;QAC7B,KAAK,CAAC,KAAK,CAAC,CAAC;IACf,CAAC;IAEM,YAAY,CAAC,QAAgB;QAClC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,eAAe,CAAC,UAAkB;QACvC,IAAI,CAAC,iBAAiB,GAAG,UAAU,CAAC;QACpC,OAAO,IAAI,CAAC;IACd,CAAC;IACD,qGAAqG;IAE9F,eAAe,CAAC,gBAAwB;QAC7C,IAAI,CAAC,uBAAuB,GAAG,gBAAgB,CAAC;QAChD,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,KAAK,CAAC,KAAK;QACzB,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC;aAChF,WAAW,CAAC;YACX,cAAc;YACd,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,kBAAkB,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC9D,GAAG,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,aAAa,EAAE,kBAAkB,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;SACvE,CAAC;aACD,kBAAkB,CAAC,MAAO,CAAC;aAC3B,gBAAgB,CAAC,qBAAI,CAAC,aAAa,CAAC,iCAAiC,CAAC,CAAC,CAAC;QAC3E,IAAI,IAAI,CAAC,iBAAiB;YAAE,IAAI,CAAC,cAAc,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,iBAAiB,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;QACnH,IAAI,IAAI,CAAC,uBAAuB,EAAE;YAChC,IAAI,CAAC,wBAAwB,CAAC;gBAC5B;oBACE,IAAI,EAAE,GAAG;oBACT,MAAM,EAAE,IAAI,CAAC,uBAAuB;oBACpC,MAAM,EAAE,IAAI,CAAC,cAAc;iBAC5B;gBACD;oBACE,IAAI,EAAE,GAAG;oBACT,MAAM,EAAE,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,WAAW,CAAC;oBACzC,MAAM,EAAE,gBAAgB;iBACzB;aACF,CAAC,CAAC;SACJ;QACD,MAAM,qBAAqB,GAAG,IAAI,qBAAqB,CAAC,MAAM,KAAK,CAAC,KAAK,EAAE,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC5F,IAAI,IAAI,CAAC,uBAAuB;YAAE,MAAM,IAAI,CAAC,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;QACtF,OAAO,qBAAqB,CAAC;IAC/B,CAAC;IAEO,KAAK,CAAC,iBAAiB,CAAC,SAAgC;QAC9D,MAAM,EAAE,GAAG,MAAM,SAAS,CAAC,IAAI,CAAC,kBAAkB,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QACnE,IAAI,EAAE,CAAC,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC;YAC/C,MAAM,KAAK,CAAC,sCAAsC,IAAI,CAAC,uBAAuB,KAAK,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC;IACpG,CAAC;CACF;AA5DD,wCA4DC;AAED,MAAa,qBAAsB,SAAQ,yCAAwB;IACQ;IAAzE,YAAY,oBAA0C,EAAmB,QAAiB;QACxF,KAAK,CAAC,oBAAoB,CAAC,CAAC;QAD2C,aAAQ,GAAR,QAAQ,CAAS;IAE1F,CAAC;IAEM,OAAO;QACZ,OAAO,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;IACxC,CAAC;IAEM,WAAW;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACvD,CAAC;IAEM,gBAAgB;QACrB,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC;QACpC,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;QAC9B,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC;QACrC,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QAClC,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAC;IACxB,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,GAAW,EAAE,kBAA4B,EAAE;QACpE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC;YAClD,WAAW;YACX,GAAG,CAAC,IAAI,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACvD,GAAG,GAAG,EAAE;YACR,GAAG,eAAe;SACnB,CAAC,CAAC;QACH,IAAI,MAAM,CAAC,QAAQ,KAAK,CAAC,EAAE;YACzB,MAAM,IAAI,KAAK,CAAC,sCAAsC,MAAM,CAAC,QAAQ,eAAe,GAAG,KAAK,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;SAC9G;QACD,OAAO,MAAM,CAAC,MAAM,CAAC;IACvB,CAAC;CACF;AAjCD,sDAiCC"}

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@testcontainers/redis",
+  "version": "10.5.0",
+  "license": "MIT",
+  "keywords": [
+    "redis",
+    "testing",
+    "docker",
+    "testcontainers"
+  ],
+  "description": "Redis module for Testcontainers",
+  "homepage": "https://github.com/testcontainers/testcontainers-node#readme",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/testcontainers/testcontainers-node"
+  },
+  "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"
+  },
+  "devDependencies": {
+    "@types/redis": "^4.0.11",
+    "redis": "^4.6.7"
+  },
+  "dependencies": {
+    "testcontainers": "^10.5.0"
+  }
+}