src/bootstrap/test.rs

   1 // Copyright 2016 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 //! Implementation of the test-related targets of the build system.
  12 //!
  13 //! This file implements the various regression test suites that we execute on
  14 //! our CI.
  15
  16 use std::env;
  17 use std::ffi::OsString;
  18 use std::fmt;
  19 use std::fs::{self, File};
  20 use std::io::Read;
  21 use std::iter;
  22 use std::path::{Path, PathBuf};
  23 use std::process::Command;
  24
  25 use build_helper::{self, output};
  26
  27 use builder::{Builder, Compiler, Kind, RunConfig, ShouldRun, Step};
  28 use cache::{Interned, INTERNER};
  29 use compile;
  30 use dist;
  31 use flags::Subcommand;
  32 use native;
  33 use tool::{self, Tool, SourceType};
  34 use toolstate::ToolState;
  35 use util::{self, dylib_path, dylib_path_var};
  36 use Crate as CargoCrate;
  37 use {DocTests, Mode, GitRepo};
  38
  39 const ADB_TEST_DIR: &str = "/data/tmp/work";
  40
  41 /// The two modes of the test runner; tests or benchmarks.
  42 #[derive(Debug, PartialEq, Eq, Hash, Copy, Clone, PartialOrd, Ord)]
  43 pub enum TestKind {
  44     /// Run `cargo test`
  45     Test,
  46     /// Run `cargo bench`
  47     Bench,
  48 }
  49
  50 impl From<Kind> for TestKind {
  51     fn from(kind: Kind) -> Self {
  52         match kind {
  53             Kind::Test => TestKind::Test,
  54             Kind::Bench => TestKind::Bench,
  55             _ => panic!("unexpected kind in crate: {:?}", kind),
  56         }
  57     }
  58 }
  59
  60 impl TestKind {
  61     // Return the cargo subcommand for this test kind
  62     fn subcommand(self) -> &'static str {
  63         match self {
  64             TestKind::Test => "test",
  65             TestKind::Bench => "bench",
  66         }
  67     }
  68 }
  69
  70 impl fmt::Display for TestKind {
  71     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
  72         f.write_str(match *self {
  73             TestKind::Test => "Testing",
  74             TestKind::Bench => "Benchmarking",
  75         })
  76     }
  77 }
  78
  79 fn try_run(builder: &Builder, cmd: &mut Command) -> bool {
  80     if !builder.fail_fast {
  81         if !builder.try_run(cmd) {
  82             let mut failures = builder.delayed_failures.borrow_mut();
  83             failures.push(format!("{:?}", cmd));
  84             return false;
  85         }
  86     } else {
  87         builder.run(cmd);
  88     }
  89     true
  90 }
  91
  92 fn try_run_quiet(builder: &Builder, cmd: &mut Command) -> bool {
  93     if !builder.fail_fast {
  94         if !builder.try_run_quiet(cmd) {
  95             let mut failures = builder.delayed_failures.borrow_mut();
  96             failures.push(format!("{:?}", cmd));
  97             return false;
  98         }
  99     } else {
 100         builder.run_quiet(cmd);
 101     }
 102     true
 103 }
 104
 105 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 106 pub struct Linkcheck {
 107     host: Interned<String>,
 108 }
 109
 110 impl Step for Linkcheck {
 111     type Output = ();
 112     const ONLY_HOSTS: bool = true;
 113     const DEFAULT: bool = true;
 114
 115     /// Runs the `linkchecker` tool as compiled in `stage` by the `host` compiler.
 116     ///
 117     /// This tool in `src/tools` will verify the validity of all our links in the
 118     /// documentation to ensure we don't have a bunch of dead ones.
 119     fn run(self, builder: &Builder) {
 120         let host = self.host;
 121
 122         builder.info(&format!("Linkcheck ({})", host));
 123
 124         builder.default_doc(None);
 125
 126         let _time = util::timeit(&builder);
 127         try_run(
 128             builder,
 129             builder
 130                 .tool_cmd(Tool::Linkchecker)
 131                 .arg(builder.out.join(host).join("doc")),
 132         );
 133     }
 134
 135     fn should_run(run: ShouldRun) -> ShouldRun {
 136         let builder = run.builder;
 137         run.path("src/tools/linkchecker")
 138             .default_condition(builder.config.docs)
 139     }
 140
 141     fn make_run(run: RunConfig) {
 142         run.builder.ensure(Linkcheck { host: run.target });
 143     }
 144 }
 145
 146 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 147 pub struct Cargotest {
 148     stage: u32,
 149     host: Interned<String>,
 150 }
 151
 152 impl Step for Cargotest {
 153     type Output = ();
 154     const ONLY_HOSTS: bool = true;
 155
 156     fn should_run(run: ShouldRun) -> ShouldRun {
 157         run.path("src/tools/cargotest")
 158     }
 159
 160     fn make_run(run: RunConfig) {
 161         run.builder.ensure(Cargotest {
 162             stage: run.builder.top_stage,
 163             host: run.target,
 164         });
 165     }
 166
 167     /// Runs the `cargotest` tool as compiled in `stage` by the `host` compiler.
 168     ///
 169     /// This tool in `src/tools` will check out a few Rust projects and run `cargo
 170     /// test` to ensure that we don't regress the test suites there.
 171     fn run(self, builder: &Builder) {
 172         let compiler = builder.compiler(self.stage, self.host);
 173         builder.ensure(compile::Rustc {
 174             compiler,
 175             target: compiler.host,
 176         });
 177
 178         // Note that this is a short, cryptic, and not scoped directory name. This
 179         // is currently to minimize the length of path on Windows where we otherwise
 180         // quickly run into path name limit constraints.
 181         let out_dir = builder.out.join("ct");
 182         t!(fs::create_dir_all(&out_dir));
 183
 184         let _time = util::timeit(&builder);
 185         let mut cmd = builder.tool_cmd(Tool::CargoTest);
 186         try_run(
 187             builder,
 188             cmd.arg(&builder.initial_cargo)
 189                 .arg(&out_dir)
 190                 .env("RUSTC", builder.rustc(compiler))
 191                 .env("RUSTDOC", builder.rustdoc(compiler.host)),
 192         );
 193     }
 194 }
 195
 196 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 197 pub struct Cargo {
 198     stage: u32,
 199     host: Interned<String>,
 200 }
 201
 202 impl Step for Cargo {
 203     type Output = ();
 204     const ONLY_HOSTS: bool = true;
 205
 206     fn should_run(run: ShouldRun) -> ShouldRun {
 207         run.path("src/tools/cargo")
 208     }
 209
 210     fn make_run(run: RunConfig) {
 211         run.builder.ensure(Cargo {
 212             stage: run.builder.top_stage,
 213             host: run.target,
 214         });
 215     }
 216
 217     /// Runs `cargo test` for `cargo` packaged with Rust.
 218     fn run(self, builder: &Builder) {
 219         let compiler = builder.compiler(self.stage, self.host);
 220
 221         builder.ensure(tool::Cargo {
 222             compiler,
 223             target: self.host,
 224         });
 225         let mut cargo = tool::prepare_tool_cargo(builder,
 226                                                  compiler,
 227                                                  Mode::ToolRustc,
 228                                                  self.host,
 229                                                  "test",
 230                                                  "src/tools/cargo",
 231                                                  SourceType::Submodule,
 232                                                  &[]);
 233
 234         if !builder.fail_fast {
 235             cargo.arg("--no-fail-fast");
 236         }
 237
 238         // Don't run cross-compile tests, we may not have cross-compiled libstd libs
 239         // available.
 240         cargo.env("CFG_DISABLE_CROSS_TESTS", "1");
 241         // Disable a test that has issues with mingw.
 242         cargo.env("CARGO_TEST_DISABLE_GIT_CLI", "1");
 243
 244         try_run(
 245             builder,
 246             cargo.env("PATH", &path_for_cargo(builder, compiler)),
 247         );
 248     }
 249 }
 250
 251 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 252 pub struct Rls {
 253     stage: u32,
 254     host: Interned<String>,
 255 }
 256
 257 impl Step for Rls {
 258     type Output = ();
 259     const ONLY_HOSTS: bool = true;
 260
 261     fn should_run(run: ShouldRun) -> ShouldRun {
 262         run.path("src/tools/rls")
 263     }
 264
 265     fn make_run(run: RunConfig) {
 266         run.builder.ensure(Rls {
 267             stage: run.builder.top_stage,
 268             host: run.target,
 269         });
 270     }
 271
 272     /// Runs `cargo test` for the rls.
 273     fn run(self, builder: &Builder) {
 274         let stage = self.stage;
 275         let host = self.host;
 276         let compiler = builder.compiler(stage, host);
 277
 278         let build_result = builder.ensure(tool::Rls {
 279             compiler,
 280             target: self.host,
 281             extra_features: Vec::new(),
 282         });
 283         if build_result.is_none() {
 284             eprintln!("failed to test rls: could not build");
 285             return;
 286         }
 287
 288         let mut cargo = tool::prepare_tool_cargo(builder,
 289                                                  compiler,
 290                                                  Mode::ToolRustc,
 291                                                  host,
 292                                                  "test",
 293                                                  "src/tools/rls",
 294                                                  SourceType::Submodule,
 295                                                  &[]);
 296
 297         // Copy `src/tools/rls/test_data` to a writable drive.
 298         let test_workspace_path = builder.out.join("rls-test-data");
 299         let test_data_path = test_workspace_path.join("test_data");
 300         builder.create_dir(&test_data_path);
 301         builder.cp_r(&builder.src.join("src/tools/rls/test_data"), &test_data_path);
 302         cargo.env("RLS_TEST_WORKSPACE_DIR", test_workspace_path);
 303
 304         builder.add_rustc_lib_path(compiler, &mut cargo);
 305         cargo.arg("--")
 306             .args(builder.config.cmd.test_args());
 307
 308         if try_run(builder, &mut cargo) {
 309             builder.save_toolstate("rls", ToolState::TestPass);
 310         }
 311     }
 312 }
 313
 314 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 315 pub struct Rustfmt {
 316     stage: u32,
 317     host: Interned<String>,
 318 }
 319
 320 impl Step for Rustfmt {
 321     type Output = ();
 322     const ONLY_HOSTS: bool = true;
 323
 324     fn should_run(run: ShouldRun) -> ShouldRun {
 325         run.path("src/tools/rustfmt")
 326     }
 327
 328     fn make_run(run: RunConfig) {
 329         run.builder.ensure(Rustfmt {
 330             stage: run.builder.top_stage,
 331             host: run.target,
 332         });
 333     }
 334
 335     /// Runs `cargo test` for rustfmt.
 336     fn run(self, builder: &Builder) {
 337         let stage = self.stage;
 338         let host = self.host;
 339         let compiler = builder.compiler(stage, host);
 340
 341         let build_result = builder.ensure(tool::Rustfmt {
 342             compiler,
 343             target: self.host,
 344             extra_features: Vec::new(),
 345         });
 346         if build_result.is_none() {
 347             eprintln!("failed to test rustfmt: could not build");
 348             return;
 349         }
 350
 351         let mut cargo = tool::prepare_tool_cargo(builder,
 352                                                  compiler,
 353                                                  Mode::ToolRustc,
 354                                                  host,
 355                                                  "test",
 356                                                  "src/tools/rustfmt",
 357                                                  SourceType::Submodule,
 358                                                  &[]);
 359
 360         let dir = testdir(builder, compiler.host);
 361         t!(fs::create_dir_all(&dir));
 362         cargo.env("RUSTFMT_TEST_DIR", dir);
 363
 364         builder.add_rustc_lib_path(compiler, &mut cargo);
 365
 366         if try_run(builder, &mut cargo) {
 367             builder.save_toolstate("rustfmt", ToolState::TestPass);
 368         }
 369     }
 370 }
 371
 372 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 373 pub struct Miri {
 374     stage: u32,
 375     host: Interned<String>,
 376 }
 377
 378 impl Step for Miri {
 379     type Output = ();
 380     const ONLY_HOSTS: bool = true;
 381     const DEFAULT: bool = true;
 382
 383     fn should_run(run: ShouldRun) -> ShouldRun {
 384         let test_miri = run.builder.config.test_miri;
 385         run.path("src/tools/miri").default_condition(test_miri)
 386     }
 387
 388     fn make_run(run: RunConfig) {
 389         run.builder.ensure(Miri {
 390             stage: run.builder.top_stage,
 391             host: run.target,
 392         });
 393     }
 394
 395     /// Runs `cargo test` for miri.
 396     fn run(self, builder: &Builder) {
 397         let stage = self.stage;
 398         let host = self.host;
 399         let compiler = builder.compiler(stage, host);
 400
 401         let miri = builder.ensure(tool::Miri {
 402             compiler,
 403             target: self.host,
 404             extra_features: Vec::new(),
 405         });
 406         if let Some(miri) = miri {
 407             let mut cargo = tool::prepare_tool_cargo(builder,
 408                                                  compiler,
 409                                                  Mode::ToolRustc,
 410                                                  host,
 411                                                  "test",
 412                                                  "src/tools/miri",
 413                                                  SourceType::Submodule,
 414                                                  &[]);
 415
 416             // miri tests need to know about the stage sysroot
 417             cargo.env("MIRI_SYSROOT", builder.sysroot(compiler));
 418             cargo.env("RUSTC_TEST_SUITE", builder.rustc(compiler));
 419             cargo.env("RUSTC_LIB_PATH", builder.rustc_libdir(compiler));
 420             cargo.env("MIRI_PATH", miri);
 421
 422             builder.add_rustc_lib_path(compiler, &mut cargo);
 423
 424             if try_run(builder, &mut cargo) {
 425                 builder.save_toolstate("miri", ToolState::TestPass);
 426             }
 427         } else {
 428             eprintln!("failed to test miri: could not build");
 429         }
 430     }
 431 }
 432
 433 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 434 pub struct Clippy {
 435     stage: u32,
 436     host: Interned<String>,
 437 }
 438
 439 impl Step for Clippy {
 440     type Output = ();
 441     const ONLY_HOSTS: bool = true;
 442     const DEFAULT: bool = false;
 443
 444     fn should_run(run: ShouldRun) -> ShouldRun {
 445         run.path("src/tools/clippy")
 446     }
 447
 448     fn make_run(run: RunConfig) {
 449         run.builder.ensure(Clippy {
 450             stage: run.builder.top_stage,
 451             host: run.target,
 452         });
 453     }
 454
 455     /// Runs `cargo test` for clippy.
 456     fn run(self, builder: &Builder) {
 457         let stage = self.stage;
 458         let host = self.host;
 459         let compiler = builder.compiler(stage, host);
 460
 461         let clippy = builder.ensure(tool::Clippy {
 462             compiler,
 463             target: self.host,
 464             extra_features: Vec::new(),
 465         });
 466         if let Some(clippy) = clippy {
 467             let mut cargo = tool::prepare_tool_cargo(builder,
 468                                                  compiler,
 469                                                  Mode::ToolRustc,
 470                                                  host,
 471                                                  "test",
 472                                                  "src/tools/clippy",
 473                                                  SourceType::Submodule,
 474                                                  &[]);
 475
 476             // clippy tests need to know about the stage sysroot
 477             cargo.env("SYSROOT", builder.sysroot(compiler));
 478             cargo.env("RUSTC_TEST_SUITE", builder.rustc(compiler));
 479             cargo.env("RUSTC_LIB_PATH", builder.rustc_libdir(compiler));
 480             let host_libs = builder
 481                 .stage_out(compiler, Mode::ToolRustc)
 482                 .join(builder.cargo_dir());
 483             cargo.env("HOST_LIBS", host_libs);
 484             // clippy tests need to find the driver
 485             cargo.env("CLIPPY_DRIVER_PATH", clippy);
 486
 487             builder.add_rustc_lib_path(compiler, &mut cargo);
 488
 489             if try_run(builder, &mut cargo) {
 490                 builder.save_toolstate("clippy-driver", ToolState::TestPass);
 491             }
 492         } else {
 493             eprintln!("failed to test clippy: could not build");
 494         }
 495     }
 496 }
 497
 498 fn path_for_cargo(builder: &Builder, compiler: Compiler) -> OsString {
 499     // Configure PATH to find the right rustc. NB. we have to use PATH
 500     // and not RUSTC because the Cargo test suite has tests that will
 501     // fail if rustc is not spelled `rustc`.
 502     let path = builder.sysroot(compiler).join("bin");
 503     let old_path = env::var_os("PATH").unwrap_or_default();
 504     env::join_paths(iter::once(path).chain(env::split_paths(&old_path))).expect("")
 505 }
 506
 507 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
 508 pub struct RustdocTheme {
 509     pub compiler: Compiler,
 510 }
 511
 512 impl Step for RustdocTheme {
 513     type Output = ();
 514     const DEFAULT: bool = true;
 515     const ONLY_HOSTS: bool = true;
 516
 517     fn should_run(run: ShouldRun) -> ShouldRun {
 518         run.path("src/tools/rustdoc-themes")
 519     }
 520
 521     fn make_run(run: RunConfig) {
 522         let compiler = run.builder.compiler(run.builder.top_stage, run.host);
 523
 524         run.builder.ensure(RustdocTheme { compiler });
 525     }
 526
 527     fn run(self, builder: &Builder) {
 528         let rustdoc = builder.out.join("bootstrap/debug/rustdoc");
 529         let mut cmd = builder.tool_cmd(Tool::RustdocTheme);
 530         cmd.arg(rustdoc.to_str().unwrap())
 531             .arg(
 532                 builder
 533                     .src
 534                     .join("src/librustdoc/html/static/themes")
 535                     .to_str()
 536                     .unwrap(),
 537             )
 538             .env("RUSTC_STAGE", self.compiler.stage.to_string())
 539             .env("RUSTC_SYSROOT", builder.sysroot(self.compiler))
 540             .env(
 541                 "RUSTDOC_LIBDIR",
 542                 builder.sysroot_libdir(self.compiler, self.compiler.host),
 543             )
 544             .env("CFG_RELEASE_CHANNEL", &builder.config.channel)
 545             .env("RUSTDOC_REAL", builder.rustdoc(self.compiler.host))
 546             .env("RUSTDOC_CRATE_VERSION", builder.rust_version())
 547             .env("RUSTC_BOOTSTRAP", "1");
 548         if let Some(linker) = builder.linker(self.compiler.host) {
 549             cmd.env("RUSTC_TARGET_LINKER", linker);
 550         }
 551         try_run(builder, &mut cmd);
 552     }
 553 }
 554
 555 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
 556 pub struct RustdocJS {
 557     pub host: Interned<String>,
 558     pub target: Interned<String>,
 559 }
 560
 561 impl Step for RustdocJS {
 562     type Output = ();
 563     const DEFAULT: bool = true;
 564     const ONLY_HOSTS: bool = true;
 565
 566     fn should_run(run: ShouldRun) -> ShouldRun {
 567         run.path("src/test/rustdoc-js")
 568     }
 569
 570     fn make_run(run: RunConfig) {
 571         run.builder.ensure(RustdocJS {
 572             host: run.host,
 573             target: run.target,
 574         });
 575     }
 576
 577     fn run(self, builder: &Builder) {
 578         if let Some(ref nodejs) = builder.config.nodejs {
 579             let mut command = Command::new(nodejs);
 580             command.args(&["src/tools/rustdoc-js/tester.js", &*self.host]);
 581             builder.ensure(::doc::Std {
 582                 target: self.target,
 583                 stage: builder.top_stage,
 584             });
 585             builder.run(&mut command);
 586         } else {
 587             builder.info(
 588                 "No nodejs found, skipping \"src/test/rustdoc-js\" tests"
 589             );
 590         }
 591     }
 592 }
 593
 594 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
 595 pub struct RustdocUi {
 596     pub host: Interned<String>,
 597     pub target: Interned<String>,
 598     pub compiler: Compiler,
 599 }
 600
 601 impl Step for RustdocUi {
 602     type Output = ();
 603     const DEFAULT: bool = true;
 604     const ONLY_HOSTS: bool = true;
 605
 606     fn should_run(run: ShouldRun) -> ShouldRun {
 607         run.path("src/test/rustdoc-ui")
 608     }
 609
 610     fn make_run(run: RunConfig) {
 611         let compiler = run.builder.compiler(run.builder.top_stage, run.host);
 612         run.builder.ensure(RustdocUi {
 613             host: run.host,
 614             target: run.target,
 615             compiler,
 616         });
 617     }
 618
 619     fn run(self, builder: &Builder) {
 620         builder.ensure(Compiletest {
 621             compiler: self.compiler,
 622             target: self.target,
 623             mode: "ui",
 624             suite: "rustdoc-ui",
 625             path: None,
 626             compare_mode: None,
 627         })
 628     }
 629 }
 630
 631 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 632 pub struct Tidy;
 633
 634 impl Step for Tidy {
 635     type Output = ();
 636     const DEFAULT: bool = true;
 637     const ONLY_HOSTS: bool = true;
 638
 639     /// Runs the `tidy` tool.
 640     ///
 641     /// This tool in `src/tools` checks up on various bits and pieces of style and
 642     /// otherwise just implements a few lint-like checks that are specific to the
 643     /// compiler itself.
 644     fn run(self, builder: &Builder) {
 645         let mut cmd = builder.tool_cmd(Tool::Tidy);
 646         cmd.arg(builder.src.join("src"));
 647         cmd.arg(&builder.initial_cargo);
 648         if !builder.config.vendor {
 649             cmd.arg("--no-vendor");
 650         }
 651         if !builder.config.verbose_tests {
 652             cmd.arg("--quiet");
 653         }
 654
 655         let _folder = builder.fold_output(|| "tidy");
 656         builder.info("tidy check");
 657         try_run(builder, &mut cmd);
 658     }
 659
 660     fn should_run(run: ShouldRun) -> ShouldRun {
 661         run.path("src/tools/tidy")
 662     }
 663
 664     fn make_run(run: RunConfig) {
 665         run.builder.ensure(Tidy);
 666     }
 667 }
 668
 669 fn testdir(builder: &Builder, host: Interned<String>) -> PathBuf {
 670     builder.out.join(host).join("test")
 671 }
 672
 673 macro_rules! default_test {
 674     ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr }) => {
 675         test!($name { path: $path, mode: $mode, suite: $suite, default: true, host: false });
 676     }
 677 }
 678
 679 macro_rules! default_test_with_compare_mode {
 680     ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr,
 681                    compare_mode: $compare_mode:expr }) => {
 682         test_with_compare_mode!($name { path: $path, mode: $mode, suite: $suite, default: true,
 683                                         host: false, compare_mode: $compare_mode });
 684     }
 685 }
 686
 687 macro_rules! host_test {
 688     ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr }) => {
 689         test!($name { path: $path, mode: $mode, suite: $suite, default: true, host: true });
 690     }
 691 }
 692
 693 macro_rules! test {
 694     ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr, default: $default:expr,
 695                    host: $host:expr }) => {
 696         test_definitions!($name { path: $path, mode: $mode, suite: $suite, default: $default,
 697                                   host: $host, compare_mode: None });
 698     }
 699 }
 700
 701 macro_rules! test_with_compare_mode {
 702     ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr, default: $default:expr,
 703                    host: $host:expr, compare_mode: $compare_mode:expr }) => {
 704         test_definitions!($name { path: $path, mode: $mode, suite: $suite, default: $default,
 705                                   host: $host, compare_mode: Some($compare_mode) });
 706     }
 707 }
 708
 709 macro_rules! test_definitions {
 710     ($name:ident {
 711         path: $path:expr,
 712         mode: $mode:expr,
 713         suite: $suite:expr,
 714         default: $default:expr,
 715         host: $host:expr,
 716         compare_mode: $compare_mode:expr
 717     }) => {
 718         #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 719         pub struct $name {
 720             pub compiler: Compiler,
 721             pub target: Interned<String>,
 722         }
 723
 724         impl Step for $name {
 725             type Output = ();
 726             const DEFAULT: bool = $default;
 727             const ONLY_HOSTS: bool = $host;
 728
 729             fn should_run(run: ShouldRun) -> ShouldRun {
 730                 run.suite_path($path)
 731             }
 732
 733             fn make_run(run: RunConfig) {
 734                 let compiler = run.builder.compiler(run.builder.top_stage, run.host);
 735
 736                 run.builder.ensure($name {
 737                     compiler,
 738                     target: run.target,
 739                 });
 740             }
 741
 742             fn run(self, builder: &Builder) {
 743                 builder.ensure(Compiletest {
 744                     compiler: self.compiler,
 745                     target: self.target,
 746                     mode: $mode,
 747                     suite: $suite,
 748                     path: Some($path),
 749                     compare_mode: $compare_mode,
 750                 })
 751             }
 752         }
 753     }
 754 }
 755
 756 default_test_with_compare_mode!(Ui {
 757     path: "src/test/ui",
 758     mode: "ui",
 759     suite: "ui",
 760     compare_mode: "nll"
 761 });
 762
 763 default_test_with_compare_mode!(RunPass {
 764     path: "src/test/run-pass",
 765     mode: "run-pass",
 766     suite: "run-pass",
 767     compare_mode: "nll"
 768 });
 769
 770 default_test!(CompileFail {
 771     path: "src/test/compile-fail",
 772     mode: "compile-fail",
 773     suite: "compile-fail"
 774 });
 775
 776 default_test!(RunFail {
 777     path: "src/test/run-fail",
 778     mode: "run-fail",
 779     suite: "run-fail"
 780 });
 781
 782 default_test!(RunPassValgrind {
 783     path: "src/test/run-pass-valgrind",
 784     mode: "run-pass-valgrind",
 785     suite: "run-pass-valgrind"
 786 });
 787
 788 default_test!(MirOpt {
 789     path: "src/test/mir-opt",
 790     mode: "mir-opt",
 791     suite: "mir-opt"
 792 });
 793
 794 default_test!(Codegen {
 795     path: "src/test/codegen",
 796     mode: "codegen",
 797     suite: "codegen"
 798 });
 799
 800 default_test!(CodegenUnits {
 801     path: "src/test/codegen-units",
 802     mode: "codegen-units",
 803     suite: "codegen-units"
 804 });
 805
 806 default_test!(Incremental {
 807     path: "src/test/incremental",
 808     mode: "incremental",
 809     suite: "incremental"
 810 });
 811
 812 default_test!(Debuginfo {
 813     path: "src/test/debuginfo",
 814     mode: "debuginfo",
 815     suite: "debuginfo"
 816 });
 817
 818 host_test!(UiFullDeps {
 819     path: "src/test/ui-fulldeps",
 820     mode: "ui",
 821     suite: "ui-fulldeps"
 822 });
 823
 824 host_test!(RunPassFullDeps {
 825     path: "src/test/run-pass-fulldeps",
 826     mode: "run-pass",
 827     suite: "run-pass-fulldeps"
 828 });
 829
 830 host_test!(RunFailFullDeps {
 831     path: "src/test/run-fail-fulldeps",
 832     mode: "run-fail",
 833     suite: "run-fail-fulldeps"
 834 });
 835
 836 host_test!(CompileFailFullDeps {
 837     path: "src/test/compile-fail-fulldeps",
 838     mode: "compile-fail",
 839     suite: "compile-fail-fulldeps"
 840 });
 841
 842 host_test!(Rustdoc {
 843     path: "src/test/rustdoc",
 844     mode: "rustdoc",
 845     suite: "rustdoc"
 846 });
 847
 848 test!(Pretty {
 849     path: "src/test/pretty",
 850     mode: "pretty",
 851     suite: "pretty",
 852     default: false,
 853     host: true
 854 });
 855 test!(RunPassPretty {
 856     path: "src/test/run-pass/pretty",
 857     mode: "pretty",
 858     suite: "run-pass",
 859     default: false,
 860     host: true
 861 });
 862 test!(RunFailPretty {
 863     path: "src/test/run-fail/pretty",
 864     mode: "pretty",
 865     suite: "run-fail",
 866     default: false,
 867     host: true
 868 });
 869 test!(RunPassValgrindPretty {
 870     path: "src/test/run-pass-valgrind/pretty",
 871     mode: "pretty",
 872     suite: "run-pass-valgrind",
 873     default: false,
 874     host: true
 875 });
 876 test!(RunPassFullDepsPretty {
 877     path: "src/test/run-pass-fulldeps/pretty",
 878     mode: "pretty",
 879     suite: "run-pass-fulldeps",
 880     default: false,
 881     host: true
 882 });
 883 test!(RunFailFullDepsPretty {
 884     path: "src/test/run-fail-fulldeps/pretty",
 885     mode: "pretty",
 886     suite: "run-fail-fulldeps",
 887     default: false,
 888     host: true
 889 });
 890
 891 default_test!(RunMake {
 892     path: "src/test/run-make",
 893     mode: "run-make",
 894     suite: "run-make"
 895 });
 896
 897 host_test!(RunMakeFullDeps {
 898     path: "src/test/run-make-fulldeps",
 899     mode: "run-make",
 900     suite: "run-make-fulldeps"
 901 });
 902
 903 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 904 struct Compiletest {
 905     compiler: Compiler,
 906     target: Interned<String>,
 907     mode: &'static str,
 908     suite: &'static str,
 909     path: Option<&'static str>,
 910     compare_mode: Option<&'static str>,
 911 }
 912
 913 impl Step for Compiletest {
 914     type Output = ();
 915
 916     fn should_run(run: ShouldRun) -> ShouldRun {
 917         run.never()
 918     }
 919
 920     /// Executes the `compiletest` tool to run a suite of tests.
 921     ///
 922     /// Compiles all tests with `compiler` for `target` with the specified
 923     /// compiletest `mode` and `suite` arguments. For example `mode` can be
 924     /// "run-pass" or `suite` can be something like `debuginfo`.
 925     fn run(self, builder: &Builder) {
 926         let compiler = self.compiler;
 927         let target = self.target;
 928         let mode = self.mode;
 929         let suite = self.suite;
 930
 931         // Path for test suite
 932         let suite_path = self.path.unwrap_or("");
 933
 934         // Skip codegen tests if they aren't enabled in configuration.
 935         if !builder.config.codegen_tests && suite == "codegen" {
 936             return;
 937         }
 938
 939         if suite == "debuginfo" {
 940             // Skip debuginfo tests on MSVC
 941             if builder.config.build.contains("msvc") {
 942                 return;
 943             }
 944
 945             if mode == "debuginfo" {
 946                 return builder.ensure(Compiletest {
 947                     mode: "debuginfo-both",
 948                     ..self
 949                 });
 950             }
 951
 952             builder.ensure(dist::DebuggerScripts {
 953                 sysroot: builder.sysroot(compiler),
 954                 host: target,
 955             });
 956         }
 957
 958         if suite.ends_with("fulldeps") ||
 959             // FIXME: Does pretty need librustc compiled? Note that there are
 960             // fulldeps test suites with mode = pretty as well.
 961             mode == "pretty"
 962         {
 963             builder.ensure(compile::Rustc { compiler, target });
 964         }
 965
 966         if builder.no_std(target) == Some(true) {
 967             // the `test` doesn't compile for no-std targets
 968             builder.ensure(compile::Std { compiler, target });
 969         } else {
 970             builder.ensure(compile::Test { compiler, target });
 971         }
 972
 973         if builder.no_std(target) == Some(true) {
 974             // for no_std run-make (e.g. thumb*),
 975             // we need a host compiler which is called by cargo.
 976             builder.ensure(compile::Std { compiler, target: compiler.host });
 977         }
 978
 979         // HACK(eddyb) ensure that `libproc_macro` is available on the host.
 980         builder.ensure(compile::Test { compiler, target: compiler.host });
 981         // Also provide `rust_test_helpers` for the host.
 982         builder.ensure(native::TestHelpers { target: compiler.host });
 983
 984         builder.ensure(native::TestHelpers { target });
 985         builder.ensure(RemoteCopyLibs { compiler, target });
 986
 987         let mut cmd = builder.tool_cmd(Tool::Compiletest);
 988
 989         // compiletest currently has... a lot of arguments, so let's just pass all
 990         // of them!
 991
 992         cmd.arg("--compile-lib-path")
 993             .arg(builder.rustc_libdir(compiler));
 994         cmd.arg("--run-lib-path")
 995             .arg(builder.sysroot_libdir(compiler, target));
 996         cmd.arg("--rustc-path").arg(builder.rustc(compiler));
 997
 998         let is_rustdoc_ui = suite.ends_with("rustdoc-ui");
 999
1000         // Avoid depending on rustdoc when we don't need it.
1001         if mode == "rustdoc"
1002             || (mode == "run-make" && suite.ends_with("fulldeps"))
1003             || (mode == "ui" && is_rustdoc_ui)
1004         {
1005             cmd.arg("--rustdoc-path")
1006                 .arg(builder.rustdoc(compiler.host));
1007         }
1008
1009         cmd.arg("--src-base")
1010             .arg(builder.src.join("src/test").join(suite));
1011         cmd.arg("--build-base")
1012             .arg(testdir(builder, compiler.host).join(suite));
1013         cmd.arg("--stage-id")
1014             .arg(format!("stage{}-{}", compiler.stage, target));
1015         cmd.arg("--mode").arg(mode);
1016         cmd.arg("--target").arg(target);
1017         cmd.arg("--host").arg(&*compiler.host);
1018         cmd.arg("--llvm-filecheck")
1019             .arg(builder.llvm_filecheck(builder.config.build));
1020
1021         if builder.config.cmd.bless() {
1022             cmd.arg("--bless");
1023         }
1024
1025         let compare_mode = builder.config.cmd.compare_mode().or_else(|| {
1026             if builder.config.test_compare_mode {
1027                 self.compare_mode
1028             } else {
1029                 None
1030             }
1031         });
1032
1033         if let Some(ref nodejs) = builder.config.nodejs {
1034             cmd.arg("--nodejs").arg(nodejs);
1035         }
1036
1037         let mut flags = if is_rustdoc_ui {
1038             Vec::new()
1039         } else {
1040             vec!["-Crpath".to_string()]
1041         };
1042         if !is_rustdoc_ui {
1043             if builder.config.rust_optimize_tests {
1044                 flags.push("-O".to_string());
1045             }
1046             if builder.config.rust_debuginfo_tests {
1047                 flags.push("-g".to_string());
1048             }
1049         }
1050         flags.push("-Zunstable-options".to_string());
1051         flags.push(builder.config.cmd.rustc_args().join(" "));
1052
1053         if let Some(linker) = builder.linker(target) {
1054             cmd.arg("--linker").arg(linker);
1055         }
1056
1057         let mut hostflags = flags.clone();
1058         hostflags.push(format!(
1059             "-Lnative={}",
1060             builder.test_helpers_out(compiler.host).display()
1061         ));
1062         cmd.arg("--host-rustcflags").arg(hostflags.join(" "));
1063
1064         let mut targetflags = flags;
1065         targetflags.push(format!(
1066             "-Lnative={}",
1067             builder.test_helpers_out(target).display()
1068         ));
1069         cmd.arg("--target-rustcflags").arg(targetflags.join(" "));
1070
1071         cmd.arg("--docck-python").arg(builder.python());
1072
1073         if builder.config.build.ends_with("apple-darwin") {
1074             // Force /usr/bin/python on macOS for LLDB tests because we're loading the
1075             // LLDB plugin's compiled module which only works with the system python
1076             // (namely not Homebrew-installed python)
1077             cmd.arg("--lldb-python").arg("/usr/bin/python");
1078         } else {
1079             cmd.arg("--lldb-python").arg(builder.python());
1080         }
1081
1082         if let Some(ref gdb) = builder.config.gdb {
1083             cmd.arg("--gdb").arg(gdb);
1084         }
1085
1086         let run = |cmd: &mut Command| {
1087             cmd.output().map(|output| {
1088                 String::from_utf8_lossy(&output.stdout)
1089                     .lines().next().unwrap_or_else(|| {
1090                         panic!("{:?} failed {:?}", cmd, output)
1091                     }).to_string()
1092             })
1093         };
1094         let lldb_exe = if builder.config.lldb_enabled && !target.contains("emscripten") {
1095             // Test against the lldb that was just built.
1096             builder.llvm_out(target)
1097                 .join("bin")
1098                 .join("lldb")
1099         } else {
1100             PathBuf::from("lldb")
1101         };
1102         let lldb_version = Command::new(&lldb_exe)
1103             .arg("--version")
1104             .output()
1105             .map(|output| { String::from_utf8_lossy(&output.stdout).to_string() })
1106             .ok();
1107         if let Some(ref vers) = lldb_version {
1108             cmd.arg("--lldb-version").arg(vers);
1109             let lldb_python_dir = run(Command::new(&lldb_exe).arg("-P")).ok();
1110             if let Some(ref dir) = lldb_python_dir {
1111                 cmd.arg("--lldb-python-dir").arg(dir);
1112             }
1113         }
1114
1115         // Get paths from cmd args
1116         let paths = match &builder.config.cmd {
1117             Subcommand::Test { ref paths, .. } => &paths[..],
1118             _ => &[],
1119         };
1120
1121         // Get test-args by striping suite path
1122         let mut test_args: Vec<&str> = paths
1123             .iter()
1124             .map(|p| {
1125                 match p.strip_prefix(".") {
1126                     Ok(path) => path,
1127                     Err(_) => p,
1128                 }
1129             })
1130             .filter(|p| p.starts_with(suite_path) && p.is_file())
1131             .map(|p| p.strip_prefix(suite_path).unwrap().to_str().unwrap())
1132             .collect();
1133
1134         test_args.append(&mut builder.config.cmd.test_args());
1135
1136         cmd.args(&test_args);
1137
1138         if builder.is_verbose() {
1139             cmd.arg("--verbose");
1140         }
1141
1142         if !builder.config.verbose_tests {
1143             cmd.arg("--quiet");
1144         }
1145
1146         if builder.config.llvm_enabled {
1147             let llvm_config = builder.ensure(native::Llvm {
1148                 target: builder.config.build,
1149                 emscripten: false,
1150             });
1151             if !builder.config.dry_run {
1152                 let llvm_version = output(Command::new(&llvm_config).arg("--version"));
1153                 cmd.arg("--llvm-version").arg(llvm_version);
1154             }
1155             if !builder.is_rust_llvm(target) {
1156                 cmd.arg("--system-llvm");
1157             }
1158
1159             // Only pass correct values for these flags for the `run-make` suite as it
1160             // requires that a C++ compiler was configured which isn't always the case.
1161             if !builder.config.dry_run && suite == "run-make-fulldeps" {
1162                 let llvm_components = output(Command::new(&llvm_config).arg("--components"));
1163                 let llvm_cxxflags = output(Command::new(&llvm_config).arg("--cxxflags"));
1164                 cmd.arg("--cc")
1165                     .arg(builder.cc(target))
1166                     .arg("--cxx")
1167                     .arg(builder.cxx(target).unwrap())
1168                     .arg("--cflags")
1169                     .arg(builder.cflags(target, GitRepo::Rustc).join(" "))
1170                     .arg("--llvm-components")
1171                     .arg(llvm_components.trim())
1172                     .arg("--llvm-cxxflags")
1173                     .arg(llvm_cxxflags.trim());
1174                 if let Some(ar) = builder.ar(target) {
1175                     cmd.arg("--ar").arg(ar);
1176                 }
1177             }
1178         }
1179         if suite == "run-make-fulldeps" && !builder.config.llvm_enabled {
1180             builder.info(
1181                 "Ignoring run-make test suite as they generally don't work without LLVM"
1182             );
1183             return;
1184         }
1185
1186         if suite != "run-make-fulldeps" {
1187             cmd.arg("--cc")
1188                 .arg("")
1189                 .arg("--cxx")
1190                 .arg("")
1191                 .arg("--cflags")
1192                 .arg("")
1193                 .arg("--llvm-components")
1194                 .arg("")
1195                 .arg("--llvm-cxxflags")
1196                 .arg("");
1197         }
1198
1199         if builder.remote_tested(target) {
1200             cmd.arg("--remote-test-client")
1201                 .arg(builder.tool_exe(Tool::RemoteTestClient));
1202         }
1203
1204         // Running a C compiler on MSVC requires a few env vars to be set, to be
1205         // sure to set them here.
1206         //
1207         // Note that if we encounter `PATH` we make sure to append to our own `PATH`
1208         // rather than stomp over it.
1209         if target.contains("msvc") {
1210             for &(ref k, ref v) in builder.cc[&target].env() {
1211                 if k != "PATH" {
1212                     cmd.env(k, v);
1213                 }
1214             }
1215         }
1216         cmd.env("RUSTC_BOOTSTRAP", "1");
1217         builder.add_rust_test_threads(&mut cmd);
1218
1219         if builder.config.sanitizers {
1220             cmd.env("SANITIZER_SUPPORT", "1");
1221         }
1222
1223         if builder.config.profiler {
1224             cmd.env("PROFILER_SUPPORT", "1");
1225         }
1226
1227         cmd.env("RUST_TEST_TMPDIR", builder.out.join("tmp"));
1228
1229         cmd.arg("--adb-path").arg("adb");
1230         cmd.arg("--adb-test-dir").arg(ADB_TEST_DIR);
1231         if target.contains("android") {
1232             // Assume that cc for this target comes from the android sysroot
1233             cmd.arg("--android-cross-path")
1234                 .arg(builder.cc(target).parent().unwrap().parent().unwrap());
1235         } else {
1236             cmd.arg("--android-cross-path").arg("");
1237         }
1238
1239         builder.ci_env.force_coloring_in_ci(&mut cmd);
1240
1241         let _folder = builder.fold_output(|| format!("test_{}", suite));
1242         builder.info(&format!(
1243             "Check compiletest suite={} mode={} ({} -> {})",
1244             suite, mode, &compiler.host, target
1245         ));
1246         let _time = util::timeit(&builder);
1247         try_run(builder, &mut cmd);
1248
1249         if let Some(compare_mode) = compare_mode {
1250             cmd.arg("--compare-mode").arg(compare_mode);
1251             let _folder = builder.fold_output(|| format!("test_{}_{}", suite, compare_mode));
1252             builder.info(&format!(
1253                 "Check compiletest suite={} mode={} compare_mode={} ({} -> {})",
1254                 suite, mode, compare_mode, &compiler.host, target
1255             ));
1256             let _time = util::timeit(&builder);
1257             try_run(builder, &mut cmd);
1258         }
1259     }
1260 }
1261
1262 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1263 struct DocTest {
1264     compiler: Compiler,
1265     path: &'static str,
1266     name: &'static str,
1267     is_ext_doc: bool,
1268 }
1269
1270 impl Step for DocTest {
1271     type Output = ();
1272     const ONLY_HOSTS: bool = true;
1273
1274     fn should_run(run: ShouldRun) -> ShouldRun {
1275         run.never()
1276     }
1277
1278     /// Run `rustdoc --test` for all documentation in `src/doc`.
1279     ///
1280     /// This will run all tests in our markdown documentation (e.g. the book)
1281     /// located in `src/doc`. The `rustdoc` that's run is the one that sits next to
1282     /// `compiler`.
1283     fn run(self, builder: &Builder) {
1284         let compiler = self.compiler;
1285
1286         builder.ensure(compile::Test {
1287             compiler,
1288             target: compiler.host,
1289         });
1290
1291         // Do a breadth-first traversal of the `src/doc` directory and just run
1292         // tests for all files that end in `*.md`
1293         let mut stack = vec![builder.src.join(self.path)];
1294         let _time = util::timeit(&builder);
1295         let _folder = builder.fold_output(|| format!("test_{}", self.name));
1296
1297         let mut files = Vec::new();
1298         while let Some(p) = stack.pop() {
1299             if p.is_dir() {
1300                 stack.extend(t!(p.read_dir()).map(|p| t!(p).path()));
1301                 continue;
1302             }
1303
1304             if p.extension().and_then(|s| s.to_str()) != Some("md") {
1305                 continue;
1306             }
1307
1308             // The nostarch directory in the book is for no starch, and so isn't
1309             // guaranteed to builder. We don't care if it doesn't build, so skip it.
1310             if p.to_str().map_or(false, |p| p.contains("nostarch")) {
1311                 continue;
1312             }
1313
1314             files.push(p);
1315         }
1316
1317         files.sort();
1318
1319         let mut toolstate = ToolState::TestPass;
1320         for file in files {
1321             if !markdown_test(builder, compiler, &file) {
1322                 toolstate = ToolState::TestFail;
1323             }
1324         }
1325         if self.is_ext_doc {
1326             builder.save_toolstate(self.name, toolstate);
1327         }
1328     }
1329 }
1330
1331 macro_rules! test_book {
1332     ($($name:ident, $path:expr, $book_name:expr, default=$default:expr;)+) => {
1333         $(
1334             #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1335             pub struct $name {
1336                 compiler: Compiler,
1337             }
1338
1339             impl Step for $name {
1340                 type Output = ();
1341                 const DEFAULT: bool = $default;
1342                 const ONLY_HOSTS: bool = true;
1343
1344                 fn should_run(run: ShouldRun) -> ShouldRun {
1345                     run.path($path)
1346                 }
1347
1348                 fn make_run(run: RunConfig) {
1349                     run.builder.ensure($name {
1350                         compiler: run.builder.compiler(run.builder.top_stage, run.host),
1351                     });
1352                 }
1353
1354                 fn run(self, builder: &Builder) {
1355                     builder.ensure(DocTest {
1356                         compiler: self.compiler,
1357                         path: $path,
1358                         name: $book_name,
1359                         is_ext_doc: !$default,
1360                     });
1361                 }
1362             }
1363         )+
1364     }
1365 }
1366
1367 test_book!(
1368     Nomicon, "src/doc/nomicon", "nomicon", default=false;
1369     Reference, "src/doc/reference", "reference", default=false;
1370     RustdocBook, "src/doc/rustdoc", "rustdoc", default=true;
1371     RustcBook, "src/doc/rustc", "rustc", default=true;
1372     RustByExample, "src/doc/rust-by-example", "rust-by-example", default=false;
1373     TheBook, "src/doc/book", "book", default=false;
1374     UnstableBook, "src/doc/unstable-book", "unstable-book", default=true;
1375 );
1376
1377 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1378 pub struct ErrorIndex {
1379     compiler: Compiler,
1380 }
1381
1382 impl Step for ErrorIndex {
1383     type Output = ();
1384     const DEFAULT: bool = true;
1385     const ONLY_HOSTS: bool = true;
1386
1387     fn should_run(run: ShouldRun) -> ShouldRun {
1388         run.path("src/tools/error_index_generator")
1389     }
1390
1391     fn make_run(run: RunConfig) {
1392         run.builder.ensure(ErrorIndex {
1393             compiler: run.builder.compiler(run.builder.top_stage, run.host),
1394         });
1395     }
1396
1397     /// Run the error index generator tool to execute the tests located in the error
1398     /// index.
1399     ///
1400     /// The `error_index_generator` tool lives in `src/tools` and is used to
1401     /// generate a markdown file from the error indexes of the code base which is
1402     /// then passed to `rustdoc --test`.
1403     fn run(self, builder: &Builder) {
1404         let compiler = self.compiler;
1405
1406         builder.ensure(compile::Std {
1407             compiler,
1408             target: compiler.host,
1409         });
1410
1411         let dir = testdir(builder, compiler.host);
1412         t!(fs::create_dir_all(&dir));
1413         let output = dir.join("error-index.md");
1414
1415         let mut tool = builder.tool_cmd(Tool::ErrorIndex);
1416         tool.arg("markdown")
1417             .arg(&output)
1418             .env("CFG_BUILD", &builder.config.build)
1419             .env("RUSTC_ERROR_METADATA_DST", builder.extended_error_dir());
1420
1421         let _folder = builder.fold_output(|| "test_error_index");
1422         builder.info(&format!("Testing error-index stage{}", compiler.stage));
1423         let _time = util::timeit(&builder);
1424         builder.run(&mut tool);
1425         markdown_test(builder, compiler, &output);
1426     }
1427 }
1428
1429 fn markdown_test(builder: &Builder, compiler: Compiler, markdown: &Path) -> bool {
1430     match File::open(markdown) {
1431         Ok(mut file) => {
1432             let mut contents = String::new();
1433             t!(file.read_to_string(&mut contents));
1434             if !contents.contains("```") {
1435                 return true;
1436             }
1437         }
1438         Err(_) => {}
1439     }
1440
1441     builder.info(&format!("doc tests for: {}", markdown.display()));
1442     let mut cmd = builder.rustdoc_cmd(compiler.host);
1443     builder.add_rust_test_threads(&mut cmd);
1444     cmd.arg("--test");
1445     cmd.arg(markdown);
1446     cmd.env("RUSTC_BOOTSTRAP", "1");
1447
1448     let test_args = builder.config.cmd.test_args().join(" ");
1449     cmd.arg("--test-args").arg(test_args);
1450
1451     if builder.config.verbose_tests {
1452         try_run(builder, &mut cmd)
1453     } else {
1454         try_run_quiet(builder, &mut cmd)
1455     }
1456 }
1457
1458 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1459 pub struct CrateLibrustc {
1460     compiler: Compiler,
1461     target: Interned<String>,
1462     test_kind: TestKind,
1463     krate: Interned<String>,
1464 }
1465
1466 impl Step for CrateLibrustc {
1467     type Output = ();
1468     const DEFAULT: bool = true;
1469     const ONLY_HOSTS: bool = true;
1470
1471     fn should_run(run: ShouldRun) -> ShouldRun {
1472         run.krate("rustc-main")
1473     }
1474
1475     fn make_run(run: RunConfig) {
1476         let builder = run.builder;
1477         let compiler = builder.compiler(builder.top_stage, run.host);
1478
1479         for krate in builder.in_tree_crates("rustc-main") {
1480             if run.path.ends_with(&krate.path) {
1481                 let test_kind = builder.kind.into();
1482
1483                 builder.ensure(CrateLibrustc {
1484                     compiler,
1485                     target: run.target,
1486                     test_kind,
1487                     krate: krate.name,
1488                 });
1489             }
1490         }
1491     }
1492
1493     fn run(self, builder: &Builder) {
1494         builder.ensure(Crate {
1495             compiler: self.compiler,
1496             target: self.target,
1497             mode: Mode::Rustc,
1498             test_kind: self.test_kind,
1499             krate: self.krate,
1500         });
1501     }
1502 }
1503
1504 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1505 pub struct CrateNotDefault {
1506     compiler: Compiler,
1507     target: Interned<String>,
1508     test_kind: TestKind,
1509     krate: &'static str,
1510 }
1511
1512 impl Step for CrateNotDefault {
1513     type Output = ();
1514
1515     fn should_run(run: ShouldRun) -> ShouldRun {
1516         run.path("src/librustc_asan")
1517             .path("src/librustc_lsan")
1518             .path("src/librustc_msan")
1519             .path("src/librustc_tsan")
1520     }
1521
1522     fn make_run(run: RunConfig) {
1523         let builder = run.builder;
1524         let compiler = builder.compiler(builder.top_stage, run.host);
1525
1526         let test_kind = builder.kind.into();
1527
1528         builder.ensure(CrateNotDefault {
1529             compiler,
1530             target: run.target,
1531             test_kind,
1532             krate: match run.path {
1533                 _ if run.path.ends_with("src/librustc_asan") => "rustc_asan",
1534                 _ if run.path.ends_with("src/librustc_lsan") => "rustc_lsan",
1535                 _ if run.path.ends_with("src/librustc_msan") => "rustc_msan",
1536                 _ if run.path.ends_with("src/librustc_tsan") => "rustc_tsan",
1537                 _ => panic!("unexpected path {:?}", run.path),
1538             },
1539         });
1540     }
1541
1542     fn run(self, builder: &Builder) {
1543         builder.ensure(Crate {
1544             compiler: self.compiler,
1545             target: self.target,
1546             mode: Mode::Std,
1547             test_kind: self.test_kind,
1548             krate: INTERNER.intern_str(self.krate),
1549         });
1550     }
1551 }
1552
1553 #[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
1554 pub struct Crate {
1555     pub compiler: Compiler,
1556     pub target: Interned<String>,
1557     pub mode: Mode,
1558     pub test_kind: TestKind,
1559     pub krate: Interned<String>,
1560 }
1561
1562 impl Step for Crate {
1563     type Output = ();
1564     const DEFAULT: bool = true;
1565
1566     fn should_run(mut run: ShouldRun) -> ShouldRun {
1567         let builder = run.builder;
1568         run = run.krate("test");
1569         for krate in run.builder.in_tree_crates("std") {
1570             if krate.is_local(&run.builder)
1571                 && !(krate.name.starts_with("rustc_") && krate.name.ends_with("san"))
1572                 && krate.name != "dlmalloc"
1573             {
1574                 run = run.path(krate.local_path(&builder).to_str().unwrap());
1575             }
1576         }
1577         run
1578     }
1579
1580     fn make_run(run: RunConfig) {
1581         let builder = run.builder;
1582         let compiler = builder.compiler(builder.top_stage, run.host);
1583
1584         let make = |mode: Mode, krate: &CargoCrate| {
1585             let test_kind = builder.kind.into();
1586
1587             builder.ensure(Crate {
1588                 compiler,
1589                 target: run.target,
1590                 mode,
1591                 test_kind,
1592                 krate: krate.name,
1593             });
1594         };
1595
1596         for krate in builder.in_tree_crates("std") {
1597             if run.path.ends_with(&krate.local_path(&builder)) {
1598                 make(Mode::Std, krate);
1599             }
1600         }
1601         for krate in builder.in_tree_crates("test") {
1602             if run.path.ends_with(&krate.local_path(&builder)) {
1603                 make(Mode::Test, krate);
1604             }
1605         }
1606     }
1607
1608     /// Run all unit tests plus documentation tests for a given crate defined
1609     /// by a `Cargo.toml` (single manifest)
1610     ///
1611     /// This is what runs tests for crates like the standard library, compiler, etc.
1612     /// It essentially is the driver for running `cargo test`.
1613     ///
1614     /// Currently this runs all tests for a DAG by passing a bunch of `-p foo`
1615     /// arguments, and those arguments are discovered from `cargo metadata`.
1616     fn run(self, builder: &Builder) {
1617         let compiler = self.compiler;
1618         let target = self.target;
1619         let mode = self.mode;
1620         let test_kind = self.test_kind;
1621         let krate = self.krate;
1622
1623         builder.ensure(compile::Test { compiler, target });
1624         builder.ensure(RemoteCopyLibs { compiler, target });
1625
1626         // If we're not doing a full bootstrap but we're testing a stage2 version of
1627         // libstd, then what we're actually testing is the libstd produced in
1628         // stage1. Reflect that here by updating the compiler that we're working
1629         // with automatically.
1630         let compiler = if builder.force_use_stage1(compiler, target) {
1631             builder.compiler(1, compiler.host)
1632         } else {
1633             compiler.clone()
1634         };
1635
1636         let mut cargo = builder.cargo(compiler, mode, target, test_kind.subcommand());
1637         match mode {
1638             Mode::Std => {
1639                 compile::std_cargo(builder, &compiler, target, &mut cargo);
1640             }
1641             Mode::Test => {
1642                 compile::test_cargo(builder, &compiler, target, &mut cargo);
1643             }
1644             Mode::Rustc => {
1645                 builder.ensure(compile::Rustc { compiler, target });
1646                 compile::rustc_cargo(builder, &mut cargo);
1647             }
1648             _ => panic!("can only test libraries"),
1649         };
1650
1651         // Build up the base `cargo test` command.
1652         //
1653         // Pass in some standard flags then iterate over the graph we've discovered
1654         // in `cargo metadata` with the maps above and figure out what `-p`
1655         // arguments need to get passed.
1656         if test_kind.subcommand() == "test" && !builder.fail_fast {
1657             cargo.arg("--no-fail-fast");
1658         }
1659         match builder.doc_tests {
1660             DocTests::Only => {
1661                 cargo.arg("--doc");
1662             }
1663             DocTests::No => {
1664                 cargo.args(&["--lib", "--bins", "--examples", "--tests", "--benches"]);
1665             }
1666             DocTests::Yes => {}
1667         }
1668
1669         cargo.arg("-p").arg(krate);
1670
1671         // The tests are going to run with the *target* libraries, so we need to
1672         // ensure that those libraries show up in the LD_LIBRARY_PATH equivalent.
1673         //
1674         // Note that to run the compiler we need to run with the *host* libraries,
1675         // but our wrapper scripts arrange for that to be the case anyway.
1676         let mut dylib_path = dylib_path();
1677         dylib_path.insert(0, PathBuf::from(&*builder.sysroot_libdir(compiler, target)));
1678         cargo.env(dylib_path_var(), env::join_paths(&dylib_path).unwrap());
1679
1680         cargo.arg("--");
1681         cargo.args(&builder.config.cmd.test_args());
1682
1683         if !builder.config.verbose_tests {
1684             cargo.arg("--quiet");
1685         }
1686
1687         if target.contains("emscripten") {
1688             cargo.env(
1689                 format!("CARGO_TARGET_{}_RUNNER", envify(&target)),
1690                 builder
1691                     .config
1692                     .nodejs
1693                     .as_ref()
1694                     .expect("nodejs not configured"),
1695             );
1696         } else if target.starts_with("wasm32") {
1697             // Warn about running tests without the `wasm_syscall` feature enabled.
1698             // The javascript shim implements the syscall interface so that test
1699             // output can be correctly reported.
1700             if !builder.config.wasm_syscall {
1701                 builder.info(
1702                     "Libstd was built without `wasm_syscall` feature enabled: \
1703                      test output may not be visible."
1704                 );
1705             }
1706
1707             // On the wasm32-unknown-unknown target we're using LTO which is
1708             // incompatible with `-C prefer-dynamic`, so disable that here
1709             cargo.env("RUSTC_NO_PREFER_DYNAMIC", "1");
1710
1711             let node = builder
1712                 .config
1713                 .nodejs
1714                 .as_ref()
1715                 .expect("nodejs not configured");
1716             let runner = format!(
1717                 "{} {}/src/etc/wasm32-shim.js",
1718                 node.display(),
1719                 builder.src.display()
1720             );
1721             cargo.env(format!("CARGO_TARGET_{}_RUNNER", envify(&target)), &runner);
1722         } else if builder.remote_tested(target) {
1723             cargo.env(
1724                 format!("CARGO_TARGET_{}_RUNNER", envify(&target)),
1725                 format!("{} run", builder.tool_exe(Tool::RemoteTestClient).display()),
1726             );
1727         }
1728
1729         let _folder = builder.fold_output(|| {
1730             format!(
1731                 "{}_stage{}-{}",
1732                 test_kind.subcommand(),
1733                 compiler.stage,
1734                 krate
1735             )
1736         });
1737         builder.info(&format!(
1738             "{} {} stage{} ({} -> {})",
1739             test_kind, krate, compiler.stage, &compiler.host, target
1740         ));
1741         let _time = util::timeit(&builder);
1742         try_run(builder, &mut cargo);
1743     }
1744 }
1745
1746 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1747 pub struct CrateRustdoc {
1748     host: Interned<String>,
1749     test_kind: TestKind,
1750 }
1751
1752 impl Step for CrateRustdoc {
1753     type Output = ();
1754     const DEFAULT: bool = true;
1755     const ONLY_HOSTS: bool = true;
1756
1757     fn should_run(run: ShouldRun) -> ShouldRun {
1758         run.paths(&["src/librustdoc", "src/tools/rustdoc"])
1759     }
1760
1761     fn make_run(run: RunConfig) {
1762         let builder = run.builder;
1763
1764         let test_kind = builder.kind.into();
1765
1766         builder.ensure(CrateRustdoc {
1767             host: run.host,
1768             test_kind,
1769         });
1770     }
1771
1772     fn run(self, builder: &Builder) {
1773         let test_kind = self.test_kind;
1774
1775         let compiler = builder.compiler(builder.top_stage, self.host);
1776         let target = compiler.host;
1777         builder.ensure(compile::Rustc { compiler, target });
1778
1779         let mut cargo = tool::prepare_tool_cargo(builder,
1780                                                  compiler,
1781                                                  Mode::ToolRustc,
1782                                                  target,
1783                                                  test_kind.subcommand(),
1784                                                  "src/tools/rustdoc",
1785                                                  SourceType::InTree,
1786                                                  &[]);
1787         if test_kind.subcommand() == "test" && !builder.fail_fast {
1788             cargo.arg("--no-fail-fast");
1789         }
1790
1791         cargo.arg("-p").arg("rustdoc:0.0.0");
1792
1793         cargo.arg("--");
1794         cargo.args(&builder.config.cmd.test_args());
1795
1796         if !builder.config.verbose_tests {
1797             cargo.arg("--quiet");
1798         }
1799
1800         let _folder = builder
1801             .fold_output(|| format!("{}_stage{}-rustdoc", test_kind.subcommand(), compiler.stage));
1802         builder.info(&format!(
1803             "{} rustdoc stage{} ({} -> {})",
1804             test_kind, compiler.stage, &compiler.host, target
1805         ));
1806         let _time = util::timeit(&builder);
1807
1808         try_run(builder, &mut cargo);
1809     }
1810 }
1811
1812 fn envify(s: &str) -> String {
1813     s.chars()
1814         .map(|c| match c {
1815             '-' => '_',
1816             c => c,
1817         })
1818         .flat_map(|c| c.to_uppercase())
1819         .collect()
1820 }
1821
1822 /// Some test suites are run inside emulators or on remote devices, and most
1823 /// of our test binaries are linked dynamically which means we need to ship
1824 /// the standard library and such to the emulator ahead of time. This step
1825 /// represents this and is a dependency of all test suites.
1826 ///
1827 /// Most of the time this is a noop. For some steps such as shipping data to
1828 /// QEMU we have to build our own tools so we've got conditional dependencies
1829 /// on those programs as well. Note that the remote test client is built for
1830 /// the build target (us) and the server is built for the target.
1831 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1832 pub struct RemoteCopyLibs {
1833     compiler: Compiler,
1834     target: Interned<String>,
1835 }
1836
1837 impl Step for RemoteCopyLibs {
1838     type Output = ();
1839
1840     fn should_run(run: ShouldRun) -> ShouldRun {
1841         run.never()
1842     }
1843
1844     fn run(self, builder: &Builder) {
1845         let compiler = self.compiler;
1846         let target = self.target;
1847         if !builder.remote_tested(target) {
1848             return;
1849         }
1850
1851         builder.ensure(compile::Test { compiler, target });
1852
1853         builder.info(&format!("REMOTE copy libs to emulator ({})", target));
1854         t!(fs::create_dir_all(builder.out.join("tmp")));
1855
1856         let server = builder.ensure(tool::RemoteTestServer {
1857             compiler: compiler.with_stage(0),
1858             target,
1859         });
1860
1861         // Spawn the emulator and wait for it to come online
1862         let tool = builder.tool_exe(Tool::RemoteTestClient);
1863         let mut cmd = Command::new(&tool);
1864         cmd.arg("spawn-emulator")
1865             .arg(target)
1866             .arg(&server)
1867             .arg(builder.out.join("tmp"));
1868         if let Some(rootfs) = builder.qemu_rootfs(target) {
1869             cmd.arg(rootfs);
1870         }
1871         builder.run(&mut cmd);
1872
1873         // Push all our dylibs to the emulator
1874         for f in t!(builder.sysroot_libdir(compiler, target).read_dir()) {
1875             let f = t!(f);
1876             let name = f.file_name().into_string().unwrap();
1877             if util::is_dylib(&name) {
1878                 builder.run(Command::new(&tool).arg("push").arg(f.path()));
1879             }
1880         }
1881     }
1882 }
1883
1884 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1885 pub struct Distcheck;
1886
1887 impl Step for Distcheck {
1888     type Output = ();
1889
1890     fn should_run(run: ShouldRun) -> ShouldRun {
1891         run.path("distcheck")
1892     }
1893
1894     fn make_run(run: RunConfig) {
1895         run.builder.ensure(Distcheck);
1896     }
1897
1898     /// Run "distcheck", a 'make check' from a tarball
1899     fn run(self, builder: &Builder) {
1900         builder.info("Distcheck");
1901         let dir = builder.out.join("tmp").join("distcheck");
1902         let _ = fs::remove_dir_all(&dir);
1903         t!(fs::create_dir_all(&dir));
1904
1905         // Guarantee that these are built before we begin running.
1906         builder.ensure(dist::PlainSourceTarball);
1907         builder.ensure(dist::Src);
1908
1909         let mut cmd = Command::new("tar");
1910         cmd.arg("-xzf")
1911             .arg(builder.ensure(dist::PlainSourceTarball))
1912             .arg("--strip-components=1")
1913             .current_dir(&dir);
1914         builder.run(&mut cmd);
1915         builder.run(
1916             Command::new("./configure")
1917                 .args(&builder.config.configure_args)
1918                 .arg("--enable-vendor")
1919                 .current_dir(&dir),
1920         );
1921         builder.run(
1922             Command::new(build_helper::make(&builder.config.build))
1923                 .arg("check")
1924                 .current_dir(&dir),
1925         );
1926
1927         // Now make sure that rust-src has all of libstd's dependencies
1928         builder.info("Distcheck rust-src");
1929         let dir = builder.out.join("tmp").join("distcheck-src");
1930         let _ = fs::remove_dir_all(&dir);
1931         t!(fs::create_dir_all(&dir));
1932
1933         let mut cmd = Command::new("tar");
1934         cmd.arg("-xzf")
1935             .arg(builder.ensure(dist::Src))
1936             .arg("--strip-components=1")
1937             .current_dir(&dir);
1938         builder.run(&mut cmd);
1939
1940         let toml = dir.join("rust-src/lib/rustlib/src/rust/src/libstd/Cargo.toml");
1941         builder.run(
1942             Command::new(&builder.initial_cargo)
1943                 .arg("generate-lockfile")
1944                 .arg("--manifest-path")
1945                 .arg(&toml)
1946                 .current_dir(&dir),
1947         );
1948     }
1949 }
1950
1951 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1952 pub struct Bootstrap;
1953
1954 impl Step for Bootstrap {
1955     type Output = ();
1956     const DEFAULT: bool = true;
1957     const ONLY_HOSTS: bool = true;
1958
1959     /// Test the build system itself
1960     fn run(self, builder: &Builder) {
1961         let mut cmd = Command::new(&builder.initial_cargo);
1962         cmd.arg("test")
1963             .current_dir(builder.src.join("src/bootstrap"))
1964             .env("RUSTFLAGS", "-Cdebuginfo=2")
1965             .env("CARGO_TARGET_DIR", builder.out.join("bootstrap"))
1966             .env("RUSTC_BOOTSTRAP", "1")
1967             .env("RUSTC", &builder.initial_rustc);
1968         if let Some(flags) = option_env!("RUSTFLAGS") {
1969             // Use the same rustc flags for testing as for "normal" compilation,
1970             // so that Cargo doesn’t recompile the entire dependency graph every time:
1971             // https://github.com/rust-lang/rust/issues/49215
1972             cmd.env("RUSTFLAGS", flags);
1973         }
1974         if !builder.fail_fast {
1975             cmd.arg("--no-fail-fast");
1976         }
1977         cmd.arg("--").args(&builder.config.cmd.test_args());
1978         // rustbuild tests are racy on directory creation so just run them one at a time.
1979         // Since there's not many this shouldn't be a problem.
1980         cmd.arg("--test-threads=1");
1981         try_run(builder, &mut cmd);
1982     }
1983
1984     fn should_run(run: ShouldRun) -> ShouldRun {
1985         run.path("src/bootstrap")
1986     }
1987
1988     fn make_run(run: RunConfig) {
1989         run.builder.ensure(Bootstrap);
1990     }
1991 }