src/bootstrap/test.rs

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