tc_core 0.3.1

Core crate of testcontainers, a library for integration-testing against docker containers from within Rust.
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

use std::{collections::HashMap, io::Read};
use Container;
use Image;

/// Defines the minimum API required for interacting with the Docker daemon.
pub trait Docker
where
    Self: Sized,
{
    fn run<I: Image>(&self, image: I) -> Container<Self, I>;
    fn logs(&self, id: &str) -> Logs;
    fn ports(&self, id: &str) -> Ports;
    fn rm(&self, id: &str);
    fn stop(&self, id: &str);
}

/// The exposed ports of a running container.
#[derive(Debug, PartialEq, Default)]
pub struct Ports {
    mapping: HashMap<u32, u32>,
}

impl Ports {
    /// Registers the mapping of an exposed port.
    pub fn add_mapping(&mut self, internal: u32, host: u32) -> &mut Self {
        debug!("Registering port mapping: {} -> {}", internal, host);

        self.mapping.insert(internal, host);

        self
    }

    /// Returns the host port for the given internal port.
    pub fn map_to_host_port(&self, internal_port: u32) -> Option<u32> {
        self.mapping.get(&internal_port).map(|p| p.clone())
    }
}

/// Log streams of running container (stdout & stderr).
#[derive(DebugStub)]
pub struct Logs {
    #[debug_stub = "stream"]
    pub stdout: Box<Read>,
    #[debug_stub = "stream"]
    pub stderr: Box<Read>,
}