docker-wrapper 0.11.1

A Docker CLI wrapper 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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
//! Reusable test fixtures for common services
//!
//! This example shows how to create reusable fixtures for testing with
//! databases, caches, and other services using docker-wrapper.
//!
//! Note: This is a conceptual example. Actual implementation may vary.

#[allow(unused_imports)]
use docker_wrapper::{
    DockerCommand, ExecCommand, NetworkCreateCommand, NetworkRmCommand, RmCommand, RunCommand,
    StopCommand,
};
#[allow(unused_imports)]
use std::time::{Duration, Instant};
#[allow(unused_imports)]
use tokio::net::TcpStream;

/// Helper to generate unique names for parallel test safety
fn unique_name(prefix: &str) -> String {
    format!("{}-{}", prefix, uuid::Uuid::new_v4())
}

/// Wait for a port to become available
async fn wait_for_port(host: &str, port: u16, timeout: Duration) -> Result<(), String> {
    let start = Instant::now();

    while start.elapsed() < timeout {
        if TcpStream::connect(format!("{}:{}", host, port))
            .await
            .is_ok()
        {
            return Ok(());
        }
        tokio::time::sleep(Duration::from_millis(100)).await;
    }

    Err(format!(
        "Port {}:{} not ready after {:?}",
        host, port, timeout
    ))
}

/// Redis test fixture
pub struct RedisFixture {
    container_name: String,
    port: u16,
    password: Option<String>,
}

impl RedisFixture {
    /// Create a new Redis fixture with defaults
    pub async fn new() -> Result<Self, Box<dyn std::error::Error>> {
        Self::with_config(6379, None).await
    }

    /// Create a Redis fixture with custom configuration
    pub async fn with_config(
        port: u16,
        password: Option<String>,
    ) -> Result<Self, Box<dyn std::error::Error>> {
        let container_name = unique_name("redis");

        let mut cmd = RunCommand::new("redis:7-alpine")
            .name(&container_name)
            .port(port, 6379)
            .detach()
            .remove();

        if let Some(ref pwd) = password {
            cmd = cmd.cmd(vec![
                "redis-server".to_string(),
                "--requirepass".to_string(),
                pwd.to_string(),
            ]);
        }

        cmd.execute().await?;

        // Wait for Redis to be ready
        wait_for_port("localhost", port, Duration::from_secs(5)).await?;

        Ok(Self {
            container_name,
            port,
            password,
        })
    }

    /// Get the Redis connection string
    pub fn connection_string(&self) -> String {
        match &self.password {
            Some(pwd) => format!("redis://:{}@localhost:{}", pwd, self.port),
            None => format!("redis://localhost:{}", self.port),
        }
    }

    /// Execute a Redis command
    pub async fn exec(&self, args: Vec<&str>) -> Result<String, Box<dyn std::error::Error>> {
        let mut cmd_args = vec!["redis-cli"];

        if let Some(ref pwd) = self.password {
            cmd_args.push("-a");
            cmd_args.push(pwd);
        }

        cmd_args.extend(args);

        let cmd_args_strings: Vec<String> = cmd_args.into_iter().map(|s| s.to_string()).collect();
        let output = ExecCommand::new(&self.container_name, cmd_args_strings)
            .execute()
            .await?;

        Ok(output.stdout)
    }

    /// Clean up the Redis container
    pub async fn cleanup(self) -> Result<(), Box<dyn std::error::Error>> {
        StopCommand::new(&self.container_name).execute().await?;
        Ok(())
    }
}

/// PostgreSQL test fixture
pub struct PostgresFixture {
    container_name: String,
    database: String,
    username: String,
    password: String,
    port: u16,
}

impl PostgresFixture {
    /// Create a new PostgreSQL fixture with defaults
    pub async fn new() -> Result<Self, Box<dyn std::error::Error>> {
        Self::with_config("testdb", "testuser", "testpass", 5432).await
    }

