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.
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.
16 use std::collections::HashMap;
18 use std::io::{self, Read, BufRead, BufReader};
22 use rustfmt::filemap::{write_system_newlines, FileMap};
23 use rustfmt::config::{Config, ReportTactic, WriteMode};
24 use rustfmt::rustfmt_diff::*;
26 static DIFF_CONTEXT_SIZE: usize = 3;
28 fn get_path_string(dir_entry: io::Result<fs::DirEntry>) -> String {
29 let path = dir_entry.expect("Couldn't get DirEntry").path();
31 path.to_str().expect("Couldn't stringify path").to_owned()
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
38 // FIXME(#28) would be good to check for error messages and fail on them, or at
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
46 let files = files.map(get_path_string);
47 let (_reports, count, fails) = check_files(files, WriteMode::Default);
50 println!("Ran {} system tests.", count);
51 assert!(fails == 0, "{} system tests failed", fails);
54 // Do the same for tests/coverage-source directory
55 // the only difference is the coverage mode
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, WriteMode::Coverage);
62 println!("Ran {} tests in coverage mode.", count);
63 assert!(fails == 0, "{} tests failed", fails);
67 fn checkstyle_test() {
68 let filename = "tests/source/fn-single-line.rs";
69 let expected_filename = "tests/writemode/checkstyle.xml";
70 assert_output(filename, expected_filename, WriteMode::Checkstyle);
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, write_mode: WriteMode) {
77 let config = read_config(&source);
78 let file_map = run_rustfmt(source.to_string(), write_mode);
80 // Populate output by writing to a vec.
82 let _ = filemap::write_all_files(&file_map, &mut out, write_mode, &config);
83 let output = String::from_utf8(out).unwrap();
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");
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");
99 // Idempotence tests. Files in tests/target are checked to be unaltered by
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, WriteMode::Default);
110 println!("Ran {} idempotent tests.", count);
111 assert!(fails == 0, "{} idempotent tests failed", fails);
114 // Run rustfmt on itself. This operation must be idempotent. We also check that
115 // no warnings are emitted.
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());
125 let (reports, count, fails) = check_files(files, WriteMode::Default);
126 let mut warnings = 0;
129 println!("Ran {} self tests.", count);
130 assert!(fails == 0, "{} self tests failed", fails);
132 for format_report in reports {
133 println!("{}", format_report);
134 warnings += format_report.warning_count();
137 assert!(warnings == 0,
138 "Rustfmt's code generated {} warnings",
142 // For each file, run rustfmt and collect the output.
143 // Returns the number of files checked and the number of failures.
144 fn check_files<I>(files: I, write_mode: WriteMode) -> (Vec<FormatReport>, u32, u32)
145 where I: Iterator<Item = String>
149 let mut reports = vec![];
151 for file_name in files.filter(|f| f.ends_with(".rs")) {
152 println!("Testing '{}'...", file_name);
154 match idempotent_check(file_name, write_mode) {
155 Ok(report) => reports.push(report),
157 print_mismatches(msg);
165 (reports, count, fails)
168 fn print_mismatches(result: HashMap<String, Vec<Mismatch>>) {
169 let mut t = term::stdout().unwrap();
171 for (file_name, diff) in result {
173 |line_num| format!("\nMismatch at {}:{}:", file_name, line_num));
176 assert!(t.reset().unwrap());
179 fn read_config(filename: &str) -> Config {
180 let sig_comments = read_significant_comments(&filename);
181 let mut config = get_config(sig_comments.get("config").map(|x| &(*x)[..]));
183 for (key, val) in &sig_comments {
184 if key != "target" && key != "config" {
185 config.override_value(key, val);
189 // Don't generate warnings for to-do items.
190 config.report_todo = ReportTactic::Never;
195 fn run_rustfmt(filename: String, write_mode: WriteMode) -> FileMap {
196 let config = read_config(&filename);
197 format(Path::new(&filename), &config, write_mode)
200 pub fn idempotent_check(filename: String,
201 write_mode: WriteMode)
202 -> Result<FormatReport, HashMap<String, Vec<Mismatch>>> {
203 let sig_comments = read_significant_comments(&filename);
204 let config = read_config(&filename);
205 let mut file_map = run_rustfmt(filename, write_mode);
206 let format_report = fmt_lines(&mut file_map, &config);
208 let mut write_result = HashMap::new();
209 for (filename, text) in file_map.iter() {
210 let mut v = Vec::new();
211 // Won't panic, as we're not doing any IO.
212 write_system_newlines(&mut v, text, &config).unwrap();
213 // Won't panic, we are writing correct utf8.
214 let one_result = String::from_utf8(v).unwrap();
215 write_result.insert(filename.clone(), one_result);
218 let target = sig_comments.get("target").map(|x| &(*x)[..]);
220 handle_result(write_result, target, write_mode).map(|_| format_report)
223 // Reads test config file from comments and reads its contents.
224 fn get_config(config_file: Option<&str>) -> Config {
225 let config_file_name = match config_file {
226 None => return Default::default(),
228 let mut full_path = "tests/config/".to_owned();
229 full_path.push_str(&file_name);
234 let mut def_config_file = fs::File::open(config_file_name).expect("Couldn't open config");
235 let mut def_config = String::new();
236 def_config_file.read_to_string(&mut def_config).expect("Couldn't read config");
238 Config::from_toml(&def_config)
241 // Reads significant comments of the form: // rustfmt-key: value
243 fn read_significant_comments(file_name: &str) -> HashMap<String, String> {
244 let file = fs::File::open(file_name).expect(&format!("Couldn't read file {}", file_name));
245 let reader = BufReader::new(file);
246 let pattern = r"^\s*//\s*rustfmt-([^:]+):\s*(\S+)";
247 let regex = regex::Regex::new(&pattern).expect("Failed creating pattern 1");
249 // Matches lines containing significant comments or whitespace.
250 let line_regex = regex::Regex::new(r"(^\s*$)|(^\s*//\s*rustfmt-[^:]+:\s*\S+)")
251 .expect("Failed creating pattern 2");
254 .map(|line| line.expect("Failed getting line"))
255 .take_while(|line| line_regex.is_match(&line))
257 regex.captures_iter(&line).next().map(|capture| {
258 (capture.at(1).expect("Couldn't unwrap capture").to_owned(),
259 capture.at(2).expect("Couldn't unwrap capture").to_owned())
265 // Compare output to input.
266 // TODO: needs a better name, more explanation.
267 fn handle_result(result: HashMap<String, String>,
268 target: Option<&str>,
269 write_mode: WriteMode)
270 -> Result<(), HashMap<String, Vec<Mismatch>>> {
271 let mut failures = HashMap::new();
273 for (file_name, fmt_text) in result {
274 // If file is in tests/source, compare to file with same name in tests/target.
275 let target = get_target(&file_name, target, write_mode);
276 let mut f = fs::File::open(&target).expect("Couldn't open target");
278 let mut text = String::new();
279 f.read_to_string(&mut text).expect("Failed reading target");
281 if fmt_text != text {
282 let diff = make_diff(&text, &fmt_text, DIFF_CONTEXT_SIZE);
283 failures.insert(file_name, diff);
287 if failures.is_empty() {
294 // Map source file paths to their target paths.
295 fn get_target(file_name: &str, target: Option<&str>, write_mode: WriteMode) -> String {
296 let file_path = Path::new(file_name);
297 let (source_path_prefix, target_path_prefix) = match write_mode {
298 WriteMode::Coverage => {
299 (Path::new("tests/coverage-source/"),
300 "tests/coverage-target/")
302 _ => (Path::new("tests/source/"), "tests/target/"),
305 if file_path.starts_with(source_path_prefix) {
306 let mut components = file_path.components();
307 // Can't skip(2) as the resulting iterator can't as_path()
311 let new_target = match components.as_path().to_str() {
312 Some(string) => string,
315 let base = target.unwrap_or(new_target);
317 format!("{}{}", target_path_prefix, base)
324 fn rustfmt_diff_make_diff_tests() {
325 let diff = make_diff("a\nb\nc\nd", "a\ne\nc\nd", 3);
329 lines: vec![DiffLine::Context("a".into()),
330 DiffLine::Resulting("b".into()),
331 DiffLine::Expected("e".into()),
332 DiffLine::Context("c".into()),
333 DiffLine::Context("d".into())],