tokio-process-tools 0.9.0

Correctness-focused async subprocess orchestration for Tokio: bounded output, multi-consumer streams, output detection, guaranteed cleanup and graceful termination.
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
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
use super::name::{ProcessName, generate_name};
use super::stream_config::{ProcessStreamBuilder, ProcessStreamConfig};
use crate::error::SpawnError;
use crate::output_stream::OutputStream;
use crate::process_handle::ProcessHandle;
use std::marker::PhantomData;

#[doc(hidden)]
pub struct Unnamed;

#[doc(hidden)]
pub struct Named {
    name: ProcessName,
}

#[doc(hidden)]
pub struct Unset;

/// Typestate builder for configuring and spawning a process.
///
/// A process must be named before configuring output streams. This keeps public errors and tracing
/// fields intentional, while stdout and stderr stream configuration remains explicit at the spawn
/// call site.
///
/// # Examples
///
/// ```no_run
/// use tokio_process_tools::*;
/// use tokio_process_tools::SpawnError;
/// use tokio::process::Command;
///
/// # tokio_test::block_on(async {
/// let process = Process::new(Command::new("cargo"))
///     .name("test-runner")
///     .stdout_and_stderr(|stream| {
///         stream
///             .broadcast()
///             .best_effort_delivery()
///             .no_replay()
///             .read_chunk_size(DEFAULT_READ_CHUNK_SIZE)
///             .max_buffered_chunks(DEFAULT_MAX_BUFFERED_CHUNKS)
///     })
///     .spawn()?;
/// # Ok::<_, SpawnError>(())
/// # });
/// ```
pub struct Process<
    NameState = Unnamed,
    StdoutConfig = Unset,
    Stdout = Unset,
    StderrConfig = Unset,
    Stderr = Unset,
> {
    cmd: tokio::process::Command,
    name_state: NameState,
    stdout_config: StdoutConfig,
    stderr_config: StderrConfig,
    _streams: PhantomData<fn() -> (Stdout, Stderr)>,
}

impl Process {
    /// Creates a new process builder from a tokio command.
    #[must_use]
    pub fn new(cmd: tokio::process::Command) -> Self {
        Self {
            cmd,
            name_state: Unnamed,
            stdout_config: Unset,
            stderr_config: Unset,
            _streams: PhantomData,
        }
    }

    /// Sets how the process should be named.
    ///
    /// You can provide either an explicit name or configure automatic name generation.
    /// The name is used in public errors and tracing fields. By default, automatic
    /// naming captures only the program name. Prefer `.name(...)` for stable safe
    /// labels when command arguments or environment variables may contain secrets.
    #[must_use]
    pub fn name(self, name: impl Into<ProcessName>) -> Process<Named> {
        Process {
            cmd: self.cmd,
            name_state: Named { name: name.into() },
            stdout_config: Unset,
            stderr_config: Unset,
            _streams: PhantomData,
        }
    }
}

impl Process<Named> {
    /// Configures stdout and stderr with the same output stream settings.
    #[must_use]
    pub fn stdout_and_stderr<Config, Stream>(
        self,
        configure: impl FnOnce(ProcessStreamBuilder) -> Config,
    ) -> Process<Named, Config, Stream, Config, Stream>
    where
        Config: ProcessStreamConfig<Stream> + Copy,
        Stream: OutputStream,
    {
        let config = configure(ProcessStreamBuilder);
        Process {
            cmd: self.cmd,
            name_state: self.name_state,
            stdout_config: config,
            stderr_config: config,
            _streams: PhantomData,
        }
    }

    /// Configures stdout before configuring stderr.
    #[must_use]
    pub fn stdout<StdoutConfig, Stdout>(
        self,
        configure: impl FnOnce(ProcessStreamBuilder) -> StdoutConfig,
    ) -> Process<Named, StdoutConfig, Stdout>
    where
        StdoutConfig: ProcessStreamConfig<Stdout>,
        Stdout: OutputStream,
    {
        Process {
            cmd: self.cmd,
            name_state: self.name_state,
            stdout_config: configure(ProcessStreamBuilder),
            stderr_config: Unset,
            _streams: PhantomData,
        }
    }

