change tracker

Author: jdonszelmann

src/bootstrap/src/core/build_steps/test.rs

@@ -1410,7 +1410,7 @@ impl Step for RustdocGUI {
 /// (To run the tidy tool's internal tests, use the alias "tidyselftest" instead.)
 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
 pub struct Tidy {
-    is_for_rerunning_tests: IsForRerunningTests,
+    pub is_for_rerunning_tests: IsForRerunningTests,
 }
 
 impl Step for Tidy {

src/bootstrap/src/core/build_steps/test/failed_tests.rs

@@ -25,8 +25,16 @@ impl RecordFailedTests {
     }
 }
 
-impl RecordFailedTests {}
-
+/// This step is run as a dependency of most testing steps.
+/// Upon running, a file is created for failed tests to be recorded in if `--record` is passed on
+/// the command line.
+///
+/// This step is the only way to get access to a token type called [`RecordFailedTests`].
+/// Having this token type signifies the fact that a file was created to store failed tests in,
+/// and is required to create a `Renderer`, the type that renders the outputs of tests.
+///
+/// If `--rerun` isn't passed, or we're in dry-run mode, running this step is a no-op,
+/// and the `RecordFailedTest` type doesn't (need to) signify anything.
 #[derive(Clone, Copy, Eq, PartialEq, Hash, Debug)]
 pub struct SetupFailedTestsFile;
 impl Step for SetupFailedTestsFile {
@@ -80,7 +88,7 @@ pub fn collect_previously_failed_tests(failed_tests_file_path: &PathBuf) -> Vec<
     for line in lines {
         let trimmed = line.as_str().trim();
         let without_revision =
-            trimmed.rsplit_once("#").map(|(before, _)| before).unwrap_or(&trimmed);
+            trimmed.rsplit_once("#").map(|(before, _)| before).unwrap_or(trimmed);
         let without_suite_prefix = without_revision
             .strip_prefix("[")
             .and_then(|rest| rest.split_once("]"))
@@ -90,7 +98,7 @@ pub fn collect_previously_failed_tests(failed_tests_file_path: &PathBuf) -> Vec<
         let failed_test_path = PathBuf::from(without_suite_prefix.to_string());
         if set_tracking_duplicates.insert(failed_test_path.clone()) {
             if num_printed == 0 {
-                println!("rerunning previousy failed tests:");
+                println!("rerunning previously failed tests:");
             }
             if num_printed < MAX_RERUN_PRINTS {
                 println!("    {}", failed_test_path.display());

src/bootstrap/src/core/builder/cli_paths.rs

@@ -195,7 +195,7 @@ pub(crate) fn match_paths_to_steps_and_run(
     {
         let run_test_path = |path: &Path, is_for_rerunning_tests| {
             for StepExtra { desc, should_run } in &steps {
-                if let Some(suite) = should_run.is_suite_path(&path) {
+                if let Some(suite) = should_run.is_suite_path(path) {
                     desc.maybe_run(builder, vec![suite.clone()], is_for_rerunning_tests);
                     return false;
                 }

src/bootstrap/src/core/builder/tests.rs

@@ -35,7 +35,7 @@ fn run_build(paths: &[PathBuf], config: Config) -> Cache {
     let kind = config.cmd.kind();
     let build = Build::new(config);
     let builder = Builder::new(&build);
-    builder.run_step_descriptions(&Builder::get_step_descriptions(kind), paths);
+    builder.run_step_descriptions(&Builder::get_step_descriptions(kind), paths, &[]);
     builder.cache
 }
 
@@ -509,6 +509,7 @@ fn any_debug() {
 mod snapshot {
     use std::path::PathBuf;
 
+    use crate::core::build_steps::test::failed_tests::IsForRerunningTests;
     use crate::core::build_steps::{compile, dist, doc, test, tool};
     use crate::core::builder::tests::{
         RenderConfig, TEST_TRIPLE_1, TEST_TRIPLE_2, TEST_TRIPLE_3, configure, first, host_target,
@@ -2378,7 +2379,7 @@ mod snapshot {
 
         let host = TargetSelection::from_user(&host_target());
         steps.assert_contains(StepMetadata::test("compiletest-rustdoc-ui", host).stage(1));
-        steps.assert_not_contains(test::Tidy);
+        steps.assert_not_contains(test::Tidy { is_for_rerunning_tests: IsForRerunningTests::No });
     }
 
     #[test]
@@ -3238,7 +3239,7 @@ impl ConfigBuilder {
         let kind = config.cmd.kind();
         let build = Build::new(config);
         let builder = Builder::new(&build);
-        builder.run_step_descriptions(&Builder::get_step_descriptions(kind), &builder.paths);
+        builder.run_step_descriptions(&Builder::get_step_descriptions(kind), &builder.paths, &[]);
         builder.cache
     }
 

src/bootstrap/src/core/config/config.rs

@@ -1440,8 +1440,8 @@ impl Config {
             patch_binaries_for_nix: build_patch_binaries_for_nix,
             path_modification_cache,
             paths: flags_paths,
-            previously_failed_test_paths,
             prefix: install_prefix.map(PathBuf::from),
+            previously_failed_test_paths,
             print_step_rusage: build_print_step_rusage.unwrap_or(false),
             print_step_timings: build_print_step_timings.unwrap_or(false),
             profiler: build_profiler.unwrap_or(false),

src/bootstrap/src/core/config/flags.rs

@@ -434,13 +434,13 @@ pub enum Subcommand {
         #[doc(hidden)]
         no_doc: bool,
 
-        #[arg(long)]
         /// Record all the failed tests in a file in the build directory.
         ///
         /// On subsequent invocations, this set of tests can be rerun by passing `--rerun`
-        record: bool,
         #[arg(long)]
+        record: bool,
         /// Rerun tests that previously failed, and stored with `--record`.
+        #[arg(long)]
         rerun: bool,
     },
     /// Build and run some test suites *in Miri*

src/bootstrap/src/utils/change_tracker.rs

@@ -621,4 +621,9 @@ pub const CONFIG_CHANGE_HISTORY: &[ChangeInfo] = &[
         severity: ChangeSeverity::Info,
         summary: "`x.py` stopped accepting partial argument names. Use full names to avoid errors.",
     },
+    ChangeInfo {
+        change_id: 154586,
+        severity: ChangeSeverity::Info,
+        summary: "New option `build.record_failed_tests_path` to store failed tests when passing `--record`. These can be rerun with `--rerun`.",
+    },
 ];

src/bootstrap/src/utils/render_tests.rs

@@ -109,7 +109,7 @@ impl<'a> Renderer<'a> {
     ) -> Self {
         let failed_tests = record_failed_tests.path().and_then(|path| {
             // create the file (overwriting any previous) to get ready to record new failed tests
-            match File::options().create(true).append(true).truncate(false).open(&path) {
+            match File::options().create(true).append(true).truncate(false).open(path) {
                 Ok(f) => Some(f),
                 Err(e) => {
                     println!(
@@ -391,12 +391,12 @@ impl<'a> Renderer<'a> {
             }
             Message::Test(TestMessage::Failed(outcome)) => {
                 self.render_test_outcome(Outcome::Failed, &outcome);
-                if let Some(failed_tests) = &mut self.failed_tests {
-                    if let Err(e) = writeln!(failed_tests, "{}", outcome.name) {
-                        eprintln!(
-                            "failed to write test failure to file: {e} (attempted because `--record` was passed)"
-                        );
-                    }
+                if let Some(failed_tests) = &mut self.failed_tests
+                    && let Err(e) = writeln!(failed_tests, "{}", outcome.name)
+                {
+                    eprintln!(
+                        "failed to write test failure to file: {e} (attempted because `--record` was passed)"
+                    );
                 }
                 self.failures.push(outcome);
             }

src/etc/completions/x.fish

@@ -454,6 +454,8 @@ complete -c x -n "__fish_x_using_subcommand test" -l rustfix-coverage -d 'enable
 complete -c x -n "__fish_x_using_subcommand test" -l no-capture -d 'don\'t capture stdout/stderr of tests'
 complete -c x -n "__fish_x_using_subcommand test" -l bypass-ignore-backends -d 'Ignore `//@ ignore-backends` directives'
 complete -c x -n "__fish_x_using_subcommand test" -l no-doc -d 'Deprecated. Use `--all-targets` or `--tests` instead'
+complete -c x -n "__fish_x_using_subcommand test" -l record -d 'Record all the failed tests in a file in the build directory'
+complete -c x -n "__fish_x_using_subcommand test" -l rerun -d 'Rerun tests that previously failed, and stored with `--record`'
 complete -c x -n "__fish_x_using_subcommand test" -s v -l verbose -d 'use verbose output (-vv for very verbose)'
 complete -c x -n "__fish_x_using_subcommand test" -s i -l incremental -d 'use incremental compilation'
 complete -c x -n "__fish_x_using_subcommand test" -l include-default-paths -d 'include default paths in addition to the provided ones'
@@ -507,6 +509,8 @@ complete -c x -n "__fish_x_using_subcommand t" -l rustfix-coverage -d 'enable th
 complete -c x -n "__fish_x_using_subcommand t" -l no-capture -d 'don\'t capture stdout/stderr of tests'
 complete -c x -n "__fish_x_using_subcommand t" -l bypass-ignore-backends -d 'Ignore `//@ ignore-backends` directives'
 complete -c x -n "__fish_x_using_subcommand t" -l no-doc -d 'Deprecated. Use `--all-targets` or `--tests` instead'
+complete -c x -n "__fish_x_using_subcommand t" -l record -d 'Record all the failed tests in a file in the build directory'
+complete -c x -n "__fish_x_using_subcommand t" -l rerun -d 'Rerun tests that previously failed, and stored with `--record`'
 complete -c x -n "__fish_x_using_subcommand t" -s v -l verbose -d 'use verbose output (-vv for very verbose)'
 complete -c x -n "__fish_x_using_subcommand t" -s i -l incremental -d 'use incremental compilation'
 complete -c x -n "__fish_x_using_subcommand t" -l include-default-paths -d 'include default paths in addition to the provided ones'

src/etc/completions/x.ps1

@@ -522,6 +522,8 @@ Register-ArgumentCompleter -Native -CommandName 'x' -ScriptBlock {
             [CompletionResult]::new('--no-capture', '--no-capture', [CompletionResultType]::ParameterName, 'don''t capture stdout/stderr of tests')
             [CompletionResult]::new('--bypass-ignore-backends', '--bypass-ignore-backends', [CompletionResultType]::ParameterName, 'Ignore `//@ ignore-backends` directives')
             [CompletionResult]::new('--no-doc', '--no-doc', [CompletionResultType]::ParameterName, 'Deprecated. Use `--all-targets` or `--tests` instead')
+            [CompletionResult]::new('--record', '--record', [CompletionResultType]::ParameterName, 'Record all the failed tests in a file in the build directory')
+            [CompletionResult]::new('--rerun', '--rerun', [CompletionResultType]::ParameterName, 'Rerun tests that previously failed, and stored with `--record`')
             [CompletionResult]::new('-v', '-v', [CompletionResultType]::ParameterName, 'use verbose output (-vv for very verbose)')
             [CompletionResult]::new('--verbose', '--verbose', [CompletionResultType]::ParameterName, 'use verbose output (-vv for very verbose)')
             [CompletionResult]::new('-i', '-i', [CompletionResultType]::ParameterName, 'use incremental compilation')
@@ -582,6 +584,8 @@ Register-ArgumentCompleter -Native -CommandName 'x' -ScriptBlock {
             [CompletionResult]::new('--no-capture', '--no-capture', [CompletionResultType]::ParameterName, 'don''t capture stdout/stderr of tests')
             [CompletionResult]::new('--bypass-ignore-backends', '--bypass-ignore-backends', [CompletionResultType]::ParameterName, 'Ignore `//@ ignore-backends` directives')
             [CompletionResult]::new('--no-doc', '--no-doc', [CompletionResultType]::ParameterName, 'Deprecated. Use `--all-targets` or `--tests` instead')
+            [CompletionResult]::new('--record', '--record', [CompletionResultType]::ParameterName, 'Record all the failed tests in a file in the build directory')
+            [CompletionResult]::new('--rerun', '--rerun', [CompletionResultType]::ParameterName, 'Rerun tests that previously failed, and stored with `--record`')
             [CompletionResult]::new('-v', '-v', [CompletionResultType]::ParameterName, 'use verbose output (-vv for very verbose)')
             [CompletionResult]::new('--verbose', '--verbose', [CompletionResultType]::ParameterName, 'use verbose output (-vv for very verbose)')
             [CompletionResult]::new('-i', '-i', [CompletionResultType]::ParameterName, 'use incremental compilation')