Check that diagnostics happen in the line that they are annotated for

This commit is contained in:
Oli Scherer 2022-05-30 12:17:36 +00:00
parent 47771d6b78
commit 4b100a1b58
17 changed files with 737 additions and 77 deletions

45
Cargo.lock generated
View File

@ -193,6 +193,12 @@ dependencies = [
"cfg-if", "cfg-if",
] ]
[[package]]
name = "itoa"
version = "1.0.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "112c678d4050afce233f4f2852bb2eb519230b3cf12f33585275537d7e41578d"
[[package]] [[package]]
name = "lazy_static" name = "lazy_static"
version = "1.4.0" version = "1.4.0"
@ -446,6 +452,12 @@ dependencies = [
"semver", "semver",
] ]
[[package]]
name = "ryu"
version = "1.0.10"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f3f6f92acf49d1b98f7a81226834412ada05458b7364277387724a237f062695"
[[package]] [[package]]
name = "scopeguard" name = "scopeguard"
version = "1.1.0" version = "1.1.0"
@ -458,6 +470,37 @@ version = "1.0.9"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "8cb243bdfdb5936c8dc3c45762a19d12ab4550cdc753bc247637d4ec35a040fd" checksum = "8cb243bdfdb5936c8dc3c45762a19d12ab4550cdc753bc247637d4ec35a040fd"
[[package]]
name = "serde"
version = "1.0.137"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "61ea8d54c77f8315140a05f4c7237403bf38b72704d031543aa1d16abbf517d1"
dependencies = [
"serde_derive",
]
[[package]]
name = "serde_derive"
version = "1.0.137"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "1f26faba0c3959972377d3b2d306ee9f71faee9714294e41bb777f83f88578be"
dependencies = [
"proc-macro2",
"quote",
"syn",
]
[[package]]
name = "serde_json"
version = "1.0.81"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "9b7ce2b32a1aed03c558dc61a5cd328f15aff2dbc17daad8fb8af04d2100e15c"
dependencies = [
"itoa",
"ryu",
"serde",
]
[[package]] [[package]]
name = "shell-escape" name = "shell-escape"
version = "0.1.5" version = "0.1.5"
@ -500,6 +543,8 @@ dependencies = [
"pretty_assertions", "pretty_assertions",
"regex", "regex",
"rustc_version", "rustc_version",
"serde",
"serde_json",
] ]
[[package]] [[package]]

View File

@ -19,7 +19,6 @@ use log::debug;
use rustc_data_structures::sync::Lrc; use rustc_data_structures::sync::Lrc;
use rustc_driver::Compilation; use rustc_driver::Compilation;
use rustc_errors::emitter::{ColorConfig, HumanReadableErrorType};
use rustc_hir::{self as hir, def_id::LOCAL_CRATE, Node}; use rustc_hir::{self as hir, def_id::LOCAL_CRATE, Node};
use rustc_interface::interface::Config; use rustc_interface::interface::Config;
use rustc_middle::{ use rustc_middle::{
@ -28,7 +27,7 @@ use rustc_middle::{
}, },
ty::{query::ExternProviders, TyCtxt}, ty::{query::ExternProviders, TyCtxt},
}; };
use rustc_session::{config::ErrorOutputType, search_paths::PathKind, CtfeBacktrace}; use rustc_session::{search_paths::PathKind, CtfeBacktrace};
use miri::{BacktraceStyle, ProvenanceMode}; use miri::{BacktraceStyle, ProvenanceMode};
@ -64,13 +63,7 @@ impl rustc_driver::Callbacks for MiriCompilerCalls {
let (entry_def_id, entry_type) = if let Some(entry_def) = tcx.entry_fn(()) { let (entry_def_id, entry_type) = if let Some(entry_def) = tcx.entry_fn(()) {
entry_def entry_def
} else { } else {
let output_ty = ErrorOutputType::HumanReadable(HumanReadableErrorType::Default( tcx.sess.fatal("miri can only run programs that have a main function");
ColorConfig::Auto,
));
rustc_session::early_error(
output_ty,
"miri can only run programs that have a main function",
);
}; };
let mut config = self.miri_config.clone(); let mut config = self.miri_config.clone();

View File

@ -5,6 +5,6 @@ fn main() {
unsafe { unsafe {
std::intrinsics::assume(x < 10); std::intrinsics::assume(x < 10);
std::intrinsics::assume(x > 1); std::intrinsics::assume(x > 1);
std::intrinsics::assume(x > 42); //~ `assume` intrinsic called with `false` std::intrinsics::assume(x > 42); //~ ERROR `assume` intrinsic called with `false`
} }
} }

View File

@ -1,2 +1,4 @@
error: miri can only run programs that have a main function error: miri can only run programs that have a main function
error: aborting due to previous error

View File

@ -17,6 +17,6 @@ fn main() {
libc::pthread_cond_destroy(cond.as_mut_ptr()); libc::pthread_cond_destroy(cond.as_mut_ptr());
libc::pthread_cond_destroy(cond.as_mut_ptr()); libc::pthread_cond_destroy(cond.as_mut_ptr());
//~^ Undefined Behavior: using uninitialized data, but this operation requires initialized memory //~^ ERROR Undefined Behavior: using uninitialized data, but this operation requires initialized memory
} }
} }

View File

