src/bootstrap/test.rs

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