cargo-e 0.3.2

e is for Example. A command-line tool for running and exploring source, examples, and binaries from Rust projects. It will run the first example, if no options are given.
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
use crate::e_cli::RunAll;
use crate::e_command_builder::CargoCommandBuilder;
use crate::e_processmanager::ProcessManager;
use crate::e_target::{CargoTarget, TargetKind};
use anyhow::{Context, Result};
use std::path::PathBuf;
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::Arc;
use std::time::Duration;
use std::time::Instant;

#[cfg(unix)]
use nix::sys::signal::{kill, Signal};
#[cfg(unix)]
use nix::unistd::Pid;

// #[cfg(target_os = "windows")]
// use std::os::windows::process::CommandExt;

// #[cfg(target_os = "windows")]
// const CREATE_NEW_PROCESS_GROUP: u32 = 0x00000200;

// #[cfg(target_os = "windows")]
// fn send_ctrl_c(child: &mut Child) -> Result<()> {
//     println!("Sending CTRL-C to child process...");
//     use windows::Win32::System::Console::{GenerateConsoleCtrlEvent, CTRL_C_EVENT};

//     // Send CTRL+C to the child process group.
//     // The child must have been spawned with CREATE_NEW_PROCESS_GROUP.
//     let result = unsafe { GenerateConsoleCtrlEvent(CTRL_C_EVENT, child.id()) };
//     if result.is_err() {
//         return Err(anyhow::anyhow!("Failed to send CTRL_C_EVENT on Windows"));
//     }

//     // Allow some time for the child to handle the signal gracefully.
//     std::thread::sleep(std::time::Duration::from_millis(1000));

//     Ok(())
// }

#[cfg(not(target_os = "windows"))]
pub fn send_ctrl_c(child: &mut std::process::Child) -> Result<()> {
    // On Unix, send SIGINT to the child.
    kill(Pid::from_raw(child.id() as i32), Signal::SIGINT).context("Failed to send SIGINT")?;
    // Wait briefly to allow graceful shutdown.
    std::thread::sleep(Duration::from_millis(2000));
    Ok(())
}

