testcontainers-modules 0.15.0

Community maintained modules for Testcontainers for 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
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

use std::borrow::Cow;

use testcontainers::{
    core::{ContainerPort, WaitFor},
    Image,
};

const DEFAULT_IMAGE_NAME: &str = "gvenzl/oracle-free";
const DEFAULT_IMAGE_TAG: &str = "23-slim-faststart";
/// Port that the [`Oracle Database Free`] container has internally
/// Can be rebound externally via [`testcontainers::core::ImageExt::with_mapped_port`]
///
/// [`Oracle Database Free`]: https://www.oracle.com/database/free/
pub const FREE_PORT: ContainerPort = ContainerPort::Tcp(1521);

/// Module to work with [`Oracle Database Free`] inside of tests.
/// The default image is [`gvenzl/oracle-free:23-slim-faststart`] (unofficial).
/// Official dockerfiles can be found [here][Oracle official dockerfiles].
///
/// The default schema is `test`, with a password `test`.
///
/// NOTE: Currently, there is no Oracle Database Free port for ARM chips,
/// hence Oracle Database Free images cannot run on the new Apple M chips via Docker Desktop.
///
/// # Example
/// ```
/// use std::time::Duration;
/// use testcontainers_modules::{oracle::free::Oracle, testcontainers::{runners::SyncRunner, ImageExt}};
///
/// // On slower machines more time needed than 60 seconds may be required (see `with_startup_timeout`).
/// let oracle = Oracle::default()
///     .start()
///     .unwrap();
///
/// let http_port = oracle.get_host_port_ipv4(1521).unwrap();
///
/// // do something with the started Oracle instance..
/// ```
///
/// [`Oracle Database Free`]: https://www.oracle.com/database/free/
/// [Oracle official dockerfiles]: https://github.com/oracle/docker-images/tree/main/OracleDatabase
/// [`gvenzl/oracle-free:23-slim-faststart`]: https://hub.docker.com/r/gvenzl/oracle-free
#[derive(Debug, Default, Clone)]
pub struct Oracle {
    /// (remove if there is another variable)
    /// Field is included to prevent this struct to be a unit struct.
    /// This allows extending functionality (and thus further variables) without breaking changes
    _priv: (),
}

impl Image for Oracle {
    fn name(&self) -> &str {
        DEFAULT_IMAGE_NAME
    }

    fn tag(&self) -> &str {
        DEFAULT_IMAGE_TAG
    }

    fn ready_conditions(&self) -> Vec<WaitFor> {
        vec![WaitFor::message_on_stdout("DATABASE IS READY TO USE!")]
    }

    fn env_vars(
        &self,
    ) -> impl IntoIterator<Item = (impl Into<Cow<'_, str>>, impl Into<Cow<'_, str>>)> {
        [
            ("ORACLE_PASSWORD", "testsys"),
            ("APP_USER", "test"),
            ("APP_USER_PASSWORD", "test"),
        ]
    }

    fn expose_ports(&self) -> &[ContainerPort] {
        &[FREE_PORT]
    }
}

#[cfg(test)]
mod tests {
    use std::time::Duration;

    use super::*;
    use crate::testcontainers::{runners::SyncRunner, ImageExt};

    // remember to provide Oracle client 11.2 or later (see https://crates.io/crates/oracle)

    #[test]
    fn oracle_one_plus_one() -> Result<(), Box<dyn std::error::Error + 'static>> {
        let oracle = Oracle::default()
            .pull_image()?
            .with_startup_timeout(Duration::from_secs(75));

        let node = oracle.start()?;

        let connection_string = format!(
            "//{}:{}/FREEPDB1",
            node.get_host()?,
            node.get_host_port_ipv4(1521)?
        );
        let conn = oracle::Connection::connect("test", "test", connection_string)?;

        let mut rows = conn.query("SELECT 1 + 1", &[])?;
        let row = rows.next().unwrap()?;
        let col: i32 = row.get(0)?;
        assert_eq!(col, 2);
        Ok(())
    }
}