-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathtesting.rs
More file actions
1056 lines (965 loc) · 34.4 KB
/
testing.rs
File metadata and controls
1056 lines (965 loc) · 34.4 KB
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
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//! Testing utilities for container lifecycle management.
//!
//! This module provides [`ContainerGuard`], an RAII wrapper that automatically
//! manages container lifecycle. When the guard goes out of scope, containers
//! are stopped and removed automatically.
//!
//! # Example
//!
//! ```rust,no_run
//! use docker_wrapper::testing::ContainerGuard;
//! use docker_wrapper::RedisTemplate;
//!
//! #[tokio::test]
//! async fn test_redis() -> Result<(), Box<dyn std::error::Error>> {
//! let guard = ContainerGuard::new(RedisTemplate::new("test-redis"))
//! .start()
//! .await?;
//!
//! // Use the container...
//! let url = guard.template().connection_url();
//!
//! Ok(())
//! // Container automatically stopped and removed here
//! }
//! ```
use crate::command::DockerCommand;
use crate::template::{Template, TemplateError};
use crate::{
LogsCommand, NetworkCreateCommand, NetworkRmCommand, PortCommand, RmCommand, StopCommand,
};
use std::collections::HashMap;
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::Arc;
use std::time::Duration;
/// Options for controlling container lifecycle behavior.
#[derive(Debug, Clone)]
#[allow(clippy::struct_excessive_bools)]
pub struct GuardOptions {
/// Remove container on drop (default: true)
pub remove_on_drop: bool,
/// Stop container on drop (default: true)
pub stop_on_drop: bool,
/// Keep container running if test panics (default: false)
pub keep_on_panic: bool,
/// Capture container logs and print on panic (default: false)
pub capture_logs: bool,
/// Reuse existing container if already running (default: false)
pub reuse_if_running: bool,
/// Automatically wait for container to be ready after start (default: false)
pub wait_for_ready: bool,
/// Network to attach the container to (default: None)
pub network: Option<String>,
/// Create the network if it doesn't exist (default: true when network is set)
pub create_network: bool,
/// Remove the network on drop (default: false)
pub remove_network_on_drop: bool,
/// Timeout for stop operations during cleanup (default: None, uses Docker default)
pub stop_timeout: Option<Duration>,
}
impl Default for GuardOptions {
fn default() -> Self {
Self {
remove_on_drop: true,
stop_on_drop: true,
keep_on_panic: false,
capture_logs: false,
reuse_if_running: false,
wait_for_ready: false,
network: None,
create_network: true,
remove_network_on_drop: false,
stop_timeout: None,
}
}
}
/// Builder for creating a [`ContainerGuard`] with custom options.
pub struct ContainerGuardBuilder<T: Template> {
template: T,
options: GuardOptions,
}
impl<T: Template> ContainerGuardBuilder<T> {
/// Create a new builder with the given template.
#[must_use]
pub fn new(template: T) -> Self {
Self {
template,
options: GuardOptions::default(),
}
}
/// Set whether to remove the container on drop (default: true).
#[must_use]
pub fn remove_on_drop(mut self, remove: bool) -> Self {
self.options.remove_on_drop = remove;
self
}
/// Set whether to stop the container on drop (default: true).
#[must_use]
pub fn stop_on_drop(mut self, stop: bool) -> Self {
self.options.stop_on_drop = stop;
self
}
/// Set whether to keep the container running if the test panics (default: false).
///
/// This is useful for debugging failed tests - you can inspect the container
/// state after the test fails.
#[must_use]
pub fn keep_on_panic(mut self, keep: bool) -> Self {
self.options.keep_on_panic = keep;
self
}
/// Set whether to capture container logs and print them on panic (default: false).
///
/// When enabled, container logs are buffered and printed to stderr if the
/// test panics, making it easier to debug failures.
#[must_use]
pub fn capture_logs(mut self, capture: bool) -> Self {
self.options.capture_logs = capture;
self
}
/// Set whether to reuse an existing container if already running (default: false).
///
/// This is useful for faster local development iteration - containers can
/// be kept running between test runs.
#[must_use]
pub fn reuse_if_running(mut self, reuse: bool) -> Self {
self.options.reuse_if_running = reuse;
self
}
/// Set whether to automatically wait for the container to be ready after starting (default: false).
///
/// When enabled, `start()` will not return until the container passes its
/// readiness check. This is useful for tests that need to immediately connect
/// to the service.
///
/// # Example
///
/// ```rust,no_run
/// # use docker_wrapper::testing::ContainerGuard;
/// # use docker_wrapper::RedisTemplate;
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let guard = ContainerGuard::new(RedisTemplate::new("test"))
/// .wait_for_ready(true)
/// .start()
/// .await?;
/// // Container is guaranteed ready at this point
/// # Ok(())
/// # }
/// ```
#[must_use]
pub fn wait_for_ready(mut self, wait: bool) -> Self {
self.options.wait_for_ready = wait;
self
}
/// Attach the container to a Docker network.
///
/// By default, the network will be created if it doesn't exist. Use
/// `create_network(false)` to disable automatic network creation.
///
/// # Example
///
/// ```rust,no_run
/// # use docker_wrapper::testing::ContainerGuard;
/// # use docker_wrapper::RedisTemplate;
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let guard = ContainerGuard::new(RedisTemplate::new("redis"))
/// .with_network("test-network")
/// .start()
/// .await?;
/// // Container is attached to "test-network"
/// # Ok(())
/// # }
/// ```
#[must_use]
pub fn with_network(mut self, network: impl Into<String>) -> Self {
self.options.network = Some(network.into());
self
}
/// Set whether to create the network if it doesn't exist (default: true).
///
/// Only applies when a network is specified via `with_network()`.
#[must_use]
pub fn create_network(mut self, create: bool) -> Self {
self.options.create_network = create;
self
}
/// Set whether to remove the network on drop (default: false).
///
/// This is useful for cleaning up test-specific networks. Only applies
/// when a network is specified via `with_network()`.
///
/// Note: The network removal will fail silently if other containers are
/// still using it.
#[must_use]
pub fn remove_network_on_drop(mut self, remove: bool) -> Self {
self.options.remove_network_on_drop = remove;
self
}
/// Set the timeout for stop operations during cleanup (default: Docker default).
///
/// This controls how long Docker waits for the container to stop gracefully
/// before sending SIGKILL.
///
/// # Example
///
/// ```rust,no_run
/// # use docker_wrapper::testing::ContainerGuard;
/// # use docker_wrapper::RedisTemplate;
/// # use std::time::Duration;
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// // Fast cleanup with 1 second timeout
/// let guard = ContainerGuard::new(RedisTemplate::new("redis"))
/// .stop_timeout(Duration::from_secs(1))
/// .start()
/// .await?;
///
/// // Immediate SIGKILL with zero timeout
/// let guard = ContainerGuard::new(RedisTemplate::new("redis2"))
/// .stop_timeout(Duration::ZERO)
/// .start()
/// .await?;
/// # Ok(())
/// # }
/// ```
#[must_use]
pub fn stop_timeout(mut self, timeout: Duration) -> Self {
self.options.stop_timeout = Some(timeout);
self
}
/// Start the container and return a guard that manages its lifecycle.
///
/// If `reuse_if_running` is enabled and a container is already running,
/// it will be reused instead of starting a new one.
///
/// If `wait_for_ready` is enabled, this method will block until the
/// container passes its readiness check.
///
/// If a network is specified via `with_network()`, the container will be
/// attached to that network. The network will be created if it doesn't
/// exist (unless `create_network(false)` was called).
///
/// # Errors
///
/// Returns an error if the container fails to start or the readiness check times out.
pub async fn start(mut self) -> Result<ContainerGuard<T>, TemplateError> {
let wait_for_ready = self.options.wait_for_ready;
let mut network_created = false;
// Create network if specified and create_network is enabled
if let Some(ref network) = self.options.network {
if self.options.create_network {
// Try to create the network (ignore errors if it already exists)
let result = NetworkCreateCommand::new(network)
.driver("bridge")
.execute()
.await;
// Track if we successfully created it (for cleanup purposes)
network_created = result.is_ok();
}
// Set the network on the template
self.template.config_mut().network = Some(network.clone());
}
// Check if we should reuse an existing container
if self.options.reuse_if_running {
if let Ok(true) = self.template.is_running().await {
let guard = ContainerGuard {
template: self.template,
container_id: None, // We don't have the ID for reused containers
options: self.options,
was_reused: true,
network_created,
cleaned_up: Arc::new(AtomicBool::new(false)),
};
// Wait for ready if configured (even for reused containers)
if wait_for_ready {
guard.wait_for_ready().await?;
}
return Ok(guard);
}
}
// Start the container
let container_id = self.template.start_and_wait().await?;
let guard = ContainerGuard {
template: self.template,
container_id: Some(container_id),
options: self.options,
was_reused: false,
network_created,
cleaned_up: Arc::new(AtomicBool::new(false)),
};
// Wait for ready if configured
if wait_for_ready {
guard.wait_for_ready().await?;
}
Ok(guard)
}
}
/// RAII guard for automatic container lifecycle management.
///
/// When this guard is dropped, the container is automatically stopped and
/// removed (unless configured otherwise via [`ContainerGuardBuilder`]).
///
/// # Example
///
/// ```rust,no_run
/// use docker_wrapper::testing::ContainerGuard;
/// use docker_wrapper::RedisTemplate;
///
/// #[tokio::test]
/// async fn test_example() -> Result<(), Box<dyn std::error::Error>> {
/// let guard = ContainerGuard::new(RedisTemplate::new("test"))
/// .keep_on_panic(true) // Keep container for debugging if test fails
/// .capture_logs(true) // Print logs on failure
/// .start()
/// .await?;
///
/// // Container is automatically cleaned up when guard goes out of scope
/// Ok(())
/// }
/// ```
pub struct ContainerGuard<T: Template> {
template: T,
container_id: Option<String>,
options: GuardOptions,
was_reused: bool,
network_created: bool,
cleaned_up: Arc<AtomicBool>,
}
impl<T: Template> ContainerGuard<T> {
/// Create a new builder for a container guard.
///
/// Note: This returns a builder, not a `ContainerGuard`. Call `.start().await`
/// on the builder to create the guard.
#[allow(clippy::new_ret_no_self)]
pub fn new(template: T) -> ContainerGuardBuilder<T> {
ContainerGuardBuilder::new(template)
}
/// Get a reference to the underlying template.
#[must_use]
pub fn template(&self) -> &T {
&self.template
}
/// Get the container ID, if available.
///
/// This may be `None` if the container was reused from a previous run.
#[must_use]
pub fn container_id(&self) -> Option<&str> {
self.container_id.as_deref()
}
/// Check if this guard is reusing an existing container.
#[must_use]
pub fn was_reused(&self) -> bool {
self.was_reused
}
/// Get the network name, if one was configured.
#[must_use]
pub fn network(&self) -> Option<&str> {
self.options.network.as_deref()
}
/// Check if the container is currently running.
///
/// # Errors
///
/// Returns an error if the Docker command fails.
pub async fn is_running(&self) -> Result<bool, TemplateError> {
self.template.is_running().await
}
/// Wait for the container to be ready.
///
/// This calls the underlying template's readiness check. The exact behavior
/// depends on the template implementation - for example, Redis templates
/// wait for a successful PING response.
///
/// # Errors
///
/// Returns an error if the readiness check times out or the Docker command fails.
///
/// # Example
///
/// ```rust,no_run
/// # use docker_wrapper::testing::ContainerGuard;
/// # use docker_wrapper::RedisTemplate;
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let guard = ContainerGuard::new(RedisTemplate::new("test"))
/// .start()
/// .await?;
///
/// // Wait for Redis to be ready to accept connections
/// guard.wait_for_ready().await?;
/// # Ok(())
/// # }
/// ```
pub async fn wait_for_ready(&self) -> Result<(), TemplateError> {
self.template.wait_for_ready().await
}
/// Get the host port mapped to a container port.
///
/// This is useful when using dynamic port allocation - Docker assigns
/// a random available host port which you can query with this method.
///
/// # Errors
///
/// Returns an error if the Docker command fails or no port mapping is found.
///
/// # Example
///
/// ```rust,no_run
/// # use docker_wrapper::testing::ContainerGuard;
/// # use docker_wrapper::RedisTemplate;
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let guard = ContainerGuard::new(RedisTemplate::new("test"))
/// .start()
/// .await?;
///
/// let host_port = guard.host_port(6379).await?;
/// println!("Redis available at localhost:{}", host_port);
/// # Ok(())
/// # }
/// ```
pub async fn host_port(&self, container_port: u16) -> Result<u16, TemplateError> {
let container_name = self.template.config().name.clone();
let result = PortCommand::new(&container_name)
.port(container_port)
.run()
.await
.map_err(TemplateError::DockerError)?;
// Return the first matching port mapping
if let Some(mapping) = result.port_mappings.first() {
return Ok(mapping.host_port);
}
Err(TemplateError::InvalidConfig(format!(
"No host port mapping found for container port {container_port}"
)))
}
/// Get the container logs.
///
/// # Errors
///
/// Returns an error if the Docker command fails.
pub async fn logs(&self) -> Result<String, TemplateError> {
let container_name = self.template.config().name.clone();
let result = LogsCommand::new(&container_name)
.execute()
.await
.map_err(TemplateError::DockerError)?;
Ok(format!("{}{}", result.stdout, result.stderr))
}
/// Manually stop the container.
///
/// The container will still be removed on drop if `remove_on_drop` is enabled.
///
/// # Errors
///
/// Returns an error if the Docker command fails.
pub async fn stop(&self) -> Result<(), TemplateError> {
self.template.stop().await
}
/// Manually clean up the container (stop and remove).
///
/// After calling this, the drop implementation will not attempt cleanup again.
///
/// # Errors
///
/// Returns an error if the Docker commands fail.
pub async fn cleanup(&self) -> Result<(), TemplateError> {
if self.cleaned_up.swap(true, Ordering::SeqCst) {
return Ok(()); // Already cleaned up
}
if self.options.stop_on_drop {
let _ = self.template.stop().await;
}
if self.options.remove_on_drop {
let _ = self.template.remove().await;
}
Ok(())
}
}
impl<T: Template> Drop for ContainerGuard<T> {
fn drop(&mut self) {
// Skip cleanup if already done
if self.cleaned_up.load(Ordering::SeqCst) {
return;
}
// Skip cleanup for reused containers if not configured to clean them
if self.was_reused && !self.options.remove_on_drop {
return;
}
// Check if we're panicking
let panicking = std::thread::panicking();
if panicking && self.options.keep_on_panic {
let name = &self.template.config().name;
eprintln!("[ContainerGuard] Test panicked, keeping container '{name}' for debugging");
if self.options.capture_logs {
// Try to get logs - spawn a thread to avoid runtime conflicts
let container_name = self.template.config().name.clone();
let _ = std::thread::spawn(move || {
if let Ok(rt) = tokio::runtime::Builder::new_current_thread()
.enable_all()
.build()
{
if let Ok(result) =
rt.block_on(async { LogsCommand::new(&container_name).execute().await })
{
let logs = format!("{}{}", result.stdout, result.stderr);
eprintln!("[ContainerGuard] Container logs for '{container_name}':");
eprintln!("{logs}");
}
}
})
.join();
}
return;
}
// Mark as cleaned up
self.cleaned_up.store(true, Ordering::SeqCst);
// Perform cleanup - need to spawn a runtime since Drop isn't async
let should_stop = self.options.stop_on_drop;
let should_remove = self.options.remove_on_drop;
let should_remove_network = self.options.remove_network_on_drop && self.network_created;
let container_name = self.template.config().name.clone();
let network_name = self.options.network.clone();
let stop_timeout = self.options.stop_timeout;
if !should_stop && !should_remove && !should_remove_network {
return;
}
// Perform cleanup - try to use existing runtime if available,
// otherwise create a new one (for non-async contexts)
if tokio::runtime::Handle::try_current().is_ok() {
// We're in an async context - use spawn_blocking to avoid blocking the runtime
let container_name_clone = container_name.clone();
let network_name_clone = network_name.clone();
let _ = std::thread::spawn(move || {
let rt = tokio::runtime::Builder::new_current_thread()
.enable_all()
.build()
.expect("Failed to create runtime for cleanup");
rt.block_on(async {
if should_stop {
let mut cmd = StopCommand::new(&container_name_clone);
if let Some(timeout) = stop_timeout {
cmd = cmd.timeout_duration(timeout);
}
let _ = cmd.execute().await;
}
if should_remove {
let _ = RmCommand::new(&container_name_clone).force().run().await;
}
// Remove network after container (network must be empty)
if should_remove_network {
if let Some(ref network) = network_name_clone {
let _ = NetworkRmCommand::new(network).execute().await;
}
}
});
})
.join();
} else {
// Not in an async context - create a new runtime
if let Ok(rt) = tokio::runtime::Builder::new_current_thread()
.enable_all()
.build()
{
rt.block_on(async {
if should_stop {
let mut cmd = StopCommand::new(&container_name);
if let Some(timeout) = stop_timeout {
cmd = cmd.timeout_duration(timeout);
}
let _ = cmd.execute().await;
}
if should_remove {
let _ = RmCommand::new(&container_name).force().run().await;
}
// Remove network after container (network must be empty)
if should_remove_network {
if let Some(ref network) = network_name {
let _ = NetworkRmCommand::new(network).execute().await;
}
}
});
}
}
}
}
/// A type-erased container guard entry for use in `ContainerGuardSet`.
///
/// This allows storing guards with different template types in the same collection.
#[allow(dead_code)]
struct GuardEntry {
/// Container name for lookup
name: String,
/// Cleanup function to stop and remove the container
cleanup_fn: Box<dyn FnOnce() + Send>,
}
/// Options for `ContainerGuardSet`.
#[derive(Debug, Clone, Default)]
#[allow(clippy::struct_excessive_bools)]
pub struct GuardSetOptions {
/// Shared network for all containers
pub network: Option<String>,
/// Create the network if it doesn't exist (default: true)
pub create_network: bool,
/// Remove the network on drop (default: true when network is set)
pub remove_network_on_drop: bool,
/// Keep containers running if test panics (default: false)
pub keep_on_panic: bool,
/// Wait for each container to be ready after starting (default: true)
pub wait_for_ready: bool,
}
impl GuardSetOptions {
fn new() -> Self {
Self {
network: None,
create_network: true,
remove_network_on_drop: true,
keep_on_panic: false,
wait_for_ready: true,
}
}
}
/// A pending template entry waiting to be started.
struct PendingEntry<T: Template + 'static> {
template: T,
}
/// Type-erased pending entry trait.
trait PendingEntryTrait: Send {
/// Get the container name
fn name(&self) -> String;
/// Start the container and return a cleanup function
fn start(
self: Box<Self>,
network: Option<String>,
wait_for_ready: bool,
keep_on_panic: bool,
) -> std::pin::Pin<
Box<dyn std::future::Future<Output = Result<GuardEntry, TemplateError>> + Send>,
>;
}
impl<T: Template + 'static> PendingEntryTrait for PendingEntry<T> {
fn name(&self) -> String {
self.template.config().name.clone()
}
fn start(
self: Box<Self>,
network: Option<String>,
wait_for_ready: bool,
keep_on_panic: bool,
) -> std::pin::Pin<
Box<dyn std::future::Future<Output = Result<GuardEntry, TemplateError>> + Send>,
> {
Box::pin(async move {
let mut template = self.template;
let name = template.config().name.clone();
// Set network if provided
if let Some(ref net) = network {
template.config_mut().network = Some(net.clone());
}
// Start the container
template.start_and_wait().await?;
// Wait for ready if configured
if wait_for_ready {
template.wait_for_ready().await?;
}
// Create cleanup function
let cleanup_name = name.clone();
let cleanup_fn: Box<dyn FnOnce() + Send> = Box::new(move || {
// Check if panicking and should keep
if std::thread::panicking() && keep_on_panic {
eprintln!(
"[ContainerGuardSet] Test panicked, keeping container '{cleanup_name}' for debugging"
);
return;
}
// Perform cleanup in a new runtime
let _ = std::thread::spawn(move || {
if let Ok(rt) = tokio::runtime::Builder::new_current_thread()
.enable_all()
.build()
{
rt.block_on(async {
let _ = StopCommand::new(&cleanup_name).execute().await;
let _ = RmCommand::new(&cleanup_name).force().run().await;
});
}
})
.join();
});
Ok(GuardEntry { name, cleanup_fn })
})
}
}
/// Builder for creating a [`ContainerGuardSet`].
///
/// # Example
///
/// ```rust,no_run
/// use docker_wrapper::testing::ContainerGuardSet;
/// use docker_wrapper::RedisTemplate;
///
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let guards = ContainerGuardSet::new()
/// .with_network("test-network")
/// .add(RedisTemplate::new("redis-1"))
/// .add(RedisTemplate::new("redis-2"))
/// .start_all()
/// .await?;
///
/// // Access by name
/// assert!(guards.contains("redis-1"));
/// # Ok(())
/// # }
/// ```
pub struct ContainerGuardSetBuilder {
entries: Vec<Box<dyn PendingEntryTrait>>,
options: GuardSetOptions,
}
impl ContainerGuardSetBuilder {
/// Create a new builder.
#[must_use]
pub fn new() -> Self {
Self {
entries: Vec::new(),
options: GuardSetOptions::new(),
}
}
/// Add a template to the set.
///
/// The container name from the template's config is used as the key for lookup.
#[allow(clippy::should_implement_trait)]
#[must_use]
pub fn add<T: Template + 'static>(mut self, template: T) -> Self {
self.entries.push(Box::new(PendingEntry { template }));
self
}
/// Set a shared network for all containers.
///
/// The network will be created if it doesn't exist (unless `create_network(false)` is called).
#[must_use]
pub fn with_network(mut self, network: impl Into<String>) -> Self {
self.options.network = Some(network.into());
self
}
/// Set whether to create the network if it doesn't exist (default: true).
#[must_use]
pub fn create_network(mut self, create: bool) -> Self {
self.options.create_network = create;
self
}
/// Set whether to remove the network on drop (default: true when network is set).
#[must_use]
pub fn remove_network_on_drop(mut self, remove: bool) -> Self {
self.options.remove_network_on_drop = remove;
self
}
/// Set whether to keep containers running if the test panics (default: false).
#[must_use]
pub fn keep_on_panic(mut self, keep: bool) -> Self {
self.options.keep_on_panic = keep;
self
}
/// Set whether to wait for each container to be ready (default: true).
#[must_use]
pub fn wait_for_ready(mut self, wait: bool) -> Self {
self.options.wait_for_ready = wait;
self
}
/// Start all containers and return a guard set.
///
/// Containers are started sequentially in the order they were added.
///
/// # Errors
///
/// Returns an error if any container fails to start. Containers that were
/// successfully started before the failure will be cleaned up.
pub async fn start_all(self) -> Result<ContainerGuardSet, TemplateError> {
let mut network_created = false;
// Create network if needed
if let Some(ref network) = self.options.network {
if self.options.create_network {
let result = NetworkCreateCommand::new(network)
.driver("bridge")
.execute()
.await;
network_created = result.is_ok();
}
}
let mut guards: Vec<GuardEntry> = Vec::new();
let mut names: HashMap<String, usize> = HashMap::new();
// Start each container
for entry in self.entries {
let name = entry.name();
match entry
.start(
self.options.network.clone(),
self.options.wait_for_ready,
self.options.keep_on_panic,
)
.await
{
Ok(guard) => {
names.insert(name, guards.len());
guards.push(guard);
}
Err(e) => {
// Clean up already-started containers on failure
for guard in guards {
(guard.cleanup_fn)();
}
// Clean up network if we created it
if network_created {
if let Some(ref network) = self.options.network {
let net = network.clone();
let _ = std::thread::spawn(move || {
if let Ok(rt) = tokio::runtime::Builder::new_current_thread()
.enable_all()
.build()
{
rt.block_on(async {
let _ = NetworkRmCommand::new(&net).execute().await;
});
}
})
.join();
}
}
return Err(e);
}
}
}
Ok(ContainerGuardSet {
guards,
names,
options: self.options,
network_created,
})
}
}
impl Default for ContainerGuardSetBuilder {
fn default() -> Self {
Self::new()
}
}
/// Manages multiple containers as a group with coordinated lifecycle.
///
/// All containers are cleaned up when the set is dropped. This is useful for
/// integration tests that require multiple services.
///
/// # Example
///
/// ```rust,no_run
/// use docker_wrapper::testing::ContainerGuardSet;
/// use docker_wrapper::RedisTemplate;
///
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let guards = ContainerGuardSet::new()
/// .with_network("test-network")
/// .add(RedisTemplate::new("redis"))
/// .keep_on_panic(true)
/// .start_all()
/// .await?;
///
/// // Check if container exists
/// assert!(guards.contains("redis"));
///
/// // Get container names
/// for name in guards.names() {
/// println!("Container: {}", name);
/// }
/// # Ok(())
/// # }
/// ```
pub struct ContainerGuardSet {
guards: Vec<GuardEntry>,
names: HashMap<String, usize>,
options: GuardSetOptions,
network_created: bool,
}
impl ContainerGuardSet {
/// Create a new builder for a container guard set.
#[allow(clippy::new_ret_no_self)]
#[must_use]
pub fn new() -> ContainerGuardSetBuilder {
ContainerGuardSetBuilder::new()
}
/// Check if a container with the given name exists in the set.
#[must_use]
pub fn contains(&self, name: &str) -> bool {
self.names.contains_key(name)
}
/// Get an iterator over container names in the set.
pub fn names(&self) -> impl Iterator<Item = &str> {
self.names.keys().map(String::as_str)
}
/// Get the number of containers in the set.
#[must_use]
pub fn len(&self) -> usize {
self.guards.len()
}
/// Check if the set is empty.
#[must_use]
pub fn is_empty(&self) -> bool {
self.guards.is_empty()
}
/// Get the shared network name, if one was configured.
#[must_use]
pub fn network(&self) -> Option<&str> {
self.options.network.as_deref()
}
}
impl Default for ContainerGuardSet {
fn default() -> Self {
Self {
guards: Vec::new(),
names: HashMap::new(),
options: GuardSetOptions::new(),
network_created: false,