1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375
use std::{collections::BTreeMap, env::var, fmt::Debug, time::Duration};
use super::ports::Ports;
/// Represents a docker image.
///
/// Implementations are required to implement Default. The default instance of an [`Image`]
/// should have a meaningful configuration! It should be possible to [`run`][docker_run] the default
/// instance of an Image and get back a working container!
///
/// [`Image`]: trait.Image.html
/// [docker_run]: trait.Docker.html#tymethod.run
pub trait Image
where
Self: Sized,
Self::Args: ImageArgs + Clone + Debug,
{
/// A type representing the arguments for an Image.
///
/// There are a couple of things regarding the arguments of images:
///
/// 1. Similar to the Default implementation of an Image, the Default instance
/// of its arguments should be meaningful!
/// 2. Implementations should be conservative about which arguments they expose. Many times,
/// users will either go with the default arguments or just override one or two. When defining
/// the arguments of your image, consider that the whole purpose is to facilitate integration
/// testing. Only expose those that actually make sense for this case.
type Args;
/// The name of the docker image to pull from the Docker Hub registry.
fn name(&self) -> String;
/// Implementations are encouraged to include a tag that will not change (i.e. NOT latest)
/// in order to prevent test code from randomly breaking because the underlying docker
/// suddenly changed.
fn tag(&self) -> String;
/// Returns a list of conditions that need to be met before a started container is considered ready.
///
/// This method is the **🍞 and butter** of the whole testcontainers library. Containers are
/// rarely instantly available as soon as they are started. Most of them take some time to boot
/// up.
///
/// The conditions returned from this method are evaluated **in the order** they are returned. Therefore
/// you most likely want to start with a [`WaitFor::StdOutMessage`] or [`WaitFor::StdErrMessage`] and
/// potentially follow up with a [`WaitFor::Duration`] in case the container usually needs a little
/// more time before it is ready.
fn ready_conditions(&self) -> Vec<WaitFor>;
/// There are a couple of things regarding the environment variables of images:
///
/// 1. Similar to the Default implementation of an Image, the Default instance
/// of its environment variables should be meaningful!
/// 2. Implementations should be conservative about which environment variables they expose. Many times,
/// users will either go with the default ones or just override one or two. When defining
/// the environment variables of your image, consider that the whole purpose is to facilitate integration
/// testing. Only expose those that actually make sense for this case.
fn env_vars(&self) -> Box<dyn Iterator<Item = (&String, &String)> + '_> {
Box::new(std::iter::empty())
}
/// There are a couple of things regarding the volumes of images:
///
/// 1. Similar to the Default implementation of an Image, the Default instance
/// of its volumes should be meaningful!
/// 2. Implementations should be conservative about which volumes they expose. Many times,
/// users will either go with the default ones or just override one or two. When defining
/// the volumes of your image, consider that the whole purpose is to facilitate integration
/// testing. Only expose those that actually make sense for this case.
fn volumes(&self) -> Box<dyn Iterator<Item = (&String, &String)> + '_> {
Box::new(std::iter::empty())
}
/// Returns the entrypoint this instance was created with.
fn entrypoint(&self) -> Option<String> {
None
}
/// Returns the ports that needs to be exposed when a container is created.
///
/// This method is useful when there is a need to expose some ports, but there is
/// no EXPOSE instruction in the Dockerfile of an image.
fn expose_ports(&self) -> Vec<u16> {
Default::default()
}
/// Returns the commands that needs to be executed after a container is started i.e. commands
/// to be run in a running container.
///
/// This method is useful when certain re-configuration is required after the start
/// of container for the container to be considered ready for use in tests.
#[allow(unused_variables)]
fn exec_after_start(&self, cs: ContainerState) -> Vec<ExecCommand> {
Default::default()
}
}
#[derive(Default, Debug)]
pub struct ExecCommand {
/// Command to be executed
pub cmd: String,
/// Conditions to be checked on related container
pub ready_conditions: Vec<WaitFor>,
}
#[derive(Debug)]
pub struct ContainerState {
ports: Ports,
}
impl ContainerState {
pub fn new(ports: Ports) -> Self {
Self { ports }
}
#[deprecated(
since = "0.13.1",
note = "Use `host_port_ipv4()` or `host_port_ipv6()` instead."
)]
pub fn host_port(&self, internal_port: u16) -> u16 {
self.host_port_ipv4(internal_port)
}
pub fn host_port_ipv4(&self, internal_port: u16) -> u16 {
self.ports
.map_to_host_port_ipv4(internal_port)
.unwrap_or_else(|| panic!("Container does not have a mapped port for {internal_port}",))
}
pub fn host_port_ipv6(&self, internal_port: u16) -> u16 {
self.ports
.map_to_host_port_ipv6(internal_port)
.unwrap_or_else(|| panic!("Container does not have a mapped port for {internal_port}",))
}
}
pub trait ImageArgs {
fn into_iterator(self) -> Box<dyn Iterator<Item = String>>;
}
impl ImageArgs for () {
fn into_iterator(self) -> Box<dyn Iterator<Item = String>> {
Box::new(vec![].into_iter())
}
}
#[must_use]
#[derive(Debug)]
pub struct RunnableImage<I: Image> {
image: I,
image_args: I::Args,
image_tag: Option<String>,
container_name: Option<String>,
network: Option<String>,
env_vars: BTreeMap<String, String>,
volumes: BTreeMap<String, String>,
ports: Option<Vec<Port>>,
privileged: bool,
shm_size: Option<u64>,
}
impl<I: Image> RunnableImage<I> {
pub fn inner(&self) -> &I {
&self.image
}
pub fn args(&self) -> &I::Args {
&self.image_args
}
pub fn network(&self) -> &Option<String> {
&self.network
}
pub fn container_name(&self) -> &Option<String> {
&self.container_name
}
pub fn env_vars(&self) -> Box<dyn Iterator<Item = (&String, &String)> + '_> {
Box::new(self.image.env_vars().chain(self.env_vars.iter()))
}
pub fn volumes(&self) -> Box<dyn Iterator<Item = (&String, &String)> + '_> {
Box::new(self.image.volumes().chain(self.volumes.iter()))
}
pub fn ports(&self) -> &Option<Vec<Port>> {
&self.ports
}
pub fn privileged(&self) -> bool {
self.privileged
}
/// Shared memory size in bytes
pub fn shm_size(&self) -> Option<u64> {
self.shm_size
}
pub fn entrypoint(&self) -> Option<String> {
self.image.entrypoint()
}
pub fn descriptor(&self) -> String {
if let Some(tag) = &self.image_tag {
format!("{}:{tag}", self.image.name())
} else {
format!("{}:{}", self.image.name(), self.image.tag())
}
}
pub fn ready_conditions(&self) -> Vec<WaitFor> {
self.image.ready_conditions()
}
pub fn expose_ports(&self) -> Vec<u16> {
self.image.expose_ports()
}
pub fn exec_after_start(&self, cs: ContainerState) -> Vec<ExecCommand> {
self.image.exec_after_start(cs)
}
}
impl<I: Image> RunnableImage<I> {
/// There is no guarantee that the specified tag for an image would result in a
/// running container. Users of this API are advised to use this at their own risk.
pub fn with_tag(self, tag: impl Into<String>) -> Self {
Self {
image_tag: Some(tag.into()),
..self
}
}
pub fn with_container_name(self, name: impl Into<String>) -> Self {
Self {
container_name: Some(name.into()),
..self
}
}
pub fn with_network(self, network: impl Into<String>) -> Self {
Self {
network: Some(network.into()),
..self
}
}
pub fn with_env_var(self, (key, value): (impl Into<String>, impl Into<String>)) -> Self {
let mut env_vars = self.env_vars;
env_vars.insert(key.into(), value.into());
Self { env_vars, ..self }
}
pub fn with_volume(self, (orig, dest): (impl Into<String>, impl Into<String>)) -> Self {
let mut volumes = self.volumes;
volumes.insert(orig.into(), dest.into());
Self { volumes, ..self }
}
pub fn with_mapped_port<P: Into<Port>>(self, port: P) -> Self {
let mut ports = self.ports.unwrap_or_default();
ports.push(port.into());
Self {
ports: Some(ports),
..self
}
}
pub fn with_privileged(self, privileged: bool) -> Self {
Self { privileged, ..self }
}
pub fn with_shm_size(self, bytes: u64) -> Self {
Self {
shm_size: Some(bytes),
..self
}
}
}
impl<I> From<I> for RunnableImage<I>
where
I: Image,
I::Args: Default,
{
fn from(image: I) -> Self {
Self::from((image, I::Args::default()))
}
}
impl<I: Image> From<(I, I::Args)> for RunnableImage<I> {
fn from((image, image_args): (I, I::Args)) -> Self {
Self {
image,
image_args,
image_tag: None,
container_name: None,
network: None,
env_vars: BTreeMap::default(),
volumes: BTreeMap::default(),
ports: None,
privileged: false,
shm_size: None,
}
}
}
/// Represents a port mapping between a local port and the internal port of a container.
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct Port {
pub local: u16,
pub internal: u16,
}
/// Represents a condition that needs to be met before a container is considered ready.
#[derive(Debug, Eq, PartialEq, Clone)]
pub enum WaitFor {
/// An empty condition. Useful for default cases or fallbacks.
Nothing,
/// Wait for a message on the stdout stream of the container's logs.
StdOutMessage { message: String },
/// Wait for a message on the stderr stream of the container's logs.
StdErrMessage { message: String },
/// Wait for a certain amount of time.
Duration { length: Duration },
/// Wait for the container's status to become `healthy`.
Healthcheck,
}
impl WaitFor {
pub fn message_on_stdout<S: Into<String>>(message: S) -> WaitFor {
WaitFor::StdOutMessage {
message: message.into(),
}
}
pub fn message_on_stderr<S: Into<String>>(message: S) -> WaitFor {
WaitFor::StdErrMessage {
message: message.into(),
}
}
pub fn seconds(length: u64) -> WaitFor {
WaitFor::Duration {
length: Duration::from_secs(length),
}
}
pub fn millis(length: u64) -> WaitFor {
WaitFor::Duration {
length: Duration::from_millis(length),
}
}
pub fn millis_in_env_var(name: &'static str) -> WaitFor {
let additional_sleep_period = var(name).map(|value| value.parse());
(|| {
let length = additional_sleep_period.ok()?.ok()?;
Some(WaitFor::Duration {
length: Duration::from_millis(length),
})
})()
.unwrap_or(WaitFor::Nothing)
}
}
impl From<(u16, u16)> for Port {
fn from((local, internal): (u16, u16)) -> Self {
Port { local, internal }
}
}