@testcontainers/vault 11.3.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 - 2025 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,29 @@
+# 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/checks.yml/badge.svg?branch=main)](https://github.com/testcontainers/testcontainers-node/actions/workflows/checks.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 - 2025 Cristian Greco and other authors.
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for how to contribute to this repo.
+
+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 { StartedVaultContainer, VaultContainer } from "./vault-container";

package/build/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VaultContainer = exports.StartedVaultContainer = void 0;
+var vault_container_1 = require("./vault-container");
+Object.defineProperty(exports, "StartedVaultContainer", { enumerable: true, get: function () { return vault_container_1.StartedVaultContainer; } });
+Object.defineProperty(exports, "VaultContainer", { enumerable: true, get: function () { return vault_container_1.VaultContainer; } });
+//# 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,wHAAA,qBAAqB,OAAA;AAAE,iHAAA,cAAc,OAAA"}

package/build/vault-container.d.ts

@@ -0,0 +1,80 @@
+import { AbstractStartedContainer, GenericContainer } from "testcontainers";
+/**
+ * Testcontainers module for HashiCorp Vault.
+ *
+ * This container exposes Vault on port 8200, sets up a wait strategy using the health check endpoint, and supports:
+ * - Supplying a root token
+ * - Executing post-start CLI init commands
+ */
+export declare class VaultContainer extends GenericContainer {
+    private readonly initCommands;
+    private token?;
+    /**
+     * Constructs a VaultContainer with a default image and healthcheck strategy.
+     *
+     * - Sets VAULT_ADDR to internal container address
+     * - Adds IPC_LOCK capability (required by Vault)
+     * - Exposes Vault on port 8200
+     * - Waits for HTTP 200 response from /v1/sys/health
+     * @param image Docker image to use (e.g. `hashicorp/vault:1.13.0`)
+     */
+    constructor(image: string);
+    /**
+     * Sets a root token to be used with Vault, passed via environment variables.
+     *
+     * @param token Vault root token
+     * @returns this
+     */
+    withVaultToken(token: string): this;
+    /**
+     * Registers one or more Vault CLI init commands to be run after container starts.
+     *
+     * Example:
+     *   .withInitCommands("secrets enable transit", "kv put secret/foo bar=baz")
+     *
+     * @param commands Vault CLI commands (without `vault` prefix)
+     * @returns this
+     */
+    withInitCommands(...commands: string[]): this;
+    /**
+     * Starts the Vault container and executes any registered init commands.
+     *
+     * Wraps the base container in a StartedVaultContainer with helper accessors.
+     */
+    start(): Promise<StartedVaultContainer>;
+}
+/**
+ * A running Vault container, with accessors for port, address, and exec helper.
+ */
+export declare class StartedVaultContainer extends AbstractStartedContainer {
+    private readonly token?;
+    constructor(startedTestContainer: AbstractStartedContainer["startedTestContainer"], token?: string | undefined);
+    /**
+     * Returns the mapped host port for Vault (default: 8200).
+     */
+    getVaultPort(): number;
+    /**
+     * Returns the full Vault HTTP address (e.g., http://localhost:32768).
+     */
+    getAddress(): string;
+    /**
+     * Returns the root token set at container creation time, if any.
+     */
+    getRootToken(): string | undefined;
+    /**
+     * Executes Vault CLI commands inside the container after it has started.
+     *
+     * This is typically used to pre-configure secret engines or seed test data.
+     *
+     * @example
+     * await container.execVaultCommands([
+     *   "secrets enable transit",
+     *   "write -f transit/keys/my-key",
+     *   "kv put secret/my-secret value=123",
+     * ]);
+     *
+     * @param commands Array of Vault CLI commands (without the `vault` prefix)
+     * @throws If the command fails (non-zero exit code)
+     */
+    execVaultCommands(commands: string[]): Promise<void>;
+}

package/build/vault-container.js

