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 extern crate rustfmt;
  12 extern crate diff;
  13 extern crate regex;
  14 extern crate term;
  15
  16 use std::collections::HashMap;
  17 use std::fs;
  18 use std::io::{self, Read, BufRead, BufReader};
  19 use std::path::{Path, PathBuf};
  20
  21 use rustfmt::*;
  22 use rustfmt::filemap::{write_system_newlines, FileMap};
  23 use rustfmt::config::{Config, ReportTactic};
  24 use rustfmt::rustfmt_diff::*;
  25
  26 const DIFF_CONTEXT_SIZE: usize = 3;
  27
  28 fn get_path_string(dir_entry: io::Result<fs::DirEntry>) -> String {
  29     let path = dir_entry.expect("Couldn't get DirEntry").path();
  30
  31     path.to_str().expect("Couldn't stringify path").to_owned()
  32 }
  33
  34 // Integration tests. The files in the tests/source are formatted and compared
  35 // to their equivalent in tests/target. The target file and config can be
  36 // overridden by annotations in the source file. The input and output must match
  37 // exactly.
  38 // FIXME(#28) would be good to check for error messages and fail on them, or at
  39 // least report.
  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!(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!(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.len() > 0 {
  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!(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!(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!(warnings == 0,
 140             "Rustfmt's code generated {} warnings",
 141             warnings);
 142 }
 143
 144 #[test]
 145 fn stdin_formatting_smoke_test() {
 146     let input = Input::Text("fn main () {}".to_owned());
 147     let config = Config::default();
 148     let (error_summary, file_map, _report) = format_input::<io::Stdout>(input, &config, None)
 149         .unwrap();
 150     assert!(error_summary.has_no_errors());
 151     for &(ref file_name, ref text) in &file_map {
 152         if file_name == "stdin" {
 153             assert!(text.to_string() == "fn main() {}\n");
 154             return;
 155         }
 156     }
 157     panic!("no stdin");
 158 }
 159
 160 #[test]
 161 fn format_lines_errors_are_reported() {
 162     let long_identifier = String::from_utf8(vec![b'a'; 239]).unwrap();
 163     let input = Input::Text(format!("fn {}() {{}}", long_identifier));
 164     let config = Config::default();
 165     let (error_summary, _file_map, _report) = format_input::<io::Stdout>(input, &config, None)
 166         .unwrap();
 167     assert!(error_summary.has_formatting_errors());
 168 }
 169
 170 // For each file, run rustfmt and collect the output.
 171 // Returns the number of files checked and the number of failures.
 172 fn check_files<I>(files: I) -> (Vec<FormatReport>, u32, u32)
 173     where I: Iterator<Item = String>
 174 {
 175     let mut count = 0;
 176     let mut fails = 0;
 177     let mut reports = vec![];
 178
 179     for file_name in files.filter(|f| f.ends_with(".rs")) {
 180         println!("Testing '{}'...", file_name);
 181
 182         match idempotent_check(file_name) {
 183             Ok(ref report) if report.has_warnings() => {
 184                 print!("{}", report);
 185                 fails += 1;
 186             }
 187             Ok(report) => reports.push(report),
 188             Err(msg) => {
 189                 print_mismatches(msg);
 190                 fails += 1;
 191             }
 192         }
 193
 194         count += 1;
 195     }
 196
 197     (reports, count, fails)
 198 }
 199
 200 fn print_mismatches(result: HashMap<String, Vec<Mismatch>>) {
 201     let mut t = term::stdout().unwrap();
 202
 203     for (file_name, diff) in result {
 204         print_diff(diff,
 205                    |line_num| format!("\nMismatch at {}:{}:", file_name, line_num));
 206     }
 207
 208     t.reset().unwrap();
 209 }
 210
 211 fn read_config(filename: &str) -> Config {
 212     let sig_comments = read_significant_comments(&filename);
 213     // Look for a config file... If there is a 'config' property in the significant comments, use
 214     // that. Otherwise, if there are no significant comments at all, look for a config file with
 215     // the same name as the test file.
 216     let mut config = if !sig_comments.is_empty() {
 217         get_config(sig_comments.get("config").map(|x| &(*x)[..]))
 218     } else {
 219         get_config(Path::new(filename)
 220                        .with_extension("toml")
 221                        .file_name()
 222                        .and_then(std::ffi::OsStr::to_str))
 223     };
 224
 225     for (key, val) in &sig_comments {
 226         if key != "target" && key != "config" {
 227             config.override_value(key, val);
 228         }
 229     }
 230
 231     // Don't generate warnings for to-do items.
 232     config.report_todo = ReportTactic::Never;
 233
 234     config
 235 }
 236
 237 fn format_file<P: Into<PathBuf>>(filename: P, config: &Config) -> (FileMap, FormatReport) {
 238     let input = Input::File(filename.into());
 239     let (_error_summary, file_map, report) = format_input::<io::Stdout>(input, &config, None)
 240         .unwrap();
 241     return (file_map, report);
 242 }
 243
 244 pub fn idempotent_check(filename: String) -> Result<FormatReport, HashMap<String, Vec<Mismatch>>> {
 245     let sig_comments = read_significant_comments(&filename);
 246     let config = read_config(&filename);
 247     let (file_map, format_report) = format_file(filename, &config);
 248
 249     let mut write_result = HashMap::new();
 250     for &(ref filename, ref text) in &file_map {
 251         let mut v = Vec::new();
 252         // Won't panic, as we're not doing any IO.
 253         write_system_newlines(&mut v, text, &config).unwrap();
 254         // Won't panic, we are writing correct utf8.
 255         let one_result = String::from_utf8(v).unwrap();
 256         write_result.insert(filename.clone(), one_result);
 257     }
 258
 259     let target = sig_comments.get("target").map(|x| &(*x)[..]);
 260
 261     handle_result(write_result, target).map(|_| format_report)
 262 }
 263
 264 // Reads test config file using the supplied (optional) file name. If there's no file name or the
 265 // file doesn't exist, just return the default config. Otherwise, the file must be read
 266 // successfully.
 267 fn get_config(config_file: Option<&str>) -> Config {
 268     let config_file_name = match config_file {
 269         None => return Default::default(),
 270         Some(file_name) => {
 271             let mut full_path = "tests/config/".to_owned();
 272             full_path.push_str(&file_name);
 273             if !Path::new(&full_path).exists() {
 274                 return Default::default();
 275             };
 276             full_path
 277         }
 278     };
 279
 280     let mut def_config_file = fs::File::open(config_file_name).expect("Couldn't open config");
 281     let mut def_config = String::new();
 282     def_config_file
 283         .read_to_string(&mut def_config)
 284         .expect("Couldn't read config");
 285
 286     Config::from_toml(&def_config).expect("Invalid toml")
 287 }
 288
 289 // Reads significant comments of the form: // rustfmt-key: value
 290 // into a hash map.
 291 fn read_significant_comments(file_name: &str) -> HashMap<String, String> {
 292     let file = fs::File::open(file_name).expect(&format!("Couldn't read file {}", file_name));
 293     let reader = BufReader::new(file);
 294     let pattern = r"^\s*//\s*rustfmt-([^:]+):\s*(\S+)";
 295     let regex = regex::Regex::new(&pattern).expect("Failed creating pattern 1");
 296
 297     // Matches lines containing significant comments or whitespace.
 298     let line_regex = regex::Regex::new(r"(^\s*$)|(^\s*//\s*rustfmt-[^:]+:\s*\S+)")
 299         .expect("Failed creating pattern 2");
 300
 301     reader
 302         .lines()
 303         .map(|line| line.expect("Failed getting line"))
 304         .take_while(|line| line_regex.is_match(&line))
 305         .filter_map(|line| {
 306             regex.captures_iter(&line).next().map(|capture| {
 307                 (capture
 308                      .get(1)
 309                      .expect("Couldn't unwrap capture")
 310                      .as_str()
 311                      .to_owned(),
 312                  capture
 313                      .get(2)
 314                      .expect("Couldn't unwrap capture")
 315                      .as_str()
 316                      .to_owned())
 317             })
 318         })
 319         .collect()
 320 }
 321
 322 // Compare output to input.
 323 // TODO: needs a better name, more explanation.
 324 fn handle_result(result: HashMap<String, String>,
 325                  target: Option<&str>)
 326                  -> Result<(), HashMap<String, Vec<Mismatch>>> {
 327     let mut failures = HashMap::new();
 328
 329     for (file_name, fmt_text) in result {
 330         // If file is in tests/source, compare to file with same name in tests/target.
 331         let target = get_target(&file_name, target);
 332         let open_error = format!("Couldn't open target {:?}", &target);
 333         let mut f = fs::File::open(&target).expect(&open_error);
 334
 335         let mut text = String::new();
 336         let read_error = format!("Failed reading target {:?}", &target);
 337         f.read_to_string(&mut text).expect(&read_error);
 338
 339         if fmt_text != text {
 340             let diff = make_diff(&text, &fmt_text, DIFF_CONTEXT_SIZE);
 341             assert!(!diff.is_empty(),
 342                     "Empty diff? Maybe due to a missing a newline at the end of a file?");
 343             failures.insert(file_name, diff);
 344         }
 345     }
 346
 347     if failures.is_empty() {
 348         Ok(())
 349     } else {
 350         Err(failures)
 351     }
 352 }
 353
 354 // Map source file paths to their target paths.
 355 fn get_target(file_name: &str, target: Option<&str>) -> String {
 356     if file_name.contains("source") {
 357         let target_file_name = file_name.replace("source", "target");
 358         if let Some(replace_name) = target {
 359             Path::new(&target_file_name)
 360                 .with_file_name(replace_name)
 361                 .into_os_string()
 362                 .into_string()
 363                 .unwrap()
 364         } else {
 365             target_file_name
 366         }
 367     } else {
 368         // This is either and idempotence check or a self check
 369         file_name.to_owned()
 370     }
 371 }
 372
 373 #[test]
 374 fn rustfmt_diff_make_diff_tests() {
 375     let diff = make_diff("a\nb\nc\nd", "a\ne\nc\nd", 3);
 376     assert_eq!(diff,
 377                vec![Mismatch {
 378                         line_number: 1,
 379                         lines: vec![DiffLine::Context("a".into()),
 380                                     DiffLine::Resulting("b".into()),
 381                                     DiffLine::Expected("e".into()),
 382                                     DiffLine::Context("c".into()),
 383                                     DiffLine::Context("d".into())],
 384                     }]);
 385 }
 386
 387 #[test]
 388 fn rustfmt_diff_no_diff_test() {
 389     let diff = make_diff("a\nb\nc\nd", "a\nb\nc\nd", 3);
 390     assert_eq!(diff, vec![]);
 391 }