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