tests/system.rs

   1 // Copyright 2015 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 #[macro_use]
  12 extern crate log;
  13 extern crate regex;
  14 extern crate rustfmt_nightly as rustfmt;
  15 extern crate term;
  16
  17 use std::collections::HashMap;
  18 use std::fs;
  19 use std::io::{self, BufRead, BufReader, Read, Write};
  20 use std::path::{Path, PathBuf};
  21 use std::process::{Command, Stdio};
  22
  23 use rustfmt::*;
  24 use rustfmt::filemap::{write_system_newlines, FileMap};
  25 use rustfmt::config::{Config, ReportTactic};
  26 use rustfmt::rustfmt_diff::*;
  27
  28 const DIFF_CONTEXT_SIZE: usize = 3;
  29
  30 fn get_path_string(dir_entry: io::Result<fs::DirEntry>) -> String {
  31     let path = dir_entry.expect("Couldn't get DirEntry").path();
  32
  33     path.to_str().expect("Couldn't stringify path").to_owned()
  34 }
  35
  36 // Integration tests. The files in the tests/source are formatted and compared
  37 // to their equivalent in tests/target. The target file and config can be
  38 // overridden by annotations in the source file. The input and output must match
  39 // exactly.
  40 #[test]
  41 fn system_tests() {
  42     // Get all files in the tests/source directory.
  43     let files = fs::read_dir("tests/source").expect("Couldn't read source dir");
  44     // Turn a DirEntry into a String that represents the relative path to the
  45     // file.
  46     let files = files.map(get_path_string);
  47     let (_reports, count, fails) = check_files(files);
  48
  49     // Display results.
  50     println!("Ran {} system tests.", count);
  51     assert_eq!(fails, 0, "{} system tests failed", fails);
  52 }
  53
  54 // Do the same for tests/coverage-source directory
  55 // the only difference is the coverage mode
  56 #[test]
  57 fn coverage_tests() {
  58     let files = fs::read_dir("tests/coverage/source").expect("Couldn't read source dir");
  59     let files = files.map(get_path_string);
  60     let (_reports, count, fails) = check_files(files);
  61
  62     println!("Ran {} tests in coverage mode.", count);
  63     assert_eq!(fails, 0, "{} tests failed", fails);
  64 }
  65
  66 #[test]
  67 fn checkstyle_test() {
  68     let filename = "tests/writemode/source/fn-single-line.rs";
  69     let expected_filename = "tests/writemode/target/checkstyle.xml";
  70     assert_output(filename, expected_filename);
  71 }
  72
  73
  74 // Helper function for comparing the results of rustfmt
  75 // to a known output file generated by one of the write modes.
  76 fn assert_output(source: &str, expected_filename: &str) {
  77     let config = read_config(source);
  78     let (file_map, _report) = format_file(source, &config);
  79
  80     // Populate output by writing to a vec.
  81     let mut out = vec![];
  82     let _ = filemap::write_all_files(&file_map, &mut out, &config);
  83     let output = String::from_utf8(out).unwrap();
  84
  85     let mut expected_file = fs::File::open(&expected_filename).expect("Couldn't open target");
  86     let mut expected_text = String::new();
  87     expected_file
  88         .read_to_string(&mut expected_text)
  89         .expect("Failed reading target");
  90
  91     let compare = make_diff(&expected_text, &output, DIFF_CONTEXT_SIZE);
  92     if !compare.is_empty() {
  93         let mut failures = HashMap::new();
  94         failures.insert(source.to_string(), compare);
  95         print_mismatches(failures);
  96         assert!(false, "Text does not match expected output");
  97     }
  98 }
  99
 100 // Idempotence tests. Files in tests/target are checked to be unaltered by
 101 // rustfmt.
 102 #[test]
 103 fn idempotence_tests() {
 104     // Get all files in the tests/target directory.
 105     let files = fs::read_dir("tests/target")
 106         .expect("Couldn't read target dir")
 107         .map(get_path_string);
 108     let (_reports, count, fails) = check_files(files);
 109
 110     // Display results.
 111     println!("Ran {} idempotent tests.", count);
 112     assert_eq!(fails, 0, "{} idempotent tests failed", fails);
 113 }
 114
 115 // Run rustfmt on itself. This operation must be idempotent. We also check that
 116 // no warnings are emitted.
 117 #[test]
 118 fn self_tests() {
 119     let files = fs::read_dir("src/bin")
 120         .expect("Couldn't read src dir")
 121         .chain(fs::read_dir("tests").expect("Couldn't read tests dir"))
 122         .map(get_path_string);
 123     // Hack because there's no `IntoIterator` impl for `[T; N]`.
 124     let files = files.chain(Some("src/lib.rs".to_owned()).into_iter());
 125     let files = files.chain(Some("build.rs".to_owned()).into_iter());
 126
 127     let (reports, count, fails) = check_files(files);
 128     let mut warnings = 0;
 129
 130     // Display results.
 131     println!("Ran {} self tests.", count);
 132     assert_eq!(fails, 0, "{} self tests failed", fails);
 133
 134     for format_report in reports {
 135         println!("{}", format_report);
 136         warnings += format_report.warning_count();
 137     }
 138
 139     assert_eq!(
 140         warnings,
 141         0,
 142         "Rustfmt's code generated {} warnings",
 143         warnings
 144     );
 145 }
 146
 147 #[test]
 148 fn stdin_formatting_smoke_test() {
 149     let input = Input::Text("fn main () {}".to_owned());
 150     let config = Config::default();
 151     let (error_summary, file_map, _report) =
 152         format_input::<io::Stdout>(input, &config, None).unwrap();
 153     assert!(error_summary.has_no_errors());
 154     for &(ref file_name, ref text) in &file_map {
 155         if file_name == "stdin" {
 156             assert_eq!(text.to_string(), "fn main() {}\n");
 157             return;
 158         }
 159     }
 160     panic!("no stdin");
 161 }
 162
 163 #[test]
 164 fn stdin_disable_all_formatting_test() {
 165     let input = String::from("fn main() { println!(\"This should not be formatted.\"); }");
 166     let mut child = Command::new("./target/debug/rustfmt")
 167         .stdin(Stdio::piped())
 168         .stdout(Stdio::piped())
 169         .arg("--config-path=./tests/config/disable_all_formatting.toml")
 170         .spawn()
 171         .expect("failed to execute child");
 172
 173     {
 174         let stdin = child.stdin.as_mut().expect("failed to get stdin");
 175         stdin
 176             .write_all(input.as_bytes())
 177             .expect("failed to write stdin");
 178     }
 179     let output = child.wait_with_output().expect("failed to wait on child");
 180     assert!(output.status.success());
 181     assert!(output.stderr.is_empty());
 182     assert_eq!(input, String::from_utf8(output.stdout).unwrap());
 183 }
 184
 185 #[test]
 186 fn format_lines_errors_are_reported() {
 187     let long_identifier = String::from_utf8(vec![b'a'; 239]).unwrap();
 188     let input = Input::Text(format!("fn {}() {{}}", long_identifier));
 189     let config = Config::default();
 190     let (error_summary, _file_map, _report) =
 191         format_input::<io::Stdout>(input, &config, None).unwrap();
 192     assert!(error_summary.has_formatting_errors());
 193 }
 194
 195 // For each file, run rustfmt and collect the output.
 196 // Returns the number of files checked and the number of failures.
 197 fn check_files<I>(files: I) -> (Vec<FormatReport>, u32, u32)
 198 where
 199     I: Iterator<Item = String>,
 200 {
 201     let mut count = 0;
 202     let mut fails = 0;
 203     let mut reports = vec![];
 204
 205     for file_name in files.filter(|f| f.ends_with(".rs")) {
 206         debug!("Testing '{}'...", file_name);
 207
 208         match idempotent_check(file_name) {
 209             Ok(ref report) if report.has_warnings() => {
 210                 print!("{}", report);
 211                 fails += 1;
 212             }
 213             Ok(report) => reports.push(report),
 214             Err(msg) => {
 215                 print_mismatches(msg);
 216                 fails += 1;
 217             }
 218         }
 219
 220         count += 1;
 221     }
 222
 223     (reports, count, fails)
 224 }
 225
 226 fn print_mismatches(result: HashMap<String, Vec<Mismatch>>) {
 227     let mut t = term::stdout().unwrap();
 228
 229     for (file_name, diff) in result {
 230         print_diff(diff, |line_num| {
 231             format!("\nMismatch at {}:{}:", file_name, line_num)
 232         });
 233     }
 234
 235     t.reset().unwrap();
 236 }
 237
 238 fn read_config(filename: &str) -> Config {
 239     let sig_comments = read_significant_comments(filename);
 240     // Look for a config file... If there is a 'config' property in the significant comments, use
 241     // that. Otherwise, if there are no significant comments at all, look for a config file with
 242     // the same name as the test file.
 243     let mut config = if !sig_comments.is_empty() {
 244         get_config(sig_comments.get("config").map(|x| &(*x)[..]))
 245     } else {
 246         get_config(
 247             Path::new(filename)
 248                 .with_extension("toml")
 249                 .file_name()
 250                 .and_then(std::ffi::OsStr::to_str),
 251         )
 252     };
 253
 254     for (key, val) in &sig_comments {
 255         if key != "target" && key != "config" {
 256             config.override_value(key, val);
 257         }
 258     }
 259
 260     // Don't generate warnings for to-do items.
 261     config.set().report_todo(ReportTactic::Never);
 262
 263     config
 264 }
 265
 266 fn format_file<P: Into<PathBuf>>(filepath: P, config: &Config) -> (FileMap, FormatReport) {
 267     let filepath = filepath.into();
 268     let input = Input::File(filepath);
 269     let (_error_summary, file_map, report) =
 270         format_input::<io::Stdout>(input, config, None).unwrap();
 271     (file_map, report)
 272 }
 273
 274 pub fn idempotent_check(filename: String) -> Result<FormatReport, HashMap<String, Vec<Mismatch>>> {
 275     let sig_comments = read_significant_comments(&filename);
 276     let config = read_config(&filename);
 277     let (file_map, format_report) = format_file(filename, &config);
 278
 279     let mut write_result = HashMap::new();
 280     for &(ref filename, ref text) in &file_map {
 281         let mut v = Vec::new();
 282         // Won't panic, as we're not doing any IO.
 283         write_system_newlines(&mut v, text, &config).unwrap();
 284         // Won't panic, we are writing correct utf8.
 285         let one_result = String::from_utf8(v).unwrap();
 286         write_result.insert(filename.clone(), one_result);
 287     }
 288
 289     let target = sig_comments.get("target").map(|x| &(*x)[..]);
 290
 291     handle_result(write_result, target).map(|_| format_report)
 292 }
 293
 294 // Reads test config file using the supplied (optional) file name. If there's no file name or the
 295 // file doesn't exist, just return the default config. Otherwise, the file must be read
 296 // successfully.
 297 fn get_config(config_file: Option<&str>) -> Config {
 298     let config_file_name = match config_file {
 299         None => return Default::default(),
 300         Some(file_name) => {
 301             let mut full_path = "tests/config/".to_owned();
 302             full_path.push_str(file_name);
 303             if !Path::new(&full_path).exists() {
 304                 return Default::default();
 305             };
 306             full_path
 307         }
 308     };
 309
 310     let mut def_config_file = fs::File::open(config_file_name).expect("Couldn't open config");
 311     let mut def_config = String::new();
 312     def_config_file
 313         .read_to_string(&mut def_config)
 314         .expect("Couldn't read config");
 315
 316     Config::from_toml(&def_config).expect("Invalid toml")
 317 }
 318
 319 // Reads significant comments of the form: // rustfmt-key: value
 320 // into a hash map.
 321 fn read_significant_comments(file_name: &str) -> HashMap<String, String> {
 322     let file = fs::File::open(file_name).expect(&format!("Couldn't read file {}", file_name));
 323     let reader = BufReader::new(file);
 324     let pattern = r"^\s*//\s*rustfmt-([^:]+):\s*(\S+)";
 325     let regex = regex::Regex::new(pattern).expect("Failed creating pattern 1");
 326
 327     // Matches lines containing significant comments or whitespace.
 328     let line_regex = regex::Regex::new(r"(^\s*$)|(^\s*//\s*rustfmt-[^:]+:\s*\S+)")
 329         .expect("Failed creating pattern 2");
 330
 331     reader
 332         .lines()
 333         .map(|line| line.expect("Failed getting line"))
 334         .take_while(|line| line_regex.is_match(line))
 335         .filter_map(|line| {
 336             regex.captures_iter(&line).next().map(|capture| {
 337                 (
 338                     capture
 339                         .get(1)
 340                         .expect("Couldn't unwrap capture")
 341                         .as_str()
 342                         .to_owned(),
 343                     capture
 344                         .get(2)
 345                         .expect("Couldn't unwrap capture")
 346                         .as_str()
 347                         .to_owned(),
 348                 )
 349             })
 350         })
 351         .collect()
 352 }
 353
 354 // Compare output to input.
 355 // TODO: needs a better name, more explanation.
 356 fn handle_result(
 357     result: HashMap<String, String>,
 358     target: Option<&str>,
 359 ) -> Result<(), HashMap<String, Vec<Mismatch>>> {
 360     let mut failures = HashMap::new();
 361
 362     for (file_name, fmt_text) in result {
 363         // If file is in tests/source, compare to file with same name in tests/target.
 364         let target = get_target(&file_name, target);
 365         let open_error = format!("Couldn't open target {:?}", &target);
 366         let mut f = fs::File::open(&target).expect(&open_error);
 367
 368         let mut text = String::new();
 369         let read_error = format!("Failed reading target {:?}", &target);
 370         f.read_to_string(&mut text).expect(&read_error);
 371
 372         if fmt_text != text {
 373             let diff = make_diff(&text, &fmt_text, DIFF_CONTEXT_SIZE);
 374             assert!(
 375                 !diff.is_empty(),
 376                 "Empty diff? Maybe due to a missing a newline at the end of a file?"
 377             );
 378             failures.insert(file_name, diff);
 379         }
 380     }
 381
 382     if failures.is_empty() {
 383         Ok(())
 384     } else {
 385         Err(failures)
 386     }
 387 }
 388
 389 // Map source file paths to their target paths.
 390 fn get_target(file_name: &str, target: Option<&str>) -> String {
 391     if file_name.contains("source") {
 392         let target_file_name = file_name.replace("source", "target");
 393         if let Some(replace_name) = target {
 394             Path::new(&target_file_name)
 395                 .with_file_name(replace_name)
 396                 .into_os_string()
 397                 .into_string()
 398                 .unwrap()
 399         } else {
 400             target_file_name
 401         }
 402     } else {
 403         // This is either and idempotence check or a self check
 404         file_name.to_owned()
 405     }
 406 }
 407
 408 #[test]
 409 fn rustfmt_diff_make_diff_tests() {
 410     let diff = make_diff("a\nb\nc\nd", "a\ne\nc\nd", 3);
 411     assert_eq!(
 412         diff,
 413         vec![
 414             Mismatch {
 415                 line_number: 1,
 416                 lines: vec![
 417                     DiffLine::Context("a".into()),
 418                     DiffLine::Resulting("b".into()),
 419                     DiffLine::Expected("e".into()),
 420                     DiffLine::Context("c".into()),
 421                     DiffLine::Context("d".into()),
 422                 ],
 423             },
 424         ]
 425     );
 426 }
 427
 428 #[test]
 429 fn rustfmt_diff_no_diff_test() {
 430     let diff = make_diff("a\nb\nc\nd", "a\nb\nc\nd", 3);
 431     assert_eq!(diff, vec![]);
 432 }