    /// Create a PostgreSQL fixture with custom configuration
    pub async fn with_config(
        database: &str,
        username: &str,
        password: &str,
        port: u16,
    ) -> Result<Self, Box<dyn std::error::Error>> {
        let container_name = unique_name("postgres");

        // Use dynamic host port mapping to avoid collisions on common ports (e.g., 5432)
        let cid = RunCommand::new("postgres:15-alpine")
            .name(&container_name)
            .env("POSTGRES_DB", database)
            .env("POSTGRES_USER", username)
            .env("POSTGRES_PASSWORD", password)
            .port_dyn(5432)
            .detach()
            .remove()
            .execute()
            .await?;

        // Determine mapped host port so we can probe from the host
        let mapped_ports = cid.port_mappings().await?;
        let host_port = mapped_ports.first().map(|m| m.host_port).unwrap_or(port);

        // Wait for PostgreSQL to be ready on the host-mapped port
        wait_for_port("localhost", host_port, Duration::from_secs(10)).await?;

        // Additional wait for PostgreSQL initialization
        tokio::time::sleep(Duration::from_secs(2)).await;

        // Probe PostgreSQL with psql until it accepts connections
        let mut ready = false;
        for _ in 0..30 {
            let probe = ExecCommand::new(
                &container_name,
                vec![
                    "psql".to_string(),
                    "-U".to_string(),
                    username.to_string(),
                    "-d".to_string(),
                    database.to_string(),
                    "-c".to_string(),
                    "SELECT 1".to_string(),
                ],
            )
            .env("PGPASSWORD", password)
            .execute()
            .await;

            if let Ok(out) = probe {
                if out.exit_code == 0 {
                    ready = true;
                    break;
                }
            }

            tokio::time::sleep(Duration::from_secs(1)).await;
        }

        if !ready {
            return Err(format!(
                "PostgreSQL in container {} did not become ready in time",
                container_name
            )
            .into());
        }

        Ok(Self {
            container_name,
            database: database.to_string(),
            username: username.to_string(),
            password: password.to_string(),
            port: host_port,
        })
    }

    /// Get the PostgreSQL connection string
    pub fn connection_string(&self) -> String {
        format!(
            "postgresql://{}:{}@localhost:{}/{}",
            self.username, self.password, self.port, self.database
        )
    }

    /// Execute a SQL query
    pub async fn exec_sql(&self, sql: &str) -> Result<String, Box<dyn std::error::Error>> {
        let output = ExecCommand::new(
            &self.container_name,
            vec![
                "psql".to_string(),
                "-U".to_string(),
                self.username.clone(),
                "-d".to_string(),
                self.database.clone(),
                "-c".to_string(),
                sql.to_string(),
            ],
        )
        .env("PGPASSWORD", &self.password)
        .execute()
        .await?;

        Ok(output.stdout)
    }

    /// Clean up the PostgreSQL container
    pub async fn cleanup(self) -> Result<(), Box<dyn std::error::Error>> {
        StopCommand::new(&self.container_name).execute().await?;
        Ok(())
    }
}

/// MongoDB test fixture
pub struct MongoFixture {
    container_name: String,
    port: u16,
    username: Option<String>,
    password: Option<String>,
}

impl MongoFixture {
    /// Create a new MongoDB fixture without authentication
    pub async fn new() -> Result<Self, Box<dyn std::error::Error>> {
        Self::with_auth(None, None, 27017).await
    }

    /// Create a MongoDB fixture with authentication
    pub async fn with_auth(
        username: Option<&str>,
        password: Option<&str>,
        port: u16,
    ) -> Result<Self, Box<dyn std::error::Error>> {
        let container_name = unique_name("mongo");

        let mut cmd = RunCommand::new("mongo:6")
            .name(&container_name)
            .port(port, 27017)
            .detach()
            .remove();

        if let (Some(user), Some(pwd)) = (username, password) {
            cmd = cmd
                .env("MONGO_INITDB_ROOT_USERNAME", user)
                .env("MONGO_INITDB_ROOT_PASSWORD", pwd);
        }

        cmd.execute().await?;

        // Wait for MongoDB to be ready
        wait_for_port("localhost", port, Duration::from_secs(10)).await?;

        Ok(Self {
            container_name,
            port,
            username: username.map(String::from),
            password: password.map(String::from),
        })
    }

    /// Get the MongoDB connection string
    pub fn connection_string(&self) -> String {
        match (&self.username, &self.password) {
            (Some(user), Some(pwd)) => {
                format!("mongodb://{}:{}@localhost:{}", user, pwd, self.port)
            }
            _ => format!("mongodb://localhost:{}", self.port),
        }
    }

    /// Clean up the MongoDB container
    pub async fn cleanup(self) -> Result<(), Box<dyn std::error::Error>> {
        StopCommand::new(&self.container_name).execute().await?;
        Ok(())
    }
}

/// Multi-service test environment
pub struct TestEnvironment {
    network_name: String,
    containers: Vec<String>,
}

