1 //! Implementation of the test-related targets of the build system.
3 //! This file implements the various regression test suites that we execute on
7 use std::ffi::OsString;
11 use std::path::{Path, PathBuf};
12 use std::process::{Command, Stdio};
14 use build_helper::{self, output, t};
16 use crate::builder::{Builder, Compiler, Kind, RunConfig, ShouldRun, Step};
17 use crate::cache::Interned;
19 use crate::config::TargetSelection;
21 use crate::flags::Subcommand;
23 use crate::tool::{self, SourceType, Tool};
24 use crate::toolstate::ToolState;
25 use crate::util::{self, add_link_lib_path, dylib_path, dylib_path_var};
26 use crate::Crate as CargoCrate;
27 use crate::{envify, DocTests, GitRepo, Mode};
29 const ADB_TEST_DIR: &str = "/data/tmp/work";
31 /// The two modes of the test runner; tests or benchmarks.
32 #[derive(Debug, PartialEq, Eq, Hash, Copy, Clone, PartialOrd, Ord)]
36 /// Run `cargo bench`.
40 impl From<Kind> for TestKind {
41 fn from(kind: Kind) -> Self {
43 Kind::Test => TestKind::Test,
44 Kind::Bench => TestKind::Bench,
45 _ => panic!("unexpected kind in crate: {:?}", kind),
51 // Return the cargo subcommand for this test kind
52 fn subcommand(self) -> &'static str {
54 TestKind::Test => "test",
55 TestKind::Bench => "bench",
60 impl fmt::Display for TestKind {
61 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
62 f.write_str(match *self {
63 TestKind::Test => "Testing",
64 TestKind::Bench => "Benchmarking",
69 fn try_run(builder: &Builder<'_>, cmd: &mut Command) -> bool {
70 if !builder.fail_fast {
71 if !builder.try_run(cmd) {
72 let mut failures = builder.delayed_failures.borrow_mut();
73 failures.push(format!("{:?}", cmd));
82 fn try_run_quiet(builder: &Builder<'_>, cmd: &mut Command) -> bool {
83 if !builder.fail_fast {
84 if !builder.try_run_quiet(cmd) {
85 let mut failures = builder.delayed_failures.borrow_mut();
86 failures.push(format!("{:?}", cmd));
90 builder.run_quiet(cmd);
95 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
96 pub struct Linkcheck {
97 host: TargetSelection,
100 impl Step for Linkcheck {
102 const ONLY_HOSTS: bool = true;
103 const DEFAULT: bool = true;
105 /// Runs the `linkchecker` tool as compiled in `stage` by the `host` compiler.
107 /// This tool in `src/tools` will verify the validity of all our links in the
108 /// documentation to ensure we don't have a bunch of dead ones.
109 fn run(self, builder: &Builder<'_>) {
110 let host = self.host;
111 let hosts = &builder.hosts;
112 let targets = &builder.targets;
114 // if we have different hosts and targets, some things may be built for
115 // the host (e.g. rustc) and others for the target (e.g. std). The
116 // documentation built for each will contain broken links to
117 // docs built for the other platform (e.g. rustc linking to cargo)
118 if (hosts != targets) && !hosts.is_empty() && !targets.is_empty() {
120 "Linkcheck currently does not support builds with different hosts and targets.
121 You can skip linkcheck with --exclude src/tools/linkchecker"
125 builder.info(&format!("Linkcheck ({})", host));
127 // Test the linkchecker itself.
128 let bootstrap_host = builder.config.build;
129 let compiler = builder.compiler(0, bootstrap_host);
130 let cargo = tool::prepare_tool_cargo(
136 "src/tools/linkchecker",
140 try_run(builder, &mut cargo.into());
142 // Build all the default documentation.
143 builder.default_doc(&[]);
145 // Run the linkchecker.
146 let _time = util::timeit(&builder);
149 builder.tool_cmd(Tool::Linkchecker).arg(builder.out.join(host.triple).join("doc")),
153 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
154 let builder = run.builder;
155 let run = run.path("src/tools/linkchecker");
156 run.default_condition(builder.config.docs)
159 fn make_run(run: RunConfig<'_>) {
160 run.builder.ensure(Linkcheck { host: run.target });
164 fn check_if_tidy_is_installed() -> bool {
167 .stdout(Stdio::null())
169 .map_or(false, |status| status.success())
172 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
173 pub struct HtmlCheck {
174 target: TargetSelection,
177 impl Step for HtmlCheck {
179 const DEFAULT: bool = true;
180 const ONLY_HOSTS: bool = true;
182 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
183 let run = run.path("src/tools/html-checker");
184 run.lazy_default_condition(Box::new(check_if_tidy_is_installed))
187 fn make_run(run: RunConfig<'_>) {
188 run.builder.ensure(HtmlCheck { target: run.target });
191 fn run(self, builder: &Builder<'_>) {
192 if !check_if_tidy_is_installed() {
193 eprintln!("not running HTML-check tool because `tidy` is missing");
195 "Note that `tidy` is not the in-tree `src/tools/tidy` but needs to be installed"
197 panic!("Cannot run html-check tests");
199 // Ensure that a few different kinds of documentation are available.
200 builder.default_doc(&[]);
201 builder.ensure(crate::doc::Rustc { target: self.target, stage: builder.top_stage });
203 try_run(builder, builder.tool_cmd(Tool::HtmlChecker).arg(builder.doc_out(self.target)));
207 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
208 pub struct Cargotest {
210 host: TargetSelection,
213 impl Step for Cargotest {
215 const ONLY_HOSTS: bool = true;
217 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
218 run.path("src/tools/cargotest")
221 fn make_run(run: RunConfig<'_>) {
222 run.builder.ensure(Cargotest { stage: run.builder.top_stage, host: run.target });
225 /// Runs the `cargotest` tool as compiled in `stage` by the `host` compiler.
227 /// This tool in `src/tools` will check out a few Rust projects and run `cargo
228 /// test` to ensure that we don't regress the test suites there.
229 fn run(self, builder: &Builder<'_>) {
230 let compiler = builder.compiler(self.stage, self.host);
231 builder.ensure(compile::Rustc { compiler, target: compiler.host });
232 let cargo = builder.ensure(tool::Cargo { compiler, target: compiler.host });
234 // Note that this is a short, cryptic, and not scoped directory name. This
235 // is currently to minimize the length of path on Windows where we otherwise
236 // quickly run into path name limit constraints.
237 let out_dir = builder.out.join("ct");
238 t!(fs::create_dir_all(&out_dir));
240 let _time = util::timeit(&builder);
241 let mut cmd = builder.tool_cmd(Tool::CargoTest);
246 .args(builder.config.cmd.test_args())
247 .env("RUSTC", builder.rustc(compiler))
248 .env("RUSTDOC", builder.rustdoc(compiler)),
253 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
256 host: TargetSelection,
259 impl Step for Cargo {
261 const ONLY_HOSTS: bool = true;
263 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
264 run.path("src/tools/cargo")
267 fn make_run(run: RunConfig<'_>) {
268 run.builder.ensure(Cargo { stage: run.builder.top_stage, host: run.target });
271 /// Runs `cargo test` for `cargo` packaged with Rust.
272 fn run(self, builder: &Builder<'_>) {
273 let compiler = builder.compiler(self.stage, self.host);
275 builder.ensure(tool::Cargo { compiler, target: self.host });
276 let mut cargo = tool::prepare_tool_cargo(
283 SourceType::Submodule,
287 if !builder.fail_fast {
288 cargo.arg("--no-fail-fast");
290 cargo.arg("--").args(builder.config.cmd.test_args());
292 // Don't run cross-compile tests, we may not have cross-compiled libstd libs
294 cargo.env("CFG_DISABLE_CROSS_TESTS", "1");
295 // Disable a test that has issues with mingw.
296 cargo.env("CARGO_TEST_DISABLE_GIT_CLI", "1");
297 // Forcibly disable tests using nightly features since any changes to
298 // those features won't be able to land.
299 cargo.env("CARGO_TEST_DISABLE_NIGHTLY", "1");
301 cargo.env("PATH", &path_for_cargo(builder, compiler));
303 try_run(builder, &mut cargo.into());
307 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
310 host: TargetSelection,
315 const ONLY_HOSTS: bool = true;
317 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
318 run.path("src/tools/rls")
321 fn make_run(run: RunConfig<'_>) {
322 run.builder.ensure(Rls { stage: run.builder.top_stage, host: run.target });
325 /// Runs `cargo test` for the rls.
326 fn run(self, builder: &Builder<'_>) {
327 let stage = self.stage;
328 let host = self.host;
329 let compiler = builder.compiler(stage, host);
332 builder.ensure(tool::Rls { compiler, target: self.host, extra_features: Vec::new() });
333 if build_result.is_none() {
334 eprintln!("failed to test rls: could not build");
338 let mut cargo = tool::prepare_tool_cargo(
345 SourceType::Submodule,
349 cargo.add_rustc_lib_path(builder, compiler);
350 cargo.arg("--").args(builder.config.cmd.test_args());
352 if try_run(builder, &mut cargo.into()) {
353 builder.save_toolstate("rls", ToolState::TestPass);
358 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
361 host: TargetSelection,
364 impl Step for Rustfmt {
366 const ONLY_HOSTS: bool = true;
368 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
369 run.path("src/tools/rustfmt")
372 fn make_run(run: RunConfig<'_>) {
373 run.builder.ensure(Rustfmt { stage: run.builder.top_stage, host: run.target });
376 /// Runs `cargo test` for rustfmt.
377 fn run(self, builder: &Builder<'_>) {
378 let stage = self.stage;
379 let host = self.host;
380 let compiler = builder.compiler(stage, host);
383 .ensure(tool::Rustfmt { compiler, target: self.host, extra_features: Vec::new() })
384 .expect("in-tree tool");
386 let mut cargo = tool::prepare_tool_cargo(
393 SourceType::Submodule,
397 let dir = testdir(builder, compiler.host);
398 t!(fs::create_dir_all(&dir));
399 cargo.env("RUSTFMT_TEST_DIR", dir);
401 cargo.add_rustc_lib_path(builder, compiler);
403 builder.run(&mut cargo.into());
407 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
408 pub struct RustDemangler {
410 host: TargetSelection,
413 impl Step for RustDemangler {
415 const ONLY_HOSTS: bool = true;
417 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
418 run.path("src/tools/rust-demangler")
421 fn make_run(run: RunConfig<'_>) {
422 run.builder.ensure(RustDemangler { stage: run.builder.top_stage, host: run.target });
425 /// Runs `cargo test` for rust-demangler.
426 fn run(self, builder: &Builder<'_>) {
427 let stage = self.stage;
428 let host = self.host;
429 let compiler = builder.compiler(stage, host);
431 let rust_demangler = builder
432 .ensure(tool::RustDemangler { compiler, target: self.host, extra_features: Vec::new() })
433 .expect("in-tree tool");
434 let mut cargo = tool::prepare_tool_cargo(
440 "src/tools/rust-demangler",
445 let dir = testdir(builder, compiler.host);
446 t!(fs::create_dir_all(&dir));
448 cargo.env("RUST_DEMANGLER_DRIVER_PATH", rust_demangler);
450 cargo.arg("--").args(builder.config.cmd.test_args());
452 cargo.add_rustc_lib_path(builder, compiler);
454 builder.run(&mut cargo.into());
458 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
461 host: TargetSelection,
466 const ONLY_HOSTS: bool = true;
468 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
469 run.path("src/tools/miri")
472 fn make_run(run: RunConfig<'_>) {
473 run.builder.ensure(Miri { stage: run.builder.top_stage, host: run.target });
476 /// Runs `cargo test` for miri.
477 fn run(self, builder: &Builder<'_>) {
478 let stage = self.stage;
479 let host = self.host;
480 let compiler = builder.compiler(stage, host);
483 builder.ensure(tool::Miri { compiler, target: self.host, extra_features: Vec::new() });
484 let cargo_miri = builder.ensure(tool::CargoMiri {
487 extra_features: Vec::new(),
489 if let (Some(miri), Some(_cargo_miri)) = (miri, cargo_miri) {
491 builder.cargo(compiler, Mode::ToolRustc, SourceType::Submodule, host, "install");
493 // Configure `cargo install` path. cargo adds a `bin/`.
494 cargo.env("CARGO_INSTALL_ROOT", &builder.out);
496 let mut cargo = Command::from(cargo);
497 if !try_run(builder, &mut cargo) {
501 // # Run `cargo miri setup`.
502 let mut cargo = tool::prepare_tool_cargo(
508 "src/tools/miri/cargo-miri",
509 SourceType::Submodule,
512 cargo.add_rustc_lib_path(builder, compiler);
513 cargo.arg("--").arg("miri").arg("setup");
515 // Tell `cargo miri setup` where to find the sources.
516 cargo.env("XARGO_RUST_SRC", builder.src.join("library"));
517 // Tell it where to find Miri.
518 cargo.env("MIRI", &miri);
520 cargo.env("RUST_BACKTRACE", "1");
521 // Let cargo-miri know where xargo ended up.
522 cargo.env("XARGO_CHECK", builder.out.join("bin").join("xargo-check"));
524 let mut cargo = Command::from(cargo);
525 if !try_run(builder, &mut cargo) {
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");
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 {
540 builder.verbose(&format!("running: {:?}", cargo));
543 .expect("We already ran `cargo miri setup` before and that worked");
544 assert!(out.status.success(), "`cargo miri setup` returned with non-0 exit code");
545 // Output is "<sysroot>\n".
546 let stdout = String::from_utf8(out.stdout)
547 .expect("`cargo miri setup` stdout is not valid UTF-8");
548 let sysroot = stdout.trim_end();
549 builder.verbose(&format!("`cargo miri setup --print-sysroot` said: {:?}", sysroot));
553 // # Run `cargo test`.
554 let mut cargo = tool::prepare_tool_cargo(
561 SourceType::Submodule,
564 cargo.add_rustc_lib_path(builder, compiler);
566 // miri tests need to know about the stage sysroot
567 cargo.env("MIRI_SYSROOT", miri_sysroot);
568 cargo.env("RUSTC_LIB_PATH", builder.rustc_libdir(compiler));
569 cargo.env("MIRI", miri);
571 cargo.arg("--").args(builder.config.cmd.test_args());
573 let mut cargo = Command::from(cargo);
574 if !try_run(builder, &mut cargo) {
578 // # Run `cargo test` with `-Zmir-opt-level=4`.
579 cargo.env("MIRIFLAGS", "-O -Zmir-opt-level=4");
580 if !try_run(builder, &mut cargo) {
585 builder.save_toolstate("miri", ToolState::TestPass);
587 eprintln!("failed to test miri: could not build");
592 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
593 pub struct CompiletestTest {
594 host: TargetSelection,
597 impl Step for CompiletestTest {
600 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
601 run.path("src/tools/compiletest")
604 fn make_run(run: RunConfig<'_>) {
605 run.builder.ensure(CompiletestTest { host: run.target });
608 /// Runs `cargo test` for compiletest.
609 fn run(self, builder: &Builder<'_>) {
610 let host = self.host;
611 let compiler = builder.compiler(0, host);
613 // We need `ToolStd` for the locally-built sysroot because
614 // compiletest uses unstable features of the `test` crate.
615 builder.ensure(compile::Std { compiler, target: host });
616 let cargo = tool::prepare_tool_cargo(
622 "src/tools/compiletest",
627 try_run(builder, &mut cargo.into());
631 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
634 host: TargetSelection,
637 impl Step for Clippy {
639 const ONLY_HOSTS: bool = true;
640 const DEFAULT: bool = false;
642 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
643 run.path("src/tools/clippy")
646 fn make_run(run: RunConfig<'_>) {
647 run.builder.ensure(Clippy { stage: run.builder.top_stage, host: run.target });
650 /// Runs `cargo test` for clippy.
651 fn run(self, builder: &Builder<'_>) {
652 let stage = self.stage;
653 let host = self.host;
654 let compiler = builder.compiler(stage, host);
657 .ensure(tool::Clippy { compiler, target: self.host, extra_features: Vec::new() })
658 .expect("in-tree tool");
659 let mut cargo = tool::prepare_tool_cargo(
670 // clippy tests need to know about the stage sysroot
671 cargo.env("SYSROOT", builder.sysroot(compiler));
672 cargo.env("RUSTC_TEST_SUITE", builder.rustc(compiler));
673 cargo.env("RUSTC_LIB_PATH", builder.rustc_libdir(compiler));
674 let host_libs = builder.stage_out(compiler, Mode::ToolRustc).join(builder.cargo_dir());
675 let target_libs = builder
676 .stage_out(compiler, Mode::ToolRustc)
677 .join(&self.host.triple)
678 .join(builder.cargo_dir());
679 cargo.env("HOST_LIBS", host_libs);
680 cargo.env("TARGET_LIBS", target_libs);
681 // clippy tests need to find the driver
682 cargo.env("CLIPPY_DRIVER_PATH", clippy);
684 cargo.arg("--").args(builder.config.cmd.test_args());
686 cargo.add_rustc_lib_path(builder, compiler);
688 if builder.try_run(&mut cargo.into()) {
689 // The tests succeeded; nothing to do.
693 if !builder.config.cmd.bless() {
694 std::process::exit(1);
697 let mut cargo = builder.cargo(compiler, Mode::ToolRustc, SourceType::InTree, host, "run");
698 cargo.arg("-p").arg("clippy_dev");
699 // clippy_dev gets confused if it can't find `clippy/Cargo.toml`
700 cargo.current_dir(&builder.src.join("src").join("tools").join("clippy"));
701 if builder.config.rust_optimize {
702 cargo.env("PROFILE", "release");
704 cargo.env("PROFILE", "debug");
708 builder.run(&mut cargo.into());
712 fn path_for_cargo(builder: &Builder<'_>, compiler: Compiler) -> OsString {
713 // Configure PATH to find the right rustc. NB. we have to use PATH
714 // and not RUSTC because the Cargo test suite has tests that will
715 // fail if rustc is not spelled `rustc`.
716 let path = builder.sysroot(compiler).join("bin");
717 let old_path = env::var_os("PATH").unwrap_or_default();
718 env::join_paths(iter::once(path).chain(env::split_paths(&old_path))).expect("")
721 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
722 pub struct RustdocTheme {
723 pub compiler: Compiler,
726 impl Step for RustdocTheme {
728 const DEFAULT: bool = true;
729 const ONLY_HOSTS: bool = true;
731 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
732 run.path("src/tools/rustdoc-themes")
735 fn make_run(run: RunConfig<'_>) {
736 let compiler = run.builder.compiler(run.builder.top_stage, run.target);
738 run.builder.ensure(RustdocTheme { compiler });
741 fn run(self, builder: &Builder<'_>) {
742 let rustdoc = builder.out.join("bootstrap/debug/rustdoc");
743 let mut cmd = builder.tool_cmd(Tool::RustdocTheme);
744 cmd.arg(rustdoc.to_str().unwrap())
745 .arg(builder.src.join("src/librustdoc/html/static/css/themes").to_str().unwrap())
746 .env("RUSTC_STAGE", self.compiler.stage.to_string())
747 .env("RUSTC_SYSROOT", builder.sysroot(self.compiler))
748 .env("RUSTDOC_LIBDIR", builder.sysroot_libdir(self.compiler, self.compiler.host))
749 .env("CFG_RELEASE_CHANNEL", &builder.config.channel)
750 .env("RUSTDOC_REAL", builder.rustdoc(self.compiler))
751 .env("RUSTC_BOOTSTRAP", "1");
752 if let Some(linker) = builder.linker(self.compiler.host) {
753 cmd.env("RUSTDOC_LINKER", linker);
755 if builder.is_fuse_ld_lld(self.compiler.host) {
756 cmd.env("RUSTDOC_FUSE_LD_LLD", "1");
758 try_run(builder, &mut cmd);
762 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
763 pub struct RustdocJSStd {
764 pub target: TargetSelection,
767 impl Step for RustdocJSStd {
769 const DEFAULT: bool = true;
770 const ONLY_HOSTS: bool = true;
772 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
773 run.path("src/test/rustdoc-js-std")
776 fn make_run(run: RunConfig<'_>) {
777 run.builder.ensure(RustdocJSStd { target: run.target });
780 fn run(self, builder: &Builder<'_>) {
781 if let Some(ref nodejs) = builder.config.nodejs {
782 let mut command = Command::new(nodejs);
784 .arg(builder.src.join("src/tools/rustdoc-js/tester.js"))
787 .arg("--resource-suffix")
788 .arg(&builder.version)
790 .arg(builder.doc_out(self.target))
791 .arg("--test-folder")
792 .arg(builder.src.join("src/test/rustdoc-js-std"));
793 builder.ensure(crate::doc::Std { target: self.target, stage: builder.top_stage });
794 builder.run(&mut command);
796 builder.info("No nodejs found, skipping \"src/test/rustdoc-js-std\" tests");
801 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
802 pub struct RustdocJSNotStd {
803 pub target: TargetSelection,
804 pub compiler: Compiler,
807 impl Step for RustdocJSNotStd {
809 const DEFAULT: bool = true;
810 const ONLY_HOSTS: bool = true;
812 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
813 run.path("src/test/rustdoc-js")
816 fn make_run(run: RunConfig<'_>) {
817 let compiler = run.builder.compiler(run.builder.top_stage, run.build_triple());
818 run.builder.ensure(RustdocJSNotStd { target: run.target, compiler });
821 fn run(self, builder: &Builder<'_>) {
822 if builder.config.nodejs.is_some() {
823 builder.ensure(Compiletest {
824 compiler: self.compiler,
828 path: "src/test/rustdoc-js",
832 builder.info("No nodejs found, skipping \"src/test/rustdoc-js\" tests");
837 fn check_if_browser_ui_test_is_installed_global(npm: &Path, global: bool) -> bool {
838 let mut command = Command::new(&npm);
839 command.arg("list").arg("--depth=0");
841 command.arg("--global");
845 .map(|output| String::from_utf8_lossy(&output.stdout).into_owned())
846 .unwrap_or(String::new());
847 lines.contains(&" browser-ui-test@")
850 fn check_if_browser_ui_test_is_installed(npm: &Path) -> bool {
851 check_if_browser_ui_test_is_installed_global(npm, false)
852 || check_if_browser_ui_test_is_installed_global(npm, true)
855 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
856 pub struct RustdocGUI {
857 pub target: TargetSelection,
858 pub compiler: Compiler,
861 impl Step for RustdocGUI {
863 const DEFAULT: bool = true;
864 const ONLY_HOSTS: bool = true;
866 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
867 let builder = run.builder;
868 let run = run.suite_path("src/test/rustdoc-gui");
869 run.lazy_default_condition(Box::new(move || {
870 builder.config.nodejs.is_some()
875 .map(|p| check_if_browser_ui_test_is_installed(p))
880 fn make_run(run: RunConfig<'_>) {
881 let compiler = run.builder.compiler(run.builder.top_stage, run.build_triple());
882 run.builder.ensure(RustdocGUI { target: run.target, compiler });
885 fn run(self, builder: &Builder<'_>) {
886 let nodejs = builder.config.nodejs.as_ref().expect("nodejs isn't available");
887 let npm = builder.config.npm.as_ref().expect("npm isn't available");
889 builder.ensure(compile::Std { compiler: self.compiler, target: self.target });
891 // The goal here is to check if the necessary packages are installed, and if not, we
893 if !check_if_browser_ui_test_is_installed(&npm) {
895 "error: rustdoc-gui test suite cannot be run because npm `browser-ui-test` \
896 dependency is missing",
899 "If you want to install the `{0}` dependency, run `npm install {0}`",
902 panic!("Cannot run rustdoc-gui tests");
905 let out_dir = builder.test_out(self.target).join("rustdoc-gui");
907 // We remove existing folder to be sure there won't be artifacts remaining.
908 let _ = fs::remove_dir_all(&out_dir);
910 let src_path = "src/test/rustdoc-gui/src";
911 // We generate docs for the libraries present in the rustdoc-gui's src folder.
912 let mut cargo = Command::new(&builder.initial_cargo);
918 .env("RUSTDOC", builder.rustdoc(self.compiler))
919 .env("RUSTC", builder.rustc(self.compiler))
920 .current_dir(&builder.build.src.join(src_path));
921 builder.run(&mut cargo);
923 // We now run GUI tests.
924 let mut command = Command::new(&nodejs);
926 .arg(builder.build.src.join("src/tools/rustdoc-gui/tester.js"))
928 .arg(out_dir.join("doc"))
929 .arg("--tests-folder")
930 .arg(builder.build.src.join("src/test/rustdoc-gui"));
931 for path in &builder.paths {
932 if let Some(name) = path.file_name().and_then(|f| f.to_str()) {
933 if name.ends_with(".goml") {
934 command.arg("--file").arg(name);
938 for test_arg in builder.config.cmd.test_args() {
939 command.arg(test_arg);
941 builder.run(&mut command);
945 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
950 const DEFAULT: bool = true;
951 const ONLY_HOSTS: bool = true;
953 /// Runs the `tidy` tool.
955 /// This tool in `src/tools` checks up on various bits and pieces of style and
956 /// otherwise just implements a few lint-like checks that are specific to the
959 /// Once tidy passes, this step also runs `fmt --check` if tests are being run
960 /// for the `dev` or `nightly` channels.
961 fn run(self, builder: &Builder<'_>) {
962 let mut cmd = builder.tool_cmd(Tool::Tidy);
963 cmd.arg(&builder.src);
964 cmd.arg(&builder.initial_cargo);
965 cmd.arg(&builder.out);
966 cmd.arg(builder.jobs().to_string());
967 if builder.is_verbose() {
968 cmd.arg("--verbose");
971 builder.info("tidy check");
972 try_run(builder, &mut cmd);
974 if builder.config.channel == "dev" || builder.config.channel == "nightly" {
975 builder.info("fmt check");
976 if builder.config.initial_rustfmt.is_none() {
977 let inferred_rustfmt_dir = builder.config.initial_rustc.parent().unwrap();
980 error: no `rustfmt` binary found in {PATH}
981 info: `rust.channel` is currently set to \"{CHAN}\"
982 help: if you are testing a beta branch, set `rust.channel` to \"beta\" in the `config.toml` file
983 help: to skip test's attempt to check tidiness, pass `--exclude src/tools/tidy` to `x.py test`",
984 PATH = inferred_rustfmt_dir.display(),
985 CHAN = builder.config.channel,
987 std::process::exit(1);
989 crate::format::format(&builder.build, !builder.config.cmd.bless(), &[]);
993 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
994 run.path("src/tools/tidy")
997 fn make_run(run: RunConfig<'_>) {
998 run.builder.ensure(Tidy);
1002 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1003 pub struct ExpandYamlAnchors;
1005 impl Step for ExpandYamlAnchors {
1007 const ONLY_HOSTS: bool = true;
1009 /// Ensure the `generate-ci-config` tool was run locally.
1011 /// The tool in `src/tools` reads the CI definition in `src/ci/builders.yml` and generates the
1012 /// appropriate configuration for all our CI providers. This step ensures the tool was called
1013 /// by the user before committing CI changes.
1014 fn run(self, builder: &Builder<'_>) {
1015 builder.info("Ensuring the YAML anchors in the GitHub Actions config were expanded");
1018 &mut builder.tool_cmd(Tool::ExpandYamlAnchors).arg("check").arg(&builder.src),
1022 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1023 run.path("src/tools/expand-yaml-anchors")
1026 fn make_run(run: RunConfig<'_>) {
1027 run.builder.ensure(ExpandYamlAnchors);
1031 fn testdir(builder: &Builder<'_>, host: TargetSelection) -> PathBuf {
1032 builder.out.join(host.triple).join("test")
1035 macro_rules! default_test {
1036 ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr }) => {
1037 test!($name { path: $path, mode: $mode, suite: $suite, default: true, host: false });
1041 macro_rules! default_test_with_compare_mode {
1042 ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr,
1043 compare_mode: $compare_mode:expr }) => {
1044 test_with_compare_mode!($name {
1050 compare_mode: $compare_mode
1055 macro_rules! host_test {
1056 ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr }) => {
1057 test!($name { path: $path, mode: $mode, suite: $suite, default: true, host: true });
1062 ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr, default: $default:expr,
1063 host: $host:expr }) => {
1064 test_definitions!($name {
1075 macro_rules! test_with_compare_mode {
1076 ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr, default: $default:expr,
1077 host: $host:expr, compare_mode: $compare_mode:expr }) => {
1078 test_definitions!($name {
1084 compare_mode: Some($compare_mode)
1089 macro_rules! test_definitions {
1094 default: $default:expr,
1096 compare_mode: $compare_mode:expr
1098 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1100 pub compiler: Compiler,
1101 pub target: TargetSelection,
1104 impl Step for $name {
1106 const DEFAULT: bool = $default;
1107 const ONLY_HOSTS: bool = $host;
1109 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1110 run.suite_path($path)
1113 fn make_run(run: RunConfig<'_>) {
1114 let compiler = run.builder.compiler(run.builder.top_stage, run.build_triple());
1116 run.builder.ensure($name { compiler, target: run.target });
1119 fn run(self, builder: &Builder<'_>) {
1120 builder.ensure(Compiletest {
1121 compiler: self.compiler,
1122 target: self.target,
1126 compare_mode: $compare_mode,
1133 default_test_with_compare_mode!(Ui {
1134 path: "src/test/ui",
1140 default_test!(RunPassValgrind {
1141 path: "src/test/run-pass-valgrind",
1142 mode: "run-pass-valgrind",
1143 suite: "run-pass-valgrind"
1146 default_test!(MirOpt { path: "src/test/mir-opt", mode: "mir-opt", suite: "mir-opt" });
1148 default_test!(Codegen { path: "src/test/codegen", mode: "codegen", suite: "codegen" });
1150 default_test!(CodegenUnits {
1151 path: "src/test/codegen-units",
1152 mode: "codegen-units",
1153 suite: "codegen-units"
1156 default_test!(Incremental {
1157 path: "src/test/incremental",
1158 mode: "incremental",
1159 suite: "incremental"
1162 default_test_with_compare_mode!(Debuginfo {
1163 path: "src/test/debuginfo",
1166 compare_mode: "split-dwarf"
1169 host_test!(UiFullDeps { path: "src/test/ui-fulldeps", mode: "ui", suite: "ui-fulldeps" });
1171 host_test!(Rustdoc { path: "src/test/rustdoc", mode: "rustdoc", suite: "rustdoc" });
1172 host_test!(RustdocUi { path: "src/test/rustdoc-ui", mode: "ui", suite: "rustdoc-ui" });
1174 host_test!(RustdocJson {
1175 path: "src/test/rustdoc-json",
1176 mode: "rustdoc-json",
1177 suite: "rustdoc-json"
1180 host_test!(Pretty { path: "src/test/pretty", mode: "pretty", suite: "pretty" });
1182 default_test!(RunMake { path: "src/test/run-make", mode: "run-make", suite: "run-make" });
1184 host_test!(RunMakeFullDeps {
1185 path: "src/test/run-make-fulldeps",
1187 suite: "run-make-fulldeps"
1190 default_test!(Assembly { path: "src/test/assembly", mode: "assembly", suite: "assembly" });
1192 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1193 struct Compiletest {
1195 target: TargetSelection,
1197 suite: &'static str,
1199 compare_mode: Option<&'static str>,
1202 impl Step for Compiletest {
1205 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1209 /// Executes the `compiletest` tool to run a suite of tests.
1211 /// Compiles all tests with `compiler` for `target` with the specified
1212 /// compiletest `mode` and `suite` arguments. For example `mode` can be
1213 /// "run-pass" or `suite` can be something like `debuginfo`.
1214 fn run(self, builder: &Builder<'_>) {
1215 if builder.top_stage == 0 && env::var("COMPILETEST_FORCE_STAGE0").is_err() {
1217 error: `--stage 0` runs compiletest on the beta compiler, not your local changes, and will almost always cause tests to fail
1218 help: to test the compiler, use `--stage 1` instead
1219 help: to test the standard library, use `--stage 0 library/std` instead
1220 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`."
1222 std::process::exit(1);
1225 let compiler = self.compiler;
1226 let target = self.target;
1227 let mode = self.mode;
1228 let suite = self.suite;
1230 // Path for test suite
1231 let suite_path = self.path;
1233 // Skip codegen tests if they aren't enabled in configuration.
1234 if !builder.config.codegen_tests && suite == "codegen" {
1238 if suite == "debuginfo" {
1240 .ensure(dist::DebuggerScripts { sysroot: builder.sysroot(compiler), host: target });
1243 if suite.ends_with("fulldeps") {
1244 builder.ensure(compile::Rustc { compiler, target });
1247 builder.ensure(compile::Std { compiler, target });
1248 // ensure that `libproc_macro` is available on the host.
1249 builder.ensure(compile::Std { compiler, target: compiler.host });
1251 // Also provide `rust_test_helpers` for the host.
1252 builder.ensure(native::TestHelpers { target: compiler.host });
1254 // As well as the target, except for plain wasm32, which can't build it
1255 if !target.contains("wasm32") || target.contains("emscripten") {
1256 builder.ensure(native::TestHelpers { target });
1259 builder.ensure(RemoteCopyLibs { compiler, target });
1261 let mut cmd = builder.tool_cmd(Tool::Compiletest);
1263 // compiletest currently has... a lot of arguments, so let's just pass all
1266 cmd.arg("--compile-lib-path").arg(builder.rustc_libdir(compiler));
1267 cmd.arg("--run-lib-path").arg(builder.sysroot_libdir(compiler, target));
1268 cmd.arg("--rustc-path").arg(builder.rustc(compiler));
1270 let is_rustdoc = suite.ends_with("rustdoc-ui") || suite.ends_with("rustdoc-js");
1272 // Avoid depending on rustdoc when we don't need it.
1273 if mode == "rustdoc"
1274 || mode == "run-make"
1275 || (mode == "ui" && is_rustdoc)
1276 || mode == "js-doc-test"
1277 || mode == "rustdoc-json"
1279 cmd.arg("--rustdoc-path").arg(builder.rustdoc(compiler));
1282 if mode == "rustdoc-json" {
1283 // Use the beta compiler for jsondocck
1284 let json_compiler = compiler.with_stage(0);
1285 cmd.arg("--jsondocck-path")
1286 .arg(builder.ensure(tool::JsonDocCk { compiler: json_compiler, target }));
1289 if mode == "run-make" && suite.ends_with("fulldeps") {
1290 let rust_demangler = builder
1291 .ensure(tool::RustDemangler { compiler, target, extra_features: Vec::new() })
1292 .expect("in-tree tool");
1293 cmd.arg("--rust-demangler-path").arg(rust_demangler);
1296 cmd.arg("--src-base").arg(builder.src.join("src/test").join(suite));
1297 cmd.arg("--build-base").arg(testdir(builder, compiler.host).join(suite));
1298 cmd.arg("--stage-id").arg(format!("stage{}-{}", compiler.stage, target));
1299 cmd.arg("--suite").arg(suite);
1300 cmd.arg("--mode").arg(mode);
1301 cmd.arg("--target").arg(target.rustc_target_arg());
1302 cmd.arg("--host").arg(&*compiler.host.triple);
1303 cmd.arg("--llvm-filecheck").arg(builder.llvm_filecheck(builder.config.build));
1305 if builder.config.cmd.bless() {
1310 builder.config.cmd.compare_mode().or_else(|| {
1311 if builder.config.test_compare_mode { self.compare_mode } else { None }
1314 if let Some(ref pass) = builder.config.cmd.pass() {
1319 if let Some(ref run) = builder.config.cmd.run() {
1324 if let Some(ref nodejs) = builder.config.nodejs {
1325 cmd.arg("--nodejs").arg(nodejs);
1327 if let Some(ref npm) = builder.config.npm {
1328 cmd.arg("--npm").arg(npm);
1331 let mut flags = if is_rustdoc { Vec::new() } else { vec!["-Crpath".to_string()] };
1333 if builder.config.rust_optimize_tests {
1334 flags.push("-O".to_string());
1337 flags.push(format!("-Cdebuginfo={}", builder.config.rust_debuginfo_level_tests));
1338 flags.push(builder.config.cmd.rustc_args().join(" "));
1340 if let Some(linker) = builder.linker(target) {
1341 cmd.arg("--linker").arg(linker);
1344 let mut hostflags = flags.clone();
1345 hostflags.push(format!("-Lnative={}", builder.test_helpers_out(compiler.host).display()));
1346 hostflags.extend(builder.lld_flags(compiler.host));
1347 cmd.arg("--host-rustcflags").arg(hostflags.join(" "));
1349 let mut targetflags = flags;
1350 targetflags.push(format!("-Lnative={}", builder.test_helpers_out(target).display()));
1351 targetflags.extend(builder.lld_flags(target));
1352 cmd.arg("--target-rustcflags").arg(targetflags.join(" "));
1354 cmd.arg("--docck-python").arg(builder.python());
1356 if builder.config.build.ends_with("apple-darwin") {
1357 // Force /usr/bin/python3 on macOS for LLDB tests because we're loading the
1358 // LLDB plugin's compiled module which only works with the system python
1359 // (namely not Homebrew-installed python)
1360 cmd.arg("--lldb-python").arg("/usr/bin/python3");
1362 cmd.arg("--lldb-python").arg(builder.python());
1365 if let Some(ref gdb) = builder.config.gdb {
1366 cmd.arg("--gdb").arg(gdb);
1369 let run = |cmd: &mut Command| {
1370 cmd.output().map(|output| {
1371 String::from_utf8_lossy(&output.stdout)
1374 .unwrap_or_else(|| panic!("{:?} failed {:?}", cmd, output))
1378 let lldb_exe = "lldb";
1379 let lldb_version = Command::new(lldb_exe)
1382 .map(|output| String::from_utf8_lossy(&output.stdout).to_string())
1384 if let Some(ref vers) = lldb_version {
1385 cmd.arg("--lldb-version").arg(vers);
1386 let lldb_python_dir = run(Command::new(lldb_exe).arg("-P")).ok();
1387 if let Some(ref dir) = lldb_python_dir {
1388 cmd.arg("--lldb-python-dir").arg(dir);
1392 if util::forcing_clang_based_tests() {
1393 let clang_exe = builder.llvm_out(target).join("bin").join("clang");
1394 cmd.arg("--run-clang-based-tests-with").arg(clang_exe);
1397 // Get paths from cmd args
1398 let paths = match &builder.config.cmd {
1399 Subcommand::Test { ref paths, .. } => &paths[..],
1403 // Get test-args by striping suite path
1404 let mut test_args: Vec<&str> = paths
1406 .map(|p| match p.strip_prefix(".") {
1410 .filter(|p| p.starts_with(suite_path))
1412 let exists = p.is_dir() || p.is_file();
1414 if let Some(p) = p.to_str() {
1415 builder.info(&format!(
1416 "Warning: Skipping \"{}\": not a regular file or directory",
1424 // Since test suite paths are themselves directories, if we don't
1425 // specify a directory or file, we'll get an empty string here
1426 // (the result of the test suite directory without its suite prefix).
1427 // Therefore, we need to filter these out, as only the first --test-args
1428 // flag is respected, so providing an empty --test-args conflicts with
1429 // any following it.
1430 match p.strip_prefix(suite_path).ok().and_then(|p| p.to_str()) {
1431 Some(s) if !s.is_empty() => Some(s),
1437 test_args.append(&mut builder.config.cmd.test_args());
1439 cmd.args(&test_args);
1441 if builder.is_verbose() {
1442 cmd.arg("--verbose");
1445 if !builder.config.verbose_tests {
1449 let mut llvm_components_passed = false;
1450 let mut copts_passed = false;
1451 if builder.config.llvm_enabled() {
1452 let llvm_config = builder.ensure(native::Llvm { target: builder.config.build });
1453 if !builder.config.dry_run {
1454 let llvm_version = output(Command::new(&llvm_config).arg("--version"));
1455 let llvm_components = output(Command::new(&llvm_config).arg("--components"));
1456 // Remove trailing newline from llvm-config output.
1457 cmd.arg("--llvm-version")
1458 .arg(llvm_version.trim())
1459 .arg("--llvm-components")
1460 .arg(llvm_components.trim());
1461 llvm_components_passed = true;
1463 if !builder.is_rust_llvm(target) {
1464 cmd.arg("--system-llvm");
1467 // Tests that use compiler libraries may inherit the `-lLLVM` link
1468 // requirement, but the `-L` library path is not propagated across
1469 // separate compilations. We can add LLVM's library path to the
1470 // platform-specific environment variable as a workaround.
1471 if !builder.config.dry_run && suite.ends_with("fulldeps") {
1472 let llvm_libdir = output(Command::new(&llvm_config).arg("--libdir"));
1473 add_link_lib_path(vec![llvm_libdir.trim().into()], &mut cmd);
1476 // Only pass correct values for these flags for the `run-make` suite as it
1477 // requires that a C++ compiler was configured which isn't always the case.
1478 if !builder.config.dry_run && matches!(suite, "run-make" | "run-make-fulldeps") {
1479 // The llvm/bin directory contains many useful cross-platform
1480 // tools. Pass the path to run-make tests so they can use them.
1481 let llvm_bin_path = llvm_config
1483 .expect("Expected llvm-config to be contained in directory");
1484 assert!(llvm_bin_path.is_dir());
1485 cmd.arg("--llvm-bin-dir").arg(llvm_bin_path);
1487 // If LLD is available, add it to the PATH
1488 if builder.config.lld_enabled {
1489 let lld_install_root =
1490 builder.ensure(native::Lld { target: builder.config.build });
1492 let lld_bin_path = lld_install_root.join("bin");
1494 let old_path = env::var_os("PATH").unwrap_or_default();
1495 let new_path = env::join_paths(
1496 std::iter::once(lld_bin_path).chain(env::split_paths(&old_path)),
1498 .expect("Could not add LLD bin path to PATH");
1499 cmd.env("PATH", new_path);
1504 // Only pass correct values for these flags for the `run-make` suite as it
1505 // requires that a C++ compiler was configured which isn't always the case.
1506 if !builder.config.dry_run && matches!(suite, "run-make" | "run-make-fulldeps") {
1508 .arg(builder.cc(target))
1510 .arg(builder.cxx(target).unwrap())
1512 .arg(builder.cflags(target, GitRepo::Rustc).join(" "));
1513 copts_passed = true;
1514 if let Some(ar) = builder.ar(target) {
1515 cmd.arg("--ar").arg(ar);
1519 if !llvm_components_passed {
1520 cmd.arg("--llvm-components").arg("");
1523 cmd.arg("--cc").arg("").arg("--cxx").arg("").arg("--cflags").arg("");
1526 if builder.remote_tested(target) {
1527 cmd.arg("--remote-test-client").arg(builder.tool_exe(Tool::RemoteTestClient));
1530 // Running a C compiler on MSVC requires a few env vars to be set, to be
1531 // sure to set them here.
1533 // Note that if we encounter `PATH` we make sure to append to our own `PATH`
1534 // rather than stomp over it.
1535 if target.contains("msvc") {
1536 for &(ref k, ref v) in builder.cc[&target].env() {
1542 cmd.env("RUSTC_BOOTSTRAP", "1");
1543 cmd.env("DOC_RUST_LANG_ORG_CHANNEL", builder.doc_rust_lang_org_channel());
1544 builder.add_rust_test_threads(&mut cmd);
1546 if builder.config.sanitizers_enabled(target) {
1547 cmd.env("RUSTC_SANITIZER_SUPPORT", "1");
1550 if builder.config.profiler_enabled(target) {
1551 cmd.env("RUSTC_PROFILER_SUPPORT", "1");
1554 let tmp = builder.out.join("tmp");
1555 std::fs::create_dir_all(&tmp).unwrap();
1556 cmd.env("RUST_TEST_TMPDIR", tmp);
1558 cmd.arg("--adb-path").arg("adb");
1559 cmd.arg("--adb-test-dir").arg(ADB_TEST_DIR);
1560 if target.contains("android") {
1561 // Assume that cc for this target comes from the android sysroot
1562 cmd.arg("--android-cross-path")
1563 .arg(builder.cc(target).parent().unwrap().parent().unwrap());
1565 cmd.arg("--android-cross-path").arg("");
1568 if builder.config.cmd.rustfix_coverage() {
1569 cmd.arg("--rustfix-coverage");
1572 cmd.env("BOOTSTRAP_CARGO", &builder.initial_cargo);
1574 cmd.arg("--channel").arg(&builder.config.channel);
1576 builder.ci_env.force_coloring_in_ci(&mut cmd);
1578 builder.info(&format!(
1579 "Check compiletest suite={} mode={} ({} -> {})",
1580 suite, mode, &compiler.host, target
1582 let _time = util::timeit(&builder);
1583 try_run(builder, &mut cmd);
1585 if let Some(compare_mode) = compare_mode {
1586 cmd.arg("--compare-mode").arg(compare_mode);
1587 builder.info(&format!(
1588 "Check compiletest suite={} mode={} compare_mode={} ({} -> {})",
1589 suite, mode, compare_mode, &compiler.host, target
1591 let _time = util::timeit(&builder);
1592 try_run(builder, &mut cmd);
1597 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
1605 impl Step for BookTest {
1607 const ONLY_HOSTS: bool = true;
1609 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1613 /// Runs the documentation tests for a book in `src/doc`.
1615 /// This uses the `rustdoc` that sits next to `compiler`.
1616 fn run(self, builder: &Builder<'_>) {
1617 // External docs are different from local because:
1618 // - Some books need pre-processing by mdbook before being tested.
1619 // - They need to save their state to toolstate.
1620 // - They are only tested on the "checktools" builders.
1622 // The local docs are tested by default, and we don't want to pay the
1623 // cost of building mdbook, so they use `rustdoc --test` directly.
1624 // Also, the unstable book is special because SUMMARY.md is generated,
1625 // so it is easier to just run `rustdoc` on its files.
1626 if self.is_ext_doc {
1627 self.run_ext_doc(builder);
1629 self.run_local_doc(builder);
1635 /// This runs the equivalent of `mdbook test` (via the rustbook wrapper)
1636 /// which in turn runs `rustdoc --test` on each file in the book.
1637 fn run_ext_doc(self, builder: &Builder<'_>) {
1638 let compiler = self.compiler;
1640 builder.ensure(compile::Std { compiler, target: compiler.host });
1642 // mdbook just executes a binary named "rustdoc", so we need to update
1643 // PATH so that it points to our rustdoc.
1644 let mut rustdoc_path = builder.rustdoc(compiler);
1646 let old_path = env::var_os("PATH").unwrap_or_default();
1647 let new_path = env::join_paths(iter::once(rustdoc_path).chain(env::split_paths(&old_path)))
1648 .expect("could not add rustdoc to PATH");
1650 let mut rustbook_cmd = builder.tool_cmd(Tool::Rustbook);
1651 let path = builder.src.join(&self.path);
1652 rustbook_cmd.env("PATH", new_path).arg("test").arg(path);
1653 builder.add_rust_test_threads(&mut rustbook_cmd);
1654 builder.info(&format!("Testing rustbook {}", self.path.display()));
1655 let _time = util::timeit(&builder);
1656 let toolstate = if try_run(builder, &mut rustbook_cmd) {
1661 builder.save_toolstate(self.name, toolstate);
1664 /// This runs `rustdoc --test` on all `.md` files in the path.
1665 fn run_local_doc(self, builder: &Builder<'_>) {
1666 let compiler = self.compiler;
1668 builder.ensure(compile::Std { compiler, target: compiler.host });
1670 // Do a breadth-first traversal of the `src/doc` directory and just run
1671 // tests for all files that end in `*.md`
1672 let mut stack = vec![builder.src.join(self.path)];
1673 let _time = util::timeit(&builder);
1674 let mut files = Vec::new();
1675 while let Some(p) = stack.pop() {
1677 stack.extend(t!(p.read_dir()).map(|p| t!(p).path()));
1681 if p.extension().and_then(|s| s.to_str()) != Some("md") {
1691 markdown_test(builder, compiler, &file);
1696 macro_rules! test_book {
1697 ($($name:ident, $path:expr, $book_name:expr, default=$default:expr;)+) => {
1699 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1704 impl Step for $name {
1706 const DEFAULT: bool = $default;
1707 const ONLY_HOSTS: bool = true;
1709 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1713 fn make_run(run: RunConfig<'_>) {
1714 run.builder.ensure($name {
1715 compiler: run.builder.compiler(run.builder.top_stage, run.target),
1719 fn run(self, builder: &Builder<'_>) {
1720 builder.ensure(BookTest {
1721 compiler: self.compiler,
1722 path: PathBuf::from($path),
1724 is_ext_doc: !$default,
1733 Nomicon, "src/doc/nomicon", "nomicon", default=false;
1734 Reference, "src/doc/reference", "reference", default=false;
1735 RustdocBook, "src/doc/rustdoc", "rustdoc", default=true;
1736 RustcBook, "src/doc/rustc", "rustc", default=true;
1737 RustByExample, "src/doc/rust-by-example", "rust-by-example", default=false;
1738 EmbeddedBook, "src/doc/embedded-book", "embedded-book", default=false;
1739 TheBook, "src/doc/book", "book", default=false;
1740 UnstableBook, "src/doc/unstable-book", "unstable-book", default=true;
1741 EditionGuide, "src/doc/edition-guide", "edition-guide", default=false;
1744 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1745 pub struct ErrorIndex {
1749 impl Step for ErrorIndex {
1751 const DEFAULT: bool = true;
1752 const ONLY_HOSTS: bool = true;
1754 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1755 run.path("src/tools/error_index_generator")
1758 fn make_run(run: RunConfig<'_>) {
1759 // error_index_generator depends on librustdoc. Use the compiler that
1760 // is normally used to build rustdoc for other tests (like compiletest
1761 // tests in src/test/rustdoc) so that it shares the same artifacts.
1762 let compiler = run.builder.compiler(run.builder.top_stage, run.builder.config.build);
1763 run.builder.ensure(ErrorIndex { compiler });
1766 /// Runs the error index generator tool to execute the tests located in the error
1769 /// The `error_index_generator` tool lives in `src/tools` and is used to
1770 /// generate a markdown file from the error indexes of the code base which is
1771 /// then passed to `rustdoc --test`.
1772 fn run(self, builder: &Builder<'_>) {
1773 let compiler = self.compiler;
1775 let dir = testdir(builder, compiler.host);
1776 t!(fs::create_dir_all(&dir));
1777 let output = dir.join("error-index.md");
1779 let mut tool = tool::ErrorIndex::command(builder);
1780 tool.arg("markdown").arg(&output);
1782 builder.info(&format!("Testing error-index stage{}", compiler.stage));
1783 let _time = util::timeit(&builder);
1784 builder.run_quiet(&mut tool);
1785 // The tests themselves need to link to std, so make sure it is
1787 builder.ensure(compile::Std { compiler, target: compiler.host });
1788 markdown_test(builder, compiler, &output);
1792 fn markdown_test(builder: &Builder<'_>, compiler: Compiler, markdown: &Path) -> bool {
1793 if let Ok(contents) = fs::read_to_string(markdown) {
1794 if !contents.contains("```") {
1799 builder.info(&format!("doc tests for: {}", markdown.display()));
1800 let mut cmd = builder.rustdoc_cmd(compiler);
1801 builder.add_rust_test_threads(&mut cmd);
1802 // allow for unstable options such as new editions
1804 cmd.arg("unstable-options");
1807 cmd.env("RUSTC_BOOTSTRAP", "1");
1809 let test_args = builder.config.cmd.test_args().join(" ");
1810 cmd.arg("--test-args").arg(test_args);
1812 if builder.config.verbose_tests {
1813 try_run(builder, &mut cmd)
1815 try_run_quiet(builder, &mut cmd)
1819 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1820 pub struct RustcGuide;
1822 impl Step for RustcGuide {
1824 const DEFAULT: bool = false;
1825 const ONLY_HOSTS: bool = true;
1827 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1828 run.path("src/doc/rustc-dev-guide")
1831 fn make_run(run: RunConfig<'_>) {
1832 run.builder.ensure(RustcGuide);
1835 fn run(self, builder: &Builder<'_>) {
1836 let src = builder.src.join("src/doc/rustc-dev-guide");
1837 let mut rustbook_cmd = builder.tool_cmd(Tool::Rustbook);
1838 let toolstate = if try_run(builder, rustbook_cmd.arg("linkcheck").arg(&src)) {
1843 builder.save_toolstate("rustc-dev-guide", toolstate);
1847 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1848 pub struct CrateLibrustc {
1850 target: TargetSelection,
1851 test_kind: TestKind,
1852 krate: Interned<String>,
1855 impl Step for CrateLibrustc {
1857 const DEFAULT: bool = true;
1858 const ONLY_HOSTS: bool = true;
1860 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1861 run.krate("rustc-main")
1864 fn make_run(run: RunConfig<'_>) {
1865 let builder = run.builder;
1866 let compiler = builder.compiler(builder.top_stage, run.build_triple());
1868 for krate in builder.in_tree_crates("rustc-main", Some(run.target)) {
1869 if krate.path.ends_with(&run.path) {
1870 let test_kind = builder.kind.into();
1872 builder.ensure(CrateLibrustc {
1882 fn run(self, builder: &Builder<'_>) {
1883 builder.ensure(Crate {
1884 compiler: self.compiler,
1885 target: self.target,
1887 test_kind: self.test_kind,
1893 #[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
1895 pub compiler: Compiler,
1896 pub target: TargetSelection,
1898 pub test_kind: TestKind,
1899 pub krate: Interned<String>,
1902 impl Step for Crate {
1904 const DEFAULT: bool = true;
1906 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1910 fn make_run(run: RunConfig<'_>) {
1911 let builder = run.builder;
1912 let compiler = builder.compiler(builder.top_stage, run.build_triple());
1914 let make = |mode: Mode, krate: &CargoCrate| {
1915 let test_kind = builder.kind.into();
1917 builder.ensure(Crate {
1926 for krate in builder.in_tree_crates("test", Some(run.target)) {
1927 if krate.path.ends_with(&run.path) {
1928 make(Mode::Std, krate);
1933 /// Runs all unit tests plus documentation tests for a given crate defined
1934 /// by a `Cargo.toml` (single manifest)
1936 /// This is what runs tests for crates like the standard library, compiler, etc.
1937 /// It essentially is the driver for running `cargo test`.
1939 /// Currently this runs all tests for a DAG by passing a bunch of `-p foo`
1940 /// arguments, and those arguments are discovered from `cargo metadata`.
1941 fn run(self, builder: &Builder<'_>) {
1942 let compiler = self.compiler;
1943 let target = self.target;
1944 let mode = self.mode;
1945 let test_kind = self.test_kind;
1946 let krate = self.krate;
1948 builder.ensure(compile::Std { compiler, target });
1949 builder.ensure(RemoteCopyLibs { compiler, target });
1951 // If we're not doing a full bootstrap but we're testing a stage2
1952 // version of libstd, then what we're actually testing is the libstd
1953 // produced in stage1. Reflect that here by updating the compiler that
1954 // we're working with automatically.
1955 let compiler = builder.compiler_for(compiler.stage, compiler.host, target);
1958 builder.cargo(compiler, mode, SourceType::InTree, target, test_kind.subcommand());
1961 compile::std_cargo(builder, target, compiler.stage, &mut cargo);
1964 builder.ensure(compile::Rustc { compiler, target });
1965 compile::rustc_cargo(builder, &mut cargo, target);
1967 _ => panic!("can only test libraries"),
1970 // Build up the base `cargo test` command.
1972 // Pass in some standard flags then iterate over the graph we've discovered
1973 // in `cargo metadata` with the maps above and figure out what `-p`
1974 // arguments need to get passed.
1975 if test_kind.subcommand() == "test" && !builder.fail_fast {
1976 cargo.arg("--no-fail-fast");
1978 match builder.doc_tests {
1983 cargo.args(&["--lib", "--bins", "--examples", "--tests", "--benches"]);
1988 cargo.arg("-p").arg(krate);
1990 // The tests are going to run with the *target* libraries, so we need to
1991 // ensure that those libraries show up in the LD_LIBRARY_PATH equivalent.
1993 // Note that to run the compiler we need to run with the *host* libraries,
1994 // but our wrapper scripts arrange for that to be the case anyway.
1995 let mut dylib_path = dylib_path();
1996 dylib_path.insert(0, PathBuf::from(&*builder.sysroot_libdir(compiler, target)));
1997 cargo.env(dylib_path_var(), env::join_paths(&dylib_path).unwrap());
2000 cargo.args(&builder.config.cmd.test_args());
2002 if !builder.config.verbose_tests {
2003 cargo.arg("--quiet");
2006 if target.contains("emscripten") {
2008 format!("CARGO_TARGET_{}_RUNNER", envify(&target.triple)),
2009 builder.config.nodejs.as_ref().expect("nodejs not configured"),
2011 } else if target.starts_with("wasm32") {
2012 let node = builder.config.nodejs.as_ref().expect("nodejs not configured");
2014 format!("{} {}/src/etc/wasm32-shim.js", node.display(), builder.src.display());
2015 cargo.env(format!("CARGO_TARGET_{}_RUNNER", envify(&target.triple)), &runner);
2016 } else if builder.remote_tested(target) {
2018 format!("CARGO_TARGET_{}_RUNNER", envify(&target.triple)),
2019 format!("{} run 0", builder.tool_exe(Tool::RemoteTestClient).display()),
2023 builder.info(&format!(
2024 "{} {} stage{} ({} -> {})",
2025 test_kind, krate, compiler.stage, &compiler.host, target
2027 let _time = util::timeit(&builder);
2028 try_run(builder, &mut cargo.into());
2032 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2033 pub struct CrateRustdoc {
2034 host: TargetSelection,
2035 test_kind: TestKind,
2038 impl Step for CrateRustdoc {
2040 const DEFAULT: bool = true;
2041 const ONLY_HOSTS: bool = true;
2043 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2044 run.paths(&["src/librustdoc", "src/tools/rustdoc"])
2047 fn make_run(run: RunConfig<'_>) {
2048 let builder = run.builder;
2050 let test_kind = builder.kind.into();
2052 builder.ensure(CrateRustdoc { host: run.target, test_kind });
2055 fn run(self, builder: &Builder<'_>) {
2056 let test_kind = self.test_kind;
2057 let target = self.host;
2059 // Use the previous stage compiler to reuse the artifacts that are
2060 // created when running compiletest for src/test/rustdoc. If this used
2061 // `compiler`, then it would cause rustdoc to be built *again*, which
2062 // isn't really necessary.
2063 let compiler = builder.compiler_for(builder.top_stage, target, target);
2064 builder.ensure(compile::Rustc { compiler, target });
2066 let mut cargo = tool::prepare_tool_cargo(
2071 test_kind.subcommand(),
2072 "src/tools/rustdoc",
2076 if test_kind.subcommand() == "test" && !builder.fail_fast {
2077 cargo.arg("--no-fail-fast");
2080 cargo.arg("-p").arg("rustdoc:0.0.0");
2083 cargo.args(&builder.config.cmd.test_args());
2085 if self.host.contains("musl") {
2086 cargo.arg("'-Ctarget-feature=-crt-static'");
2089 // This is needed for running doctests on librustdoc. This is a bit of
2090 // an unfortunate interaction with how bootstrap works and how cargo
2091 // sets up the dylib path, and the fact that the doctest (in
2092 // html/markdown.rs) links to rustc-private libs. For stage1, the
2093 // compiler host dylibs (in stage1/lib) are not the same as the target
2094 // dylibs (in stage1/lib/rustlib/...). This is different from a normal
2095 // rust distribution where they are the same.
2097 // On the cargo side, normal tests use `target_process` which handles
2098 // setting up the dylib for a *target* (stage1/lib/rustlib/... in this
2099 // case). However, for doctests it uses `rustdoc_process` which only
2100 // sets up the dylib path for the *host* (stage1/lib), which is the
2103 // It should be considered to just stop running doctests on
2104 // librustdoc. There is only one test, and it doesn't look too
2105 // important. There might be other ways to avoid this, but it seems
2106 // pretty convoluted.
2108 // See also https://github.com/rust-lang/rust/issues/13983 where the
2109 // host vs target dylibs for rustdoc are consistently tricky to deal
2111 let mut dylib_path = dylib_path();
2112 dylib_path.insert(0, PathBuf::from(&*builder.sysroot_libdir(compiler, target)));
2113 cargo.env(dylib_path_var(), env::join_paths(&dylib_path).unwrap());
2115 if !builder.config.verbose_tests {
2116 cargo.arg("--quiet");
2119 builder.info(&format!(
2120 "{} rustdoc stage{} ({} -> {})",
2121 test_kind, compiler.stage, &compiler.host, target
2123 let _time = util::timeit(&builder);
2125 try_run(builder, &mut cargo.into());
2129 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2130 pub struct CrateRustdocJsonTypes {
2131 host: TargetSelection,
2132 test_kind: TestKind,
2135 impl Step for CrateRustdocJsonTypes {
2137 const DEFAULT: bool = true;
2138 const ONLY_HOSTS: bool = true;
2140 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2141 run.path("src/rustdoc-json-types")
2144 fn make_run(run: RunConfig<'_>) {
2145 let builder = run.builder;
2147 let test_kind = builder.kind.into();
2149 builder.ensure(CrateRustdocJsonTypes { host: run.target, test_kind });
2152 fn run(self, builder: &Builder<'_>) {
2153 let test_kind = self.test_kind;
2154 let target = self.host;
2156 // Use the previous stage compiler to reuse the artifacts that are
2157 // created when running compiletest for src/test/rustdoc. If this used
2158 // `compiler`, then it would cause rustdoc to be built *again*, which
2159 // isn't really necessary.
2160 let compiler = builder.compiler_for(builder.top_stage, target, target);
2161 builder.ensure(compile::Rustc { compiler, target });
2163 let mut cargo = tool::prepare_tool_cargo(
2168 test_kind.subcommand(),
2169 "src/rustdoc-json-types",
2173 if test_kind.subcommand() == "test" && !builder.fail_fast {
2174 cargo.arg("--no-fail-fast");
2177 cargo.arg("-p").arg("rustdoc-json-types");
2180 cargo.args(&builder.config.cmd.test_args());
2182 if self.host.contains("musl") {
2183 cargo.arg("'-Ctarget-feature=-crt-static'");
2186 if !builder.config.verbose_tests {
2187 cargo.arg("--quiet");
2190 builder.info(&format!(
2191 "{} rustdoc-json-types stage{} ({} -> {})",
2192 test_kind, compiler.stage, &compiler.host, target
2194 let _time = util::timeit(&builder);
2196 try_run(builder, &mut cargo.into());
2200 /// Some test suites are run inside emulators or on remote devices, and most
2201 /// of our test binaries are linked dynamically which means we need to ship
2202 /// the standard library and such to the emulator ahead of time. This step
2203 /// represents this and is a dependency of all test suites.
2205 /// Most of the time this is a no-op. For some steps such as shipping data to
2206 /// QEMU we have to build our own tools so we've got conditional dependencies
2207 /// on those programs as well. Note that the remote test client is built for
2208 /// the build target (us) and the server is built for the target.
2209 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2210 pub struct RemoteCopyLibs {
2212 target: TargetSelection,
2215 impl Step for RemoteCopyLibs {
2218 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2222 fn run(self, builder: &Builder<'_>) {
2223 let compiler = self.compiler;
2224 let target = self.target;
2225 if !builder.remote_tested(target) {
2229 builder.ensure(compile::Std { compiler, target });
2231 builder.info(&format!("REMOTE copy libs to emulator ({})", target));
2232 t!(fs::create_dir_all(builder.out.join("tmp")));
2234 let server = builder.ensure(tool::RemoteTestServer { compiler, target });
2236 // Spawn the emulator and wait for it to come online
2237 let tool = builder.tool_exe(Tool::RemoteTestClient);
2238 let mut cmd = Command::new(&tool);
2239 cmd.arg("spawn-emulator").arg(target.triple).arg(&server).arg(builder.out.join("tmp"));
2240 if let Some(rootfs) = builder.qemu_rootfs(target) {
2243 builder.run(&mut cmd);
2245 // Push all our dylibs to the emulator
2246 for f in t!(builder.sysroot_libdir(compiler, target).read_dir()) {
2248 let name = f.file_name().into_string().unwrap();
2249 if util::is_dylib(&name) {
2250 builder.run(Command::new(&tool).arg("push").arg(f.path()));
2256 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2257 pub struct Distcheck;
2259 impl Step for Distcheck {
2262 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2263 run.path("distcheck")
2266 fn make_run(run: RunConfig<'_>) {
2267 run.builder.ensure(Distcheck);
2270 /// Runs "distcheck", a 'make check' from a tarball
2271 fn run(self, builder: &Builder<'_>) {
2272 builder.info("Distcheck");
2273 let dir = builder.out.join("tmp").join("distcheck");
2274 let _ = fs::remove_dir_all(&dir);
2275 t!(fs::create_dir_all(&dir));
2277 // Guarantee that these are built before we begin running.
2278 builder.ensure(dist::PlainSourceTarball);
2279 builder.ensure(dist::Src);
2281 let mut cmd = Command::new("tar");
2283 .arg(builder.ensure(dist::PlainSourceTarball).tarball())
2284 .arg("--strip-components=1")
2286 builder.run(&mut cmd);
2288 Command::new("./configure")
2289 .args(&builder.config.configure_args)
2290 .arg("--enable-vendor")
2294 Command::new(build_helper::make(&builder.config.build.triple))
2299 // Now make sure that rust-src has all of libstd's dependencies
2300 builder.info("Distcheck rust-src");
2301 let dir = builder.out.join("tmp").join("distcheck-src");
2302 let _ = fs::remove_dir_all(&dir);
2303 t!(fs::create_dir_all(&dir));
2305 let mut cmd = Command::new("tar");
2307 .arg(builder.ensure(dist::Src).tarball())
2308 .arg("--strip-components=1")
2310 builder.run(&mut cmd);
2312 let toml = dir.join("rust-src/lib/rustlib/src/rust/library/std/Cargo.toml");
2314 Command::new(&builder.initial_cargo)
2315 .arg("generate-lockfile")
2316 .arg("--manifest-path")
2323 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2324 pub struct Bootstrap;
2326 impl Step for Bootstrap {
2328 const DEFAULT: bool = true;
2329 const ONLY_HOSTS: bool = true;
2331 /// Tests the build system itself.
2332 fn run(self, builder: &Builder<'_>) {
2333 let mut cmd = Command::new(&builder.initial_cargo);
2335 .current_dir(builder.src.join("src/bootstrap"))
2336 .env("RUSTFLAGS", "-Cdebuginfo=2")
2337 .env("CARGO_TARGET_DIR", builder.out.join("bootstrap"))
2338 .env("BOOTSTRAP_OUTPUT_DIRECTORY", &builder.config.out)
2339 .env("BOOTSTRAP_INITIAL_CARGO", &builder.config.initial_cargo)
2340 .env("RUSTC_BOOTSTRAP", "1")
2341 .env("RUSTC", &builder.initial_rustc);
2342 if let Some(flags) = option_env!("RUSTFLAGS") {
2343 // Use the same rustc flags for testing as for "normal" compilation,
2344 // so that Cargo doesn’t recompile the entire dependency graph every time:
2345 // https://github.com/rust-lang/rust/issues/49215
2346 cmd.env("RUSTFLAGS", flags);
2348 if !builder.fail_fast {
2349 cmd.arg("--no-fail-fast");
2351 cmd.arg("--").args(&builder.config.cmd.test_args());
2352 // rustbuild tests are racy on directory creation so just run them one at a time.
2353 // Since there's not many this shouldn't be a problem.
2354 cmd.arg("--test-threads=1");
2355 try_run(builder, &mut cmd);
2358 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2359 run.path("src/bootstrap")
2362 fn make_run(run: RunConfig<'_>) {
2363 run.builder.ensure(Bootstrap);
2367 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2368 pub struct TierCheck {
2369 pub compiler: Compiler,
2372 impl Step for TierCheck {
2374 const DEFAULT: bool = true;
2375 const ONLY_HOSTS: bool = true;
2377 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2378 run.path("src/tools/tier-check")
2381 fn make_run(run: RunConfig<'_>) {
2383 run.builder.compiler_for(run.builder.top_stage, run.builder.build.build, run.target);
2384 run.builder.ensure(TierCheck { compiler });
2387 /// Tests the Platform Support page in the rustc book.
2388 fn run(self, builder: &Builder<'_>) {
2389 builder.ensure(compile::Std { compiler: self.compiler, target: self.compiler.host });
2390 let mut cargo = tool::prepare_tool_cargo(
2396 "src/tools/tier-check",
2400 cargo.arg(builder.src.join("src/doc/rustc/src/platform-support.md"));
2401 cargo.arg(&builder.rustc(self.compiler));
2402 if builder.is_verbose() {
2403 cargo.arg("--verbose");
2406 builder.info("platform support check");
2407 try_run(builder, &mut cargo.into());
2411 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2412 pub struct LintDocs {
2413 pub compiler: Compiler,
2414 pub target: TargetSelection,
2417 impl Step for LintDocs {
2419 const DEFAULT: bool = true;
2420 const ONLY_HOSTS: bool = true;
2422 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2423 run.path("src/tools/lint-docs")
2426 fn make_run(run: RunConfig<'_>) {
2427 run.builder.ensure(LintDocs {
2428 compiler: run.builder.compiler(run.builder.top_stage, run.builder.config.build),
2433 /// Tests that the lint examples in the rustc book generate the correct
2434 /// lints and have the expected format.
2435 fn run(self, builder: &Builder<'_>) {
2436 builder.ensure(crate::doc::RustcBook {
2437 compiler: self.compiler,
2438 target: self.target,