@ -14,6 +14,6 @@ fn main() {
libc::pthread_condattr_destroy(attr.as_mut_ptr()); libc::pthread_condattr_destroy(attr.as_mut_ptr());
libc::pthread_condattr_destroy(attr.as_mut_ptr()); libc::pthread_condattr_destroy(attr.as_mut_ptr());
//~^ Undefined Behavior: using uninitialized data, but this operation requires initialized memory //~^ ERROR Undefined Behavior: using uninitialized data, but this operation requires initialized memory
} }
} }

View File

@ -18,6 +18,6 @@ fn main() {
libc::pthread_mutex_destroy(mutex.as_mut_ptr()); libc::pthread_mutex_destroy(mutex.as_mut_ptr());
libc::pthread_mutex_destroy(mutex.as_mut_ptr()); libc::pthread_mutex_destroy(mutex.as_mut_ptr());
//~^ Undefined Behavior: using uninitialized data, but this operation requires initialized memory //~^ ERROR Undefined Behavior: using uninitialized data, but this operation requires initialized memory
} }
} }

View File

@ -14,6 +14,6 @@ fn main() {
libc::pthread_mutexattr_destroy(attr.as_mut_ptr()); libc::pthread_mutexattr_destroy(attr.as_mut_ptr());
libc::pthread_mutexattr_destroy(attr.as_mut_ptr()); libc::pthread_mutexattr_destroy(attr.as_mut_ptr());
//~^ Undefined Behavior: using uninitialized data, but this operation requires initialized memory //~^ ERROR Undefined Behavior: using uninitialized data, but this operation requires initialized memory
} }
} }

View File

@ -11,6 +11,6 @@ fn main() {
libc::pthread_rwlock_destroy(&mut lock); libc::pthread_rwlock_destroy(&mut lock);
libc::pthread_rwlock_destroy(&mut lock); libc::pthread_rwlock_destroy(&mut lock);
//~^ Undefined Behavior: using uninitialized data, but this operation requires initialized memory //~^ ERROR Undefined Behavior: using uninitialized data, but this operation requires initialized memory
} }
} }

45
ui_test/Cargo.lock generated
View File

@ -148,6 +148,12 @@ dependencies = [
"libc", "libc",
] ]
[[package]]
name = "itoa"
version = "1.0.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "112c678d4050afce233f4f2852bb2eb519230b3cf12f33585275537d7e41578d"
[[package]] [[package]]
name = "lazy_static" name = "lazy_static"
version = "1.4.0" version = "1.4.0"
@ -240,6 +246,12 @@ dependencies = [
"semver", "semver",
] ]
[[package]]
name = "ryu"
version = "1.0.10"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f3f6f92acf49d1b98f7a81226834412ada05458b7364277387724a237f062695"
[[package]] [[package]]
name = "scopeguard" name = "scopeguard"
version = "1.1.0" version = "1.1.0"
@ -252,6 +264,37 @@ version = "1.0.9"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "8cb243bdfdb5936c8dc3c45762a19d12ab4550cdc753bc247637d4ec35a040fd" checksum = "8cb243bdfdb5936c8dc3c45762a19d12ab4550cdc753bc247637d4ec35a040fd"
[[package]]
name = "serde"
version = "1.0.137"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "61ea8d54c77f8315140a05f4c7237403bf38b72704d031543aa1d16abbf517d1"
dependencies = [
"serde_derive",
]
[[package]]
name = "serde_derive"
version = "1.0.137"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "1f26faba0c3959972377d3b2d306ee9f71faee9714294e41bb777f83f88578be"
dependencies = [
"proc-macro2",
"quote",
"syn",
]
[[package]]
name = "serde_json"
version = "1.0.81"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "9b7ce2b32a1aed03c558dc61a5cd328f15aff2dbc17daad8fb8af04d2100e15c"
dependencies = [
"itoa",
"ryu",
"serde",
]
[[package]] [[package]]
name = "syn" name = "syn"
version = "1.0.95" version = "1.0.95"
@ -273,6 +316,8 @@ dependencies = [
"pretty_assertions", "pretty_assertions",
"regex", "regex",
"rustc_version", "rustc_version",
"serde",
"serde_json",
] ]
[[package]] [[package]]

View File

@ -12,3 +12,5 @@ regex = "1.5.5"
pretty_assertions = "1.2.1" pretty_assertions = "1.2.1"
crossbeam = "0.8.1" crossbeam = "0.8.1"
lazy_static = "1.4.0" lazy_static = "1.4.0"
serde = { version = "1.0", features = ["derive"] }
serde_json = "1.0"

View File

@ -11,9 +11,9 @@ Note that the space after `//`, when it is present, is *not* optional -- it must
* `// stderr-per-bitwidth` produces one stderr file per bitwidth, as they may differ significantly sometimes * `// stderr-per-bitwidth` produces one stderr file per bitwidth, as they may differ significantly sometimes
* `// error-pattern: XXX` make sure the stderr output contains `XXX` * `// error-pattern: XXX` make sure the stderr output contains `XXX`
* `//~ ERROR: XXX` make sure the stderr output contains `XXX` for an error in the line where this comment is written * `//~ ERROR: XXX` make sure the stderr output contains `XXX` for an error in the line where this comment is written
* NOTE: it is not checked at present that it is actually in the line where the error occurred, or that it is truly an ERROR/WARNING/HELP/NOTE, but you should treat it as such until that becomes true. * Also supports `HELP`, `WARN` or `NOTE` for different kind of message
* Also supports `HELP` or `WARN` for different kind of message * if one of those levels is specified explicitly, *all* diagnostics of this level or higher need an annotation. If you want to avoid this, just leave out the all caps level note entirely.
* if the all caps note is left out, any message is matched * If the all caps note is left out, a message of any level is matched. Leaving it out is not allowed for `ERROR` levels.
* This checks the output *before* normalization, so you can check things that get normalized away, but need to * This checks the output *before* normalization, so you can check things that get normalized away, but need to
be careful not to accidentally have a pattern that differs between platforms. be careful not to accidentally have a pattern that differs between platforms.
* `// revisions: XXX YYY` runs the test once for each space separated name in the list * `// revisions: XXX YYY` runs the test once for each space separated name in the list

