Use testcontainers to run postgres database. Disable shutdown tests d…

…ue to interfering tests (global var impl). (#709)

* Use testcontainers to run postgres database. Disable shutdown tests due to interferencing tests (global var impl).

* Removed shutdown test. Refactored running testcontainers for db testing.

Cargo.toml

@@ -93,6 +93,8 @@ semaphore = { git = "https://github.com/worldcoin/semaphore-rs", branch = "main"
 ] }
 similar-asserts = "1.5.0"
 test-case = "3.0"
+testcontainers = "0.15.0"
+testcontainers-modules = {  version = "0.3.7", features = ["postgres"] }
 tracing-subscriber = "0.3.11"
 tracing-test = "0.2"
 

crates/postgres-docker-utils/Cargo.toml

@@ -8,3 +8,5 @@ publish = false
 anyhow = "1.0"
 test-case = "3.1.0"
 tokio = { version = "1.0", features = ["full"] }
+testcontainers = "0.15.0"
+testcontainers-modules = {  version = "0.3.7", features = ["postgres"] }

crates/postgres-docker-utils/src/lib.rs

@@ -1,112 +1,24 @@
-use std::net::SocketAddr;
-use std::process::{Command, Stdio};
-use std::time::Duration;
+use testcontainers::clients::Cli;
+use testcontainers::{Container, RunnableImage};
+use testcontainers_modules::postgres::Postgres;
 
-use anyhow::Context;
-
-pub struct DockerContainerGuard {
-    container_id: String,
-    socket_addr:  SocketAddr,
+pub struct DockerContainer<'a> {
+    container: Container<'a, Postgres>,
 }
 
-impl DockerContainerGuard {
-    pub fn socket_addr(&self) -> SocketAddr {
-        self.socket_addr
+impl<'a> DockerContainer<'a> {
+    fn new(docker: &'a Cli) -> Self {
+        let image =
+            RunnableImage::from(Postgres::default().with_host_auth()).with_tag("16.2-alpine");
+        let container = docker.run(image);
+        DockerContainer { container }
     }
 
     pub fn address(&self) -> String {
-        self.socket_addr.to_string()
+        format!("127.0.0.1:{}", self.container.get_host_port_ipv4(5432))
     }
 }
 
-impl Drop for DockerContainerGuard {
-    fn drop(&mut self) {
-        if let Err(err) = run_cmd(&format!("docker stop {}", &self.container_id)) {
-            eprintln!("Failed to stop docker container: {}", err);
-        }
-
-        // Redundant, but better safe than sorry
-        if let Err(err) = run_cmd(&format!("docker rm {}", &self.container_id)) {
-            eprintln!("Failed to remove docker container: {}", err);
-        }
-    }
-}
-
-/// Starts a postgres docker container that will accept all connections with a
-/// random port assigned by the os or docker. The container will be stopped and
-/// removed when the guard is dropped.
-///
-/// Note that we're using sync code here so we'll block the executor - but this
-/// is fine, because the spawned container will still run in the background.
-pub async fn setup() -> anyhow::Result<DockerContainerGuard> {
-    let container_id =
-        run_cmd_to_output("docker run --rm -d -e POSTGRES_HOST_AUTH_METHOD=trust -p 5432 postgres")
-            .context("Starting the Postgres container")?;
-
-    let exposed_port = run_cmd_to_output(&format!("docker container port {container_id} 5432"))
-        .context("Fetching container exposed port")?;
-    let socket_addr = parse_exposed_port(&exposed_port)?;
-
-    std::thread::sleep(Duration::from_secs_f32(2.0));
-
-    Ok(DockerContainerGuard {
-        container_id,
-        socket_addr,
-    })
-}
-
-fn run_cmd_to_output(cmd_str: &str) -> anyhow::Result<String> {
-    let args: Vec<_> = cmd_str.split(' ').collect();
-    let mut command = Command::new(args[0]);
-
-    for arg in &args[1..] {
-        command.arg(arg);
-    }
-
-    command.stdout(Stdio::piped());
-    command.stderr(Stdio::null());
-
-    let Ok(output) = command.output() else {
-        return Ok(String::new());
-    };
-
-    let utf = String::from_utf8(output.stdout)?;
-
-    Ok(utf.trim().to_string())
-}
-
-fn run_cmd(cmd_str: &str) -> anyhow::Result<()> {
-    run_cmd_to_output(cmd_str)?;
-
-    Ok(())
-}
-
-fn parse_exposed_port(s: &str) -> anyhow::Result<SocketAddr> {
-    let parts: Vec<_> = s
-        .split_whitespace()
-        .map(|s| s.trim())
-        .filter(|s| !s.is_empty())
-        .collect();
-
-    Ok(parts
-        .iter()
-        .map(|p| p.parse::<SocketAddr>())
-        .next()
-        .context("Missing exposed port, is your docker daemon running?")??)
-}
-
-#[cfg(test)]
-mod tests {
-    use test_case::test_case;
-
-    use super::*;
-
-    #[test_case("0.0.0.0:55837" => 55837 ; "base case")]
-    #[test_case("   0.0.0.0:55837    " => 55837 ; "ignore whitespace")]
-    #[test_case("[::]:12345" => 12345 ; "works with ipv6")]
-    #[test_case("0.0.0.0:12345 \n [::]:12345" => 12345 ; "works with multiple ips")]
-    #[test_case("0.0.0.0:12345 \n [::]:54321" => 12345 ; "yields first of multiple ips")]
-    fn test_parse_exposed_port(s: &str) -> u16 {
-        parse_exposed_port(s).unwrap().port()
-    }
+pub async fn setup(docker: &Cli) -> anyhow::Result<DockerContainer> {
+    Ok(DockerContainer::new(docker))
 }