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