vault

Author: cristianrgreco

docs/modules/vault.md

@@ -1,6 +1,4 @@
-# Vault Module
-
-[Vault](https://www.vaultproject.io/) by HashiCorp is a tool for securely accessing secrets such as API keys, passwords, or certificates. This module allows you to run and initialize a Vault container for integration tests.
+# Vault
 
 ## Install
 
@@ -10,20 +8,22 @@ npm install @testcontainers/vault --save-dev
 
 ## Examples
 
-<!--codeinclude-->
-[Start and perform read/write with node-vault:](../../packages/modules/vault/src/vault-container.test.ts) inside_block:readWrite
-<!--/codeinclude-->
+These examples use the following libraries:
 
-<!--codeinclude-->
-[Run Vault CLI init commands at startup:](../../packages/modules/vault/src/vault-container.test.ts) inside_block:initCommands
-<!--/codeinclude-->
+- [node-vault](https://www.npmjs.com/package/node-vault)
 
-## Why use Vault in integration tests?
+        npm install node-vault
 
-With the growing adoption of Vault in modern infrastructure, testing components that depend on Vault for secret resolution or encryption can be complex. This module allows:
+Choose an image from the [container registry](https://hub.docker.com/r/hashicorp/vault) and substitute `IMAGE`.
 
-- Starting a local Vault instance during test runs
-- Seeding secrets or enabling engines with Vault CLI
-- Validating app behavior with secured data access
+### Write/read a value
 
-Use this module to test Vault-backed workflows without the need for pre-provisioned Vault infrastructure.
+<!--codeinclude-->
+[](../../packages/modules/vault/src/vault-container.test.ts) inside_block:readWrite
+<!--/codeinclude-->
+
+### Run CLI init commands at startup
+
+<!--codeinclude-->
+[](../../packages/modules/vault/src/vault-container.test.ts) inside_block:initCommands
+<!--/codeinclude-->

packages/modules/vault/src/vault-container.test.ts

@@ -6,8 +6,8 @@ const VAULT_TOKEN = "my-root-token";
 const IMAGE = getImage(__dirname);
 
 describe("VaultContainer", { timeout: 180_000 }, () => {
-  // inside_block:readWrite {
   it("should start Vault and allow reading/writing secrets", async () => {
+    // inside_block:readWrite {
     await using container = await new VaultContainer(IMAGE).withVaultToken(VAULT_TOKEN).start();
 
     const client = vault({
@@ -28,11 +28,11 @@ describe("VaultContainer", { timeout: 180_000 }, () => {
 
     expect(data.message).toBe("world");
     expect(data.other).toBe("vault");
+    // }
   });
-  // }
 
-  // inside_block:initCommands {
   it("should execute init commands using vault CLI", async () => {
+    // inside_block:initCommands {
     await using container = await new VaultContainer(IMAGE)
       .withVaultToken(VAULT_TOKEN)
       .withInitCommands("secrets enable transit", "write -f transit/keys/my-key")
@@ -42,6 +42,6 @@ describe("VaultContainer", { timeout: 180_000 }, () => {
 
     expect(result.exitCode).toBe(0);
     expect(result.output).toContain("my-key");
+    // }
   });
-  // }
 });