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};
28 use std::io::prelude::*;
29 use std::io::{self, BufReader};
30 use std::path::{Path, PathBuf};
31 use std::process::{Command, Output, ExitStatus, Stdio};
34 use extract_gdb_version;
36 /// The name of the environment variable that holds dynamic library locations.
37 pub fn dylib_env_var() -> &'static str {
40 } else if cfg!(target_os = "macos") {
42 } else if cfg!(target_os = "haiku") {
49 pub fn run(config: Config, testpaths: &TestPaths) {
50 match &*config.target {
52 "arm-linux-androideabi" | "armv7-linux-androideabi" | "aarch64-linux-android" => {
53 if !config.adb_device_status {
54 panic!("android device not available");
59 // android has its own gdb handling
60 if config.mode == DebugInfoGdb && config.gdb.is_none() {
61 panic!("gdb not available but debuginfo gdb debuginfo test requested");
67 // We're going to be dumping a lot of info. Start on a new line.
70 debug!("running {:?}", testpaths.file.display());
71 let base_props = TestProps::from_file(&testpaths.file, &config);
73 let base_cx = TestCx { config: &config,
79 if base_props.revisions.is_empty() {
80 base_cx.run_revision()
82 for revision in &base_props.revisions {
83 let mut revision_props = base_props.clone();
84 revision_props.load_from(&testpaths.file, Some(revision), &config);
87 props: &revision_props,
89 revision: Some(revision)
91 rev_cx.run_revision();
95 base_cx.complete_all();
97 File::create(::stamp(&config, testpaths)).unwrap();
100 struct TestCx<'test> {
101 config: &'test Config,
102 props: &'test TestProps,
103 testpaths: &'test TestPaths,
104 revision: Option<&'test str>
107 struct DebuggerCommands {
108 commands: Vec<String>,
109 check_lines: Vec<String>,
110 breakpoint_lines: Vec<usize>,
113 impl<'test> TestCx<'test> {
114 /// invoked once before any revisions have been processed
116 assert!(self.revision.is_none(), "init_all invoked for a revision");
117 if let Incremental = self.config.mode {
118 self.init_incremental_test()
122 /// Code executed for each revision in turn (or, if there are no
123 /// revisions, exactly once, with revision == None).
124 fn run_revision(&self) {
125 match self.config.mode {
127 ParseFail => self.run_cfail_test(),
128 RunFail => self.run_rfail_test(),
129 RunPass => self.run_rpass_test(),
130 RunPassValgrind => self.run_valgrind_test(),
131 Pretty => self.run_pretty_test(),
132 DebugInfoGdb => self.run_debuginfo_gdb_test(),
133 DebugInfoLldb => self.run_debuginfo_lldb_test(),
134 Codegen => self.run_codegen_test(),
135 Rustdoc => self.run_rustdoc_test(),
136 CodegenUnits => self.run_codegen_units_test(),
137 Incremental => self.run_incremental_test(),
138 RunMake => self.run_rmake_test(),
139 Ui => self.run_ui_test(),
140 MirOpt => self.run_mir_opt_test(),
144 /// Invoked after all revisions have executed.
145 fn complete_all(&self) {
146 assert!(self.revision.is_none(), "init_all invoked for a revision");
149 fn run_cfail_test(&self) {
150 let proc_res = self.compile_test();
152 if self.props.must_compile_successfully {
153 if !proc_res.status.success() {
155 "test compilation failed although it shouldn't!",
159 if proc_res.status.success() {
161 &format!("{} test compiled successfully!", self.config.mode)[..],
165 self.check_correct_failure_status(&proc_res);
168 let output_to_check = self.get_output(&proc_res);
169 let expected_errors = errors::load_errors(&self.testpaths.file, self.revision);
170 if !expected_errors.is_empty() {
171 if !self.props.error_patterns.is_empty() {
172 self.fatal("both error pattern and expected errors specified");
174 self.check_expected_errors(expected_errors, &proc_res);
176 self.check_error_patterns(&output_to_check, &proc_res);
179 self.check_no_compiler_crash(&proc_res);
180 self.check_forbid_output(&output_to_check, &proc_res);
183 fn run_rfail_test(&self) {
184 let proc_res = self.compile_test();
186 if !proc_res.status.success() {
187 self.fatal_proc_rec("compilation failed!", &proc_res);
190 let proc_res = self.exec_compiled_test();
192 // The value our Makefile configures valgrind to return on failure
193 const VALGRIND_ERR: i32 = 100;
194 if proc_res.status.code() == Some(VALGRIND_ERR) {
195 self.fatal_proc_rec("run-fail test isn't valgrind-clean!", &proc_res);
198 let output_to_check = self.get_output(&proc_res);
199 self.check_correct_failure_status(&proc_res);
200 self.check_error_patterns(&output_to_check, &proc_res);
203 fn get_output(&self, proc_res: &ProcRes) -> String {
204 if self.props.check_stdout {
205 format!("{}{}", proc_res.stdout, proc_res.stderr)
207 proc_res.stderr.clone()
211 fn check_correct_failure_status(&self, proc_res: &ProcRes) {
212 // The value the rust runtime returns on failure
213 const RUST_ERR: i32 = 101;
214 if proc_res.status.code() != Some(RUST_ERR) {
216 &format!("failure produced the wrong error: {}",
222 fn run_rpass_test(&self) {
223 let proc_res = self.compile_test();
225 if !proc_res.status.success() {
226 self.fatal_proc_rec("compilation failed!", &proc_res);
229 // FIXME(#41968): Move this check to tidy?
230 let expected_errors = errors::load_errors(&self.testpaths.file, self.revision);
231 assert!(expected_errors.is_empty(),
232 "run-pass tests with expected warnings should be moved to ui/");
234 let proc_res = self.exec_compiled_test();
236 if !proc_res.status.success() {
237 self.fatal_proc_rec("test run failed!", &proc_res);
241 fn run_valgrind_test(&self) {
242 assert!(self.revision.is_none(), "revisions not relevant here");
244 if self.config.valgrind_path.is_none() {
245 assert!(!self.config.force_valgrind);
246 return self.run_rpass_test();
249 let mut proc_res = self.compile_test();
251 if !proc_res.status.success() {
252 self.fatal_proc_rec("compilation failed!", &proc_res);
255 let mut new_config = self.config.clone();
256 new_config.runtool = new_config.valgrind_path.clone();
257 let new_cx = TestCx { config: &new_config, ..*self };
258 proc_res = new_cx.exec_compiled_test();
260 if !proc_res.status.success() {
261 self.fatal_proc_rec("test run failed!", &proc_res);
265 fn run_pretty_test(&self) {
266 if self.props.pp_exact.is_some() {
267 logv(self.config, "testing for exact pretty-printing".to_owned());
269 logv(self.config, "testing for converging pretty-printing".to_owned());
272 let rounds = match self.props.pp_exact { Some(_) => 1, None => 2 };
274 let mut src = String::new();
275 File::open(&self.testpaths.file).unwrap().read_to_string(&mut src).unwrap();
276 let mut srcs = vec![src];
279 while round < rounds {
280 logv(self.config, format!("pretty-printing round {} revision {:?}",
281 round, self.revision));
282 let proc_res = self.print_source(srcs[round].to_owned(), &self.props.pretty_mode);
284 if !proc_res.status.success() {
285 self.fatal_proc_rec(&format!("pretty-printing failed in round {} revision {:?}",
286 round, self.revision),
290 let ProcRes{ stdout, .. } = proc_res;
295 let mut expected = match self.props.pp_exact {
297 let filepath = self.testpaths.file.parent().unwrap().join(file);
298 let mut s = String::new();
299 File::open(&filepath).unwrap().read_to_string(&mut s).unwrap();
302 None => { srcs[srcs.len() - 2].clone() }
304 let mut actual = srcs[srcs.len() - 1].clone();
306 if self.props.pp_exact.is_some() {
307 // Now we have to care about line endings
308 let cr = "\r".to_owned();
309 actual = actual.replace(&cr, "").to_owned();
310 expected = expected.replace(&cr, "").to_owned();
313 self.compare_source(&expected, &actual);
315 // If we're only making sure that the output matches then just stop here
316 if self.props.pretty_compare_only { return; }
318 // Finally, let's make sure it actually appears to remain valid code
319 let proc_res = self.typecheck_source(actual);
320 if !proc_res.status.success() {
321 self.fatal_proc_rec("pretty-printed source does not typecheck", &proc_res);
324 if !self.props.pretty_expanded { return }
326 // additionally, run `--pretty expanded` and try to build it.
327 let proc_res = self.print_source(srcs[round].clone(), "expanded");
328 if !proc_res.status.success() {
329 self.fatal_proc_rec("pretty-printing (expanded) failed", &proc_res);
332 let ProcRes{ stdout: expanded_src, .. } = proc_res;
333 let proc_res = self.typecheck_source(expanded_src);
334 if !proc_res.status.success() {
336 "pretty-printed source (expanded) does not typecheck",
341 fn print_source(&self, src: String, pretty_type: &str) -> ProcRes {
342 let aux_dir = self.aux_output_dir_name();
344 let mut rustc = Command::new(&self.config.rustc_path);
346 .arg("-Zunstable-options")
347 .args(&["--unpretty", &pretty_type])
348 .args(&["--target", &self.config.target])
349 .arg("-L").arg(&aux_dir)
350 .args(self.split_maybe_args(&self.config.target_rustcflags))
351 .args(&self.props.compile_flags)
352 .envs(self.props.exec_env.clone());
354 self.compose_and_run(rustc,
355 self.config.compile_lib_path.to_str().unwrap(),
356 Some(aux_dir.to_str().unwrap()),
360 fn compare_source(&self,
363 if expected != actual {
364 self.error("pretty-printed source does not match expected source");
367 ------------------------------------------\n\
369 ------------------------------------------\n\
371 ------------------------------------------\n\
373 ------------------------------------------\n\
380 fn typecheck_source(&self, src: String) -> ProcRes {
381 let mut rustc = Command::new(&self.config.rustc_path);
383 let out_dir = self.output_base_name().with_extension("pretty-out");
384 let _ = fs::remove_dir_all(&out_dir);
385 create_dir_all(&out_dir).unwrap();
387 let target = if self.props.force_host {
393 let aux_dir = self.aux_output_dir_name();
397 .arg("--out-dir").arg(&out_dir)
398 .arg(&format!("--target={}", target))
399 .arg("-L").arg(&self.config.build_base)
400 .arg("-L").arg(aux_dir);
402 if let Some(revision) = self.revision {
403 rustc.args(&["--cfg", revision]);
406 rustc.args(self.split_maybe_args(&self.config.target_rustcflags));
407 rustc.args(&self.props.compile_flags);
409 self.compose_and_run_compiler(rustc, Some(src))
412 fn run_debuginfo_gdb_test(&self) {
413 assert!(self.revision.is_none(), "revisions not relevant here");
415 let config = Config {
416 target_rustcflags: self.cleanup_debug_info_options(&self.config.target_rustcflags),
417 host_rustcflags: self.cleanup_debug_info_options(&self.config.host_rustcflags),
418 .. self.config.clone()
421 let test_cx = TestCx {
426 test_cx.run_debuginfo_gdb_test_no_opt();
429 fn run_debuginfo_gdb_test_no_opt(&self) {
430 let prefixes = if self.config.gdb_native_rust {
432 static PREFIXES: &'static [&'static str] = &["gdb", "gdbr"];
433 println!("NOTE: compiletest thinks it is using GDB with native rust support");
437 static PREFIXES: &'static [&'static str] = &["gdb", "gdbg"];
438 println!("NOTE: compiletest thinks it is using GDB without native rust support");
442 let DebuggerCommands {
446 } = self.parse_debugger_commands(prefixes);
447 let mut cmds = commands.join("\n");
449 // compile test file (it should have 'compile-flags:-g' in the header)
450 let compiler_run_result = self.compile_test();
451 if !compiler_run_result.status.success() {
452 self.fatal_proc_rec("compilation failed!", &compiler_run_result);
455 let exe_file = self.make_exe_name();
457 let debugger_run_result;
458 match &*self.config.target {
459 "arm-linux-androideabi" |
460 "armv7-linux-androideabi" |
461 "aarch64-linux-android" => {
463 cmds = cmds.replace("run", "continue");
465 let tool_path = match self.config.android_cross_path.to_str() {
466 Some(x) => x.to_owned(),
467 None => self.fatal("cannot find android cross path")
470 // write debugger script
471 let mut script_str = String::with_capacity(2048);
472 script_str.push_str(&format!("set charset {}\n", Self::charset()));
473 script_str.push_str(&format!("set sysroot {}\n", tool_path));
474 script_str.push_str(&format!("file {}\n", exe_file.to_str().unwrap()));
475 script_str.push_str("target remote :5039\n");
476 script_str.push_str(&format!("set solib-search-path \
477 ./{}/stage2/lib/rustlib/{}/lib/\n",
478 self.config.host, self.config.target));
479 for line in &breakpoint_lines {
480 script_str.push_str(&format!("break {:?}:{}\n",
481 self.testpaths.file.file_name()
486 script_str.push_str(&cmds);
487 script_str.push_str("\nquit\n");
489 debug!("script_str = {}", script_str);
490 self.dump_output_file(&script_str, "debugger.script");
492 let adb_path = &self.config.adb_path;
494 Command::new(adb_path)
497 .arg(&self.config.adb_test_dir)
499 .expect(&format!("failed to exec `{:?}`", adb_path));
501 Command::new(adb_path)
502 .args(&["forward", "tcp:5039", "tcp:5039"])
504 .expect(&format!("failed to exec `{:?}`", adb_path));
506 let adb_arg = format!("export LD_LIBRARY_PATH={}; \
507 gdbserver{} :5039 {}/{}",
508 self.config.adb_test_dir.clone(),
509 if self.config.target.contains("aarch64")
511 self.config.adb_test_dir.clone(),
512 exe_file.file_name().unwrap().to_str()
515 debug!("adb arg: {}", adb_arg);
516 let mut adb = Command::new(adb_path)
517 .args(&["shell", &adb_arg])
518 .stdout(Stdio::piped())
519 .stderr(Stdio::inherit())
521 .expect(&format!("failed to exec `{:?}`", adb_path));
523 // Wait for the gdbserver to print out "Listening on port ..."
524 // at which point we know that it's started and then we can
525 // execute the debugger below.
526 let mut stdout = BufReader::new(adb.stdout.take().unwrap());
527 let mut line = String::new();
530 stdout.read_line(&mut line).unwrap();
531 if line.starts_with("Listening on port 5039") {
537 let debugger_script = self.make_out_name("debugger.script");
538 // FIXME (#9639): This needs to handle non-utf8 paths
540 vec!["-quiet".to_owned(),
543 format!("-command={}", debugger_script.to_str().unwrap())];
545 let mut gdb_path = tool_path;
546 gdb_path.push_str("/bin/gdb");
551 } = Command::new(&gdb_path)
552 .args(&debugger_opts)
554 .expect(&format!("failed to exec `{:?}`", gdb_path));
556 let mut gdb = Command::new(&format!("{}-gdb", self.config.target));
557 gdb.args(&debugger_opts);
558 let cmdline = self.make_cmdline(&gdb, "");
559 logv(self.config, format!("executing {}", cmdline));
563 debugger_run_result = ProcRes {
565 stdout: String::from_utf8(stdout).unwrap(),
566 stderr: String::from_utf8(stderr).unwrap(),
569 if adb.kill().is_err() {
570 println!("Adb process is already finished.");
575 let rust_src_root = self.config.find_rust_src_root().expect(
576 "Could not find Rust source root",
578 let rust_pp_module_rel_path = Path::new("./src/etc");
579 let rust_pp_module_abs_path = rust_src_root.join(rust_pp_module_rel_path)
583 // write debugger script
584 let mut script_str = String::with_capacity(2048);
585 script_str.push_str(&format!("set charset {}\n", Self::charset()));
586 script_str.push_str("show version\n");
588 match self.config.gdb_version {
590 println!("NOTE: compiletest thinks it is using GDB version {}",
593 if version > extract_gdb_version("7.4").unwrap() {
594 // Add the directory containing the pretty printers to
595 // GDB's script auto loading safe path
597 &format!("add-auto-load-safe-path {}\n",
598 rust_pp_module_abs_path.replace(r"\", r"\\"))
603 println!("NOTE: compiletest does not know which version of \
608 // The following line actually doesn't have to do anything with
609 // pretty printing, it just tells GDB to print values on one line:
610 script_str.push_str("set print pretty off\n");
612 // Add the pretty printer directory to GDB's source-file search path
613 script_str.push_str(&format!("directory {}\n",
614 rust_pp_module_abs_path));
616 // Load the target executable
617 script_str.push_str(&format!("file {}\n",
618 exe_file.to_str().unwrap()
619 .replace(r"\", r"\\")));
621 // Force GDB to print values in the Rust format.
622 if self.config.gdb_native_rust {
623 script_str.push_str("set language rust\n");
626 // Add line breakpoints
627 for line in &breakpoint_lines {
628 script_str.push_str(&format!("break '{}':{}\n",
629 self.testpaths.file.file_name().unwrap()
634 script_str.push_str(&cmds);
635 script_str.push_str("\nquit\n");
637 debug!("script_str = {}", script_str);
638 self.dump_output_file(&script_str, "debugger.script");
640 let debugger_script = self.make_out_name("debugger.script");
642 // FIXME (#9639): This needs to handle non-utf8 paths
644 vec!["-quiet".to_owned(),
647 format!("-command={}", debugger_script.to_str().unwrap())];
649 let mut gdb = Command::new(self.config.gdb.as_ref().unwrap());
650 gdb.args(&debugger_opts)
651 .env("PYTHONPATH", rust_pp_module_abs_path);
653 debugger_run_result =
654 self.compose_and_run(gdb,
655 self.config.run_lib_path.to_str().unwrap(),
661 if !debugger_run_result.status.success() {
662 self.fatal_proc_rec("gdb failed to execute", &debugger_run_result);
665 self.check_debugger_output(&debugger_run_result, &check_lines);
668 fn run_debuginfo_lldb_test(&self) {
669 assert!(self.revision.is_none(), "revisions not relevant here");
671 if self.config.lldb_python_dir.is_none() {
672 self.fatal("Can't run LLDB test because LLDB's python path is not set.");
675 let config = Config {
676 target_rustcflags: self.cleanup_debug_info_options(&self.config.target_rustcflags),
677 host_rustcflags: self.cleanup_debug_info_options(&self.config.host_rustcflags),
678 .. self.config.clone()
682 let test_cx = TestCx {
687 test_cx.run_debuginfo_lldb_test_no_opt();
690 fn run_debuginfo_lldb_test_no_opt(&self) {
691 // compile test file (it should have 'compile-flags:-g' in the header)
692 let compile_result = self.compile_test();
693 if !compile_result.status.success() {
694 self.fatal_proc_rec("compilation failed!", &compile_result);
697 let exe_file = self.make_exe_name();
699 match self.config.lldb_version {
700 Some(ref version) => {
701 println!("NOTE: compiletest thinks it is using LLDB version {}",
705 println!("NOTE: compiletest does not know which version of \
710 // Parse debugger commands etc from test files
711 let DebuggerCommands {
716 } = self.parse_debugger_commands(&["lldb"]);
718 // Write debugger script:
719 // We don't want to hang when calling `quit` while the process is still running
720 let mut script_str = String::from("settings set auto-confirm true\n");
722 // Make LLDB emit its version, so we have it documented in the test output
723 script_str.push_str("version\n");
725 // Switch LLDB into "Rust mode"
726 let rust_src_root = self.config.find_rust_src_root().expect(
727 "Could not find Rust source root",
729 let rust_pp_module_rel_path = Path::new("./src/etc/lldb_rust_formatters.py");
730 let rust_pp_module_abs_path = rust_src_root.join(rust_pp_module_rel_path)
735 script_str.push_str(&format!("command script import {}\n",
736 &rust_pp_module_abs_path[..])[..]);
737 script_str.push_str("type summary add --no-value ");
738 script_str.push_str("--python-function lldb_rust_formatters.print_val ");
739 script_str.push_str("-x \".*\" --category Rust\n");
740 script_str.push_str("type category enable Rust\n");
742 // Set breakpoints on every line that contains the string "#break"
743 let source_file_name = self.testpaths.file.file_name().unwrap().to_string_lossy();
744 for line in &breakpoint_lines {
745 script_str.push_str(&format!("breakpoint set --file '{}' --line {}\n",
750 // Append the other commands
751 for line in &commands {
752 script_str.push_str(line);
753 script_str.push_str("\n");
756 // Finally, quit the debugger
757 script_str.push_str("\nquit\n");
759 // Write the script into a file
760 debug!("script_str = {}", script_str);
761 self.dump_output_file(&script_str, "debugger.script");
762 let debugger_script = self.make_out_name("debugger.script");
764 // Let LLDB execute the script via lldb_batchmode.py
765 let debugger_run_result = self.run_lldb(&exe_file,
769 if !debugger_run_result.status.success() {
770 self.fatal_proc_rec("Error while running LLDB", &debugger_run_result);
773 self.check_debugger_output(&debugger_run_result, &check_lines);
777 test_executable: &Path,
778 debugger_script: &Path,
779 rust_src_root: &Path)
781 // Prepare the lldb_batchmode which executes the debugger script
782 let lldb_script_path = rust_src_root.join("src/etc/lldb_batchmode.py");
783 self.cmd2procres(Command::new(&self.config.lldb_python)
784 .arg(&lldb_script_path)
785 .arg(test_executable)
786 .arg(debugger_script)
788 self.config.lldb_python_dir.as_ref().unwrap()))
791 fn cmd2procres(&self, cmd: &mut Command) -> ProcRes {
792 let (status, out, err) = match cmd.output() {
793 Ok(Output { status, stdout, stderr }) => {
795 String::from_utf8(stdout).unwrap(),
796 String::from_utf8(stderr).unwrap())
799 self.fatal(&format!("Failed to setup Python process for \
800 LLDB script: {}", e))
804 self.dump_output(&out, &err);
809 cmdline: format!("{:?}", cmd)
813 fn parse_debugger_commands(&self, debugger_prefixes: &[&str]) -> DebuggerCommands {
814 let directives = debugger_prefixes.iter().map(|prefix| (
815 format!("{}-command", prefix),
816 format!("{}-check", prefix),
817 )).collect::<Vec<_>>();
819 let mut breakpoint_lines = vec![];
820 let mut commands = vec![];
821 let mut check_lines = vec![];
823 let reader = BufReader::new(File::open(&self.testpaths.file).unwrap());
824 for line in reader.lines() {
827 if line.contains("#break") {
828 breakpoint_lines.push(counter);
831 for &(ref command_directive, ref check_directive) in &directives {
832 self.config.parse_name_value_directive(
834 command_directive).map(|cmd| {
838 self.config.parse_name_value_directive(
840 check_directive).map(|cmd| {
841 check_lines.push(cmd)
846 self.fatal(&format!("Error while parsing debugger commands: {}", e))
859 fn cleanup_debug_info_options(&self, options: &Option<String>) -> Option<String> {
860 if options.is_none() {
864 // Remove options that are either unwanted (-O) or may lead to duplicates due to RUSTFLAGS.
865 let options_to_remove = [
868 "--debuginfo".to_owned()
871 self.split_maybe_args(options).into_iter()
872 .filter(|x| !options_to_remove.contains(x))
873 .collect::<Vec<String>>();
875 Some(new_options.join(" "))
878 fn check_debugger_output(&self, debugger_run_result: &ProcRes, check_lines: &[String]) {
879 let num_check_lines = check_lines.len();
881 let mut check_line_index = 0;
882 for line in debugger_run_result.stdout.lines() {
883 if check_line_index >= num_check_lines {
887 if check_single_line(line, &(check_lines[check_line_index])[..]) {
888 check_line_index += 1;
891 if check_line_index != num_check_lines && num_check_lines > 0 {
892 self.fatal_proc_rec(&format!("line not found in debugger output: {}",
893 check_lines[check_line_index]),
894 debugger_run_result);
897 fn check_single_line(line: &str, check_line: &str) -> bool {
898 // Allow check lines to leave parts unspecified (e.g., uninitialized
899 // bits in the wrong case of an enum) with the notation "[...]".
900 let line = line.trim();
901 let check_line = check_line.trim();
902 let can_start_anywhere = check_line.starts_with("[...]");
903 let can_end_anywhere = check_line.ends_with("[...]");
905 let check_fragments: Vec<&str> = check_line.split("[...]")
906 .filter(|frag| !frag.is_empty())
908 if check_fragments.is_empty() {
912 let (mut rest, first_fragment) = if can_start_anywhere {
913 match line.find(check_fragments[0]) {
914 Some(pos) => (&line[pos + check_fragments[0].len() ..], 1),
921 for current_fragment in &check_fragments[first_fragment..] {
922 match rest.find(current_fragment) {
924 rest = &rest[pos + current_fragment.len() .. ];
930 if !can_end_anywhere && !rest.is_empty() {
938 fn check_error_patterns(&self,
939 output_to_check: &str,
940 proc_res: &ProcRes) {
941 if self.props.error_patterns.is_empty() {
942 if self.props.must_compile_successfully {
945 self.fatal(&format!("no error pattern specified in {:?}",
946 self.testpaths.file.display()));
949 let mut next_err_idx = 0;
950 let mut next_err_pat = self.props.error_patterns[next_err_idx].trim();
951 let mut done = false;
952 for line in output_to_check.lines() {
953 if line.contains(next_err_pat) {
954 debug!("found error pattern {}", next_err_pat);
956 if next_err_idx == self.props.error_patterns.len() {
957 debug!("found all error patterns");
961 next_err_pat = self.props.error_patterns[next_err_idx].trim();
966 let missing_patterns = &self.props.error_patterns[next_err_idx..];
967 if missing_patterns.len() == 1 {
969 &format!("error pattern '{}' not found!", missing_patterns[0]),
972 for pattern in missing_patterns {
973 self.error(&format!("error pattern '{}' not found!", *pattern));
975 self.fatal_proc_rec("multiple error patterns not found", proc_res);
979 fn check_no_compiler_crash(&self, proc_res: &ProcRes) {
980 for line in proc_res.stderr.lines() {
981 if line.contains("error: internal compiler error") {
982 self.fatal_proc_rec("compiler encountered internal error", proc_res);
987 fn check_forbid_output(&self,
988 output_to_check: &str,
989 proc_res: &ProcRes) {
990 for pat in &self.props.forbid_output {
991 if output_to_check.contains(pat) {
992 self.fatal_proc_rec("forbidden pattern found in compiler output", proc_res);
997 fn check_expected_errors(&self,
998 expected_errors: Vec<errors::Error>,
999 proc_res: &ProcRes) {
1000 if proc_res.status.success() &&
1001 expected_errors.iter().any(|x| x.kind == Some(ErrorKind::Error)) {
1002 self.fatal_proc_rec("process did not return an error status", proc_res);
1006 format!("{}", self.testpaths.file.display())
1007 .replace(r"\", "/"); // on windows, translate all '\' path separators to '/'
1009 // If the testcase being checked contains at least one expected "help"
1010 // message, then we'll ensure that all "help" messages are expected.
1011 // Otherwise, all "help" messages reported by the compiler will be ignored.
1012 // This logic also applies to "note" messages.
1013 let expect_help = expected_errors.iter().any(|ee| ee.kind == Some(ErrorKind::Help));
1014 let expect_note = expected_errors.iter().any(|ee| ee.kind == Some(ErrorKind::Note));
1016 // Parse the JSON output from the compiler and extract out the messages.
1017 let actual_errors = json::parse_output(&file_name, &proc_res.stderr, proc_res);
1018 let mut unexpected = Vec::new();
1019 let mut found = vec![false; expected_errors.len()];
1020 for actual_error in &actual_errors {
1025 .position(|(index, expected_error)| {
1027 actual_error.line_num == expected_error.line_num &&
1028 (expected_error.kind.is_none() ||
1029 actual_error.kind == expected_error.kind) &&
1030 actual_error.msg.contains(&expected_error.msg)
1035 // found a match, everybody is happy
1036 assert!(!found[index]);
1037 found[index] = true;
1041 if self.is_unexpected_compiler_message(actual_error, expect_help, expect_note) {
1043 &format!("{}:{}: unexpected {}: '{}'",
1045 actual_error.line_num,
1046 actual_error.kind.as_ref()
1047 .map_or(String::from("message"),
1050 unexpected.push(actual_error);
1056 let mut not_found = Vec::new();
1057 // anything not yet found is a problem
1058 for (index, expected_error) in expected_errors.iter().enumerate() {
1061 &format!("{}:{}: expected {} not found: {}",
1063 expected_error.line_num,
1064 expected_error.kind.as_ref()
1065 .map_or("message".into(),
1067 expected_error.msg));
1068 not_found.push(expected_error);
1072 if !unexpected.is_empty() || !not_found.is_empty() {
1074 &format!("{} unexpected errors found, {} expected errors not found",
1075 unexpected.len(), not_found.len()));
1076 println!("status: {}\ncommand: {}",
1077 proc_res.status, proc_res.cmdline);
1078 if !unexpected.is_empty() {
1079 println!("unexpected errors (from JSON output): {:#?}\n", unexpected);
1081 if !not_found.is_empty() {
1082 println!("not found errors (from test file): {:#?}\n", not_found);
1088 /// Returns true if we should report an error about `actual_error`,
1089 /// which did not match any of the expected error. We always require
1090 /// errors/warnings to be explicitly listed, but only require
1091 /// helps/notes if there are explicit helps/notes given.
1092 fn is_unexpected_compiler_message(&self,
1093 actual_error: &Error,
1097 match actual_error.kind {
1098 Some(ErrorKind::Help) => expect_help,
1099 Some(ErrorKind::Note) => expect_note,
1100 Some(ErrorKind::Error) |
1101 Some(ErrorKind::Warning) => true,
1102 Some(ErrorKind::Suggestion) |
1107 fn compile_test(&self) -> ProcRes {
1108 let mut rustc = self.make_compile_args(
1109 &self.testpaths.file, TargetLocation::ThisFile(self.make_exe_name()));
1111 rustc.arg("-L").arg(&self.aux_output_dir_name());
1113 match self.config.mode {
1114 CompileFail | Ui => {
1115 // compile-fail and ui tests tend to have tons of unused code as
1116 // it's just testing various pieces of the compile, but we don't
1117 // want to actually assert warnings about all this code. Instead
1118 // let's just ignore unused code warnings by defaults and tests
1119 // can turn it back on if needed.
1120 rustc.args(&["-A", "unused"]);
1125 self.compose_and_run_compiler(rustc, None)
1128 fn document(&self, out_dir: &Path) -> ProcRes {
1129 if self.props.build_aux_docs {
1130 for rel_ab in &self.props.aux_builds {
1131 let aux_testpaths = self.compute_aux_test_paths(rel_ab);
1132 let aux_props = self.props.from_aux_file(&aux_testpaths.file,
1135 let aux_cx = TestCx {
1136 config: self.config,
1138 testpaths: &aux_testpaths,
1139 revision: self.revision
1141 let auxres = aux_cx.document(out_dir);
1142 if !auxres.status.success() {
1148 let aux_dir = self.aux_output_dir_name();
1150 let rustdoc_path = self.config.rustdoc_path.as_ref().expect("--rustdoc-path passed");
1151 let mut rustdoc = Command::new(rustdoc_path);
1153 rustdoc.arg("-L").arg(aux_dir)
1154 .arg("-o").arg(out_dir)
1155 .arg(&self.testpaths.file)
1156 .args(&self.props.compile_flags);
1158 self.compose_and_run_compiler(rustdoc, None)
1161 fn exec_compiled_test(&self) -> ProcRes {
1162 let env = &self.props.exec_env;
1164 match &*self.config.target {
1165 // This is pretty similar to below, we're transforming:
1167 // program arg1 arg2
1171 // remote-test-client run program:support-lib.so arg1 arg2
1173 // The test-client program will upload `program` to the emulator
1174 // along with all other support libraries listed (in this case
1175 // `support-lib.so`. It will then execute the program on the
1176 // emulator with the arguments specified (in the environment we give
1177 // the process) and then report back the same result.
1178 _ if self.config.remote_test_client.is_some() => {
1179 let aux_dir = self.aux_output_dir_name();
1180 let ProcArgs { mut prog, args } = self.make_run_args();
1181 if let Ok(entries) = aux_dir.read_dir() {
1182 for entry in entries {
1183 let entry = entry.unwrap();
1184 if !entry.path().is_file() {
1188 prog.push_str(entry.path().to_str().unwrap());
1191 let mut test_client = Command::new(
1192 self.config.remote_test_client.as_ref().unwrap());
1194 .args(&["run", &prog])
1197 self.compose_and_run(test_client,
1198 self.config.run_lib_path.to_str().unwrap(),
1199 Some(aux_dir.to_str().unwrap()),
1203 let aux_dir = self.aux_output_dir_name();
1204 let ProcArgs { prog, args } = self.make_run_args();
1205 let mut program = Command::new(&prog);
1207 .current_dir(&self.output_base_name().parent().unwrap())
1209 self.compose_and_run(program,
1210 self.config.run_lib_path.to_str().unwrap(),
1211 Some(aux_dir.to_str().unwrap()),
1217 /// For each `aux-build: foo/bar` annotation, we check to find the
1218 /// file in a `aux` directory relative to the test itself.
1219 fn compute_aux_test_paths(&self, rel_ab: &str) -> TestPaths {
1220 let test_ab = self.testpaths.file
1222 .expect("test file path has no parent")
1225 if !test_ab.exists() {
1226 self.fatal(&format!("aux-build `{}` source not found", test_ab.display()))
1231 base: self.testpaths.base.clone(),
1232 relative_dir: self.testpaths.relative_dir
1236 .expect("aux-build path has no parent")
1241 fn compose_and_run_compiler(&self, mut rustc: Command, input: Option<String>) -> ProcRes {
1242 if !self.props.aux_builds.is_empty() {
1243 create_dir_all(&self.aux_output_dir_name()).unwrap();
1246 let aux_dir = self.aux_output_dir_name();
1248 for rel_ab in &self.props.aux_builds {
1249 let aux_testpaths = self.compute_aux_test_paths(rel_ab);
1250 let aux_props = self.props.from_aux_file(&aux_testpaths.file,
1254 let f = self.make_lib_name(&self.testpaths.file);
1255 let parent = f.parent().unwrap();
1256 TargetLocation::ThisDirectory(parent.to_path_buf())
1258 let aux_cx = TestCx {
1259 config: self.config,
1261 testpaths: &aux_testpaths,
1262 revision: self.revision
1264 let mut aux_rustc = aux_cx.make_compile_args(&aux_testpaths.file, aux_output);
1266 let crate_type = if aux_props.no_prefer_dynamic {
1268 } else if (self.config.target.contains("musl") && !aux_props.force_host) ||
1269 self.config.target.contains("emscripten") {
1270 // We primarily compile all auxiliary libraries as dynamic libraries
1271 // to avoid code size bloat and large binaries as much as possible
1272 // for the test suite (otherwise including libstd statically in all
1273 // executables takes up quite a bit of space).
1275 // For targets like MUSL or Emscripten, however, there is no support for
1276 // dynamic libraries so we just go back to building a normal library. Note,
1277 // however, that for MUSL if the library is built with `force_host` then
1278 // it's ok to be a dylib as the host should always support dylibs.
1284 if let Some(crate_type) = crate_type {
1285 aux_rustc.args(&["--crate-type", crate_type]);
1288 aux_rustc.arg("-L").arg(&aux_dir);
1290 let auxres = aux_cx.compose_and_run(aux_rustc,
1291 aux_cx.config.compile_lib_path.to_str().unwrap(),
1292 Some(aux_dir.to_str().unwrap()),
1294 if !auxres.status.success() {
1295 self.fatal_proc_rec(
1296 &format!("auxiliary build of {:?} failed to compile: ",
1297 aux_testpaths.file.display()),
1302 rustc.envs(self.props.rustc_env.clone());
1303 self.compose_and_run(rustc,
1304 self.config.compile_lib_path.to_str().unwrap(),
1305 Some(aux_dir.to_str().unwrap()),
1309 fn compose_and_run(&self,
1310 mut command: Command,
1312 aux_path: Option<&str>,
1313 input: Option<String>) -> ProcRes {
1316 let cmdline = self.make_cmdline(&command, lib_path);
1317 logv(self.config, format!("executing {}", cmdline));
1322 .stdout(Stdio::piped())
1323 .stderr(Stdio::piped())
1324 .stdin(Stdio::piped());
1326 // Need to be sure to put both the lib_path and the aux path in the dylib
1327 // search path for the child.
1328 let mut path = env::split_paths(&env::var_os(dylib_env_var()).unwrap_or(OsString::new()))
1329 .collect::<Vec<_>>();
1330 if let Some(p) = aux_path {
1331 path.insert(0, PathBuf::from(p))
1333 path.insert(0, PathBuf::from(lib_path));
1335 // Add the new dylib search path var
1336 let newpath = env::join_paths(&path).unwrap();
1337 command.env(dylib_env_var(), newpath);
1339 let mut child = command.spawn().expect(&format!("failed to exec `{:?}`", &command));
1340 if let Some(input) = input {
1341 child.stdin.as_mut().unwrap().write_all(input.as_bytes()).unwrap();
1343 let Output { status, stdout, stderr } = child.wait_with_output().unwrap();
1345 let result = ProcRes {
1347 stdout: String::from_utf8(stdout).unwrap(),
1348 stderr: String::from_utf8(stderr).unwrap(),
1352 self.dump_output(&result.stdout, &result.stderr);
1357 fn make_compile_args(&self, input_file: &Path, output_file: TargetLocation) -> Command {
1358 let mut rustc = Command::new(&self.config.rustc_path);
1359 rustc.arg(input_file)
1360 .arg("-L").arg(&self.config.build_base);
1362 // Optionally prevent default --target if specified in test compile-flags.
1363 let custom_target = self.props.compile_flags
1365 .fold(false, |acc, x| acc || x.starts_with("--target"));
1368 let target = if self.props.force_host {
1371 &*self.config.target
1374 rustc.arg(&format!("--target={}", target));
1377 if let Some(revision) = self.revision {
1378 rustc.args(&["--cfg", revision]);
1381 if let Some(ref incremental_dir) = self.props.incremental_dir {
1382 rustc.args(&["-Z", &format!("incremental={}", incremental_dir.display())]);
1385 match self.config.mode {
1389 // If we are extracting and matching errors in the new
1390 // fashion, then you want JSON mode. Old-skool error
1391 // patterns still match the raw compiler output.
1392 if self.props.error_patterns.is_empty() {
1393 rustc.args(&["--error-format", "json"]);
1399 "-Zmir-opt-level=3",
1400 "-Zdump-mir-exclude-pass-number"]);
1402 let mir_dump_dir = self.get_mir_dump_dir();
1403 create_dir_all(mir_dump_dir.as_path()).unwrap();
1404 let mut dir_opt = "-Zdump-mir-dir=".to_string();
1405 dir_opt.push_str(mir_dump_dir.to_str().unwrap());
1406 debug!("dir_opt: {:?}", dir_opt);
1421 // do not use JSON output
1425 if !self.props.no_prefer_dynamic {
1426 rustc.args(&["-C", "prefer-dynamic"]);
1430 TargetLocation::ThisFile(path) => {
1431 rustc.arg("-o").arg(path);
1433 TargetLocation::ThisDirectory(path) => {
1434 rustc.arg("--out-dir").arg(path);
1438 if self.props.force_host {
1439 rustc.args(self.split_maybe_args(&self.config.host_rustcflags));
1441 rustc.args(self.split_maybe_args(&self.config.target_rustcflags));
1444 rustc.args(&self.props.compile_flags);
1449 fn make_lib_name(&self, auxfile: &Path) -> PathBuf {
1450 // what we return here is not particularly important, as it
1451 // happens; rustc ignores everything except for the directory.
1452 let auxname = self.output_testname(auxfile);
1453 self.aux_output_dir_name().join(&auxname)
1456 fn make_exe_name(&self) -> PathBuf {
1457 let mut f = self.output_base_name();
1458 // FIXME: This is using the host architecture exe suffix, not target!
1459 if self.config.target.contains("emscripten") {
1460 let mut fname = f.file_name().unwrap().to_os_string();
1462 f.set_file_name(&fname);
1463 } else if !env::consts::EXE_SUFFIX.is_empty() {
1464 let mut fname = f.file_name().unwrap().to_os_string();
1465 fname.push(env::consts::EXE_SUFFIX);
1466 f.set_file_name(&fname);
1471 fn make_run_args(&self) -> ProcArgs {
1472 // If we've got another tool to run under (valgrind),
1473 // then split apart its command
1474 let mut args = self.split_maybe_args(&self.config.runtool);
1476 // If this is emscripten, then run tests under nodejs
1477 if self.config.target.contains("emscripten") {
1478 if let Some(ref p) = self.config.nodejs {
1479 args.push(p.clone());
1481 self.fatal("no NodeJS binary found (--nodejs)");
1485 let exe_file = self.make_exe_name();
1487 // FIXME (#9639): This needs to handle non-utf8 paths
1488 args.push(exe_file.to_str().unwrap().to_owned());
1490 // Add the arguments in the run_flags directive
1491 args.extend(self.split_maybe_args(&self.props.run_flags));
1493 let prog = args.remove(0);
1500 fn split_maybe_args(&self, argstr: &Option<String>) -> Vec<String> {
1506 if s.chars().all(|c| c.is_whitespace()) {
1517 fn make_cmdline(&self, command: &Command, libpath: &str) -> String {
1520 // Linux and mac don't require adjusting the library search path
1522 format!("{:?}", command)
1524 // Build the LD_LIBRARY_PATH variable as it would be seen on the command line
1525 // for diagnostic purposes
1526 fn lib_path_cmd_prefix(path: &str) -> String {
1527 format!("{}=\"{}\"", util::lib_path_env_var(), util::make_new_path(path))
1530 format!("{} {:?}", lib_path_cmd_prefix(libpath), command)
1534 fn dump_output(&self, out: &str, err: &str) {
1535 let revision = if let Some(r) = self.revision {
1541 self.dump_output_file(out, &format!("{}out", revision));
1542 self.dump_output_file(err, &format!("{}err", revision));
1543 self.maybe_dump_to_stdout(out, err);
1546 fn dump_output_file(&self,
1549 let outfile = self.make_out_name(extension);
1550 File::create(&outfile).unwrap().write_all(out.as_bytes()).unwrap();
1553 fn make_out_name(&self, extension: &str) -> PathBuf {
1554 self.output_base_name().with_extension(extension)
1557 fn aux_output_dir_name(&self) -> PathBuf {
1558 let f = self.output_base_name();
1559 let mut fname = f.file_name().unwrap().to_os_string();
1560 fname.push(&format!(".{}.libaux", self.config.mode));
1561 f.with_file_name(&fname)
1564 fn output_testname(&self, filepath: &Path) -> PathBuf {
1565 PathBuf::from(filepath.file_stem().unwrap())
1568 /// Given a test path like `compile-fail/foo/bar.rs` Returns a name like
1570 /// <output>/foo/bar-stage1
1571 fn output_base_name(&self) -> PathBuf {
1572 let dir = self.config.build_base.join(&self.testpaths.relative_dir);
1574 // Note: The directory `dir` is created during `collect_tests_from_dir`
1576 .join(&self.output_testname(&self.testpaths.file))
1577 .with_extension(&self.config.stage_id)
1580 fn maybe_dump_to_stdout(&self, out: &str, err: &str) {
1581 if self.config.verbose {
1582 println!("------{}------------------------------", "stdout");
1583 println!("{}", out);
1584 println!("------{}------------------------------", "stderr");
1585 println!("{}", err);
1586 println!("------------------------------------------");
1590 fn error(&self, err: &str) {
1591 match self.revision {
1592 Some(rev) => println!("\nerror in revision `{}`: {}", rev, err),
1593 None => println!("\nerror: {}", err)
1597 fn fatal(&self, err: &str) -> ! {
1598 self.error(err); panic!();
1601 fn fatal_proc_rec(&self, err: &str, proc_res: &ProcRes) -> ! {
1602 self.try_print_open_handles();
1604 proc_res.fatal(None);
1607 // This function is a poor man's attempt to debug rust-lang/rust#38620, if
1608 // that's closed then this should be deleted
1610 // This is a very "opportunistic" debugging attempt, so we ignore all
1612 fn try_print_open_handles(&self) {
1616 if self.config.mode != Incremental {
1620 let filename = match self.testpaths.file.file_stem() {
1625 let mut cmd = Command::new("handle.exe");
1626 cmd.arg("-a").arg("-u");
1628 cmd.arg("-nobanner");
1629 let output = match cmd.output() {
1630 Ok(output) => output,
1633 println!("---------------------------------------------------");
1634 println!("ran extra command to debug rust-lang/rust#38620: ");
1635 println!("{:?}", cmd);
1636 println!("result: {}", output.status);
1637 println!("--- stdout ----------------------------------------");
1638 println!("{}", String::from_utf8_lossy(&output.stdout));
1639 println!("--- stderr ----------------------------------------");
1640 println!("{}", String::from_utf8_lossy(&output.stderr));
1641 println!("---------------------------------------------------");
1644 // codegen tests (using FileCheck)
1646 fn compile_test_and_save_ir(&self) -> ProcRes {
1647 let aux_dir = self.aux_output_dir_name();
1649 let output_file = TargetLocation::ThisDirectory(
1650 self.output_base_name().parent().unwrap().to_path_buf());
1651 let mut rustc = self.make_compile_args(&self.testpaths.file, output_file);
1652 rustc.arg("-L").arg(aux_dir)
1653 .arg("--emit=llvm-ir");
1655 self.compose_and_run_compiler(rustc, None)
1658 fn check_ir_with_filecheck(&self) -> ProcRes {
1659 let irfile = self.output_base_name().with_extension("ll");
1660 let mut filecheck = Command::new(self.config.llvm_filecheck.as_ref().unwrap());
1661 filecheck.arg("--input-file").arg(irfile)
1662 .arg(&self.testpaths.file);
1663 self.compose_and_run(filecheck, "", None, None)
1666 fn run_codegen_test(&self) {
1667 assert!(self.revision.is_none(), "revisions not relevant here");
1669 if self.config.llvm_filecheck.is_none() {
1670 self.fatal("missing --llvm-filecheck");
1673 let mut proc_res = self.compile_test_and_save_ir();
1674 if !proc_res.status.success() {
1675 self.fatal_proc_rec("compilation failed!", &proc_res);
1678 proc_res = self.check_ir_with_filecheck();
1679 if !proc_res.status.success() {
1680 self.fatal_proc_rec("verification with 'FileCheck' failed", &proc_res);
1684 fn charset() -> &'static str {
1685 // FreeBSD 10.1 defaults to GDB 6.1.1 which doesn't support "auto" charset
1686 if cfg!(target_os = "bitrig") {
1688 } else if cfg!(target_os = "freebsd") {
1695 fn run_rustdoc_test(&self) {
1696 assert!(self.revision.is_none(), "revisions not relevant here");
1698 let out_dir = self.output_base_name();
1699 let _ = fs::remove_dir_all(&out_dir);
1700 create_dir_all(&out_dir).unwrap();
1702 let proc_res = self.document(&out_dir);
1703 if !proc_res.status.success() {
1704 self.fatal_proc_rec("rustdoc failed!", &proc_res);
1707 if self.props.check_test_line_numbers_match {
1708 self.check_rustdoc_test_option(proc_res);
1710 let root = self.config.find_rust_src_root().unwrap();
1711 let res = self.cmd2procres(
1712 Command::new(&self.config.docck_python)
1713 .arg(root.join("src/etc/htmldocck.py"))
1715 .arg(&self.testpaths.file),
1717 if !res.status.success() {
1718 self.fatal_proc_rec("htmldocck failed!", &res);
1723 fn get_lines<P: AsRef<Path>>(&self, path: &P,
1724 mut other_files: Option<&mut Vec<String>>) -> Vec<usize> {
1725 let mut file = fs::File::open(path)
1726 .expect("markdown_test_output_check_entry File::open failed");
1727 let mut content = String::new();
1728 file.read_to_string(&mut content)
1729 .expect("markdown_test_output_check_entry read_to_string failed");
1730 let mut ignore = false;
1733 .filter_map(|(line_nb, line)| {
1734 if (line.trim_left().starts_with("pub mod ") ||
1735 line.trim_left().starts_with("mod ")) &&
1736 line.ends_with(';') {
1737 if let Some(ref mut other_files) = other_files {
1738 other_files.push(line.rsplit("mod ")
1745 let sline = line.split("///").last().unwrap_or("");
1746 let line = sline.trim_left();
1747 if line.starts_with("```") {
1763 fn check_rustdoc_test_option(&self, res: ProcRes) {
1764 let mut other_files = Vec::new();
1765 let mut files: HashMap<String, Vec<usize>> = HashMap::new();
1766 let cwd = env::current_dir().unwrap();
1767 files.insert(self.testpaths.file.strip_prefix(&cwd)
1768 .unwrap_or(&self.testpaths.file)
1771 .replace('\\', "/"),
1772 self.get_lines(&self.testpaths.file, Some(&mut other_files)));
1773 for other_file in other_files {
1774 let mut path = self.testpaths.file.clone();
1775 path.set_file_name(&format!("{}.rs", other_file));
1776 files.insert(path.strip_prefix(&cwd)
1780 .replace('\\', "/"),
1781 self.get_lines(&path, None));
1785 for _ in res.stdout.split('\n')
1786 .filter(|s| s.starts_with("test "))
1788 let tmp: Vec<&str> = s.split(" - ").collect();
1790 let path = tmp[0].rsplit("test ").next().unwrap();
1791 if let Some(ref mut v) = files.get_mut(
1792 &path.replace('\\', "/")) {
1794 let mut iter = tmp[1].split("(line ");
1796 let line = iter.next()
1803 if let Ok(pos) = v.binary_search(&line) {
1806 self.fatal_proc_rec(
1807 &format!("Not found doc test: \"{}\" in \"{}\":{:?}",
1815 self.fatal_proc_rec(&format!("No test has been found... {:?}", files), &res);
1817 for (entry, v) in &files {
1819 self.fatal_proc_rec(&format!("Not found test at line{} \"{}\":{:?}",
1820 if v.len() > 1 { "s" } else { "" }, entry, v),
1827 fn run_codegen_units_test(&self) {
1828 assert!(self.revision.is_none(), "revisions not relevant here");
1830 let proc_res = self.compile_test();
1832 if !proc_res.status.success() {
1833 self.fatal_proc_rec("compilation failed!", &proc_res);
1836 self.check_no_compiler_crash(&proc_res);
1838 const PREFIX: &'static str = "TRANS_ITEM ";
1839 const CGU_MARKER: &'static str = "@@";
1841 let actual: Vec<TransItem> = proc_res
1844 .filter(|line| line.starts_with(PREFIX))
1845 .map(str_to_trans_item)
1848 let expected: Vec<TransItem> = errors::load_errors(&self.testpaths.file, None)
1850 .map(|e| str_to_trans_item(&e.msg[..]))
1853 let mut missing = Vec::new();
1854 let mut wrong_cgus = Vec::new();
1856 for expected_item in &expected {
1857 let actual_item_with_same_name = actual.iter()
1858 .find(|ti| ti.name == expected_item.name);
1860 if let Some(actual_item) = actual_item_with_same_name {
1861 if !expected_item.codegen_units.is_empty() &&
1862 // Also check for codegen units
1863 expected_item.codegen_units != actual_item.codegen_units {
1864 wrong_cgus.push((expected_item.clone(), actual_item.clone()));
1867 missing.push(expected_item.string.clone());
1871 let unexpected: Vec<_> =
1873 .filter(|acgu| !expected.iter().any(|ecgu| acgu.name == ecgu.name))
1874 .map(|acgu| acgu.string.clone())
1877 if !missing.is_empty() {
1880 println!("\nThese items should have been contained but were not:\n");
1882 for item in &missing {
1883 println!("{}", item);
1889 if !unexpected.is_empty() {
1891 let mut sorted = unexpected.clone();
1896 println!("\nThese items were contained but should not have been:\n");
1898 for item in sorted {
1899 println!("{}", item);
1905 if !wrong_cgus.is_empty() {
1906 wrong_cgus.sort_by_key(|pair| pair.0.name.clone());
1907 println!("\nThe following items were assigned to wrong codegen units:\n");
1909 for &(ref expected_item, ref actual_item) in &wrong_cgus {
1910 println!("{}", expected_item.name);
1911 println!(" expected: {}", codegen_units_to_str(&expected_item.codegen_units));
1912 println!(" actual: {}", codegen_units_to_str(&actual_item.codegen_units));
1917 if !(missing.is_empty() && unexpected.is_empty() && wrong_cgus.is_empty())
1922 #[derive(Clone, Eq, PartialEq)]
1925 codegen_units: HashSet<String>,
1929 // [TRANS_ITEM] name [@@ (cgu)+]
1930 fn str_to_trans_item(s: &str) -> TransItem {
1931 let s = if s.starts_with(PREFIX) {
1932 (&s[PREFIX.len()..]).trim()
1937 let full_string = format!("{}{}", PREFIX, s.trim().to_owned());
1939 let parts: Vec<&str> = s.split(CGU_MARKER)
1941 .filter(|s| !s.is_empty())
1944 let name = parts[0].trim();
1946 let cgus = if parts.len() > 1 {
1947 let cgus_str = parts[1];
1951 .filter(|s| !s.is_empty())
1960 name: name.to_owned(),
1961 codegen_units: cgus,
1962 string: full_string,
1966 fn codegen_units_to_str(cgus: &HashSet<String>) -> String
1968 let mut cgus: Vec<_> = cgus.iter().collect();
1971 let mut string = String::new();
1973 string.push_str(&cgu[..]);
1974 string.push_str(" ");
1981 fn init_incremental_test(&self) {
1982 // (See `run_incremental_test` for an overview of how incremental tests work.)
1984 // Before any of the revisions have executed, create the
1985 // incremental workproduct directory. Delete any old
1986 // incremental work products that may be there from prior
1988 let incremental_dir = self.incremental_dir();
1989 if incremental_dir.exists() {
1990 // Canonicalizing the path will convert it to the //?/ format
1991 // on Windows, which enables paths longer than 260 character
1992 let canonicalized = incremental_dir.canonicalize().unwrap();
1993 fs::remove_dir_all(canonicalized).unwrap();
1995 fs::create_dir_all(&incremental_dir).unwrap();
1997 if self.config.verbose {
1998 print!("init_incremental_test: incremental_dir={}", incremental_dir.display());
2002 fn run_incremental_test(&self) {
2003 // Basic plan for a test incremental/foo/bar.rs:
2004 // - load list of revisions rpass1, cfail2, rpass3
2005 // - each should begin with `rpass`, `cfail`, or `cfail`
2006 // - if `rpass`, expect compile and execution to succeed
2007 // - if `cfail`, expect compilation to fail
2008 // - if `rfail`, expect execution to fail
2009 // - create a directory build/foo/bar.incremental
2010 // - compile foo/bar.rs with -Z incremental=.../foo/bar.incremental and -C rpass1
2011 // - because name of revision starts with "rpass", expect success
2012 // - compile foo/bar.rs with -Z incremental=.../foo/bar.incremental and -C cfail2
2013 // - because name of revision starts with "cfail", expect an error
2014 // - load expected errors as usual, but filter for those that end in `[rfail2]`
2015 // - compile foo/bar.rs with -Z incremental=.../foo/bar.incremental and -C rpass3
2016 // - because name of revision starts with "rpass", expect success
2017 // - execute build/foo/bar.exe and save output
2019 // FIXME -- use non-incremental mode as an oracle? That doesn't apply
2020 // to #[rustc_dirty] and clean tests I guess
2022 let revision = self.revision.expect("incremental tests require a list of revisions");
2024 // Incremental workproduct directory should have already been created.
2025 let incremental_dir = self.incremental_dir();
2026 assert!(incremental_dir.exists(), "init_incremental_test failed to create incremental dir");
2028 // Add an extra flag pointing at the incremental directory.
2029 let mut revision_props = self.props.clone();
2030 revision_props.incremental_dir = Some(incremental_dir);
2031 revision_props.compile_flags.push(String::from("-Zincremental-info"));
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::new();
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 } else if l.is_empty() {
2248 } else if l.starts_with("// ") {
2249 let (_, test_content) = l.split_at("// ".len());
2250 curr_test_contents.push(test_content);
2256 fn check_mir_test_timestamp(&self, test_name: &str, output_file: &Path) {
2257 let t = |file| FileTime::from_last_modification_time(&fs::metadata(file).unwrap());
2258 let source_file = &self.testpaths.file;
2259 let output_time = t(output_file);
2260 let source_time = t(source_file);
2261 if source_time > output_time {
2262 debug!("source file time: {:?} output file time: {:?}", source_time, output_time);
2263 panic!("test source file `{}` is newer than potentially stale output file `{}`.",
2264 source_file.display(), test_name);
2268 fn compare_mir_test_output(&self, test_name: &str, expected_content: &[&str]) {
2269 let mut output_file = PathBuf::new();
2270 output_file.push(self.get_mir_dump_dir());
2271 output_file.push(test_name);
2272 debug!("comparing the contests of: {:?}", output_file);
2273 debug!("with: {:?}", expected_content);
2274 self.check_mir_test_timestamp(test_name, &output_file);
2276 let mut dumped_file = fs::File::open(output_file.clone()).unwrap();
2277 let mut dumped_string = String::new();
2278 dumped_file.read_to_string(&mut dumped_string).unwrap();
2279 let mut dumped_lines = dumped_string.lines().filter(|l| !l.is_empty());
2280 let mut expected_lines = expected_content.iter().filter(|l| !l.is_empty());
2282 // We expect each non-empty line from expected_content to appear
2283 // in the dump in order, but there may be extra lines interleaved
2284 while let Some(expected_line) = expected_lines.next() {
2285 let e_norm = normalize_mir_line(expected_line);
2286 if e_norm.is_empty() {
2289 let mut found = false;
2290 while let Some(dumped_line) = dumped_lines.next() {
2291 let d_norm = normalize_mir_line(dumped_line);
2292 debug!("found: {:?}", d_norm);
2293 debug!("expected: {:?}", e_norm);
2294 if e_norm == d_norm {
2300 let normalize_all = dumped_string.lines()
2301 .map(nocomment_mir_line)
2302 .filter(|l| !l.is_empty())
2303 .collect::<Vec<_>>()
2305 panic!("ran out of mir dump output to match against.\n\
2306 Did not find expected line: {:?}\n\
2310 expected_content.join("\n"),
2316 fn get_mir_dump_dir(&self) -> PathBuf {
2317 let mut mir_dump_dir = PathBuf::from(self.config.build_base
2321 debug!("input_file: {:?}", self.testpaths.file);
2322 mir_dump_dir.push(self.testpaths.file.file_stem().unwrap().to_str().unwrap());
2326 fn normalize_output(&self, output: &str, custom_rules: &[(String, String)]) -> String {
2327 let parent_dir = self.testpaths.file.parent().unwrap();
2328 let parent_dir_str = parent_dir.display().to_string();
2329 let mut normalized = output.replace(&parent_dir_str, "$DIR")
2330 .replace("\\", "/") // normalize for paths on windows
2331 .replace("\r\n", "\n") // normalize for linebreaks on windows
2332 .replace("\t", "\\t"); // makes tabs visible
2333 for rule in custom_rules {
2334 normalized = normalized.replace(&rule.0, &rule.1);
2339 fn expected_output_path(&self, kind: &str) -> PathBuf {
2340 let extension = match self.revision {
2341 Some(r) => format!("{}.{}", r, kind),
2342 None => kind.to_string(),
2344 self.testpaths.file.with_extension(extension)
2347 fn load_expected_output(&self, path: &Path) -> String {
2349 return String::new();
2352 let mut result = String::new();
2353 match File::open(path).and_then(|mut f| f.read_to_string(&mut result)) {
2356 self.fatal(&format!("failed to load expected output from `{}`: {}",
2362 fn compare_output(&self, kind: &str, actual: &str, expected: &str) -> usize {
2363 if actual == expected {
2367 println!("normalized {}:\n{}\n", kind, actual);
2368 println!("expected {}:\n{}\n", kind, expected);
2369 println!("diff of {}:\n", kind);
2371 for diff in diff::lines(expected, actual) {
2373 diff::Result::Left(l) => println!("-{}", l),
2374 diff::Result::Both(l, _) => println!(" {}", l),
2375 diff::Result::Right(r) => println!("+{}", r),
2379 let output_file = self.output_base_name().with_extension(kind);
2380 match File::create(&output_file).and_then(|mut f| f.write_all(actual.as_bytes())) {
2383 self.fatal(&format!("failed to write {} to `{}`: {}",
2384 kind, output_file.display(), e))
2388 println!("\nThe actual {0} differed from the expected {0}.", kind);
2389 println!("Actual {} saved to {}", kind, output_file.display());
2399 pub struct ProcRes {
2407 pub fn fatal(&self, err: Option<&str>) -> ! {
2408 if let Some(e) = err {
2409 println!("\nerror: {}", e);
2415 ------------------------------------------\n\
2417 ------------------------------------------\n\
2419 ------------------------------------------\n\
2421 ------------------------------------------\n\
2423 self.status, self.cmdline, self.stdout,
2429 enum TargetLocation {
2431 ThisDirectory(PathBuf),
2434 fn normalize_mir_line(line: &str) -> String {
2435 nocomment_mir_line(line).replace(char::is_whitespace, "")
2438 fn nocomment_mir_line(line: &str) -> &str {
2439 if let Some(idx) = line.find("//") {
2440 let (l, _) = line.split_at(idx);