@@ -0,0 +1,125 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StartedVaultContainer = exports.VaultContainer = void 0;
+const testcontainers_1 = require("testcontainers");
+const VAULT_PORT = 8200;
+/**
+ * Testcontainers module for HashiCorp Vault.
+ *
+ * This container exposes Vault on port 8200, sets up a wait strategy using the health check endpoint, and supports:
+ * - Supplying a root token
+ * - Executing post-start CLI init commands
+ */
+class VaultContainer extends testcontainers_1.GenericContainer {
+    initCommands = [];
+    token;
+    /**
+     * Constructs a VaultContainer with a default image and healthcheck strategy.
+     *
+     * - Sets VAULT_ADDR to internal container address
+     * - Adds IPC_LOCK capability (required by Vault)
+     * - Exposes Vault on port 8200
+     * - Waits for HTTP 200 response from /v1/sys/health
+     * @param image Docker image to use (e.g. `hashicorp/vault:1.13.0`)
+     */
+    constructor(image) {
+        super(image);
+        this.withExposedPorts(VAULT_PORT)
+            .withEnvironment({ VAULT_ADDR: `http://0.0.0.0:${VAULT_PORT}` })
+            .withAddedCapabilities("IPC_LOCK")
+            .withWaitStrategy(testcontainers_1.Wait.forHttp("/v1/sys/health", VAULT_PORT).forStatusCode(200));
+    }
+    /**
+     * Sets a root token to be used with Vault, passed via environment variables.
+     *
+     * @param token Vault root token
+     * @returns this
+     */
+    withVaultToken(token) {
+        this.token = token;
+        this.withEnvironment({
+            VAULT_DEV_ROOT_TOKEN_ID: token,
+            VAULT_TOKEN: token,
+        });
+        return this;
+    }
+    /**
+     * Registers one or more Vault CLI init commands to be run after container starts.
+     *
+     * Example:
+     *   .withInitCommands("secrets enable transit", "kv put secret/foo bar=baz")
+     *
+     * @param commands Vault CLI commands (without `vault` prefix)
+     * @returns this
+     */
+    withInitCommands(...commands) {
+        this.initCommands.push(...commands);
+        return this;
+    }
+    /**
+     * Starts the Vault container and executes any registered init commands.
+     *
+     * Wraps the base container in a StartedVaultContainer with helper accessors.
+     */
+    async start() {
+        const started = await super.start();
+        const container = new StartedVaultContainer(started, this.token);
+        if (this.initCommands.length > 0) {
+            await container.execVaultCommands(this.initCommands);
+        }
+        return container;
+    }
+}
+exports.VaultContainer = VaultContainer;
+/**
+ * A running Vault container, with accessors for port, address, and exec helper.
+ */
+class StartedVaultContainer extends testcontainers_1.AbstractStartedContainer {
+    token;
+    constructor(startedTestContainer, token) {
+        super(startedTestContainer);
+        this.token = token;
+    }
+    /**
+     * Returns the mapped host port for Vault (default: 8200).
+     */
+    getVaultPort() {
+        return this.getMappedPort(VAULT_PORT);
+    }
+    /**
+     * Returns the full Vault HTTP address (e.g., http://localhost:32768).
+     */
+    getAddress() {
+        return `http://${this.getHost()}:${this.getVaultPort()}`;
+    }
+    /**
+     * Returns the root token set at container creation time, if any.
+     */
+    getRootToken() {
+        return this.token;
+    }
+    /**
+     * Executes Vault CLI commands inside the container after it has started.
+     *
+     * This is typically used to pre-configure secret engines or seed test data.
+     *
+     * @example
+     * await container.execVaultCommands([
+     *   "secrets enable transit",
+     *   "write -f transit/keys/my-key",
+     *   "kv put secret/my-secret value=123",
+     * ]);
+     *
+     * @param commands Array of Vault CLI commands (without the `vault` prefix)
+     * @throws If the command fails (non-zero exit code)
+     */
+    async execVaultCommands(commands) {
+        const cmd = commands.map((c) => `vault ${c}`).join(" && ");
+        const result = await this.exec(["/bin/sh", "-c", cmd]);
+        if (result.exitCode !== 0) {
+            throw new Error(`execVaultCommands failed with exit code ${result.exitCode}: ${result.output}`);
+        }
+    }
+}
+exports.StartedVaultContainer = StartedVaultContainer;
+//# sourceMappingURL=vault-container.js.map

package/build/vault-container.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vault-container.js","sourceRoot":"","sources":["../src/vault-container.ts"],"names":[],"mappings":";;;AAAA,mDAAkF;AAElF,MAAM,UAAU,GAAG,IAAI,CAAC;AAExB;;;;;;GAMG;AACH,MAAa,cAAe,SAAQ,iCAAgB;IACjC,YAAY,GAAa,EAAE,CAAC;IACrC,KAAK,CAAU;IAEvB;;;;;;;;OAQG;IACH,YAAY,KAAa;QACvB,KAAK,CAAC,KAAK,CAAC,CAAC;QAEb,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC;aAC9B,eAAe,CAAC,EAAE,UAAU,EAAE,kBAAkB,UAAU,EAAE,EAAE,CAAC;aAC/D,qBAAqB,CAAC,UAAU,CAAC;aACjC,gBAAgB,CAAC,qBAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,UAAU,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC;IACrF,CAAC;IAED;;;;;OAKG;IACI,cAAc,CAAC,KAAa;QACjC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,eAAe,CAAC;YACnB,uBAAuB,EAAE,KAAK;YAC9B,WAAW,EAAE,KAAK;SACnB,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;OAQG;IACI,gBAAgB,CAAC,GAAG,QAAkB;QAC3C,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,CAAC;QACpC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACa,KAAK,CAAC,KAAK;QACzB,MAAM,OAAO,GAAG,MAAM,KAAK,CAAC,KAAK,EAAE,CAAC;QACpC,MAAM,SAAS,GAAG,IAAI,qBAAqB,CAAC,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;QAEjE,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACjC,MAAM,SAAS,CAAC,iBAAiB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACvD,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AAlED,wCAkEC;AAED;;GAEG;AACH,MAAa,qBAAsB,SAAQ,yCAAwB;IAG9C;IAFnB,YACE,oBAAsE,EACrD,KAAc;QAE/B,KAAK,CAAC,oBAAoB,CAAC,CAAC;QAFX,UAAK,GAAL,KAAK,CAAS;IAGjC,CAAC;IAED;;OAEG;IACI,YAAY;QACjB,OAAO,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;IACxC,CAAC;IAED;;OAEG;IACI,UAAU;QACf,OAAO,UAAU,IAAI,CAAC,OAAO,EAAE,IAAI,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC;IAC3D,CAAC;IAED;;OAEG;IACI,YAAY;QACjB,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACI,KAAK,CAAC,iBAAiB,CAAC,QAAkB;QAC/C,MAAM,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC3D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;QAEvD,IAAI,MAAM,CAAC,QAAQ,KAAK,CAAC,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CAAC,2CAA2C,MAAM,CAAC,QAAQ,KAAK,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;QAClG,CAAC;IACH,CAAC;CACF;AApDD,sDAoDC"}

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@testcontainers/vault",
+  "version": "11.3.0",
+  "license": "MIT",
+  "keywords": [
+    "vault",
+    "hashicorp",
+    "testing",
+    "docker",
+    "testcontainers"
+  ],
+  "description": "HashiCorp Vault 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": {
+    "node-vault": "^0.10.5"
+  },
+  "dependencies": {
+    "testcontainers": "^11.3.0"
+  }
+}