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

use std::path::Path;

use typed_builder::TypedBuilder;

use super::ComposeService;
use crate::{ExposedPort, WaitStrategy};

/// Contains configuration require to run compose containers
///
/// See [existings compose images](https://github.com/wefoxplatform/rustainers/tree/main/rustainers/src/compose/images/)
/// for real usages.
#[derive(Debug, Clone, TypedBuilder)]
#[builder(field_defaults(setter(prefix = "with_")))]
#[non_exhaustive]
pub struct RunnableComposeContainers<P> {
    pub(crate) compose_path: P,

    /// The wait condition
    #[builder(default, setter(transform = |args: impl IntoIterator<Item = (impl Into<ComposeService>, impl Into<WaitStrategy>)>| args.into_iter().map(|(key, value)| (key.into(), value.into())).collect()))]
    pub(crate) wait_strategies: Vec<(ComposeService, WaitStrategy)>,

    /// The services port mapping
    #[builder(default, setter(transform = |args: impl IntoIterator<Item = (impl Into<ComposeService>, ExposedPort)>| args.into_iter().map(|(key, value)| (key.into(), value)).collect()))]
    pub(crate) port_mappings: Vec<(ComposeService, ExposedPort)>,
}

/// Build a runnable compose containers
pub trait ToRunnableComposeContainers {
    /// The path type
    type AsPath: AsRef<Path>;

    /// Should provide the path of the docker-compose file
    ///
    /// # Errors
    ///
    /// If the compose container cannot be created (e.g. issue while creating a [`crate::compose::TemporaryDirectory`])
    fn to_runnable(
        &self,
        builder: RunnableComposeContainersBuilder<Self::AsPath>,
    ) -> RunnableComposeContainers<Self::AsPath>;
}