testcontainers_modules/zookeeper/
mod.rs

1use std::borrow::Cow;
2
3use testcontainers::{core::WaitFor, Image};
4
5const NAME: &str = "bitnami/zookeeper";
6const TAG: &str = "3.9.0";
7
8/// # [Apache ZooKeeper] image for [testcontainers](https://crates.io/crates/testcontainers).
9///
10/// This image is based on the [`bitnami/zookeeper` docker image].
11/// By default, anonymous logins are allowed.
12/// See the [Zookeeper documentation] for additional options.
13///
14/// # Example
15///
16/// ```
17/// async {
18///     use testcontainers_modules::{testcontainers::runners::AsyncRunner, zookeeper};
19///
20///     let node = zookeeper::Zookeeper::default().start().await.unwrap();
21///     let zk_url = format!(
22///         "{}:{}",
23///         node.get_host().await.unwrap(),
24///         node.get_host_port_ipv4(2181).await.unwrap(),
25///     );
26///     let zk_socket_addr = tokio::net::lookup_host(&zk_url)
27///         .await
28///         .unwrap()
29///         .next()
30///         .unwrap();
31///
32///     let (zk, default_watcher) = tokio_zookeeper::ZooKeeper::connect(&zk_socket_addr)
33///         .await
34///         .expect("connect to Zookeeper");
35///
36///     let path = "/test";
37///     let _stat = zk.watch().exists(path).await.expect("stat received");
38/// };
39/// ```
40///
41///
42/// [Apache ZooKeeper]: https://zookeeper.apache.org/
43/// [`bitnami/zookeeper` docker image]: https://hub.docker.com/r/bitnami/openldap
44/// [Zookeeper documentation]: https://zookeeper.apache.org/documentation.html
45#[derive(Debug, Default, Clone)]
46pub struct Zookeeper {
47    /// (remove if there is another variable)
48    /// Field is included to prevent this struct to be a unit struct.
49    /// This allows extending functionality (and thus further variables) without breaking changes
50    _priv: (),
51}
52
53impl Image for Zookeeper {
54    fn name(&self) -> &str {
55        NAME
56    }
57
58    fn tag(&self) -> &str {
59        TAG
60    }
61
62    fn ready_conditions(&self) -> Vec<WaitFor> {
63        vec![
64            WaitFor::message_on_stdout("Started AdminServer"),
65            WaitFor::message_on_stdout("PrepRequestProcessor (sid:0) started"),
66        ]
67    }
68
69    fn env_vars(
70        &self,
71    ) -> impl IntoIterator<Item = (impl Into<Cow<'_, str>>, impl Into<Cow<'_, str>>)> {
72        [("ALLOW_ANONYMOUS_LOGIN", "yes")]
73    }
74}
75
76#[cfg(test)]
77mod tests {
78    use futures::StreamExt;
79    use rustls::crypto::CryptoProvider;
80    use tokio::net::lookup_host;
81    use tokio_zookeeper::*;
82
83    use crate::{testcontainers::runners::AsyncRunner, zookeeper::Zookeeper as ZookeeperImage};
84
85    #[tokio::test]
86    async fn zookeeper_check_directories_existence(
87    ) -> Result<(), Box<dyn std::error::Error + 'static>> {
88        let _ = pretty_env_logger::try_init();
89        if CryptoProvider::get_default().is_none() {
90            rustls::crypto::ring::default_provider()
91                .install_default()
92                .expect("Error initializing rustls provider");
93        }
94
95        let node = ZookeeperImage::default().start().await?;
96
97        let host = node.get_host().await?;
98        let host_port = node.get_host_port_ipv4(2181).await?;
99        let zk_url = format!("{host}:{host_port}");
100        let zk_socket_addr = lookup_host(&zk_url).await?.next().unwrap();
101
102        let (zk, mut default_watcher) = ZooKeeper::connect(&zk_socket_addr).await.unwrap();
103
104        let path = "/test";
105        let _stat = zk.watch().exists(path).await.expect("stat requested");
106
107        let path = zk
108            .create(path, &[1, 2], Acl::open_unsafe(), CreateMode::Ephemeral)
109            .await?
110            .expect("create a node");
111
112        let event = default_watcher.next().await.expect("event received");
113        assert_eq!(event.event_type, WatchedEventType::NodeCreated);
114        assert_eq!(event.path, path);
115        Ok(())
116    }
117}
testcontainers_modules/zookeeper/mod.rs

testcontainers_modules/zookeeper/
mod.rs
