[integration-tests] redact hh:mm:ss durations (#3197)

Fixes an issue identified in
#3190 -- this shows up as
00:00:01 elapsed, breaking the snapshot.

Author: sunshowers

cargo-nextest/src/dispatch/core/replay.rs

@@ -24,6 +24,7 @@ use nextest_runner::{
         STORE_FORMAT_VERSION, StoreReader, TestEventKindSummary, TestEventSummary,
         records_state_dir,
     },
+    redact::Redactor,
     reporter::ReporterOutput,
     user_config::{UserConfig, UserConfigExperimental},
 };
@@ -265,6 +266,9 @@ fn run_replay_common(
 
     let mut reporter_builder = ReplayReporterBuilder::new();
     reporter_builder.set_colorize(should_colorize);
+    if crate::output::should_redact() {
+        reporter_builder.set_redactor(Redactor::for_snapshot_testing());
+    }
     replay_opts.reporter_opts.apply_to_replay_builder(
         &mut reporter_builder,
         &user_config.ui,

cargo-nextest/src/dispatch/core/run.rs

@@ -34,6 +34,7 @@ use nextest_runner::{
         RecordSession, RecordSessionConfig, RerunRootInfo, RunIdOrRecordingSelector, RunIdSelector,
         RunStore, STORE_FORMAT_VERSION, Styles as RecordStyles, records_state_dir,
     },
+    redact::Redactor,
     reporter::{
         MaxProgressRunning, ReporterBuilder, ShowProgress, ShowTerminalProgress, TestOutputDisplay,
         events::{FinalRunStats, RunStats},
@@ -746,6 +747,9 @@ impl ReporterOpts {
 
         builder.set_show_progress(show_progress);
         builder.set_max_progress_running(max_progress_running);
+        if crate::output::should_redact() {
+            builder.set_redactor(Redactor::for_snapshot_testing());
+        }
         builder
     }
 }
@@ -787,6 +791,9 @@ impl BenchReporterOpts {
             .map(ShowProgress::from)
             .unwrap_or(resolved_ui.show_progress.into());
         builder.set_show_progress(show_progress);
+        if crate::output::should_redact() {
+            builder.set_redactor(Redactor::for_snapshot_testing());
+        }
         builder
     }
 }

integration-tests/tests/integration/snapshots/integration__record_replay__replay_stress_run.snap

@@ -9,7 +9,7 @@ expression: "redact_dynamic_fields(&output, temp_root)"
  Nextest run ID 60000001-0000-0000-0000-000000000001 with nextest profile: default
     Starting 1 test across 7 binaries (31 tests skipped)
 ────────────
- Stress test iteration 1/5 (00:00:00 elapsed so far, 5 iterations remaining)
+ Stress test iteration 1/5 (HH:MM:SS elapsed so far, 5 iterations remaining)
         SKIP [         ] [1/5] (───) nextest-tests tests::call_dylib_add_two
         SKIP [         ] [1/5] (───) nextest-tests tests::unit_test_success
         SKIP [         ] [1/5] (───) nextest-tests::basic test_cargo_env_vars
@@ -44,7 +44,7 @@ expression: "redact_dynamic_fields(&output, temp_root)"
         PASS [ duration] [1/5] (1/1) nextest-tests::basic test_success
  Stress test [ duration] iteration 1/5: 1 test run: 1 passed, 31 skipped
 ────────────
- Stress test iteration 2/5 (00:00:00 elapsed so far, 4 iterations remaining)
+ Stress test iteration 2/5 (HH:MM:SS elapsed so far, 4 iterations remaining)
         SKIP [         ] [2/5] (───) nextest-tests tests::call_dylib_add_two
         SKIP [         ] [2/5] (───) nextest-tests tests::unit_test_success
         SKIP [         ] [2/5] (───) nextest-tests::basic test_cargo_env_vars
@@ -79,7 +79,7 @@ expression: "redact_dynamic_fields(&output, temp_root)"
         PASS [ duration] [2/5] (1/1) nextest-tests::basic test_success
  Stress test [ duration] iteration 2/5: 1 test run: 1 passed, 31 skipped
 ────────────
- Stress test iteration 3/5 (00:00:00 elapsed so far, 3 iterations remaining)
+ Stress test iteration 3/5 (HH:MM:SS elapsed so far, 3 iterations remaining)
         SKIP [         ] [3/5] (───) nextest-tests tests::call_dylib_add_two
         SKIP [         ] [3/5] (───) nextest-tests tests::unit_test_success
         SKIP [         ] [3/5] (───) nextest-tests::basic test_cargo_env_vars
@@ -114,7 +114,7 @@ expression: "redact_dynamic_fields(&output, temp_root)"
         PASS [ duration] [3/5] (1/1) nextest-tests::basic test_success
  Stress test [ duration] iteration 3/5: 1 test run: 1 passed, 31 skipped
 ────────────
- Stress test iteration 4/5 (00:00:00 elapsed so far, 2 iterations remaining)
+ Stress test iteration 4/5 (HH:MM:SS elapsed so far, 2 iterations remaining)
         SKIP [         ] [4/5] (───) nextest-tests tests::call_dylib_add_two
         SKIP [         ] [4/5] (───) nextest-tests tests::unit_test_success
         SKIP [         ] [4/5] (───) nextest-tests::basic test_cargo_env_vars
@@ -149,7 +149,7 @@ expression: "redact_dynamic_fields(&output, temp_root)"
         PASS [ duration] [4/5] (1/1) nextest-tests::basic test_success
  Stress test [ duration] iteration 4/5: 1 test run: 1 passed, 31 skipped
 ────────────
- Stress test iteration 5/5 (00:00:00 elapsed so far, 1 iteration remaining)
+ Stress test iteration 5/5 (HH:MM:SS elapsed so far, 1 iteration remaining)
         SKIP [         ] [5/5] (───) nextest-tests tests::call_dylib_add_two
         SKIP [         ] [5/5] (───) nextest-tests tests::unit_test_success
         SKIP [         ] [5/5] (───) nextest-tests::basic test_cargo_env_vars

nextest-runner/src/helpers.rs

@@ -633,6 +633,41 @@ pub(crate) fn rel_path_join(rel_path: &Utf8Path, path: &Utf8Path) -> Utf8PathBuf
 #[derive(Debug)]
 pub(crate) struct FormattedDuration(pub(crate) Duration);
 
+/// Controls how sub-second precision is handled when formatting durations.
+#[derive(Copy, Clone, Debug)]
+pub(crate) enum DurationRounding {
+    /// Truncate sub-second precision (floor). Use for elapsed time.
+    Floor,
+
+    /// Round up to the next second when sub-second milliseconds are present
+    /// (ceiling). Use for remaining time so that elapsed + remaining doesn't
+    /// appear to exceed the total.
+    Ceiling,
+}
+
+/// Formats a duration as `HH:MM:SS`.
+#[derive(Debug)]
+pub(crate) struct FormattedHhMmSs {
+    pub(crate) duration: Duration,
+    pub(crate) rounding: DurationRounding,
+}
+
+impl fmt::Display for FormattedHhMmSs {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        let total_secs = self.duration.as_secs();
+        let total_secs = match self.rounding {
+            DurationRounding::Ceiling if self.duration.subsec_millis() > 0 => total_secs + 1,
+            _ => total_secs,
+        };
+        let secs = total_secs % 60;
+        let total_mins = total_secs / 60;
+        let mins = total_mins % 60;
+        let hours = total_mins / 60;
+
+        write!(f, "{hours:02}:{mins:02}:{secs:02}")
+    }
+}
+
 impl fmt::Display for FormattedDuration {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         let duration = self.0.as_secs_f64();

nextest-runner/src/record/replay.rs

@@ -602,6 +602,7 @@ use crate::{
         run_id_index::{RunIdIndex, ShortestRunIdPrefix},
         store::{RecordedRunInfo, RecordedRunStatus},
     },
+    redact::Redactor,
     reporter::{
         DisplayConfig, DisplayReporter, DisplayReporterBuilder, DisplayerKind, FinalStatusLevel,
         MaxProgressRunning, OutputLoadDecider, ReporterOutput, ShowProgress, ShowTerminalProgress,
@@ -663,6 +664,7 @@ pub struct ReplayReporterBuilder {
     show_progress: ShowProgress,
     max_progress_running: MaxProgressRunning,
     no_output_indent: bool,
+    redactor: Redactor,
 }
 
 impl Default for ReplayReporterBuilder {
@@ -677,6 +679,7 @@ impl Default for ReplayReporterBuilder {
             show_progress: ShowProgress::default(),
             max_progress_running: MaxProgressRunning::default(),
             no_output_indent: false,
+            redactor: Redactor::noop(),
         }
     }
 }
@@ -744,6 +747,12 @@ impl ReplayReporterBuilder {
         self
     }
 
+    /// Sets the redactor for snapshot testing.
+    pub fn set_redactor(&mut self, redactor: Redactor) -> &mut Self {
+        self.redactor = redactor;
+        self
+    }
+
     /// Builds the replay reporter with the given output destination.
     pub fn build<'a>(
         self,
@@ -771,6 +780,7 @@ impl ReplayReporterBuilder {
             // we're replaying events, not running live tests.
             show_term_progress: ShowTerminalProgress::No,
             displayer_kind: DisplayerKind::Replay,
+            redactor: self.redactor,
         }
         .build(output);
 

nextest-runner/src/redact.rs

@@ -7,8 +7,8 @@
 
 use crate::{
     helpers::{
-        FormattedDuration, FormattedRelativeDuration, convert_rel_path_to_forward_slash,
-        decimal_char_width,
+        DurationRounding, FormattedDuration, FormattedHhMmSs, FormattedRelativeDuration,
+        convert_rel_path_to_forward_slash, decimal_char_width,
     },
     list::RustBuildMeta,
 };
@@ -40,6 +40,8 @@ static SIZE_REDACTION: &str = "<size>";
 static VERSION_REDACTION: &str = "<version>";
 /// Placeholder for redacted relative durations (e.g. "30s ago").
 static RELATIVE_DURATION_REDACTION: &str = "<ago>";
+/// 8 chars, matches `HH:MM:SS` format.
+static HHMMSS_REDACTION: &str = "HH:MM:SS";
 
 /// A helper for redacting data that varies by environment.
 ///
@@ -50,6 +52,12 @@ pub struct Redactor {
     kind: Arc<RedactorKind>,
 }
 
+impl Default for Redactor {
+    fn default() -> Self {
+        Self::noop()
+    }
+}
+
 impl Redactor {
     /// Creates a new no-op redactor.
     pub fn noop() -> Self {
@@ -149,6 +157,23 @@ impl Redactor {
         }
     }
 
+    /// Redacts an `HH:MM:SS` duration (used for stress test elapsed/remaining
+    /// time).
+    ///
+    /// The placeholder `HH:MM:SS` is 8 characters, matching the width of the
+    /// zero-padded `%02H:%02M:%02S` format.
+    pub(crate) fn redact_hhmmss_duration(
+        &self,
+        duration: Duration,
+        rounding: DurationRounding,
+    ) -> RedactorOutput<FormattedHhMmSs> {
+        if self.kind.is_active() {
+            RedactorOutput::Redacted(HHMMSS_REDACTION.to_string())
+        } else {
+            RedactorOutput::Unredacted(FormattedHhMmSs { duration, rounding })
+        }
+    }
+
     /// Returns true if this redactor is active (will redact values).
     pub fn is_active(&self) -> bool {
         self.kind.is_active()

nextest-runner/src/reporter/displayer/formatters.rs

@@ -34,32 +34,6 @@ impl fmt::Display for DisplayBracketedHhMmSs {
     }
 }
 
-pub(super) struct DisplayHhMmSs {
-    pub(super) duration: Duration,
-    // True if floor, false if ceiling.
-    pub(super) floor: bool,
-}
-
-impl fmt::Display for DisplayHhMmSs {
-    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        // This matches indicatif's elapsed_precise display.
-        let total_secs = self.duration.as_secs();
-        let total_secs = if !self.floor && self.duration.subsec_millis() > 0 {
-            total_secs + 1
-        } else {
-            total_secs
-        };
-        let secs = total_secs % 60;
-        let total_mins = total_secs / 60;
-        let mins = total_mins % 60;
-        let hours = total_mins / 60;
-
-        // Buffer the output internally to provide padding.
-        let out = format!("{hours:02}:{mins:02}:{secs:02}");
-        write!(f, "{out}")
-    }
-}
-
 pub(super) struct DisplayBracketedDuration(pub(super) Duration);
 
 impl fmt::Display for DisplayBracketedDuration {