testcontainers::ExecOptions Struct Reference

Options for running a command inside a container via exec. More...

#include <testcontainers/ExecOptions.hpp>

Public Attributes
std::vector< std::string >	env
	each "KEY=VALUE" (Env)
std::optional< std::string >	working_dir
	WorkingDir.
std::optional< std::string >	user
	User ("name" or "uid[:gid]").
bool	privileged = false
	Privileged.
bool	tty = false
	allocate a TTY (raw, unframed output)
bool	detach = false
	Fire-and-forget (docker exec -d): start the command and return immediately instead of waiting for it to finish.
std::optional< std::string >	stdin_data
	When set, attach stdin, feed these bytes, then half-close so the reader sees EOF.
std::optional< TtySize >	console_size
	Initial console size of a tty exec, rows x columns.
std::function< void(const std::string &exec_id)>	on_started
	Called once, with the exec's id, right after the exec is STARTED — for an attached exec: after the start response's header arrives, before any stdin goes out or output is read.

Detailed Description

Options for running a command inside a container via exec.

All fields are plain std types so the public header stays free of any third-party (Boost / nlohmann / asio) dependency.

Member Data Documentation

env

std::vector<std::string> testcontainers::ExecOptions::env

each "KEY=VALUE" (Env)

working_dir

std::optional<std::string> testcontainers::ExecOptions::working_dir

WorkingDir.

user

std::optional<std::string> testcontainers::ExecOptions::user

User ("name" or "uid[:gid]").

privileged

bool testcontainers::ExecOptions::privileged = false

Privileged.

tty

bool testcontainers::ExecOptions::tty = false

allocate a TTY (raw, unframed output)

detach

bool testcontainers::ExecOptions::detach = false

Fire-and-forget (docker exec -d): start the command and return immediately instead of waiting for it to finish.

Nothing is attached or captured — the returned ExecResult keeps its defaults (empty output, exit_code 0; the command is still running, so its real status is unknown; a command that fails inside the container surfaces no error). Cannot be combined with stdin_data or with the streaming (consumer) exec overload: those combinations throw DockerError before any daemon interaction.

stdin_data

std::optional<std::string> testcontainers::ExecOptions::stdin_data

When set, attach stdin, feed these bytes, then half-close so the reader sees EOF.

Requires a half-closable transport — TCP, unix socket, or a message-mode Windows named pipe (every real daemon's pipe is one): on the TLS transport and byte-mode pipes exec throws instead (no EOF signal is possible there, so a reader like cat would hang forever).

console_size

std::optional<TtySize> testcontainers::ExecOptions::console_size

Initial console size of a tty exec, rows x columns.

Commands that format to the terminal width see this size from their first output byte (resize_exec can change it mid-run). Meaningful only with tty = true; daemons older than API 1.42 silently ignore it.

on_started

std::function<void(const std::string& exec_id)> testcontainers::ExecOptions::on_started

Called once, with the exec's id, right after the exec is STARTED — for an attached exec: after the start response's header arrives, before any stdin goes out or output is read.

That id (and that moment) is exactly what DockerClient::resize_exec needs. Runs on the calling thread; keep it quick — the output stream is not being drained while it runs. An exception thrown here propagates out of exec (the connection is released, but the already-started command keeps running in the container).