    /// Configures stderr before configuring stdout.
    #[must_use]
    pub fn stderr<StderrConfig, Stderr>(
        self,
        configure: impl FnOnce(ProcessStreamBuilder) -> StderrConfig,
    ) -> Process<Named, Unset, Unset, StderrConfig, Stderr>
    where
        StderrConfig: ProcessStreamConfig<Stderr>,
        Stderr: OutputStream,
    {
        Process {
            cmd: self.cmd,
            name_state: self.name_state,
            stdout_config: Unset,
            stderr_config: configure(ProcessStreamBuilder),
            _streams: PhantomData,
        }
    }
}

impl<StdoutConfig, Stdout> Process<Named, StdoutConfig, Stdout>
where
    Stdout: OutputStream,
{
    /// Configures stderr and completes the process builder.
    #[must_use]
    pub fn stderr<StderrConfig, Stderr>(
        self,
        configure: impl FnOnce(ProcessStreamBuilder) -> StderrConfig,
    ) -> Process<Named, StdoutConfig, Stdout, StderrConfig, Stderr>
    where
        StdoutConfig: ProcessStreamConfig<Stdout>,
        StderrConfig: ProcessStreamConfig<Stderr>,
        Stderr: OutputStream,
    {
        Process {
            cmd: self.cmd,
            name_state: self.name_state,
            stdout_config: self.stdout_config,
            stderr_config: configure(ProcessStreamBuilder),
            _streams: PhantomData,
        }
    }
}

impl<StderrConfig, Stderr> Process<Named, Unset, Unset, StderrConfig, Stderr>
where
    Stderr: OutputStream,
{
    /// Configures stdout and completes the process builder.
    #[must_use]
    pub fn stdout<StdoutConfig, Stdout>(
        self,
        configure: impl FnOnce(ProcessStreamBuilder) -> StdoutConfig,
    ) -> Process<Named, StdoutConfig, Stdout, StderrConfig, Stderr>
    where
        StderrConfig: ProcessStreamConfig<Stderr>,
        StdoutConfig: ProcessStreamConfig<Stdout>,
        Stdout: OutputStream,
    {
        Process {
            cmd: self.cmd,
            name_state: self.name_state,
            stdout_config: configure(ProcessStreamBuilder),
            stderr_config: self.stderr_config,
            _streams: PhantomData,
        }
    }
}

impl<StdoutConfig, Stdout, StderrConfig, Stderr>
    Process<Named, StdoutConfig, Stdout, StderrConfig, Stderr>
