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 // overriden 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
 125     let (reports, count, fails) = check_files(files);
 126     let mut warnings = 0;
 127
 128     // Display results.
 129     println!("Ran {} self tests.", count);
 130     assert!(fails == 0, "{} self tests failed", fails);
 131
 132     for format_report in reports {
 133         println!("{}", format_report);
 134         warnings += format_report.warning_count();
 135     }
 136
 137     assert!(warnings == 0,
 138             "Rustfmt's code generated {} warnings",
 139             warnings);
 140 }
 141
 142 #[test]
 143 fn stdin_formatting_smoke_test() {
 144     let input = Input::Text("fn main () {}".to_owned());
 145     let config = Config::default();
 146     let (file_map, _report) = format_input(input, &config);
 147     assert_eq!(file_map["stdin"].to_string(), "fn main() {}\n")
 148 }
 149
 150 // For each file, run rustfmt and collect the output.
 151 // Returns the number of files checked and the number of failures.
 152 fn check_files<I>(files: I) -> (Vec<FormatReport>, u32, u32)
 153     where I: Iterator<Item = String>
 154 {
 155     let mut count = 0;
 156     let mut fails = 0;
 157     let mut reports = vec![];
 158
 159     for file_name in files.filter(|f| f.ends_with(".rs")) {
 160         println!("Testing '{}'...", file_name);
 161
 162         match idempotent_check(file_name) {
 163             Ok(report) => reports.push(report),
 164             Err(msg) => {
 165                 print_mismatches(msg);
 166                 fails += 1;
 167             }
 168         }
 169
 170         count += 1;
 171     }
 172
 173     (reports, count, fails)
 174 }
 175
 176 fn print_mismatches(result: HashMap<String, Vec<Mismatch>>) {
 177     let mut t = term::stdout().unwrap();
 178
 179     for (file_name, diff) in result {
 180         print_diff(diff,
 181                    |line_num| format!("\nMismatch at {}:{}:", file_name, line_num));
 182     }
 183
 184     t.reset().unwrap();
 185 }
 186
 187 fn read_config(filename: &str) -> Config {
 188     let sig_comments = read_significant_comments(&filename);
 189     let mut config = get_config(sig_comments.get("config").map(|x| &(*x)[..]));
 190
 191     for (key, val) in &sig_comments {
 192         if key != "target" && key != "config" {
 193             config.override_value(key, val);
 194         }
 195     }
 196
 197     // Don't generate warnings for to-do items.
 198     config.report_todo = ReportTactic::Never;
 199
 200     config
 201 }
 202
 203 fn format_file<P: Into<PathBuf>>(filename: P, config: &Config) -> (FileMap, FormatReport) {
 204     let input = Input::File(filename.into());
 205     format_input(input, &config)
 206 }
 207
 208 pub fn idempotent_check(filename: String) -> Result<FormatReport, HashMap<String, Vec<Mismatch>>> {
 209     let sig_comments = read_significant_comments(&filename);
 210     let config = read_config(&filename);
 211     let (file_map, format_report) = format_file(filename, &config);
 212
 213     let mut write_result = HashMap::new();
 214     for (filename, text) in file_map.iter() {
 215         let mut v = Vec::new();
 216         // Won't panic, as we're not doing any IO.
 217         write_system_newlines(&mut v, text, &config).unwrap();
 218         // Won't panic, we are writing correct utf8.
 219         let one_result = String::from_utf8(v).unwrap();
 220         write_result.insert(filename.clone(), one_result);
 221     }
 222
 223     let target = sig_comments.get("target").map(|x| &(*x)[..]);
 224
 225     handle_result(write_result, target).map(|_| format_report)
 226 }
 227
 228 // Reads test config file from comments and reads its contents.
 229 fn get_config(config_file: Option<&str>) -> Config {
 230     let config_file_name = match config_file {
 231         None => return Default::default(),
 232         Some(file_name) => {
 233             let mut full_path = "tests/config/".to_owned();
 234             full_path.push_str(&file_name);
 235             full_path
 236         }
 237     };
 238
 239     let mut def_config_file = fs::File::open(config_file_name).expect("Couldn't open config");
 240     let mut def_config = String::new();
 241     def_config_file.read_to_string(&mut def_config).expect("Couldn't read config");
 242
 243     Config::from_toml(&def_config)
 244 }
 245
 246 // Reads significant comments of the form: // rustfmt-key: value
 247 // into a hash map.
 248 fn read_significant_comments(file_name: &str) -> HashMap<String, String> {
 249     let file = fs::File::open(file_name).expect(&format!("Couldn't read file {}", file_name));
 250     let reader = BufReader::new(file);
 251     let pattern = r"^\s*//\s*rustfmt-([^:]+):\s*(\S+)";
 252     let regex = regex::Regex::new(&pattern).expect("Failed creating pattern 1");
 253
 254     // Matches lines containing significant comments or whitespace.
 255     let line_regex = regex::Regex::new(r"(^\s*$)|(^\s*//\s*rustfmt-[^:]+:\s*\S+)")
 256                          .expect("Failed creating pattern 2");
 257
 258     reader.lines()
 259           .map(|line| line.expect("Failed getting line"))
 260           .take_while(|line| line_regex.is_match(&line))
 261           .filter_map(|line| {
 262               regex.captures_iter(&line).next().map(|capture| {
 263                   (capture.at(1).expect("Couldn't unwrap capture").to_owned(),
 264                    capture.at(2).expect("Couldn't unwrap capture").to_owned())
 265               })
 266           })
 267           .collect()
 268 }
 269
 270 // Compare output to input.
 271 // TODO: needs a better name, more explanation.
 272 fn handle_result(result: HashMap<String, String>,
 273                  target: Option<&str>)
 274                  -> Result<(), HashMap<String, Vec<Mismatch>>> {
 275     let mut failures = HashMap::new();
 276
 277     for (file_name, fmt_text) in result {
 278         // If file is in tests/source, compare to file with same name in tests/target.
 279         let target = get_target(&file_name, target);
 280         let mut f = fs::File::open(&target).expect("Couldn't open target");
 281
 282         let mut text = String::new();
 283         f.read_to_string(&mut text).expect("Failed reading target");
 284
 285         if fmt_text != text {
 286             let diff = make_diff(&text, &fmt_text, DIFF_CONTEXT_SIZE);
 287             assert!(!diff.is_empty(),
 288                     "Empty diff? Maybe due to a missing a newline at the end of a file?");
 289             failures.insert(file_name, diff);
 290         }
 291     }
 292
 293     if failures.is_empty() {
 294         Ok(())
 295     } else {
 296         Err(failures)
 297     }
 298 }
 299
 300 // Map source file paths to their target paths.
 301 fn get_target(file_name: &str, target: Option<&str>) -> String {
 302     if file_name.contains("source") {
 303         let target_file_name = file_name.replace("source", "target");
 304         if let Some(replace_name) = target {
 305             Path::new(&target_file_name)
 306                 .with_file_name(replace_name)
 307                 .into_os_string()
 308                 .into_string()
 309                 .unwrap()
 310         } else {
 311             target_file_name
 312         }
 313     } else {
 314         // This is either and idempotence check or a self check
 315         file_name.to_owned()
 316     }
 317 }
 318
 319 #[test]
 320 fn rustfmt_diff_make_diff_tests() {
 321     let diff = make_diff("a\nb\nc\nd", "a\ne\nc\nd", 3);
 322     assert_eq!(diff,
 323                vec![Mismatch {
 324                         line_number: 1,
 325                         lines: vec![DiffLine::Context("a".into()),
 326                                     DiffLine::Resulting("b".into()),
 327                                     DiffLine::Expected("e".into()),
 328                                     DiffLine::Context("c".into()),
 329                                     DiffLine::Context("d".into())],
 330                     }]);
 331 }