[nextest-runner] store CLI args

We're going to use this in the run recorder.

Author: sunshowers

cargo-nextest/src/dispatch.rs

@@ -60,13 +60,13 @@ pub struct CargoNextestApp {
 
 impl CargoNextestApp {
     /// Executes the app.
-    pub fn exec(self, output_writer: &mut OutputWriter) -> Result<i32> {
+    pub fn exec(self, cli_args: Vec<String>, output_writer: &mut OutputWriter) -> Result<i32> {
         #[cfg(feature = "experimental-tokio-console")]
         nextest_runner::console::init();
 
         match self.subcommand {
-            NextestSubcommand::Nextest(app) => app.exec(output_writer),
-            NextestSubcommand::Ntr(opts) => opts.exec(output_writer),
+            NextestSubcommand::Nextest(app) => app.exec(cli_args, output_writer),
+            NextestSubcommand::Ntr(opts) => opts.exec(cli_args, output_writer),
             #[cfg(unix)]
             NextestSubcommand::DoubleSpawn(opts) => opts.exec(),
         }
@@ -99,7 +99,7 @@ impl AppOpts {
     /// Execute the command.
     ///
     /// Returns the exit code.
-    fn exec(self, output_writer: &mut OutputWriter) -> Result<i32> {
+    fn exec(self, cli_args: Vec<String>, output_writer: &mut OutputWriter) -> Result<i32> {
         let output = self.common.output.init();
 
         match self.command {
@@ -138,6 +138,7 @@ impl AppOpts {
                     run_opts.no_capture,
                     &run_opts.runner_opts,
                     &run_opts.reporter_opts,
+                    cli_args,
                     output_writer,
                 )?;
                 Ok(0)
@@ -372,7 +373,7 @@ struct NtrOpts {
 }
 
 impl NtrOpts {
-    fn exec(self, output_writer: &mut OutputWriter) -> Result<i32> {
+    fn exec(self, cli_args: Vec<String>, output_writer: &mut OutputWriter) -> Result<i32> {
         let output = self.common.output.init();
 
         let base = BaseApp::new(
@@ -389,6 +390,7 @@ impl NtrOpts {
             self.run_opts.no_capture,
             &self.run_opts.runner_opts,
             &self.run_opts.reporter_opts,
+            cli_args,
             output_writer,
         )?;
         Ok(0)
@@ -1523,6 +1525,7 @@ impl App {
         no_capture: bool,
         runner_opts: &TestRunnerOpts,
         reporter_opts: &TestReporterOpts,
+        cli_args: Vec<String>,
         output_writer: &mut OutputWriter,
     ) -> Result<()> {
         let (version_only_config, config) = self.base.load_config()?;
@@ -1606,6 +1609,7 @@ impl App {
         let runner = runner_builder.build(
             &test_list,
             &profile,
+            cli_args,
             handler,
             double_spawn.clone(),
             target_runner.clone(),

cargo-nextest/src/main.rs

@@ -9,8 +9,12 @@ fn main() -> Result<()> {
     color_eyre::install()?;
     let _ = enable_ansi_support::enable_ansi_support();
 
+    let cli_args: Vec<_> = std::env::args_os()
+        .map(|arg| arg.to_string_lossy().into_owned())
+        .collect();
+
     let opts = CargoNextestApp::parse();
-    match opts.exec(&mut OutputWriter::default()) {
+    match opts.exec(cli_args, &mut OutputWriter::default()) {
         Ok(code) => std::process::exit(code),
         Err(error) => {
             error.display_to_stderr();

integration-tests/test-helpers/cargo-nextest-dup.rs

@@ -12,8 +12,12 @@ fn main() -> Result<()> {
     color_eyre::install()?;
     let _ = enable_ansi_support::enable_ansi_support();
 
+    let cli_args: Vec<_> = std::env::args_os()
+        .map(|arg| arg.to_string_lossy().into_owned())
+        .collect();
+
     let opts = CargoNextestApp::parse();
-    match opts.exec(&mut OutputWriter::default()) {
+    match opts.exec(cli_args, &mut OutputWriter::default()) {
         Ok(code) => std::process::exit(code),
         Err(error) => {
             error.display_to_stderr();

nextest-runner/src/reporter.rs

@@ -598,6 +598,7 @@ impl<'a> TestReporterImpl<'a> {
                 test_list,
                 run_id,
                 profile_name,
+                cli_args: _,
             } => {
                 write!(writer, "{:>12} ", "Starting".style(self.styles.pass))?;
 
@@ -1675,6 +1676,9 @@ pub enum TestEventKind<'a> {
 
         /// The nextest profile chosen for this run.
         profile_name: String,
+
+        /// The command-line arguments for the process.
+        cli_args: Vec<String>,
     },
 
     /// A setup script started.

nextest-runner/src/runner.rs

@@ -170,6 +170,7 @@ impl TestRunnerBuilder {
         self,
         test_list: &'a TestList,
         profile: &'a NextestProfile<'a>,
+        cli_args: Vec<String>,
         handler_kind: SignalHandlerKind,
         double_spawn: DoubleSpawnInfo,
         target_runner: TargetRunner,
@@ -193,6 +194,7 @@ impl TestRunnerBuilder {
             inner: TestRunnerInner {
                 capture_strategy: self.capture_strategy,
                 profile,
+                cli_args,
                 test_threads,
                 force_retries: self.retries,
                 fail_fast,
@@ -253,6 +255,7 @@ impl<'a> TestRunner<'a> {
 struct TestRunnerInner<'a> {
     capture_strategy: CaptureStrategy,
     profile: &'a NextestProfile<'a>,
+    cli_args: Vec<String>,
     test_threads: usize,
     // This is Some if the user specifies a retry policy over the command-line.
     force_retries: Option<RetryPolicy>,
@@ -286,6 +289,7 @@ impl<'a> TestRunnerInner<'a> {
             callback,
             self.run_id,
             self.profile.name(),
+            self.cli_args.clone(),
             self.test_list.run_count(),
             self.fail_fast,
         );
@@ -1681,6 +1685,7 @@ struct CallbackContext<F, E> {
     callback: F,
     run_id: Uuid,
     profile_name: String,
+    cli_args: Vec<String>,
     stopwatch: StopwatchStart,
     run_stats: RunStats,
     fail_fast: bool,
@@ -1699,6 +1704,7 @@ where
         callback: F,
         run_id: Uuid,
         profile_name: &str,
+        cli_args: Vec<String>,
         initial_run_count: usize,
         fail_fast: bool,
     ) -> Self {
@@ -1707,6 +1713,7 @@ where
             run_id,
             stopwatch: crate::time::stopwatch(),
             profile_name: profile_name.to_owned(),
+            cli_args,
             run_stats: RunStats {
                 initial_run_count,
                 ..RunStats::default()
@@ -1725,6 +1732,7 @@ where
             test_list,
             run_id: self.run_id,
             profile_name: self.profile_name.clone(),
+            cli_args: self.cli_args.clone(),
         })
     }
 
@@ -2380,6 +2388,7 @@ mod tests {
             .build(
                 &test_list,
                 &profile,
+                vec![],
                 handler_kind,
                 DoubleSpawnInfo::disabled(),
                 TargetRunner::empty(),

nextest-runner/tests/integration/basic.rs

@@ -102,6 +102,7 @@ fn test_run() -> Result<()> {
         .build(
             &test_list,
             &profile,
+            vec![], // we aren't testing CLI args at the moment
             SignalHandlerKind::Noop,
             DoubleSpawnInfo::disabled(),
             TargetRunner::empty(),
@@ -210,6 +211,7 @@ fn test_run_ignored() -> Result<()> {
         .build(
             &test_list,
             &profile,
+            vec![],
             SignalHandlerKind::Noop,
             DoubleSpawnInfo::disabled(),
             TargetRunner::empty(),
@@ -418,6 +420,7 @@ fn test_retries(retries: Option<RetryPolicy>) -> Result<()> {
         .build(
             &test_list,
             &profile,
+            vec![],
             SignalHandlerKind::Noop,
             DoubleSpawnInfo::disabled(),
             TargetRunner::empty(),
@@ -556,6 +559,7 @@ fn test_termination() -> Result<()> {
         .build(
             &test_list,
             &profile,
+            vec![],
             SignalHandlerKind::Noop,
             DoubleSpawnInfo::disabled(),
             TargetRunner::empty(),

nextest-runner/tests/integration/target_runner.rs

@@ -220,6 +220,7 @@ fn test_run_with_target_runner() -> Result<()> {
         .build(
             &test_list,
             &profile,
+            vec![],
             SignalHandlerKind::Noop,
             DoubleSpawnInfo::disabled(),
             target_runner,