TestcontainersConfiguration class

Holds all runtime-tunable configuration for testcontainers-dart.

Values are read from environment variables at construction time and can be overridden programmatically (useful in tests). The global singleton testcontainersConfig is the authoritative source used throughout the library.

Example — disable Ryuk in a CI environment:

testcontainersConfig.ryukDisabled = true;

Constructors

TestcontainersConfiguration()
Creates a configuration object by reading from environment variables and ~/.testcontainers.properties.

Properties

connectionModeOverride → ConnectionMode?
Overrides the automatic connection-mode detection.
final
dockerAuthConfig ↔ String?
Raw JSON string from DOCKER_AUTH_CONFIG, or null.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
hubImageNamePrefix → String
Optional prefix prepended to every image name.
final
maxTries → int
Maximum number of polling attempts before a wait strategy gives up.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
ryukDisabled ↔ bool
Whether the Ryuk resource-reaper is disabled.
getter/setter pair
ryukDockerSocket ↔ String
The Docker socket path used by the Ryuk reaper container.
getter/setter pair
ryukImage → String
Docker image used to run the Ryuk resource-reaper container.
final
ryukPrivileged ↔ bool
Whether the Ryuk container should run with Docker --privileged mode.
getter/setter pair
ryukReconnectionTimeout → String
Timeout string passed to Ryuk via the RYUK_RECONNECTION_TIMEOUT environment variable inside the Ryuk container.
final
sleepTime → double
Sleep duration in seconds between wait-strategy poll attempts.
final
tcHost → String?
Returns the tc.host value from ~/.testcontainers.properties, or null.
no setter
tcHostOverride → String?
Overrides the host address returned by DockerClient.host.
final
tcProperties → Map<String, String>
Properties loaded from ~/.testcontainers.properties.
final
timeout → double
The effective startup timeout in seconds: maxTries × sleepTime.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited