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.
11 extern crate assert_cli;
13 use std::collections::{HashMap, HashSet};
16 use std::io::{self, BufRead, BufReader, Read, Write};
17 use std::iter::{Enumerate, Peekable};
19 use std::path::{Path, PathBuf};
22 use config::{Color, Config, EmitMode, FileName, ReportTactic};
23 use formatting::{ModifiedChunk, SourceFile};
24 use rustfmt_diff::{make_diff, print_diff, DiffLine, Mismatch, OutputWriter};
26 use {FormatReport, Input, Session};
28 const DIFF_CONTEXT_SIZE: usize = 3;
29 const CONFIGURATIONS_FILE_NAME: &str = "Configurations.md";
31 // Returns a `Vec` containing `PathBuf`s of files with a rs extension in the
32 // given path. The `recursive` argument controls if files from subdirectories
34 fn get_test_files(path: &Path, recursive: bool) -> Vec<PathBuf> {
35 let mut files = vec![];
37 for entry in fs::read_dir(path).expect(&format!(
38 "Couldn't read directory {}",
39 path.to_str().unwrap()
41 let entry = entry.expect("Couldn't get DirEntry");
42 let path = entry.path();
43 if path.is_dir() && recursive {
44 files.append(&mut get_test_files(&path, recursive));
45 } else if path.extension().map_or(false, |f| f == "rs") {
53 fn verify_config_used(path: &Path, config_name: &str) {
54 for entry in fs::read_dir(path).expect(&format!(
55 "Couldn't read {} directory",
56 path.to_str().unwrap()
58 let entry = entry.expect("Couldn't get directory entry");
59 let path = entry.path();
60 if path.extension().map_or(false, |f| f == "rs") {
61 // check if "// rustfmt-<config_name>:" appears in the file.
62 let filebuf = BufReader::new(
63 fs::File::open(&path).expect(&format!("Couldn't read file {}", path.display())),
69 .take_while(|l| l.starts_with("//"))
70 .any(|l| l.starts_with(&format!("// rustfmt-{}", config_name))),
72 "config option file {} does not contain expected config name",
81 fn verify_config_test_names() {
83 Path::new("tests/source/configs"),
84 Path::new("tests/target/configs"),
86 for entry in fs::read_dir(path).expect("Couldn't read configs directory") {
87 let entry = entry.expect("Couldn't get directory entry");
88 let path = entry.path();
90 let config_name = path.file_name().unwrap().to_str().unwrap();
92 // Make sure that config name is used in the files in the directory.
93 verify_config_used(&path, config_name);
99 // This writes to the terminal using the same approach (via term::stdout or
100 // println!) that is used by `rustfmt::rustfmt_diff::print_diff`. Writing
101 // using only one or the other will cause the output order to differ when
102 // `print_diff` selects the approach not used.
103 fn write_message(msg: &str) {
104 let mut writer = OutputWriter::new(Color::Auto);
105 writer.writeln(&format!("{}", msg), None);
108 // Integration tests. The files in the tests/source are formatted and compared
109 // to their equivalent in tests/target. The target file and config can be
110 // overridden by annotations in the source file. The input and output must match
114 // Get all files in the tests/source directory.
115 let files = get_test_files(Path::new("tests/source"), true);
116 let (_reports, count, fails) = check_files(files, None);
119 println!("Ran {} system tests.", count);
120 assert_eq!(fails, 0, "{} system tests failed", fails);
123 // Do the same for tests/coverage-source directory
124 // the only difference is the coverage mode
126 fn coverage_tests() {
127 let files = get_test_files(Path::new("tests/coverage/source"), true);
128 let (_reports, count, fails) = check_files(files, None);
130 println!("Ran {} tests in coverage mode.", count);
131 assert_eq!(fails, 0, "{} tests failed", fails);
135 fn checkstyle_test() {
136 let filename = "tests/writemode/source/fn-single-line.rs";
137 let expected_filename = "tests/writemode/target/checkstyle.xml";
138 assert_output(Path::new(filename), Path::new(expected_filename));
143 use std::io::BufRead;
145 // Test "modified" output
146 let filename = "tests/writemode/source/modified.rs";
147 let mut data = Vec::new();
148 let mut config = Config::default();
149 config.set().emit_mode(::config::EmitMode::ModifiedLines);
152 let mut session = Session::new(config, Some(&mut data));
153 session.format(Input::File(filename.into())).unwrap();
156 let mut lines = data.lines();
157 let mut chunks = Vec::new();
158 while let Some(Ok(header)) = lines.next() {
159 // Parse the header line
160 let values: Vec<_> = header
162 .map(|s| s.parse::<u32>().unwrap())
164 assert_eq!(values.len(), 3);
165 let line_number_orig = values[0];
166 let lines_removed = values[1];
167 let num_added = values[2];
168 let mut added_lines = Vec::new();
169 for _ in 0..num_added {
170 added_lines.push(lines.next().unwrap().unwrap());
172 chunks.push(ModifiedChunk {
185 lines: vec!["fn blah() {}".into()],
190 lines: vec!["#[cfg(a, b)]".into(), "fn main() {}".into()],
196 // Helper function for comparing the results of rustfmt
197 // to a known output file generated by one of the write modes.
198 fn assert_output(source: &Path, expected_filename: &Path) {
199 let config = read_config(source);
200 let (_, source_file, _) = format_file(source, config.clone());
202 // Populate output by writing to a vec.
203 let mut out = vec![];
204 let _ = source_file::write_all_files(&source_file, &mut out, &config);
205 let output = String::from_utf8(out).unwrap();
207 let mut expected_file = fs::File::open(&expected_filename).expect("Couldn't open target");
208 let mut expected_text = String::new();
210 .read_to_string(&mut expected_text)
211 .expect("Failed reading target");
213 let compare = make_diff(&expected_text, &output, DIFF_CONTEXT_SIZE);
214 if !compare.is_empty() {
215 let mut failures = HashMap::new();
216 failures.insert(source.to_owned(), compare);
217 print_mismatches_default_message(failures);
218 assert!(false, "Text does not match expected output");
222 // Idempotence tests. Files in tests/target are checked to be unaltered by
225 fn idempotence_tests() {
226 match option_env!("CFG_RELEASE_CHANNEL") {
227 None | Some("nightly") => {}
228 _ => return, // these tests require nightly
230 // Get all files in the tests/target directory.
231 let files = get_test_files(Path::new("tests/target"), true);
232 let (_reports, count, fails) = check_files(files, None);
235 println!("Ran {} idempotent tests.", count);
236 assert_eq!(fails, 0, "{} idempotent tests failed", fails);
239 // Run rustfmt on itself. This operation must be idempotent. We also check that
240 // no warnings are emitted.
243 let mut files = get_test_files(Path::new("tests"), false);
244 let bin_directories = vec!["cargo-fmt", "git-rustfmt", "bin", "format-diff"];
245 for dir in bin_directories {
246 let mut path = PathBuf::from("src");
248 path.push("main.rs");
251 files.push(PathBuf::from("src/lib.rs"));
253 let (reports, count, fails) = check_files(files, Some(PathBuf::from("rustfmt.toml")));
254 let mut warnings = 0;
257 println!("Ran {} self tests.", count);
258 assert_eq!(fails, 0, "{} self tests failed", fails);
260 for format_report in reports {
261 println!("{}", format_report);
262 warnings += format_report.warning_count();
267 "Rustfmt's code generated {} warnings",
273 fn stdin_formatting_smoke_test() {
274 let input = Input::Text("fn main () {}".to_owned());
275 let mut config = Config::default();
276 config.set().emit_mode(EmitMode::Stdout);
277 let mut buf: Vec<u8> = vec![];
279 let mut session = Session::new(config, Some(&mut buf));
280 session.format(input).unwrap();
281 assert!(session.has_no_errors());
283 //eprintln!("{:?}", );
285 assert_eq!(buf, "fn main() {}\n".as_bytes());
287 assert_eq!(buf, "fn main() {}\r\n".as_bytes());
290 // FIXME(#1990) restore this test
292 // fn stdin_disable_all_formatting_test() {
293 // let input = String::from("fn main() { println!(\"This should not be formatted.\"); }");
294 // let mut child = Command::new("./target/debug/rustfmt")
295 // .stdin(Stdio::piped())
296 // .stdout(Stdio::piped())
297 // .arg("--config-path=./tests/config/disable_all_formatting.toml")
299 // .expect("failed to execute child");
302 // let stdin = child.stdin.as_mut().expect("failed to get stdin");
304 // .write_all(input.as_bytes())
305 // .expect("failed to write stdin");
307 // let output = child.wait_with_output().expect("failed to wait on child");
308 // assert!(output.status.success());
309 // assert!(output.stderr.is_empty());
310 // assert_eq!(input, String::from_utf8(output.stdout).unwrap());
314 fn format_lines_errors_are_reported() {
315 let long_identifier = String::from_utf8(vec![b'a'; 239]).unwrap();
316 let input = Input::Text(format!("fn {}() {{}}", long_identifier));
317 let mut config = Config::default();
318 config.set().error_on_line_overflow(true);
319 let mut session = Session::<io::Stdout>::new(config, None);
320 session.format(input).unwrap();
321 assert!(session.has_formatting_errors());
325 fn format_lines_errors_are_reported_with_tabs() {
326 let long_identifier = String::from_utf8(vec![b'a'; 97]).unwrap();
327 let input = Input::Text(format!("fn a() {{\n\t{}\n}}", long_identifier));
328 let mut config = Config::default();
329 config.set().error_on_line_overflow(true);
330 config.set().hard_tabs(true);
331 let mut session = Session::<io::Stdout>::new(config, None);
332 session.format(input).unwrap();
333 assert!(session.has_formatting_errors());
336 // For each file, run rustfmt and collect the output.
337 // Returns the number of files checked and the number of failures.
338 fn check_files(files: Vec<PathBuf>, opt_config: Option<PathBuf>) -> (Vec<FormatReport>, u32, u32) {
341 let mut reports = vec![];
343 for file_name in files {
344 debug!("Testing '{}'...", file_name.display());
346 match idempotent_check(&file_name, &opt_config) {
347 Ok(ref report) if report.has_warnings() => {
348 print!("{}", report);
351 Ok(report) => reports.push(report),
353 if let IdempotentCheckError::Mismatch(msg) = err {
354 print_mismatches_default_message(msg);
363 (reports, count, fails)
366 fn print_mismatches_default_message(result: HashMap<PathBuf, Vec<Mismatch>>) {
367 for (file_name, diff) in result {
368 let mismatch_msg_formatter =
369 |line_num| format!("\nMismatch at {}:{}:", file_name.display(), line_num);
370 print_diff(diff, &mismatch_msg_formatter, &Default::default());
373 if let Some(mut t) = term::stdout() {
374 t.reset().unwrap_or(());
378 fn print_mismatches<T: Fn(u32) -> String>(
379 result: HashMap<PathBuf, Vec<Mismatch>>,
380 mismatch_msg_formatter: T,
382 for (_file_name, diff) in result {
383 print_diff(diff, &mismatch_msg_formatter, &Default::default());
386 if let Some(mut t) = term::stdout() {
387 t.reset().unwrap_or(());
391 fn read_config(filename: &Path) -> Config {
392 let sig_comments = read_significant_comments(filename);
393 // Look for a config file... If there is a 'config' property in the significant comments, use
394 // that. Otherwise, if there are no significant comments at all, look for a config file with
395 // the same name as the test file.
396 let mut config = if !sig_comments.is_empty() {
397 get_config(sig_comments.get("config").map(Path::new))
399 get_config(filename.with_extension("toml").file_name().map(Path::new))
402 for (key, val) in &sig_comments {
403 if key != "target" && key != "config" {
404 config.override_value(key, val);
405 if config.is_default(key) {
406 warn!("Default value {} used explicitly for {}", val, key);
411 // Don't generate warnings for to-do items.
412 config.set().report_todo(ReportTactic::Never);
417 fn format_file<P: Into<PathBuf>>(filepath: P, config: Config) -> (bool, SourceFile, FormatReport) {
418 let filepath = filepath.into();
419 let input = Input::File(filepath);
420 let mut session = Session::<io::Stdout>::new(config, None);
421 let result = session.format(input).unwrap();
422 let parsing_errors = session.has_parsing_errors();
423 let mut source_file = SourceFile::new();
424 mem::swap(&mut session.source_file, &mut source_file);
425 (parsing_errors, source_file, result)
428 enum IdempotentCheckError {
429 Mismatch(HashMap<PathBuf, Vec<Mismatch>>),
435 opt_config: &Option<PathBuf>,
436 ) -> Result<FormatReport, IdempotentCheckError> {
437 let sig_comments = read_significant_comments(filename);
438 let config = if let Some(ref config_file_path) = opt_config {
439 Config::from_toml_path(config_file_path).expect("rustfmt.toml not found")
441 read_config(filename)
443 let (parsing_errors, source_file, format_report) = format_file(filename, config);
445 return Err(IdempotentCheckError::Parse);
448 let mut write_result = HashMap::new();
449 for (filename, text) in source_file {
450 if let FileName::Real(ref filename) = filename {
451 write_result.insert(filename.to_owned(), text);
455 let target = sig_comments.get("target").map(|x| &(*x)[..]);
457 handle_result(write_result, target).map(|_| format_report)
460 // Reads test config file using the supplied (optional) file name. If there's no file name or the
461 // file doesn't exist, just return the default config. Otherwise, the file must be read
463 fn get_config(config_file: Option<&Path>) -> Config {
464 let config_file_name = match config_file {
465 None => return Default::default(),
467 let mut full_path = PathBuf::from("tests/config/");
468 full_path.push(file_name);
469 if !full_path.exists() {
470 return Default::default();
476 let mut def_config_file = fs::File::open(config_file_name).expect("Couldn't open config");
477 let mut def_config = String::new();
479 .read_to_string(&mut def_config)
480 .expect("Couldn't read config");
482 Config::from_toml(&def_config, Path::new("tests/config/")).expect("Invalid toml")
485 // Reads significant comments of the form: // rustfmt-key: value
487 fn read_significant_comments(file_name: &Path) -> HashMap<String, String> {
489 fs::File::open(file_name).expect(&format!("Couldn't read file {}", file_name.display()));
490 let reader = BufReader::new(file);
491 let pattern = r"^\s*//\s*rustfmt-([^:]+):\s*(\S+)";
492 let regex = regex::Regex::new(pattern).expect("Failed creating pattern 1");
494 // Matches lines containing significant comments or whitespace.
495 let line_regex = regex::Regex::new(r"(^\s*$)|(^\s*//\s*rustfmt-[^:]+:\s*\S+)")
496 .expect("Failed creating pattern 2");
500 .map(|line| line.expect("Failed getting line"))
501 .take_while(|line| line_regex.is_match(line))
503 regex.captures_iter(&line).next().map(|capture| {
507 .expect("Couldn't unwrap capture")
512 .expect("Couldn't unwrap capture")
520 // Compare output to input.
521 // TODO: needs a better name, more explanation.
523 result: HashMap<PathBuf, String>,
524 target: Option<&str>,
525 ) -> Result<(), IdempotentCheckError> {
526 let mut failures = HashMap::new();
528 for (file_name, fmt_text) in result {
529 // If file is in tests/source, compare to file with same name in tests/target.
530 let target = get_target(&file_name, target);
531 let open_error = format!("Couldn't open target {:?}", &target);
532 let mut f = fs::File::open(&target).expect(&open_error);
534 let mut text = String::new();
535 let read_error = format!("Failed reading target {:?}", &target);
536 f.read_to_string(&mut text).expect(&read_error);
538 // Ignore LF and CRLF difference for Windows.
539 if !string_eq_ignore_newline_repr(&fmt_text, &text) {
540 let diff = make_diff(&text, &fmt_text, DIFF_CONTEXT_SIZE);
543 "Empty diff? Maybe due to a missing a newline at the end of a file?"
545 failures.insert(file_name, diff);
549 if failures.is_empty() {
552 Err(IdempotentCheckError::Mismatch(failures))
556 // Map source file paths to their target paths.
557 fn get_target(file_name: &Path, target: Option<&str>) -> PathBuf {
558 if let Some(n) = file_name
560 .position(|c| c.as_os_str() == "source")
562 let mut target_file_name = PathBuf::new();
563 for (i, c) in file_name.components().enumerate() {
565 target_file_name.push("target");
567 target_file_name.push(c.as_os_str());
570 if let Some(replace_name) = target {
571 target_file_name.with_file_name(replace_name)
576 // This is either and idempotence check or a self check
582 fn rustfmt_diff_make_diff_tests() {
583 let diff = make_diff("a\nb\nc\nd", "a\ne\nc\nd", 3);
590 DiffLine::Context("a".into()),
591 DiffLine::Resulting("b".into()),
592 DiffLine::Expected("e".into()),
593 DiffLine::Context("c".into()),
594 DiffLine::Context("d".into()),
601 fn rustfmt_diff_no_diff_test() {
602 let diff = make_diff("a\nb\nc\nd", "a\nb\nc\nd", 3);
603 assert_eq!(diff, vec![]);
606 // Compare strings without distinguishing between CRLF and LF
607 fn string_eq_ignore_newline_repr(left: &str, right: &str) -> bool {
608 let left = CharsIgnoreNewlineRepr(left.chars().peekable());
609 let right = CharsIgnoreNewlineRepr(right.chars().peekable());
613 struct CharsIgnoreNewlineRepr<'a>(Peekable<Chars<'a>>);
615 impl<'a> Iterator for CharsIgnoreNewlineRepr<'a> {
618 fn next(&mut self) -> Option<char> {
619 self.0.next().map(|c| {
621 if *self.0.peek().unwrap_or(&'\0') == '\n' {
635 fn string_eq_ignore_newline_repr_test() {
636 assert!(string_eq_ignore_newline_repr("", ""));
637 assert!(!string_eq_ignore_newline_repr("", "abc"));
638 assert!(!string_eq_ignore_newline_repr("abc", ""));
639 assert!(string_eq_ignore_newline_repr("a\nb\nc\rd", "a\nb\r\nc\rd"));
640 assert!(string_eq_ignore_newline_repr("a\r\n\r\n\r\nb", "a\n\n\nb"));
641 assert!(!string_eq_ignore_newline_repr("a\r\nbcd", "a\nbcdefghijk"));
644 // This enum is used to represent one of three text features in Configurations.md: a block of code
645 // with its starting line number, the name of a rustfmt configuration option, or the value of a
646 // rustfmt configuration option.
647 enum ConfigurationSection {
648 CodeBlock((String, u32)), // (String: block of code, u32: line number of code block start)
653 impl ConfigurationSection {
654 fn get_section<I: Iterator<Item = String>>(
655 file: &mut Enumerate<I>,
656 ) -> Option<ConfigurationSection> {
658 static ref CONFIG_NAME_REGEX: regex::Regex =
659 regex::Regex::new(r"^## `([^`]+)`").expect("Failed creating configuration pattern");
660 static ref CONFIG_VALUE_REGEX: regex::Regex =
661 regex::Regex::new(r#"^#### `"?([^`"]+)"?`"#)
662 .expect("Failed creating configuration value pattern");
668 if line.starts_with("```rust") {
669 // Get the lines of the code block.
670 let lines: Vec<String> = file
672 .take_while(|l| !l.starts_with("```"))
674 let block = format!("{}\n", lines.join("\n"));
676 // +1 to translate to one-based indexing
677 // +1 to get to first line of code (line after "```")
678 let start_line = (i + 2) as u32;
680 return Some(ConfigurationSection::CodeBlock((block, start_line)));
681 } else if let Some(c) = CONFIG_NAME_REGEX.captures(&line) {
682 return Some(ConfigurationSection::ConfigName(String::from(&c[1])));
683 } else if let Some(c) = CONFIG_VALUE_REGEX.captures(&line) {
684 return Some(ConfigurationSection::ConfigValue(String::from(&c[1])));
687 None => return None, // reached the end of the file
693 // This struct stores the information about code blocks in the configurations
694 // file, formats the code blocks, and prints formatting errors.
695 struct ConfigCodeBlock {
696 config_name: Option<String>,
697 config_value: Option<String>,
698 code_block: Option<String>,
699 code_block_start: Option<u32>,
702 impl ConfigCodeBlock {
703 fn new() -> ConfigCodeBlock {
708 code_block_start: None,
712 fn set_config_name(&mut self, name: Option<String>) {
713 self.config_name = name;
714 self.config_value = None;
717 fn set_config_value(&mut self, value: Option<String>) {
718 self.config_value = value;
721 fn set_code_block(&mut self, code_block: String, code_block_start: u32) {
722 self.code_block = Some(code_block);
723 self.code_block_start = Some(code_block_start);
726 fn get_block_config(&self) -> Config {
727 let mut config = Config::default();
728 if self.config_value.is_some() && self.config_value.is_some() {
729 config.override_value(
730 self.config_name.as_ref().unwrap(),
731 self.config_value.as_ref().unwrap(),
737 fn code_block_valid(&self) -> bool {
738 // We never expect to not have a code block.
739 assert!(self.code_block.is_some() && self.code_block_start.is_some());
741 // See if code block begins with #![rustfmt::skip].
749 == "#![rustfmt::skip]";
751 if self.config_name.is_none() && !fmt_skip {
752 write_message(&format!(
753 "No configuration name for {}:{}",
754 CONFIGURATIONS_FILE_NAME,
755 self.code_block_start.unwrap()
759 if self.config_value.is_none() && !fmt_skip {
760 write_message(&format!(
761 "No configuration value for {}:{}",
762 CONFIGURATIONS_FILE_NAME,
763 self.code_block_start.unwrap()
770 fn has_parsing_errors<T: Write>(&self, session: &Session<T>) -> bool {
771 if session.has_parsing_errors() {
772 write_message(&format!(
773 "\u{261d}\u{1f3fd} Cannot format {}:{}",
774 CONFIGURATIONS_FILE_NAME,
775 self.code_block_start.unwrap()
783 fn print_diff(&self, compare: Vec<Mismatch>) {
784 let mut mismatches = HashMap::new();
785 mismatches.insert(PathBuf::from(CONFIGURATIONS_FILE_NAME), compare);
786 print_mismatches(mismatches, |line_num| {
788 "\nMismatch at {}:{}:",
789 CONFIGURATIONS_FILE_NAME,
790 line_num + self.code_block_start.unwrap() - 1
795 fn formatted_has_diff(&self, text: &str) -> bool {
796 let compare = make_diff(self.code_block.as_ref().unwrap(), text, DIFF_CONTEXT_SIZE);
797 if !compare.is_empty() {
798 self.print_diff(compare);
805 // Return a bool indicating if formatting this code block is an idempotent
806 // operation. This function also triggers printing any formatting failure
808 fn formatted_is_idempotent(&self) -> bool {
809 // Verify that we have all of the expected information.
810 if !self.code_block_valid() {
814 let input = Input::Text(self.code_block.as_ref().unwrap().to_owned());
815 let mut config = self.get_block_config();
816 config.set().emit_mode(EmitMode::Stdout);
817 let mut buf: Vec<u8> = vec![];
820 let mut session = Session::new(config, Some(&mut buf));
821 session.format(input).unwrap();
822 if self.has_parsing_errors(&session) {
827 !self.formatted_has_diff(&String::from_utf8(buf).unwrap())
830 // Extract a code block from the iterator. Behavior:
831 // - Rust code blocks are identifed by lines beginning with "```rust".
832 // - One explicit configuration setting is supported per code block.
833 // - Rust code blocks with no configuration setting are illegal and cause an
834 // assertion failure, unless the snippet begins with #![rustfmt::skip].
835 // - Configuration names in Configurations.md must be in the form of
837 // - Configuration values in Configurations.md must be in the form of
839 fn extract<I: Iterator<Item = String>>(
840 file: &mut Enumerate<I>,
841 prev: Option<&ConfigCodeBlock>,
842 hash_set: &mut HashSet<String>,
843 ) -> Option<ConfigCodeBlock> {
844 let mut code_block = ConfigCodeBlock::new();
845 code_block.config_name = prev.and_then(|cb| cb.config_name.clone());
848 match ConfigurationSection::get_section(file) {
849 Some(ConfigurationSection::CodeBlock((block, start_line))) => {
850 code_block.set_code_block(block, start_line);
853 Some(ConfigurationSection::ConfigName(name)) => {
855 Config::is_valid_name(&name),
856 "an unknown configuration option was found: {}",
860 hash_set.remove(&name),
861 "multiple configuration guides found for option {}",
864 code_block.set_config_name(Some(name));
866 Some(ConfigurationSection::ConfigValue(value)) => {
867 code_block.set_config_value(Some(value));
869 None => return None, // end of file was reached
878 fn configuration_snippet_tests() {
879 // Read Configurations.md and build a `Vec` of `ConfigCodeBlock` structs with one
880 // entry for each Rust code block found.
881 fn get_code_blocks() -> Vec<ConfigCodeBlock> {
882 let mut file_iter = BufReader::new(
883 fs::File::open(Path::new(CONFIGURATIONS_FILE_NAME))
884 .expect(&format!("Couldn't read file {}", CONFIGURATIONS_FILE_NAME)),
888 let mut code_blocks: Vec<ConfigCodeBlock> = Vec::new();
889 let mut hash_set = Config::hash_set();
892 ConfigCodeBlock::extract(&mut file_iter, code_blocks.last(), &mut hash_set)
894 code_blocks.push(cb);
897 for name in hash_set {
898 if !Config::is_hidden_option(&name) {
899 panic!("{} does not have a configuration guide", name);
906 let blocks = get_code_blocks();
907 let failures = blocks
909 .map(|b| b.formatted_is_idempotent())
910 .fold(0, |acc, r| acc + (!r as u32));
913 println!("Ran {} configurations tests.", blocks.len());
914 assert_eq!(failures, 0, "{} configurations tests failed", failures);
921 fn make_temp_file(file_name: &'static str) -> TempFile {
925 // Used in the Rust build system.
926 let target_dir = var("RUSTFMT_TEST_DIR").unwrap_or_else(|_| ".".to_owned());
927 let path = Path::new(&target_dir).join(file_name);
929 let mut file = File::create(&path).expect("Couldn't create temp file");
930 let content = "fn main() {}\n";
931 file.write_all(content.as_bytes())
932 .expect("Couldn't write temp file");
936 impl Drop for TempFile {
938 use std::fs::remove_file;
939 remove_file(&self.path).expect("Couldn't delete temp file");
943 fn rustfmt() -> PathBuf {
944 let mut me = env::current_exe().expect("failed to get current executable");
945 me.pop(); // chop of the test name
946 me.pop(); // chop off `deps`
949 me.is_file() || me.with_extension("exe").is_file(),
950 "no rustfmt bin, try running `cargo build` before testing"
956 fn verify_check_works() {
957 let temp_file = make_temp_file("temp_check.rs");
958 assert_cli::Assert::command(&[
959 rustfmt().to_str().unwrap(),
961 temp_file.path.to_str().unwrap(),