/// Runs all filtered targets with prebuild, child process management, and timeout‐based termination.
///
/// If the CLI flag `pre_build` is enabled, this function first prebuilds all targets by invoking
/// `cargo build` with the appropriate flags (using `--example` or `--bin` and, for extended targets,
/// the `--manifest-path` flag). Then it spawns a child process for each target using `cargo run`,
/// waits for the duration specified by `cli.wait`, kills the child process, and then checks its output.
///
/// # Parameters
///
/// - `cli`: A reference to the CLI configuration (containing flags like `pre_build`, `wait`, and extra arguments).
/// - `filtered_targets`: A slice of `Example` instances representing the targets to run.
///
/// # Errors
///
/// Returns an error if the prebuild step fails or if any child process fails to spawn or complete.
pub fn run_all_examples(
    manager: Arc<ProcessManager>,
    cli: &crate::Cli,
    filtered_targets: &[CargoTarget],
) -> Result<bool> {
    // Adjust RUSTFLAGS if --quiet was provided.
    set_rustflags_if_quiet(cli.quiet);

    // Prebuild targets if requested.
    if cli.pre_build {
        crate::e_prebuild::prebuild_examples(filtered_targets)
            .context("Prebuild of targets failed")?;
    }

    let mut targets = filtered_targets.to_vec();
    targets.sort_by(|a, b| a.display_name.cmp(&b.display_name));

    let user_requested_quit = Arc::new(AtomicBool::new(false));

    let chunk_size = cli.run_at_a_time;
    let mut idx = 0;
    while idx < targets.len() {
        let chunk = &targets[idx..std::cmp::min(idx + chunk_size, targets.len())];
        let mut handles = vec![];

        for (chunk_idx, target) in chunk.iter().enumerate() {
            let manager = Arc::clone(&manager);
            let cli = cli.clone();
            let target = target.clone();
            let targets_len = targets.len();
            let idx = idx + chunk_idx;
            let user_requested_quit_thread = Arc::clone(&user_requested_quit);

            // Spawn a thread for each target in the chunk
            let handle = std::thread::spawn(move || {
                // --- Begin: original per-target logic ---
                let current_bin = env!("CARGO_PKG_NAME");
                // Skip running our own binary.
                if target.kind == TargetKind::Binary && target.name == current_bin {
                    return Ok(()) as Result<()>;
                }

                let manifest_path = PathBuf::from(target.manifest_path.clone());
                let builder = CargoCommandBuilder::new(
                    &target.name,
                    &manifest_path,
                    &cli.subcommand,
                    cli.filter,
                    cli.cached,
                    cli.default_binary_is_runner,
                    cli.quiet || cli.json_all_targets,
                    cli.detached,
                    cli.cwd_wsr,
                )
                .with_target(&target)
                .with_cli(&cli)
                .with_extra_args(&cli.extra);

                builder.print_command();

                let maybe_backup =
                    crate::e_manifest::maybe_patch_manifest_for_run(&target.manifest_path)
                        .context("Failed to patch manifest for run")?;

                // let system = Arc::new(Mutex::new(System::new_all()));
                // std::thread::sleep(sysinfo::MINIMUM_CPU_UPDATE_INTERVAL);
                // let mut system_guard = system.lock().unwrap();
                // system_guard.refresh_processes_specifics(
                //     ProcessesToUpdate::All,
                //     true,
                //     ProcessRefreshKind::nothing().with_cpu(),
                // );
                // drop(system_guard);

                let start = Arc::new(std::sync::Mutex::new(None));
                let start_for_callback = Arc::clone(&start);
                let pid = Arc::new(builder).run({
                    let manager_ref = Arc::clone(&manager);
                    let t = target.clone();
                    let len = targets_len;
                    let start = Arc::clone(&start_for_callback);
                    // let system_clone = system.clone();
                    move |pid, handle| {
                        let stats = {
                            let handle_guard = handle.lock().unwrap();
                            let stats = handle_guard.stats.lock().unwrap().clone();
                            stats
                        };
                        let runtime_start = if stats.is_comiler_target {
                            stats.build_finished_time
                        } else {
                            stats.start_time
                        };
                        let mut start_guard = start.lock().unwrap();
                        if start_guard.is_none() {
                            *start_guard = Some(Instant::now());
                        }
                        if !cli.no_status_lines {
                            let status_display = ProcessManager::format_process_status(
                                pid,
                                runtime_start,
                                &t,
                                (idx + 1, len),
                            );
                            ProcessManager::update_status_line(&status_display, true).ok();
                        }
                        manager_ref.register(pid, handle);
                    }
                })?;

                let timeout = match cli.run_all {
                    RunAll::Timeout(secs) => Duration::from_secs(secs),
                    RunAll::Forever => Duration::from_secs(u64::MAX),
                    RunAll::NotSpecified => Duration::from_secs(cli.wait),
                };

                // Use an Arc<Mutex<Option<Instant>>> so it can be set in the run callback and accessed in the main loop.
                let start_for_callback = Arc::clone(&start);
                // let target_name_for_timeout = target.name.clone();
                // let timeout_thread = std::thread::spawn({
                //     let manager = Arc::clone(&manager);
                //     let pid = pid.clone();
                //     move || {
                //         // Wait until `start` is Some, i.e., the process has started running
                //         while start.is_none() {
                //             println!(
                //                 "Waiting for process {} to start before applying timeout...",
                //                 pid
                //             );
                //             std::thread::sleep(Duration::from_millis(50));
                //         }
                //         let start_time = start.expect("start should have been set");
                //         while start_time.elapsed() < timeout {
                //             std::thread::sleep(Duration::from_millis(500));
                //             if manager.try_wait(pid).is_ok() {
                //                 return; // Process finished naturally
                //             }
                //             println!(
                //                 "Process {} is still running, waiting for timeout...",
                //                 pid
                //             );
                //         }
                //         // Timeout reached, kill the process
                //         println!(
                //             "\nTimeout reached for target {}. Killing child process {}.",
                //             target_name_for_timeout, pid
                //         );
                //         manager.kill_by_pid(pid).ok();
                //         manager.remove(pid);
                //     }
                // });

                // Main thread continues to monitor the process
                loop {
                    if manager.is_alive(pid) {
                        std::thread::sleep(Duration::from_millis(500));
                        match manager.try_wait(pid) {
                            Ok(Some(status)) => {
                                println!("Process {} finished naturally. {:?}", pid, status);
                                let hold = cli.detached_hold.unwrap_or(0);
                                if cli.detached_hold.is_some() && hold > 0 {
                                    println!("holding for the duration (detached_hold enabled). Sleeping for {} seconds...", hold);
                                    std::thread::sleep(std::time::Duration::from_secs(hold as u64));
                                }
                                // manager.e_window_kill(pid);
                                // manager.remove(pid);
                                break;
                            }
                            _ => {
                                // Process is still running.
                                // We can check for timeout here as well.
                                if let Ok(start_guard) = start_for_callback.lock() {
                                    if let Some(start_time) = *start_guard {
                                        if start_time.elapsed() >= timeout {
                                            println!(
                                            "\nTimeout reached for target {}. Killing child process {}.",
                                            target.name,pid);
                                            let hold = cli.detached_hold.unwrap_or(0);
                                            if cli.detached_hold.is_some() && hold > 0 {
                                                println!("holding for the duration (detached_hold enabled). Sleeping for {} seconds...", hold);
                                                std::thread::sleep(std::time::Duration::from_secs(
                                                    hold as u64,
                                                ));
                                            }
                                            manager.kill_by_pid(pid).ok();
                                            // manager.remove(pid);
                                            // user_requested_kill_thread.store(true, Ordering::SeqCst);
                                            // pids_to_kill_thread.lock().push(pid);
                                            break;
                                        }
                                    }
                                }
                                std::thread::sleep(Duration::from_millis(100));
                            }
                        }
                        if manager.has_signalled() > 0 {
                            println!("Detected Ctrl+C. {}", manager.has_signalled());
                            manager.remove(pid); // Clean up the process handle

                            if manager.has_signalled() > 1 {
                                if let Some(dur) = manager.time_between_signals() {
                                    if dur < Duration::from_millis(350) {
                                        println!("User requested quit two times quickly (<350ms).");
                                        user_requested_quit_thread.store(true, Ordering::SeqCst);
                                        break;
                                    }
                                }
                            }
                            println!("Dectected Ctrl+C, coninuing to next target.");
                            manager.reset_signalled();
                            break;
                        }

                        // let (_stats, runtime_start, end_time, status_display) = {
                        //     let (stats, runtime_start, end_time) =
                        //         if let Some(process_handle) = manager.get(pid) {
                        //             if let Ok(handle) = process_handle.lock() {
                        //                 let stats =
                        //                     handle.stats.lock().map(|s| s.clone()).unwrap_or_default();
                        //                 let runtime_start = if stats.is_comiler_target {
                        //                     stats.build_finished_time
                        //                 } else {
                        //                     stats.start_time
                        //                 };
                        //                 let end_time = handle.result.end_time;
                        //                 (stats, runtime_start, end_time)
                        //             } else {
                        //                 // If we can't lock, fallback to defaults
                        //                 (Default::default(), None, None)
                        //             }
                        //         } else {
                        //             // If process handle not found, fallback to defaults
                        //             (Default::default(), None, None)
                        //         };
                        //     let status_display = if !cli.no_status_lines {
                        //         ProcessManager::format_process_status(
                        //             pid,
                        //             runtime_start,
                        //             &target,
                        //             (idx + 1, targets_len),
                        //         )
                        //     } else {
                        //         String::new()
                        //     };
                        //     (stats, runtime_start, end_time, status_display)
                        // };

                        // if cli.filter && !cli.no_status_lines {
                        //     // let mut system_guard = system.lock().unwrap();
                        //     // system_guard.refresh_processes_specifics(
                        //     //     ProcessesToUpdate::All,
                        //     //     true,
                        //     //     ProcessRefreshKind::nothing().with_cpu(),
                        //     // );
                        //     // drop(system_guard);
                        //     ProcessManager::update_status_line(&status_display, true).ok();
                        // }
                        // if runtime_start.is_some() {
                        //     // let mut start_guard = start_for_callback.lock().unwrap();
                        //     // if start_guard.is_none() {
                        //     //     *start_guard = Some(Instant::now());
                        //     // }
                        //     if let Some(start_time) = *start_for_callback.lock().unwrap() {
                        //         if start_time.elapsed() >= timeout {
                        //             println!(
                        //                 "\nTimeout reached for target {} after {:.2?}. Killing child process {}.",
                        //                 target.name,
                        //                 start_time.elapsed(),
                        //                 pid
                        //             );
                        //             manager.e_window_kill(pid);
                        //             manager.remove(pid);
                        //             manager.kill_by_pid(pid).ok();
                        //             break;
                        //         }
                        //     }
                        //     // std::thread::sleep(Duration::from_millis(500));
                        // } else if end_time.is_some() {
                        //     println!("Process finished naturally.");
                        //     manager.e_window_kill(pid);
                        //     manager.remove(pid);
                        //     break;
                        // }
                        std::thread::sleep(Duration::from_millis(100));
                    }
                }

                // Wait for the timeout thread to finish
                // let _ = timeout_thread.join();

                if let Some(original) = maybe_backup {
                    fs::write(&target.manifest_path, original)
                        .context("Failed to restore patched manifest")?;
                }
                manager.generate_report(cli.gist);

                Ok(())
                // --- End: original per-target logic ---
            });
            if user_requested_quit.load(Ordering::SeqCst) {
                break;
            }
            handles.push(handle);
        }
        // Check if the user requested to quit.
        if user_requested_quit.load(Ordering::SeqCst) {
            break;
        }
        // Wait for all threads in this chunk to finish
        for handle in handles {
            let _ = handle.join();
        }
        manager.e_window_kill_all();
        idx += chunk_size;
    }

    Ok(Arc::clone(&user_requested_quit).load(Ordering::SeqCst))
}

