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