|
| 1 | +// This tests checks that if a path is defined for an entity in the standard |
| 2 | +// library, the proper prefix is used and a reference to a PR against |
| 3 | +// `rust-lang/rust` is mentionned. |
| 4 | + |
| 5 | +// This test is a no-op if run as part of the compiler test suite |
| 6 | +// and will always succeed. |
| 7 | + |
| 8 | +use itertools::Itertools; |
| 9 | +use regex::Regex; |
| 10 | +use std::io; |
| 11 | + |
| 12 | +const PATHS_FILE: &str = "clippy_utils/src/paths.rs"; |
| 13 | + |
| 14 | +fn parse_content(content: &str) -> Vec<String> { |
| 15 | + let comment_re = Regex::new(r"^// `sym::(.*)` added in <https://github.com/rust-lang/rust/pull/\d+>$").unwrap(); |
| 16 | + let path_re = |
| 17 | + Regex::new(r"^pub static ([A-Z_]+): PathLookup = (?:macro|type|value)_path!\((([a-z]+)::.*)\);").unwrap(); |
| 18 | + let mut errors = vec![]; |
| 19 | + for (prev, line) in content.lines().tuple_windows() { |
| 20 | + if let Some(caps) = path_re.captures(line) { |
| 21 | + if ["alloc", "core", "std"].contains(&&caps[3]) && !caps[1].starts_with("DIAG_ITEM_") { |
| 22 | + errors.push(format!( |
| 23 | + "Path `{}` for `{}` should start with `DIAG_ITEM`", |
| 24 | + &caps[1], &caps[2] |
| 25 | + )); |
| 26 | + continue; |
| 27 | + } |
| 28 | + if let Some(upper) = caps[1].strip_prefix("DIAG_ITEM_") { |
| 29 | + let Some(comment) = comment_re.captures(prev) else { |
| 30 | + errors.push(format!( |
| 31 | + "Definition for `{}` should be preceded by PR-related comment", |
| 32 | + &caps[1] |
| 33 | + )); |
| 34 | + continue; |
| 35 | + }; |
| 36 | + let upper_sym = comment[1].to_uppercase(); |
| 37 | + if upper != upper_sym { |
| 38 | + errors.push(format!( |
| 39 | + "Path for symbol `{}` should be named `DIAG_ITEM_{}`", |
| 40 | + &comment[1], upper_sym |
| 41 | + )); |
| 42 | + } |
| 43 | + } |
| 44 | + } |
| 45 | + } |
| 46 | + errors |
| 47 | +} |
| 48 | + |
| 49 | +#[test] |
| 50 | +fn stdlib_diag_items() -> Result<(), io::Error> { |
| 51 | + if option_env!("RUSTC_TEST_SUITE").is_some() { |
| 52 | + return Ok(()); |
| 53 | + } |
| 54 | + |
| 55 | + let diagnostics = parse_content(&std::fs::read_to_string(PATHS_FILE)?); |
| 56 | + if diagnostics.is_empty() { |
| 57 | + Ok(()) |
| 58 | + } else { |
| 59 | + eprintln!("Issues found in {PATHS_FILE}:"); |
| 60 | + for diag in diagnostics { |
| 61 | + eprintln!("- {diag}"); |
| 62 | + } |
| 63 | + Err(io::Error::other("problems found")) |
| 64 | + } |
| 65 | +} |
| 66 | + |
| 67 | +#[test] |
| 68 | +fn internal_diag_items_test() { |
| 69 | + let content = r" |
| 70 | +// Missing comment |
| 71 | +pub static DIAG_ITEM_IO_ERROR_NEW: PathLookup = value_path!(std::io::Error::new); |
| 72 | +
|
| 73 | +// Wrong static name |
| 74 | +// `sym::io_error` added in <https://github.com/rust-lang/rust/pull/142787> |
| 75 | +pub static DIAG_ITEM_ERROR: PathLookup = value_path!(std::io::Error); |
| 76 | +
|
| 77 | +// Missing DIAG_ITEM |
| 78 | +// `sym::io_foobar` added in <https://github.com/rust-lang/rust/pull/142787> |
| 79 | +pub static IO_FOOBAR_PATH: PathLookup = value_path!(std::io); |
| 80 | +"; |
| 81 | + |
| 82 | + let diags = parse_content(content); |
| 83 | + let diags = diags.iter().map(String::as_str).collect::<Vec<_>>(); |
| 84 | + assert_eq!( |
| 85 | + diags.as_slice(), |
| 86 | + [ |
| 87 | + "Definition for `DIAG_ITEM_IO_ERROR_NEW` should be preceded by PR-related comment", |
| 88 | + "Path for symbol `io_error` should be named `DIAG_ITEM_IO_ERROR`", |
| 89 | + "Path `IO_FOOBAR_PATH` for `std::io` should start with `DIAG_ITEM`" |
| 90 | + ] |
| 91 | + ); |
| 92 | +} |
0 commit comments