// pub fn run_all_examples(cli: &Cli, filtered_targets: &[CargoTarget]) -> Result<()> {
//     // If --quiet was provided, adjust RUSTFLAGS.
//     set_rustflags_if_quiet(cli.quiet);

//     // Factor out the prebuild logic.
//     if cli.pre_build {
//         crate::e_prebuild::prebuild_examples(filtered_targets)
//             .context("Prebuild of targets failed")?;
//     }
//     let mut targets = filtered_targets.to_vec();
//     targets.sort_by(|a, b| a.display_name.cmp(&b.display_name));
//     // For each filtered target, run it with child process management.
//     for target in targets {
//         // Clear the screen before running each target.

//         // use crossterm::{execute, terminal::{Clear, ClearType}};
//         // use std::io::{stdout, Write};
//         //         execute!(stdout(), Clear(ClearType::All), crossterm::cursor::MoveTo(0, 0))?;
//         // std::io::Write::flush(&mut std::io::stdout()).unwrap();
//         println!("Running target: {}", target.name);

//         // Retrieve the current package name (or binary name) at compile time.
//         let current_bin = env!("CARGO_PKG_NAME");
//         // Avoid running our own binary if the target's name is the same.
//         if target.kind == TargetKind::Binary && target.name == current_bin {
//             continue;
//         }

