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