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;
  20
  21 use rustfmt::*;
  22 use rustfmt::config::{Config, ReportTactic};
  23 use rustfmt::rustfmt_diff::*;
  24
  25 static DIFF_CONTEXT_SIZE: usize = 3;
  26
  27 fn get_path_string(dir_entry: io::Result<fs::DirEntry>) -> String {
  28     let path = dir_entry.ok().expect("Couldn't get DirEntry.").path();
  29
  30     path.to_str().expect("Couldn't stringify path.").to_owned()
  31 }
  32
  33 // Integration tests. The files in the tests/source are formatted and compared
  34 // to their equivalent in tests/target. The target file and config can be
  35 // overriden by annotations in the source file. The input and output must match
  36 // exactly.
  37 // FIXME(#28) would be good to check for error messages and fail on them, or at
  38 // least report.
  39 #[test]
  40 fn system_tests() {
  41     // Get all files in the tests/source directory.
  42     let files = fs::read_dir("tests/source").ok().expect("Couldn't read source dir.");
  43     // Turn a DirEntry into a String that represents the relative path to the
  44     // file.
  45     let files = files.map(get_path_string);
  46     let (_reports, count, fails) = check_files(files);
  47
  48     // Display results.
  49     println!("Ran {} system tests.", count);
  50     assert!(fails == 0, "{} system tests failed", fails);
  51 }
  52
  53 // Idempotence tests. Files in tests/target are checked to be unaltered by
  54 // rustfmt.
  55 #[test]
  56 fn idempotence_tests() {
  57     // Get all files in the tests/target directory.
  58     let files = fs::read_dir("tests/target")
  59                     .ok()
  60                     .expect("Couldn't read target dir.")
  61                     .map(get_path_string);
  62     let (_reports, count, fails) = check_files(files);
  63
  64     // Display results.
  65     println!("Ran {} idempotent tests.", count);
  66     assert!(fails == 0, "{} idempotent tests failed", fails);
  67 }
  68
  69 // Run rustfmt on itself. This operation must be idempotent. We also check that
  70 // no warnings are emitted.
  71 #[test]
  72 fn self_tests() {
  73     let files = fs::read_dir("src/bin")
  74                     .ok()
  75                     .expect("Couldn't read src dir.")
  76                     .chain(fs::read_dir("tests").ok().expect("Couldn't read tests dir."))
  77                     .map(get_path_string);
  78     // Hack because there's no `IntoIterator` impl for `[T; N]`.
  79     let files = files.chain(Some("src/lib.rs".to_owned()).into_iter());
  80
  81     let (reports, count, fails) = check_files(files);
  82     let mut warnings = 0;
  83
  84     // Display results.
  85     println!("Ran {} self tests.", count);
  86     assert!(fails == 0, "{} self tests failed", fails);
  87
  88     for format_report in reports {
  89         println!("{}", format_report);
  90         warnings += format_report.warning_count();
  91     }
  92
  93     assert!(warnings == 0,
  94             "Rustfmt's code generated {} warnings",
  95             warnings);
  96 }
  97
  98 // For each file, run rustfmt and collect the output.
  99 // Returns the number of files checked and the number of failures.
 100 fn check_files<I>(files: I) -> (Vec<FormatReport>, u32, u32)
 101     where I: Iterator<Item = String>
 102 {
 103     let mut count = 0;
 104     let mut fails = 0;
 105     let mut reports = vec![];
 106
 107     for file_name in files.filter(|f| f.ends_with(".rs")) {
 108         println!("Testing '{}'...", file_name);
 109
 110         match idempotent_check(file_name) {
 111             Ok(report) => reports.push(report),
 112             Err(msg) => {
 113                 print_mismatches(msg);
 114                 fails += 1;
 115             }
 116         }
 117
 118         count += 1;
 119     }
 120
 121     (reports, count, fails)
 122 }
 123
 124 fn print_mismatches(result: HashMap<String, Vec<Mismatch>>) {
 125     let mut t = term::stdout().unwrap();
 126
 127     for (file_name, diff) in result {
 128         print_diff(diff,
 129                    |line_num| format!("\nMismatch at {}:{}:", file_name, line_num));
 130     }
 131
 132     assert!(t.reset().unwrap());
 133 }
 134
 135 pub fn idempotent_check(filename: String) -> Result<FormatReport, HashMap<String, Vec<Mismatch>>> {
 136     let sig_comments = read_significant_comments(&filename);
 137     let mut config = get_config(sig_comments.get("config").map(|x| &(*x)[..]));
 138
 139     for (key, val) in &sig_comments {
 140         if key != "target" && key != "config" {
 141             config.override_value(key, val);
 142         }
 143     }
 144
 145     // Don't generate warnings for to-do items.
 146     config.report_todo = ReportTactic::Never;
 147
 148     let mut file_map = format(Path::new(&filename), &config, WriteMode::Return);
 149     let format_report = fmt_lines(&mut file_map, &config);
 150
 151     // Won't panic, as we're not doing any IO.
 152     let write_result = filemap::write_all_files(&file_map, WriteMode::Return, &config).unwrap();
 153     let target = sig_comments.get("target").map(|x| &(*x)[..]);
 154
 155     handle_result(write_result, target).map(|_| format_report)
 156 }
 157
 158 // Reads test config file from comments and reads its contents.
 159 fn get_config(config_file: Option<&str>) -> Config {
 160     let config_file_name = match config_file {
 161         None => return Default::default(),
 162         Some(file_name) => {
 163             let mut full_path = "tests/config/".to_owned();
 164             full_path.push_str(&file_name);
 165             full_path
 166         }
 167     };
 168
 169     let mut def_config_file = fs::File::open(config_file_name)
 170                                   .ok()
 171                                   .expect("Couldn't open config.");
 172     let mut def_config = String::new();
 173     def_config_file.read_to_string(&mut def_config).ok().expect("Couldn't read config.");
 174
 175     Config::from_toml(&def_config)
 176 }
 177
 178 // Reads significant comments of the form: // rustfmt-key: value
 179 // into a hash map.
 180 fn read_significant_comments(file_name: &str) -> HashMap<String, String> {
 181     let file = fs::File::open(file_name)
 182                    .ok()
 183                    .expect(&format!("Couldn't read file {}.", file_name));
 184     let reader = BufReader::new(file);
 185     let pattern = r"^\s*//\s*rustfmt-([^:]+):\s*(\S+)";
 186     let regex = regex::Regex::new(&pattern).ok().expect("Failed creating pattern 1.");
 187
 188     // Matches lines containing significant comments or whitespace.
 189     let line_regex = regex::Regex::new(r"(^\s*$)|(^\s*//\s*rustfmt-[^:]+:\s*\S+)")
 190                          .ok()
 191                          .expect("Failed creating pattern 2.");
 192
 193     reader.lines()
 194           .map(|line| line.ok().expect("Failed getting line."))
 195           .take_while(|line| line_regex.is_match(&line))
 196           .filter_map(|line| {
 197               regex.captures_iter(&line).next().map(|capture| {
 198                   (capture.at(1).expect("Couldn't unwrap capture.").to_owned(),
 199                    capture.at(2).expect("Couldn't unwrap capture.").to_owned())
 200               })
 201           })
 202           .collect()
 203 }
 204
 205 // Compare output to input.
 206 // TODO: needs a better name, more explanation.
 207 fn handle_result(result: HashMap<String, String>,
 208                  target: Option<&str>)
 209                  -> Result<(), HashMap<String, Vec<Mismatch>>> {
 210     let mut failures = HashMap::new();
 211
 212     for (file_name, fmt_text) in result {
 213         // If file is in tests/source, compare to file with same name in tests/target.
 214         let target = get_target(&file_name, target);
 215         let mut f = fs::File::open(&target).ok().expect("Couldn't open target.");
 216
 217         let mut text = String::new();
 218         f.read_to_string(&mut text).ok().expect("Failed reading target.");
 219
 220         if fmt_text != text {
 221             let diff = make_diff(&text, &fmt_text, DIFF_CONTEXT_SIZE);
 222             failures.insert(file_name, diff);
 223         }
 224     }
 225
 226     if failures.is_empty() {
 227         Ok(())
 228     } else {
 229         Err(failures)
 230     }
 231 }
 232
 233 // Map source file paths to their target paths.
 234 fn get_target(file_name: &str, target: Option<&str>) -> String {
 235     let file_path = Path::new(file_name);
 236     let source_path_prefix = Path::new("tests/source/");
 237     if file_path.starts_with(source_path_prefix) {
 238         let mut components = file_path.components();
 239         // Can't skip(2) as the resulting iterator can't as_path()
 240         components.next();
 241         components.next();
 242
 243         let new_target = match components.as_path().to_str() {
 244             Some(string) => string,
 245             None => file_name,
 246         };
 247         let base = target.unwrap_or(new_target);
 248
 249         format!("tests/target/{}", base)
 250     } else {
 251         file_name.to_owned()
 252     }
 253 }