View File

@ -2,6 +2,8 @@ use std::path::Path;
use regex::Regex; use regex::Regex;
use crate::rustc_stderr::Level;
#[cfg(test)] #[cfg(test)]
mod tests; mod tests;
@ -33,7 +35,11 @@ pub(crate) struct Comments {
pub(crate) struct ErrorMatch { pub(crate) struct ErrorMatch {
pub matched: String, pub matched: String,
pub revision: Option<String>, pub revision: Option<String>,
pub level: Option<Level>,
/// The line where the message was defined, for reporting issues with it (e.g. in case it wasn't found).
pub definition_line: usize, pub definition_line: usize,
/// The line this pattern is expecting to find a message in.
pub line: usize,
} }
impl Comments { impl Comments {
@ -47,9 +53,13 @@ impl Comments {
pub(crate) fn parse(path: &Path, content: &str) -> Self { pub(crate) fn parse(path: &Path, content: &str) -> Self {
let mut this = Self::default(); let mut this = Self::default();
let error_pattern_regex = let error_pattern_regex =
Regex::new(r"//(\[(?P<revision>[^\]]+)\])?~[|^]*\s*(ERROR|HELP|WARN)?:?(?P<text>.*)") Regex::new(r"//(\[(?P<revision>[^\]]+)\])?~(?P<offset>\||[\^]+)?\s*(?P<level>ERROR|HELP|WARN|NOTE)?:?(?P<text>.*)")
.unwrap(); .unwrap();
// The line that a `|` will refer to
let mut fallthrough_to = None;
for (l, line) in content.lines().enumerate() { for (l, line) in content.lines().enumerate() {
let l = l + 1; // enumerate starts at 0, but line numbers start at 1
if let Some(revisions) = line.strip_prefix("// revisions:") { if let Some(revisions) = line.strip_prefix("// revisions:") {
assert_eq!( assert_eq!(
this.revisions, this.revisions,
@ -113,7 +123,29 @@ impl Comments {
let matched = captures["text"].trim().to_string(); let matched = captures["text"].trim().to_string();
let revision = captures.name("revision").map(|rev| rev.as_str().to_string()); let revision = captures.name("revision").map(|rev| rev.as_str().to_string());
this.error_matches.push(ErrorMatch { matched, revision, definition_line: l });
let level = captures.name("level").map(|rev| rev.as_str().parse().unwrap());
let match_line = match captures.name("offset").map(|rev| rev.as_str()) {
Some("|") => fallthrough_to.expect("`//~|` pattern without preceding line"),
Some(pat) => {
debug_assert!(pat.chars().all(|c| c == '^'));
l - pat.len()
}
None => l,
};
fallthrough_to = Some(match_line);
this.error_matches.push(ErrorMatch {
matched,
revision,
level,
definition_line: l,
line: match_line,
});
} else {
fallthrough_to = None;
} }
} }
this this

View File

@ -13,7 +13,7 @@ fn main() {
"; ";
let comments = Comments::parse(Path::new("<dummy>"), s); let comments = Comments::parse(Path::new("<dummy>"), s);
println!("parsed comments: {:#?}", comments); println!("parsed comments: {:#?}", comments);
assert_eq!(comments.error_matches[0].definition_line, 4); assert_eq!(comments.error_matches[0].definition_line, 5);
assert_eq!(comments.error_matches[0].revision, None); assert_eq!(comments.error_matches[0].revision, None);
assert_eq!( assert_eq!(
comments.error_matches[0].matched, comments.error_matches[0].matched,

View File

@ -8,10 +8,12 @@ use colored::*;
use comments::ErrorMatch; use comments::ErrorMatch;
use crossbeam::queue::SegQueue; use crossbeam::queue::SegQueue;
use regex::Regex; use regex::Regex;
use rustc_stderr::{Level, Message};
use crate::comments::Comments; use crate::comments::Comments;
mod comments; mod comments;
mod rustc_stderr;
#[cfg(test)] #[cfg(test)]
mod tests; mod tests;
@ -100,7 +102,8 @@ pub fn run_tests(config: Config) {
for revision in for revision in
comments.revisions.clone().unwrap_or_else(|| vec![String::new()]) comments.revisions.clone().unwrap_or_else(|| vec![String::new()])
{ {
let (m, errors) = run_test(&path, &config, &target, &revision, &comments); let (m, errors, stderr) =
run_test(&path, &config, &target, &revision, &comments);
// Using a single `eprintln!` to prevent messages from threads from getting intermingled. // Using a single `eprintln!` to prevent messages from threads from getting intermingled.
let mut msg = format!("{} ", path.display()); let mut msg = format!("{} ", path.display());
@ -113,7 +116,13 @@ pub fn run_tests(config: Config) {
succeeded.fetch_add(1, Ordering::Relaxed); succeeded.fetch_add(1, Ordering::Relaxed);
} else { } else {
eprintln!("{msg}{}", "FAILED".red().bold()); eprintln!("{msg}{}", "FAILED".red().bold());
failures.lock().unwrap().push((path.clone(), m, revision, errors)); failures.lock().unwrap().push((
path.clone(),
m,
revision,
errors,
stderr,
));
} }
} }
} }
@ -128,7 +137,7 @@ pub fn run_tests(config: Config) {
let ignored = ignored.load(Ordering::Relaxed); let ignored = ignored.load(Ordering::Relaxed);
let filtered = filtered.load(Ordering::Relaxed); let filtered = filtered.load(Ordering::Relaxed);
if !failures.is_empty() { if !failures.is_empty() {
for (path, miri, revision, errors) in &failures { for (path, miri, revision, errors, stderr) in &failures {
eprintln!(); eprintln!();
eprint!("{}", path.display().to_string().underline()); eprint!("{}", path.display().to_string().underline());
if !revision.is_empty() { if !revision.is_empty() {
@ -138,32 +147,63 @@ pub fn run_tests(config: Config) {
eprintln!(); eprintln!();
eprintln!("command: {:?}", miri); eprintln!("command: {:?}", miri);
eprintln!(); eprintln!();
let mut dump_stderr = None; // `None` means never dump, as we already dumped it for an `OutputDiffers`
// `Some(false)` means there's no reason to dump, as all errors are independent of the stderr
// `Some(true)` means that there was a pattern in the .rs file that was not found in the output.
let mut dump_stderr = Some(false);
for error in errors { for error in errors {
match error { match error {
Error::ExitStatus(mode, exit_status) => eprintln!("{mode:?} got {exit_status}"), Error::ExitStatus(mode, exit_status) => eprintln!("{mode:?} got {exit_status}"),
Error::PatternNotFound { stderr, pattern, definition_line } => { Error::PatternNotFound { pattern, definition_line } => {
eprintln!("`{pattern}` {} in stderr output", "not found".red()); eprintln!("`{pattern}` {} in stderr output", "not found".red());
eprintln!( eprintln!(
"expected because of pattern here: {}:{definition_line}", "expected because of pattern here: {}:{definition_line}",
path.display().to_string().bold() path.display().to_string().bold()
); );
dump_stderr = Some(stderr.clone()) dump_stderr = dump_stderr.map(|_| true);
}
Error::NoPatternsFound => {
eprintln!("{}", "no error patterns found in failure test".red());
} }
Error::NoPatternsFound =>
eprintln!("{}", "no error patterns found in failure test".red()),
Error::PatternFoundInPassTest => Error::PatternFoundInPassTest =>
eprintln!("{}", "error pattern found in success test".red()), eprintln!("{}", "error pattern found in success test".red()),
Error::OutputDiffers { path, actual, expected } => { Error::OutputDiffers { path, actual, expected } => {
dump_stderr = None; if path.extension().unwrap() == "stderr" {
dump_stderr = None;
}
eprintln!("actual output differed from expected {}", path.display()); eprintln!("actual output differed from expected {}", path.display());
eprintln!("{}", pretty_assertions::StrComparison::new(expected, actual)); eprintln!("{}", pretty_assertions::StrComparison::new(expected, actual));
eprintln!() eprintln!()
} }
Error::ErrorsWithoutPattern { path: None, msgs } => {
eprintln!(
"There were {} unmatched diagnostics that occurred outside the testfile and had not pattern",
msgs.len(),
);
for Message { level, message } in msgs {
eprintln!(" {level:?}: {message}")
}
}
Error::ErrorsWithoutPattern { path: Some((path, line)), msgs } => {
eprintln!(
"There were {} unmatched diagnostics at {}:{line}",
msgs.len(),
path.display()
);
for Message { level, message } in msgs {
eprintln!(" {level:?}: {message}")
}
}
Error::ErrorPatternWithoutErrorAnnotation(path, line) => {
eprintln!(
"Annotation at {}:{line} matched an error diagnostic but did not have `ERROR` before its message",
path.display()
);
}
} }
eprintln!(); eprintln!();
} }
if let Some(stderr) = dump_stderr { if let Some(true) = dump_stderr {
eprintln!("actual stderr:"); eprintln!("actual stderr:");
eprintln!("{}", stderr); eprintln!("{}", stderr);
eprintln!(); eprintln!();
@ -195,7 +235,6 @@ enum Error {
/// Got an invalid exit status for the given mode. /// Got an invalid exit status for the given mode.
ExitStatus(Mode, ExitStatus), ExitStatus(Mode, ExitStatus),
PatternNotFound { PatternNotFound {
stderr: String,
pattern: String, pattern: String,
definition_line: usize, definition_line: usize,
}, },
@ -209,6 +248,11 @@ enum Error {
actual: String, actual: String,
expected: String, expected: String,
}, },
ErrorsWithoutPattern {
msgs: Vec<Message>,
path: Option<(PathBuf, usize)>,
},
ErrorPatternWithoutErrorAnnotation(PathBuf, usize),
} }
type Errors = Vec<Error>; type Errors = Vec<Error>;
@ -219,7 +263,7 @@ fn run_test(
target: &str, target: &str,
revision: &str, revision: &str,
comments: &Comments, comments: &Comments,
) -> (Command, Errors) { ) -> (Command, Errors, String) {
// Run miri // Run miri
let mut miri = Command::new(&config.program); let mut miri = Command::new(&config.program);
miri.args(config.args.iter()); miri.args(config.args.iter());
@ -227,6 +271,7 @@ fn run_test(
if !revision.is_empty() { if !revision.is_empty() {
miri.arg(format!("--cfg={revision}")); miri.arg(format!("--cfg={revision}"));
} }
miri.arg("--error-format=json");
for arg in &comments.compile_flags { for arg in &comments.compile_flags {
miri.arg(arg); miri.arg(arg);
} }
@ -235,7 +280,7 @@ fn run_test(
} }
let output = miri.output().expect("could not execute miri"); let output = miri.output().expect("could not execute miri");
let mut errors = config.mode.ok(output.status); let mut errors = config.mode.ok(output.status);
check_test_result( let stderr = check_test_result(
path, path,
config, config,
target, target,
@ -245,7 +290,7 @@ fn run_test(
&output.stdout, &output.stdout,
&output.stderr, &output.stderr,
); );
(miri, errors) (miri, errors, stderr)
} }
fn check_test_result( fn check_test_result(
@ -257,11 +302,9 @@ fn check_test_result(
errors: &mut Errors, errors: &mut Errors,
stdout: &[u8], stdout: &[u8],
stderr: &[u8], stderr: &[u8],
) { ) -> String {
// Always remove annotation comments from stderr. // Always remove annotation comments from stderr.
let annotations = Regex::new(r"\s*//~.*").unwrap(); let diagnostics = rustc_stderr::process(path, stderr);
let stderr = std::str::from_utf8(stderr).unwrap();
let stderr = annotations.replace_all(stderr, "");
let stdout = std::str::from_utf8(stdout).unwrap(); let stdout = std::str::from_utf8(stdout).unwrap();
// Check output files (if any) // Check output files (if any)
let revised = |extension: &str| { let revised = |extension: &str| {
@ -273,7 +316,7 @@ fn check_test_result(
}; };
// Check output files against actual output // Check output files against actual output
check_output( check_output(
&stderr, &diagnostics.rendered,
path, path,
errors, errors,
revised("stderr"), revised("stderr"),
@ -293,50 +336,126 @@ fn check_test_result(
comments, comments,
); );
// Check error annotations in the source against output // Check error annotations in the source against output
check_annotations(&stderr, errors, config, revision, comments); check_annotations(
diagnostics.messages,
diagnostics.messages_from_unknown_file_or_line,
path,
errors,
config,
revision,
comments,
);
diagnostics.rendered
} }
fn check_annotations( fn check_annotations(
unnormalized_stderr: &str, mut messages: Vec<Vec<Message>>,
mut messages_from_unknown_file_or_line: Vec<Message>,
path: &Path,
errors: &mut Errors, errors: &mut Errors,
config: &Config, config: &Config,
revision: &str, revision: &str,
comments: &Comments, comments: &Comments,
) { ) {
let mut found_annotation = false;
if let Some((ref error_pattern, definition_line)) = comments.error_pattern { if let Some((ref error_pattern, definition_line)) = comments.error_pattern {
if !unnormalized_stderr.contains(error_pattern) { let mut found = false;
// first check the diagnostics messages outside of our file. We check this first, so that
// you can mix in-file annotations with // error-pattern annotations, even if there is overlap
// in the messages.
if let Some(i) = messages_from_unknown_file_or_line
.iter()
.position(|msg| msg.message.contains(error_pattern))
{
messages_from_unknown_file_or_line.remove(i);
found = true;
}
// if nothing was found, check the ones inside our file. We permit this because some tests may have
// flaky line numbers for their messages.
if !found {
for line in &mut messages {
if let Some(i) = line.iter().position(|msg| msg.message.contains(error_pattern)) {
line.remove(i);
found = true;
break;
}
}
}
if !found {
errors.push(Error::PatternNotFound { errors.push(Error::PatternNotFound {
stderr: unnormalized_stderr.to_string(),
pattern: error_pattern.to_string(), pattern: error_pattern.to_string(),
definition_line, definition_line,
}); });
} }
found_annotation = true;
} }
for &ErrorMatch { ref matched, revision: ref rev, definition_line } in &comments.error_matches {
// FIXME: check that the error happens on the marked line
// The order on `Level` is such that `Error` is the highest level.
// We will ensure that *all* diagnostics of level at least `lowest_annotation_level`
// are matched.
let mut lowest_annotation_level = Level::Error;
for &ErrorMatch { ref matched, revision: ref rev, definition_line, line, level } in
&comments.error_matches
{
if let Some(rev) = rev { if let Some(rev) = rev {
if rev != revision { if rev != revision {
continue; continue;
} }
} }
if let Some(level) = level {
if !unnormalized_stderr.contains(matched) { // If we found a diagnostic with a level annotation, make sure that all
errors.push(Error::PatternNotFound { // diagnostics of that level have annotations, even if we don't end up finding a matching diagnostic
stderr: unnormalized_stderr.to_string(), // for this pattern.
pattern: matched.to_string(), lowest_annotation_level = std::cmp::min(lowest_annotation_level, level);
definition_line,
});
} }
found_annotation = true;
if let Some(msgs) = messages.get_mut(line) {
let found = msgs.iter().position(|msg| {
msg.message.contains(matched)
// in case there is no level on the annotation, match any level.
&& level.map_or(true, |level| {
msg.level == level
})
});
if let Some(found) = found {
let msg = msgs.remove(found);
if msg.level == Level::Error && level.is_none() {
errors
.push(Error::ErrorPatternWithoutErrorAnnotation(path.to_path_buf(), line));
}
continue;
}
}
errors.push(Error::PatternNotFound { pattern: matched.to_string(), definition_line });
} }
match (config.mode, found_annotation) {
let filter = |msgs: Vec<Message>| -> Vec<_> {
msgs.into_iter().filter(|msg| msg.level >= lowest_annotation_level).collect()
};
let messages_from_unknown_file_or_line = filter(messages_from_unknown_file_or_line);
if !messages_from_unknown_file_or_line.is_empty() {
errors.push(Error::ErrorsWithoutPattern {
path: None,
msgs: messages_from_unknown_file_or_line,
});
}
for (line, msgs) in messages.into_iter().enumerate() {
let msgs = filter(msgs);
if !msgs.is_empty() {
errors
.push(Error::ErrorsWithoutPattern { path: Some((path.to_path_buf(), line)), msgs });
}
}
match (config.mode, comments.error_pattern.is_some() || !comments.error_matches.is_empty()) {
(Mode::Pass, true) | (Mode::Panic, true) => errors.push(Error::PatternFoundInPassTest), (Mode::Pass, true) | (Mode::Panic, true) => errors.push(Error::PatternFoundInPassTest),
(Mode::Fail, false) => errors.push(Error::NoPatternsFound), (Mode::Fail, false) => errors.push(Error::NoPatternsFound),
_ => {} _ => {}
}; }
} }
fn check_output( fn check_output(

152
ui_test/src/rustc_stderr.rs Normal file
View File

@ -0,0 +1,152 @@
use std::{
fmt::Write,
path::{Path, PathBuf},
};
use regex::Regex;
#[derive(serde::Deserialize, Debug)]
struct RustcMessage {
rendered: Option<String>,
spans: Vec<Span>,
level: String,
message: String,
children: Vec<RustcMessage>,
}
#[derive(Copy, Clone, Debug, PartialOrd, Ord, PartialEq, Eq)]
pub(crate) enum Level {
Error = 4,
Warn = 3,
Help = 2,
Note = 1,
/// Only used for "For more information about this error, try `rustc --explain EXXXX`".
FailureNote = 0,
}
#[derive(Debug)]
pub(crate) struct Message {
pub(crate) level: Level,
pub(crate) message: String,
}
/// Information about macro expansion.
#[derive(serde::Deserialize, Debug)]
struct Expansion {
span: Span,
}
#[derive(serde::Deserialize, Debug)]
struct Span {
line_start: usize,
file_name: PathBuf,
expansion: Option<Box<Expansion>>,
}
impl std::str::FromStr for Level {
type Err = String;
fn from_str(s: &str) -> Result<Self, Self::Err> {
match s {
"ERROR" | "error" => Ok(Self::Error),
"WARN" | "warning" => Ok(Self::Warn),
"HELP" | "help" => Ok(Self::Help),
"NOTE" | "note" => Ok(Self::Note),
"failure-note" => Ok(Self::FailureNote),
_ => Err(format!("unknown level `{s}`")),
}
}
}
#[derive(Debug)]
pub(crate) struct Diagnostics {
/// Rendered and concatenated version of all diagnostics.
/// This is equivalent to non-json diagnostics.
pub rendered: String,
/// Per line, a list of messages for that line.
pub messages: Vec<Vec<Message>>,
/// Messages not on any line (usually because they are from libstd)
pub messages_from_unknown_file_or_line: Vec<Message>,
}
impl RustcMessage {
fn line(&self, file: &Path) -> Option<usize> {
self.spans.iter().find_map(|span| span.line(file))
}
/// Put the message and its children into the line-indexed list.
fn insert_recursive(
self,
file: &Path,
messages: &mut Vec<Vec<Message>>,
messages_from_unknown_file_or_line: &mut Vec<Message>,
line: Option<usize>,
) {
let line = self.line(file).or(line);
let msg = Message { level: self.level.parse().unwrap(), message: self.message };
if let Some(line) = line {
if messages.len() <= line {
messages.resize_with(line + 1, Vec::new);
}
messages[line].push(msg);
// All other messages go into the general bin, unless they are specifically of the
// "aborting due to X previous errors" variety, as we never want to match those. They
// only count the number of errors and provide no useful information about the tests.
} else if !(msg.message.starts_with("aborting due to")
&& msg.message.contains("previous error"))
{
messages_from_unknown_file_or_line.push(msg);
}
for child in self.children {
child.insert_recursive(file, messages, messages_from_unknown_file_or_line, line)
}
}
}
impl Span {
/// Returns a line number *in the given file*, if possible.
fn line(&self, file: &Path) -> Option<usize> {
if self.file_name == file {
Some(self.line_start)
} else {
self.expansion.as_ref()?.span.line(file)
}
}
}
pub(crate) fn filter_annotations_from_rendered(rendered: &str) -> std::borrow::Cow<'_, str> {
let annotations = Regex::new(r"\s*//~.*").unwrap();
annotations.replace_all(&rendered, "")
}
pub(crate) fn process(file: &Path, stderr: &[u8]) -> Diagnostics {
let stderr = std::str::from_utf8(&stderr).unwrap();
let mut rendered = String::new();
let mut messages = vec![];
let mut messages_from_unknown_file_or_line = vec![];
for line in stderr.lines() {
if line.starts_with("{") {
match serde_json::from_str::<RustcMessage>(line) {
Ok(msg) => {
write!(
rendered,
"{}",
filter_annotations_from_rendered(msg.rendered.as_ref().unwrap())
)
.unwrap();
msg.insert_recursive(
file,
&mut messages,
&mut messages_from_unknown_file_or_line,
None,
);
}
Err(err) =>
panic!("failed to parse rustc JSON output at line: {}\nerr:{}", line, err),
}
} else {
// FIXME: do we want to throw interpreter stderr into a separate file?
writeln!(rendered, "{}", line).unwrap();
}
}
Diagnostics { rendered, messages, messages_from_unknown_file_or_line }
}

View File

@ -1,5 +1,8 @@
use std::path::{Path, PathBuf}; use std::path::{Path, PathBuf};
use crate::rustc_stderr::Level;
use crate::rustc_stderr::Message;
use super::*; use super::*;
fn config() -> Config { fn config() -> Config {
@ -29,25 +32,292 @@ fn main() {
let comments = Comments::parse(&path, s); let comments = Comments::parse(&path, s);
let mut errors = vec![]; let mut errors = vec![];
let config = config(); let config = config();
// Crucially, the intended error string *does* appear in this output, as a quote of the comment itself. let messages = vec![
let stderr = br" vec![], vec![], vec![], vec![], vec![],
error: Undefined Behavior: type validation failed: encountered a dangling reference (address 0x10 is unallocated) vec![
--> tests/compile-fail/validity/dangling_ref1.rs:6:29 Message {
| message:"Undefined Behavior: type validation failed: encountered a dangling reference (address 0x10 is unallocated)".to_string(),
LL | let _x: &i32 = unsafe { mem::transmute(16usize) }; //~ ERROR encountered a dangling reference (address $HEX is unallocated) level: Level::Error,
| ^^^^^^^^^^^^^^^^^^^^^^^ type validation failed: encountered a dangling reference (address 0x10 is unallocated) }
| ]
= help: this indicates a bug in the program: it performed an invalid operation, and caused Undefined Behavior ];
= help: see https://doc.rust-lang.org/nightly/reference/behavior-considered-undefined.html for further information check_annotations(messages, vec![], Path::new("moobar"), &mut errors, &config, "", &comments);
= note: inside `main` at tests/compile-fail/validity/dangling_ref1.rs:6:29
note: some details are omitted, run with `MIRIFLAGS=-Zmiri-backtrace=full` for a verbose backtrace
error: aborting due to previous error
";
check_test_result(&path, &config, "", "", &comments, &mut errors, /*stdout*/ br"", stderr);
// The "OutputDiffers" is because we cannot open the .rs file
match &errors[..] { match &errors[..] {
[Error::OutputDiffers { .. }, Error::PatternNotFound { .. }] => {} [
_ => panic!("not the expected error: {:#?}", errors), Error::PatternNotFound { definition_line: 5, .. },
Error::ErrorsWithoutPattern { path: Some((_, 5)), .. },
] => {}
_ => panic!("{:#?}", errors),
}
}
#[test]
fn find_pattern() {
let s = r"
use std::mem;
fn main() {
let _x: &i32 = unsafe { mem::transmute(16usize) }; //~ ERROR encountered a dangling reference (address 0x10 is unallocated)
}
";
let comments = Comments::parse(Path::new("<dummy>"), s);
let config = config();
{
let messages = vec![vec![], vec![], vec![], vec![], vec![], vec![
Message {
message: "Undefined Behavior: type validation failed: encountered a dangling reference (address 0x10 is unallocated)".to_string(),
level: Level::Error,
}
]
];
let mut errors = vec![];
check_annotations(
messages,
vec![],
Path::new("moobar"),
&mut errors,
&config,
"",
&comments,
);
match &errors[..] {
[] => {}
_ => panic!("{:#?}", errors),
}
}
// only difference to above is a wrong line number
{
let messages = vec![vec![], vec![], vec![], vec![], vec![
Message {
message: "Undefined Behavior: type validation failed: encountered a dangling reference (address 0x10 is unallocated)".to_string(),
level: Level::Error,
}
]
];
let mut errors = vec![];
check_annotations(
messages,
vec![],
Path::new("moobar"),
&mut errors,
&config,
"",
&comments,
);
match &errors[..] {
[
Error::PatternNotFound { definition_line: 5, .. },
Error::ErrorsWithoutPattern { path: Some((_, 4)), .. },
] => {}
_ => panic!("not the expected error: {:#?}", errors),
}
}
// only difference to first is a wrong level
{
let messages = vec![
vec![], vec![], vec![], vec![], vec![],
vec![
Message {
message: "Undefined Behavior: type validation failed: encountered a dangling reference (address 0x10 is unallocated)".to_string(),
level: Level::Note,
}
]
];
let mut errors = vec![];
check_annotations(
messages,
vec![],
Path::new("moobar"),
&mut errors,
&config,
"",
&comments,
);
match &errors[..] {
// Note no `ErrorsWithoutPattern`, because there are no `//~NOTE` in the test file, so we ignore them
[Error::PatternNotFound { definition_line: 5, .. }] => {}
_ => panic!("not the expected error: {:#?}", errors),
}
}
}
#[test]
fn duplicate_pattern() {
let s = r"
use std::mem;
fn main() {
let _x: &i32 = unsafe { mem::transmute(16usize) }; //~ ERROR encountered a dangling reference (address 0x10 is unallocated)
//~^ ERROR encountered a dangling reference (address 0x10 is unallocated)
}
";
let comments = Comments::parse(Path::new("<dummy>"), s);
let config = config();
let messages = vec![
vec![], vec![], vec![], vec![], vec![],
vec![
Message {
message: "Undefined Behavior: type validation failed: encountered a dangling reference (address 0x10 is unallocated)".to_string(),
level: Level::Error,
}
]
];
let mut errors = vec![];
check_annotations(messages, vec![], Path::new("moobar"), &mut errors, &config, "", &comments);
match &errors[..] {
[Error::PatternNotFound { definition_line: 6, .. }] => {}
_ => panic!("{:#?}", errors),
}
}
#[test]
fn missing_pattern() {
let s = r"
use std::mem;
fn main() {
let _x: &i32 = unsafe { mem::transmute(16usize) }; //~ ERROR encountered a dangling reference (address 0x10 is unallocated)
}
";
let comments = Comments::parse(Path::new("<dummy>"), s);
let config = config();
let messages = vec![
vec![], vec![], vec![], vec![], vec![],
vec![
Message {
message: "Undefined Behavior: type validation failed: encountered a dangling reference (address 0x10 is unallocated)".to_string(),
level: Level::Error,
},
Message {
message: "Undefined Behavior: type validation failed: encountered a dangling reference (address 0x10 is unallocated)".to_string(),
level: Level::Error,
}
]
];
let mut errors = vec![];
check_annotations(messages, vec![], Path::new("moobar"), &mut errors, &config, "", &comments);
match &errors[..] {
[Error::ErrorsWithoutPattern { path: Some((_, 5)), .. }] => {}
_ => panic!("{:#?}", errors),
}
}
#[test]
fn missing_warn_pattern() {
let s = r"
use std::mem;
fn main() {
let _x: &i32 = unsafe { mem::transmute(16usize) }; //~ ERROR encountered a dangling reference (address 0x10 is unallocated)
//~^ WARN cake
}
";
let comments = Comments::parse(Path::new("<dummy>"), s);
let config = config();
let messages= vec![
vec![],
vec![],
vec![],
vec![],
vec![],
vec![
Message {
message: "Undefined Behavior: type validation failed: encountered a dangling reference (address 0x10 is unallocated)".to_string(),
level: Level::Error,
},
Message {
message: "kaboom".to_string(),
level: Level::Warn,
},
Message {
message: "cake".to_string(),
level: Level::Warn,
},
],
];
let mut errors = vec![];
check_annotations(messages, vec![], Path::new("moobar"), &mut errors, &config, "", &comments);
match &errors[..] {
[Error::ErrorsWithoutPattern { path: Some((_, 5)), msgs, .. }] =>
match &msgs[..] {
[Message { message, level: Level::Warn }] if message == "kaboom" => {}
_ => panic!("{:#?}", msgs),
},
_ => panic!("{:#?}", errors),
}
}
#[test]
fn missing_implicit_warn_pattern() {
let s = r"
use std::mem;
fn main() {
let _x: &i32 = unsafe { mem::transmute(16usize) }; //~ ERROR encountered a dangling reference (address 0x10 is unallocated)
//~^ cake
}
";
let comments = Comments::parse(Path::new("<dummy>"), s);
let config = config();
let messages = vec![
vec![],
vec![],
vec![],
vec![],
vec![],
vec![
Message {
message: "Undefined Behavior: type validation failed: encountered a dangling reference (address 0x10 is unallocated)".to_string(),
level: Level::Error,
},
Message {
message: "kaboom".to_string(),
level: Level::Warn,
},
Message {
message: "cake".to_string(),
level: Level::Warn,
},
],
];
let mut errors = vec![];
check_annotations(messages, vec![], Path::new("moobar"), &mut errors, &config, "", &comments);
match &errors[..] {
[] => {}
_ => panic!("{:#?}", errors),
}
}
#[test]
fn implicit_err_pattern() {
let s = r"
use std::mem;
fn main() {
let _x: &i32 = unsafe { mem::transmute(16usize) }; //~ encountered a dangling reference (address 0x10 is unallocated)
}
";
let comments = Comments::parse(Path::new("<dummy>"), s);
let config = config();
let messages = vec![
vec![],
vec![],
vec![],
vec![],
vec![],
vec![
Message {
message: "Undefined Behavior: type validation failed: encountered a dangling reference (address 0x10 is unallocated)".to_string(),
level: Level::Error,
},
],
];
let mut errors = vec![];
check_annotations(messages, vec![], Path::new("moobar"), &mut errors, &config, "", &comments);
match &errors[..] {
[Error::ErrorPatternWithoutErrorAnnotation(_, 5)] => {}
_ => panic!("{:#?}", errors),
} }
} }