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         builder.add_rustc_lib_path(compiler, &mut cargo);
 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         builder.add_rustc_lib_path(compiler, &mut cargo);
 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("src"));
 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             builder.add_rustc_lib_path(compiler, &mut cargo);
 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         let cargo = tool::prepare_tool_cargo(
 488             builder,
 489             compiler,
 490             Mode::ToolBootstrap,
 491             host,
 492             "test",
 493             "src/tools/compiletest",
 494             SourceType::InTree,
 495             &[],
 496         );
 497
 498         try_run(builder, &mut cargo.into());
 499     }
 500 }
 501
 502 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 503 pub struct Clippy {
 504     stage: u32,
 505     host: TargetSelection,
 506 }
 507
 508 impl Step for Clippy {
 509     type Output = ();
 510     const ONLY_HOSTS: bool = true;
 511     const DEFAULT: bool = false;
 512
 513     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 514         run.path("src/tools/clippy")
 515     }
 516
 517     fn make_run(run: RunConfig<'_>) {
 518         run.builder.ensure(Clippy { stage: run.builder.top_stage, host: run.target });
 519     }
 520
 521     /// Runs `cargo test` for clippy.
 522     fn run(self, builder: &Builder<'_>) {
 523         let stage = self.stage;
 524         let host = self.host;
 525         let compiler = builder.compiler(stage, host);
 526
 527         let clippy = builder
 528             .ensure(tool::Clippy { compiler, target: self.host, extra_features: Vec::new() })
 529             .expect("in-tree tool");
 530         let mut cargo = tool::prepare_tool_cargo(
 531             builder,
 532             compiler,
 533             Mode::ToolRustc,
 534             host,
 535             "test",
 536             "src/tools/clippy",
 537             SourceType::InTree,
 538             &[],
 539         );
 540
 541         // clippy tests need to know about the stage sysroot
 542         cargo.env("SYSROOT", builder.sysroot(compiler));
 543         cargo.env("RUSTC_TEST_SUITE", builder.rustc(compiler));
 544         cargo.env("RUSTC_LIB_PATH", builder.rustc_libdir(compiler));
 545         let host_libs = builder.stage_out(compiler, Mode::ToolRustc).join(builder.cargo_dir());
 546         let target_libs = builder
 547             .stage_out(compiler, Mode::ToolRustc)
 548             .join(&self.host.triple)
 549             .join(builder.cargo_dir());
 550         cargo.env("HOST_LIBS", host_libs);
 551         cargo.env("TARGET_LIBS", target_libs);
 552         // clippy tests need to find the driver
 553         cargo.env("CLIPPY_DRIVER_PATH", clippy);
 554
 555         cargo.arg("--").args(builder.config.cmd.test_args());
 556
 557         builder.add_rustc_lib_path(compiler, &mut cargo);
 558
 559         builder.run(&mut cargo.into());
 560     }
 561 }
 562
 563 fn path_for_cargo(builder: &Builder<'_>, compiler: Compiler) -> OsString {
 564     // Configure PATH to find the right rustc. NB. we have to use PATH
 565     // and not RUSTC because the Cargo test suite has tests that will
 566     // fail if rustc is not spelled `rustc`.
 567     let path = builder.sysroot(compiler).join("bin");
 568     let old_path = env::var_os("PATH").unwrap_or_default();
 569     env::join_paths(iter::once(path).chain(env::split_paths(&old_path))).expect("")
 570 }
 571
 572 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
 573 pub struct RustdocTheme {
 574     pub compiler: Compiler,
 575 }
 576
 577 impl Step for RustdocTheme {
 578     type Output = ();
 579     const DEFAULT: bool = true;
 580     const ONLY_HOSTS: bool = true;
 581
 582     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 583         run.path("src/tools/rustdoc-themes")
 584     }
 585
 586     fn make_run(run: RunConfig<'_>) {
 587         let compiler = run.builder.compiler(run.builder.top_stage, run.host);
 588
 589         run.builder.ensure(RustdocTheme { compiler });
 590     }
 591
 592     fn run(self, builder: &Builder<'_>) {
 593         let rustdoc = builder.out.join("bootstrap/debug/rustdoc");
 594         let mut cmd = builder.tool_cmd(Tool::RustdocTheme);
 595         cmd.arg(rustdoc.to_str().unwrap())
 596             .arg(builder.src.join("src/librustdoc/html/static/themes").to_str().unwrap())
 597             .env("RUSTC_STAGE", self.compiler.stage.to_string())
 598             .env("RUSTC_SYSROOT", builder.sysroot(self.compiler))
 599             .env("RUSTDOC_LIBDIR", builder.sysroot_libdir(self.compiler, self.compiler.host))
 600             .env("CFG_RELEASE_CHANNEL", &builder.config.channel)
 601             .env("RUSTDOC_REAL", builder.rustdoc(self.compiler))
 602             .env("RUSTDOC_CRATE_VERSION", builder.rust_version())
 603             .env("RUSTC_BOOTSTRAP", "1");
 604         if let Some(linker) = builder.linker(self.compiler.host, true) {
 605             cmd.env("RUSTC_TARGET_LINKER", linker);
 606         }
 607         try_run(builder, &mut cmd);
 608     }
 609 }
 610
 611 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
 612 pub struct RustdocJSStd {
 613     pub target: TargetSelection,
 614 }
 615
 616 impl Step for RustdocJSStd {
 617     type Output = ();
 618     const DEFAULT: bool = true;
 619     const ONLY_HOSTS: bool = true;
 620
 621     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 622         run.path("src/test/rustdoc-js-std")
 623     }
 624
 625     fn make_run(run: RunConfig<'_>) {
 626         run.builder.ensure(RustdocJSStd { target: run.target });
 627     }
 628
 629     fn run(self, builder: &Builder<'_>) {
 630         if let Some(ref nodejs) = builder.config.nodejs {
 631             let mut command = Command::new(nodejs);
 632             command
 633                 .arg(builder.src.join("src/tools/rustdoc-js/tester.js"))
 634                 .arg("--crate-name")
 635                 .arg("std")
 636                 .arg("--resource-suffix")
 637                 .arg(crate::channel::CFG_RELEASE_NUM)
 638                 .arg("--doc-folder")
 639                 .arg(builder.doc_out(self.target))
 640                 .arg("--test-folder")
 641                 .arg(builder.src.join("src/test/rustdoc-js-std"));
 642             builder.ensure(crate::doc::Std { target: self.target, stage: builder.top_stage });
 643             builder.run(&mut command);
 644         } else {
 645             builder.info("No nodejs found, skipping \"src/test/rustdoc-js-std\" tests");
 646         }
 647     }
 648 }
 649
 650 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
 651 pub struct RustdocJSNotStd {
 652     pub host: TargetSelection,
 653     pub target: TargetSelection,
 654     pub compiler: Compiler,
 655 }
 656
 657 impl Step for RustdocJSNotStd {
 658     type Output = ();
 659     const DEFAULT: bool = true;
 660     const ONLY_HOSTS: bool = true;
 661
 662     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 663         run.path("src/test/rustdoc-js")
 664     }
 665
 666     fn make_run(run: RunConfig<'_>) {
 667         let compiler = run.builder.compiler(run.builder.top_stage, run.host);
 668         run.builder.ensure(RustdocJSNotStd { host: run.host, target: run.target, compiler });
 669     }
 670
 671     fn run(self, builder: &Builder<'_>) {
 672         if builder.config.nodejs.is_some() {
 673             builder.ensure(Compiletest {
 674                 compiler: self.compiler,
 675                 target: self.target,
 676                 mode: "js-doc-test",
 677                 suite: "rustdoc-js",
 678                 path: "src/test/rustdoc-js",
 679                 compare_mode: None,
 680             });
 681         } else {
 682             builder.info("No nodejs found, skipping \"src/test/rustdoc-js\" tests");
 683         }
 684     }
 685 }
 686
 687 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
 688 pub struct RustdocUi {
 689     pub host: TargetSelection,
 690     pub target: TargetSelection,
 691     pub compiler: Compiler,
 692 }
 693
 694 impl Step for RustdocUi {
 695     type Output = ();
 696     const DEFAULT: bool = true;
 697     const ONLY_HOSTS: bool = true;
 698
 699     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 700         run.path("src/test/rustdoc-ui")
 701     }
 702
 703     fn make_run(run: RunConfig<'_>) {
 704         let compiler = run.builder.compiler(run.builder.top_stage, run.host);
 705         run.builder.ensure(RustdocUi { host: run.host, target: run.target, compiler });
 706     }
 707
 708     fn run(self, builder: &Builder<'_>) {
 709         builder.ensure(Compiletest {
 710             compiler: self.compiler,
 711             target: self.target,
 712             mode: "ui",
 713             suite: "rustdoc-ui",
 714             path: "src/test/rustdoc-ui",
 715             compare_mode: None,
 716         })
 717     }
 718 }
 719
 720 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 721 pub struct Tidy;
 722
 723 impl Step for Tidy {
 724     type Output = ();
 725     const DEFAULT: bool = true;
 726     const ONLY_HOSTS: bool = true;
 727
 728     /// Runs the `tidy` tool.
 729     ///
 730     /// This tool in `src/tools` checks up on various bits and pieces of style and
 731     /// otherwise just implements a few lint-like checks that are specific to the
 732     /// compiler itself.
 733     ///
 734     /// Once tidy passes, this step also runs `fmt --check` if tests are being run
 735     /// for the `dev` or `nightly` channels.
 736     fn run(self, builder: &Builder<'_>) {
 737         let mut cmd = builder.tool_cmd(Tool::Tidy);
 738         cmd.arg(builder.src.join("src"));
 739         cmd.arg(&builder.initial_cargo);
 740         if builder.is_verbose() {
 741             cmd.arg("--verbose");
 742         }
 743
 744         builder.info("tidy check");
 745         try_run(builder, &mut cmd);
 746
 747         if builder.config.channel == "dev" || builder.config.channel == "nightly" {
 748             builder.info("fmt check");
 749             crate::format::format(&builder.build, !builder.config.cmd.bless());
 750         }
 751     }
 752
 753     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 754         run.path("src/tools/tidy")
 755     }
 756
 757     fn make_run(run: RunConfig<'_>) {
 758         run.builder.ensure(Tidy);
 759     }
 760 }
 761
 762 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 763 pub struct ExpandYamlAnchors;
 764
 765 impl Step for ExpandYamlAnchors {
 766     type Output = ();
 767     const ONLY_HOSTS: bool = true;
 768
 769     /// Ensure the `generate-ci-config` tool was run locally.
 770     ///
 771     /// The tool in `src/tools` reads the CI definition in `src/ci/builders.yml` and generates the
 772     /// appropriate configuration for all our CI providers. This step ensures the tool was called
 773     /// by the user before committing CI changes.
 774     fn run(self, builder: &Builder<'_>) {
 775         builder.info("Ensuring the YAML anchors in the GitHub Actions config were expanded");
 776         try_run(
 777             builder,
 778             &mut builder.tool_cmd(Tool::ExpandYamlAnchors).arg("check").arg(&builder.src),
 779         );
 780     }
 781
 782     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 783         run.path("src/tools/expand-yaml-anchors")
 784     }
 785
 786     fn make_run(run: RunConfig<'_>) {
 787         run.builder.ensure(ExpandYamlAnchors);
 788     }
 789 }
 790
 791 fn testdir(builder: &Builder<'_>, host: TargetSelection) -> PathBuf {
 792     builder.out.join(host.triple).join("test")
 793 }
 794
 795 macro_rules! default_test {
 796     ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr }) => {
 797         test!($name { path: $path, mode: $mode, suite: $suite, default: true, host: false });
 798     };
 799 }
 800
 801 macro_rules! default_test_with_compare_mode {
 802     ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr,
 803                    compare_mode: $compare_mode:expr }) => {
 804         test_with_compare_mode!($name {
 805             path: $path,
 806             mode: $mode,
 807             suite: $suite,
 808             default: true,
 809             host: false,
 810             compare_mode: $compare_mode
 811         });
 812     };
 813 }
 814
 815 macro_rules! host_test {
 816     ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr }) => {
 817         test!($name { path: $path, mode: $mode, suite: $suite, default: true, host: true });
 818     };
 819 }
 820
 821 macro_rules! test {
 822     ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr, default: $default:expr,
 823                    host: $host:expr }) => {
 824         test_definitions!($name {
 825             path: $path,
 826             mode: $mode,
 827             suite: $suite,
 828             default: $default,
 829             host: $host,
 830             compare_mode: None
 831         });
 832     };
 833 }
 834
 835 macro_rules! test_with_compare_mode {
 836     ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr, default: $default:expr,
 837                    host: $host:expr, compare_mode: $compare_mode:expr }) => {
 838         test_definitions!($name {
 839             path: $path,
 840             mode: $mode,
 841             suite: $suite,
 842             default: $default,
 843             host: $host,
 844             compare_mode: Some($compare_mode)
 845         });
 846     };
 847 }
 848
 849 macro_rules! test_definitions {
 850     ($name:ident {
 851         path: $path:expr,
 852         mode: $mode:expr,
 853         suite: $suite:expr,
 854         default: $default:expr,
 855         host: $host:expr,
 856         compare_mode: $compare_mode:expr
 857     }) => {
 858         #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 859         pub struct $name {
 860             pub compiler: Compiler,
 861             pub target: TargetSelection,
 862         }
 863
 864         impl Step for $name {
 865             type Output = ();
 866             const DEFAULT: bool = $default;
 867             const ONLY_HOSTS: bool = $host;
 868
 869             fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 870                 run.suite_path($path)
 871             }
 872
 873             fn make_run(run: RunConfig<'_>) {
 874                 let compiler = run.builder.compiler(run.builder.top_stage, run.host);
 875
 876                 run.builder.ensure($name { compiler, target: run.target });
 877             }
 878
 879             fn run(self, builder: &Builder<'_>) {
 880                 builder.ensure(Compiletest {
 881                     compiler: self.compiler,
 882                     target: self.target,
 883                     mode: $mode,
 884                     suite: $suite,
 885                     path: $path,
 886                     compare_mode: $compare_mode,
 887                 })
 888             }
 889         }
 890     };
 891 }
 892
 893 default_test_with_compare_mode!(Ui {
 894     path: "src/test/ui",
 895     mode: "ui",
 896     suite: "ui",
 897     compare_mode: "nll"
 898 });
 899
 900 default_test!(CompileFail {
 901     path: "src/test/compile-fail",
 902     mode: "compile-fail",
 903     suite: "compile-fail"
 904 });
 905
 906 default_test!(RunPassValgrind {
 907     path: "src/test/run-pass-valgrind",
 908     mode: "run-pass-valgrind",
 909     suite: "run-pass-valgrind"
 910 });
 911
 912 default_test!(MirOpt { path: "src/test/mir-opt", mode: "mir-opt", suite: "mir-opt" });
 913
 914 default_test!(Codegen { path: "src/test/codegen", mode: "codegen", suite: "codegen" });
 915
 916 default_test!(CodegenUnits {
 917     path: "src/test/codegen-units",
 918     mode: "codegen-units",
 919     suite: "codegen-units"
 920 });
 921
 922 default_test!(Incremental {
 923     path: "src/test/incremental",
 924     mode: "incremental",
 925     suite: "incremental"
 926 });
 927
 928 default_test!(Debuginfo { path: "src/test/debuginfo", mode: "debuginfo", suite: "debuginfo" });
 929
 930 host_test!(UiFullDeps { path: "src/test/ui-fulldeps", mode: "ui", suite: "ui-fulldeps" });
 931
 932 host_test!(Rustdoc { path: "src/test/rustdoc", mode: "rustdoc", suite: "rustdoc" });
 933
 934 host_test!(Pretty { path: "src/test/pretty", mode: "pretty", suite: "pretty" });
 935
 936 default_test!(RunMake { path: "src/test/run-make", mode: "run-make", suite: "run-make" });
 937
 938 host_test!(RunMakeFullDeps {
 939     path: "src/test/run-make-fulldeps",
 940     mode: "run-make",
 941     suite: "run-make-fulldeps"
 942 });
 943
 944 default_test!(Assembly { path: "src/test/assembly", mode: "assembly", suite: "assembly" });
 945
 946 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 947 struct Compiletest {
 948     compiler: Compiler,
 949     target: TargetSelection,
 950     mode: &'static str,
 951     suite: &'static str,
 952     path: &'static str,
 953     compare_mode: Option<&'static str>,
 954 }
 955
 956 impl Step for Compiletest {
 957     type Output = ();
 958
 959     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 960         run.never()
 961     }
 962
 963     /// Executes the `compiletest` tool to run a suite of tests.
 964     ///
 965     /// Compiles all tests with `compiler` for `target` with the specified
 966     /// compiletest `mode` and `suite` arguments. For example `mode` can be
 967     /// "run-pass" or `suite` can be something like `debuginfo`.
 968     fn run(self, builder: &Builder<'_>) {
 969         let compiler = self.compiler;
 970         let target = self.target;
 971         let mode = self.mode;
 972         let suite = self.suite;
 973
 974         // Path for test suite
 975         let suite_path = self.path;
 976
 977         // Skip codegen tests if they aren't enabled in configuration.
 978         if !builder.config.codegen_tests && suite == "codegen" {
 979             return;
 980         }
 981
 982         if suite == "debuginfo" {
 983             builder
 984                 .ensure(dist::DebuggerScripts { sysroot: builder.sysroot(compiler), host: target });
 985         }
 986
 987         if suite.ends_with("fulldeps") {
 988             builder.ensure(compile::Rustc { compiler, target });
 989         }
 990
 991         builder.ensure(compile::Std { compiler, target });
 992         // ensure that `libproc_macro` is available on the host.
 993         builder.ensure(compile::Std { compiler, target: compiler.host });
 994
 995         // Also provide `rust_test_helpers` for the host.
 996         builder.ensure(native::TestHelpers { target: compiler.host });
 997
 998         // As well as the target, except for plain wasm32, which can't build it
 999         if !target.contains("wasm32") || target.contains("emscripten") {
1000             builder.ensure(native::TestHelpers { target });
1001         }
1002
1003         builder.ensure(RemoteCopyLibs { compiler, target });
1004
1005         let mut cmd = builder.tool_cmd(Tool::Compiletest);
1006
1007         // compiletest currently has... a lot of arguments, so let's just pass all
1008         // of them!
1009
1010         cmd.arg("--compile-lib-path").arg(builder.rustc_libdir(compiler));
1011         cmd.arg("--run-lib-path").arg(builder.sysroot_libdir(compiler, target));
1012         cmd.arg("--rustc-path").arg(builder.rustc(compiler));
1013
1014         let is_rustdoc = suite.ends_with("rustdoc-ui") || suite.ends_with("rustdoc-js");
1015
1016         // Avoid depending on rustdoc when we don't need it.
1017         if mode == "rustdoc"
1018             || (mode == "run-make" && suite.ends_with("fulldeps"))
1019             || (mode == "ui" && is_rustdoc)
1020             || mode == "js-doc-test"
1021         {
1022             cmd.arg("--rustdoc-path").arg(builder.rustdoc(compiler));
1023         }
1024
1025         if mode == "run-make" && suite.ends_with("fulldeps") {
1026             cmd.arg("--rust-demangler-path").arg(builder.tool_exe(Tool::RustDemangler));
1027         }
1028
1029         cmd.arg("--src-base").arg(builder.src.join("src/test").join(suite));
1030         cmd.arg("--build-base").arg(testdir(builder, compiler.host).join(suite));
1031         cmd.arg("--stage-id").arg(format!("stage{}-{}", compiler.stage, target));
1032         cmd.arg("--mode").arg(mode);
1033         cmd.arg("--target").arg(target.rustc_target_arg());
1034         cmd.arg("--host").arg(&*compiler.host.triple);
1035         cmd.arg("--llvm-filecheck").arg(builder.llvm_filecheck(builder.config.build));
1036
1037         if builder.config.cmd.bless() {
1038             cmd.arg("--bless");
1039         }
1040
1041         let compare_mode =
1042             builder.config.cmd.compare_mode().or_else(|| {
1043                 if builder.config.test_compare_mode { self.compare_mode } else { None }
1044             });
1045
1046         if let Some(ref pass) = builder.config.cmd.pass() {
1047             cmd.arg("--pass");
1048             cmd.arg(pass);
1049         }
1050
1051         if let Some(ref nodejs) = builder.config.nodejs {
1052             cmd.arg("--nodejs").arg(nodejs);
1053         }
1054
1055         let mut flags = if is_rustdoc { Vec::new() } else { vec!["-Crpath".to_string()] };
1056         if !is_rustdoc {
1057             if builder.config.rust_optimize_tests {
1058                 flags.push("-O".to_string());
1059             }
1060         }
1061         flags.push(format!("-Cdebuginfo={}", builder.config.rust_debuginfo_level_tests));
1062         flags.push("-Zunstable-options".to_string());
1063         flags.push(builder.config.cmd.rustc_args().join(" "));
1064
1065         // Don't use LLD here since we want to test that rustc finds and uses a linker by itself.
1066         if let Some(linker) = builder.linker(target, false) {
1067             cmd.arg("--linker").arg(linker);
1068         }
1069
1070         let mut hostflags = flags.clone();
1071         hostflags.push(format!("-Lnative={}", builder.test_helpers_out(compiler.host).display()));
1072         cmd.arg("--host-rustcflags").arg(hostflags.join(" "));
1073
1074         let mut targetflags = flags;
1075         targetflags.push(format!("-Lnative={}", builder.test_helpers_out(target).display()));
1076         cmd.arg("--target-rustcflags").arg(targetflags.join(" "));
1077
1078         cmd.arg("--docck-python").arg(builder.python());
1079
1080         if builder.config.build.ends_with("apple-darwin") {
1081             // Force /usr/bin/python3 on macOS for LLDB tests because we're loading the
1082             // LLDB plugin's compiled module which only works with the system python
1083             // (namely not Homebrew-installed python)
1084             cmd.arg("--lldb-python").arg("/usr/bin/python3");
1085         } else {
1086             cmd.arg("--lldb-python").arg(builder.python());
1087         }
1088
1089         if let Some(ref gdb) = builder.config.gdb {
1090             cmd.arg("--gdb").arg(gdb);
1091         }
1092
1093         let run = |cmd: &mut Command| {
1094             cmd.output().map(|output| {
1095                 String::from_utf8_lossy(&output.stdout)
1096                     .lines()
1097                     .next()
1098                     .unwrap_or_else(|| panic!("{:?} failed {:?}", cmd, output))
1099                     .to_string()
1100             })
1101         };
1102         let lldb_exe = "lldb";
1103         let lldb_version = Command::new(lldb_exe)
1104             .arg("--version")
1105             .output()
1106             .map(|output| String::from_utf8_lossy(&output.stdout).to_string())
1107             .ok();
1108         if let Some(ref vers) = lldb_version {
1109             cmd.arg("--lldb-version").arg(vers);
1110             let lldb_python_dir = run(Command::new(lldb_exe).arg("-P")).ok();
1111             if let Some(ref dir) = lldb_python_dir {
1112                 cmd.arg("--lldb-python-dir").arg(dir);
1113             }
1114         }
1115
1116         if util::forcing_clang_based_tests() {
1117             let clang_exe = builder.llvm_out(target).join("bin").join("clang");
1118             cmd.arg("--run-clang-based-tests-with").arg(clang_exe);
1119         }
1120
1121         // Get paths from cmd args
1122         let paths = match &builder.config.cmd {
1123             Subcommand::Test { ref paths, .. } => &paths[..],
1124             _ => &[],
1125         };
1126
1127         // Get test-args by striping suite path
1128         let mut test_args: Vec<&str> = paths
1129             .iter()
1130             .map(|p| match p.strip_prefix(".") {
1131                 Ok(path) => path,
1132                 Err(_) => p,
1133             })
1134             .filter(|p| p.starts_with(suite_path) && (p.is_dir() || p.is_file()))
1135             .filter_map(|p| {
1136                 // Since test suite paths are themselves directories, if we don't
1137                 // specify a directory or file, we'll get an empty string here
1138                 // (the result of the test suite directory without its suite prefix).
1139                 // Therefore, we need to filter these out, as only the first --test-args
1140                 // flag is respected, so providing an empty --test-args conflicts with
1141                 // any following it.
1142                 match p.strip_prefix(suite_path).ok().and_then(|p| p.to_str()) {
1143                     Some(s) if s != "" => Some(s),
1144                     _ => None,
1145                 }
1146             })
1147             .collect();
1148
1149         test_args.append(&mut builder.config.cmd.test_args());
1150
1151         cmd.args(&test_args);
1152
1153         if builder.is_verbose() {
1154             cmd.arg("--verbose");
1155         }
1156
1157         if !builder.config.verbose_tests {
1158             cmd.arg("--quiet");
1159         }
1160
1161         if builder.config.llvm_enabled() {
1162             let llvm_config = builder.ensure(native::Llvm { target: builder.config.build });
1163             if !builder.config.dry_run {
1164                 let llvm_version = output(Command::new(&llvm_config).arg("--version"));
1165                 // Remove trailing newline from llvm-config output.
1166                 let llvm_version = llvm_version.trim_end();
1167                 cmd.arg("--llvm-version").arg(llvm_version);
1168             }
1169             if !builder.is_rust_llvm(target) {
1170                 cmd.arg("--system-llvm");
1171             }
1172
1173             // Tests that use compiler libraries may inherit the `-lLLVM` link
1174             // requirement, but the `-L` library path is not propagated across
1175             // separate compilations. We can add LLVM's library path to the
1176             // platform-specific environment variable as a workaround.
1177             if !builder.config.dry_run && suite.ends_with("fulldeps") {
1178                 let llvm_libdir = output(Command::new(&llvm_config).arg("--libdir"));
1179                 add_link_lib_path(vec![llvm_libdir.trim().into()], &mut cmd);
1180             }
1181
1182             // Only pass correct values for these flags for the `run-make` suite as it
1183             // requires that a C++ compiler was configured which isn't always the case.
1184             if !builder.config.dry_run && suite == "run-make-fulldeps" {
1185                 let llvm_components = output(Command::new(&llvm_config).arg("--components"));
1186                 cmd.arg("--cc")
1187                     .arg(builder.cc(target))
1188                     .arg("--cxx")
1189                     .arg(builder.cxx(target).unwrap())
1190                     .arg("--cflags")
1191                     .arg(builder.cflags(target, GitRepo::Rustc).join(" "))
1192                     .arg("--llvm-components")
1193                     .arg(llvm_components.trim());
1194                 if let Some(ar) = builder.ar(target) {
1195                     cmd.arg("--ar").arg(ar);
1196                 }
1197
1198                 // The llvm/bin directory contains many useful cross-platform
1199                 // tools. Pass the path to run-make tests so they can use them.
1200                 let llvm_bin_path = llvm_config
1201                     .parent()
1202                     .expect("Expected llvm-config to be contained in directory");
1203                 assert!(llvm_bin_path.is_dir());
1204                 cmd.arg("--llvm-bin-dir").arg(llvm_bin_path);
1205
1206                 // If LLD is available, add it to the PATH
1207                 if builder.config.lld_enabled {
1208                     let lld_install_root =
1209                         builder.ensure(native::Lld { target: builder.config.build });
1210
1211                     let lld_bin_path = lld_install_root.join("bin");
1212
1213                     let old_path = env::var_os("PATH").unwrap_or_default();
1214                     let new_path = env::join_paths(
1215                         std::iter::once(lld_bin_path).chain(env::split_paths(&old_path)),
1216                     )
1217                     .expect("Could not add LLD bin path to PATH");
1218                     cmd.env("PATH", new_path);
1219                 }
1220             }
1221         }
1222
1223         if suite != "run-make-fulldeps" {
1224             cmd.arg("--cc")
1225                 .arg("")
1226                 .arg("--cxx")
1227                 .arg("")
1228                 .arg("--cflags")
1229                 .arg("")
1230                 .arg("--llvm-components")
1231                 .arg("");
1232         }
1233
1234         if builder.remote_tested(target) {
1235             cmd.arg("--remote-test-client").arg(builder.tool_exe(Tool::RemoteTestClient));
1236         }
1237
1238         // Running a C compiler on MSVC requires a few env vars to be set, to be
1239         // sure to set them here.
1240         //
1241         // Note that if we encounter `PATH` we make sure to append to our own `PATH`
1242         // rather than stomp over it.
1243         if target.contains("msvc") {
1244             for &(ref k, ref v) in builder.cc[&target].env() {
1245                 if k != "PATH" {
1246                     cmd.env(k, v);
1247                 }
1248             }
1249         }
1250         cmd.env("RUSTC_BOOTSTRAP", "1");
1251         builder.add_rust_test_threads(&mut cmd);
1252
1253         if builder.config.sanitizers {
1254             cmd.env("RUSTC_SANITIZER_SUPPORT", "1");
1255         }
1256
1257         if builder.config.profiler {
1258             cmd.env("RUSTC_PROFILER_SUPPORT", "1");
1259         }
1260
1261         let tmp = builder.out.join("tmp");
1262         std::fs::create_dir_all(&tmp).unwrap();
1263         cmd.env("RUST_TEST_TMPDIR", tmp);
1264
1265         cmd.arg("--adb-path").arg("adb");
1266         cmd.arg("--adb-test-dir").arg(ADB_TEST_DIR);
1267         if target.contains("android") {
1268             // Assume that cc for this target comes from the android sysroot
1269             cmd.arg("--android-cross-path")
1270                 .arg(builder.cc(target).parent().unwrap().parent().unwrap());
1271         } else {
1272             cmd.arg("--android-cross-path").arg("");
1273         }
1274
1275         if builder.config.cmd.rustfix_coverage() {
1276             cmd.arg("--rustfix-coverage");
1277         }
1278
1279         builder.ci_env.force_coloring_in_ci(&mut cmd);
1280
1281         builder.info(&format!(
1282             "Check compiletest suite={} mode={} ({} -> {})",
1283             suite, mode, &compiler.host, target
1284         ));
1285         let _time = util::timeit(&builder);
1286         try_run(builder, &mut cmd);
1287
1288         if let Some(compare_mode) = compare_mode {
1289             cmd.arg("--compare-mode").arg(compare_mode);
1290             builder.info(&format!(
1291                 "Check compiletest suite={} mode={} compare_mode={} ({} -> {})",
1292                 suite, mode, compare_mode, &compiler.host, target
1293             ));
1294             let _time = util::timeit(&builder);
1295             try_run(builder, &mut cmd);
1296         }
1297     }
1298 }
1299
1300 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
1301 struct BookTest {
1302     compiler: Compiler,
1303     path: PathBuf,
1304     name: &'static str,
1305     is_ext_doc: bool,
1306 }
1307
1308 impl Step for BookTest {
1309     type Output = ();
1310     const ONLY_HOSTS: bool = true;
1311
1312     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1313         run.never()
1314     }
1315
1316     /// Runs the documentation tests for a book in `src/doc`.
1317     ///
1318     /// This uses the `rustdoc` that sits next to `compiler`.
1319     fn run(self, builder: &Builder<'_>) {
1320         // External docs are different from local because:
1321         // - Some books need pre-processing by mdbook before being tested.
1322         // - They need to save their state to toolstate.
1323         // - They are only tested on the "checktools" builders.
1324         //
1325         // The local docs are tested by default, and we don't want to pay the
1326         // cost of building mdbook, so they use `rustdoc --test` directly.
1327         // Also, the unstable book is special because SUMMARY.md is generated,
1328         // so it is easier to just run `rustdoc` on its files.
1329         if self.is_ext_doc {
1330             self.run_ext_doc(builder);
1331         } else {
1332             self.run_local_doc(builder);
1333         }
1334     }
1335 }
1336
1337 impl BookTest {
1338     /// This runs the equivalent of `mdbook test` (via the rustbook wrapper)
1339     /// which in turn runs `rustdoc --test` on each file in the book.
1340     fn run_ext_doc(self, builder: &Builder<'_>) {
1341         let compiler = self.compiler;
1342
1343         builder.ensure(compile::Std { compiler, target: compiler.host });
1344
1345         // mdbook just executes a binary named "rustdoc", so we need to update
1346         // PATH so that it points to our rustdoc.
1347         let mut rustdoc_path = builder.rustdoc(compiler);
1348         rustdoc_path.pop();
1349         let old_path = env::var_os("PATH").unwrap_or_default();
1350         let new_path = env::join_paths(iter::once(rustdoc_path).chain(env::split_paths(&old_path)))
1351             .expect("could not add rustdoc to PATH");
1352
1353         let mut rustbook_cmd = builder.tool_cmd(Tool::Rustbook);
1354         let path = builder.src.join(&self.path);
1355         rustbook_cmd.env("PATH", new_path).arg("test").arg(path);
1356         builder.add_rust_test_threads(&mut rustbook_cmd);
1357         builder.info(&format!("Testing rustbook {}", self.path.display()));
1358         let _time = util::timeit(&builder);
1359         let toolstate = if try_run(builder, &mut rustbook_cmd) {
1360             ToolState::TestPass
1361         } else {
1362             ToolState::TestFail
1363         };
1364         builder.save_toolstate(self.name, toolstate);
1365     }
1366
1367     /// This runs `rustdoc --test` on all `.md` files in the path.
1368     fn run_local_doc(self, builder: &Builder<'_>) {
1369         let compiler = self.compiler;
1370
1371         builder.ensure(compile::Std { compiler, target: compiler.host });
1372
1373         // Do a breadth-first traversal of the `src/doc` directory and just run
1374         // tests for all files that end in `*.md`
1375         let mut stack = vec![builder.src.join(self.path)];
1376         let _time = util::timeit(&builder);
1377         let mut files = Vec::new();
1378         while let Some(p) = stack.pop() {
1379             if p.is_dir() {
1380                 stack.extend(t!(p.read_dir()).map(|p| t!(p).path()));
1381                 continue;
1382             }
1383
1384             if p.extension().and_then(|s| s.to_str()) != Some("md") {
1385                 continue;
1386             }
1387
1388             files.push(p);
1389         }
1390
1391         files.sort();
1392
1393         for file in files {
1394             markdown_test(builder, compiler, &file);
1395         }
1396     }
1397 }
1398
1399 macro_rules! test_book {
1400     ($($name:ident, $path:expr, $book_name:expr, default=$default:expr;)+) => {
1401         $(
1402             #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1403             pub struct $name {
1404                 compiler: Compiler,
1405             }
1406
1407             impl Step for $name {
1408                 type Output = ();
1409                 const DEFAULT: bool = $default;
1410                 const ONLY_HOSTS: bool = true;
1411
1412                 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1413                     run.path($path)
1414                 }
1415
1416                 fn make_run(run: RunConfig<'_>) {
1417                     run.builder.ensure($name {
1418                         compiler: run.builder.compiler(run.builder.top_stage, run.host),
1419                     });
1420                 }
1421
1422                 fn run(self, builder: &Builder<'_>) {
1423                     builder.ensure(BookTest {
1424                         compiler: self.compiler,
1425                         path: PathBuf::from($path),
1426                         name: $book_name,
1427                         is_ext_doc: !$default,
1428                     });
1429                 }
1430             }
1431         )+
1432     }
1433 }
1434
1435 test_book!(
1436     Nomicon, "src/doc/nomicon", "nomicon", default=false;
1437     Reference, "src/doc/reference", "reference", default=false;
1438     RustdocBook, "src/doc/rustdoc", "rustdoc", default=true;
1439     RustcBook, "src/doc/rustc", "rustc", default=true;
1440     RustByExample, "src/doc/rust-by-example", "rust-by-example", default=false;
1441     EmbeddedBook, "src/doc/embedded-book", "embedded-book", default=false;
1442     TheBook, "src/doc/book", "book", default=false;
1443     UnstableBook, "src/doc/unstable-book", "unstable-book", default=true;
1444     EditionGuide, "src/doc/edition-guide", "edition-guide", default=false;
1445 );
1446
1447 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1448 pub struct ErrorIndex {
1449     compiler: Compiler,
1450 }
1451
1452 impl Step for ErrorIndex {
1453     type Output = ();
1454     const DEFAULT: bool = true;
1455     const ONLY_HOSTS: bool = true;
1456
1457     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1458         run.path("src/tools/error_index_generator")
1459     }
1460
1461     fn make_run(run: RunConfig<'_>) {
1462         // error_index_generator depends on librustdoc. Use the compiler that
1463         // is normally used to build rustdoc for other tests (like compiletest
1464         // tests in src/test/rustdoc) so that it shares the same artifacts.
1465         let compiler = run.builder.compiler_for(run.builder.top_stage, run.host, run.host);
1466         run.builder.ensure(ErrorIndex { compiler });
1467     }
1468
1469     /// Runs the error index generator tool to execute the tests located in the error
1470     /// index.
1471     ///
1472     /// The `error_index_generator` tool lives in `src/tools` and is used to
1473     /// generate a markdown file from the error indexes of the code base which is
1474     /// then passed to `rustdoc --test`.
1475     fn run(self, builder: &Builder<'_>) {
1476         let compiler = self.compiler;
1477
1478         let dir = testdir(builder, compiler.host);
1479         t!(fs::create_dir_all(&dir));
1480         let output = dir.join("error-index.md");
1481
1482         let mut tool = tool::ErrorIndex::command(builder, compiler);
1483         tool.arg("markdown").arg(&output);
1484
1485         // Use the rustdoc that was built by self.compiler. This copy of
1486         // rustdoc is shared with other tests (like compiletest tests in
1487         // src/test/rustdoc). This helps avoid building rustdoc multiple
1488         // times.
1489         let rustdoc_compiler = builder.compiler(builder.top_stage, builder.config.build);
1490         builder.info(&format!("Testing error-index stage{}", rustdoc_compiler.stage));
1491         let _time = util::timeit(&builder);
1492         builder.run_quiet(&mut tool);
1493         builder.ensure(compile::Std { compiler: rustdoc_compiler, target: rustdoc_compiler.host });
1494         markdown_test(builder, rustdoc_compiler, &output);
1495     }
1496 }
1497
1498 fn markdown_test(builder: &Builder<'_>, compiler: Compiler, markdown: &Path) -> bool {
1499     if let Ok(contents) = fs::read_to_string(markdown) {
1500         if !contents.contains("```") {
1501             return true;
1502         }
1503     }
1504
1505     builder.info(&format!("doc tests for: {}", markdown.display()));
1506     let mut cmd = builder.rustdoc_cmd(compiler);
1507     builder.add_rust_test_threads(&mut cmd);
1508     cmd.arg("--test");
1509     cmd.arg(markdown);
1510     cmd.env("RUSTC_BOOTSTRAP", "1");
1511
1512     let test_args = builder.config.cmd.test_args().join(" ");
1513     cmd.arg("--test-args").arg(test_args);
1514
1515     if builder.config.verbose_tests {
1516         try_run(builder, &mut cmd)
1517     } else {
1518         try_run_quiet(builder, &mut cmd)
1519     }
1520 }
1521
1522 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1523 pub struct RustcGuide;
1524
1525 impl Step for RustcGuide {
1526     type Output = ();
1527     const DEFAULT: bool = false;
1528     const ONLY_HOSTS: bool = true;
1529
1530     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1531         run.path("src/doc/rustc-dev-guide")
1532     }
1533
1534     fn make_run(run: RunConfig<'_>) {
1535         run.builder.ensure(RustcGuide);
1536     }
1537
1538     fn run(self, builder: &Builder<'_>) {
1539         let src = builder.src.join("src/doc/rustc-dev-guide");
1540         let mut rustbook_cmd = builder.tool_cmd(Tool::Rustbook);
1541         let toolstate = if try_run(builder, rustbook_cmd.arg("linkcheck").arg(&src)) {
1542             ToolState::TestPass
1543         } else {
1544             ToolState::TestFail
1545         };
1546         builder.save_toolstate("rustc-dev-guide", toolstate);
1547     }
1548 }
1549
1550 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1551 pub struct CrateLibrustc {
1552     compiler: Compiler,
1553     target: TargetSelection,
1554     test_kind: TestKind,
1555     krate: Interned<String>,
1556 }
1557
1558 impl Step for CrateLibrustc {
1559     type Output = ();
1560     const DEFAULT: bool = true;
1561     const ONLY_HOSTS: bool = true;
1562
1563     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1564         run.krate("rustc-main")
1565     }
1566
1567     fn make_run(run: RunConfig<'_>) {
1568         let builder = run.builder;
1569         let compiler = builder.compiler(builder.top_stage, run.host);
1570
1571         for krate in builder.in_tree_crates("rustc-main") {
1572             if krate.path.ends_with(&run.path) {
1573                 let test_kind = builder.kind.into();
1574
1575                 builder.ensure(CrateLibrustc {
1576                     compiler,
1577                     target: run.target,
1578                     test_kind,
1579                     krate: krate.name,
1580                 });
1581             }
1582         }
1583     }
1584
1585     fn run(self, builder: &Builder<'_>) {
1586         builder.ensure(Crate {
1587             compiler: self.compiler,
1588             target: self.target,
1589             mode: Mode::Rustc,
1590             test_kind: self.test_kind,
1591             krate: self.krate,
1592         });
1593     }
1594 }
1595
1596 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1597 pub struct CrateNotDefault {
1598     compiler: Compiler,
1599     target: TargetSelection,
1600     test_kind: TestKind,
1601     krate: &'static str,
1602 }
1603
1604 impl Step for CrateNotDefault {
1605     type Output = ();
1606
1607     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1608         run.path("src/librustc_asan")
1609             .path("src/librustc_lsan")
1610             .path("src/librustc_msan")
1611             .path("src/librustc_tsan")
1612     }
1613
1614     fn make_run(run: RunConfig<'_>) {
1615         let builder = run.builder;
1616         let compiler = builder.compiler(builder.top_stage, run.host);
1617
1618         let test_kind = builder.kind.into();
1619
1620         builder.ensure(CrateNotDefault {
1621             compiler,
1622             target: run.target,
1623             test_kind,
1624             krate: match run.path {
1625                 _ if run.path.ends_with("src/librustc_asan") => "rustc_asan",
1626                 _ if run.path.ends_with("src/librustc_lsan") => "rustc_lsan",
1627                 _ if run.path.ends_with("src/librustc_msan") => "rustc_msan",
1628                 _ if run.path.ends_with("src/librustc_tsan") => "rustc_tsan",
1629                 _ => panic!("unexpected path {:?}", run.path),
1630             },
1631         });
1632     }
1633
1634     fn run(self, builder: &Builder<'_>) {
1635         builder.ensure(Crate {
1636             compiler: self.compiler,
1637             target: self.target,
1638             mode: Mode::Std,
1639             test_kind: self.test_kind,
1640             krate: INTERNER.intern_str(self.krate),
1641         });
1642     }
1643 }
1644
1645 #[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
1646 pub struct Crate {
1647     pub compiler: Compiler,
1648     pub target: TargetSelection,
1649     pub mode: Mode,
1650     pub test_kind: TestKind,
1651     pub krate: Interned<String>,
1652 }
1653
1654 impl Step for Crate {
1655     type Output = ();
1656     const DEFAULT: bool = true;
1657
1658     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1659         run.krate("test")
1660     }
1661
1662     fn make_run(run: RunConfig<'_>) {
1663         let builder = run.builder;
1664         let compiler = builder.compiler(builder.top_stage, run.host);
1665
1666         let make = |mode: Mode, krate: &CargoCrate| {
1667             let test_kind = builder.kind.into();
1668
1669             builder.ensure(Crate {
1670                 compiler,
1671                 target: run.target,
1672                 mode,
1673                 test_kind,
1674                 krate: krate.name,
1675             });
1676         };
1677
1678         for krate in builder.in_tree_crates("test") {
1679             if krate.path.ends_with(&run.path) {
1680                 make(Mode::Std, krate);
1681             }
1682         }
1683     }
1684
1685     /// Runs all unit tests plus documentation tests for a given crate defined
1686     /// by a `Cargo.toml` (single manifest)
1687     ///
1688     /// This is what runs tests for crates like the standard library, compiler, etc.
1689     /// It essentially is the driver for running `cargo test`.
1690     ///
1691     /// Currently this runs all tests for a DAG by passing a bunch of `-p foo`
1692     /// arguments, and those arguments are discovered from `cargo metadata`.
1693     fn run(self, builder: &Builder<'_>) {
1694         let compiler = self.compiler;
1695         let target = self.target;
1696         let mode = self.mode;
1697         let test_kind = self.test_kind;
1698         let krate = self.krate;
1699
1700         builder.ensure(compile::Std { compiler, target });
1701         builder.ensure(RemoteCopyLibs { compiler, target });
1702
1703         // If we're not doing a full bootstrap but we're testing a stage2
1704         // version of libstd, then what we're actually testing is the libstd
1705         // produced in stage1. Reflect that here by updating the compiler that
1706         // we're working with automatically.
1707         let compiler = builder.compiler_for(compiler.stage, compiler.host, target);
1708
1709         let mut cargo =
1710             builder.cargo(compiler, mode, SourceType::InTree, target, test_kind.subcommand());
1711         match mode {
1712             Mode::Std => {
1713                 compile::std_cargo(builder, target, compiler.stage, &mut cargo);
1714             }
1715             Mode::Rustc => {
1716                 builder.ensure(compile::Rustc { compiler, target });
1717                 compile::rustc_cargo(builder, &mut cargo, target);
1718             }
1719             _ => panic!("can only test libraries"),
1720         };
1721
1722         // Build up the base `cargo test` command.
1723         //
1724         // Pass in some standard flags then iterate over the graph we've discovered
1725         // in `cargo metadata` with the maps above and figure out what `-p`
1726         // arguments need to get passed.
1727         if test_kind.subcommand() == "test" && !builder.fail_fast {
1728             cargo.arg("--no-fail-fast");
1729         }
1730         match builder.doc_tests {
1731             DocTests::Only => {
1732                 cargo.arg("--doc");
1733             }
1734             DocTests::No => {
1735                 cargo.args(&["--lib", "--bins", "--examples", "--tests", "--benches"]);
1736             }
1737             DocTests::Yes => {}
1738         }
1739
1740         cargo.arg("-p").arg(krate);
1741
1742         // The tests are going to run with the *target* libraries, so we need to
1743         // ensure that those libraries show up in the LD_LIBRARY_PATH equivalent.
1744         //
1745         // Note that to run the compiler we need to run with the *host* libraries,
1746         // but our wrapper scripts arrange for that to be the case anyway.
1747         let mut dylib_path = dylib_path();
1748         dylib_path.insert(0, PathBuf::from(&*builder.sysroot_libdir(compiler, target)));
1749         cargo.env(dylib_path_var(), env::join_paths(&dylib_path).unwrap());
1750
1751         cargo.arg("--");
1752         cargo.args(&builder.config.cmd.test_args());
1753
1754         if !builder.config.verbose_tests {
1755             cargo.arg("--quiet");
1756         }
1757
1758         if target.contains("emscripten") {
1759             cargo.env(
1760                 format!("CARGO_TARGET_{}_RUNNER", envify(&target.triple)),
1761                 builder.config.nodejs.as_ref().expect("nodejs not configured"),
1762             );
1763         } else if target.starts_with("wasm32") {
1764             let node = builder.config.nodejs.as_ref().expect("nodejs not configured");
1765             let runner =
1766                 format!("{} {}/src/etc/wasm32-shim.js", node.display(), builder.src.display());
1767             cargo.env(format!("CARGO_TARGET_{}_RUNNER", envify(&target.triple)), &runner);
1768         } else if builder.remote_tested(target) {
1769             cargo.env(
1770                 format!("CARGO_TARGET_{}_RUNNER", envify(&target.triple)),
1771                 format!("{} run 0", builder.tool_exe(Tool::RemoteTestClient).display()),
1772             );
1773         }
1774
1775         builder.info(&format!(
1776             "{} {} stage{} ({} -> {})",
1777             test_kind, krate, compiler.stage, &compiler.host, target
1778         ));
1779         let _time = util::timeit(&builder);
1780         try_run(builder, &mut cargo.into());
1781     }
1782 }
1783
1784 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1785 pub struct CrateRustdoc {
1786     host: TargetSelection,
1787     test_kind: TestKind,
1788 }
1789
1790 impl Step for CrateRustdoc {
1791     type Output = ();
1792     const DEFAULT: bool = true;
1793     const ONLY_HOSTS: bool = true;
1794
1795     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1796         run.paths(&["src/librustdoc", "src/tools/rustdoc"])
1797     }
1798
1799     fn make_run(run: RunConfig<'_>) {
1800         let builder = run.builder;
1801
1802         let test_kind = builder.kind.into();
1803
1804         builder.ensure(CrateRustdoc { host: run.host, test_kind });
1805     }
1806
1807     fn run(self, builder: &Builder<'_>) {
1808         let test_kind = self.test_kind;
1809         let target = self.host;
1810
1811         // Use the previous stage compiler to reuse the artifacts that are
1812         // created when running compiletest for src/test/rustdoc. If this used
1813         // `compiler`, then it would cause rustdoc to be built *again*, which
1814         // isn't really necessary.
1815         let compiler = builder.compiler_for(builder.top_stage, target, target);
1816         builder.ensure(compile::Rustc { compiler, target });
1817
1818         let mut cargo = tool::prepare_tool_cargo(
1819             builder,
1820             compiler,
1821             Mode::ToolRustc,
1822             target,
1823             test_kind.subcommand(),
1824             "src/tools/rustdoc",
1825             SourceType::InTree,
1826             &[],
1827         );
1828         if test_kind.subcommand() == "test" && !builder.fail_fast {
1829             cargo.arg("--no-fail-fast");
1830         }
1831
1832         cargo.arg("-p").arg("rustdoc:0.0.0");
1833
1834         cargo.arg("--");
1835         cargo.args(&builder.config.cmd.test_args());
1836
1837         if self.host.contains("musl") {
1838             cargo.arg("'-Ctarget-feature=-crt-static'");
1839         }
1840
1841         // This is needed for running doctests on librustdoc. This is a bit of
1842         // an unfortunate interaction with how bootstrap works and how cargo
1843         // sets up the dylib path, and the fact that the doctest (in
1844         // html/markdown.rs) links to rustc-private libs. For stage1, the
1845         // compiler host dylibs (in stage1/lib) are not the same as the target
1846         // dylibs (in stage1/lib/rustlib/...). This is different from a normal
1847         // rust distribution where they are the same.
1848         //
1849         // On the cargo side, normal tests use `target_process` which handles
1850         // setting up the dylib for a *target* (stage1/lib/rustlib/... in this
1851         // case). However, for doctests it uses `rustdoc_process` which only
1852         // sets up the dylib path for the *host* (stage1/lib), which is the
1853         // wrong directory.
1854         //
1855         // It should be considered to just stop running doctests on
1856         // librustdoc. There is only one test, and it doesn't look too
1857         // important. There might be other ways to avoid this, but it seems
1858         // pretty convoluted.
1859         //
1860         // See also https://github.com/rust-lang/rust/issues/13983 where the
1861         // host vs target dylibs for rustdoc are consistently tricky to deal
1862         // with.
1863         let mut dylib_path = dylib_path();
1864         dylib_path.insert(0, PathBuf::from(&*builder.sysroot_libdir(compiler, target)));
1865         cargo.env(dylib_path_var(), env::join_paths(&dylib_path).unwrap());
1866
1867         if !builder.config.verbose_tests {
1868             cargo.arg("--quiet");
1869         }
1870
1871         builder.info(&format!(
1872             "{} rustdoc stage{} ({} -> {})",
1873             test_kind, compiler.stage, &compiler.host, target
1874         ));
1875         let _time = util::timeit(&builder);
1876
1877         try_run(builder, &mut cargo.into());
1878     }
1879 }
1880
1881 /// Some test suites are run inside emulators or on remote devices, and most
1882 /// of our test binaries are linked dynamically which means we need to ship
1883 /// the standard library and such to the emulator ahead of time. This step
1884 /// represents this and is a dependency of all test suites.
1885 ///
1886 /// Most of the time this is a no-op. For some steps such as shipping data to
1887 /// QEMU we have to build our own tools so we've got conditional dependencies
1888 /// on those programs as well. Note that the remote test client is built for
1889 /// the build target (us) and the server is built for the target.
1890 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1891 pub struct RemoteCopyLibs {
1892     compiler: Compiler,
1893     target: TargetSelection,
1894 }
1895
1896 impl Step for RemoteCopyLibs {
1897     type Output = ();
1898
1899     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1900         run.never()
1901     }
1902
1903     fn run(self, builder: &Builder<'_>) {
1904         let compiler = self.compiler;
1905         let target = self.target;
1906         if !builder.remote_tested(target) {
1907             return;
1908         }
1909
1910         builder.ensure(compile::Std { compiler, target });
1911
1912         builder.info(&format!("REMOTE copy libs to emulator ({})", target));
1913         t!(fs::create_dir_all(builder.out.join("tmp")));
1914
1915         let server =
1916             builder.ensure(tool::RemoteTestServer { compiler: compiler.with_stage(0), target });
1917
1918         // Spawn the emulator and wait for it to come online
1919         let tool = builder.tool_exe(Tool::RemoteTestClient);
1920         let mut cmd = Command::new(&tool);
1921         cmd.arg("spawn-emulator").arg(target.triple).arg(&server).arg(builder.out.join("tmp"));
1922         if let Some(rootfs) = builder.qemu_rootfs(target) {
1923             cmd.arg(rootfs);
1924         }
1925         builder.run(&mut cmd);
1926
1927         // Push all our dylibs to the emulator
1928         for f in t!(builder.sysroot_libdir(compiler, target).read_dir()) {
1929             let f = t!(f);
1930             let name = f.file_name().into_string().unwrap();
1931             if util::is_dylib(&name) {
1932                 builder.run(Command::new(&tool).arg("push").arg(f.path()));
1933             }
1934         }
1935     }
1936 }
1937
1938 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1939 pub struct Distcheck;
1940
1941 impl Step for Distcheck {
1942     type Output = ();
1943
1944     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1945         run.path("distcheck")
1946     }
1947
1948     fn make_run(run: RunConfig<'_>) {
1949         run.builder.ensure(Distcheck);
1950     }
1951
1952     /// Runs "distcheck", a 'make check' from a tarball
1953     fn run(self, builder: &Builder<'_>) {
1954         builder.info("Distcheck");
1955         let dir = builder.out.join("tmp").join("distcheck");
1956         let _ = fs::remove_dir_all(&dir);
1957         t!(fs::create_dir_all(&dir));
1958
1959         // Guarantee that these are built before we begin running.
1960         builder.ensure(dist::PlainSourceTarball);
1961         builder.ensure(dist::Src);
1962
1963         let mut cmd = Command::new("tar");
1964         cmd.arg("-xzf")
1965             .arg(builder.ensure(dist::PlainSourceTarball))
1966             .arg("--strip-components=1")
1967             .current_dir(&dir);
1968         builder.run(&mut cmd);
1969         builder.run(
1970             Command::new("./configure")
1971                 .args(&builder.config.configure_args)
1972                 .arg("--enable-vendor")
1973                 .current_dir(&dir),
1974         );
1975         builder.run(
1976             Command::new(build_helper::make(&builder.config.build.triple))
1977                 .arg("check")
1978                 .current_dir(&dir),
1979         );
1980
1981         // Now make sure that rust-src has all of libstd's dependencies
1982         builder.info("Distcheck rust-src");
1983         let dir = builder.out.join("tmp").join("distcheck-src");
1984         let _ = fs::remove_dir_all(&dir);
1985         t!(fs::create_dir_all(&dir));
1986
1987         let mut cmd = Command::new("tar");
1988         cmd.arg("-xzf")
1989             .arg(builder.ensure(dist::Src))
1990             .arg("--strip-components=1")
1991             .current_dir(&dir);
1992         builder.run(&mut cmd);
1993
1994         let toml = dir.join("rust-src/lib/rustlib/src/rust/library/std/Cargo.toml");
1995         builder.run(
1996             Command::new(&builder.initial_cargo)
1997                 .arg("generate-lockfile")
1998                 .arg("--manifest-path")
1999                 .arg(&toml)
2000                 .current_dir(&dir),
2001         );
2002     }
2003 }
2004
2005 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2006 pub struct Bootstrap;
2007
2008 impl Step for Bootstrap {
2009     type Output = ();
2010     const DEFAULT: bool = true;
2011     const ONLY_HOSTS: bool = true;
2012
2013     /// Tests the build system itself.
2014     fn run(self, builder: &Builder<'_>) {
2015         let mut cmd = Command::new(&builder.initial_cargo);
2016         cmd.arg("test")
2017             .current_dir(builder.src.join("src/bootstrap"))
2018             .env("RUSTFLAGS", "-Cdebuginfo=2")
2019             .env("CARGO_TARGET_DIR", builder.out.join("bootstrap"))
2020             .env("RUSTC_BOOTSTRAP", "1")
2021             .env("RUSTC", &builder.initial_rustc);
2022         if let Some(flags) = option_env!("RUSTFLAGS") {
2023             // Use the same rustc flags for testing as for "normal" compilation,
2024             // so that Cargo doesn’t recompile the entire dependency graph every time:
2025             // https://github.com/rust-lang/rust/issues/49215
2026             cmd.env("RUSTFLAGS", flags);
2027         }
2028         if !builder.fail_fast {
2029             cmd.arg("--no-fail-fast");
2030         }
2031         cmd.arg("--").args(&builder.config.cmd.test_args());
2032         // rustbuild tests are racy on directory creation so just run them one at a time.
2033         // Since there's not many this shouldn't be a problem.
2034         cmd.arg("--test-threads=1");
2035         try_run(builder, &mut cmd);
2036     }
2037
2038     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2039         run.path("src/bootstrap")
2040     }
2041
2042     fn make_run(run: RunConfig<'_>) {
2043         run.builder.ensure(Bootstrap);
2044     }
2045 }