//         // Determine the run flag and whether we need to pass the manifest path.
//         let (run_flag, needs_manifest) = match target.kind {
//             TargetKind::Example => ("--example", false),
//             TargetKind::ExtendedExample => ("--example", true),
//             TargetKind::Binary => ("--bin", false),
//             TargetKind::ExtendedBinary => ("--bin", true),
//             TargetKind::ManifestTauri => ("", true),
//             TargetKind::ManifestTauriExample => ("", true),
//             TargetKind::Test => ("--test", true),
//             TargetKind::Manifest => ("", true),
//             TargetKind::ManifestDioxus => ("", true),
//             TargetKind::ManifestDioxusExample => ("", true),
//             TargetKind::Bench => ("", true),
//         };
//         let mut cmd_parts = vec!["cargo".to_string()];
//         cmd_parts.push("run".to_string());
//         if cli.release {
//             cmd_parts.push("--release".to_string());
//         }
//         // Pass --quiet if requested.
//         if cli.quiet {
//             cmd_parts.push("--quiet".to_string());
//         }
//         cmd_parts.push(run_flag.to_string());
//         cmd_parts.push(target.name.clone());
//         if needs_manifest {
//             cmd_parts.push("--manifest-path".to_string());
//             cmd_parts.push(
//                 target
//                     .manifest_path
//                     .clone()
//                     .to_str()
//                     .unwrap_or_default()
//                     .to_owned(),
//             );
//         }
//         cmd_parts.extend(cli.extra.clone());

//         // // Build a vector of command parts for logging.
//         // let mut cmd_parts = vec!["cargo".to_string(), "run".to_string(), run_flag.to_string(), target.name.clone()];
//         // if needs_manifest {
//         //     cmd_parts.push("--manifest-path".to_string());
//         //     cmd_parts.push(target.manifest_path.clone());
//         // }
//         // // Append any extra CLI arguments.
//         // cmd_parts.extend(cli.extra.clone());

