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 crate::builder::{Builder, Compiler, Kind, RunConfig, ShouldRun, Step};
15 use crate::cache::Interned;
17 use crate::config::TargetSelection;
19 use crate::flags::Subcommand;
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};
26 const ADB_TEST_DIR: &str = "/data/tmp/work";
28 /// The two modes of the test runner; tests or benchmarks.
29 #[derive(Debug, PartialEq, Eq, Hash, Copy, Clone, PartialOrd, Ord)]
33 /// Run `cargo bench`.
37 impl From<Kind> for TestKind {
38 fn from(kind: Kind) -> Self {
40 Kind::Test => TestKind::Test,
41 Kind::Bench => TestKind::Bench,
42 _ => panic!("unexpected kind in crate: {:?}", kind),
48 // Return the cargo subcommand for this test kind
49 fn subcommand(self) -> &'static str {
51 TestKind::Test => "test",
52 TestKind::Bench => "bench",
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",
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));
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));
87 builder.run_quiet(cmd);
92 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
93 pub struct Linkcheck {
94 host: TargetSelection,
97 impl Step for Linkcheck {
99 const ONLY_HOSTS: bool = true;
100 const DEFAULT: bool = true;
102 /// Runs the `linkchecker` tool as compiled in `stage` by the `host` compiler.
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;
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() {
117 "Linkcheck currently does not support builds with different hosts and targets.
118 You can skip linkcheck with --exclude src/tools/linkchecker"
122 builder.info(&format!("Linkcheck ({})", host));
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(
133 "src/tools/linkchecker",
137 try_run(builder, &mut cargo.into());
139 // Build all the default documentation.
140 builder.default_doc(&[]);
142 // Run the linkchecker.
143 let _time = util::timeit(&builder);
146 builder.tool_cmd(Tool::Linkchecker).arg(builder.out.join(host.triple).join("doc")),
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)
156 fn make_run(run: RunConfig<'_>) {
157 run.builder.ensure(Linkcheck { host: run.target });
161 fn check_if_tidy_is_installed() -> bool {
164 .stdout(Stdio::null())
166 .map_or(false, |status| status.success())
169 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
170 pub struct HtmlCheck {
171 target: TargetSelection,
174 impl Step for HtmlCheck {
176 const DEFAULT: bool = true;
177 const ONLY_HOSTS: bool = true;
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))
184 fn make_run(run: RunConfig<'_>) {
185 run.builder.ensure(HtmlCheck { target: run.target });
188 fn run(self, builder: &Builder<'_>) {
189 if !check_if_tidy_is_installed() {
190 eprintln!("not running HTML-check tool because `tidy` is missing");
192 "Note that `tidy` is not the in-tree `src/tools/tidy` but needs to be installed"
194 panic!("Cannot run html-check tests");
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 });
200 try_run(builder, builder.tool_cmd(Tool::HtmlChecker).arg(builder.doc_out(self.target)));
204 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
205 pub struct Cargotest {
207 host: TargetSelection,
210 impl Step for Cargotest {
212 const ONLY_HOSTS: bool = true;
214 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
215 run.path("src/tools/cargotest")
218 fn make_run(run: RunConfig<'_>) {
219 run.builder.ensure(Cargotest { stage: run.builder.top_stage, host: run.target });
222 /// Runs the `cargotest` tool as compiled in `stage` by the `host` compiler.
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 { compiler, target: compiler.host });
229 let cargo = builder.ensure(tool::Cargo { compiler, target: compiler.host });
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));
237 let _time = util::timeit(&builder);
238 let mut cmd = builder.tool_cmd(Tool::CargoTest);
243 .args(builder.config.cmd.test_args())
244 .env("RUSTC", builder.rustc(compiler))
245 .env("RUSTDOC", builder.rustdoc(compiler)),
250 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
253 host: TargetSelection,
256 impl Step for Cargo {
258 const ONLY_HOSTS: bool = true;
260 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
261 run.path("src/tools/cargo")
264 fn make_run(run: RunConfig<'_>) {
265 run.builder.ensure(Cargo { stage: run.builder.top_stage, host: run.target });
268 /// Runs `cargo test` for `cargo` packaged with Rust.
269 fn run(self, builder: &Builder<'_>) {
270 let compiler = builder.compiler(self.stage, self.host);
272 builder.ensure(tool::Cargo { compiler, target: self.host });
273 let mut cargo = tool::prepare_tool_cargo(
280 SourceType::Submodule,
284 if !builder.fail_fast {
285 cargo.arg("--no-fail-fast");
287 cargo.arg("--").args(builder.config.cmd.test_args());
289 // Don't run cross-compile tests, we may not have cross-compiled libstd libs
291 cargo.env("CFG_DISABLE_CROSS_TESTS", "1");
292 // Disable a test that has issues with mingw.
293 cargo.env("CARGO_TEST_DISABLE_GIT_CLI", "1");
294 // Forcibly disable tests using nightly features since any changes to
295 // those features won't be able to land.
296 cargo.env("CARGO_TEST_DISABLE_NIGHTLY", "1");
298 cargo.env("PATH", &path_for_cargo(builder, compiler));
300 try_run(builder, &mut cargo.into());
304 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
307 host: TargetSelection,
312 const ONLY_HOSTS: bool = true;
314 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
315 run.path("src/tools/rls")
318 fn make_run(run: RunConfig<'_>) {
319 run.builder.ensure(Rls { stage: run.builder.top_stage, host: run.target });
322 /// Runs `cargo test` for the rls.
323 fn run(self, builder: &Builder<'_>) {
324 let stage = self.stage;
325 let host = self.host;
326 let compiler = builder.compiler(stage, host);
329 builder.ensure(tool::Rls { compiler, target: self.host, extra_features: Vec::new() });
330 if build_result.is_none() {
331 eprintln!("failed to test rls: could not build");
335 let mut cargo = tool::prepare_tool_cargo(
342 SourceType::Submodule,
346 cargo.add_rustc_lib_path(builder, compiler);
347 cargo.arg("--").args(builder.config.cmd.test_args());
349 if try_run(builder, &mut cargo.into()) {
350 builder.save_toolstate("rls", ToolState::TestPass);
355 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
358 host: TargetSelection,
361 impl Step for Rustfmt {
363 const ONLY_HOSTS: bool = true;
365 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
366 run.path("src/tools/rustfmt")
369 fn make_run(run: RunConfig<'_>) {
370 run.builder.ensure(Rustfmt { stage: run.builder.top_stage, host: run.target });
373 /// Runs `cargo test` for rustfmt.
374 fn run(self, builder: &Builder<'_>) {
375 let stage = self.stage;
376 let host = self.host;
377 let compiler = builder.compiler(stage, host);
380 .ensure(tool::Rustfmt { compiler, target: self.host, extra_features: Vec::new() })
381 .expect("in-tree tool");
383 let mut cargo = tool::prepare_tool_cargo(
394 let dir = testdir(builder, compiler.host);
395 t!(fs::create_dir_all(&dir));
396 cargo.env("RUSTFMT_TEST_DIR", dir);
398 cargo.add_rustc_lib_path(builder, compiler);
400 builder.run(&mut cargo.into());
404 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
405 pub struct RustDemangler {
407 host: TargetSelection,
410 impl Step for RustDemangler {
412 const ONLY_HOSTS: bool = true;
414 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
415 run.path("src/tools/rust-demangler")
418 fn make_run(run: RunConfig<'_>) {
419 run.builder.ensure(RustDemangler { stage: run.builder.top_stage, host: run.target });
422 /// Runs `cargo test` for rust-demangler.
423 fn run(self, builder: &Builder<'_>) {
424 let stage = self.stage;
425 let host = self.host;
426 let compiler = builder.compiler(stage, host);
428 let rust_demangler = builder
429 .ensure(tool::RustDemangler { compiler, target: self.host, extra_features: Vec::new() })
430 .expect("in-tree tool");
431 let mut cargo = tool::prepare_tool_cargo(
437 "src/tools/rust-demangler",
442 let dir = testdir(builder, compiler.host);
443 t!(fs::create_dir_all(&dir));
445 cargo.env("RUST_DEMANGLER_DRIVER_PATH", rust_demangler);
447 cargo.arg("--").args(builder.config.cmd.test_args());
449 cargo.add_rustc_lib_path(builder, compiler);
451 builder.run(&mut cargo.into());
455 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
458 host: TargetSelection,
463 const ONLY_HOSTS: bool = true;
465 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
466 run.path("src/tools/miri")
469 fn make_run(run: RunConfig<'_>) {
470 run.builder.ensure(Miri { stage: run.builder.top_stage, host: run.target });
473 /// Runs `cargo test` for miri.
474 fn run(self, builder: &Builder<'_>) {
475 let stage = self.stage;
476 let host = self.host;
477 let compiler = builder.compiler(stage, host);
480 builder.ensure(tool::Miri { compiler, target: self.host, extra_features: Vec::new() });
481 let cargo_miri = builder.ensure(tool::CargoMiri {
484 extra_features: Vec::new(),
486 if let (Some(miri), Some(_cargo_miri)) = (miri, cargo_miri) {
488 builder.cargo(compiler, Mode::ToolRustc, SourceType::Submodule, host, "install");
490 // Configure `cargo install` path. cargo adds a `bin/`.
491 cargo.env("CARGO_INSTALL_ROOT", &builder.out);
493 let mut cargo = Command::from(cargo);
494 if !try_run(builder, &mut cargo) {
498 // # Run `cargo miri setup`.
499 let mut cargo = tool::prepare_tool_cargo(
505 "src/tools/miri/cargo-miri",
506 SourceType::Submodule,
509 cargo.add_rustc_lib_path(builder, compiler);
510 cargo.arg("--").arg("miri").arg("setup");
512 // Tell `cargo miri setup` where to find the sources.
513 cargo.env("XARGO_RUST_SRC", builder.src.join("library"));
514 // Tell it where to find Miri.
515 cargo.env("MIRI", &miri);
517 cargo.env("RUST_BACKTRACE", "1");
518 // Let cargo-miri know where xargo ended up.
519 cargo.env("XARGO_CHECK", builder.out.join("bin").join("xargo-check"));
521 let mut cargo = Command::from(cargo);
522 if !try_run(builder, &mut cargo) {
526 // # Determine where Miri put its sysroot.
527 // To this end, we run `cargo miri setup --print-sysroot` and capture the output.
528 // (We do this separately from the above so that when the setup actually
529 // happens we get some output.)
530 // We re-use the `cargo` from above.
531 cargo.arg("--print-sysroot");
533 // FIXME: Is there a way in which we can re-use the usual `run` helpers?
534 let miri_sysroot = if builder.config.dry_run {
537 builder.verbose(&format!("running: {:?}", cargo));
540 .expect("We already ran `cargo miri setup` before and that worked");
541 assert!(out.status.success(), "`cargo miri setup` returned with non-0 exit code");
542 // Output is "<sysroot>\n".
543 let stdout = String::from_utf8(out.stdout)
544 .expect("`cargo miri setup` stdout is not valid UTF-8");
545 let sysroot = stdout.trim_end();
546 builder.verbose(&format!("`cargo miri setup --print-sysroot` said: {:?}", sysroot));
550 // # Run `cargo test`.
551 let mut cargo = tool::prepare_tool_cargo(
558 SourceType::Submodule,
561 cargo.add_rustc_lib_path(builder, compiler);
563 // miri tests need to know about the stage sysroot
564 cargo.env("MIRI_SYSROOT", miri_sysroot);
565 cargo.env("RUSTC_LIB_PATH", builder.rustc_libdir(compiler));
566 cargo.env("MIRI", miri);
568 cargo.arg("--").args(builder.config.cmd.test_args());
570 let mut cargo = Command::from(cargo);
571 if !try_run(builder, &mut cargo) {
576 builder.save_toolstate("miri", ToolState::TestPass);
578 eprintln!("failed to test miri: could not build");
583 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
584 pub struct CompiletestTest {
585 host: TargetSelection,
588 impl Step for CompiletestTest {
591 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
592 run.path("src/tools/compiletest")
595 fn make_run(run: RunConfig<'_>) {
596 run.builder.ensure(CompiletestTest { host: run.target });
599 /// Runs `cargo test` for compiletest.
600 fn run(self, builder: &Builder<'_>) {
601 let host = self.host;
602 let compiler = builder.compiler(0, host);
604 // We need `ToolStd` for the locally-built sysroot because
605 // compiletest uses unstable features of the `test` crate.
606 builder.ensure(compile::Std { compiler, target: host });
607 let cargo = tool::prepare_tool_cargo(
613 "src/tools/compiletest",
618 try_run(builder, &mut cargo.into());
622 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
625 host: TargetSelection,
628 impl Step for Clippy {
630 const ONLY_HOSTS: bool = true;
631 const DEFAULT: bool = false;
633 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
634 run.path("src/tools/clippy")
637 fn make_run(run: RunConfig<'_>) {
638 run.builder.ensure(Clippy { stage: run.builder.top_stage, host: run.target });
641 /// Runs `cargo test` for clippy.
642 fn run(self, builder: &Builder<'_>) {
643 let stage = self.stage;
644 let host = self.host;
645 let compiler = builder.compiler(stage, host);
648 .ensure(tool::Clippy { compiler, target: self.host, extra_features: Vec::new() })
649 .expect("in-tree tool");
650 let mut cargo = tool::prepare_tool_cargo(
661 cargo.env("RUSTC_TEST_SUITE", builder.rustc(compiler));
662 cargo.env("RUSTC_LIB_PATH", builder.rustc_libdir(compiler));
663 let host_libs = builder.stage_out(compiler, Mode::ToolRustc).join(builder.cargo_dir());
664 cargo.env("HOST_LIBS", host_libs);
666 cargo.arg("--").args(builder.config.cmd.test_args());
668 cargo.add_rustc_lib_path(builder, compiler);
670 if builder.try_run(&mut cargo.into()) {
671 // The tests succeeded; nothing to do.
675 if !builder.config.cmd.bless() {
676 std::process::exit(1);
679 let mut cargo = builder.cargo(compiler, Mode::ToolRustc, SourceType::InTree, host, "run");
680 cargo.arg("-p").arg("clippy_dev");
681 // clippy_dev gets confused if it can't find `clippy/Cargo.toml`
682 cargo.current_dir(&builder.src.join("src").join("tools").join("clippy"));
683 if builder.config.rust_optimize {
684 cargo.env("PROFILE", "release");
686 cargo.env("PROFILE", "debug");
690 builder.run(&mut cargo.into());
694 fn path_for_cargo(builder: &Builder<'_>, compiler: Compiler) -> OsString {
695 // Configure PATH to find the right rustc. NB. we have to use PATH
696 // and not RUSTC because the Cargo test suite has tests that will
697 // fail if rustc is not spelled `rustc`.
698 let path = builder.sysroot(compiler).join("bin");
699 let old_path = env::var_os("PATH").unwrap_or_default();
700 env::join_paths(iter::once(path).chain(env::split_paths(&old_path))).expect("")
703 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
704 pub struct RustdocTheme {
705 pub compiler: Compiler,
708 impl Step for RustdocTheme {
710 const DEFAULT: bool = true;
711 const ONLY_HOSTS: bool = true;
713 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
714 run.path("src/tools/rustdoc-themes")
717 fn make_run(run: RunConfig<'_>) {
718 let compiler = run.builder.compiler(run.builder.top_stage, run.target);
720 run.builder.ensure(RustdocTheme { compiler });
723 fn run(self, builder: &Builder<'_>) {
724 let rustdoc = builder.bootstrap_out.join("rustdoc");
725 let mut cmd = builder.tool_cmd(Tool::RustdocTheme);
726 cmd.arg(rustdoc.to_str().unwrap())
727 .arg(builder.src.join("src/librustdoc/html/static/css/themes").to_str().unwrap())
728 .env("RUSTC_STAGE", self.compiler.stage.to_string())
729 .env("RUSTC_SYSROOT", builder.sysroot(self.compiler))
730 .env("RUSTDOC_LIBDIR", builder.sysroot_libdir(self.compiler, self.compiler.host))
731 .env("CFG_RELEASE_CHANNEL", &builder.config.channel)
732 .env("RUSTDOC_REAL", builder.rustdoc(self.compiler))
733 .env("RUSTC_BOOTSTRAP", "1");
734 if let Some(linker) = builder.linker(self.compiler.host) {
735 cmd.env("RUSTDOC_LINKER", linker);
737 if builder.is_fuse_ld_lld(self.compiler.host) {
738 cmd.env("RUSTDOC_FUSE_LD_LLD", "1");
740 try_run(builder, &mut cmd);
744 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
745 pub struct RustdocJSStd {
746 pub target: TargetSelection,
749 impl Step for RustdocJSStd {
751 const DEFAULT: bool = true;
752 const ONLY_HOSTS: bool = true;
754 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
755 run.suite_path("src/test/rustdoc-js-std")
758 fn make_run(run: RunConfig<'_>) {
759 run.builder.ensure(RustdocJSStd { target: run.target });
762 fn run(self, builder: &Builder<'_>) {
763 if let Some(ref nodejs) = builder.config.nodejs {
764 let mut command = Command::new(nodejs);
766 .arg(builder.src.join("src/tools/rustdoc-js/tester.js"))
769 .arg("--resource-suffix")
770 .arg(&builder.version)
772 .arg(builder.doc_out(self.target))
773 .arg("--test-folder")
774 .arg(builder.src.join("src/test/rustdoc-js-std"));
775 for path in &builder.paths {
777 util::is_valid_test_suite_arg(path, "src/test/rustdoc-js-std", builder)
779 if !p.ends_with(".js") {
780 eprintln!("A non-js file was given: `{}`", path.display());
781 panic!("Cannot run rustdoc-js-std tests");
783 command.arg("--test-file").arg(path);
786 builder.ensure(crate::doc::Std { target: self.target, stage: builder.top_stage });
787 builder.run(&mut command);
789 builder.info("No nodejs found, skipping \"src/test/rustdoc-js-std\" tests");
794 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
795 pub struct RustdocJSNotStd {
796 pub target: TargetSelection,
797 pub compiler: Compiler,
800 impl Step for RustdocJSNotStd {
802 const DEFAULT: bool = true;
803 const ONLY_HOSTS: bool = true;
805 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
806 run.suite_path("src/test/rustdoc-js")
809 fn make_run(run: RunConfig<'_>) {
810 let compiler = run.builder.compiler(run.builder.top_stage, run.build_triple());
811 run.builder.ensure(RustdocJSNotStd { target: run.target, compiler });
814 fn run(self, builder: &Builder<'_>) {
815 if builder.config.nodejs.is_some() {
816 builder.ensure(Compiletest {
817 compiler: self.compiler,
821 path: "src/test/rustdoc-js",
825 builder.info("No nodejs found, skipping \"src/test/rustdoc-js\" tests");
830 fn get_browser_ui_test_version_inner(npm: &Path, global: bool) -> Option<String> {
831 let mut command = Command::new(&npm);
832 command.arg("list").arg("--parseable").arg("--long").arg("--depth=0");
834 command.arg("--global");
838 .map(|output| String::from_utf8_lossy(&output.stdout).into_owned())
839 .unwrap_or(String::new());
840 lines.lines().find_map(|l| l.split(":browser-ui-test@").skip(1).next()).map(|v| v.to_owned())
843 fn get_browser_ui_test_version(npm: &Path) -> Option<String> {
844 get_browser_ui_test_version_inner(npm, false)
845 .or_else(|| get_browser_ui_test_version_inner(npm, true))
848 fn compare_browser_ui_test_version(installed_version: &str, src: &Path) {
849 match fs::read_to_string(
850 src.join("src/ci/docker/host-x86_64/x86_64-gnu-tools/browser-ui-test.version"),
853 if v.trim() != installed_version {
855 "⚠️ Installed version of browser-ui-test (`{}`) is different than the \
856 one used in the CI (`{}`)",
861 Err(e) => eprintln!("Couldn't find the CI browser-ui-test version: {:?}", e),
865 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
866 pub struct RustdocGUI {
867 pub target: TargetSelection,
868 pub compiler: Compiler,
871 impl Step for RustdocGUI {
873 const DEFAULT: bool = true;
874 const ONLY_HOSTS: bool = true;
876 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
877 let builder = run.builder;
878 let run = run.suite_path("src/test/rustdoc-gui");
879 run.lazy_default_condition(Box::new(move || {
880 builder.config.nodejs.is_some()
885 .map(|p| get_browser_ui_test_version(p).is_some())
890 fn make_run(run: RunConfig<'_>) {
891 let compiler = run.builder.compiler(run.builder.top_stage, run.build_triple());
892 run.builder.ensure(RustdocGUI { target: run.target, compiler });
895 fn run(self, builder: &Builder<'_>) {
896 let nodejs = builder.config.nodejs.as_ref().expect("nodejs isn't available");
897 let npm = builder.config.npm.as_ref().expect("npm isn't available");
899 builder.ensure(compile::Std { compiler: self.compiler, target: self.target });
901 // The goal here is to check if the necessary packages are installed, and if not, we
903 match get_browser_ui_test_version(&npm) {
905 // We also check the version currently used in CI and emit a warning if it's not the
907 compare_browser_ui_test_version(&version, &builder.build.src);
911 "error: rustdoc-gui test suite cannot be run because npm `browser-ui-test` \
912 dependency is missing",
915 "If you want to install the `{0}` dependency, run `npm install {0}`",
918 panic!("Cannot run rustdoc-gui tests");
922 let out_dir = builder.test_out(self.target).join("rustdoc-gui");
924 // We remove existing folder to be sure there won't be artifacts remaining.
925 builder.clear_if_dirty(&out_dir, &builder.rustdoc(self.compiler));
927 let src_path = builder.build.src.join("src/test/rustdoc-gui/src");
928 // We generate docs for the libraries present in the rustdoc-gui's src folder.
929 for entry in src_path.read_dir().expect("read_dir call failed") {
930 if let Ok(entry) = entry {
931 let path = entry.path();
937 let mut cargo = Command::new(&builder.initial_cargo);
942 .env("RUSTDOC", builder.rustdoc(self.compiler))
943 .env("RUSTC", builder.rustc(self.compiler))
945 // FIXME: implement a `// compile-flags` command or similar
946 // instead of hard-coding this test
947 if entry.file_name() == "link_to_definition" {
948 cargo.env("RUSTDOCFLAGS", "-Zunstable-options --generate-link-to-definition");
950 builder.run(&mut cargo);
954 // We now run GUI tests.
955 let mut command = Command::new(&nodejs);
957 .arg(builder.build.src.join("src/tools/rustdoc-gui/tester.js"))
959 .arg(&builder.jobs().to_string())
961 .arg(out_dir.join("doc"))
962 .arg("--tests-folder")
963 .arg(builder.build.src.join("src/test/rustdoc-gui"));
964 for path in &builder.paths {
965 if let Some(p) = util::is_valid_test_suite_arg(path, "src/test/rustdoc-gui", builder) {
966 if !p.ends_with(".goml") {
967 eprintln!("A non-goml file was given: `{}`", path.display());
968 panic!("Cannot run rustdoc-gui tests");
970 if let Some(name) = path.file_name().and_then(|f| f.to_str()) {
971 command.arg("--file").arg(name);
975 for test_arg in builder.config.cmd.test_args() {
976 command.arg(test_arg);
978 builder.run(&mut command);
982 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
987 const DEFAULT: bool = true;
988 const ONLY_HOSTS: bool = true;
990 /// Runs the `tidy` tool.
992 /// This tool in `src/tools` checks up on various bits and pieces of style and
993 /// otherwise just implements a few lint-like checks that are specific to the
996 /// Once tidy passes, this step also runs `fmt --check` if tests are being run
997 /// for the `dev` or `nightly` channels.
998 fn run(self, builder: &Builder<'_>) {
999 let mut cmd = builder.tool_cmd(Tool::Tidy);
1000 cmd.arg(&builder.src);
1001 cmd.arg(&builder.initial_cargo);
1002 cmd.arg(&builder.out);
1003 cmd.arg(builder.jobs().to_string());
1004 if builder.is_verbose() {
1005 cmd.arg("--verbose");
1008 builder.info("tidy check");
1009 try_run(builder, &mut cmd);
1011 if builder.config.channel == "dev" || builder.config.channel == "nightly" {
1012 builder.info("fmt check");
1013 if builder.initial_rustfmt().is_none() {
1014 let inferred_rustfmt_dir = builder.config.initial_rustc.parent().unwrap();
1017 error: no `rustfmt` binary found in {PATH}
1018 info: `rust.channel` is currently set to \"{CHAN}\"
1019 help: if you are testing a beta branch, set `rust.channel` to \"beta\" in the `config.toml` file
1020 help: to skip test's attempt to check tidiness, pass `--exclude src/tools/tidy` to `x.py test`",
1021 PATH = inferred_rustfmt_dir.display(),
1022 CHAN = builder.config.channel,
1024 std::process::exit(1);
1026 crate::format::format(&builder, !builder.config.cmd.bless(), &[]);
1030 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1031 run.path("src/tools/tidy")
1034 fn make_run(run: RunConfig<'_>) {
1035 run.builder.ensure(Tidy);
1039 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1040 pub struct ExpandYamlAnchors;
1042 impl Step for ExpandYamlAnchors {
1044 const ONLY_HOSTS: bool = true;
1046 /// Ensure the `generate-ci-config` tool was run locally.
1048 /// The tool in `src/tools` reads the CI definition in `src/ci/builders.yml` and generates the
1049 /// appropriate configuration for all our CI providers. This step ensures the tool was called
1050 /// by the user before committing CI changes.
1051 fn run(self, builder: &Builder<'_>) {
1052 builder.info("Ensuring the YAML anchors in the GitHub Actions config were expanded");
1055 &mut builder.tool_cmd(Tool::ExpandYamlAnchors).arg("check").arg(&builder.src),
1059 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1060 run.path("src/tools/expand-yaml-anchors")
1063 fn make_run(run: RunConfig<'_>) {
1064 run.builder.ensure(ExpandYamlAnchors);
1068 fn testdir(builder: &Builder<'_>, host: TargetSelection) -> PathBuf {
1069 builder.out.join(host.triple).join("test")
1072 macro_rules! default_test {
1073 ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr }) => {
1074 test!($name { path: $path, mode: $mode, suite: $suite, default: true, host: false });
1078 macro_rules! default_test_with_compare_mode {
1079 ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr,
1080 compare_mode: $compare_mode:expr }) => {
1081 test_with_compare_mode!($name {
1087 compare_mode: $compare_mode
1092 macro_rules! host_test {
1093 ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr }) => {
1094 test!($name { path: $path, mode: $mode, suite: $suite, default: true, host: true });
1099 ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr, default: $default:expr,
1100 host: $host:expr }) => {
1101 test_definitions!($name {
1112 macro_rules! test_with_compare_mode {
1113 ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr, default: $default:expr,
1114 host: $host:expr, compare_mode: $compare_mode:expr }) => {
1115 test_definitions!($name {
1121 compare_mode: Some($compare_mode)
1126 macro_rules! test_definitions {
1131 default: $default:expr,
1133 compare_mode: $compare_mode:expr
1135 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1137 pub compiler: Compiler,
1138 pub target: TargetSelection,
1141 impl Step for $name {
1143 const DEFAULT: bool = $default;
1144 const ONLY_HOSTS: bool = $host;
1146 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1147 run.suite_path($path)
1150 fn make_run(run: RunConfig<'_>) {
1151 let compiler = run.builder.compiler(run.builder.top_stage, run.build_triple());
1153 run.builder.ensure($name { compiler, target: run.target });
1156 fn run(self, builder: &Builder<'_>) {
1157 builder.ensure(Compiletest {
1158 compiler: self.compiler,
1159 target: self.target,
1163 compare_mode: $compare_mode,
1170 default_test!(Ui { path: "src/test/ui", mode: "ui", suite: "ui" });
1172 default_test!(RunPassValgrind {
1173 path: "src/test/run-pass-valgrind",
1174 mode: "run-pass-valgrind",
1175 suite: "run-pass-valgrind"
1178 default_test!(MirOpt { path: "src/test/mir-opt", mode: "mir-opt", suite: "mir-opt" });
1180 default_test!(Codegen { path: "src/test/codegen", mode: "codegen", suite: "codegen" });
1182 default_test!(CodegenUnits {
1183 path: "src/test/codegen-units",
1184 mode: "codegen-units",
1185 suite: "codegen-units"
1188 default_test!(Incremental {
1189 path: "src/test/incremental",
1190 mode: "incremental",
1191 suite: "incremental"
1194 default_test_with_compare_mode!(Debuginfo {
1195 path: "src/test/debuginfo",
1198 compare_mode: "split-dwarf"
1201 host_test!(UiFullDeps { path: "src/test/ui-fulldeps", mode: "ui", suite: "ui-fulldeps" });
1203 host_test!(Rustdoc { path: "src/test/rustdoc", mode: "rustdoc", suite: "rustdoc" });
1204 host_test!(RustdocUi { path: "src/test/rustdoc-ui", mode: "ui", suite: "rustdoc-ui" });
1206 host_test!(RustdocJson {
1207 path: "src/test/rustdoc-json",
1208 mode: "rustdoc-json",
1209 suite: "rustdoc-json"
1212 host_test!(Pretty { path: "src/test/pretty", mode: "pretty", suite: "pretty" });
1214 default_test!(RunMake { path: "src/test/run-make", mode: "run-make", suite: "run-make" });
1216 host_test!(RunMakeFullDeps {
1217 path: "src/test/run-make-fulldeps",
1219 suite: "run-make-fulldeps"
1222 default_test!(Assembly { path: "src/test/assembly", mode: "assembly", suite: "assembly" });
1224 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1225 struct Compiletest {
1227 target: TargetSelection,
1229 suite: &'static str,
1231 compare_mode: Option<&'static str>,
1234 impl Step for Compiletest {
1237 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1241 /// Executes the `compiletest` tool to run a suite of tests.
1243 /// Compiles all tests with `compiler` for `target` with the specified
1244 /// compiletest `mode` and `suite` arguments. For example `mode` can be
1245 /// "run-pass" or `suite` can be something like `debuginfo`.
1246 fn run(self, builder: &Builder<'_>) {
1247 if builder.top_stage == 0 && env::var("COMPILETEST_FORCE_STAGE0").is_err() {
1249 error: `--stage 0` runs compiletest on the beta compiler, not your local changes, and will almost always cause tests to fail
1250 help: to test the compiler, use `--stage 1` instead
1251 help: to test the standard library, use `--stage 0 library/std` instead
1252 note: if you're sure you want to do this, please open an issue as to why. In the meantime, you can override this with `COMPILETEST_FORCE_STAGE0=1`."
1254 std::process::exit(1);
1257 let compiler = self.compiler;
1258 let target = self.target;
1259 let mode = self.mode;
1260 let suite = self.suite;
1262 // Path for test suite
1263 let suite_path = self.path;
1265 // Skip codegen tests if they aren't enabled in configuration.
1266 if !builder.config.codegen_tests && suite == "codegen" {
1270 if suite == "debuginfo" {
1272 .ensure(dist::DebuggerScripts { sysroot: builder.sysroot(compiler), host: target });
1275 if suite.ends_with("fulldeps") {
1276 builder.ensure(compile::Rustc { compiler, target });
1279 builder.ensure(compile::Std { compiler, target });
1280 // ensure that `libproc_macro` is available on the host.
1281 builder.ensure(compile::Std { compiler, target: compiler.host });
1283 // Also provide `rust_test_helpers` for the host.
1284 builder.ensure(native::TestHelpers { target: compiler.host });
1286 // As well as the target, except for plain wasm32, which can't build it
1287 if !target.contains("wasm") || target.contains("emscripten") {
1288 builder.ensure(native::TestHelpers { target });
1291 builder.ensure(RemoteCopyLibs { compiler, target });
1293 let mut cmd = builder.tool_cmd(Tool::Compiletest);
1295 // compiletest currently has... a lot of arguments, so let's just pass all
1298 cmd.arg("--compile-lib-path").arg(builder.rustc_libdir(compiler));
1299 cmd.arg("--run-lib-path").arg(builder.sysroot_libdir(compiler, target));
1300 cmd.arg("--rustc-path").arg(builder.rustc(compiler));
1302 let is_rustdoc = suite.ends_with("rustdoc-ui") || suite.ends_with("rustdoc-js");
1304 // Avoid depending on rustdoc when we don't need it.
1305 if mode == "rustdoc"
1306 || mode == "run-make"
1307 || (mode == "ui" && is_rustdoc)
1308 || mode == "js-doc-test"
1309 || mode == "rustdoc-json"
1311 cmd.arg("--rustdoc-path").arg(builder.rustdoc(compiler));
1314 if mode == "rustdoc-json" {
1315 // Use the beta compiler for jsondocck
1316 let json_compiler = compiler.with_stage(0);
1317 cmd.arg("--jsondocck-path")
1318 .arg(builder.ensure(tool::JsonDocCk { compiler: json_compiler, target }));
1321 if mode == "run-make" && suite.ends_with("fulldeps") {
1322 let rust_demangler = builder
1323 .ensure(tool::RustDemangler { compiler, target, extra_features: Vec::new() })
1324 .expect("in-tree tool");
1325 cmd.arg("--rust-demangler-path").arg(rust_demangler);
1328 cmd.arg("--src-base").arg(builder.src.join("src/test").join(suite));
1329 cmd.arg("--build-base").arg(testdir(builder, compiler.host).join(suite));
1330 cmd.arg("--stage-id").arg(format!("stage{}-{}", compiler.stage, target));
1331 cmd.arg("--suite").arg(suite);
1332 cmd.arg("--mode").arg(mode);
1333 cmd.arg("--target").arg(target.rustc_target_arg());
1334 cmd.arg("--host").arg(&*compiler.host.triple);
1335 cmd.arg("--llvm-filecheck").arg(builder.llvm_filecheck(builder.config.build));
1337 if builder.config.cmd.bless() {
1341 if builder.config.cmd.force_rerun() {
1342 cmd.arg("--force-rerun");
1346 builder.config.cmd.compare_mode().or_else(|| {
1347 if builder.config.test_compare_mode { self.compare_mode } else { None }
1350 if let Some(ref pass) = builder.config.cmd.pass() {
1355 if let Some(ref run) = builder.config.cmd.run() {
1360 if let Some(ref nodejs) = builder.config.nodejs {
1361 cmd.arg("--nodejs").arg(nodejs);
1363 if let Some(ref npm) = builder.config.npm {
1364 cmd.arg("--npm").arg(npm);
1367 let mut flags = if is_rustdoc { Vec::new() } else { vec!["-Crpath".to_string()] };
1368 if !is_rustdoc && mode != "ui" {
1369 if builder.config.rust_optimize_tests {
1370 flags.push("-O".to_string());
1373 if builder.config.rust_optimize_tests {
1374 cmd.arg("--optimize-tests");
1376 flags.push(format!("-Cdebuginfo={}", builder.config.rust_debuginfo_level_tests));
1377 flags.push(builder.config.cmd.rustc_args().join(" "));
1379 if let Some(linker) = builder.linker(target) {
1380 cmd.arg("--linker").arg(linker);
1383 let mut hostflags = flags.clone();
1384 hostflags.push(format!("-Lnative={}", builder.test_helpers_out(compiler.host).display()));
1385 hostflags.extend(builder.lld_flags(compiler.host));
1386 cmd.arg("--host-rustcflags").arg(hostflags.join(" "));
1388 let mut targetflags = flags;
1389 targetflags.push(format!("-Lnative={}", builder.test_helpers_out(target).display()));
1390 targetflags.extend(builder.lld_flags(target));
1391 cmd.arg("--target-rustcflags").arg(targetflags.join(" "));
1393 cmd.arg("--python").arg(builder.python());
1395 if let Some(ref gdb) = builder.config.gdb {
1396 cmd.arg("--gdb").arg(gdb);
1399 let run = |cmd: &mut Command| {
1400 cmd.output().map(|output| {
1401 String::from_utf8_lossy(&output.stdout)
1404 .unwrap_or_else(|| panic!("{:?} failed {:?}", cmd, output))
1408 let lldb_exe = "lldb";
1409 let lldb_version = Command::new(lldb_exe)
1412 .map(|output| String::from_utf8_lossy(&output.stdout).to_string())
1414 if let Some(ref vers) = lldb_version {
1415 cmd.arg("--lldb-version").arg(vers);
1416 let lldb_python_dir = run(Command::new(lldb_exe).arg("-P")).ok();
1417 if let Some(ref dir) = lldb_python_dir {
1418 cmd.arg("--lldb-python-dir").arg(dir);
1422 if util::forcing_clang_based_tests() {
1423 let clang_exe = builder.llvm_out(target).join("bin").join("clang");
1424 cmd.arg("--run-clang-based-tests-with").arg(clang_exe);
1427 // Get paths from cmd args
1428 let paths = match &builder.config.cmd {
1429 Subcommand::Test { ref paths, .. } => &paths[..],
1433 // Get test-args by striping suite path
1434 let mut test_args: Vec<&str> = paths
1436 .filter_map(|p| util::is_valid_test_suite_arg(p, suite_path, builder))
1439 test_args.append(&mut builder.config.cmd.test_args());
1441 cmd.args(&test_args);
1443 if builder.is_verbose() {
1444 cmd.arg("--verbose");
1447 if !builder.config.verbose_tests {
1451 let mut llvm_components_passed = false;
1452 let mut copts_passed = false;
1453 if builder.config.llvm_enabled() {
1454 let llvm_config = builder.ensure(native::Llvm { target: builder.config.build });
1455 if !builder.config.dry_run {
1456 let llvm_version = output(Command::new(&llvm_config).arg("--version"));
1457 let llvm_components = output(Command::new(&llvm_config).arg("--components"));
1458 // Remove trailing newline from llvm-config output.
1459 cmd.arg("--llvm-version")
1460 .arg(llvm_version.trim())
1461 .arg("--llvm-components")
1462 .arg(llvm_components.trim());
1463 llvm_components_passed = true;
1465 if !builder.is_rust_llvm(target) {
1466 cmd.arg("--system-llvm");
1469 // Tests that use compiler libraries may inherit the `-lLLVM` link
1470 // requirement, but the `-L` library path is not propagated across
1471 // separate compilations. We can add LLVM's library path to the
1472 // platform-specific environment variable as a workaround.
1473 if !builder.config.dry_run && suite.ends_with("fulldeps") {
1474 let llvm_libdir = output(Command::new(&llvm_config).arg("--libdir"));
1475 add_link_lib_path(vec![llvm_libdir.trim().into()], &mut cmd);
1478 // Only pass correct values for these flags for the `run-make` suite as it
1479 // requires that a C++ compiler was configured which isn't always the case.
1480 if !builder.config.dry_run && matches!(suite, "run-make" | "run-make-fulldeps") {
1481 // The llvm/bin directory contains many useful cross-platform
1482 // tools. Pass the path to run-make tests so they can use them.
1483 let llvm_bin_path = llvm_config
1485 .expect("Expected llvm-config to be contained in directory");
1486 assert!(llvm_bin_path.is_dir());
1487 cmd.arg("--llvm-bin-dir").arg(llvm_bin_path);
1489 // If LLD is available, add it to the PATH
1490 if builder.config.lld_enabled {
1491 let lld_install_root =
1492 builder.ensure(native::Lld { target: builder.config.build });
1494 let lld_bin_path = lld_install_root.join("bin");
1496 let old_path = env::var_os("PATH").unwrap_or_default();
1497 let new_path = env::join_paths(
1498 std::iter::once(lld_bin_path).chain(env::split_paths(&old_path)),
1500 .expect("Could not add LLD bin path to PATH");
1501 cmd.env("PATH", new_path);
1506 // Only pass correct values for these flags for the `run-make` suite as it
1507 // requires that a C++ compiler was configured which isn't always the case.
1508 if !builder.config.dry_run && matches!(suite, "run-make" | "run-make-fulldeps") {
1510 .arg(builder.cc(target))
1512 .arg(builder.cxx(target).unwrap())
1514 .arg(builder.cflags(target, GitRepo::Rustc, CLang::C).join(" "))
1516 .arg(builder.cflags(target, GitRepo::Rustc, CLang::Cxx).join(" "));
1517 copts_passed = true;
1518 if let Some(ar) = builder.ar(target) {
1519 cmd.arg("--ar").arg(ar);
1523 if !llvm_components_passed {
1524 cmd.arg("--llvm-components").arg("");
1537 if builder.remote_tested(target) {
1538 cmd.arg("--remote-test-client").arg(builder.tool_exe(Tool::RemoteTestClient));
1541 // Running a C compiler on MSVC requires a few env vars to be set, to be
1542 // sure to set them here.
1544 // Note that if we encounter `PATH` we make sure to append to our own `PATH`
1545 // rather than stomp over it.
1546 if target.contains("msvc") {
1547 for &(ref k, ref v) in builder.cc[&target].env() {
1553 cmd.env("RUSTC_BOOTSTRAP", "1");
1554 // Override the rustc version used in symbol hashes to reduce the amount of normalization
1555 // needed when diffing test output.
1556 cmd.env("RUSTC_FORCE_RUSTC_VERSION", "compiletest");
1557 cmd.env("DOC_RUST_LANG_ORG_CHANNEL", builder.doc_rust_lang_org_channel());
1558 builder.add_rust_test_threads(&mut cmd);
1560 if builder.config.sanitizers_enabled(target) {
1561 cmd.env("RUSTC_SANITIZER_SUPPORT", "1");
1564 if builder.config.profiler_enabled(target) {
1565 cmd.env("RUSTC_PROFILER_SUPPORT", "1");
1568 cmd.env("RUST_TEST_TMPDIR", builder.tempdir());
1570 cmd.arg("--adb-path").arg("adb");
1571 cmd.arg("--adb-test-dir").arg(ADB_TEST_DIR);
1572 if target.contains("android") {
1573 // Assume that cc for this target comes from the android sysroot
1574 cmd.arg("--android-cross-path")
1575 .arg(builder.cc(target).parent().unwrap().parent().unwrap());
1577 cmd.arg("--android-cross-path").arg("");
1580 if builder.config.cmd.rustfix_coverage() {
1581 cmd.arg("--rustfix-coverage");
1584 cmd.env("BOOTSTRAP_CARGO", &builder.initial_cargo);
1586 cmd.arg("--channel").arg(&builder.config.channel);
1588 builder.ci_env.force_coloring_in_ci(&mut cmd);
1590 builder.info(&format!(
1591 "Check compiletest suite={} mode={} ({} -> {})",
1592 suite, mode, &compiler.host, target
1594 let _time = util::timeit(&builder);
1595 try_run(builder, &mut cmd);
1597 if let Some(compare_mode) = compare_mode {
1598 cmd.arg("--compare-mode").arg(compare_mode);
1599 builder.info(&format!(
1600 "Check compiletest suite={} mode={} compare_mode={} ({} -> {})",
1601 suite, mode, compare_mode, &compiler.host, target
1603 let _time = util::timeit(&builder);
1604 try_run(builder, &mut cmd);
1609 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
1617 impl Step for BookTest {
1619 const ONLY_HOSTS: bool = true;
1621 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1625 /// Runs the documentation tests for a book in `src/doc`.
1627 /// This uses the `rustdoc` that sits next to `compiler`.
1628 fn run(self, builder: &Builder<'_>) {
1629 // External docs are different from local because:
1630 // - Some books need pre-processing by mdbook before being tested.
1631 // - They need to save their state to toolstate.
1632 // - They are only tested on the "checktools" builders.
1634 // The local docs are tested by default, and we don't want to pay the
1635 // cost of building mdbook, so they use `rustdoc --test` directly.
1636 // Also, the unstable book is special because SUMMARY.md is generated,
1637 // so it is easier to just run `rustdoc` on its files.
1638 if self.is_ext_doc {
1639 self.run_ext_doc(builder);
1641 self.run_local_doc(builder);
1647 /// This runs the equivalent of `mdbook test` (via the rustbook wrapper)
1648 /// which in turn runs `rustdoc --test` on each file in the book.
1649 fn run_ext_doc(self, builder: &Builder<'_>) {
1650 let compiler = self.compiler;
1652 builder.ensure(compile::Std { compiler, target: compiler.host });
1654 // mdbook just executes a binary named "rustdoc", so we need to update
1655 // PATH so that it points to our rustdoc.
1656 let mut rustdoc_path = builder.rustdoc(compiler);
1658 let old_path = env::var_os("PATH").unwrap_or_default();
1659 let new_path = env::join_paths(iter::once(rustdoc_path).chain(env::split_paths(&old_path)))
1660 .expect("could not add rustdoc to PATH");
1662 let mut rustbook_cmd = builder.tool_cmd(Tool::Rustbook);
1663 let path = builder.src.join(&self.path);
1664 rustbook_cmd.env("PATH", new_path).arg("test").arg(path);
1665 builder.add_rust_test_threads(&mut rustbook_cmd);
1666 builder.info(&format!("Testing rustbook {}", self.path.display()));
1667 let _time = util::timeit(&builder);
1668 let toolstate = if try_run(builder, &mut rustbook_cmd) {
1673 builder.save_toolstate(self.name, toolstate);
1676 /// This runs `rustdoc --test` on all `.md` files in the path.
1677 fn run_local_doc(self, builder: &Builder<'_>) {
1678 let compiler = self.compiler;
1680 builder.ensure(compile::Std { compiler, target: compiler.host });
1682 // Do a breadth-first traversal of the `src/doc` directory and just run
1683 // tests for all files that end in `*.md`
1684 let mut stack = vec![builder.src.join(self.path)];
1685 let _time = util::timeit(&builder);
1686 let mut files = Vec::new();
1687 while let Some(p) = stack.pop() {
1689 stack.extend(t!(p.read_dir()).map(|p| t!(p).path()));
1693 if p.extension().and_then(|s| s.to_str()) != Some("md") {
1703 markdown_test(builder, compiler, &file);
1708 macro_rules! test_book {
1709 ($($name:ident, $path:expr, $book_name:expr, default=$default:expr;)+) => {
1711 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1716 impl Step for $name {
1718 const DEFAULT: bool = $default;
1719 const ONLY_HOSTS: bool = true;
1721 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1725 fn make_run(run: RunConfig<'_>) {
1726 run.builder.ensure($name {
1727 compiler: run.builder.compiler(run.builder.top_stage, run.target),
1731 fn run(self, builder: &Builder<'_>) {
1732 builder.ensure(BookTest {
1733 compiler: self.compiler,
1734 path: PathBuf::from($path),
1736 is_ext_doc: !$default,
1745 Nomicon, "src/doc/nomicon", "nomicon", default=false;
1746 Reference, "src/doc/reference", "reference", default=false;
1747 RustdocBook, "src/doc/rustdoc", "rustdoc", default=true;
1748 RustcBook, "src/doc/rustc", "rustc", default=true;
1749 RustByExample, "src/doc/rust-by-example", "rust-by-example", default=false;
1750 EmbeddedBook, "src/doc/embedded-book", "embedded-book", default=false;
1751 TheBook, "src/doc/book", "book", default=false;
1752 UnstableBook, "src/doc/unstable-book", "unstable-book", default=true;
1753 EditionGuide, "src/doc/edition-guide", "edition-guide", default=false;
1756 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1757 pub struct ErrorIndex {
1761 impl Step for ErrorIndex {
1763 const DEFAULT: bool = true;
1764 const ONLY_HOSTS: bool = true;
1766 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1767 run.path("src/tools/error_index_generator")
1770 fn make_run(run: RunConfig<'_>) {
1771 // error_index_generator depends on librustdoc. Use the compiler that
1772 // is normally used to build rustdoc for other tests (like compiletest
1773 // tests in src/test/rustdoc) so that it shares the same artifacts.
1774 let compiler = run.builder.compiler(run.builder.top_stage, run.builder.config.build);
1775 run.builder.ensure(ErrorIndex { compiler });
1778 /// Runs the error index generator tool to execute the tests located in the error
1781 /// The `error_index_generator` tool lives in `src/tools` and is used to
1782 /// generate a markdown file from the error indexes of the code base which is
1783 /// then passed to `rustdoc --test`.
1784 fn run(self, builder: &Builder<'_>) {
1785 let compiler = self.compiler;
1787 let dir = testdir(builder, compiler.host);
1788 t!(fs::create_dir_all(&dir));
1789 let output = dir.join("error-index.md");
1791 let mut tool = tool::ErrorIndex::command(builder);
1792 tool.arg("markdown").arg(&output);
1794 builder.info(&format!("Testing error-index stage{}", compiler.stage));
1795 let _time = util::timeit(&builder);
1796 builder.run_quiet(&mut tool);
1797 // The tests themselves need to link to std, so make sure it is
1799 builder.ensure(compile::Std { compiler, target: compiler.host });
1800 markdown_test(builder, compiler, &output);
1804 fn markdown_test(builder: &Builder<'_>, compiler: Compiler, markdown: &Path) -> bool {
1805 if let Ok(contents) = fs::read_to_string(markdown) {
1806 if !contents.contains("```") {
1811 builder.info(&format!("doc tests for: {}", markdown.display()));
1812 let mut cmd = builder.rustdoc_cmd(compiler);
1813 builder.add_rust_test_threads(&mut cmd);
1814 // allow for unstable options such as new editions
1816 cmd.arg("unstable-options");
1819 cmd.env("RUSTC_BOOTSTRAP", "1");
1821 let test_args = builder.config.cmd.test_args().join(" ");
1822 cmd.arg("--test-args").arg(test_args);
1824 if builder.config.verbose_tests {
1825 try_run(builder, &mut cmd)
1827 try_run_quiet(builder, &mut cmd)
1831 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1832 pub struct RustcGuide;
1834 impl Step for RustcGuide {
1836 const DEFAULT: bool = false;
1837 const ONLY_HOSTS: bool = true;
1839 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1840 run.path("src/doc/rustc-dev-guide")
1843 fn make_run(run: RunConfig<'_>) {
1844 run.builder.ensure(RustcGuide);
1847 fn run(self, builder: &Builder<'_>) {
1848 let relative_path = Path::new("src").join("doc").join("rustc-dev-guide");
1849 builder.update_submodule(&relative_path);
1851 let src = builder.src.join(relative_path);
1852 let mut rustbook_cmd = builder.tool_cmd(Tool::Rustbook);
1853 let toolstate = if try_run(builder, rustbook_cmd.arg("linkcheck").arg(&src)) {
1858 builder.save_toolstate("rustc-dev-guide", toolstate);
1862 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
1863 pub struct CrateLibrustc {
1865 target: TargetSelection,
1866 test_kind: TestKind,
1867 crates: Vec<Interned<String>>,
1870 impl Step for CrateLibrustc {
1872 const DEFAULT: bool = true;
1873 const ONLY_HOSTS: bool = true;
1875 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1876 run.krate("rustc-main")
1879 fn make_run(run: RunConfig<'_>) {
1880 let builder = run.builder;
1881 let host = run.build_triple();
1882 let compiler = builder.compiler_for(builder.top_stage, host, host);
1886 .map(|p| builder.crate_paths[&p.assert_single_path().path].clone())
1888 let test_kind = builder.kind.into();
1890 builder.ensure(CrateLibrustc { compiler, target: run.target, test_kind, crates });
1893 fn run(self, builder: &Builder<'_>) {
1894 builder.ensure(Crate {
1895 compiler: self.compiler,
1896 target: self.target,
1898 test_kind: self.test_kind,
1899 crates: self.crates,
1904 #[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
1906 pub compiler: Compiler,
1907 pub target: TargetSelection,
1909 pub test_kind: TestKind,
1910 pub crates: Vec<Interned<String>>,
1913 impl Step for Crate {
1915 const DEFAULT: bool = true;
1917 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1921 fn make_run(run: RunConfig<'_>) {
1922 let builder = run.builder;
1923 let host = run.build_triple();
1924 let compiler = builder.compiler_for(builder.top_stage, host, host);
1925 let test_kind = builder.kind.into();
1929 .map(|p| builder.crate_paths[&p.assert_single_path().path].clone())
1932 builder.ensure(Crate { compiler, target: run.target, mode: Mode::Std, test_kind, crates });
1935 /// Runs all unit tests plus documentation tests for a given crate defined
1936 /// by a `Cargo.toml` (single manifest)
1938 /// This is what runs tests for crates like the standard library, compiler, etc.
1939 /// It essentially is the driver for running `cargo test`.
1941 /// Currently this runs all tests for a DAG by passing a bunch of `-p foo`
1942 /// arguments, and those arguments are discovered from `cargo metadata`.
1943 fn run(self, builder: &Builder<'_>) {
1944 let compiler = self.compiler;
1945 let target = self.target;
1946 let mode = self.mode;
1947 let test_kind = self.test_kind;
1949 builder.ensure(compile::Std { compiler, target });
1950 builder.ensure(RemoteCopyLibs { compiler, target });
1952 // If we're not doing a full bootstrap but we're testing a stage2
1953 // version of libstd, then what we're actually testing is the libstd
1954 // produced in stage1. Reflect that here by updating the compiler that
1955 // we're working with automatically.
1956 let compiler = builder.compiler_for(compiler.stage, compiler.host, target);
1959 builder.cargo(compiler, mode, SourceType::InTree, target, test_kind.subcommand());
1962 compile::std_cargo(builder, target, compiler.stage, &mut cargo);
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 for krate in &self.crates {
1989 cargo.arg("-p").arg(krate);
1992 // The tests are going to run with the *target* libraries, so we need to
1993 // ensure that those libraries show up in the LD_LIBRARY_PATH equivalent.
1995 // Note that to run the compiler we need to run with the *host* libraries,
1996 // but our wrapper scripts arrange for that to be the case anyway.
1997 let mut dylib_path = dylib_path();
1998 dylib_path.insert(0, PathBuf::from(&*builder.sysroot_libdir(compiler, target)));
1999 cargo.env(dylib_path_var(), env::join_paths(&dylib_path).unwrap());
2002 cargo.args(&builder.config.cmd.test_args());
2004 if !builder.config.verbose_tests {
2005 cargo.arg("--quiet");
2008 if target.contains("emscripten") {
2010 format!("CARGO_TARGET_{}_RUNNER", envify(&target.triple)),
2011 builder.config.nodejs.as_ref().expect("nodejs not configured"),
2013 } else if target.starts_with("wasm32") {
2014 let node = builder.config.nodejs.as_ref().expect("nodejs not configured");
2016 format!("{} {}/src/etc/wasm32-shim.js", node.display(), builder.src.display());
2017 cargo.env(format!("CARGO_TARGET_{}_RUNNER", envify(&target.triple)), &runner);
2018 } else if builder.remote_tested(target) {
2020 format!("CARGO_TARGET_{}_RUNNER", envify(&target.triple)),
2021 format!("{} run 0", builder.tool_exe(Tool::RemoteTestClient).display()),
2025 builder.info(&format!(
2026 "{} {:?} stage{} ({} -> {})",
2027 test_kind, self.crates, compiler.stage, &compiler.host, target
2029 let _time = util::timeit(&builder);
2030 try_run(builder, &mut cargo.into());
2034 /// Rustdoc is special in various ways, which is why this step is different from `Crate`.
2035 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2036 pub struct CrateRustdoc {
2037 host: TargetSelection,
2038 test_kind: TestKind,
2041 impl Step for CrateRustdoc {
2043 const DEFAULT: bool = true;
2044 const ONLY_HOSTS: bool = true;
2046 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2047 run.paths(&["src/librustdoc", "src/tools/rustdoc"])
2050 fn make_run(run: RunConfig<'_>) {
2051 let builder = run.builder;
2053 let test_kind = builder.kind.into();
2055 builder.ensure(CrateRustdoc { host: run.target, test_kind });
2058 fn run(self, builder: &Builder<'_>) {
2059 let test_kind = self.test_kind;
2060 let target = self.host;
2062 let compiler = if builder.download_rustc() {
2063 builder.compiler(builder.top_stage, target)
2065 // Use the previous stage compiler to reuse the artifacts that are
2066 // created when running compiletest for src/test/rustdoc. If this used
2067 // `compiler`, then it would cause rustdoc to be built *again*, which
2068 // isn't really necessary.
2069 builder.compiler_for(builder.top_stage, target, target)
2071 builder.ensure(compile::Rustc { compiler, target });
2073 let mut cargo = tool::prepare_tool_cargo(
2078 test_kind.subcommand(),
2079 "src/tools/rustdoc",
2083 if test_kind.subcommand() == "test" && !builder.fail_fast {
2084 cargo.arg("--no-fail-fast");
2086 match builder.doc_tests {
2091 cargo.args(&["--lib", "--bins", "--examples", "--tests", "--benches"]);
2096 cargo.arg("-p").arg("rustdoc:0.0.0");
2099 cargo.args(&builder.config.cmd.test_args());
2101 if self.host.contains("musl") {
2102 cargo.arg("'-Ctarget-feature=-crt-static'");
2105 // This is needed for running doctests on librustdoc. This is a bit of
2106 // an unfortunate interaction with how bootstrap works and how cargo
2107 // sets up the dylib path, and the fact that the doctest (in
2108 // html/markdown.rs) links to rustc-private libs. For stage1, the
2109 // compiler host dylibs (in stage1/lib) are not the same as the target
2110 // dylibs (in stage1/lib/rustlib/...). This is different from a normal
2111 // rust distribution where they are the same.
2113 // On the cargo side, normal tests use `target_process` which handles
2114 // setting up the dylib for a *target* (stage1/lib/rustlib/... in this
2115 // case). However, for doctests it uses `rustdoc_process` which only
2116 // sets up the dylib path for the *host* (stage1/lib), which is the
2119 // Recall that we special-cased `compiler_for(top_stage)` above, so we always use stage1.
2121 // It should be considered to just stop running doctests on
2122 // librustdoc. There is only one test, and it doesn't look too
2123 // important. There might be other ways to avoid this, but it seems
2124 // pretty convoluted.
2126 // See also https://github.com/rust-lang/rust/issues/13983 where the
2127 // host vs target dylibs for rustdoc are consistently tricky to deal
2130 // Note that this set the host libdir for `download_rustc`, which uses a normal rust distribution.
2131 let libdir = if builder.download_rustc() {
2132 builder.rustc_libdir(compiler)
2134 builder.sysroot_libdir(compiler, target).to_path_buf()
2136 let mut dylib_path = dylib_path();
2137 dylib_path.insert(0, PathBuf::from(&*libdir));
2138 cargo.env(dylib_path_var(), env::join_paths(&dylib_path).unwrap());
2140 if !builder.config.verbose_tests {
2141 cargo.arg("--quiet");
2144 builder.info(&format!(
2145 "{} rustdoc stage{} ({} -> {})",
2146 test_kind, compiler.stage, &compiler.host, target
2148 let _time = util::timeit(&builder);
2150 try_run(builder, &mut cargo.into());
2154 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2155 pub struct CrateRustdocJsonTypes {
2156 host: TargetSelection,
2157 test_kind: TestKind,
2160 impl Step for CrateRustdocJsonTypes {
2162 const DEFAULT: bool = true;
2163 const ONLY_HOSTS: bool = true;
2165 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2166 run.path("src/rustdoc-json-types")
2169 fn make_run(run: RunConfig<'_>) {
2170 let builder = run.builder;
2172 let test_kind = builder.kind.into();
2174 builder.ensure(CrateRustdocJsonTypes { host: run.target, test_kind });
2177 fn run(self, builder: &Builder<'_>) {
2178 let test_kind = self.test_kind;
2179 let target = self.host;
2181 // Use the previous stage compiler to reuse the artifacts that are
2182 // created when running compiletest for src/test/rustdoc. If this used
2183 // `compiler`, then it would cause rustdoc to be built *again*, which
2184 // isn't really necessary.
2185 let compiler = builder.compiler_for(builder.top_stage, target, target);
2186 builder.ensure(compile::Rustc { compiler, target });
2188 let mut cargo = tool::prepare_tool_cargo(
2193 test_kind.subcommand(),
2194 "src/rustdoc-json-types",
2198 if test_kind.subcommand() == "test" && !builder.fail_fast {
2199 cargo.arg("--no-fail-fast");
2202 cargo.arg("-p").arg("rustdoc-json-types");
2205 cargo.args(&builder.config.cmd.test_args());
2207 if self.host.contains("musl") {
2208 cargo.arg("'-Ctarget-feature=-crt-static'");
2211 if !builder.config.verbose_tests {
2212 cargo.arg("--quiet");
2215 builder.info(&format!(
2216 "{} rustdoc-json-types stage{} ({} -> {})",
2217 test_kind, compiler.stage, &compiler.host, target
2219 let _time = util::timeit(&builder);
2221 try_run(builder, &mut cargo.into());
2225 /// Some test suites are run inside emulators or on remote devices, and most
2226 /// of our test binaries are linked dynamically which means we need to ship
2227 /// the standard library and such to the emulator ahead of time. This step
2228 /// represents this and is a dependency of all test suites.
2230 /// Most of the time this is a no-op. For some steps such as shipping data to
2231 /// QEMU we have to build our own tools so we've got conditional dependencies
2232 /// on those programs as well. Note that the remote test client is built for
2233 /// the build target (us) and the server is built for the target.
2234 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2235 pub struct RemoteCopyLibs {
2237 target: TargetSelection,
2240 impl Step for RemoteCopyLibs {
2243 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2247 fn run(self, builder: &Builder<'_>) {
2248 let compiler = self.compiler;
2249 let target = self.target;
2250 if !builder.remote_tested(target) {
2254 builder.ensure(compile::Std { compiler, target });
2256 builder.info(&format!("REMOTE copy libs to emulator ({})", target));
2258 let server = builder.ensure(tool::RemoteTestServer { compiler, target });
2260 // Spawn the emulator and wait for it to come online
2261 let tool = builder.tool_exe(Tool::RemoteTestClient);
2262 let mut cmd = Command::new(&tool);
2263 cmd.arg("spawn-emulator").arg(target.triple).arg(&server).arg(builder.tempdir());
2264 if let Some(rootfs) = builder.qemu_rootfs(target) {
2267 builder.run(&mut cmd);
2269 // Push all our dylibs to the emulator
2270 for f in t!(builder.sysroot_libdir(compiler, target).read_dir()) {
2272 let name = f.file_name().into_string().unwrap();
2273 if util::is_dylib(&name) {
2274 builder.run(Command::new(&tool).arg("push").arg(f.path()));
2280 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2281 pub struct Distcheck;
2283 impl Step for Distcheck {
2286 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2287 run.alias("distcheck")
2290 fn make_run(run: RunConfig<'_>) {
2291 run.builder.ensure(Distcheck);
2294 /// Runs "distcheck", a 'make check' from a tarball
2295 fn run(self, builder: &Builder<'_>) {
2296 builder.info("Distcheck");
2297 let dir = builder.tempdir().join("distcheck");
2298 let _ = fs::remove_dir_all(&dir);
2299 t!(fs::create_dir_all(&dir));
2301 // Guarantee that these are built before we begin running.
2302 builder.ensure(dist::PlainSourceTarball);
2303 builder.ensure(dist::Src);
2305 let mut cmd = Command::new("tar");
2307 .arg(builder.ensure(dist::PlainSourceTarball).tarball())
2308 .arg("--strip-components=1")
2310 builder.run(&mut cmd);
2312 Command::new("./configure")
2313 .args(&builder.config.configure_args)
2314 .arg("--enable-vendor")
2318 Command::new(util::make(&builder.config.build.triple)).arg("check").current_dir(&dir),
2321 // Now make sure that rust-src has all of libstd's dependencies
2322 builder.info("Distcheck rust-src");
2323 let dir = builder.tempdir().join("distcheck-src");
2324 let _ = fs::remove_dir_all(&dir);
2325 t!(fs::create_dir_all(&dir));
2327 let mut cmd = Command::new("tar");
2329 .arg(builder.ensure(dist::Src).tarball())
2330 .arg("--strip-components=1")
2332 builder.run(&mut cmd);
2334 let toml = dir.join("rust-src/lib/rustlib/src/rust/library/std/Cargo.toml");
2336 Command::new(&builder.initial_cargo)
2337 .arg("generate-lockfile")
2338 .arg("--manifest-path")
2345 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2346 pub struct Bootstrap;
2348 impl Step for Bootstrap {
2350 const DEFAULT: bool = true;
2351 const ONLY_HOSTS: bool = true;
2353 /// Tests the build system itself.
2354 fn run(self, builder: &Builder<'_>) {
2355 let mut check_bootstrap = Command::new(&builder.python());
2356 check_bootstrap.arg("bootstrap_test.py").current_dir(builder.src.join("src/bootstrap/"));
2357 try_run(builder, &mut check_bootstrap);
2359 let mut cmd = Command::new(&builder.initial_cargo);
2361 .current_dir(builder.src.join("src/bootstrap"))
2362 .env("RUSTFLAGS", "-Cdebuginfo=2")
2363 .env("CARGO_TARGET_DIR", builder.out.join("bootstrap"))
2364 .env("RUSTC_BOOTSTRAP", "1")
2365 .env("RUSTDOC", builder.rustdoc(builder.compiler(0, builder.build.build)))
2366 .env("RUSTC", &builder.initial_rustc);
2367 if let Some(flags) = option_env!("RUSTFLAGS") {
2368 // Use the same rustc flags for testing as for "normal" compilation,
2369 // so that Cargo doesn’t recompile the entire dependency graph every time:
2370 // https://github.com/rust-lang/rust/issues/49215
2371 cmd.env("RUSTFLAGS", flags);
2373 if !builder.fail_fast {
2374 cmd.arg("--no-fail-fast");
2376 match builder.doc_tests {
2381 cmd.args(&["--lib", "--bins", "--examples", "--tests", "--benches"]);
2386 cmd.arg("--").args(&builder.config.cmd.test_args());
2387 // rustbuild tests are racy on directory creation so just run them one at a time.
2388 // Since there's not many this shouldn't be a problem.
2389 cmd.arg("--test-threads=1");
2390 try_run(builder, &mut cmd);
2393 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2394 run.path("src/bootstrap")
2397 fn make_run(run: RunConfig<'_>) {
2398 run.builder.ensure(Bootstrap);
2402 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2403 pub struct TierCheck {
2404 pub compiler: Compiler,
2407 impl Step for TierCheck {
2409 const DEFAULT: bool = true;
2410 const ONLY_HOSTS: bool = true;
2412 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2413 run.path("src/tools/tier-check")
2416 fn make_run(run: RunConfig<'_>) {
2418 run.builder.compiler_for(run.builder.top_stage, run.builder.build.build, run.target);
2419 run.builder.ensure(TierCheck { compiler });
2422 /// Tests the Platform Support page in the rustc book.
2423 fn run(self, builder: &Builder<'_>) {
2424 builder.ensure(compile::Std { compiler: self.compiler, target: self.compiler.host });
2425 let mut cargo = tool::prepare_tool_cargo(
2431 "src/tools/tier-check",
2435 cargo.arg(builder.src.join("src/doc/rustc/src/platform-support.md"));
2436 cargo.arg(&builder.rustc(self.compiler));
2437 if builder.is_verbose() {
2438 cargo.arg("--verbose");
2441 builder.info("platform support check");
2442 try_run(builder, &mut cargo.into());
2446 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2447 pub struct LintDocs {
2448 pub compiler: Compiler,
2449 pub target: TargetSelection,
2452 impl Step for LintDocs {
2454 const DEFAULT: bool = true;
2455 const ONLY_HOSTS: bool = true;
2457 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2458 run.path("src/tools/lint-docs")
2461 fn make_run(run: RunConfig<'_>) {
2462 run.builder.ensure(LintDocs {
2463 compiler: run.builder.compiler(run.builder.top_stage, run.builder.config.build),
2468 /// Tests that the lint examples in the rustc book generate the correct
2469 /// lints and have the expected format.
2470 fn run(self, builder: &Builder<'_>) {
2471 builder.ensure(crate::doc::RustcBook {
2472 compiler: self.compiler,
2473 target: self.target,