Skip to content

Testing helpers

Two kinds of test support ship in the testing module of each package:

  • In-memory fakes and the conformance runner (shared by every Grow Codes package), see Secrets → Testing.
  • Server lifecycle helpers for test fixtures and bootstrap scripts: initialise, unseal and seal a server and wait until it is active. They are deliberately not part of the main client API.
Function What it does
initStatus(client) GET sys/init → initialised or not
init(client, {secretShares = 1, secretThreshold = 1, recoveryShares?, recoveryThreshold?}) PUT sys/init; returns the unseal (or recovery) keys and the root token, all redacted; an initialised server → VALIDATION; never retried
unseal(client, key) enters one key share (hex or base64), returns the seal status; an invalid key → VALIDATION. Reset the progress with {reset: true} (TypeScript, Python), unseal_reset (Rust) or resetUnseal (Java).
seal(client) PUT sys/seal with the client token (root or sudo)
waitForActive(client, timeout = 30 s) polls sys.health() until the node is active; TIMEOUT otherwise

Where they live: TypeScript @grow-codes/openbao/testing; Rust grow_openbao::testing (feature testing); Go package github.com/grow-codes-packages/openbao/go/testkit; Python grow_openbao.testing.lifecycle (a… forms for AsyncOpenBaoClient); Java codes.grow.packages.openbao.testing.OpenBaoTesting (plus initRecovery for auto-unseal seals).

import { init, initStatus, unseal, waitForActive } from "@grow-codes/openbao/testing";

const client = new OpenBaoClient({ url: "http://openbao-shamir:8200" });
if (!(await initStatus(client))) {
  const res = await init(client, { secretShares: 1, secretThreshold: 1 });
  await unseal(client, res.keys[0]!);
  client.setToken(res.rootToken);
}
await waitForActive(client, { timeoutMs: 30_000 });
use grow_openbao::testing::{self, InitOptions};

if !testing::init_status(&client).await? {
    let res = testing::init(&client, &InitOptions::default()).await?;
    testing::unseal(&client, res.keys[0].expose_secret()).await?;
    client.set_token(Some(res.root_token.clone()));
}
testing::wait_for_active(&client, Duration::from_secs(30)).await?;
import "github.com/grow-codes-packages/openbao/go/testkit"

if ok, err := testkit.InitStatus(ctx, client, nil); err == nil && !ok {
    res, err := testkit.Init(ctx, client, &testkit.InitOptions{SecretShares: 1, SecretThreshold: 1})
    if err != nil {
        return err
    }
    if _, err := testkit.Unseal(ctx, client, res.Keys[0].Reveal(), nil); err != nil {
        return err
    }
    client.SetToken(res.RootToken.Reveal())
}
_, err := testkit.WaitForActive(ctx, client, 30*time.Second)
from grow_openbao.testing import lifecycle

if not lifecycle.init_status(client):
    res = lifecycle.init(client, secret_shares=1, secret_threshold=1)
    lifecycle.unseal(client, res.keys[0])
    client.set_token(res.root_token)
lifecycle.wait_for_active(client, timeout_s=30)
if (!OpenBaoTesting.initStatus(client)) {
  InitResult res = OpenBaoTesting.init(client, 1, 1);
  OpenBaoTesting.unseal(client, res.keys().get(0));
  client.setToken(res.rootToken());
}
OpenBaoTesting.waitForActive(client, Duration.ofSeconds(30));