src/tools/compiletest/src/runtest.rs

   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.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 use common::Config;
  12 use common::{CompileFail, ParseFail, Pretty, RunFail, RunPass, RunPassValgrind};
  13 use common::{Codegen, DebugInfoLldb, DebugInfoGdb, Rustdoc, CodegenUnits};
  14 use common::{Incremental, RunMake, Ui, MirOpt};
  15 use diff;
  16 use errors::{self, ErrorKind, Error};
  17 use filetime::FileTime;
  18 use json;
  19 use header::TestProps;
  20 use test::TestPaths;
  21 use util::logv;
  22
  23 use std::collections::HashMap;
  24 use std::collections::HashSet;
  25 use std::env;
  26 use std::ffi::OsString;
  27 use std::fs::{self, File, create_dir_all};
  28 use std::fmt;
  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};
  33 use std::str;
  34
  35 use extract_gdb_version;
  36
  37 /// The name of the environment variable that holds dynamic library locations.
  38 pub fn dylib_env_var() -> &'static str {
  39     if cfg!(windows) {
  40         "PATH"
  41     } else if cfg!(target_os = "macos") {
  42         "DYLD_LIBRARY_PATH"
  43     } else if cfg!(target_os = "haiku") {
  44         "LIBRARY_PATH"
  45     } else {
  46         "LD_LIBRARY_PATH"
  47     }
  48 }
  49
  50 pub fn run(config: Config, testpaths: &TestPaths) {
  51     match &*config.target {
  52
  53         "arm-linux-androideabi" | "armv7-linux-androideabi" | "aarch64-linux-android" => {
  54             if !config.adb_device_status {
  55                 panic!("android device not available");
  56             }
  57         }
  58
  59         _ => {
  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");
  63             }
  64         }
  65     }
  66
  67     if config.verbose {
  68         // We're going to be dumping a lot of info. Start on a new line.
  69         print!("\n\n");
  70     }
  71     debug!("running {:?}", testpaths.file.display());
  72     let base_props = TestProps::from_file(&testpaths.file, &config);
  73
  74     let base_cx = TestCx { config: &config,
  75                            props: &base_props,
  76                            testpaths,
  77                            revision: None };
  78     base_cx.init_all();
  79
  80     if base_props.revisions.is_empty() {
  81         base_cx.run_revision()
  82     } else {
  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);
  86             let rev_cx = TestCx {
  87                 config: &config,
  88                 props: &revision_props,
  89                 testpaths,
  90                 revision: Some(revision)
  91             };
  92             rev_cx.run_revision();
  93         }
  94     }
  95
  96     base_cx.complete_all();
  97
  98     File::create(::stamp(&config, testpaths)).unwrap();
  99 }
 100
 101 struct TestCx<'test> {
 102     config: &'test Config,
 103     props: &'test TestProps,
 104     testpaths: &'test TestPaths,
 105     revision: Option<&'test str>
 106 }
 107
 108 struct DebuggerCommands {
 109     commands: Vec<String>,
 110     check_lines: Vec<String>,
 111     breakpoint_lines: Vec<usize>,
 112 }
 113
 114 impl<'test> TestCx<'test> {
 115     /// invoked once before any revisions have been processed
 116     fn init_all(&self) {
 117         assert!(self.revision.is_none(), "init_all invoked for a revision");
 118         if let Incremental = self.config.mode {
 119             self.init_incremental_test()
 120         }
 121     }
 122
 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 {
 127             CompileFail |
 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(),
 142         }
 143     }
 144
 145     /// Invoked after all revisions have executed.
 146     fn complete_all(&self) {
 147         assert!(self.revision.is_none(), "init_all invoked for a revision");
 148     }
 149
 150     fn run_cfail_test(&self) {
 151         let proc_res = self.compile_test();
 152
 153         if self.props.must_compile_successfully {
 154             if !proc_res.status.success() {
 155                 self.fatal_proc_rec(
 156                     "test compilation failed although it shouldn't!",
 157                     &proc_res);
 158             }
 159         } else {
 160             if proc_res.status.success() {
 161                 self.fatal_proc_rec(
 162                     &format!("{} test compiled successfully!", self.config.mode)[..],
 163                     &proc_res);
 164             }
 165
 166             self.check_correct_failure_status(&proc_res);
 167         }
 168
 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");
 174             }
 175             self.check_expected_errors(expected_errors, &proc_res);
 176         } else {
 177             self.check_error_patterns(&output_to_check, &proc_res);
 178         }
 179
 180         self.check_no_compiler_crash(&proc_res);
 181         self.check_forbid_output(&output_to_check, &proc_res);
 182     }
 183
 184     fn run_rfail_test(&self) {
 185         let proc_res = self.compile_test();
 186
 187         if !proc_res.status.success() {
 188             self.fatal_proc_rec("compilation failed!", &proc_res);
 189         }
 190
 191         let proc_res = self.exec_compiled_test();
 192
 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);
 197         }
 198
 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);
 202     }
 203
 204     fn get_output(&self, proc_res: &ProcRes) -> String {
 205         if self.props.check_stdout {
 206             format!("{}{}", proc_res.stdout, proc_res.stderr)
 207         } else {
 208             proc_res.stderr.clone()
 209         }
 210     }
 211
 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) {
 216             self.fatal_proc_rec(
 217                 &format!("failure produced the wrong error: {}",
 218                          proc_res.status),
 219                 proc_res);
 220         }
 221     }
 222
 223     fn run_rpass_test(&self) {
 224         let proc_res = self.compile_test();
 225
 226         if !proc_res.status.success() {
 227             self.fatal_proc_rec("compilation failed!", &proc_res);
 228         }
 229
 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/");
 234
 235         let proc_res = self.exec_compiled_test();
 236
 237         if !proc_res.status.success() {
 238             self.fatal_proc_rec("test run failed!", &proc_res);
 239         }
 240     }
 241
 242     fn run_valgrind_test(&self) {
 243         assert!(self.revision.is_none(), "revisions not relevant here");
 244
 245         if self.config.valgrind_path.is_none() {
 246             assert!(!self.config.force_valgrind);
 247             return self.run_rpass_test();
 248         }
 249
 250         let mut proc_res = self.compile_test();
 251
 252         if !proc_res.status.success() {
 253             self.fatal_proc_rec("compilation failed!", &proc_res);
 254         }
 255
 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();
 260
 261         if !proc_res.status.success() {
 262             self.fatal_proc_rec("test run failed!", &proc_res);
 263         }
 264     }
 265
 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());
 269         } else {
 270             logv(self.config, "testing for converging pretty-printing".to_owned());
 271         }
 272
 273         let rounds = match self.props.pp_exact { Some(_) => 1, None => 2 };
 274
 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];
 278
 279         let mut round = 0;
 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);
 284
 285             if !proc_res.status.success() {
 286                 self.fatal_proc_rec(&format!("pretty-printing failed in round {} revision {:?}",
 287                                              round, self.revision),
 288                                     &proc_res);
 289             }
 290
 291             let ProcRes{ stdout, .. } = proc_res;
 292             srcs.push(stdout);
 293             round += 1;
 294         }
 295
 296         let mut expected = match self.props.pp_exact {
 297             Some(ref file) => {
 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();
 301                 s
 302             }
 303             None => { srcs[srcs.len() - 2].clone() }
 304         };
 305         let mut actual = srcs[srcs.len() - 1].clone();
 306
 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();
 312         }
 313
 314         self.compare_source(&expected, &actual);
 315
 316         // If we're only making sure that the output matches then just stop here
 317         if self.props.pretty_compare_only { return; }
 318
 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);
 323         }
 324
 325         if !self.props.pretty_expanded { return }
 326
 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);
 331         }
 332
 333         let ProcRes{ stdout: expanded_src, .. } = proc_res;
 334         let proc_res = self.typecheck_source(expanded_src);
 335         if !proc_res.status.success() {
 336             self.fatal_proc_rec(
 337                 "pretty-printed source (expanded) does not typecheck",
 338                 &proc_res);
 339         }
 340     }
 341
 342     fn print_source(&self, src: String, pretty_type: &str) -> ProcRes {
 343         let aux_dir = self.aux_output_dir_name();
 344
 345         let mut rustc = Command::new(&self.config.rustc_path);
 346         rustc.arg("-")
 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());
 354
 355         self.compose_and_run(rustc,
 356                              self.config.compile_lib_path.to_str().unwrap(),
 357                              Some(aux_dir.to_str().unwrap()),
 358                              Some(src))
 359     }
 360
 361     fn compare_source(&self,
 362                       expected: &str,
 363                       actual: &str) {
 364         if expected != actual {
 365             self.error("pretty-printed source does not match expected source");
 366             println!("\n\
 367 expected:\n\
 368 ------------------------------------------\n\
 369 {}\n\
 370 ------------------------------------------\n\
 371 actual:\n\
 372 ------------------------------------------\n\
 373 {}\n\
 374 ------------------------------------------\n\
 375 \n",
 376                      expected, actual);
 377             panic!();
 378         }
 379     }
 380
 381     fn typecheck_source(&self, src: String) -> ProcRes {
 382         let mut rustc = Command::new(&self.config.rustc_path);
 383
 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();
 387
 388         let target = if self.props.force_host {
 389             &*self.config.host
 390         } else {
 391             &*self.config.target
 392         };
 393
 394         let aux_dir = self.aux_output_dir_name();
 395
 396         rustc.arg("-")
 397             .arg("-Zno-trans")
 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);
 402
 403         if let Some(revision) = self.revision {
 404             rustc.args(&["--cfg", revision]);
 405         }
 406
 407         rustc.args(self.split_maybe_args(&self.config.target_rustcflags));
 408         rustc.args(&self.props.compile_flags);
 409
 410         self.compose_and_run_compiler(rustc, Some(src))
 411     }
 412
 413     fn run_debuginfo_gdb_test(&self) {
 414         assert!(self.revision.is_none(), "revisions not relevant here");
 415
 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()
 420         };
 421
 422         let test_cx = TestCx {
 423             config: &config,
 424             ..*self
 425         };
 426
 427         test_cx.run_debuginfo_gdb_test_no_opt();
 428     }
 429
 430     fn run_debuginfo_gdb_test_no_opt(&self) {
 431         let prefixes = if self.config.gdb_native_rust {
 432             // GDB with Rust
 433             static PREFIXES: &'static [&'static str] = &["gdb", "gdbr"];
 434             println!("NOTE: compiletest thinks it is using GDB with native rust support");
 435             PREFIXES
 436         } else {
 437             // Generic GDB
 438             static PREFIXES: &'static [&'static str] = &["gdb", "gdbg"];
 439             println!("NOTE: compiletest thinks it is using GDB without native rust support");
 440             PREFIXES
 441         };
 442
 443         let DebuggerCommands {
 444             commands,
 445             check_lines,
 446             breakpoint_lines
 447         } = self.parse_debugger_commands(prefixes);
 448         let mut cmds = commands.join("\n");
 449
 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);
 454         }
 455
 456         let exe_file = self.make_exe_name();
 457
 458         let debugger_run_result;
 459         match &*self.config.target {
 460             "arm-linux-androideabi" |
 461             "armv7-linux-androideabi" |
 462             "aarch64-linux-android" => {
 463
 464                 cmds = cmds.replace("run", "continue");
 465
 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")
 469                 };
 470
 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()
 483                                                  .unwrap()
 484                                                  .to_string_lossy(),
 485                                                  *line)[..]);
 486                 }
 487                 script_str.push_str(&cmds);
 488                 script_str.push_str("\nquit\n");
 489
 490                 debug!("script_str = {}", script_str);
 491                 self.dump_output_file(&script_str, "debugger.script");
 492
 493                 let adb_path = &self.config.adb_path;
 494
 495                 Command::new(adb_path)
 496                     .arg("push")
 497                     .arg(&exe_file)
 498                     .arg(&self.config.adb_test_dir)
 499                     .status()
 500                     .expect(&format!("failed to exec `{:?}`", adb_path));
 501
 502                 Command::new(adb_path)
 503                     .args(&["forward", "tcp:5039", "tcp:5039"])
 504                     .status()
 505                     .expect(&format!("failed to exec `{:?}`", adb_path));
 506
 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")
 511                                       {"64"} else {""},
 512                                       self.config.adb_test_dir.clone(),
 513                                       exe_file.file_name().unwrap().to_str()
 514                                       .unwrap());
 515
 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())
 521                     .spawn()
 522                     .expect(&format!("failed to exec `{:?}`", adb_path));
 523
 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();
 529                 loop {
 530                     line.truncate(0);
 531                     stdout.read_line(&mut line).unwrap();
 532                     if line.starts_with("Listening on port 5039") {
 533                         break
 534                     }
 535                 }
 536                 drop(stdout);
 537
 538                 let debugger_script = self.make_out_name("debugger.script");
 539                 // FIXME (#9639): This needs to handle non-utf8 paths
 540                 let debugger_opts =
 541                     vec!["-quiet".to_owned(),
 542                          "-batch".to_owned(),
 543                          "-nx".to_owned(),
 544                          format!("-command={}", debugger_script.to_str().unwrap())];
 545
 546                 let mut gdb_path = tool_path;
 547                 gdb_path.push_str("/bin/gdb");
 548                 let Output {
 549                     status,
 550                     stdout,
 551                     stderr
 552                 } = Command::new(&gdb_path)
 553                     .args(&debugger_opts)
 554                     .output()
 555                     .expect(&format!("failed to exec `{:?}`", gdb_path));
 556                 let cmdline = {
 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));
 561                     cmdline
 562                 };
 563
 564                 debugger_run_result = ProcRes {
 565                     status,
 566                     stdout: String::from_utf8(stdout).unwrap(),
 567                     stderr: String::from_utf8(stderr).unwrap(),
 568                     cmdline,
 569                 };
 570                 if adb.kill().is_err() {
 571                     println!("Adb process is already finished.");
 572                 }
 573             }
 574
 575             _ => {
 576                 let rust_src_root = self.config.find_rust_src_root().expect(
 577                     "Could not find Rust source root",
 578                 );
 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)
 581                                                            .to_str()
 582                                                            .unwrap()
 583                                                            .to_owned();
 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");
 588
 589                 match self.config.gdb_version {
 590                     Some(version) => {
 591                         println!("NOTE: compiletest thinks it is using GDB version {}",
 592                                  version);
 593
 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
 597                             script_str.push_str(
 598                                 &format!("add-auto-load-safe-path {}\n",
 599                                          rust_pp_module_abs_path.replace(r"\", r"\\"))
 600                             );
 601                         }
 602                     }
 603                     _ => {
 604                         println!("NOTE: compiletest does not know which version of \
 605                                   GDB it is using");
 606                     }
 607                 }
 608
 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");
 612
 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));
 616
 617                 // Load the target executable
 618                 script_str.push_str(&format!("file {}\n",
 619                                              exe_file.to_str().unwrap()
 620                                              .replace(r"\", r"\\")));
 621
 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");
 625                 }
 626
 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()
 631                                                  .to_string_lossy(),
 632                                                  *line));
 633                 }
 634
 635                 script_str.push_str(&cmds);
 636                 script_str.push_str("\nquit\n");
 637
 638                 debug!("script_str = {}", script_str);
 639                 self.dump_output_file(&script_str, "debugger.script");
 640
 641                 let debugger_script = self.make_out_name("debugger.script");
 642
 643                 // FIXME (#9639): This needs to handle non-utf8 paths
 644                 let debugger_opts =
 645                     vec!["-quiet".to_owned(),
 646                          "-batch".to_owned(),
 647                          "-nx".to_owned(),
 648                          format!("-command={}", debugger_script.to_str().unwrap())];
 649
 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);
 653
 654                 debugger_run_result =
 655                     self.compose_and_run(gdb,
 656                                          self.config.run_lib_path.to_str().unwrap(),
 657                                          None,
 658                                          None);
 659             }
 660         }
 661
 662         if !debugger_run_result.status.success() {
 663             self.fatal_proc_rec("gdb failed to execute", &debugger_run_result);
 664         }
 665
 666         self.check_debugger_output(&debugger_run_result, &check_lines);
 667     }
 668
 669     fn run_debuginfo_lldb_test(&self) {
 670         assert!(self.revision.is_none(), "revisions not relevant here");
 671
 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.");
 674         }
 675
 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()
 680         };
 681
 682
 683         let test_cx = TestCx {
 684             config: &config,
 685             ..*self
 686         };
 687
 688         test_cx.run_debuginfo_lldb_test_no_opt();
 689     }
 690
 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);
 696         }
 697
 698         let exe_file = self.make_exe_name();
 699
 700         match self.config.lldb_version {
 701             Some(ref version) => {
 702                 println!("NOTE: compiletest thinks it is using LLDB version {}",
 703                          version);
 704             }
 705             _ => {
 706                 println!("NOTE: compiletest does not know which version of \
 707                           LLDB it is using");
 708             }
 709         }
 710
 711         // Parse debugger commands etc from test files
 712         let DebuggerCommands {
 713             commands,
 714             check_lines,
 715             breakpoint_lines,
 716             ..
 717         } = self.parse_debugger_commands(&["lldb"]);
 718
 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");
 722
 723         // Make LLDB emit its version, so we have it documented in the test output
 724         script_str.push_str("version\n");
 725
 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",
 729         );
 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)
 732                                                    .to_str()
 733                                                    .unwrap()
 734                                                    .to_owned();
 735
 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");
 742
 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",
 747                                          source_file_name,
 748                                          line));
 749         }
 750
 751         // Append the other commands
 752         for line in &commands {
 753             script_str.push_str(line);
 754             script_str.push_str("\n");
 755         }
 756
 757         // Finally, quit the debugger
 758         script_str.push_str("\nquit\n");
 759
 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");
 764
 765         // Let LLDB execute the script via lldb_batchmode.py
 766         let debugger_run_result = self.run_lldb(&exe_file,
 767                                                 &debugger_script,
 768                                                 &rust_src_root);
 769
 770         if !debugger_run_result.status.success() {
 771             self.fatal_proc_rec("Error while running LLDB", &debugger_run_result);
 772         }
 773
 774         self.check_debugger_output(&debugger_run_result, &check_lines);
 775     }
 776
 777     fn run_lldb(&self,
 778                 test_executable: &Path,
 779                 debugger_script: &Path,
 780                 rust_src_root: &Path)
 781                 -> ProcRes {
 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)
 788                          .env("PYTHONPATH",
 789                               self.config.lldb_python_dir.as_ref().unwrap()))
 790     }
 791
 792     fn cmd2procres(&self, cmd: &mut Command) -> ProcRes {
 793         let (status, out, err) = match cmd.output() {
 794             Ok(Output { status, stdout, stderr }) => {
 795                 (status,
 796                  String::from_utf8(stdout).unwrap(),
 797                  String::from_utf8(stderr).unwrap())
 798             },
 799             Err(e) => {
 800                 self.fatal(&format!("Failed to setup Python process for \
 801                                       LLDB script: {}", e))
 802             }
 803         };
 804
 805         self.dump_output(&out, &err);
 806         ProcRes {
 807             status,
 808             stdout: out,
 809             stderr: err,
 810             cmdline: format!("{:?}", cmd)
 811         }
 812     }
 813
 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<_>>();
 819
 820         let mut breakpoint_lines = vec![];
 821         let mut commands = vec![];
 822         let mut check_lines = vec![];
 823         let mut counter = 1;
 824         let reader = BufReader::new(File::open(&self.testpaths.file).unwrap());
 825         for line in reader.lines() {
 826             match line {
 827                 Ok(line) => {
 828                     if line.contains("#break") {
 829                         breakpoint_lines.push(counter);
 830                     }
 831
 832                     for &(ref command_directive, ref check_directive) in &directives {
 833                         self.config.parse_name_value_directive(
 834                             &line,
 835                             command_directive).map(|cmd| {
 836                                 commands.push(cmd)
 837                             });
 838
 839                         self.config.parse_name_value_directive(
 840                             &line,
 841                             check_directive).map(|cmd| {
 842                                 check_lines.push(cmd)
 843                             });
 844                     }
 845                 }
 846                 Err(e) => {
 847                     self.fatal(&format!("Error while parsing debugger commands: {}", e))
 848                 }
 849             }
 850             counter += 1;
 851         }
 852
 853         DebuggerCommands {
 854             commands,
 855             check_lines,
 856             breakpoint_lines,
 857         }
 858     }
 859
 860     fn cleanup_debug_info_options(&self, options: &Option<String>) -> Option<String> {
 861         if options.is_none() {
 862             return None;
 863         }
 864
 865         // Remove options that are either unwanted (-O) or may lead to duplicates due to RUSTFLAGS.
 866         let options_to_remove = [
 867             "-O".to_owned(),
 868             "-g".to_owned(),
 869             "--debuginfo".to_owned()
 870         ];
 871         let new_options =
 872             self.split_maybe_args(options).into_iter()
 873                                           .filter(|x| !options_to_remove.contains(x))
 874                                           .collect::<Vec<String>>();
 875
 876         Some(new_options.join(" "))
 877     }
 878
 879     fn check_debugger_output(&self, debugger_run_result: &ProcRes, check_lines: &[String]) {
 880         let num_check_lines = check_lines.len();
 881
 882         let mut check_line_index = 0;
 883         for line in debugger_run_result.stdout.lines() {
 884             if check_line_index >= num_check_lines {
 885                 break;
 886             }
 887
 888             if check_single_line(line, &(check_lines[check_line_index])[..]) {
 889                 check_line_index += 1;
 890             }
 891         }
 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);
 896         }
 897
 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("[...]");
 905
 906             let check_fragments: Vec<&str> = check_line.split("[...]")
 907                                                        .filter(|frag| !frag.is_empty())
 908                                                        .collect();
 909             if check_fragments.is_empty() {
 910                 return true;
 911             }
 912
 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),
 916                     None => return false
 917                 }
 918             } else {
 919                 (line, 0)
 920             };
 921
 922             for current_fragment in &check_fragments[first_fragment..] {
 923                 match rest.find(current_fragment) {
 924                     Some(pos) => {
 925                         rest = &rest[pos + current_fragment.len() .. ];
 926                     }
 927                     None => return false
 928                 }
 929             }
 930
 931             if !can_end_anywhere && !rest.is_empty() {
 932                 return false;
 933             }
 934
 935             true
 936         }
 937     }
 938
 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 {
 944                 return
 945             } else {
 946                 self.fatal(&format!("no error pattern specified in {:?}",
 947                                     self.testpaths.file.display()));
 948             }
 949         }
 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);
 956                 next_err_idx += 1;
 957                 if next_err_idx == self.props.error_patterns.len() {
 958                     debug!("found all error patterns");
 959                     done = true;
 960                     break;
 961                 }
 962                 next_err_pat = self.props.error_patterns[next_err_idx].trim();
 963             }
 964         }
 965         if done { return; }
 966
 967         let missing_patterns = &self.props.error_patterns[next_err_idx..];
 968         if missing_patterns.len() == 1 {
 969             self.fatal_proc_rec(
 970                 &format!("error pattern '{}' not found!", missing_patterns[0]),
 971                 proc_res);
 972         } else {
 973             for pattern in missing_patterns {
 974                 self.error(&format!("error pattern '{}' not found!", *pattern));
 975             }
 976             self.fatal_proc_rec("multiple error patterns not found", proc_res);
 977         }
 978     }
 979
 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);
 984             }
 985         }
 986     }
 987
 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);
 994             }
 995         }
 996     }
 997
 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);