impl TestEnvironment {
    /// Create a new test environment with isolated network
    pub async fn new() -> Result<Self, Box<dyn std::error::Error>> {
        let network_name = unique_name("test-net");

        NetworkCreateCommand::new(&network_name).execute().await?;

        Ok(Self {
            network_name,
            containers: Vec::new(),
        })
    }

    /// Add a Redis service to the environment
    pub async fn with_redis(&mut self) -> Result<String, Box<dyn std::error::Error>> {
        let container_name = unique_name("env-redis");

        RunCommand::new("redis:7-alpine")
            .name(&container_name)
            .network(&self.network_name)
            .detach()
            .remove()
            .execute()
            .await?;

        self.containers.push(container_name.clone());
        Ok(container_name)
    }

    /// Add a PostgreSQL service to the environment
    pub async fn with_postgres(&mut self) -> Result<String, Box<dyn std::error::Error>> {
        let container_name = unique_name("env-postgres");

        RunCommand::new("postgres:15-alpine")
            .name(&container_name)
            .network(&self.network_name)
            .env("POSTGRES_PASSWORD", "test")
            .detach()
            .remove()
            .execute()
            .await?;

        self.containers.push(container_name.clone());
        Ok(container_name)
    }

    /// Get the network name for connecting additional containers
    pub fn network(&self) -> &str {
        &self.network_name
    }

    /// Clean up all containers and the network
    pub async fn cleanup(self) -> Result<(), Box<dyn std::error::Error>> {
        // Stop all containers
        for container in &self.containers {
            let _ = StopCommand::new(container).execute().await;
        }

        // Remove network
        NetworkRmCommand::new(&self.network_name).execute().await?;

        Ok(())
    }
}

// Example tests using the fixtures
#[cfg(test)]
mod tests {
    use super::*;

    #[tokio::test]
    async fn test_with_redis_fixture() {
        let redis = RedisFixture::new()
            .await
            .expect("Failed to create Redis fixture");

        // Use the Redis connection string
        println!("Redis URL: {}", redis.connection_string());

        // Execute Redis commands
        let result = redis
            .exec(vec!["PING"])
            .await
            .expect("Failed to ping Redis");
        assert!(result.contains("PONG"));

        // Set and get a value
        redis
            .exec(vec!["SET", "test_key", "test_value"])
            .await
            .expect("Failed to set value");

        let value = redis
            .exec(vec!["GET", "test_key"])
            .await
            .expect("Failed to get value");
        assert!(value.contains("test_value"));

        redis.cleanup().await.expect("Failed to cleanup Redis");
    }

    #[tokio::test]
    async fn test_with_postgres_fixture() {
        let postgres = PostgresFixture::new()
            .await
            .expect("Failed to create PostgreSQL fixture");

        // Create a table
        postgres
            .exec_sql("CREATE TABLE users (id SERIAL PRIMARY KEY, name VARCHAR(100))")
            .await
            .expect("Failed to create table");

        // Insert data
        postgres
            .exec_sql("INSERT INTO users (name) VALUES ('Alice'), ('Bob')")
            .await
            .expect("Failed to insert data");

        // Query data
        let result = postgres
            .exec_sql("SELECT COUNT(*) FROM users")
            .await
            .expect("Failed to query data");

        assert!(result.contains("2"));

        postgres
            .cleanup()
            .await
            .expect("Failed to cleanup PostgreSQL");
    }

    #[tokio::test]
    async fn test_with_environment() {
        let mut env = TestEnvironment::new()
            .await
            .expect("Failed to create test environment");

        // Add services
        let redis_name = env.with_redis().await.expect("Failed to add Redis");
        let postgres_name = env.with_postgres().await.expect("Failed to add PostgreSQL");

        println!("Started Redis: {}", redis_name);
        println!("Started PostgreSQL: {}", postgres_name);
        println!("Network: {}", env.network());

        // Services can communicate via container names on the test network
        // Your application can connect to these services

        env.cleanup().await.expect("Failed to cleanup environment");
    }
}

fn main() {
    println!("Test Fixtures Example");
    println!("====================");
    println!();
    println!("This example demonstrates reusable test fixtures for:");
    println!("- Redis");
    println!("- PostgreSQL");
    println!("- MongoDB");
    println!("- Multi-service environments");
    println!();
    println!("This is a conceptual example showing test fixture patterns.");
    println!("Implementation details may need adjustment for your specific use case.");
    println!();
    println!("See the source code for fixture patterns.");
}