|
| 1 | +//! Docker command wrapper. |
| 2 | +use std::io; |
| 3 | +use std::process::{Command, Output}; |
| 4 | +use std::thread::sleep; |
| 5 | +use std::time::{Duration, Instant}; |
| 6 | + |
| 7 | +use log::debug; |
| 8 | + |
| 9 | +/// Docker command wrapper. |
| 10 | +pub struct Docker {} |
| 11 | + |
| 12 | +pub struct RunningContainer { |
| 13 | + pub name: String, |
| 14 | + pub output: Output, |
| 15 | +} |
| 16 | + |
| 17 | +impl Drop for RunningContainer { |
| 18 | + /// Ensures that the temporary container is stopped and removed when the |
| 19 | + /// struct goes out of scope. |
| 20 | + fn drop(&mut self) { |
| 21 | + let _unused = Docker::stop(self); |
| 22 | + let _unused = Docker::remove(&self.name); |
| 23 | + } |
| 24 | +} |
| 25 | + |
| 26 | +impl Docker { |
| 27 | + /// Builds a Docker image from a given Dockerfile. |
| 28 | + /// |
| 29 | + /// # Errors |
| 30 | + /// |
| 31 | + /// Will fail if the docker build command fails. |
| 32 | + pub fn build(dockerfile: &str, tag: &str) -> io::Result<()> { |
| 33 | + let status = Command::new("docker") |
| 34 | + .args(["build", "-f", dockerfile, "-t", tag, "."]) |
| 35 | + .status()?; |
| 36 | + |
| 37 | + if status.success() { |
| 38 | + Ok(()) |
| 39 | + } else { |
| 40 | + Err(io::Error::new( |
| 41 | + io::ErrorKind::Other, |
| 42 | + format!("Failed to build Docker image from dockerfile {dockerfile}"), |
| 43 | + )) |
| 44 | + } |
| 45 | + } |
| 46 | + |
| 47 | + /// Runs a Docker container from a given image with multiple environment variables. |
| 48 | + /// |
| 49 | + /// # Arguments |
| 50 | + /// |
| 51 | + /// * `image` - The Docker image to run. |
| 52 | + /// * `container` - The name for the Docker container. |
| 53 | + /// * `env_vars` - A slice of tuples, each representing an environment variable as ("KEY", "value"). |
| 54 | + /// |
| 55 | + /// # Errors |
| 56 | + /// |
| 57 | + /// Will fail if the docker run command fails. |
| 58 | + pub fn run(image: &str, container: &str, env_vars: &[(String, String)], ports: &[String]) -> io::Result<RunningContainer> { |
| 59 | + let initial_args = vec![ |
| 60 | + "run".to_string(), |
| 61 | + "--detach".to_string(), |
| 62 | + "--name".to_string(), |
| 63 | + container.to_string(), |
| 64 | + ]; |
| 65 | + |
| 66 | + // Add environment variables |
| 67 | + let mut env_var_args: Vec<String> = vec![]; |
| 68 | + for (key, value) in env_vars { |
| 69 | + env_var_args.push("--env".to_string()); |
| 70 | + env_var_args.push(format!("{key}={value}")); |
| 71 | + } |
| 72 | + |
| 73 | + // Add port mappings |
| 74 | + let mut port_args: Vec<String> = vec![]; |
| 75 | + for port in ports { |
| 76 | + port_args.push("--publish".to_string()); |
| 77 | + port_args.push(port.to_string()); |
| 78 | + } |
| 79 | + |
| 80 | + let args = [initial_args, env_var_args, port_args, [image.to_string()].to_vec()].concat(); |
| 81 | + |
| 82 | + debug!("Docker run args: {:?}", args); |
| 83 | + |
| 84 | + let output = Command::new("docker").args(args).output()?; |
| 85 | + |
| 86 | + if output.status.success() { |
| 87 | + Ok(RunningContainer { |
| 88 | + name: container.to_owned(), |
| 89 | + output, |
| 90 | + }) |
| 91 | + } else { |
| 92 | + Err(io::Error::new( |
| 93 | + io::ErrorKind::Other, |
| 94 | + format!("Failed to run Docker image {image}"), |
| 95 | + )) |
| 96 | + } |
| 97 | + } |
| 98 | + |
| 99 | + /// Stops a Docker container. |
| 100 | + /// |
| 101 | + /// # Errors |
| 102 | + /// |
| 103 | + /// Will fail if the docker stop command fails. |
| 104 | + pub fn stop(container: &RunningContainer) -> io::Result<()> { |
| 105 | + let status = Command::new("docker").args(["stop", &container.name]).status()?; |
| 106 | + |
| 107 | + if status.success() { |
| 108 | + Ok(()) |
| 109 | + } else { |
| 110 | + Err(io::Error::new( |
| 111 | + io::ErrorKind::Other, |
| 112 | + format!("Failed to stop Docker container {}", container.name), |
| 113 | + )) |
| 114 | + } |
| 115 | + } |
| 116 | + |
| 117 | + /// Removes a Docker container. |
| 118 | + /// |
| 119 | + /// # Errors |
| 120 | + /// |
| 121 | + /// Will fail if the docker rm command fails. |
| 122 | + pub fn remove(container: &str) -> io::Result<()> { |
| 123 | + let status = Command::new("docker").args(["rm", "-f", container]).status()?; |
| 124 | + |
| 125 | + if status.success() { |
| 126 | + Ok(()) |
| 127 | + } else { |
| 128 | + Err(io::Error::new( |
| 129 | + io::ErrorKind::Other, |
| 130 | + format!("Failed to remove Docker container {container}"), |
| 131 | + )) |
| 132 | + } |
| 133 | + } |
| 134 | + |
| 135 | + /// Fetches logs from a Docker container. |
| 136 | + /// |
| 137 | + /// # Errors |
| 138 | + /// |
| 139 | + /// Will fail if the docker logs command fails. |
| 140 | + pub fn logs(container: &str) -> io::Result<String> { |
| 141 | + let output = Command::new("docker").args(["logs", container]).output()?; |
| 142 | + |
| 143 | + if output.status.success() { |
| 144 | + Ok(String::from_utf8_lossy(&output.stdout).to_string()) |
| 145 | + } else { |
| 146 | + Err(io::Error::new( |
| 147 | + io::ErrorKind::Other, |
| 148 | + format!("Failed to fetch logs from Docker container {container}"), |
| 149 | + )) |
| 150 | + } |
| 151 | + } |
| 152 | + |
| 153 | + /// Checks if a Docker container is healthy. |
| 154 | + #[must_use] |
| 155 | + pub fn wait_until_is_healthy(name: &str, timeout: Duration) -> bool { |
| 156 | + let start = Instant::now(); |
| 157 | + |
| 158 | + while start.elapsed() < timeout { |
| 159 | + let Ok(output) = Command::new("docker") |
| 160 | + .args(["ps", "-f", &format!("name={name}"), "--format", "{{.Status}}"]) |
| 161 | + .output() |
| 162 | + else { |
| 163 | + return false; |
| 164 | + }; |
| 165 | + |
| 166 | + let output_str = String::from_utf8_lossy(&output.stdout); |
| 167 | + |
| 168 | + if output_str.contains("(healthy)") { |
| 169 | + return true; |
| 170 | + } |
| 171 | + |
| 172 | + sleep(Duration::from_secs(1)); |
| 173 | + } |
| 174 | + |
| 175 | + false |
| 176 | + } |
| 177 | +} |
0 commit comments