Skip to content

Valkey

Install

1
npm install @testcontainers/valkey --save-dev

Examples

These examples use the following libraries:

  • redis
    1
    npm install redis

Choose an image from the container registry and substitute IMAGE.

Set/get a value

1
2
3
4
5
6
7
8
9
await using container = await new ValkeyContainer(IMAGE).start();

const client = createClient({ url: container.getConnectionUrl() });
await client.connect();

await client.set("key", "val");
expect(await client.get("key")).toBe("val");

client.destroy();

With password

1
2
3
4
5
const password = "testPassword";

await using container = await new ValkeyContainer(IMAGE).withPassword(password).start();

expect(container.getConnectionUrl()).toEqual(`redis://:${password}@${container.getHost()}:${container.getPort()}`);

With persistent data

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const sourcePath = fs.mkdtempSync("valkey-");

await using container = await new ValkeyContainer(IMAGE).withPassword("test").withPersistence(sourcePath).start();

let client = createClient({ url: container.getConnectionUrl() });
await client.connect();

await client.set("key", "val");
client.destroy();

await container.restart();
client = createClient({ url: container.getConnectionUrl() });
await client.connect();

expect(await client.get("key")).toBe("val");

client.destroy();
fs.rmSync(sourcePath, { force: true, recursive: true });

With predefined data

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
await using container = await new ValkeyContainer(IMAGE)
  .withPassword("test")
  .withInitialData(path.join(__dirname, "initData.valkey"))
  .start();

const client = createClient({ url: container.getConnectionUrl() });
await client.connect();

const user = {
  first_name: "David",
  last_name: "Bloom",
  dob: "03-MAR-1981",
};
expect(await client.get("user:002")).toBe(JSON.stringify(user));

client.destroy();

Execute a command inside the container

1
2
3
4
5
await using container = await new ValkeyContainer(IMAGE).start();

const queryResult = await container.executeCliCmd("info", ["clients"]);

expect(queryResult).toEqual(expect.stringContaining("connected_clients:1"));