//! Assorted testing utilities. //! //! Most notable things are: //! //! * Rich text comparison, which outputs a diff. //! * Extracting markup (mainly, `<|>` markers) out of fixture strings. //! * marks (see the eponymous module). #[macro_use] pub mod marks; use std::{ fs, path::{Path, PathBuf}, }; use serde_json::Value; use text_unit::{TextRange, TextUnit}; pub use difference::Changeset as __Changeset; pub const CURSOR_MARKER: &str = "<|>"; #[macro_export] macro_rules! assert_eq_text { ($left:expr, $right:expr) => { assert_eq_text!($left, $right,) }; ($left:expr, $right:expr, $($tt:tt)*) => {{ let left = $left; let right = $right; if left != right { if left.trim() == right.trim() { eprintln!("Left:\n{:?}\n\nRight:\n{:?}\n\nWhitespace difference\n", left, right); } else { let changeset = $crate::__Changeset::new(right, left, "\n"); eprintln!("Left:\n{}\n\nRight:\n{}\n\nDiff:\n{}\n", left, right, changeset); } eprintln!($($tt)*); panic!("text differs"); } }}; } pub fn extract_offset(text: &str) -> (TextUnit, String) { match try_extract_offset(text) { None => panic!("text should contain cursor marker"), Some(result) => result, } } fn try_extract_offset(text: &str) -> Option<(TextUnit, String)> { let cursor_pos = text.find(CURSOR_MARKER)?; let mut new_text = String::with_capacity(text.len() - CURSOR_MARKER.len()); new_text.push_str(&text[..cursor_pos]); new_text.push_str(&text[cursor_pos + CURSOR_MARKER.len()..]); let cursor_pos = TextUnit::from(cursor_pos as u32); Some((cursor_pos, new_text)) } pub fn extract_range(text: &str) -> (TextRange, String) { match try_extract_range(text) { None => panic!("text should contain cursor marker"), Some(result) => result, } } fn try_extract_range(text: &str) -> Option<(TextRange, String)> { let (start, text) = try_extract_offset(text)?; let (end, text) = try_extract_offset(&text)?; Some((TextRange::from_to(start, end), text)) } pub enum RangeOrOffset { Range(TextRange), Offset(TextUnit), } impl From for TextRange { fn from(selection: RangeOrOffset) -> Self { match selection { RangeOrOffset::Range(it) => it, RangeOrOffset::Offset(it) => TextRange::from_to(it, it), } } } pub fn extract_range_or_offset(text: &str) -> (RangeOrOffset, String) { if let Some((range, text)) = try_extract_range(text) { return (RangeOrOffset::Range(range), text); } let (offset, text) = extract_offset(text); (RangeOrOffset::Offset(offset), text) } /// Extracts ranges, marked with ` ` paris from the `text` pub fn extract_ranges(mut text: &str, tag: &str) -> (Vec, String) { let open = format!("<{}>", tag); let close = format!("", tag); let mut ranges = Vec::new(); let mut res = String::new(); let mut stack = Vec::new(); loop { match text.find('<') { None => { res.push_str(text); break; } Some(i) => { res.push_str(&text[..i]); text = &text[i..]; if text.starts_with(&open) { text = &text[open.len()..]; let from = TextUnit::of_str(&res); stack.push(from); } else if text.starts_with(&close) { text = &text[close.len()..]; let from = stack.pop().unwrap_or_else(|| panic!("unmatched ", tag)); let to = TextUnit::of_str(&res); ranges.push(TextRange::from_to(from, to)); } } } } assert!(stack.is_empty(), "unmatched <{}>", tag); ranges.sort_by_key(|r| (r.start(), r.end())); (ranges, res) } pub fn add_cursor(text: &str, offset: TextUnit) -> String { let offset: u32 = offset.into(); let offset: usize = offset as usize; let mut res = String::new(); res.push_str(&text[..offset]); res.push_str("<|>"); res.push_str(&text[offset..]); res } #[derive(Debug)] pub struct FixtureEntry { pub meta: String, pub text: String, } /// Parses text which looks like this: /// /// ```not_rust /// //- some meta /// line 1 /// line 2 /// // - other meta /// ``` pub fn parse_fixture(fixture: &str) -> Vec { let mut res = Vec::new(); let mut buf = String::new(); let mut meta: Option<&str> = None; macro_rules! flush { () => { if let Some(meta) = meta { res.push(FixtureEntry { meta: meta.to_string(), text: buf.clone() }); buf.clear(); } }; }; let margin = fixture .lines() .filter(|it| it.trim_start().starts_with("//-")) .map(|it| it.len() - it.trim_start().len()) .next() .expect("empty fixture"); let lines = fixture .split('\n') // don't use `.lines` to not drop `\r\n` .filter_map(|line| { if line.len() >= margin { assert!(line[..margin].trim().is_empty()); Some(&line[margin..]) } else { assert!(line.trim().is_empty()); None } }); for line in lines { if line.starts_with("//-") { flush!(); buf.clear(); meta = Some(line["//-".len()..].trim()); continue; } buf.push_str(line); buf.push('\n'); } flush!(); res } // Comparison functionality borrowed from cargo: /// Compare a line with an expected pattern. /// - Use `[..]` as a wildcard to match 0 or more characters on the same line /// (similar to `.*` in a regex). pub fn lines_match(expected: &str, actual: &str) -> bool { // Let's not deal with / vs \ (windows...) // First replace backslash-escaped backslashes with forward slashes // which can occur in, for example, JSON output let expected = expected.replace("\\\\", "/").replace("\\", "/"); let mut actual: &str = &actual.replace("\\\\", "/").replace("\\", "/"); for (i, part) in expected.split("[..]").enumerate() { match actual.find(part) { Some(j) => { if i == 0 && j != 0 { return false; } actual = &actual[j + part.len()..]; } None => return false, } } actual.is_empty() || expected.ends_with("[..]") } #[test] fn lines_match_works() { assert!(lines_match("a b", "a b")); assert!(lines_match("a[..]b", "a b")); assert!(lines_match("a[..]", "a b")); assert!(lines_match("[..]", "a b")); assert!(lines_match("[..]b", "a b")); assert!(!lines_match("[..]b", "c")); assert!(!lines_match("b", "c")); assert!(!lines_match("b", "cb")); } // Compares JSON object for approximate equality. // You can use `[..]` wildcard in strings (useful for OS dependent things such // as paths). You can use a `"{...}"` string literal as a wildcard for // arbitrary nested JSON (useful for parts of object emitted by other programs // (e.g. rustc) rather than Cargo itself). Arrays are sorted before comparison. pub fn find_mismatch<'a>(expected: &'a Value, actual: &'a Value) -> Option<(&'a Value, &'a Value)> { use serde_json::Value::*; match (expected, actual) { (&Number(ref l), &Number(ref r)) if l == r => None, (&Bool(l), &Bool(r)) if l == r => None, (&String(ref l), &String(ref r)) if lines_match(l, r) => None, (&Array(ref l), &Array(ref r)) => { if l.len() != r.len() { return Some((expected, actual)); } let mut l = l.iter().collect::>(); let mut r = r.iter().collect::>(); l.retain(|l| match r.iter().position(|r| find_mismatch(l, r).is_none()) { Some(i) => { r.remove(i); false } None => true, }); if !l.is_empty() { assert!(!r.is_empty()); Some((&l[0], &r[0])) } else { assert_eq!(r.len(), 0); None } } (&Object(ref l), &Object(ref r)) => { let same_keys = l.len() == r.len() && l.keys().all(|k| r.contains_key(k)); if !same_keys { return Some((expected, actual)); } l.values().zip(r.values()).filter_map(|(l, r)| find_mismatch(l, r)).nth(0) } (&Null, &Null) => None, // magic string literal "{...}" acts as wildcard for any sub-JSON (&String(ref l), _) if l == "{...}" => None, _ => Some((expected, actual)), } } pub fn dir_tests(test_data_dir: &Path, paths: &[&str], f: F) where F: Fn(&str, &Path) -> String, { for (path, input_code) in collect_tests(test_data_dir, paths) { let parse_tree = f(&input_code, &path); let path = path.with_extension("txt"); if !path.exists() { println!("\nfile: {}", path.display()); println!("No .txt file with expected result, creating...\n"); println!("{}\n{}", input_code, parse_tree); fs::write(&path, &parse_tree).unwrap(); panic!("No expected result") } let expected = read_text(&path); let expected = expected.as_str(); let parse_tree = parse_tree.as_str(); assert_equal_text(expected, parse_tree, &path); } } pub fn collect_tests(test_data_dir: &Path, paths: &[&str]) -> Vec<(PathBuf, String)> { paths .iter() .flat_map(|path| { let path = test_data_dir.to_owned().join(path); test_from_dir(&path).into_iter() }) .map(|path| { let text = read_text(&path); (path, text) }) .collect() } fn test_from_dir(dir: &Path) -> Vec { let mut acc = Vec::new(); for file in fs::read_dir(&dir).unwrap() { let file = file.unwrap(); let path = file.path(); if path.extension().unwrap_or_default() == "rs" { acc.push(path); } } acc.sort(); acc } pub fn project_dir() -> PathBuf { let dir = env!("CARGO_MANIFEST_DIR"); PathBuf::from(dir).parent().unwrap().parent().unwrap().to_owned() } /// Read file and normalize newlines. /// /// `rustc` seems to always normalize `\r\n` newlines to `\n`: /// /// ``` /// let s = " /// "; /// assert_eq!(s.as_bytes(), &[10]); /// ``` /// /// so this should always be correct. pub fn read_text(path: &Path) -> String { fs::read_to_string(path) .unwrap_or_else(|_| panic!("File at {:?} should be valid", path)) .replace("\r\n", "\n") } const REWRITE: bool = false; fn assert_equal_text(expected: &str, actual: &str, path: &Path) { if expected == actual { return; } let dir = project_dir(); let pretty_path = path.strip_prefix(&dir).unwrap_or_else(|_| path); if expected.trim() == actual.trim() { println!("whitespace difference, rewriting"); println!("file: {}\n", pretty_path.display()); fs::write(path, actual).unwrap(); return; } if REWRITE { println!("rewriting {}", pretty_path.display()); fs::write(path, actual).unwrap(); return; } assert_eq_text!(expected, actual, "file: {}", pretty_path.display()); }