Public API for TestcontainerEx.
This module is a thin facade that delegates to the GenServer
(TestcontainerEx.Server) and domain modules.
Summary
Functions
Returns container logs.
Convenience alias for start_container/2.
Convenience alias for start_containers/2.
Executes a command inside a running container.
Returns the latest Docker inspect result for a container ID.
Monitors a container until a predicate returns {:ok, value} or the timeout elapses.
Parses the default gateway IP from /proc/net/route content.
Convenience alias for start_container/2.
Convenience alias for start_containers/2.
Returns true when running inside a container (Docker, Podman, Kubernetes).
Starts multiple containers.
Stops a container and waits until Docker no longer reports it running.
Stops multiple containers.
Functions
Returns container logs.
Options include :stdout, :stderr, :timestamps, :tail, :since,
:until_time, and :follow.
Convenience alias for start_container/2.
Convenience alias for start_containers/2.
Executes a command inside a running container.
Returns the latest Docker inspect result for a container ID.
Monitors a container until a predicate returns {:ok, value} or the timeout elapses.
The predicate receives the latest inspected container and must return {:ok, value}
to succeed or {:error, reason} to retry.
Parses the default gateway IP from /proc/net/route content.
Returns {:ok, ip_string} or {:error, :no_default_route}.
Convenience alias for start_container/2.
Convenience alias for start_containers/2.
Returns true when running inside a container (Docker, Podman, Kubernetes).
Accepts optional overrides for the .dockerenv path, cgroup path,
Kubernetes secrets path, and Podman containerenv path
(useful for testing on non-Linux hosts).
Starts multiple containers.
Accepts a list of config builders and returns {:ok, containers} only when
all containers start successfully. On failure, returns {:error, results}
where results contains per-container {:ok, container} or {:error, reason}
entries in the same order as the input.
Stops a container and waits until Docker no longer reports it running.
Stops multiple containers.
Returns {:ok, results} with one result per container ID. Nonexistent
containers are treated as already stopped by the Docker API.