Show the unnormalized output on output mismatch failure

CHANGELOG.md

@@ -15,6 +15,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed
 
+## [0.29.0] - 2025-02-25
+
+### Added
+
+### Fixed
+
+### Changed
+
+* output conflict handling now only takes the unnormalized output and is expected to normalize itself if desired.
+
+### Removed
+
 ## [0.28.0] - 2025-01-27
 
 ### Added

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ui_test"
-version = "0.28.0"
+version = "0.29.0"
 edition = "2021"
 license = "MIT OR Apache-2.0"
 description = "A test framework for testing rustc diagnostics output"

src/config.rs

@@ -7,7 +7,7 @@ use crate::{
 use crate::{
     diagnostics::{self, Diagnostics},
     parser::CommandParserFunc,
-    per_test_config::{Comments, Condition},
+    per_test_config::{Comments, Condition, TestConfig},
     CommandBuilder, Error, Errored, Errors,
 };
 use color_eyre::eyre::Result;
@@ -85,7 +85,7 @@ impl AbortCheck {
 }
 
 /// Function that performs the actual output conflict handling.
-pub type OutputConflictHandling = fn(&Path, Vec<u8>, &mut Errors, &Config);
+pub type OutputConflictHandling = fn(&Path, &[u8], &mut Errors, &TestConfig);
 
 impl Config {
     /// Create a blank configuration that doesn't do anything interesting
@@ -484,36 +484,37 @@ impl Config {
 /// test.
 pub fn error_on_output_conflict(
     path: &Path,
-    actual: Vec<u8>,
+    output: &[u8],
     errors: &mut Errors,
-    config: &Config,
+    config: &TestConfig,
 ) {
     let expected = std::fs::read(path).unwrap_or_default();
-    if actual != expected {
+    if config.normalize(output, &path.extension().unwrap().to_string_lossy()) != expected {
         errors.push(Error::OutputDiffers {
             path: path.to_path_buf(),
-            actual,
+            actual: output.to_vec(),
             expected,
-            bless_command: config.bless_command.clone(),
+            bless_command: config.config.bless_command.clone(),
         });
     }
 }
 
 /// Ignore mismatches in the stderr/stdout files.
 pub fn ignore_output_conflict(
     _path: &Path,
-    _actual: Vec<u8>,
+    _output: &[u8],
     _errors: &mut Errors,
-    _config: &Config,
+    _config: &TestConfig,
 ) {
 }
 
 /// Instead of erroring if the stderr/stdout differs from the expected
 /// automatically replace it with the found output (after applying filters).
-pub fn bless_output_files(path: &Path, actual: Vec<u8>, _errors: &mut Errors, _config: &Config) {
-    if actual.is_empty() {
+pub fn bless_output_files(path: &Path, output: &[u8], _errors: &mut Errors, config: &TestConfig) {
+    if output.is_empty() {
         let _ = std::fs::remove_file(path);
     } else {
+        let actual = config.normalize(output, &path.extension().unwrap().to_string_lossy());
         std::fs::write(path, &actual).unwrap();
     }
 }

src/per_test_config.rs

@@ -186,9 +186,8 @@ impl TestConfig {
     }
 
     pub(crate) fn check_output(&self, output: &[u8], errors: &mut Errors, kind: &str) -> PathBuf {
-        let output = self.normalize(output, kind);
         let path = self.output_path(kind);
-        (self.config.output_conflict_handling)(&path, output, errors, &self.config);
+        (self.config.output_conflict_handling)(&path, output, errors, &self);
         path
     }
 

tests/integrations/basic-fail/Cargo.stdout

@@ -30,7 +30,13 @@ Execute `DO NOT BLESS. These are meant to fail` to update `tests/actual_tests/ba
 +++ <stderr output>
  error[E0308]: mismatched types
   --> tests/actual_tests/bad_pattern.rs:4:9
-... 10 lines skipped ...
+... 5 lines skipped ...
+   |
+ note: function defined here
+- --> $DIR/tests/integrations/basic-fail/src/lib.rs:LL:CC
++ --> $DIR/tests/integrations/basic-fail/src/lib.rs:LL:CC
+   |
+ 1 | pub fn add(left: usize, right: usize) -> usize {
    |        ^^^
 
 -error: aborting due to previous error
@@ -227,7 +233,13 @@ Execute `DO NOT BLESS. These are meant to fail` to update `tests/actual_tests/fo
 +++ <stderr output>
  error[E0308]: mismatched types
   --> tests/actual_tests/foomp2.rs:4:9
-... 10 lines skipped ...
+... 5 lines skipped ...
+   |
+ note: function defined here
+- --> $DIR/tests/integrations/basic-fail/src/lib.rs:LL:CC
++ --> $DIR/tests/integrations/basic-fail/src/lib.rs:LL:CC
+   |
+ 1 | pub fn add(left: usize, right: usize) -> usize {
    |        ^^^
 
 -error: aborting due to previous error
@@ -1429,7 +1441,8 @@ Execute `DO NOT BLESS. These are meant to fail` to update `tests/actual_tests/ru
 -  |     --- ^^^^ expected `usize`, found `&str`
 +  |     ^^^^^^^^^^ use of undeclared crate or module `basic_fail`
 
- thread 'rustc' panicked
+-thread 'rustc' panicked
++thread 'rustc' panicked at compiler/rustc_errors/src/lib.rs:
 
 
 error: `mismatched types` not found in diagnostics on line 8