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.read_to_string(&mut expected_text)
  88         .expect("Failed reading target");
  89
  90     let compare = make_diff(&expected_text, &output, DIFF_CONTEXT_SIZE);
  91     if compare.len() > 0 {
  92         let mut failures = HashMap::new();
  93         failures.insert(source.to_string(), compare);
  94         print_mismatches(failures);
  95         assert!(false, "Text does not match expected output");
  96     }
  97 }
  98
  99 // Idempotence tests. Files in tests/target are checked to be unaltered by
 100 // rustfmt.
 101 #[test]
 102 fn idempotence_tests() {
 103     // Get all files in the tests/target directory.
 104     let files = fs::read_dir("tests/target")
 105         .expect("Couldn't read target dir")
 106         .map(get_path_string);
 107     let (_reports, count, fails) = check_files(files);
 108
 109     // Display results.
 110     println!("Ran {} idempotent tests.", count);
 111     assert!(fails == 0, "{} idempotent tests failed", fails);
 112 }
 113
 114 // Run rustfmt on itself. This operation must be idempotent. We also check that
 115 // no warnings are emitted.
 116 #[test]
 117 fn self_tests() {
 118     let files = fs::read_dir("src/bin")
 119         .expect("Couldn't read src dir")
 120         .chain(fs::read_dir("tests").expect("Couldn't read tests dir"))
 121         .map(get_path_string);
 122     // Hack because there's no `IntoIterator` impl for `[T; N]`.
 123     let files = files.chain(Some("src/lib.rs".to_owned()).into_iter());
 124     let files = files.chain(Some("build.rs".to_owned()).into_iter());
 125
 126     let (reports, count, fails) = check_files(files);
 127     let mut warnings = 0;
 128
 129     // Display results.
 130     println!("Ran {} self tests.", count);
 131     assert!(fails == 0, "{} self tests failed", fails);
 132
 133     for format_report in reports {
 134         println!("{}", format_report);
 135         warnings += format_report.warning_count();
 136     }
 137
 138     assert!(warnings == 0,
 139             "Rustfmt's code generated {} warnings",
 140             warnings);
 141 }
 142
 143 #[test]
 144 fn stdin_formatting_smoke_test() {
 145     let input = Input::Text("fn main () {}".to_owned());
 146     let config = Config::default();
 147     let (error_summary, file_map, _report) = format_input::<io::Stdout>(input, &config, None)
 148         .unwrap();
 149     assert!(error_summary.has_no_errors());
 150     for &(ref file_name, ref text) in &file_map {
 151         if file_name == "stdin" {
 152             assert!(text.to_string() == "fn main() {}\n");
 153             return;
 154         }
 155     }
 156     panic!("no stdin");
 157 }
 158
 159 #[test]
 160 fn format_lines_errors_are_reported() {
 161     let long_identifier = String::from_utf8(vec![b'a'; 239]).unwrap();
 162     let input = Input::Text(format!("fn {}() {{}}", long_identifier));
 163     let config = Config::default();
 164     let (error_summary, _file_map, _report) = format_input::<io::Stdout>(input, &config, None)
 165         .unwrap();
 166     assert!(error_summary.has_formatting_errors());
 167 }
 168
 169 // For each file, run rustfmt and collect the output.
 170 // Returns the number of files checked and the number of failures.
 171 fn check_files<I>(files: I) -> (Vec<FormatReport>, u32, u32)
 172     where I: Iterator<Item = String>
 173 {
 174     let mut count = 0;
 175     let mut fails = 0;
 176     let mut reports = vec![];
 177
 178     for file_name in files.filter(|f| f.ends_with(".rs")) {
 179         println!("Testing '{}'...", file_name);
 180
 181         match idempotent_check(file_name) {
 182             Ok(ref report) if report.has_warnings() => {
 183                 print!("{}", report);
 184                 fails += 1;
 185             }
 186             Ok(report) => reports.push(report),
 187             Err(msg) => {
 188                 print_mismatches(msg);
 189                 fails += 1;
 190             }
 191         }
 192
 193         count += 1;
 194     }
 195
 196     (reports, count, fails)
 197 }
 198
 199 fn print_mismatches(result: HashMap<String, Vec<Mismatch>>) {
 200     let mut t = term::stdout().unwrap();
 201
 202     for (file_name, diff) in result {
 203         print_diff(diff,
 204                    |line_num| format!("\nMismatch at {}:{}:", file_name, line_num));
 205     }
 206
 207     t.reset().unwrap();
 208 }
 209
 210 fn read_config(filename: &str) -> Config {
 211     let sig_comments = read_significant_comments(&filename);
 212     // Look for a config file... If there is a 'config' property in the significant comments, use
 213     // that. Otherwise, if there are no significant comments at all, look for a config file with
 214     // the same name as the test file.
 215     let mut config = if !sig_comments.is_empty() {
 216         get_config(sig_comments.get("config").map(|x| &(*x)[..]))
 217     } else {
 218         get_config(Path::new(filename)
 219             .with_extension("toml")
 220             .file_name()
 221             .and_then(std::ffi::OsStr::to_str))
 222     };
 223
 224     for (key, val) in &sig_comments {
 225         if key != "target" && key != "config" {
 226             config.override_value(key, val);
 227         }
 228     }
 229
 230     // Don't generate warnings for to-do items.
 231     config.report_todo = ReportTactic::Never;
 232
 233     config
 234 }
 235
 236 fn format_file<P: Into<PathBuf>>(filename: P, config: &Config) -> (FileMap, FormatReport) {
 237     let input = Input::File(filename.into());
 238     let (_error_summary, file_map, report) = format_input::<io::Stdout>(input, &config, None)
 239         .unwrap();
 240     return (file_map, report);
 241 }
 242
 243 pub fn idempotent_check(filename: String) -> Result<FormatReport, HashMap<String, Vec<Mismatch>>> {
 244     let sig_comments = read_significant_comments(&filename);
 245     let config = read_config(&filename);
 246     let (file_map, format_report) = format_file(filename, &config);
 247
 248     let mut write_result = HashMap::new();
 249     for &(ref filename, ref text) in &file_map {
 250         let mut v = Vec::new();
 251         // Won't panic, as we're not doing any IO.
 252         write_system_newlines(&mut v, text, &config).unwrap();
 253         // Won't panic, we are writing correct utf8.
 254         let one_result = String::from_utf8(v).unwrap();
 255         write_result.insert(filename.clone(), one_result);
 256     }
 257
 258     let target = sig_comments.get("target").map(|x| &(*x)[..]);
 259
 260     handle_result(write_result, target).map(|_| format_report)
 261 }
 262
 263 // Reads test config file using the supplied (optional) file name. If there's no file name or the
 264 // file doesn't exist, just return the default config. Otherwise, the file must be read
 265 // successfully.
 266 fn get_config(config_file: Option<&str>) -> Config {
 267     let config_file_name = match config_file {
 268         None => return Default::default(),
 269         Some(file_name) => {
 270             let mut full_path = "tests/config/".to_owned();
 271             full_path.push_str(&file_name);
 272             if !Path::new(&full_path).exists() {
 273                 return Default::default();
 274             };
 275             full_path
 276         }
 277     };
 278
 279     let mut def_config_file = fs::File::open(config_file_name).expect("Couldn't open config");
 280     let mut def_config = String::new();
 281     def_config_file.read_to_string(&mut def_config).expect("Couldn't read config");
 282
 283     Config::from_toml(&def_config)
 284 }
 285
 286 // Reads significant comments of the form: // rustfmt-key: value
 287 // into a hash map.
 288 fn read_significant_comments(file_name: &str) -> HashMap<String, String> {
 289     let file = fs::File::open(file_name).expect(&format!("Couldn't read file {}", file_name));
 290     let reader = BufReader::new(file);
 291     let pattern = r"^\s*//\s*rustfmt-([^:]+):\s*(\S+)";
 292     let regex = regex::Regex::new(&pattern).expect("Failed creating pattern 1");
 293
 294     // Matches lines containing significant comments or whitespace.
 295     let line_regex = regex::Regex::new(r"(^\s*$)|(^\s*//\s*rustfmt-[^:]+:\s*\S+)")
 296         .expect("Failed creating pattern 2");
 297
 298     reader.lines()
 299         .map(|line| line.expect("Failed getting line"))
 300         .take_while(|line| line_regex.is_match(&line))
 301         .filter_map(|line| {
 302             regex.captures_iter(&line).next().map(|capture| {
 303                 (capture.at(1).expect("Couldn't unwrap capture").to_owned(),
 304                  capture.at(2).expect("Couldn't unwrap capture").to_owned())
 305             })
 306         })
 307         .collect()
 308 }
 309
 310 // Compare output to input.
 311 // TODO: needs a better name, more explanation.
 312 fn handle_result(result: HashMap<String, String>,
 313                  target: Option<&str>)
 314                  -> Result<(), HashMap<String, Vec<Mismatch>>> {
 315     let mut failures = HashMap::new();
 316
 317     for (file_name, fmt_text) in result {
 318         // If file is in tests/source, compare to file with same name in tests/target.
 319         let target = get_target(&file_name, target);
 320         let mut f = fs::File::open(&target).expect("Couldn't open target");
 321
 322         let mut text = String::new();
 323         f.read_to_string(&mut text).expect("Failed reading target");
 324
 325         if fmt_text != text {
 326             let diff = make_diff(&text, &fmt_text, DIFF_CONTEXT_SIZE);
 327             assert!(!diff.is_empty(),
 328                     "Empty diff? Maybe due to a missing a newline at the end of a file?");
 329             failures.insert(file_name, diff);
 330         }
 331     }
 332
 333     if failures.is_empty() {
 334         Ok(())
 335     } else {
 336         Err(failures)
 337     }
 338 }
 339
 340 // Map source file paths to their target paths.
 341 fn get_target(file_name: &str, target: Option<&str>) -> String {
 342     if file_name.contains("source") {
 343         let target_file_name = file_name.replace("source", "target");
 344         if let Some(replace_name) = target {
 345             Path::new(&target_file_name)
 346                 .with_file_name(replace_name)
 347                 .into_os_string()
 348                 .into_string()
 349                 .unwrap()
 350         } else {
 351             target_file_name
 352         }
 353     } else {
 354         // This is either and idempotence check or a self check
 355         file_name.to_owned()
 356     }
 357 }
 358
 359 #[test]
 360 fn rustfmt_diff_make_diff_tests() {
 361     let diff = make_diff("a\nb\nc\nd", "a\ne\nc\nd", 3);
 362     assert_eq!(diff,
 363                vec![Mismatch {
 364                         line_number: 1,
 365                         lines: vec![DiffLine::Context("a".into()),
 366                                     DiffLine::Resulting("b".into()),
 367                                     DiffLine::Expected("e".into()),
 368                                     DiffLine::Context("c".into()),
 369                                     DiffLine::Context("d".into())],
 370                     }]);
 371 }
 372
 373 #[test]
 374 fn rustfmt_diff_no_diff_test() {
 375     let diff = make_diff("a\nb\nc\nd", "a\nb\nc\nd", 3);
 376     assert_eq!(diff, vec![]);
 377 }