rustainers 0.15.1

A simple, opinionated way to run containers for tests.
Documentation 
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

use std::time::Duration;

use indexmap::IndexMap;
use typed_builder::TypedBuilder;

use crate::{Network, Volume};

/// Run options
///
/// Available options:
///
/// * `wait_interval`: wait until re-check a container state (default 500ms)
/// * `remove`: if we remove the container after the stop (`--rm` flag, default false)
/// * `name`: provide the container name (default unnamed, use the runner name)
/// * `network`: define the network
/// * `volumes`: set some volumes
/// * `env`: set some environment variables
#[derive(Debug, Clone, TypedBuilder)]
#[builder(field_defaults(default, setter(prefix = "with_")))]
pub struct RunOption {
    /// Wait interval for container health check
    #[builder(default = Duration::from_millis(500))]
    pub(super) wait_interval: Duration,

    /// Automatically remove the container when it exits
    pub(super) remove: bool,

    /// Assign a name to the container
    #[builder(setter(into, strip_option))]
    pub(super) name: Option<String>,

    /// The network
    #[builder(default, setter(into))]
    pub(crate) network: Option<Network>,

    /// Volumes
    #[builder(default, setter(transform = |args: impl IntoIterator<Item = impl Into<Volume>>| args.into_iter().map(Into::into).collect()))]
    pub(crate) volumes: Vec<Volume>,

    /// The environment variables
    #[builder(setter(transform = |args: impl IntoIterator<Item = (impl Into<String>, impl Into<String>)>| args.into_iter().map(|(key, value)| (key.into(), value.into())).collect()))]
    pub(crate) env: IndexMap<String, String>,

    /// The command (override the runable command)
    #[builder(default, setter(transform = |args: impl IntoIterator<Item = impl Into<String>>| Some(args.into_iter().map(Into::into).collect())))]
    pub(crate) command: Option<Vec<String>>,

    /// The entrypoint (override the image entrypoint)
    #[builder(default, setter(into, strip_option))]
    pub(crate) entrypoint: Option<String>,
}

impl RunOption {
    /// If we need to remove the container when it's stopped
    #[must_use]
    pub fn remove(&self) -> bool {
        self.remove
    }

    /// The container name
    #[must_use]
    pub fn name(&self) -> Option<&str> {
        self.name.as_deref()
    }
}

impl Default for RunOption {
    fn default() -> Self {
        RunOption::builder().build()
    }
}