1 // Copyright 2012-2014 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.
12 use common::{CompileFail, ParseFail, Pretty, RunFail, RunPass, RunPassValgrind};
13 use common::{Codegen, DebugInfoLldb, DebugInfoGdb, Rustdoc, CodegenUnits};
14 use common::{Incremental, RunMake, Ui, MirOpt};
16 use errors::{self, ErrorKind, Error};
17 use filetime::FileTime;
19 use header::TestProps;
23 use std::collections::HashMap;
24 use std::collections::HashSet;
26 use std::ffi::OsString;
27 use std::fs::{self, File, create_dir_all};
29 use std::io::prelude::*;
30 use std::io::{self, BufReader};
31 use std::path::{Path, PathBuf};
32 use std::process::{Command, Output, ExitStatus, Stdio};
35 use extract_gdb_version;
37 /// The name of the environment variable that holds dynamic library locations.
38 pub fn dylib_env_var() -> &'static str {
41 } else if cfg!(target_os = "macos") {
43 } else if cfg!(target_os = "haiku") {
50 pub fn run(config: Config, testpaths: &TestPaths) {
51 match &*config.target {
53 "arm-linux-androideabi" | "armv7-linux-androideabi" | "aarch64-linux-android" => {
54 if !config.adb_device_status {
55 panic!("android device not available");
60 // android has its own gdb handling
61 if config.mode == DebugInfoGdb && config.gdb.is_none() {
62 panic!("gdb not available but debuginfo gdb debuginfo test requested");
68 // We're going to be dumping a lot of info. Start on a new line.
71 debug!("running {:?}", testpaths.file.display());
72 let base_props = TestProps::from_file(&testpaths.file, &config);
74 let base_cx = TestCx { config: &config,
80 if base_props.revisions.is_empty() {
81 base_cx.run_revision()
83 for revision in &base_props.revisions {
84 let mut revision_props = base_props.clone();
85 revision_props.load_from(&testpaths.file, Some(revision), &config);
88 props: &revision_props,
90 revision: Some(revision)
92 rev_cx.run_revision();
96 base_cx.complete_all();
98 File::create(::stamp(&config, testpaths)).unwrap();
101 struct TestCx<'test> {
102 config: &'test Config,
103 props: &'test TestProps,
104 testpaths: &'test TestPaths,
105 revision: Option<&'test str>
108 struct DebuggerCommands {
109 commands: Vec<String>,
110 check_lines: Vec<String>,
111 breakpoint_lines: Vec<usize>,
114 impl<'test> TestCx<'test> {
115 /// invoked once before any revisions have been processed
117 assert!(self.revision.is_none(), "init_all invoked for a revision");
118 if let Incremental = self.config.mode {
119 self.init_incremental_test()
123 /// Code executed for each revision in turn (or, if there are no
124 /// revisions, exactly once, with revision == None).
125 fn run_revision(&self) {
126 match self.config.mode {
128 ParseFail => self.run_cfail_test(),
129 RunFail => self.run_rfail_test(),
130 RunPass => self.run_rpass_test(),
131 RunPassValgrind => self.run_valgrind_test(),
132 Pretty => self.run_pretty_test(),
133 DebugInfoGdb => self.run_debuginfo_gdb_test(),
134 DebugInfoLldb => self.run_debuginfo_lldb_test(),
135 Codegen => self.run_codegen_test(),
136 Rustdoc => self.run_rustdoc_test(),
137 CodegenUnits => self.run_codegen_units_test(),
138 Incremental => self.run_incremental_test(),
139 RunMake => self.run_rmake_test(),
140 Ui => self.run_ui_test(),
141 MirOpt => self.run_mir_opt_test(),
145 /// Invoked after all revisions have executed.
146 fn complete_all(&self) {
147 assert!(self.revision.is_none(), "init_all invoked for a revision");
150 fn run_cfail_test(&self) {
151 let proc_res = self.compile_test();
153 if self.props.must_compile_successfully {
154 if !proc_res.status.success() {
156 "test compilation failed although it shouldn't!",
160 if proc_res.status.success() {
162 &format!("{} test compiled successfully!", self.config.mode)[..],
166 self.check_correct_failure_status(&proc_res);
169 let output_to_check = self.get_output(&proc_res);
170 let expected_errors = errors::load_errors(&self.testpaths.file, self.revision);
171 if !expected_errors.is_empty() {
172 if !self.props.error_patterns.is_empty() {
173 self.fatal("both error pattern and expected errors specified");
175 self.check_expected_errors(expected_errors, &proc_res);
177 self.check_error_patterns(&output_to_check, &proc_res);
180 self.check_no_compiler_crash(&proc_res);
181 self.check_forbid_output(&output_to_check, &proc_res);
184 fn run_rfail_test(&self) {
185 let proc_res = self.compile_test();
187 if !proc_res.status.success() {
188 self.fatal_proc_rec("compilation failed!", &proc_res);
191 let proc_res = self.exec_compiled_test();
193 // The value our Makefile configures valgrind to return on failure
194 const VALGRIND_ERR: i32 = 100;
195 if proc_res.status.code() == Some(VALGRIND_ERR) {
196 self.fatal_proc_rec("run-fail test isn't valgrind-clean!", &proc_res);
199 let output_to_check = self.get_output(&proc_res);
200 self.check_correct_failure_status(&proc_res);
201 self.check_error_patterns(&output_to_check, &proc_res);
204 fn get_output(&self, proc_res: &ProcRes) -> String {
205 if self.props.check_stdout {
206 format!("{}{}", proc_res.stdout, proc_res.stderr)
208 proc_res.stderr.clone()
212 fn check_correct_failure_status(&self, proc_res: &ProcRes) {
213 // The value the rust runtime returns on failure
214 const RUST_ERR: i32 = 101;
215 if proc_res.status.code() != Some(RUST_ERR) {
217 &format!("failure produced the wrong error: {}",
223 fn run_rpass_test(&self) {
224 let proc_res = self.compile_test();
226 if !proc_res.status.success() {
227 self.fatal_proc_rec("compilation failed!", &proc_res);
230 // FIXME(#41968): Move this check to tidy?
231 let expected_errors = errors::load_errors(&self.testpaths.file, self.revision);
232 assert!(expected_errors.is_empty(),
233 "run-pass tests with expected warnings should be moved to ui/");
235 let proc_res = self.exec_compiled_test();
237 if !proc_res.status.success() {
238 self.fatal_proc_rec("test run failed!", &proc_res);
242 fn run_valgrind_test(&self) {
243 assert!(self.revision.is_none(), "revisions not relevant here");
245 if self.config.valgrind_path.is_none() {
246 assert!(!self.config.force_valgrind);
247 return self.run_rpass_test();
250 let mut proc_res = self.compile_test();
252 if !proc_res.status.success() {
253 self.fatal_proc_rec("compilation failed!", &proc_res);
256 let mut new_config = self.config.clone();
257 new_config.runtool = new_config.valgrind_path.clone();
258 let new_cx = TestCx { config: &new_config, ..*self };
259 proc_res = new_cx.exec_compiled_test();
261 if !proc_res.status.success() {
262 self.fatal_proc_rec("test run failed!", &proc_res);
266 fn run_pretty_test(&self) {
267 if self.props.pp_exact.is_some() {
268 logv(self.config, "testing for exact pretty-printing".to_owned());
270 logv(self.config, "testing for converging pretty-printing".to_owned());
273 let rounds = match self.props.pp_exact { Some(_) => 1, None => 2 };
275 let mut src = String::new();
276 File::open(&self.testpaths.file).unwrap().read_to_string(&mut src).unwrap();
277 let mut srcs = vec![src];
280 while round < rounds {
281 logv(self.config, format!("pretty-printing round {} revision {:?}",
282 round, self.revision));
283 let proc_res = self.print_source(srcs[round].to_owned(), &self.props.pretty_mode);
285 if !proc_res.status.success() {
286 self.fatal_proc_rec(&format!("pretty-printing failed in round {} revision {:?}",
287 round, self.revision),
291 let ProcRes{ stdout, .. } = proc_res;
296 let mut expected = match self.props.pp_exact {
298 let filepath = self.testpaths.file.parent().unwrap().join(file);
299 let mut s = String::new();
300 File::open(&filepath).unwrap().read_to_string(&mut s).unwrap();
303 None => { srcs[srcs.len() - 2].clone() }
305 let mut actual = srcs[srcs.len() - 1].clone();
307 if self.props.pp_exact.is_some() {
308 // Now we have to care about line endings
309 let cr = "\r".to_owned();
310 actual = actual.replace(&cr, "").to_owned();
311 expected = expected.replace(&cr, "").to_owned();
314 self.compare_source(&expected, &actual);
316 // If we're only making sure that the output matches then just stop here
317 if self.props.pretty_compare_only { return; }
319 // Finally, let's make sure it actually appears to remain valid code
320 let proc_res = self.typecheck_source(actual);
321 if !proc_res.status.success() {
322 self.fatal_proc_rec("pretty-printed source does not typecheck", &proc_res);
325 if !self.props.pretty_expanded { return }
327 // additionally, run `--pretty expanded` and try to build it.
328 let proc_res = self.print_source(srcs[round].clone(), "expanded");
329 if !proc_res.status.success() {
330 self.fatal_proc_rec("pretty-printing (expanded) failed", &proc_res);
333 let ProcRes{ stdout: expanded_src, .. } = proc_res;
334 let proc_res = self.typecheck_source(expanded_src);
335 if !proc_res.status.success() {
337 "pretty-printed source (expanded) does not typecheck",
342 fn print_source(&self, src: String, pretty_type: &str) -> ProcRes {
343 let aux_dir = self.aux_output_dir_name();
345 let mut rustc = Command::new(&self.config.rustc_path);
347 .arg("-Zunstable-options")
348 .args(&["--unpretty", &pretty_type])
349 .args(&["--target", &self.config.target])
350 .arg("-L").arg(&aux_dir)
351 .args(self.split_maybe_args(&self.config.target_rustcflags))
352 .args(&self.props.compile_flags)
353 .envs(self.props.exec_env.clone());
355 self.compose_and_run(rustc,
356 self.config.compile_lib_path.to_str().unwrap(),
357 Some(aux_dir.to_str().unwrap()),
361 fn compare_source(&self,
364 if expected != actual {
365 self.error("pretty-printed source does not match expected source");
368 ------------------------------------------\n\
370 ------------------------------------------\n\
372 ------------------------------------------\n\
374 ------------------------------------------\n\
381 fn typecheck_source(&self, src: String) -> ProcRes {
382 let mut rustc = Command::new(&self.config.rustc_path);
384 let out_dir = self.output_base_name().with_extension("pretty-out");
385 let _ = fs::remove_dir_all(&out_dir);
386 create_dir_all(&out_dir).unwrap();
388 let target = if self.props.force_host {
394 let aux_dir = self.aux_output_dir_name();
398 .arg("--out-dir").arg(&out_dir)
399 .arg(&format!("--target={}", target))
400 .arg("-L").arg(&self.config.build_base)
401 .arg("-L").arg(aux_dir);
403 if let Some(revision) = self.revision {
404 rustc.args(&["--cfg", revision]);
407 rustc.args(self.split_maybe_args(&self.config.target_rustcflags));
408 rustc.args(&self.props.compile_flags);
410 self.compose_and_run_compiler(rustc, Some(src))
413 fn run_debuginfo_gdb_test(&self) {
414 assert!(self.revision.is_none(), "revisions not relevant here");
416 let config = Config {
417 target_rustcflags: self.cleanup_debug_info_options(&self.config.target_rustcflags),
418 host_rustcflags: self.cleanup_debug_info_options(&self.config.host_rustcflags),
419 .. self.config.clone()
422 let test_cx = TestCx {
427 test_cx.run_debuginfo_gdb_test_no_opt();
430 fn run_debuginfo_gdb_test_no_opt(&self) {
431 let prefixes = if self.config.gdb_native_rust {
433 static PREFIXES: &'static [&'static str] = &["gdb", "gdbr"];
434 println!("NOTE: compiletest thinks it is using GDB with native rust support");
438 static PREFIXES: &'static [&'static str] = &["gdb", "gdbg"];
439 println!("NOTE: compiletest thinks it is using GDB without native rust support");
443 let DebuggerCommands {
447 } = self.parse_debugger_commands(prefixes);
448 let mut cmds = commands.join("\n");
450 // compile test file (it should have 'compile-flags:-g' in the header)
451 let compiler_run_result = self.compile_test();
452 if !compiler_run_result.status.success() {
453 self.fatal_proc_rec("compilation failed!", &compiler_run_result);
456 let exe_file = self.make_exe_name();
458 let debugger_run_result;
459 match &*self.config.target {
460 "arm-linux-androideabi" |
461 "armv7-linux-androideabi" |
462 "aarch64-linux-android" => {
464 cmds = cmds.replace("run", "continue");
466 let tool_path = match self.config.android_cross_path.to_str() {
467 Some(x) => x.to_owned(),
468 None => self.fatal("cannot find android cross path")
471 // write debugger script
472 let mut script_str = String::with_capacity(2048);
473 script_str.push_str(&format!("set charset {}\n", Self::charset()));
474 script_str.push_str(&format!("set sysroot {}\n", tool_path));
475 script_str.push_str(&format!("file {}\n", exe_file.to_str().unwrap()));
476 script_str.push_str("target remote :5039\n");
477 script_str.push_str(&format!("set solib-search-path \
478 ./{}/stage2/lib/rustlib/{}/lib/\n",
479 self.config.host, self.config.target));
480 for line in &breakpoint_lines {
481 script_str.push_str(&format!("break {:?}:{}\n",
482 self.testpaths.file.file_name()
487 script_str.push_str(&cmds);
488 script_str.push_str("\nquit\n");
490 debug!("script_str = {}", script_str);
491 self.dump_output_file(&script_str, "debugger.script");
493 let adb_path = &self.config.adb_path;
495 Command::new(adb_path)
498 .arg(&self.config.adb_test_dir)
500 .expect(&format!("failed to exec `{:?}`", adb_path));
502 Command::new(adb_path)
503 .args(&["forward", "tcp:5039", "tcp:5039"])
505 .expect(&format!("failed to exec `{:?}`", adb_path));
507 let adb_arg = format!("export LD_LIBRARY_PATH={}; \
508 gdbserver{} :5039 {}/{}",
509 self.config.adb_test_dir.clone(),
510 if self.config.target.contains("aarch64")
512 self.config.adb_test_dir.clone(),
513 exe_file.file_name().unwrap().to_str()
516 debug!("adb arg: {}", adb_arg);
517 let mut adb = Command::new(adb_path)
518 .args(&["shell", &adb_arg])
519 .stdout(Stdio::piped())
520 .stderr(Stdio::inherit())
522 .expect(&format!("failed to exec `{:?}`", adb_path));
524 // Wait for the gdbserver to print out "Listening on port ..."
525 // at which point we know that it's started and then we can
526 // execute the debugger below.
527 let mut stdout = BufReader::new(adb.stdout.take().unwrap());
528 let mut line = String::new();
531 stdout.read_line(&mut line).unwrap();
532 if line.starts_with("Listening on port 5039") {
538 let debugger_script = self.make_out_name("debugger.script");
539 // FIXME (#9639): This needs to handle non-utf8 paths
541 vec!["-quiet".to_owned(),
544 format!("-command={}", debugger_script.to_str().unwrap())];
546 let mut gdb_path = tool_path;
547 gdb_path.push_str("/bin/gdb");
552 } = Command::new(&gdb_path)
553 .args(&debugger_opts)
555 .expect(&format!("failed to exec `{:?}`", gdb_path));
557 let mut gdb = Command::new(&format!("{}-gdb", self.config.target));
558 gdb.args(&debugger_opts);
559 let cmdline = self.make_cmdline(&gdb, "");
560 logv(self.config, format!("executing {}", cmdline));
564 debugger_run_result = ProcRes {
566 stdout: String::from_utf8(stdout).unwrap(),
567 stderr: String::from_utf8(stderr).unwrap(),
570 if adb.kill().is_err() {
571 println!("Adb process is already finished.");
576 let rust_src_root = self.config.find_rust_src_root().expect(
577 "Could not find Rust source root",
579 let rust_pp_module_rel_path = Path::new("./src/etc");
580 let rust_pp_module_abs_path = rust_src_root.join(rust_pp_module_rel_path)
584 // write debugger script
585 let mut script_str = String::with_capacity(2048);
586 script_str.push_str(&format!("set charset {}\n", Self::charset()));
587 script_str.push_str("show version\n");
589 match self.config.gdb_version {
591 println!("NOTE: compiletest thinks it is using GDB version {}",
594 if version > extract_gdb_version("7.4").unwrap() {
595 // Add the directory containing the pretty printers to
596 // GDB's script auto loading safe path
598 &format!("add-auto-load-safe-path {}\n",
599 rust_pp_module_abs_path.replace(r"\", r"\\"))
604 println!("NOTE: compiletest does not know which version of \
609 // The following line actually doesn't have to do anything with
610 // pretty printing, it just tells GDB to print values on one line:
611 script_str.push_str("set print pretty off\n");
613 // Add the pretty printer directory to GDB's source-file search path
614 script_str.push_str(&format!("directory {}\n",
615 rust_pp_module_abs_path));
617 // Load the target executable
618 script_str.push_str(&format!("file {}\n",
619 exe_file.to_str().unwrap()
620 .replace(r"\", r"\\")));
622 // Force GDB to print values in the Rust format.
623 if self.config.gdb_native_rust {
624 script_str.push_str("set language rust\n");
627 // Add line breakpoints
628 for line in &breakpoint_lines {
629 script_str.push_str(&format!("break '{}':{}\n",
630 self.testpaths.file.file_name().unwrap()
635 script_str.push_str(&cmds);
636 script_str.push_str("\nquit\n");
638 debug!("script_str = {}", script_str);
639 self.dump_output_file(&script_str, "debugger.script");
641 let debugger_script = self.make_out_name("debugger.script");
643 // FIXME (#9639): This needs to handle non-utf8 paths
645 vec!["-quiet".to_owned(),
648 format!("-command={}", debugger_script.to_str().unwrap())];
650 let mut gdb = Command::new(self.config.gdb.as_ref().unwrap());
651 gdb.args(&debugger_opts)
652 .env("PYTHONPATH", rust_pp_module_abs_path);
654 debugger_run_result =
655 self.compose_and_run(gdb,
656 self.config.run_lib_path.to_str().unwrap(),
662 if !debugger_run_result.status.success() {
663 self.fatal_proc_rec("gdb failed to execute", &debugger_run_result);
666 self.check_debugger_output(&debugger_run_result, &check_lines);
669 fn run_debuginfo_lldb_test(&self) {
670 assert!(self.revision.is_none(), "revisions not relevant here");
672 if self.config.lldb_python_dir.is_none() {
673 self.fatal("Can't run LLDB test because LLDB's python path is not set.");
676 let config = Config {
677 target_rustcflags: self.cleanup_debug_info_options(&self.config.target_rustcflags),
678 host_rustcflags: self.cleanup_debug_info_options(&self.config.host_rustcflags),
679 .. self.config.clone()
683 let test_cx = TestCx {
688 test_cx.run_debuginfo_lldb_test_no_opt();
691 fn run_debuginfo_lldb_test_no_opt(&self) {
692 // compile test file (it should have 'compile-flags:-g' in the header)
693 let compile_result = self.compile_test();
694 if !compile_result.status.success() {
695 self.fatal_proc_rec("compilation failed!", &compile_result);
698 let exe_file = self.make_exe_name();
700 match self.config.lldb_version {
701 Some(ref version) => {
702 println!("NOTE: compiletest thinks it is using LLDB version {}",
706 println!("NOTE: compiletest does not know which version of \
711 // Parse debugger commands etc from test files
712 let DebuggerCommands {
717 } = self.parse_debugger_commands(&["lldb"]);
719 // Write debugger script:
720 // We don't want to hang when calling `quit` while the process is still running
721 let mut script_str = String::from("settings set auto-confirm true\n");
723 // Make LLDB emit its version, so we have it documented in the test output
724 script_str.push_str("version\n");
726 // Switch LLDB into "Rust mode"
727 let rust_src_root = self.config.find_rust_src_root().expect(
728 "Could not find Rust source root",
730 let rust_pp_module_rel_path = Path::new("./src/etc/lldb_rust_formatters.py");
731 let rust_pp_module_abs_path = rust_src_root.join(rust_pp_module_rel_path)
736 script_str.push_str(&format!("command script import {}\n",
737 &rust_pp_module_abs_path[..])[..]);
738 script_str.push_str("type summary add --no-value ");
739 script_str.push_str("--python-function lldb_rust_formatters.print_val ");
740 script_str.push_str("-x \".*\" --category Rust\n");
741 script_str.push_str("type category enable Rust\n");
743 // Set breakpoints on every line that contains the string "#break"
744 let source_file_name = self.testpaths.file.file_name().unwrap().to_string_lossy();
745 for line in &breakpoint_lines {
746 script_str.push_str(&format!("breakpoint set --file '{}' --line {}\n",
751 // Append the other commands
752 for line in &commands {
753 script_str.push_str(line);
754 script_str.push_str("\n");
757 // Finally, quit the debugger
758 script_str.push_str("\nquit\n");
760 // Write the script into a file
761 debug!("script_str = {}", script_str);
762 self.dump_output_file(&script_str, "debugger.script");
763 let debugger_script = self.make_out_name("debugger.script");
765 // Let LLDB execute the script via lldb_batchmode.py
766 let debugger_run_result = self.run_lldb(&exe_file,
770 if !debugger_run_result.status.success() {
771 self.fatal_proc_rec("Error while running LLDB", &debugger_run_result);
774 self.check_debugger_output(&debugger_run_result, &check_lines);
778 test_executable: &Path,
779 debugger_script: &Path,
780 rust_src_root: &Path)
782 // Prepare the lldb_batchmode which executes the debugger script
783 let lldb_script_path = rust_src_root.join("src/etc/lldb_batchmode.py");
784 self.cmd2procres(Command::new(&self.config.lldb_python)
785 .arg(&lldb_script_path)
786 .arg(test_executable)
787 .arg(debugger_script)
789 self.config.lldb_python_dir.as_ref().unwrap()))
792 fn cmd2procres(&self, cmd: &mut Command) -> ProcRes {
793 let (status, out, err) = match cmd.output() {
794 Ok(Output { status, stdout, stderr }) => {
796 String::from_utf8(stdout).unwrap(),
797 String::from_utf8(stderr).unwrap())
800 self.fatal(&format!("Failed to setup Python process for \
801 LLDB script: {}", e))
805 self.dump_output(&out, &err);
810 cmdline: format!("{:?}", cmd)
814 fn parse_debugger_commands(&self, debugger_prefixes: &[&str]) -> DebuggerCommands {
815 let directives = debugger_prefixes.iter().map(|prefix| (
816 format!("{}-command", prefix),
817 format!("{}-check", prefix),
818 )).collect::<Vec<_>>();
820 let mut breakpoint_lines = vec![];
821 let mut commands = vec![];
822 let mut check_lines = vec![];
824 let reader = BufReader::new(File::open(&self.testpaths.file).unwrap());
825 for line in reader.lines() {
828 if line.contains("#break") {
829 breakpoint_lines.push(counter);
832 for &(ref command_directive, ref check_directive) in &directives {
833 self.config.parse_name_value_directive(
835 command_directive).map(|cmd| {
839 self.config.parse_name_value_directive(
841 check_directive).map(|cmd| {
842 check_lines.push(cmd)
847 self.fatal(&format!("Error while parsing debugger commands: {}", e))
860 fn cleanup_debug_info_options(&self, options: &Option<String>) -> Option<String> {
861 if options.is_none() {
865 // Remove options that are either unwanted (-O) or may lead to duplicates due to RUSTFLAGS.
866 let options_to_remove = [
869 "--debuginfo".to_owned()
872 self.split_maybe_args(options).into_iter()
873 .filter(|x| !options_to_remove.contains(x))
874 .collect::<Vec<String>>();
876 Some(new_options.join(" "))
879 fn check_debugger_output(&self, debugger_run_result: &ProcRes, check_lines: &[String]) {
880 let num_check_lines = check_lines.len();
882 let mut check_line_index = 0;
883 for line in debugger_run_result.stdout.lines() {
884 if check_line_index >= num_check_lines {
888 if check_single_line(line, &(check_lines[check_line_index])[..]) {
889 check_line_index += 1;
892 if check_line_index != num_check_lines && num_check_lines > 0 {
893 self.fatal_proc_rec(&format!("line not found in debugger output: {}",
894 check_lines[check_line_index]),
895 debugger_run_result);
898 fn check_single_line(line: &str, check_line: &str) -> bool {
899 // Allow check lines to leave parts unspecified (e.g., uninitialized
900 // bits in the wrong case of an enum) with the notation "[...]".
901 let line = line.trim();
902 let check_line = check_line.trim();
903 let can_start_anywhere = check_line.starts_with("[...]");
904 let can_end_anywhere = check_line.ends_with("[...]");
906 let check_fragments: Vec<&str> = check_line.split("[...]")
907 .filter(|frag| !frag.is_empty())
909 if check_fragments.is_empty() {
913 let (mut rest, first_fragment) = if can_start_anywhere {
914 match line.find(check_fragments[0]) {
915 Some(pos) => (&line[pos + check_fragments[0].len() ..], 1),
922 for current_fragment in &check_fragments[first_fragment..] {
923 match rest.find(current_fragment) {
925 rest = &rest[pos + current_fragment.len() .. ];
931 if !can_end_anywhere && !rest.is_empty() {
939 fn check_error_patterns(&self,
940 output_to_check: &str,
941 proc_res: &ProcRes) {
942 if self.props.error_patterns.is_empty() {
943 if self.props.must_compile_successfully {
946 self.fatal(&format!("no error pattern specified in {:?}",
947 self.testpaths.file.display()));
950 let mut next_err_idx = 0;
951 let mut next_err_pat = self.props.error_patterns[next_err_idx].trim();
952 let mut done = false;
953 for line in output_to_check.lines() {
954 if line.contains(next_err_pat) {
955 debug!("found error pattern {}", next_err_pat);
957 if next_err_idx == self.props.error_patterns.len() {
958 debug!("found all error patterns");
962 next_err_pat = self.props.error_patterns[next_err_idx].trim();
967 let missing_patterns = &self.props.error_patterns[next_err_idx..];
968 if missing_patterns.len() == 1 {
970 &format!("error pattern '{}' not found!", missing_patterns[0]),
973 for pattern in missing_patterns {
974 self.error(&format!("error pattern '{}' not found!", *pattern));
976 self.fatal_proc_rec("multiple error patterns not found", proc_res);
980 fn check_no_compiler_crash(&self, proc_res: &ProcRes) {
981 for line in proc_res.stderr.lines() {
982 if line.contains("error: internal compiler error") {
983 self.fatal_proc_rec("compiler encountered internal error", proc_res);
988 fn check_forbid_output(&self,
989 output_to_check: &str,
990 proc_res: &ProcRes) {
991 for pat in &self.props.forbid_output {
992 if output_to_check.contains(pat) {
993 self.fatal_proc_rec("forbidden pattern found in compiler output", proc_res);
998 fn check_expected_errors(&self,
999 expected_errors: Vec<errors::Error>,
1000 proc_res: &ProcRes) {
1001 if proc_res.status.success() &&
1002 expected_errors.iter().any(|x| x.kind == Some(ErrorKind::Error)) {
1003 self.fatal_proc_rec("process did not return an error status", proc_res);
1007 format!("{}", self.testpaths.file.display())
1008 .replace(r"\", "/"); // on windows, translate all '\' path separators to '/'
1010 // If the testcase being checked contains at least one expected "help"
1011 // message, then we'll ensure that all "help" messages are expected.
1012 // Otherwise, all "help" messages reported by the compiler will be ignored.
1013 // This logic also applies to "note" messages.
1014 let expect_help = expected_errors.iter().any(|ee| ee.kind == Some(ErrorKind::Help));
1015 let expect_note = expected_errors.iter().any(|ee| ee.kind == Some(ErrorKind::Note));
1017 // Parse the JSON output from the compiler and extract out the messages.
1018 let actual_errors = json::parse_output(&file_name, &proc_res.stderr, proc_res);
1019 let mut unexpected = Vec::new();
1020 let mut found = vec![false; expected_errors.len()];
1021 for actual_error in &actual_errors {
1026 .position(|(index, expected_error)| {
1028 actual_error.line_num == expected_error.line_num &&
1029 (expected_error.kind.is_none() ||
1030 actual_error.kind == expected_error.kind) &&
1031 actual_error.msg.contains(&expected_error.msg)
1036 // found a match, everybody is happy
1037 assert!(!found[index]);
1038 found[index] = true;
1042 if self.is_unexpected_compiler_message(actual_error, expect_help, expect_note) {
1044 &format!("{}:{}: unexpected {:?}: '{}'",
1046 actual_error.line_num,
1047 actual_error.kind.as_ref()
1048 .map_or(String::from("message"),
1051 unexpected.push(actual_error);
1057 let mut not_found = Vec::new();
1058 // anything not yet found is a problem
1059 for (index, expected_error) in expected_errors.iter().enumerate() {
1062 &format!("{}:{}: expected {} not found: {}",
1064 expected_error.line_num,
1065 expected_error.kind.as_ref()
1066 .map_or("message".into(),
1068 expected_error.msg));
1069 not_found.push(expected_error);
1073 if !unexpected.is_empty() || !not_found.is_empty() {
1075 &format!("{} unexpected errors found, {} expected errors not found",
1076 unexpected.len(), not_found.len()));
1077 println!("status: {}\ncommand: {}",
1078 proc_res.status, proc_res.cmdline);
1079 if !unexpected.is_empty() {
1080 println!("unexpected errors (from JSON output): {:#?}\n", unexpected);
1082 if !not_found.is_empty() {
1083 println!("not found errors (from test file): {:#?}\n", not_found);
1089 /// Returns true if we should report an error about `actual_error`,
1090 /// which did not match any of the expected error. We always require
1091 /// errors/warnings to be explicitly listed, but only require
1092 /// helps/notes if there are explicit helps/notes given.
1093 fn is_unexpected_compiler_message(&self,
1094 actual_error: &Error,
1098 match actual_error.kind {
1099 Some(ErrorKind::Help) => expect_help,
1100 Some(ErrorKind::Note) => expect_note,
1101 Some(ErrorKind::Error) |
1102 Some(ErrorKind::Warning) => true,
1103 Some(ErrorKind::Suggestion) |
1108 fn compile_test(&self) -> ProcRes {
1109 let mut rustc = self.make_compile_args(
1110 &self.testpaths.file, TargetLocation::ThisFile(self.make_exe_name()));
1112 rustc.arg("-L").arg(&self.aux_output_dir_name());
1114 match self.config.mode {
1115 CompileFail | Ui => {
1116 // compile-fail and ui tests tend to have tons of unused code as
1117 // it's just testing various pieces of the compile, but we don't
1118 // want to actually assert warnings about all this code. Instead
1119 // let's just ignore unused code warnings by defaults and tests
1120 // can turn it back on if needed.
1121 rustc.args(&["-A", "unused"]);
1126 self.compose_and_run_compiler(rustc, None)
1129 fn document(&self, out_dir: &Path) -> ProcRes {
1130 if self.props.build_aux_docs {
1131 for rel_ab in &self.props.aux_builds {
1132 let aux_testpaths = self.compute_aux_test_paths(rel_ab);
1133 let aux_props = self.props.from_aux_file(&aux_testpaths.file,
1136 let aux_cx = TestCx {
1137 config: self.config,
1139 testpaths: &aux_testpaths,
1140 revision: self.revision
1142 let auxres = aux_cx.document(out_dir);
1143 if !auxres.status.success() {
1149 let aux_dir = self.aux_output_dir_name();
1151 let rustdoc_path = self.config.rustdoc_path.as_ref().expect("--rustdoc-path passed");
1152 let mut rustdoc = Command::new(rustdoc_path);
1154 rustdoc.arg("-L").arg(aux_dir)
1155 .arg("-o").arg(out_dir)
1156 .arg(&self.testpaths.file)
1157 .args(&self.props.compile_flags);
1159 self.compose_and_run_compiler(rustdoc, None)
1162 fn exec_compiled_test(&self) -> ProcRes {
1163 let env = &self.props.exec_env;
1165 match &*self.config.target {
1166 // This is pretty similar to below, we're transforming:
1168 // program arg1 arg2
1172 // remote-test-client run program:support-lib.so arg1 arg2
1174 // The test-client program will upload `program` to the emulator
1175 // along with all other support libraries listed (in this case
1176 // `support-lib.so`. It will then execute the program on the
1177 // emulator with the arguments specified (in the environment we give
1178 // the process) and then report back the same result.
1179 _ if self.config.remote_test_client.is_some() => {
1180 let aux_dir = self.aux_output_dir_name();
1181 let ProcArgs { mut prog, args } = self.make_run_args();
1182 if let Ok(entries) = aux_dir.read_dir() {
1183 for entry in entries {
1184 let entry = entry.unwrap();
1185 if !entry.path().is_file() {
1189 prog.push_str(entry.path().to_str().unwrap());
1192 let mut test_client = Command::new(
1193 self.config.remote_test_client.as_ref().unwrap());
1195 .args(&["run", &prog])
1198 self.compose_and_run(test_client,
1199 self.config.run_lib_path.to_str().unwrap(),
1200 Some(aux_dir.to_str().unwrap()),
1204 let aux_dir = self.aux_output_dir_name();
1205 let ProcArgs { prog, args } = self.make_run_args();
1206 let mut program = Command::new(&prog);
1208 .current_dir(&self.output_base_name().parent().unwrap())
1210 self.compose_and_run(program,
1211 self.config.run_lib_path.to_str().unwrap(),
1212 Some(aux_dir.to_str().unwrap()),
1218 /// For each `aux-build: foo/bar` annotation, we check to find the
1219 /// file in a `aux` directory relative to the test itself.
1220 fn compute_aux_test_paths(&self, rel_ab: &str) -> TestPaths {
1221 let test_ab = self.testpaths.file
1223 .expect("test file path has no parent")
1226 if !test_ab.exists() {
1227 self.fatal(&format!("aux-build `{}` source not found", test_ab.display()))
1232 base: self.testpaths.base.clone(),
1233 relative_dir: self.testpaths.relative_dir
1237 .expect("aux-build path has no parent")
1242 fn compose_and_run_compiler(&self, mut rustc: Command, input: Option<String>) -> ProcRes {
1243 if !self.props.aux_builds.is_empty() {
1244 create_dir_all(&self.aux_output_dir_name()).unwrap();
1247 let aux_dir = self.aux_output_dir_name();
1249 for rel_ab in &self.props.aux_builds {
1250 let aux_testpaths = self.compute_aux_test_paths(rel_ab);
1251 let aux_props = self.props.from_aux_file(&aux_testpaths.file,
1255 let f = self.make_lib_name(&self.testpaths.file);
1256 let parent = f.parent().unwrap();
1257 TargetLocation::ThisDirectory(parent.to_path_buf())
1259 let aux_cx = TestCx {
1260 config: self.config,
1262 testpaths: &aux_testpaths,
1263 revision: self.revision
1265 let mut aux_rustc = aux_cx.make_compile_args(&aux_testpaths.file, aux_output);
1267 let crate_type = if aux_props.no_prefer_dynamic {
1269 } else if (self.config.target.contains("musl") && !aux_props.force_host) ||
1270 self.config.target.contains("emscripten") {
1271 // We primarily compile all auxiliary libraries as dynamic libraries
1272 // to avoid code size bloat and large binaries as much as possible
1273 // for the test suite (otherwise including libstd statically in all
1274 // executables takes up quite a bit of space).
1276 // For targets like MUSL or Emscripten, however, there is no support for
1277 // dynamic libraries so we just go back to building a normal library. Note,
1278 // however, that for MUSL if the library is built with `force_host` then
1279 // it's ok to be a dylib as the host should always support dylibs.
1285 if let Some(crate_type) = crate_type {
1286 aux_rustc.args(&["--crate-type", crate_type]);
1289 aux_rustc.arg("-L").arg(&aux_dir);
1291 let auxres = aux_cx.compose_and_run(aux_rustc,
1292 aux_cx.config.compile_lib_path.to_str().unwrap(),
1293 Some(aux_dir.to_str().unwrap()),
1295 if !auxres.status.success() {
1296 self.fatal_proc_rec(
1297 &format!("auxiliary build of {:?} failed to compile: ",
1298 aux_testpaths.file.display()),
1303 rustc.envs(self.props.rustc_env.clone());
1304 self.compose_and_run(rustc,
1305 self.config.compile_lib_path.to_str().unwrap(),
1306 Some(aux_dir.to_str().unwrap()),
1310 fn compose_and_run(&self,
1311 mut command: Command,
1313 aux_path: Option<&str>,
1314 input: Option<String>) -> ProcRes {
1317 let cmdline = self.make_cmdline(&command, lib_path);
1318 logv(self.config, format!("executing {}", cmdline));
1323 .stdout(Stdio::piped())
1324 .stderr(Stdio::piped())
1325 .stdin(Stdio::piped());
1327 // Need to be sure to put both the lib_path and the aux path in the dylib
1328 // search path for the child.
1329 let mut path = env::split_paths(&env::var_os(dylib_env_var()).unwrap_or(OsString::new()))
1330 .collect::<Vec<_>>();
1331 if let Some(p) = aux_path {
1332 path.insert(0, PathBuf::from(p))
1334 path.insert(0, PathBuf::from(lib_path));
1336 // Add the new dylib search path var
1337 let newpath = env::join_paths(&path).unwrap();
1338 command.env(dylib_env_var(), newpath);
1340 let mut child = command.spawn().expect(&format!("failed to exec `{:?}`", &command));
1341 if let Some(input) = input {
1342 child.stdin.as_mut().unwrap().write_all(input.as_bytes()).unwrap();
1344 let Output { status, stdout, stderr } = child.wait_with_output().unwrap();
1346 let result = ProcRes {
1348 stdout: String::from_utf8(stdout).unwrap(),
1349 stderr: String::from_utf8(stderr).unwrap(),
1353 self.dump_output(&result.stdout, &result.stderr);
1358 fn make_compile_args(&self, input_file: &Path, output_file: TargetLocation) -> Command {
1359 let mut rustc = Command::new(&self.config.rustc_path);
1360 rustc.arg(input_file)
1361 .arg("-L").arg(&self.config.build_base);
1363 // Optionally prevent default --target if specified in test compile-flags.
1364 let custom_target = self.props.compile_flags
1366 .fold(false, |acc, x| acc || x.starts_with("--target"));
1369 let target = if self.props.force_host {
1372 &*self.config.target
1375 rustc.arg(&format!("--target={}", target));
1378 if let Some(revision) = self.revision {
1379 rustc.args(&["--cfg", revision]);
1382 if let Some(ref incremental_dir) = self.props.incremental_dir {
1383 rustc.args(&["-Z", &format!("incremental={}", incremental_dir.display())]);
1386 match self.config.mode {
1390 // If we are extracting and matching errors in the new
1391 // fashion, then you want JSON mode. Old-skool error
1392 // patterns still match the raw compiler output.
1393 if self.props.error_patterns.is_empty() {
1394 rustc.args(&["--error-format", "json"]);
1400 "-Zmir-opt-level=3",
1401 "-Zdump-mir-exclude-pass-number"]);
1403 let mir_dump_dir = self.get_mir_dump_dir();
1404 create_dir_all(mir_dump_dir.as_path()).unwrap();
1405 let mut dir_opt = "-Zdump-mir-dir=".to_string();
1406 dir_opt.push_str(mir_dump_dir.to_str().unwrap());
1407 debug!("dir_opt: {:?}", dir_opt);
1422 // do not use JSON output
1426 if !self.props.no_prefer_dynamic {
1427 rustc.args(&["-C", "prefer-dynamic"]);
1431 TargetLocation::ThisFile(path) => {
1432 rustc.arg("-o").arg(path);
1434 TargetLocation::ThisDirectory(path) => {
1435 rustc.arg("--out-dir").arg(path);
1439 if self.props.force_host {
1440 rustc.args(self.split_maybe_args(&self.config.host_rustcflags));
1442 rustc.args(self.split_maybe_args(&self.config.target_rustcflags));
1445 rustc.args(&self.props.compile_flags);
1450 fn make_lib_name(&self, auxfile: &Path) -> PathBuf {
1451 // what we return here is not particularly important, as it
1452 // happens; rustc ignores everything except for the directory.
1453 let auxname = self.output_testname(auxfile);
1454 self.aux_output_dir_name().join(&auxname)
1457 fn make_exe_name(&self) -> PathBuf {
1458 let mut f = self.output_base_name();
1459 // FIXME: This is using the host architecture exe suffix, not target!
1460 if self.config.target.contains("emscripten") {
1461 let mut fname = f.file_name().unwrap().to_os_string();
1463 f.set_file_name(&fname);
1464 } else if !env::consts::EXE_SUFFIX.is_empty() {
1465 let mut fname = f.file_name().unwrap().to_os_string();
1466 fname.push(env::consts::EXE_SUFFIX);
1467 f.set_file_name(&fname);
1472 fn make_run_args(&self) -> ProcArgs {
1473 // If we've got another tool to run under (valgrind),
1474 // then split apart its command
1475 let mut args = self.split_maybe_args(&self.config.runtool);
1477 // If this is emscripten, then run tests under nodejs
1478 if self.config.target.contains("emscripten") {
1479 if let Some(ref p) = self.config.nodejs {
1480 args.push(p.clone());
1482 self.fatal("no NodeJS binary found (--nodejs)");
1486 let exe_file = self.make_exe_name();
1488 // FIXME (#9639): This needs to handle non-utf8 paths
1489 args.push(exe_file.to_str().unwrap().to_owned());
1491 // Add the arguments in the run_flags directive
1492 args.extend(self.split_maybe_args(&self.props.run_flags));
1494 let prog = args.remove(0);
1501 fn split_maybe_args(&self, argstr: &Option<String>) -> Vec<String> {
1507 if s.chars().all(|c| c.is_whitespace()) {
1518 fn make_cmdline(&self, command: &Command, libpath: &str) -> String {
1521 // Linux and mac don't require adjusting the library search path
1523 format!("{:?}", command)
1525 // Build the LD_LIBRARY_PATH variable as it would be seen on the command line
1526 // for diagnostic purposes
1527 fn lib_path_cmd_prefix(path: &str) -> String {
1528 format!("{}=\"{}\"", util::lib_path_env_var(), util::make_new_path(path))
1531 format!("{} {:?}", lib_path_cmd_prefix(libpath), command)
1535 fn dump_output(&self, out: &str, err: &str) {
1536 let revision = if let Some(r) = self.revision {
1542 self.dump_output_file(out, &format!("{}out", revision));
1543 self.dump_output_file(err, &format!("{}err", revision));
1544 self.maybe_dump_to_stdout(out, err);
1547 fn dump_output_file(&self,
1550 let outfile = self.make_out_name(extension);
1551 File::create(&outfile).unwrap().write_all(out.as_bytes()).unwrap();
1554 fn make_out_name(&self, extension: &str) -> PathBuf {
1555 self.output_base_name().with_extension(extension)
1558 fn aux_output_dir_name(&self) -> PathBuf {
1559 let f = self.output_base_name();
1560 let mut fname = f.file_name().unwrap().to_os_string();
1561 fname.push(&format!(".{}.libaux", self.config.mode));
1562 f.with_file_name(&fname)
1565 fn output_testname(&self, filepath: &Path) -> PathBuf {
1566 PathBuf::from(filepath.file_stem().unwrap())
1569 /// Given a test path like `compile-fail/foo/bar.rs` Returns a name like
1571 /// <output>/foo/bar-stage1
1572 fn output_base_name(&self) -> PathBuf {
1573 let dir = self.config.build_base.join(&self.testpaths.relative_dir);
1575 // Note: The directory `dir` is created during `collect_tests_from_dir`
1577 .join(&self.output_testname(&self.testpaths.file))
1578 .with_extension(&self.config.stage_id)
1581 fn maybe_dump_to_stdout(&self, out: &str, err: &str) {
1582 if self.config.verbose {
1583 println!("------{}------------------------------", "stdout");
1584 println!("{}", out);
1585 println!("------{}------------------------------", "stderr");
1586 println!("{}", err);
1587 println!("------------------------------------------");
1591 fn error(&self, err: &str) {
1592 match self.revision {
1593 Some(rev) => println!("\nerror in revision `{}`: {}", rev, err),
1594 None => println!("\nerror: {}", err)
1598 fn fatal(&self, err: &str) -> ! {
1599 self.error(err); panic!();
1602 fn fatal_proc_rec(&self, err: &str, proc_res: &ProcRes) -> ! {
1603 self.try_print_open_handles();
1605 proc_res.fatal(None);
1608 // This function is a poor man's attempt to debug rust-lang/rust#38620, if
1609 // that's closed then this should be deleted
1611 // This is a very "opportunistic" debugging attempt, so we ignore all
1613 fn try_print_open_handles(&self) {
1617 if self.config.mode != Incremental {
1621 let filename = match self.testpaths.file.file_stem() {
1626 let mut cmd = Command::new("handle.exe");
1627 cmd.arg("-a").arg("-u");
1629 cmd.arg("-nobanner");
1630 let output = match cmd.output() {
1631 Ok(output) => output,
1634 println!("---------------------------------------------------");
1635 println!("ran extra command to debug rust-lang/rust#38620: ");
1636 println!("{:?}", cmd);
1637 println!("result: {}", output.status);
1638 println!("--- stdout ----------------------------------------");
1639 println!("{}", String::from_utf8_lossy(&output.stdout));
1640 println!("--- stderr ----------------------------------------");
1641 println!("{}", String::from_utf8_lossy(&output.stderr));
1642 println!("---------------------------------------------------");
1645 // codegen tests (using FileCheck)
1647 fn compile_test_and_save_ir(&self) -> ProcRes {
1648 let aux_dir = self.aux_output_dir_name();
1650 let output_file = TargetLocation::ThisDirectory(
1651 self.output_base_name().parent().unwrap().to_path_buf());
1652 let mut rustc = self.make_compile_args(&self.testpaths.file, output_file);
1653 rustc.arg("-L").arg(aux_dir)
1654 .arg("--emit=llvm-ir");
1656 self.compose_and_run_compiler(rustc, None)
1659 fn check_ir_with_filecheck(&self) -> ProcRes {
1660 let irfile = self.output_base_name().with_extension("ll");
1661 let mut filecheck = Command::new(self.config.llvm_filecheck.as_ref().unwrap());
1662 filecheck.arg("--input-file").arg(irfile)
1663 .arg(&self.testpaths.file);
1664 self.compose_and_run(filecheck, "", None, None)
1667 fn run_codegen_test(&self) {
1668 assert!(self.revision.is_none(), "revisions not relevant here");
1670 if self.config.llvm_filecheck.is_none() {
1671 self.fatal("missing --llvm-filecheck");
1674 let mut proc_res = self.compile_test_and_save_ir();
1675 if !proc_res.status.success() {
1676 self.fatal_proc_rec("compilation failed!", &proc_res);
1679 proc_res = self.check_ir_with_filecheck();
1680 if !proc_res.status.success() {
1681 self.fatal_proc_rec("verification with 'FileCheck' failed", &proc_res);
1685 fn charset() -> &'static str {
1686 // FreeBSD 10.1 defaults to GDB 6.1.1 which doesn't support "auto" charset
1687 if cfg!(target_os = "bitrig") {
1689 } else if cfg!(target_os = "freebsd") {
1696 fn run_rustdoc_test(&self) {
1697 assert!(self.revision.is_none(), "revisions not relevant here");
1699 let out_dir = self.output_base_name();
1700 let _ = fs::remove_dir_all(&out_dir);
1701 create_dir_all(&out_dir).unwrap();
1703 let proc_res = self.document(&out_dir);
1704 if !proc_res.status.success() {
1705 self.fatal_proc_rec("rustdoc failed!", &proc_res);
1708 if self.props.check_test_line_numbers_match {
1709 self.check_rustdoc_test_option(proc_res);
1711 let root = self.config.find_rust_src_root().unwrap();
1712 let res = self.cmd2procres(
1713 Command::new(&self.config.docck_python)
1714 .arg(root.join("src/etc/htmldocck.py"))
1716 .arg(&self.testpaths.file),
1718 if !res.status.success() {
1719 self.fatal_proc_rec("htmldocck failed!", &res);
1724 fn get_lines<P: AsRef<Path>>(&self, path: &P,
1725 mut other_files: Option<&mut Vec<String>>) -> Vec<usize> {
1726 let mut file = fs::File::open(path)
1727 .expect("markdown_test_output_check_entry File::open failed");
1728 let mut content = String::new();
1729 file.read_to_string(&mut content)
1730 .expect("markdown_test_output_check_entry read_to_string failed");
1731 let mut ignore = false;
1734 .filter_map(|(line_nb, line)| {
1735 if (line.trim_left().starts_with("pub mod ") ||
1736 line.trim_left().starts_with("mod ")) &&
1737 line.ends_with(';') {
1738 if let Some(ref mut other_files) = other_files {
1739 other_files.push(line.rsplit("mod ")
1746 let sline = line.split("///").last().unwrap_or("");
1747 let line = sline.trim_left();
1748 if line.starts_with("```") {
1764 fn check_rustdoc_test_option(&self, res: ProcRes) {
1765 let mut other_files = Vec::new();
1766 let mut files: HashMap<String, Vec<usize>> = HashMap::new();
1767 let cwd = env::current_dir().unwrap();
1768 files.insert(self.testpaths.file.strip_prefix(&cwd)
1769 .unwrap_or(&self.testpaths.file)
1772 .replace('\\', "/"),
1773 self.get_lines(&self.testpaths.file, Some(&mut other_files)));
1774 for other_file in other_files {
1775 let mut path = self.testpaths.file.clone();
1776 path.set_file_name(&format!("{}.rs", other_file));
1777 files.insert(path.strip_prefix(&cwd)
1781 .replace('\\', "/"),
1782 self.get_lines(&path, None));
1786 for _ in res.stdout.split('\n')
1787 .filter(|s| s.starts_with("test "))
1789 let tmp: Vec<&str> = s.split(" - ").collect();
1791 let path = tmp[0].rsplit("test ").next().unwrap();
1792 if let Some(ref mut v) = files.get_mut(
1793 &path.replace('\\', "/")) {
1795 let mut iter = tmp[1].split("(line ");
1797 let line = iter.next()
1804 if let Ok(pos) = v.binary_search(&line) {
1807 self.fatal_proc_rec(
1808 &format!("Not found doc test: \"{}\" in \"{}\":{:?}",
1816 self.fatal_proc_rec(&format!("No test has been found... {:?}", files), &res);
1818 for (entry, v) in &files {
1820 self.fatal_proc_rec(&format!("Not found test at line{} \"{}\":{:?}",
1821 if v.len() > 1 { "s" } else { "" }, entry, v),
1828 fn run_codegen_units_test(&self) {
1829 assert!(self.revision.is_none(), "revisions not relevant here");
1831 let proc_res = self.compile_test();
1833 if !proc_res.status.success() {
1834 self.fatal_proc_rec("compilation failed!", &proc_res);
1837 self.check_no_compiler_crash(&proc_res);
1839 const PREFIX: &'static str = "TRANS_ITEM ";
1840 const CGU_MARKER: &'static str = "@@";
1842 let actual: Vec<TransItem> = proc_res
1845 .filter(|line| line.starts_with(PREFIX))
1846 .map(str_to_trans_item)
1849 let expected: Vec<TransItem> = errors::load_errors(&self.testpaths.file, None)
1851 .map(|e| str_to_trans_item(&e.msg[..]))
1854 let mut missing = Vec::new();
1855 let mut wrong_cgus = Vec::new();
1857 for expected_item in &expected {
1858 let actual_item_with_same_name = actual.iter()
1859 .find(|ti| ti.name == expected_item.name);
1861 if let Some(actual_item) = actual_item_with_same_name {
1862 if !expected_item.codegen_units.is_empty() &&
1863 // Also check for codegen units
1864 expected_item.codegen_units != actual_item.codegen_units {
1865 wrong_cgus.push((expected_item.clone(), actual_item.clone()));
1868 missing.push(expected_item.string.clone());
1872 let unexpected: Vec<_> =
1874 .filter(|acgu| !expected.iter().any(|ecgu| acgu.name == ecgu.name))
1875 .map(|acgu| acgu.string.clone())
1878 if !missing.is_empty() {
1881 println!("\nThese items should have been contained but were not:\n");
1883 for item in &missing {
1884 println!("{}", item);
1890 if !unexpected.is_empty() {
1892 let mut sorted = unexpected.clone();
1897 println!("\nThese items were contained but should not have been:\n");
1899 for item in sorted {
1900 println!("{}", item);
1906 if !wrong_cgus.is_empty() {
1907 wrong_cgus.sort_by_key(|pair| pair.0.name.clone());
1908 println!("\nThe following items were assigned to wrong codegen units:\n");
1910 for &(ref expected_item, ref actual_item) in &wrong_cgus {
1911 println!("{}", expected_item.name);
1912 println!(" expected: {}", codegen_units_to_str(&expected_item.codegen_units));
1913 println!(" actual: {}", codegen_units_to_str(&actual_item.codegen_units));
1918 if !(missing.is_empty() && unexpected.is_empty() && wrong_cgus.is_empty())
1923 #[derive(Clone, Eq, PartialEq)]
1926 codegen_units: HashSet<String>,
1930 // [TRANS_ITEM] name [@@ (cgu)+]
1931 fn str_to_trans_item(s: &str) -> TransItem {
1932 let s = if s.starts_with(PREFIX) {
1933 (&s[PREFIX.len()..]).trim()
1938 let full_string = format!("{}{}", PREFIX, s.trim().to_owned());
1940 let parts: Vec<&str> = s.split(CGU_MARKER)
1942 .filter(|s| !s.is_empty())
1945 let name = parts[0].trim();
1947 let cgus = if parts.len() > 1 {
1948 let cgus_str = parts[1];
1952 .filter(|s| !s.is_empty())
1961 name: name.to_owned(),
1962 codegen_units: cgus,
1963 string: full_string,
1967 fn codegen_units_to_str(cgus: &HashSet<String>) -> String
1969 let mut cgus: Vec<_> = cgus.iter().collect();
1972 let mut string = String::new();
1974 string.push_str(&cgu[..]);
1975 string.push_str(" ");
1982 fn init_incremental_test(&self) {
1983 // (See `run_incremental_test` for an overview of how incremental tests work.)
1985 // Before any of the revisions have executed, create the
1986 // incremental workproduct directory. Delete any old
1987 // incremental work products that may be there from prior
1989 let incremental_dir = self.incremental_dir();
1990 if incremental_dir.exists() {
1991 // Canonicalizing the path will convert it to the //?/ format
1992 // on Windows, which enables paths longer than 260 character
1993 let canonicalized = incremental_dir.canonicalize().unwrap();
1994 fs::remove_dir_all(canonicalized).unwrap();
1996 fs::create_dir_all(&incremental_dir).unwrap();
1998 if self.config.verbose {
1999 print!("init_incremental_test: incremental_dir={}", incremental_dir.display());
2003 fn run_incremental_test(&self) {
2004 // Basic plan for a test incremental/foo/bar.rs:
2005 // - load list of revisions rpass1, cfail2, rpass3
2006 // - each should begin with `rpass`, `cfail`, or `cfail`
2007 // - if `rpass`, expect compile and execution to succeed
2008 // - if `cfail`, expect compilation to fail
2009 // - if `rfail`, expect execution to fail
2010 // - create a directory build/foo/bar.incremental
2011 // - compile foo/bar.rs with -Z incremental=.../foo/bar.incremental and -C rpass1
2012 // - because name of revision starts with "rpass", expect success
2013 // - compile foo/bar.rs with -Z incremental=.../foo/bar.incremental and -C cfail2
2014 // - because name of revision starts with "cfail", expect an error
2015 // - load expected errors as usual, but filter for those that end in `[rfail2]`
2016 // - compile foo/bar.rs with -Z incremental=.../foo/bar.incremental and -C rpass3
2017 // - because name of revision starts with "rpass", expect success
2018 // - execute build/foo/bar.exe and save output
2020 // FIXME -- use non-incremental mode as an oracle? That doesn't apply
2021 // to #[rustc_dirty] and clean tests I guess
2023 let revision = self.revision.expect("incremental tests require a list of revisions");
2025 // Incremental workproduct directory should have already been created.
2026 let incremental_dir = self.incremental_dir();
2027 assert!(incremental_dir.exists(), "init_incremental_test failed to create incremental dir");
2029 // Add an extra flag pointing at the incremental directory.
2030 let mut revision_props = self.props.clone();
2031 revision_props.incremental_dir = Some(incremental_dir);
2033 let revision_cx = TestCx {
2034 config: self.config,
2035 props: &revision_props,
2036 testpaths: self.testpaths,
2037 revision: self.revision,
2040 if self.config.verbose {
2041 print!("revision={:?} revision_props={:#?}", revision, revision_props);
2044 if revision.starts_with("rpass") {
2045 revision_cx.run_rpass_test();
2046 } else if revision.starts_with("rfail") {
2047 revision_cx.run_rfail_test();
2048 } else if revision.starts_with("cfail") {
2049 revision_cx.run_cfail_test();
2052 "revision name must begin with rpass, rfail, or cfail");
2056 /// Directory where incremental work products are stored.
2057 fn incremental_dir(&self) -> PathBuf {
2058 self.output_base_name().with_extension("inc")
2061 fn run_rmake_test(&self) {
2062 // FIXME(#11094): we should fix these tests
2063 if self.config.host != self.config.target {
2067 let cwd = env::current_dir().unwrap();
2068 let src_root = self.config.src_base.parent().unwrap()
2071 let src_root = cwd.join(&src_root);
2073 let tmpdir = cwd.join(self.output_base_name());
2074 if tmpdir.exists() {
2075 self.aggressive_rm_rf(&tmpdir).unwrap();
2077 create_dir_all(&tmpdir).unwrap();
2079 let host = &self.config.host;
2080 let make = if host.contains("bitrig") || host.contains("dragonfly") ||
2081 host.contains("freebsd") || host.contains("netbsd") ||
2082 host.contains("openbsd") {
2088 let mut cmd = Command::new(make);
2089 cmd.current_dir(&self.testpaths.file)
2090 .env("TARGET", &self.config.target)
2091 .env("PYTHON", &self.config.docck_python)
2093 .env("RUST_BUILD_STAGE", &self.config.stage_id)
2094 .env("RUSTC", cwd.join(&self.config.rustc_path))
2096 cwd.join(&self.config.rustdoc_path.as_ref().expect("--rustdoc-path passed")))
2097 .env("TMPDIR", &tmpdir)
2098 .env("LD_LIB_PATH_ENVVAR", dylib_env_var())
2099 .env("HOST_RPATH_DIR", cwd.join(&self.config.compile_lib_path))
2100 .env("TARGET_RPATH_DIR", cwd.join(&self.config.run_lib_path))
2101 .env("LLVM_COMPONENTS", &self.config.llvm_components)
2102 .env("LLVM_CXXFLAGS", &self.config.llvm_cxxflags);
2104 // We don't want RUSTFLAGS set from the outside to interfere with
2105 // compiler flags set in the test cases:
2106 cmd.env_remove("RUSTFLAGS");
2108 if self.config.target.contains("msvc") {
2109 // We need to pass a path to `lib.exe`, so assume that `cc` is `cl.exe`
2110 // and that `lib.exe` lives next to it.
2111 let lib = Path::new(&self.config.cc).parent().unwrap().join("lib.exe");
2113 // MSYS doesn't like passing flags of the form `/foo` as it thinks it's
2114 // a path and instead passes `C:\msys64\foo`, so convert all
2115 // `/`-arguments to MSVC here to `-` arguments.
2116 let cflags = self.config.cflags.split(' ').map(|s| s.replace("/", "-"))
2117 .collect::<Vec<_>>().join(" ");
2119 cmd.env("IS_MSVC", "1")
2120 .env("IS_WINDOWS", "1")
2121 .env("MSVC_LIB", format!("'{}' -nologo", lib.display()))
2122 .env("CC", format!("'{}' {}", self.config.cc, cflags))
2123 .env("CXX", &self.config.cxx);
2125 cmd.env("CC", format!("{} {}", self.config.cc, self.config.cflags))
2126 .env("CXX", format!("{} {}", self.config.cxx, self.config.cflags));
2128 if self.config.target.contains("windows") {
2129 cmd.env("IS_WINDOWS", "1");
2133 let output = cmd.output().expect("failed to spawn `make`");
2134 if !output.status.success() {
2136 status: output.status,
2137 stdout: String::from_utf8_lossy(&output.stdout).into_owned(),
2138 stderr: String::from_utf8_lossy(&output.stderr).into_owned(),
2139 cmdline: format!("{:?}", cmd),
2141 self.fatal_proc_rec("make failed", &res);
2145 fn aggressive_rm_rf(&self, path: &Path) -> io::Result<()> {
2146 for e in path.read_dir()? {
2148 let path = entry.path();
2149 if entry.file_type()?.is_dir() {
2150 self.aggressive_rm_rf(&path)?;
2152 // Remove readonly files as well on windows (by default we can't)
2153 fs::remove_file(&path).or_else(|e| {
2154 if cfg!(windows) && e.kind() == io::ErrorKind::PermissionDenied {
2155 let mut meta = entry.metadata()?.permissions();
2156 meta.set_readonly(false);
2157 fs::set_permissions(&path, meta)?;
2158 fs::remove_file(&path)
2165 fs::remove_dir(path)
2168 fn run_ui_test(&self) {
2169 let proc_res = self.compile_test();
2171 let expected_stderr_path = self.expected_output_path("stderr");
2172 let expected_stderr = self.load_expected_output(&expected_stderr_path);
2174 let expected_stdout_path = self.expected_output_path("stdout");
2175 let expected_stdout = self.load_expected_output(&expected_stdout_path);
2177 let normalized_stdout =
2178 self.normalize_output(&proc_res.stdout, &self.props.normalize_stdout);
2179 let normalized_stderr =
2180 self.normalize_output(&proc_res.stderr, &self.props.normalize_stderr);
2183 errors += self.compare_output("stdout", &normalized_stdout, &expected_stdout);
2184 errors += self.compare_output("stderr", &normalized_stderr, &expected_stderr);
2187 println!("To update references, run this command from build directory:");
2188 let relative_path_to_file =
2189 self.testpaths.relative_dir
2190 .join(self.testpaths.file.file_name().unwrap());
2191 println!("{}/update-references.sh '{}' '{}'",
2192 self.config.src_base.display(),
2193 self.config.build_base.display(),
2194 relative_path_to_file.display());
2195 self.fatal_proc_rec(&format!("{} errors occurred comparing output.", errors),
2199 if self.props.run_pass {
2200 let proc_res = self.exec_compiled_test();
2202 if !proc_res.status.success() {
2203 self.fatal_proc_rec("test run failed!", &proc_res);
2208 fn run_mir_opt_test(&self) {
2209 let proc_res = self.compile_test();
2211 if !proc_res.status.success() {
2212 self.fatal_proc_rec("compilation failed!", &proc_res);
2215 let proc_res = self.exec_compiled_test();
2217 if !proc_res.status.success() {
2218 self.fatal_proc_rec("test run failed!", &proc_res);
2220 self.check_mir_dump();
2223 fn check_mir_dump(&self) {
2224 let mut test_file_contents = String::new();
2225 fs::File::open(self.testpaths.file.clone()).unwrap()
2226 .read_to_string(&mut test_file_contents)
2228 if let Some(idx) = test_file_contents.find("// END RUST SOURCE") {
2229 let (_, tests_text) = test_file_contents.split_at(idx + "// END_RUST SOURCE".len());
2230 let tests_text_str = String::from(tests_text);
2231 let mut curr_test : Option<&str> = None;
2232 let mut curr_test_contents = vec![ExpectedLine::Elision];
2233 for l in tests_text_str.lines() {
2234 debug!("line: {:?}", l);
2235 if l.starts_with("// START ") {
2236 let (_, t) = l.split_at("// START ".len());
2237 curr_test = Some(t);
2238 } else if l.starts_with("// END") {
2239 let (_, t) = l.split_at("// END ".len());
2240 if Some(t) != curr_test {
2241 panic!("mismatched START END test name");
2243 self.compare_mir_test_output(curr_test.unwrap(), &curr_test_contents);
2245 curr_test_contents.clear();
2246 curr_test_contents.push(ExpectedLine::Elision);
2247 } else if l.is_empty() {
2249 } else if l.starts_with("//") && l.split_at("//".len()).1.trim() == "..." {
2250 curr_test_contents.push(ExpectedLine::Elision)
2251 } else if l.starts_with("// ") {
2252 let (_, test_content) = l.split_at("// ".len());
2253 curr_test_contents.push(ExpectedLine::Text(test_content));
2259 fn check_mir_test_timestamp(&self, test_name: &str, output_file: &Path) {
2260 let t = |file| FileTime::from_last_modification_time(&fs::metadata(file).unwrap());
2261 let source_file = &self.testpaths.file;
2262 let output_time = t(output_file);
2263 let source_time = t(source_file);
2264 if source_time > output_time {
2265 debug!("source file time: {:?} output file time: {:?}", source_time, output_time);
2266 panic!("test source file `{}` is newer than potentially stale output file `{}`.",
2267 source_file.display(), test_name);
2271 fn compare_mir_test_output(&self, test_name: &str, expected_content: &[ExpectedLine<&str>]) {
2272 let mut output_file = PathBuf::new();
2273 output_file.push(self.get_mir_dump_dir());
2274 output_file.push(test_name);
2275 debug!("comparing the contests of: {:?}", output_file);
2276 debug!("with: {:?}", expected_content);
2277 self.check_mir_test_timestamp(test_name, &output_file);
2279 let mut dumped_file = fs::File::open(output_file.clone()).unwrap();
2280 let mut dumped_string = String::new();
2281 dumped_file.read_to_string(&mut dumped_string).unwrap();
2282 let mut dumped_lines = dumped_string.lines().filter(|l| !l.is_empty());
2283 let mut expected_lines = expected_content.iter().filter(|&l| {
2284 if let &ExpectedLine::Text(l) = l {
2291 let compare = |expected_line, dumped_line| {
2292 let e_norm = normalize_mir_line(expected_line);
2293 let d_norm = normalize_mir_line(dumped_line);
2294 debug!("found: {:?}", d_norm);
2295 debug!("expected: {:?}", e_norm);
2299 let error = |expected_line, extra_msg| {
2300 let normalize_all = dumped_string.lines()
2301 .map(nocomment_mir_line)
2302 .filter(|l| !l.is_empty())
2303 .collect::<Vec<_>>()
2305 let f = |l: &ExpectedLine<_>| match l {
2306 &ExpectedLine::Elision => "... (elided)".into(),
2307 &ExpectedLine::Text(t) => t
2309 let expected_content = expected_content.iter()
2311 .collect::<Vec<_>>()
2313 panic!("Did not find expected line, error: {}\n\
2314 Actual Line: {:?}\n\
2323 // We expect each non-empty line to appear consecutively, non-consecutive lines
2324 // must be separated by at least one Elision
2325 while let Some(dumped_line) = dumped_lines.next() {
2326 match expected_lines.next() {
2327 Some(&ExpectedLine::Text(expected_line)) =>
2328 if !compare(expected_line, dumped_line) {
2329 error(expected_line,
2330 format!("Mismatch in lines\nExpected Line: {:?}", dumped_line));
2332 Some(&ExpectedLine::Elision) => {
2333 // skip any number of elisions in a row.
2334 while let Some(&&ExpectedLine::Elision) = expected_lines.peek() {
2335 expected_lines.next();
2337 if let Some(&ExpectedLine::Text(expected_line)) = expected_lines.next() {
2338 let mut found = compare(expected_line, dumped_line);
2342 while let Some(dumped_line) = dumped_lines.next() {
2343 found = compare(expected_line, dumped_line);
2349 error(expected_line, "ran out of mir dump to match against".into());
2358 fn get_mir_dump_dir(&self) -> PathBuf {
2359 let mut mir_dump_dir = PathBuf::from(self.config.build_base
2363 debug!("input_file: {:?}", self.testpaths.file);
2364 mir_dump_dir.push(self.testpaths.file.file_stem().unwrap().to_str().unwrap());
2368 fn normalize_output(&self, output: &str, custom_rules: &[(String, String)]) -> String {
2369 let parent_dir = self.testpaths.file.parent().unwrap();
2370 let parent_dir_str = parent_dir.display().to_string();
2371 let mut normalized = output.replace(&parent_dir_str, "$DIR")
2372 .replace("\\", "/") // normalize for paths on windows
2373 .replace("\r\n", "\n") // normalize for linebreaks on windows
2374 .replace("\t", "\\t"); // makes tabs visible
2375 for rule in custom_rules {
2376 normalized = normalized.replace(&rule.0, &rule.1);
2381 fn expected_output_path(&self, kind: &str) -> PathBuf {
2382 let extension = match self.revision {
2383 Some(r) => format!("{}.{}", r, kind),
2384 None => kind.to_string(),
2386 self.testpaths.file.with_extension(extension)
2389 fn load_expected_output(&self, path: &Path) -> String {
2391 return String::new();
2394 let mut result = String::new();
2395 match File::open(path).and_then(|mut f| f.read_to_string(&mut result)) {
2398 self.fatal(&format!("failed to load expected output from `{}`: {}",
2404 fn compare_output(&self, kind: &str, actual: &str, expected: &str) -> usize {
2405 if actual == expected {
2409 println!("normalized {}:\n{}\n", kind, actual);
2410 println!("expected {}:\n{}\n", kind, expected);
2411 println!("diff of {}:\n", kind);
2413 for diff in diff::lines(expected, actual) {
2415 diff::Result::Left(l) => println!("-{}", l),
2416 diff::Result::Both(l, _) => println!(" {}", l),
2417 diff::Result::Right(r) => println!("+{}", r),
2421 let output_file = self.output_base_name().with_extension(kind);
2422 match File::create(&output_file).and_then(|mut f| f.write_all(actual.as_bytes())) {
2425 self.fatal(&format!("failed to write {} to `{}`: {}",
2426 kind, output_file.display(), e))
2430 println!("\nThe actual {0} differed from the expected {0}.", kind);
2431 println!("Actual {} saved to {}", kind, output_file.display());
2441 pub struct ProcRes {
2449 pub fn fatal(&self, err: Option<&str>) -> ! {
2450 if let Some(e) = err {
2451 println!("\nerror: {}", e);
2457 ------------------------------------------\n\
2459 ------------------------------------------\n\
2461 ------------------------------------------\n\
2463 ------------------------------------------\n\
2465 self.status, self.cmdline, self.stdout,
2471 enum TargetLocation {
2473 ThisDirectory(PathBuf),
2476 #[derive(Clone, PartialEq, Eq)]
2477 enum ExpectedLine<T: AsRef<str>> {
2482 impl<T> fmt::Debug for ExpectedLine<T>
2484 T: AsRef<str> + fmt::Debug
2486 fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
2487 if let &ExpectedLine::Text(ref t) = self {
2488 write!(formatter, "{:?}", t)
2490 write!(formatter, "\"...\" (Elision)")
2495 fn normalize_mir_line(line: &str) -> String {
2496 nocomment_mir_line(line).replace(char::is_whitespace, "")
2499 fn nocomment_mir_line(line: &str) -> &str {
2500 if let Some(idx) = line.find("//") {
2501 let (l, _) = line.split_at(idx);