//         // Print out the full command that will be run.
//         let key = prompt(&format!("Full command: {}", cmd_parts.join(" ")), 2)?;
//         if let Some('q') = key {
//             println!("User requested quit.");
//             break;
//         }

//         // Clear the screen before running each target.
//         //println!("\x1B[2J\x1B[H");

//         // Build the command for execution.
//         let mut command = Command::new("cargo");
//         command.arg("run");
//         if cli.release {
//             command.arg("--release");
//         }
//         if cli.quiet {
//             command.arg("--quiet");
//         }
//         command.arg(run_flag).arg(&target.name);
//         if needs_manifest {
//             command.args(&[
//                 "--manifest-path",
//                 &target.manifest_path.to_str().unwrap_or_default().to_owned(),
//             ]);
//         }

//         // --- Inject required-features support using our helper ---
//         if let Some(features) = crate::e_manifest::get_required_features_from_manifest(
//             std::path::Path::new(&target.manifest_path),
//             &target.kind,
//             &target.name,
//         ) {
//             command.args(&["--features", &features]);
//         }
//         // --- End required-features support ---

//         // Append any extra CLI arguments.
//         command.args(&cli.extra);

//         // Spawn the child process.
//         let child = command
//             .spawn()
//             .with_context(|| format!("Failed to spawn cargo run for target {}", target.name))?;
//         {
//             let mut global = crate::e_runner::GLOBAL_CHILD.lock().unwrap();
//             *global = Some(child);
//         }
//         // Let the target run for the specified duration.
//         let run_duration = Duration::from_secs(cli.wait);
//         thread::sleep(run_duration);

//         // Kill the process (ignoring errors if it already terminated).

//         // Decide on the run duration per target and use it accordingly:
//         // Determine behavior based on the run_all flag:
//         let output = {
//             let mut global = crate::e_runner::GLOBAL_CHILD.lock().unwrap();
//             if let Some(mut child) = global.take() {
//                 match cli.run_all {
//                     RunAll::Timeout(timeout_secs) => {
//                         let message = format!(
//                             "Press any key to continue (timeout in {} seconds)...",
//                             timeout_secs
//                         );
//                         let key = prompt(&message, timeout_secs)?;
//                         if let Some('q') = key {
//                             println!("User requested quit.");
//                             // Terminate the process and break out of the loop.
//                             child.kill().ok();
//                             break;
//                         }
//                         child.kill().ok();
//                         child.wait_with_output().with_context(|| {
//                             format!("Failed to wait on cargo run for target {}", target.name)
//                         })?
//                     }
//                     RunAll::Forever => {
//                         let key = prompt(&"", 0)?;
//                         if let Some('q') = key {
//                             println!("User requested quit.");
//                             // Terminate the process and break out of the loop.
//                             child.kill().ok();
//                             break;
//                         } // Run until natural termination.
//                         child.wait_with_output().with_context(|| {
//                             format!("Failed to wait on cargo run for target {}", target.name)
//                         })?
//                     }
//                     RunAll::NotSpecified => {
//                         let key = prompt(&"", cli.wait)?;
//                         if let Some('q') = key {
//                             println!("User requested quit.");
//                             // Terminate the process and break out of the loop.
//                             child.kill().ok();
//                             break;
//                         }
//                         child.kill().ok();
//                         child.wait_with_output().with_context(|| {
//                             format!("Failed to wait on cargo run for target {}", target.name)
//                         })?
//                     }
//                 }
//             } else {
//                 return Err(anyhow::anyhow!("No child process found"));
//             }
//         };

//         if !output.stderr.is_empty() {
//             eprintln!(
//                 "Target '{}' produced errors:\n{}",
//                 target.name,
//                 String::from_utf8_lossy(&output.stderr)
//             );
//         }
//     }
//     Ok(())
// }

use std::{env, fs};

/// If quiet mode is enabled, ensure that RUSTFLAGS contains "-Awarnings".
/// If RUSTFLAGS is already set, and it does not contain "-Awarnings", then append it.
pub fn set_rustflags_if_quiet(quiet: bool) {
    if quiet {
        let current_flags = env::var("RUSTFLAGS").unwrap_or_else(|_| "".to_string());
        if !current_flags.contains("-Awarnings") {
            let new_flags = if current_flags.trim().is_empty() {
                "-Awarnings".to_string()
            } else {
                format!("{} -Awarnings", current_flags)
            };
            env::set_var("RUSTFLAGS", new_flags);
        }
    }
}