LibTmux.Testing 0.1.1

LibTmux.Testing

Scoped tmux servers, sessions and windows for testing code that drives tmux, on top of LibTmux.

Each scope owns what it created. Disposal attempts to tear it down even when the test body throws.

Add it to your test project:

$ dotnet add package LibTmux.Testing

Releases. Releases are numbered 0.1.N, and each release increments N. The API is not settled: any release may change or remove exported identifiers, and the changelog marks each break. Pin an exact version to avoid one.

Quick start

Give a test a tmux server of its own, type into its pane, and wait for the result. The block uses ct from your test:

TmuxTestFactory factory = new();
await using TemporaryHierarchyScope scope = await factory.CreateHierarchyAsync(cancellationToken: ct);

await scope.Pane.SendTextAsync("echo $((6 * 7))", cancellationToken: ct);
await scope.Pane.EnterAsync(ct);

// The product is printed only once the shell has run the line.
string screen = await TmuxWait.UntilAsync(
    async token => string.Join('\n', await scope.Pane.CaptureAsync(cancellationToken: token)),
    text => text.Contains("42", StringComparison.Ordinal),
    TimeSpan.FromSeconds(10),
    TimeSpan.FromMilliseconds(20));

It prints nothing and returns once the pane shows 42. Disposing the scope kills the server, even when an assertion above it throws.

Create the scopes a test needs

TmuxTestFactory: a server, session, window, or whole hierarchy

CreateHierarchyAsync starts a server on a socket of its own, with one session, window, and pane.

The TemporaryServerScope, TemporarySessionScope, and TemporaryWindowScope types stop at the level their name gives. TmuxNameGenerator hands out names no live session is using.

TmuxWait.UntilAsync: wait for a state

It polls a state until a condition holds or a timeout passes, and it replaces a sleep. It ships in LibTmux, because reading back what a command produced is ordinary client work.

What it leaves out

• Test scaffolding in your application. This ships apart from LibTmux, so an application that references the client carries no test scaffolding in its output or its trim closure.
• Your existing tmux. Default settings create a server on a unique socket. Disposal stops only the daemon the scope owns.

Support and status

• Releases. Releases are numbered 0.1.N, and each release increments N. The API is not settled: any release may change or remove exported identifiers, and the changelog marks each break. Pin an exact version to avoid one.
• Dependencies. LibTmux.
• tmux and .NET. The tmux versions LibTmux supports, on net8.0 and net10.0.
• Systems. Linux, including WSL. macOS is best effort, without CI coverage. CI builds on Windows x64.

Documentation

• Testing with libtmux on libtmux.org: an isolated server and cleanup failures
• TmuxTestFactory and TemporaryHierarchyScope
• Source: src/LibTmux.Testing; issues and history on GitHub

License

MIT