nextest_runner/reporter/displayer/status_level.rs
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
// Copyright (c) The nextest Contributors
// SPDX-License-Identifier: MIT OR Apache-2.0
//! Status levels: filters for which test statuses are displayed.
//!
//! Status levels play a role that's similar to log levels in typical loggers.
use super::TestOutputDisplay;
use crate::reporter::events::CancelReason;
use serde::Deserialize;
/// Status level to show in the reporter output.
///
/// Status levels are incremental: each level causes all the statuses listed above it to be output. For example,
/// [`Slow`](Self::Slow) implies [`Retry`](Self::Retry) and [`Fail`](Self::Fail).
#[derive(Copy, Clone, Debug, Eq, Ord, PartialEq, PartialOrd, Deserialize)]
#[cfg_attr(test, derive(test_strategy::Arbitrary))]
#[serde(rename_all = "kebab-case")]
#[non_exhaustive]
pub enum StatusLevel {
/// No output.
None,
/// Only output test failures.
Fail,
/// Output retries and failures.
Retry,
/// Output information about slow tests, and all variants above.
Slow,
/// Output information about leaky tests, and all variants above.
Leak,
/// Output passing tests in addition to all variants above.
Pass,
/// Output skipped tests in addition to all variants above.
Skip,
/// Currently has the same meaning as [`Skip`](Self::Skip).
All,
}
/// Status level to show at the end of test runs in the reporter output.
///
/// Status levels are incremental.
///
/// This differs from [`StatusLevel`] in two ways:
/// * It has a "flaky" test indicator that's different from "retry" (though "retry" works as an alias.)
/// * It has a different ordering: skipped tests are prioritized over passing ones.
#[derive(Copy, Clone, Debug, Eq, Ord, PartialEq, PartialOrd, Deserialize)]
#[cfg_attr(test, derive(test_strategy::Arbitrary))]
#[serde(rename_all = "kebab-case")]
#[non_exhaustive]
pub enum FinalStatusLevel {
/// No output.
None,
/// Only output test failures.
Fail,
/// Output flaky tests.
#[serde(alias = "retry")]
Flaky,
/// Output information about slow tests, and all variants above.
Slow,
/// Output skipped tests in addition to all variants above.
Skip,
/// Output leaky tests in addition to all variants above.
Leak,
/// Output passing tests in addition to all variants above.
Pass,
/// Currently has the same meaning as [`Pass`](Self::Pass).
All,
}
pub(crate) struct StatusLevels {
pub(crate) status_level: StatusLevel,
pub(crate) final_status_level: FinalStatusLevel,
}
impl StatusLevels {
pub(super) fn compute_output_on_test_finished(
&self,
display: TestOutputDisplay,
cancel_status: Option<CancelReason>,
test_status_level: StatusLevel,
test_final_status_level: FinalStatusLevel,
) -> OutputOnTestFinished {
let write_status_line = self.status_level >= test_status_level;
let is_immediate = display.is_immediate();
// We store entries in the final output map if either the final status level is high enough or
// if `display` says we show the output at the end.
let is_final = display.is_final() || self.final_status_level >= test_final_status_level;
// This table is tested below. The basic invariant is that we generally follow what
// is_immediate and is_final suggests, except:
//
// - if the run is cancelled due to a non-interrupt signal, we display test output at most
// once.
// - if the run is cancelled due to an interrupt, we hide the output because dumping a bunch
// of output at the end is likely to not be helpful (though in the future we may want to
// at least dump outputs into files and write their names out, or whenever nextest gains
// the ability to replay test runs to be able to display it then.)
//
// is_immediate is_final cancel_status | show_immediate store_final
//
// false false <= Signal | false false
// false true <= Signal | false true [1]
// true false <= Signal | true false [1]
// true true < Signal | true true
// true true Signal | true false [2]
// * * Interrupt | false false
//
// [1] In non-interrupt cases, we want to display output if specified once.
//
// [2] If there's a signal, we shouldn't display output twice at the end since it's
// redundant -- instead, just show the output as part of the immediate display.
let show_immediate = is_immediate && cancel_status <= Some(CancelReason::Signal);
let store_final = if is_final && cancel_status < Some(CancelReason::Signal)
|| !is_immediate && is_final && cancel_status == Some(CancelReason::Signal)
{
OutputStoreFinal::Yes {
display_output: display.is_final(),
}
} else if is_immediate && is_final && cancel_status == Some(CancelReason::Signal) {
// In this special case, we already display the output once as the test is being
// cancelled, so don't display it again at the end since that's redundant.
OutputStoreFinal::Yes {
display_output: false,
}
} else {
OutputStoreFinal::No
};
OutputOnTestFinished {
write_status_line,
show_immediate,
store_final,
}
}
}
#[derive(Debug, PartialEq, Eq)]
pub(super) struct OutputOnTestFinished {
pub(super) write_status_line: bool,
pub(super) show_immediate: bool,
pub(super) store_final: OutputStoreFinal,
}
#[derive(Debug, PartialEq, Eq)]
pub(super) enum OutputStoreFinal {
/// Do not store the output.
No,
/// Store the output. display_output controls whether stdout and stderr should actually be
/// displayed at the end.
Yes { display_output: bool },
}
#[cfg(test)]
mod tests {
use super::*;
use test_strategy::proptest;
// ---
// The proptests here are probabilistically exhaustive, and it's just easier to express them
// as property-based tests. We could also potentially use a model checker like Kani here.
// ---
#[proptest(cases = 64)]
fn on_test_finished_dont_write_status_line(
display: TestOutputDisplay,
cancel_status: Option<CancelReason>,
#[filter(StatusLevel::Pass < #test_status_level)] test_status_level: StatusLevel,
test_final_status_level: FinalStatusLevel,
) {
let status_levels = StatusLevels {
status_level: StatusLevel::Pass,
final_status_level: FinalStatusLevel::Fail,
};
let actual = status_levels.compute_output_on_test_finished(
display,
cancel_status,
test_status_level,
test_final_status_level,
);
assert!(!actual.write_status_line);
}
#[proptest(cases = 64)]
fn on_test_finished_write_status_line(
display: TestOutputDisplay,
cancel_status: Option<CancelReason>,
#[filter(StatusLevel::Pass >= #test_status_level)] test_status_level: StatusLevel,
test_final_status_level: FinalStatusLevel,
) {
let status_levels = StatusLevels {
status_level: StatusLevel::Pass,
final_status_level: FinalStatusLevel::Fail,
};
let actual = status_levels.compute_output_on_test_finished(
display,
cancel_status,
test_status_level,
test_final_status_level,
);
assert!(actual.write_status_line);
}
#[proptest(cases = 64)]
fn on_test_finished_with_interrupt(
// We always hide output on interrupt.
display: TestOutputDisplay,
// cancel_status is fixed to Interrupt.
// In this case, the status levels are not relevant for is_immediate and is_final.
test_status_level: StatusLevel,
test_final_status_level: FinalStatusLevel,
) {
let status_levels = StatusLevels {
status_level: StatusLevel::Pass,
final_status_level: FinalStatusLevel::Fail,
};
let actual = status_levels.compute_output_on_test_finished(
display,
Some(CancelReason::Interrupt),
test_status_level,
test_final_status_level,
);
assert!(!actual.show_immediate);
assert_eq!(actual.store_final, OutputStoreFinal::No);
}
#[proptest(cases = 64)]
fn on_test_finished_dont_show_immediate(
#[filter(!#display.is_immediate())] display: TestOutputDisplay,
cancel_status: Option<CancelReason>,
// The status levels are not relevant for show_immediate.
test_status_level: StatusLevel,
test_final_status_level: FinalStatusLevel,
) {
let status_levels = StatusLevels {
status_level: StatusLevel::Pass,
final_status_level: FinalStatusLevel::Fail,
};
let actual = status_levels.compute_output_on_test_finished(
display,
cancel_status,
test_status_level,
test_final_status_level,
);
assert!(!actual.show_immediate);
}
#[proptest(cases = 64)]
fn on_test_finished_show_immediate(
#[filter(#display.is_immediate())] display: TestOutputDisplay,
#[filter(#cancel_status <= Some(CancelReason::Signal))] cancel_status: Option<CancelReason>,
// The status levels are not relevant for show_immediate.
test_status_level: StatusLevel,
test_final_status_level: FinalStatusLevel,
) {
let status_levels = StatusLevels {
status_level: StatusLevel::Pass,
final_status_level: FinalStatusLevel::Fail,
};
let actual = status_levels.compute_output_on_test_finished(
display,
cancel_status,
test_status_level,
test_final_status_level,
);
assert!(actual.show_immediate);
}
// Where we don't store final output: if display.is_final() is false, and if the test final
// status level is too high.
#[proptest(cases = 64)]
fn on_test_finished_dont_store_final(
#[filter(!#display.is_final())] display: TestOutputDisplay,
cancel_status: Option<CancelReason>,
// The status level is not relevant for store_final.
test_status_level: StatusLevel,
// But the final status level is.
#[filter(FinalStatusLevel::Fail < #test_final_status_level)]
test_final_status_level: FinalStatusLevel,
) {
let status_levels = StatusLevels {
status_level: StatusLevel::Pass,
final_status_level: FinalStatusLevel::Fail,
};
let actual = status_levels.compute_output_on_test_finished(
display,
cancel_status,
test_status_level,
test_final_status_level,
);
assert_eq!(actual.store_final, OutputStoreFinal::No);
}
// Case 1 where we store final output: if display is exactly TestOutputDisplay::Final, and if
// the cancel status is not Interrupt.
#[proptest(cases = 64)]
fn on_test_finished_store_final_1(
#[filter(#cancel_status <= Some(CancelReason::Signal))] cancel_status: Option<CancelReason>,
// In this case, it isn't relevant what test_status_level and test_final_status_level are.
test_status_level: StatusLevel,
test_final_status_level: FinalStatusLevel,
) {
let status_levels = StatusLevels {
status_level: StatusLevel::Pass,
final_status_level: FinalStatusLevel::Fail,
};
let actual = status_levels.compute_output_on_test_finished(
TestOutputDisplay::Final,
cancel_status,
test_status_level,
test_final_status_level,
);
assert_eq!(
actual.store_final,
OutputStoreFinal::Yes {
display_output: true
}
);
}
// Case 2 where we store final output: if display is TestOutputDisplay::ImmediateFinal and the
// cancel status is not Signal or Interrupt
#[proptest(cases = 64)]
fn on_test_finished_store_final_2(
#[filter(#cancel_status < Some(CancelReason::Signal))] cancel_status: Option<CancelReason>,
test_status_level: StatusLevel,
test_final_status_level: FinalStatusLevel,
) {
let status_levels = StatusLevels {
status_level: StatusLevel::Pass,
final_status_level: FinalStatusLevel::Fail,
};
let actual = status_levels.compute_output_on_test_finished(
TestOutputDisplay::ImmediateFinal,
cancel_status,
test_status_level,
test_final_status_level,
);
assert_eq!(
actual.store_final,
OutputStoreFinal::Yes {
display_output: true
}
);
}
// Case 3 where we store final output: if display is TestOutputDisplay::ImmediateFinal and the
// cancel status is exactly Signal. In this special case, we don't display the output.
#[proptest(cases = 64)]
fn on_test_finished_store_final_3(
test_status_level: StatusLevel,
test_final_status_level: FinalStatusLevel,
) {
let status_levels = StatusLevels {
status_level: StatusLevel::Pass,
final_status_level: FinalStatusLevel::Fail,
};
let actual = status_levels.compute_output_on_test_finished(
TestOutputDisplay::ImmediateFinal,
Some(CancelReason::Signal),
test_status_level,
test_final_status_level,
);
assert_eq!(
actual.store_final,
OutputStoreFinal::Yes {
display_output: false,
}
);
}
// Case 4: if display.is_final() is *false* but the test_final_status_level is low enough.
#[proptest(cases = 64)]
fn on_test_finished_store_final_4(
#[filter(!#display.is_final())] display: TestOutputDisplay,
#[filter(#cancel_status <= Some(CancelReason::Signal))] cancel_status: Option<CancelReason>,
// The status level is not relevant for store_final.
test_status_level: StatusLevel,
// But the final status level is.
#[filter(FinalStatusLevel::Fail >= #test_final_status_level)]
test_final_status_level: FinalStatusLevel,
) {
let status_levels = StatusLevels {
status_level: StatusLevel::Pass,
final_status_level: FinalStatusLevel::Fail,
};
let actual = status_levels.compute_output_on_test_finished(
display,
cancel_status,
test_status_level,
test_final_status_level,
);
assert_eq!(
actual.store_final,
OutputStoreFinal::Yes {
display_output: false,
}
);
}
}