1004         }
1005
1006         let file_name =
1007             format!("{}", self.testpaths.file.display())
1008             .replace(r"\", "/"); // on windows, translate all '\' path separators to '/'
1009
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));
1016
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 {
1022             let opt_index =
1023                 expected_errors
1024                 .iter()
1025                 .enumerate()
1026                 .position(|(index, expected_error)| {
1027                     !found[index] &&
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)
1032                 });
1033
1034             match opt_index {
1035                 Some(index) => {
1036                     // found a match, everybody is happy
1037                     assert!(!found[index]);
1038                     found[index] = true;
1039                 }
1040
1041                 None => {
1042                     if self.is_unexpected_compiler_message(actual_error, expect_help, expect_note) {
1043                         self.error(
1044                             &format!("{}:{}: unexpected {:?}: '{}'",
1045                                      file_name,
1046                                      actual_error.line_num,
1047                                      actual_error.kind.as_ref()
1048                                      .map_or(String::from("message"),
1049                                              |k| k.to_string()),
1050                                      actual_error.msg));
1051                         unexpected.push(actual_error);
1052                     }
1053                 }
1054             }
1055         }
1056
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() {
1060             if !found[index] {
1061                 self.error(
1062                     &format!("{}:{}: expected {} not found: {}",
1063                              file_name,
1064                              expected_error.line_num,
1065                              expected_error.kind.as_ref()
1066                              .map_or("message".into(),
1067                                      |k| k.to_string()),
1068                              expected_error.msg));
1069                 not_found.push(expected_error);
1070             }
1071         }
1072
1073         if !unexpected.is_empty() || !not_found.is_empty() {
1074             self.error(
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);
1081             }
1082             if !not_found.is_empty() {
1083                 println!("not found errors (from test file): {:#?}\n", not_found);
1084             }
1085             panic!();
1086         }
1087     }
1088
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,
1095                                       expect_help: bool,
1096                                       expect_note: bool)
1097                                       -> bool {
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) |
1104             None => false
1105         }
1106     }
1107
1108     fn compile_test(&self) -> ProcRes {
1109         let mut rustc = self.make_compile_args(
1110             &self.testpaths.file, TargetLocation::ThisFile(self.make_exe_name()));
1111
1112         rustc.arg("-L").arg(&self.aux_output_dir_name());
1113
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"]);
1122             }
1123             _ => {}
1124         }
1125
1126         self.compose_and_run_compiler(rustc, None)
1127     }
1128
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,
1134                                                          self.revision,
1135                                                          self.config);
1136                 let aux_cx = TestCx {
1137                     config: self.config,
1138                     props: &aux_props,
1139                     testpaths: &aux_testpaths,
1140                     revision: self.revision
1141                 };
1142                 let auxres = aux_cx.document(out_dir);
1143                 if !auxres.status.success() {
1144                     return auxres;
1145                 }
1146             }
1147         }
1148
1149         let aux_dir = self.aux_output_dir_name();
1150
1151         let rustdoc_path = self.config.rustdoc_path.as_ref().expect("--rustdoc-path passed");
1152         let mut rustdoc = Command::new(rustdoc_path);
1153
1154         rustdoc.arg("-L").arg(aux_dir)
1155             .arg("-o").arg(out_dir)
1156             .arg(&self.testpaths.file)
1157             .args(&self.props.compile_flags);
1158
1159         self.compose_and_run_compiler(rustdoc, None)
1160     }
1161
1162     fn exec_compiled_test(&self) -> ProcRes {
1163         let env = &self.props.exec_env;
1164
1165         match &*self.config.target {
1166             // This is pretty similar to below, we're transforming:
1167             //
1168             //      program arg1 arg2
1169             //
1170             // into
1171             //
1172             //      remote-test-client run program:support-lib.so arg1 arg2
1173             //
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() {
1186                             continue
1187                         }
1188                         prog.push_str(":");
1189                         prog.push_str(entry.path().to_str().unwrap());
1190                     }
1191                 }
1192                 let mut test_client = Command::new(
1193                     self.config.remote_test_client.as_ref().unwrap());
1194                 test_client
1195                     .args(&["run", &prog])
1196                     .args(args)
1197                     .envs(env.clone());
1198                 self.compose_and_run(test_client,
1199                                      self.config.run_lib_path.to_str().unwrap(),
1200                                      Some(aux_dir.to_str().unwrap()),
1201                                      None)
1202             }
1203             _ => {
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);
1207                 program.args(args)
1208                     .current_dir(&self.output_base_name().parent().unwrap())
1209                     .envs(env.clone());
1210                 self.compose_and_run(program,
1211                                      self.config.run_lib_path.to_str().unwrap(),
1212                                      Some(aux_dir.to_str().unwrap()),
1213                                      None)
1214             }
1215         }
1216     }
1217
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
1222                                     .parent()
1223                                     .expect("test file path has no parent")
1224                                     .join("auxiliary")
1225                                     .join(rel_ab);
1226         if !test_ab.exists() {
1227             self.fatal(&format!("aux-build `{}` source not found", test_ab.display()))
1228         }
1229
1230         TestPaths {
1231             file: test_ab,
1232             base: self.testpaths.base.clone(),
1233             relative_dir: self.testpaths.relative_dir
1234                                         .join("auxiliary")
1235                                         .join(rel_ab)
1236                                         .parent()
1237                                         .expect("aux-build path has no parent")
1238                                         .to_path_buf()
1239         }
1240     }
1241
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();
1245         }
1246
1247         let aux_dir = self.aux_output_dir_name();
1248
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,
1252                                                      self.revision,
1253                                                      self.config);
1254             let aux_output = {
1255                 let f = self.make_lib_name(&self.testpaths.file);
1256                 let parent = f.parent().unwrap();
1257                 TargetLocation::ThisDirectory(parent.to_path_buf())
1258             };
1259             let aux_cx = TestCx {
1260                 config: self.config,
1261                 props: &aux_props,
1262                 testpaths: &aux_testpaths,
1263                 revision: self.revision
1264             };
1265             let mut aux_rustc = aux_cx.make_compile_args(&aux_testpaths.file, aux_output);
1266
1267             let crate_type = if aux_props.no_prefer_dynamic {
1268                 None
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).
1275                 //
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.
1280                 Some("lib")
1281             } else {
1282                 Some("dylib")
1283             };
1284
1285             if let Some(crate_type) = crate_type {
1286                 aux_rustc.args(&["--crate-type", crate_type]);
1287             }
1288
1289             aux_rustc.arg("-L").arg(&aux_dir);
1290
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()),
1294                                                 None);
1295             if !auxres.status.success() {
1296                 self.fatal_proc_rec(
1297                     &format!("auxiliary build of {:?} failed to compile: ",
1298                              aux_testpaths.file.display()),
1299                     &auxres);
1300             }
1301         }
1302
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()),
1307                              input)
1308     }
1309
1310     fn compose_and_run(&self,
1311                        mut command: Command,
1312                        lib_path: &str,
1313                        aux_path: Option<&str>,
1314                        input: Option<String>) -> ProcRes {
1315         let cmdline =
1316         {
1317             let cmdline = self.make_cmdline(&command, lib_path);
1318             logv(self.config, format!("executing {}", cmdline));
1319             cmdline
1320         };
1321
1322         command
1323             .stdout(Stdio::piped())
1324             .stderr(Stdio::piped())
1325             .stdin(Stdio::piped());
1326
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))
1333         }
1334         path.insert(0, PathBuf::from(lib_path));
1335
1336         // Add the new dylib search path var
1337         let newpath = env::join_paths(&path).unwrap();
1338         command.env(dylib_env_var(), newpath);
1339
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();
1343         }
1344         let Output { status, stdout, stderr } = child.wait_with_output().unwrap();
1345
1346         let result = ProcRes {
1347             status,
1348             stdout: String::from_utf8(stdout).unwrap(),
1349             stderr: String::from_utf8(stderr).unwrap(),
1350             cmdline,
1351         };
1352
1353         self.dump_output(&result.stdout, &result.stderr);
1354
1355         result
1356     }
1357
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);
1362
1363         // Optionally prevent default --target if specified in test compile-flags.
1364         let custom_target = self.props.compile_flags
1365             .iter()
1366             .fold(false, |acc, x| acc || x.starts_with("--target"));
1367
1368         if !custom_target {
1369             let target = if self.props.force_host {
1370                 &*self.config.host
1371             } else {
1372                 &*self.config.target
1373             };
1374
1375             rustc.arg(&format!("--target={}", target));
1376         }
1377
1378         if let Some(revision) = self.revision {
1379             rustc.args(&["--cfg", revision]);
1380         }
1381
1382         if let Some(ref incremental_dir) = self.props.incremental_dir {
1383             rustc.args(&["-Z", &format!("incremental={}", incremental_dir.display())]);
1384         }
1385
1386         match self.config.mode {
1387             CompileFail |
1388             ParseFail |
1389             Incremental => {
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"]);
1395                 }
1396             }
1397             MirOpt => {
1398                 rustc.args(&[
1399                     "-Zdump-mir=all",
1400                     "-Zmir-opt-level=3",
1401                     "-Zdump-mir-exclude-pass-number"]);
1402
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);
1408
1409                 rustc.arg(dir_opt);
1410             }
1411             RunPass |
1412             RunFail |
1413             RunPassValgrind |
1414             Pretty |
1415             DebugInfoGdb |
1416             DebugInfoLldb |
1417             Codegen |
1418             Rustdoc |
1419             RunMake |
1420             Ui |
1421             CodegenUnits => {
1422                 // do not use JSON output
1423             }
1424         }
1425
1426         if !self.props.no_prefer_dynamic {
1427             rustc.args(&["-C", "prefer-dynamic"]);
1428         }
1429
1430         match output_file {
1431             TargetLocation::ThisFile(path) => {
1432                 rustc.arg("-o").arg(path);
1433             }
1434             TargetLocation::ThisDirectory(path) => {
1435                 rustc.arg("--out-dir").arg(path);
1436             }
1437         }
1438
1439         if self.props.force_host {
1440             rustc.args(self.split_maybe_args(&self.config.host_rustcflags));
1441         } else {
1442             rustc.args(self.split_maybe_args(&self.config.target_rustcflags));
1443         }
1444
1445         rustc.args(&self.props.compile_flags);
1446
1447         rustc
1448     }
1449
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)
1455     }
1456
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();
1462             fname.push(".js");
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);
1468         }
1469         f
1470     }
1471
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);
1476
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());
1481             } else {
1482                 self.fatal("no NodeJS binary found (--nodejs)");
1483             }
1484         }
1485
1486         let exe_file = self.make_exe_name();
1487
1488         // FIXME (#9639): This needs to handle non-utf8 paths
1489         args.push(exe_file.to_str().unwrap().to_owned());
1490
1491         // Add the arguments in the run_flags directive
1492         args.extend(self.split_maybe_args(&self.props.run_flags));
1493
1494         let prog = args.remove(0);
1495          ProcArgs {
1496             prog,
1497             args,
1498         }
1499     }
1500
1501     fn split_maybe_args(&self, argstr: &Option<String>) -> Vec<String> {
1502         match *argstr {
1503             Some(ref s) => {
1504                 s
1505                     .split(' ')
1506                     .filter_map(|s| {
1507                         if s.chars().all(|c| c.is_whitespace()) {
1508                             None
1509                         } else {
1510                             Some(s.to_owned())
1511                         }
1512                     }).collect()
1513             }
1514             None => Vec::new()
1515         }
1516     }
1517
1518     fn make_cmdline(&self, command: &Command, libpath: &str) -> String {
1519         use util;
1520
1521         // Linux and mac don't require adjusting the library search path
1522         if cfg!(unix) {
1523             format!("{:?}", command)
1524         } else {
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))
1529             }
1530
1531             format!("{} {:?}", lib_path_cmd_prefix(libpath), command)
1532         }
1533     }
1534
1535     fn dump_output(&self, out: &str, err: &str) {
1536         let revision = if let Some(r) = self.revision {
1537             format!("{}.", r)
1538         } else {
1539             String::new()
1540         };
1541
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);
1545     }
1546
1547     fn dump_output_file(&self,
1548                         out: &str,
1549                         extension: &str) {
1550         let outfile = self.make_out_name(extension);
1551         File::create(&outfile).unwrap().write_all(out.as_bytes()).unwrap();
1552     }
1553
1554     fn make_out_name(&self, extension: &str) -> PathBuf {
1555         self.output_base_name().with_extension(extension)
1556     }
1557
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)
1563     }
1564
1565     fn output_testname(&self, filepath: &Path) -> PathBuf {
1566         PathBuf::from(filepath.file_stem().unwrap())
1567     }
1568
1569     /// Given a test path like `compile-fail/foo/bar.rs` Returns a name like
1570     ///
1571     ///     <output>/foo/bar-stage1
1572     fn output_base_name(&self) -> PathBuf {
1573         let dir = self.config.build_base.join(&self.testpaths.relative_dir);
1574
1575         // Note: The directory `dir` is created during `collect_tests_from_dir`
1576         dir
1577             .join(&self.output_testname(&self.testpaths.file))
1578             .with_extension(&self.config.stage_id)
1579     }
1580
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!("------------------------------------------");
1588         }
1589     }
1590
1591     fn error(&self, err: &str) {
1592         match self.revision {
1593             Some(rev) => println!("\nerror in revision `{}`: {}", rev, err),
1594             None => println!("\nerror: {}", err)
1595         }
1596     }
1597
1598     fn fatal(&self, err: &str) -> ! {
1599         self.error(err); panic!();
1600     }
1601
1602     fn fatal_proc_rec(&self, err: &str, proc_res: &ProcRes) -> ! {
1603         self.try_print_open_handles();
1604         self.error(err);
1605         proc_res.fatal(None);
1606     }
1607
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
1610     //
1611     // This is a very "opportunistic" debugging attempt, so we ignore all
1612     // errors here.
1613     fn try_print_open_handles(&self) {
1614         if !cfg!(windows) {
1615             return
1616         }
1617         if self.config.mode != Incremental {
1618             return
1619         }
1620
1621         let filename = match self.testpaths.file.file_stem() {
1622             Some(path) => path,
1623             None => return,
1624         };
1625
1626         let mut cmd = Command::new("handle.exe");
1627         cmd.arg("-a").arg("-u");
1628         cmd.arg(filename);
1629         cmd.arg("-nobanner");
1630         let output = match cmd.output() {
1631             Ok(output) => output,
1632             Err(_) => return,
1633         };
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!("---------------------------------------------------");
1643     }
1644
1645     // codegen tests (using FileCheck)
1646
1647     fn compile_test_and_save_ir(&self) -> ProcRes {
1648         let aux_dir = self.aux_output_dir_name();
1649
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");
1655
1656         self.compose_and_run_compiler(rustc, None)
1657     }
1658
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)
1665     }
1666
1667     fn run_codegen_test(&self) {
1668         assert!(self.revision.is_none(), "revisions not relevant here");
1669
1670         if self.config.llvm_filecheck.is_none() {
1671             self.fatal("missing --llvm-filecheck");
1672         }
1673
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);
1677         }
1678
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);
1682         }
1683     }
1684
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") {
1688             "auto"
1689         } else if cfg!(target_os = "freebsd") {
1690             "ISO-8859-1"
1691         } else {
1692             "UTF-8"
1693         }
1694     }
1695
1696     fn run_rustdoc_test(&self) {
1697         assert!(self.revision.is_none(), "revisions not relevant here");
1698
1699         let out_dir = self.output_base_name();
1700         let _ = fs::remove_dir_all(&out_dir);
1701         create_dir_all(&out_dir).unwrap();
1702
1703         let proc_res = self.document(&out_dir);
1704         if !proc_res.status.success() {
1705             self.fatal_proc_rec("rustdoc failed!", &proc_res);
1706         }
1707
1708         if self.props.check_test_line_numbers_match {
1709             self.check_rustdoc_test_option(proc_res);
1710         } else {
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"))
1715                     .arg(out_dir)
1716                     .arg(&self.testpaths.file),
1717             );
1718             if !res.status.success() {
1719                 self.fatal_proc_rec("htmldocck failed!", &res);
1720             }
1721         }
1722     }
1723
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;
1732         content.lines()
1733                .enumerate()
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 ")
1740                                       .next()
1741                                       .unwrap()
1742                                       .replace(";", ""));
1743                        }
1744                        None
1745                    } else {
1746                        let sline = line.split("///").last().unwrap_or("");
1747                        let line = sline.trim_left();
1748                        if line.starts_with("```") {
1749                            if ignore {
1750                                ignore = false;
1751                                None
1752                            } else {
1753                                ignore = true;
1754                                Some(line_nb + 1)
1755                            }
1756                        } else {
1757                            None
1758                        }
1759                    }
1760                })
1761                .collect()
1762     }
1763
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)
1770                                         .to_str()
1771                                         .unwrap()
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)
1778                              .unwrap_or(&path)
1779                              .to_str()
1780                              .unwrap()
1781                              .replace('\\', "/"),
1782                          self.get_lines(&path, None));
1783         }
1784
1785         let mut tested = 0;
1786         for _ in res.stdout.split('\n')
1787                            .filter(|s| s.starts_with("test "))
1788                            .inspect(|s| {
1789                                let tmp: Vec<&str> = s.split(" - ").collect();
1790                                if tmp.len() == 2 {
1791                                    let path = tmp[0].rsplit("test ").next().unwrap();
1792                                    if let Some(ref mut v) = files.get_mut(
1793                                                                 &path.replace('\\', "/")) {
1794                                        tested += 1;
1795                                        let mut iter = tmp[1].split("(line ");
1796                                        iter.next();
1797                                        let line = iter.next()
1798                                                       .unwrap_or(")")
1799                                                       .split(')')
1800                                                       .next()
1801                                                       .unwrap_or("0")
1802                                                       .parse()
1803                                                       .unwrap_or(0);
1804                                        if let Ok(pos) = v.binary_search(&line) {
1805                                            v.remove(pos);
1806                                        } else {
1807                                            self.fatal_proc_rec(
1808                                                &format!("Not found doc test: \"{}\" in \"{}\":{:?}",
1809                                                         s, path, v),
1810                                                &res);
1811                                        }
1812                                    }
1813                                }
1814                            }) {}
1815         if tested == 0 {
1816             self.fatal_proc_rec(&format!("No test has been found... {:?}", files), &res);
1817         } else {
1818             for (entry, v) in &files {
1819                 if !v.is_empty() {
1820                     self.fatal_proc_rec(&format!("Not found test at line{} \"{}\":{:?}",
1821                                                  if v.len() > 1 { "s" } else { "" }, entry, v),
1822                                         &res);
1823                 }
1824             }
1825         }
1826     }
1827
1828     fn run_codegen_units_test(&self) {
1829         assert!(self.revision.is_none(), "revisions not relevant here");
1830
1831         let proc_res = self.compile_test();
1832
1833         if !proc_res.status.success() {
1834             self.fatal_proc_rec("compilation failed!", &proc_res);
1835         }
1836
1837         self.check_no_compiler_crash(&proc_res);
1838
1839         const PREFIX: &'static str = "TRANS_ITEM ";
1840         const CGU_MARKER: &'static str = "@@";
1841
1842         let actual: Vec<TransItem> = proc_res
1843             .stdout
1844             .lines()
1845             .filter(|line| line.starts_with(PREFIX))
1846             .map(str_to_trans_item)
1847             .collect();
1848
1849         let expected: Vec<TransItem> = errors::load_errors(&self.testpaths.file, None)
1850             .iter()
1851             .map(|e| str_to_trans_item(&e.msg[..]))
1852             .collect();
1853
1854         let mut missing = Vec::new();
1855         let mut wrong_cgus = Vec::new();
1856
1857         for expected_item in &expected {
1858             let actual_item_with_same_name = actual.iter()
1859                                                    .find(|ti| ti.name == expected_item.name);
1860
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()));
1866                 }
1867             } else {
1868                 missing.push(expected_item.string.clone());
1869             }
1870         }
1871
1872         let unexpected: Vec<_> =
1873             actual.iter()
1874                   .filter(|acgu| !expected.iter().any(|ecgu| acgu.name == ecgu.name))
1875                   .map(|acgu| acgu.string.clone())
1876                   .collect();
1877
1878         if !missing.is_empty() {
1879             missing.sort();
1880
1881             println!("\nThese items should have been contained but were not:\n");
1882
1883             for item in &missing {
1884                 println!("{}", item);
1885             }
1886
1887             println!("\n");
1888         }
1889
1890         if !unexpected.is_empty() {
1891             let sorted = {
1892                 let mut sorted = unexpected.clone();
1893                 sorted.sort();
1894                 sorted
1895             };
1896
1897             println!("\nThese items were contained but should not have been:\n");
1898
1899             for item in sorted {
1900                 println!("{}", item);
1901             }
1902
1903             println!("\n");
1904         }
1905
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");
1909
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));
1914                 println!("");
1915             }
1916         }
1917
1918         if !(missing.is_empty() && unexpected.is_empty() && wrong_cgus.is_empty())
1919         {
1920             panic!();
1921         }
1922
1923         #[derive(Clone, Eq, PartialEq)]
1924         struct TransItem {
1925             name: String,
1926             codegen_units: HashSet<String>,
1927             string: String,
1928         }
1929
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()
1934             } else {
1935                 s.trim()
1936             };
1937
1938             let full_string = format!("{}{}", PREFIX, s.trim().to_owned());
1939
1940             let parts: Vec<&str> = s.split(CGU_MARKER)
1941                                     .map(str::trim)
1942                                     .filter(|s| !s.is_empty())
1943                                     .collect();
1944
1945             let name = parts[0].trim();
1946
1947             let cgus = if parts.len() > 1 {
1948                 let cgus_str = parts[1];
1949
1950                 cgus_str.split(' ')
1951                         .map(str::trim)
1952                         .filter(|s| !s.is_empty())
1953                         .map(str::to_owned)
1954                         .collect()
1955             }
1956             else {
1957                 HashSet::new()
1958             };
1959
1960             TransItem {
1961                 name: name.to_owned(),
1962                 codegen_units: cgus,
1963                 string: full_string,
1964             }
1965         }
1966
1967         fn codegen_units_to_str(cgus: &HashSet<String>) -> String
1968         {
1969             let mut cgus: Vec<_> = cgus.iter().collect();
1970             cgus.sort();
1971
1972             let mut string = String::new();
1973             for cgu in cgus {
1974                 string.push_str(&cgu[..]);
1975                 string.push_str(" ");
1976             }
1977
1978             string
1979         }
1980     }
1981
1982     fn init_incremental_test(&self) {
1983         // (See `run_incremental_test` for an overview of how incremental tests work.)
1984
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
1988         // runs.
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();
1995         }
1996         fs::create_dir_all(&incremental_dir).unwrap();
1997
1998         if self.config.verbose {
1999             print!("init_incremental_test: incremental_dir={}", incremental_dir.display());
2000         }
2001     }
2002
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
2019         //
2020         // FIXME -- use non-incremental mode as an oracle? That doesn't apply
2021         // to #[rustc_dirty] and clean tests I guess
2022
2023         let revision = self.revision.expect("incremental tests require a list of revisions");
2024
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");
2028
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);
2032
2033         let revision_cx = TestCx {
2034             config: self.config,
2035             props: &revision_props,
2036             testpaths: self.testpaths,
2037             revision: self.revision,
2038         };
2039
2040         if self.config.verbose {
2041             print!("revision={:?} revision_props={:#?}", revision, revision_props);
2042         }
2043
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();
2050         } else {
2051             revision_cx.fatal(
2052                 "revision name must begin with rpass, rfail, or cfail");
2053         }
2054     }
2055
2056     /// Directory where incremental work products are stored.
2057     fn incremental_dir(&self) -> PathBuf {
2058         self.output_base_name().with_extension("inc")
2059     }
2060
2061     fn run_rmake_test(&self) {
2062         // FIXME(#11094): we should fix these tests
2063         if self.config.host != self.config.target {
2064             return
2065         }
2066
2067         let cwd = env::current_dir().unwrap();
2068         let src_root = self.config.src_base.parent().unwrap()
2069                                            .parent().unwrap()
2070                                            .parent().unwrap();
2071         let src_root = cwd.join(&src_root);
2072
2073         let tmpdir = cwd.join(self.output_base_name());
2074         if tmpdir.exists() {
2075             self.aggressive_rm_rf(&tmpdir).unwrap();
2076         }
2077         create_dir_all(&tmpdir).unwrap();
2078
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") {
2083             "gmake"
2084         } else {
2085             "make"
2086         };
2087
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)
2092            .env("S", src_root)
2093            .env("RUST_BUILD_STAGE", &self.config.stage_id)
2094            .env("RUSTC", cwd.join(&self.config.rustc_path))
2095            .env("RUSTDOC",
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);
2103
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");
2107
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");
2112
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(" ");
2118
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);
2124         } else {
2125             cmd.env("CC", format!("{} {}", self.config.cc, self.config.cflags))
2126                .env("CXX", format!("{} {}", self.config.cxx, self.config.cflags));
2127
2128             if self.config.target.contains("windows") {
2129                 cmd.env("IS_WINDOWS", "1");
2130             }
2131         }
2132
2133         let output = cmd.output().expect("failed to spawn `make`");
2134         if !output.status.success() {
2135             let res = ProcRes {
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),
2140             };
2141             self.fatal_proc_rec("make failed", &res);
2142         }
2143     }
2144
2145     fn aggressive_rm_rf(&self, path: &Path) -> io::Result<()> {
2146         for e in path.read_dir()? {
2147             let entry = e?;
2148             let path = entry.path();
2149             if entry.file_type()?.is_dir() {
2150                 self.aggressive_rm_rf(&path)?;
2151             } else {
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)
2159                     } else {
2160                         Err(e)
2161                     }
2162                 })?;
2163             }
2164         }
2165         fs::remove_dir(path)
2166     }
2167
2168     fn run_ui_test(&self) {
2169         let proc_res = self.compile_test();
2170
2171         let expected_stderr_path = self.expected_output_path("stderr");
2172         let expected_stderr = self.load_expected_output(&expected_stderr_path);
2173
2174         let expected_stdout_path = self.expected_output_path("stdout");
2175         let expected_stdout = self.load_expected_output(&expected_stdout_path);
2176
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);
2181
2182         let mut errors = 0;
2183         errors += self.compare_output("stdout", &normalized_stdout, &expected_stdout);
2184         errors += self.compare_output("stderr", &normalized_stderr, &expected_stderr);
2185
2186         if errors > 0 {
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),
2196                                 &proc_res);
2197         }
2198
2199         if self.props.run_pass {
2200             let proc_res = self.exec_compiled_test();
2201
2202             if !proc_res.status.success() {
2203                 self.fatal_proc_rec("test run failed!", &proc_res);
2204             }
2205         }
2206     }
2207
2208     fn run_mir_opt_test(&self) {
2209         let proc_res = self.compile_test();
2210
2211         if !proc_res.status.success() {
2212             self.fatal_proc_rec("compilation failed!", &proc_res);
2213         }
2214
2215         let proc_res = self.exec_compiled_test();
2216
2217         if !proc_res.status.success() {
2218             self.fatal_proc_rec("test run failed!", &proc_res);
2219         }
2220         self.check_mir_dump();
2221     }
2222
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)
2227                                                    .unwrap();
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");
2242                     }
2243                     self.compare_mir_test_output(curr_test.unwrap(), &curr_test_contents);
2244                     curr_test = None;
2245                     curr_test_contents.clear();
2246                     curr_test_contents.push(ExpectedLine::Elision);
2247                 } else if l.is_empty() {
2248                     // ignore
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));
2254                 }
2255             }
2256         }
2257     }
2258
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);
2268         }
2269     }
2270
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);
2278
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 {
2285                 !l.is_empty()
2286             } else {
2287                 true
2288             }
2289         }).peekable();
2290
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);
2296             e_norm == d_norm
2297         };
2298
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<_>>()
2304                                              .join("\n");
2305             let f = |l: &ExpectedLine<_>| match l {
2306                 &ExpectedLine::Elision => "... (elided)".into(),
2307                 &ExpectedLine::Text(t) => t
2308             };
2309             let expected_content = expected_content.iter()
2310                                                    .map(|l| f(l))
2311                                                    .collect::<Vec<_>>()
2312                                                    .join("\n");
2313             panic!("Did not find expected line, error: {}\n\
2314                    Actual Line: {:?}\n\
2315                    Expected:\n{}\n\
2316                    Actual:\n{}",
2317                    extra_msg,
2318                    expected_line,
2319                    expected_content,
2320                    normalize_all);
2321         };
2322
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));
2331                     },
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();
2336                     }
2337                     if let Some(&ExpectedLine::Text(expected_line)) = expected_lines.next() {
2338                         let mut found = compare(expected_line, dumped_line);
2339                         if found {
2340                             continue;
2341                         }
2342                         while let Some(dumped_line) = dumped_lines.next() {
2343                             found = compare(expected_line, dumped_line);
2344                             if found {
2345                                 break;
2346                             }
2347                         }
2348                         if !found {
2349                             error(expected_line, "ran out of mir dump to match against".into());
2350                         }
2351                     }
2352                 },
2353                 None => {},
2354             }
2355         }
2356     }
2357
2358     fn get_mir_dump_dir(&self) -> PathBuf {
2359         let mut mir_dump_dir = PathBuf::from(self.config.build_base
2360                                                     .as_path()
2361                                                     .to_str()
2362                                                     .unwrap());
2363         debug!("input_file: {:?}", self.testpaths.file);
2364         mir_dump_dir.push(self.testpaths.file.file_stem().unwrap().to_str().unwrap());
2365         mir_dump_dir
2366     }
2367
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);
2377         }
2378         normalized
2379     }
2380
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(),
2385         };
2386         self.testpaths.file.with_extension(extension)
2387     }
2388
2389     fn load_expected_output(&self, path: &Path) -> String {
2390         if !path.exists() {
2391             return String::new();
2392         }
2393
2394         let mut result = String::new();
2395         match File::open(path).and_then(|mut f| f.read_to_string(&mut result)) {
2396             Ok(_) => result,
2397             Err(e) => {
2398                 self.fatal(&format!("failed to load expected output from `{}`: {}",
2399                                     path.display(), e))
2400             }
2401         }
2402     }
2403
2404     fn compare_output(&self, kind: &str, actual: &str, expected: &str) -> usize {
2405         if actual == expected {
2406             return 0;
2407         }
2408
2409         println!("normalized {}:\n{}\n", kind, actual);
2410         println!("expected {}:\n{}\n", kind, expected);
2411         println!("diff of {}:\n", kind);
2412
2413         for diff in diff::lines(expected, actual) {
2414             match diff {
2415                 diff::Result::Left(l)    => println!("-{}", l),
2416                 diff::Result::Both(l, _) => println!(" {}", l),
2417                 diff::Result::Right(r)   => println!("+{}", r),
2418             }
2419         }
2420
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())) {
2423             Ok(()) => { }
2424             Err(e) => {
2425                 self.fatal(&format!("failed to write {} to `{}`: {}",
2426                                     kind, output_file.display(), e))
2427             }
2428         }
2429
2430         println!("\nThe actual {0} differed from the expected {0}.", kind);
2431         println!("Actual {} saved to {}", kind, output_file.display());
2432         1
2433     }
2434 }
2435
2436 struct ProcArgs {
2437     prog: String,
2438     args: Vec<String>,
2439 }
2440
2441 pub struct ProcRes {
2442     status: ExitStatus,
2443     stdout: String,
2444     stderr: String,
2445     cmdline: String,
2446 }
2447
2448 impl ProcRes {
2449     pub fn fatal(&self, err: Option<&str>) -> ! {
2450         if let Some(e) = err {
2451             println!("\nerror: {}", e);
2452         }
2453         print!("\
2454             status: {}\n\
2455             command: {}\n\
2456             stdout:\n\
2457             ------------------------------------------\n\
2458             {}\n\
2459             ------------------------------------------\n\
2460             stderr:\n\
2461             ------------------------------------------\n\
2462             {}\n\
2463             ------------------------------------------\n\
2464             \n",
2465                self.status, self.cmdline, self.stdout,
2466                self.stderr);
2467         panic!();
2468     }
2469 }
2470
2471 enum TargetLocation {
2472     ThisFile(PathBuf),
2473     ThisDirectory(PathBuf),
2474 }
2475
2476 #[derive(Clone, PartialEq, Eq)]
2477 enum ExpectedLine<T: AsRef<str>> {
2478     Elision,
2479     Text(T)
2480 }
2481
2482 impl<T> fmt::Debug for ExpectedLine<T>
2483 where
2484     T: AsRef<str> + fmt::Debug
2485 {
2486     fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
2487         if let &ExpectedLine::Text(ref t) = self {
2488             write!(formatter, "{:?}", t)
2489         } else {
2490             write!(formatter, "\"...\" (Elision)")
2491         }
2492     }
2493 }
2494
2495 fn normalize_mir_line(line: &str) -> String {
2496     nocomment_mir_line(line).replace(char::is_whitespace, "")
2497 }
2498
2499 fn nocomment_mir_line(line: &str) -> &str {
2500     if let Some(idx) = line.find("//") {
2501         let (l, _) = line.split_at(idx);
2502         l.trim_right()
2503     } else {
2504         line
2505     }
2506 }