where
    Stdout: OutputStream,
    Stderr: OutputStream,
{
    /// Spawns the process with the configured output streams.
    ///
    /// # Errors
    ///
    /// Returns [`SpawnError::SpawnFailed`] if the process cannot be spawned.
    pub fn spawn(self) -> Result<ProcessHandle<Stdout, Stderr>, SpawnError>
    where
        StdoutConfig: ProcessStreamConfig<Stdout>,
        StderrConfig: ProcessStreamConfig<Stderr>,
    {
        let name = generate_name(&self.name_state.name, &self.cmd);
        ProcessHandle::<Stdout, Stderr>::spawn_with_stream_configs(
            name,
            self.cmd,
            self.stdout_config,
            self.stderr_config,
        )
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::output_stream::TrySubscribable;
    use crate::test_support::{ScriptedOutput, line_output_options};
    use crate::{
        AutoName, AutoNameSettings, BestEffortDelivery, DEFAULT_MAX_BUFFERED_CHUNKS,
        DEFAULT_READ_CHUNK_SIZE, NoReplay, NumBytesExt, ProcessHandle, ProcessOutput,
        ReliableDelivery, ReplayEnabled, SingleSubscriberOutputStream,
    };
    use assertr::prelude::*;
    use std::time::Duration;
    use tokio::process::Command;

    async fn assert_successful_completion<Stdout, Stderr>(
        mut process: ProcessHandle<Stdout, Stderr>,
    ) where
        Stdout: TrySubscribable,
        Stderr: TrySubscribable,
    {
        let ProcessOutput {
            status,
            stdout,
            stderr,
        } = process
            .wait_for_completion_with_output(Duration::from_secs(2), line_output_options())
            .await
            .unwrap()
            .expect_completed("process should complete");

        assert_that!(status.success()).is_true();
        assert_that!(stdout.lines().is_empty()).is_false();
        assert_that!(stderr.lines().is_empty()).is_true();
    }

    async fn assert_out_and_err_completion<Stdout, Stderr>(
        mut process: ProcessHandle<Stdout, Stderr>,
    ) where
        Stdout: TrySubscribable,
        Stderr: TrySubscribable,
    {
        let output = process
            .wait_for_completion_with_output(Duration::from_secs(2), line_output_options())
            .await
            .unwrap()
            .expect_completed("process should complete");

        assert_that!(output.status.success()).is_true();
        assert_that!(output.stdout.lines().iter().map(String::as_str)).contains_exactly(["out"]);
        assert_that!(output.stderr.lines().iter().map(String::as_str)).contains_exactly(["err"]);
    }

    mod shared_config {
        use super::*;

        #[tokio::test]
        async fn shared_broadcast_config_applies_to_stdout_and_stderr() {
            let process = Process::new(ScriptedOutput::builder().stdout("out\n").build())
                .name(AutoName::program_only())
                .stdout_and_stderr(|stream| {
                    stream
                        .broadcast()
                        .best_effort_delivery()
                        .replay_last_bytes(1.megabytes())
                        .read_chunk_size(DEFAULT_READ_CHUNK_SIZE)
                        .max_buffered_chunks(DEFAULT_MAX_BUFFERED_CHUNKS)
                })
                .spawn()
                .expect("Failed to spawn");

            assert_that!(process.stdout().read_chunk_size()).is_equal_to(DEFAULT_READ_CHUNK_SIZE);
            assert_that!(process.stdout().max_buffered_chunks())
                .is_equal_to(DEFAULT_MAX_BUFFERED_CHUNKS);
            assert_that!(process.stderr().read_chunk_size()).is_equal_to(DEFAULT_READ_CHUNK_SIZE);
            assert_that!(process.stderr().max_buffered_chunks())
                .is_equal_to(DEFAULT_MAX_BUFFERED_CHUNKS);
            assert_successful_completion(process).await;
        }

        #[tokio::test]
        async fn shared_single_subscriber_config_applies_to_stdout_and_stderr() {
            let process = Process::new(ScriptedOutput::builder().stdout("out\n").build())
                .name(AutoName::program_only())
                .stdout_and_stderr(|stream| {
                    stream
                        .single_subscriber()
                        .best_effort_delivery()
                        .no_replay()
                        .read_chunk_size(DEFAULT_READ_CHUNK_SIZE)
                        .max_buffered_chunks(DEFAULT_MAX_BUFFERED_CHUNKS)
                })
                .spawn()
                .expect("Failed to spawn");

            assert_that!(process.stdout().read_chunk_size()).is_equal_to(DEFAULT_READ_CHUNK_SIZE);
            assert_that!(process.stdout().max_buffered_chunks())
                .is_equal_to(DEFAULT_MAX_BUFFERED_CHUNKS);
            assert_that!(process.stdout().replay_enabled()).is_false();
            assert_that!(process.stderr().read_chunk_size()).is_equal_to(DEFAULT_READ_CHUNK_SIZE);
            assert_that!(process.stderr().max_buffered_chunks())
                .is_equal_to(DEFAULT_MAX_BUFFERED_CHUNKS);
            assert_that!(process.stderr().replay_enabled()).is_false();
            assert_successful_completion(process).await;
        }
    }

    mod split_config {
        use super::*;

        #[tokio::test]
        async fn split_broadcast_config_applies_per_stream() {
            let process = Process::new(ScriptedOutput::builder().stdout("out\n").build())
                .name(AutoName::program_only())
                .stdout(|stdout| {
                    stdout
                        .broadcast()
                        .best_effort_delivery()
                        .replay_last_bytes(1.megabytes())
                        .read_chunk_size(42.kilobytes())
                        .max_buffered_chunks(42)
                })
                .stderr(|stderr| {
                    stderr
                        .broadcast()
                        .best_effort_delivery()
                        .replay_last_bytes(1.megabytes())
                        .read_chunk_size(43.kilobytes())
                        .max_buffered_chunks(43)
                })
                .spawn()
                .expect("Failed to spawn");

            assert_that!(process.stdout().read_chunk_size()).is_equal_to(42.kilobytes());
            assert_that!(process.stdout().max_buffered_chunks()).is_equal_to(42);
            assert_that!(process.stderr().read_chunk_size()).is_equal_to(43.kilobytes());
            assert_that!(process.stderr().max_buffered_chunks()).is_equal_to(43);
            assert_successful_completion(process).await;
        }

        #[tokio::test]
        async fn split_single_subscriber_config_applies_per_stream() {
            let process = Process::new(ScriptedOutput::builder().stdout("out\n").build())
                .name(AutoName::program_only())
                .stdout(|stdout| {
                    stdout
                        .single_subscriber()
                        .best_effort_delivery()
                        .replay_last_bytes(1.megabytes())
                        .read_chunk_size(42.kilobytes())
                        .max_buffered_chunks(42)
                })
                .stderr(|stderr| {
                    stderr
                        .single_subscriber()
                        .best_effort_delivery()
                        .replay_last_bytes(1.megabytes())
                        .read_chunk_size(43.kilobytes())
                        .max_buffered_chunks(43)
                })
                .spawn()
                .expect("Failed to spawn");

            assert_that!(process.stdout().read_chunk_size()).is_equal_to(42.kilobytes());
            assert_that!(process.stdout().max_buffered_chunks()).is_equal_to(42);
            assert_that!(process.stderr().read_chunk_size()).is_equal_to(43.kilobytes());
            assert_that!(process.stderr().max_buffered_chunks()).is_equal_to(43);
            assert_successful_completion(process).await;
        }

        #[tokio::test]
        async fn split_broadcast_config_applies_per_stream_with_dual_outputs() {
            let process = Process::new(
                ScriptedOutput::builder()
                    .stdout("out\n")
                    .stderr("err\n")
                    .build(),
            )
            .name(AutoName::program_only())
            .stdout(|stdout| {
                stdout
                    .broadcast()
                    .reliable_for_active_subscribers()
                    .replay_last_bytes(1.megabytes())
                    .read_chunk_size(21.bytes())
                    .max_buffered_chunks(22)
            })
            .stderr(|stderr| {
                stderr
                    .broadcast()
                    .reliable_for_active_subscribers()
                    .replay_last_bytes(1.megabytes())
                    .read_chunk_size(23.bytes())
                    .max_buffered_chunks(24)
            })
            .spawn()
            .expect("Failed to spawn");

            assert_that!(process.stdout().read_chunk_size()).is_equal_to(21.bytes());
            assert_that!(process.stdout().max_buffered_chunks()).is_equal_to(22);
            assert_that!(process.stderr().read_chunk_size()).is_equal_to(23.bytes());
            assert_that!(process.stderr().max_buffered_chunks()).is_equal_to(24);
            assert_out_and_err_completion(process).await;
        }

        #[tokio::test]
        async fn split_broadcast_replay_can_be_sealed() {
            let process = Process::new(
                ScriptedOutput::builder()
                    .stdout("out\n")
                    .stderr("err\n")
                    .build(),
            )
            .name(AutoName::program_only())
            .stdout(|stdout| {
                stdout
                    .broadcast()
                    .reliable_for_active_subscribers()
                    .replay_last_bytes(1.megabytes())
                    .read_chunk_size(DEFAULT_READ_CHUNK_SIZE)
                    .max_buffered_chunks(DEFAULT_MAX_BUFFERED_CHUNKS)
            })
            .stderr(|stderr| {
                stderr
                    .broadcast()
                    .best_effort_delivery()
                    .replay_last_bytes(1.megabytes())
                    .read_chunk_size(DEFAULT_READ_CHUNK_SIZE)
                    .max_buffered_chunks(DEFAULT_MAX_BUFFERED_CHUNKS)
            })
            .spawn()
            .expect("Failed to spawn");

            assert_that!(process.stdout().is_replay_sealed()).is_false();
            process.seal_stdout_replay();
            assert_that!(process.stdout().is_replay_sealed()).is_true();
            assert_out_and_err_completion(process).await;
        }

        #[tokio::test]
        async fn split_with_broadcast_stdout_and_single_subscriber_stderr_completes() {
            let process = Process::new(
                ScriptedOutput::builder()
                    .stdout("out\n")
                    .stderr("err\n")
                    .build(),
            )
            .name(AutoName::program_only())
            .stdout(|stdout| {
                stdout
                    .broadcast()
                    .reliable_for_active_subscribers()
                    .replay_last_bytes(1.megabytes())
                    .read_chunk_size(DEFAULT_READ_CHUNK_SIZE)
                    .max_buffered_chunks(DEFAULT_MAX_BUFFERED_CHUNKS)
            })
            .stderr(|stderr| {
                stderr
                    .single_subscriber()
                    .best_effort_delivery()
                    .replay_last_bytes(1.megabytes())
                    .read_chunk_size(DEFAULT_READ_CHUNK_SIZE)
                    .max_buffered_chunks(DEFAULT_MAX_BUFFERED_CHUNKS)
            })
            .spawn()
            .expect("Failed to spawn");

            process.seal_stdout_replay();
            assert_that!(process.stdout().is_replay_sealed()).is_true();
            assert_out_and_err_completion(process).await;
        }
    }

    mod single_subscriber_delivery_and_replay {
        use super::*;

        fn assert_single_subscriber_stream_types<StdoutD, StdoutR, StderrD, StderrR>(
            _process: &ProcessHandle<
                SingleSubscriberOutputStream<StdoutD, StdoutR>,
                SingleSubscriberOutputStream<StderrD, StderrR>,
            >,
        ) where
            StdoutD: crate::Delivery,
            StdoutR: crate::Replay,
            StderrD: crate::Delivery,
            StderrR: crate::Replay,
        {
        }

        #[tokio::test]
        async fn split_delivery_modes_can_wait_for_completion() {
            let mut process = Process::new(Command::new("ls"))
                .name(AutoName::program_only())
                .stdout(|stdout| {
                    stdout
                        .single_subscriber()
                        .reliable_for_active_subscribers()
                        .no_replay()
                        .read_chunk_size(DEFAULT_READ_CHUNK_SIZE)
                        .max_buffered_chunks(DEFAULT_MAX_BUFFERED_CHUNKS)
                })
                .stderr(|stderr| {
                    stderr
                        .single_subscriber()
                        .best_effort_delivery()
                        .no_replay()
                        .read_chunk_size(DEFAULT_READ_CHUNK_SIZE)
                        .max_buffered_chunks(DEFAULT_MAX_BUFFERED_CHUNKS)
                })
                .spawn()
                .expect("Failed to spawn");

            assert_single_subscriber_stream_types::<
                ReliableDelivery,
                NoReplay,
                BestEffortDelivery,
                NoReplay,
            >(&process);

            let _ = process
                .wait_for_completion(Duration::from_secs(2))
                .await
                .unwrap();
        }

        #[tokio::test]
        async fn split_replay_modes_preserve_stream_types() {
            let mut process = Process::new(Command::new("ls"))
                .name(AutoName::program_only())
                .stdout(|stdout| {
                    stdout
                        .single_subscriber()
                        .best_effort_delivery()
                        .no_replay()
                        .read_chunk_size(DEFAULT_READ_CHUNK_SIZE)
                        .max_buffered_chunks(DEFAULT_MAX_BUFFERED_CHUNKS)
                })
                .stderr(|stderr| {
                    stderr
                        .single_subscriber()
                        .reliable_for_active_subscribers()
                        .replay_last_chunks(1)
                        .read_chunk_size(DEFAULT_READ_CHUNK_SIZE)
                        .max_buffered_chunks(DEFAULT_MAX_BUFFERED_CHUNKS)
                })
                .spawn()
                .expect("Failed to spawn");

            assert_single_subscriber_stream_types::<
                BestEffortDelivery,
                NoReplay,
                ReliableDelivery,
                ReplayEnabled,
            >(&process);

            process.seal_stderr_replay();
            let _ = process
                .wait_for_completion(Duration::from_secs(2))
                .await
                .unwrap();
        }

        #[tokio::test]
        async fn split_replay_enabled_streams_can_be_sealed() {
            let mut process = Process::new(Command::new("ls"))
                .name(AutoName::program_only())
                .stdout(|stdout| {
                    stdout
                        .single_subscriber()
                        .best_effort_delivery()
                        .replay_last_chunks(1)
                        .read_chunk_size(DEFAULT_READ_CHUNK_SIZE)
                        .max_buffered_chunks(DEFAULT_MAX_BUFFERED_CHUNKS)
                })
                .stderr(|stderr| {
                    stderr
                        .single_subscriber()
                        .reliable_for_active_subscribers()
                        .replay_last_chunks(1)
                        .read_chunk_size(DEFAULT_READ_CHUNK_SIZE)
                        .max_buffered_chunks(DEFAULT_MAX_BUFFERED_CHUNKS)
                })
                .spawn()
                .expect("Failed to spawn");

            assert_that!(process.stdout().replay_enabled()).is_true();
            assert_that!(process.stderr().replay_enabled()).is_true();

            process.seal_output_replay();
            assert_that!(process.stdout().is_replay_sealed()).is_true();
            assert_that!(process.stderr().is_replay_sealed()).is_true();

            let _ = process
                .wait_for_completion(Duration::from_secs(2))
                .await
                .unwrap();
        }
    }

    mod discard {
        use super::*;
        use crate::OutputStream;

        #[tokio::test]
        async fn stdout_and_stderr_complete_with_wait_for_completion() {
            let mut process = Process::new(
                ScriptedOutput::builder()
                    .stdout("out\n")
                    .stderr("err\n")
                    .build(),
            )
            .name(AutoName::program_only())
            .stdout_and_stderr(ProcessStreamBuilder::discard)
            .spawn()
            .expect("Failed to spawn");

            assert_that!(process.stdout().name()).is_equal_to("stdout");
            assert_that!(process.stderr().name()).is_equal_to("stderr");

            process
                .wait_for_completion(Duration::from_secs(2))
                .await
                .unwrap()
                .expect_completed("process should complete");
        }

        #[tokio::test]
        async fn can_discard_stdout_and_broadcast_stderr() {
            let mut process = Process::new(
                ScriptedOutput::builder()
                    .stdout("out\n")
                    .stderr("err\n")
                    .build(),
            )
            .name(AutoName::program_only())
            .stdout(ProcessStreamBuilder::discard)
            .stderr(|stream| {
                stream
                    .broadcast()
                    .best_effort_delivery()
                    .replay_last_bytes(1.megabytes())
                    .read_chunk_size(DEFAULT_READ_CHUNK_SIZE)
                    .max_buffered_chunks(DEFAULT_MAX_BUFFERED_CHUNKS)
            })
            .spawn()
            .expect("Failed to spawn");

            let collector = process.stderr().collect_lines_into_vec(
                crate::LineParsingOptions::default(),
                crate::test_support::line_collection_options(),
            );

            process
                .wait_for_completion(Duration::from_secs(2))
                .await
                .unwrap()
                .expect_completed("process should complete");

            let collected = collector.wait().await.unwrap();
            assert_that!(collected.lines()).contains_exactly(["err"]);
        }

        #[tokio::test]
        async fn can_broadcast_stdout_and_discard_stderr() {
            let mut process = Process::new(
                ScriptedOutput::builder()
                    .stdout("out\n")
                    .stderr("err\n")
                    .build(),
            )
            .name(AutoName::program_only())
            .stdout(|stream| {
                stream
                    .broadcast()
                    .best_effort_delivery()
                    .replay_last_bytes(1.megabytes())
                    .read_chunk_size(DEFAULT_READ_CHUNK_SIZE)
                    .max_buffered_chunks(DEFAULT_MAX_BUFFERED_CHUNKS)
            })
            .stderr(ProcessStreamBuilder::discard)
            .spawn()
            .expect("Failed to spawn");

            let collector = process.stdout().collect_lines_into_vec(
                crate::LineParsingOptions::default(),
                crate::test_support::line_collection_options(),
            );

            process
                .wait_for_completion(Duration::from_secs(2))
                .await
                .unwrap()
                .expect_completed("process should complete");

            let collected = collector.wait().await.unwrap();
            assert_that!(collected.lines()).contains_exactly(["out"]);
        }
    }

    mod spawn_errors {
        use super::*;

        #[tokio::test]
        async fn default_auto_name_does_not_capture_sensitive_args_in_spawn_error() {
            let sensitive_arg = "--token=secret-token-should-not-be-logged";
            let mut cmd = Command::new("tokio-process-tools-definitely-missing-command");
            cmd.arg(sensitive_arg);

            let error = match Process::new(cmd)
                .name(AutoName::program_only())
                .stdout_and_stderr(|stream| {
                    stream
                        .broadcast()
                        .best_effort_delivery()
                        .no_replay()
                        .read_chunk_size(DEFAULT_READ_CHUNK_SIZE)
                        .max_buffered_chunks(DEFAULT_MAX_BUFFERED_CHUNKS)
                })
                .spawn()
            {
                Ok(mut process) => {
                    let _ = process.wait_for_completion(Duration::from_secs(2)).await;
                    assert_that!(()).fail("command should fail to spawn");
                    return;
                }
                Err(error) => error,
            };
            let error = error.to_string();

            assert_that!(error.as_str()).contains("tokio-process-tools-definitely-missing-command");
            assert_that!(error.as_str()).does_not_contain(sensitive_arg);
        }
    }

    mod names {
        use super::*;

        #[tokio::test]
        async fn auto_name_settings_include_current_dir_and_args() {
            let mut cmd = Command::new("ls");
            cmd.arg("-la");
            cmd.env("IGNORED_ENV", "secret");
            cmd.current_dir("./");

            let mut process = Process::new(cmd)
                .name(
                    AutoNameSettings::builder()
                        .include_current_dir(true)
                        .include_args(true)
                        .build(),
                )
                .stdout_and_stderr(|stream| {
                    stream
                        .broadcast()
                        .best_effort_delivery()
                        .no_replay()
                        .read_chunk_size(DEFAULT_READ_CHUNK_SIZE)
                        .max_buffered_chunks(DEFAULT_MAX_BUFFERED_CHUNKS)
                })
                .spawn()
                .expect("Failed to spawn");

            assert_that!(&process.name).is_equal_to("./ % ls \"-la\"");

            let _ = process.wait_for_completion(Duration::from_secs(2)).await;
        }
    }
}