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/local/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::new(compiler, 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 // Forcibly disable tests using nightly features since any changes to
293 // those features won't be able to land.
294 cargo.env("CARGO_TEST_DISABLE_NIGHTLY", "1");
296 cargo.env("PATH", &path_for_cargo(builder, compiler));
298 try_run(builder, &mut cargo.into());
302 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
303 pub struct RustAnalyzer {
305 host: TargetSelection,
308 impl Step for RustAnalyzer {
310 const ONLY_HOSTS: bool = true;
311 const DEFAULT: bool = true;
313 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
314 run.path("src/tools/rust-analyzer")
317 fn make_run(run: RunConfig<'_>) {
318 run.builder.ensure(Self { stage: run.builder.top_stage, host: run.target });
321 /// Runs `cargo test` for rust-analyzer
322 fn run(self, builder: &Builder<'_>) {
323 let stage = self.stage;
324 let host = self.host;
325 let compiler = builder.compiler(stage, host);
327 builder.ensure(tool::RustAnalyzer { compiler, target: self.host }).expect("in-tree tool");
329 let workspace_path = "src/tools/rust-analyzer";
330 // until the whole RA test suite runs on `i686`, we only run
331 // `proc-macro-srv` tests
332 let crate_path = "src/tools/rust-analyzer/crates/proc-macro-srv";
333 let mut cargo = tool::prepare_tool_cargo(
341 &["sysroot-abi".to_owned()],
344 let dir = builder.src.join(workspace_path);
345 // needed by rust-analyzer to find its own text fixtures, cf.
346 // https://github.com/rust-analyzer/expect-test/issues/33
347 cargo.env("CARGO_WORKSPACE_DIR", &dir);
349 // RA's test suite tries to write to the source directory, that can't
351 cargo.env("SKIP_SLOW_TESTS", "1");
353 cargo.add_rustc_lib_path(builder, compiler);
354 cargo.arg("--").args(builder.config.cmd.test_args());
356 builder.run(&mut cargo.into());
360 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
363 host: TargetSelection,
366 impl Step for Rustfmt {
368 const ONLY_HOSTS: bool = true;
370 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
371 run.path("src/tools/rustfmt")
374 fn make_run(run: RunConfig<'_>) {
375 run.builder.ensure(Rustfmt { stage: run.builder.top_stage, host: run.target });
378 /// Runs `cargo test` for rustfmt.
379 fn run(self, builder: &Builder<'_>) {
380 let stage = self.stage;
381 let host = self.host;
382 let compiler = builder.compiler(stage, host);
385 .ensure(tool::Rustfmt { compiler, target: self.host, extra_features: Vec::new() })
386 .expect("in-tree tool");
388 let mut cargo = tool::prepare_tool_cargo(
399 let dir = testdir(builder, compiler.host);
400 t!(fs::create_dir_all(&dir));
401 cargo.env("RUSTFMT_TEST_DIR", dir);
403 cargo.add_rustc_lib_path(builder, compiler);
405 builder.run(&mut cargo.into());
409 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
410 pub struct RustDemangler {
412 host: TargetSelection,
415 impl Step for RustDemangler {
417 const ONLY_HOSTS: bool = true;
419 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
420 run.path("src/tools/rust-demangler")
423 fn make_run(run: RunConfig<'_>) {
424 run.builder.ensure(RustDemangler { stage: run.builder.top_stage, host: run.target });
427 /// Runs `cargo test` for rust-demangler.
428 fn run(self, builder: &Builder<'_>) {
429 let stage = self.stage;
430 let host = self.host;
431 let compiler = builder.compiler(stage, host);
433 let rust_demangler = builder
434 .ensure(tool::RustDemangler { compiler, target: self.host, extra_features: Vec::new() })
435 .expect("in-tree tool");
436 let mut cargo = tool::prepare_tool_cargo(
442 "src/tools/rust-demangler",
447 let dir = testdir(builder, compiler.host);
448 t!(fs::create_dir_all(&dir));
450 cargo.env("RUST_DEMANGLER_DRIVER_PATH", rust_demangler);
452 cargo.arg("--").args(builder.config.cmd.test_args());
454 cargo.add_rustc_lib_path(builder, compiler);
456 builder.run(&mut cargo.into());
460 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
463 host: TargetSelection,
468 const ONLY_HOSTS: bool = true;
470 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
471 run.path("src/tools/miri")
474 fn make_run(run: RunConfig<'_>) {
475 run.builder.ensure(Miri { stage: run.builder.top_stage, host: run.target });
478 /// Runs `cargo test` for miri.
479 fn run(self, builder: &Builder<'_>) {
480 let stage = self.stage;
481 let host = self.host;
482 let compiler = builder.compiler(stage, host);
483 // We need the stdlib for the *next* stage, as it was built with this compiler that also built Miri.
484 // Except if we are at stage 2, the bootstrap loop is complete and we can stick with our current stage.
485 let compiler_std = builder.compiler(if stage < 2 { stage + 1 } else { stage }, host);
488 .ensure(tool::Miri { compiler, target: self.host, extra_features: Vec::new() })
489 .expect("in-tree tool");
490 let _cargo_miri = builder
491 .ensure(tool::CargoMiri { compiler, target: self.host, extra_features: Vec::new() })
492 .expect("in-tree tool");
493 // The stdlib we need might be at a different stage. And just asking for the
494 // sysroot does not seem to populate it, so we do that first.
495 builder.ensure(compile::Std::new(compiler_std, host));
496 let sysroot = builder.sysroot(compiler_std);
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("MIRI_LIB_SRC", builder.src.join("library"));
514 // Tell it where to find Miri.
515 cargo.env("MIRI", &miri);
517 cargo.env("RUST_BACKTRACE", "1");
519 let mut cargo = Command::from(cargo);
520 builder.run(&mut cargo);
522 // # Determine where Miri put its sysroot.
523 // To this end, we run `cargo miri setup --print-sysroot` and capture the output.
524 // (We do this separately from the above so that when the setup actually
525 // happens we get some output.)
526 // We re-use the `cargo` from above.
527 cargo.arg("--print-sysroot");
529 // FIXME: Is there a way in which we can re-use the usual `run` helpers?
530 let miri_sysroot = if builder.config.dry_run {
533 builder.verbose(&format!("running: {:?}", cargo));
535 cargo.output().expect("We already ran `cargo miri setup` before and that worked");
536 assert!(out.status.success(), "`cargo miri setup` returned with non-0 exit code");
537 // Output is "<sysroot>\n".
538 let stdout = String::from_utf8(out.stdout)
539 .expect("`cargo miri setup` stdout is not valid UTF-8");
540 let sysroot = stdout.trim_end();
541 builder.verbose(&format!("`cargo miri setup --print-sysroot` said: {:?}", sysroot));
545 // # Run `cargo test`.
546 let mut cargo = tool::prepare_tool_cargo(
553 SourceType::Submodule,
556 cargo.add_rustc_lib_path(builder, compiler);
558 // miri tests need to know about the stage sysroot
559 cargo.env("MIRI_SYSROOT", miri_sysroot);
560 cargo.env("MIRI_HOST_SYSROOT", sysroot);
561 cargo.env("RUSTC_LIB_PATH", builder.rustc_libdir(compiler));
562 cargo.env("MIRI", miri);
564 if builder.config.cmd.bless() {
565 cargo.env("MIRI_BLESS", "Gesundheit");
568 cargo.arg("--").args(builder.config.cmd.test_args());
570 let mut cargo = Command::from(cargo);
571 builder.run(&mut cargo);
575 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
576 pub struct CompiletestTest {
577 host: TargetSelection,
580 impl Step for CompiletestTest {
583 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
584 run.path("src/tools/compiletest")
587 fn make_run(run: RunConfig<'_>) {
588 run.builder.ensure(CompiletestTest { host: run.target });
591 /// Runs `cargo test` for compiletest.
592 fn run(self, builder: &Builder<'_>) {
593 let host = self.host;
594 let compiler = builder.compiler(0, host);
596 // We need `ToolStd` for the locally-built sysroot because
597 // compiletest uses unstable features of the `test` crate.
598 builder.ensure(compile::Std::new(compiler, host));
599 let cargo = tool::prepare_tool_cargo(
605 "src/tools/compiletest",
610 try_run(builder, &mut cargo.into());
614 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
617 host: TargetSelection,
620 impl Step for Clippy {
622 const ONLY_HOSTS: bool = true;
623 const DEFAULT: bool = false;
625 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
626 run.path("src/tools/clippy")
629 fn make_run(run: RunConfig<'_>) {
630 run.builder.ensure(Clippy { stage: run.builder.top_stage, host: run.target });
633 /// Runs `cargo test` for clippy.
634 fn run(self, builder: &Builder<'_>) {
635 let stage = self.stage;
636 let host = self.host;
637 let compiler = builder.compiler(stage, host);
640 .ensure(tool::Clippy { compiler, target: self.host, extra_features: Vec::new() })
641 .expect("in-tree tool");
642 let mut cargo = tool::prepare_tool_cargo(
653 cargo.env("RUSTC_TEST_SUITE", builder.rustc(compiler));
654 cargo.env("RUSTC_LIB_PATH", builder.rustc_libdir(compiler));
655 let host_libs = builder.stage_out(compiler, Mode::ToolRustc).join(builder.cargo_dir());
656 cargo.env("HOST_LIBS", host_libs);
658 cargo.arg("--").args(builder.config.cmd.test_args());
660 cargo.add_rustc_lib_path(builder, compiler);
662 if builder.try_run(&mut cargo.into()) {
663 // The tests succeeded; nothing to do.
667 if !builder.config.cmd.bless() {
668 crate::detail_exit(1);
671 let mut cargo = builder.cargo(compiler, Mode::ToolRustc, SourceType::InTree, host, "run");
672 cargo.arg("-p").arg("clippy_dev");
673 // clippy_dev gets confused if it can't find `clippy/Cargo.toml`
674 cargo.current_dir(&builder.src.join("src").join("tools").join("clippy"));
675 if builder.config.rust_optimize {
676 cargo.env("PROFILE", "release");
678 cargo.env("PROFILE", "debug");
682 builder.run(&mut cargo.into());
686 fn path_for_cargo(builder: &Builder<'_>, compiler: Compiler) -> OsString {
687 // Configure PATH to find the right rustc. NB. we have to use PATH
688 // and not RUSTC because the Cargo test suite has tests that will
689 // fail if rustc is not spelled `rustc`.
690 let path = builder.sysroot(compiler).join("bin");
691 let old_path = env::var_os("PATH").unwrap_or_default();
692 env::join_paths(iter::once(path).chain(env::split_paths(&old_path))).expect("")
695 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
696 pub struct RustdocTheme {
697 pub compiler: Compiler,
700 impl Step for RustdocTheme {
702 const DEFAULT: bool = true;
703 const ONLY_HOSTS: bool = true;
705 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
706 run.path("src/tools/rustdoc-themes")
709 fn make_run(run: RunConfig<'_>) {
710 let compiler = run.builder.compiler(run.builder.top_stage, run.target);
712 run.builder.ensure(RustdocTheme { compiler });
715 fn run(self, builder: &Builder<'_>) {
716 let rustdoc = builder.bootstrap_out.join("rustdoc");
717 let mut cmd = builder.tool_cmd(Tool::RustdocTheme);
718 cmd.arg(rustdoc.to_str().unwrap())
719 .arg(builder.src.join("src/librustdoc/html/static/css/themes").to_str().unwrap())
720 .env("RUSTC_STAGE", self.compiler.stage.to_string())
721 .env("RUSTC_SYSROOT", builder.sysroot(self.compiler))
722 .env("RUSTDOC_LIBDIR", builder.sysroot_libdir(self.compiler, self.compiler.host))
723 .env("CFG_RELEASE_CHANNEL", &builder.config.channel)
724 .env("RUSTDOC_REAL", builder.rustdoc(self.compiler))
725 .env("RUSTC_BOOTSTRAP", "1");
726 if let Some(linker) = builder.linker(self.compiler.host) {
727 cmd.env("RUSTDOC_LINKER", linker);
729 if builder.is_fuse_ld_lld(self.compiler.host) {
730 cmd.env("RUSTDOC_FUSE_LD_LLD", "1");
732 try_run(builder, &mut cmd);
736 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
737 pub struct RustdocJSStd {
738 pub target: TargetSelection,
741 impl Step for RustdocJSStd {
743 const DEFAULT: bool = true;
744 const ONLY_HOSTS: bool = true;
746 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
747 run.suite_path("src/test/rustdoc-js-std")
750 fn make_run(run: RunConfig<'_>) {
751 run.builder.ensure(RustdocJSStd { target: run.target });
754 fn run(self, builder: &Builder<'_>) {
755 if let Some(ref nodejs) = builder.config.nodejs {
756 let mut command = Command::new(nodejs);
758 .arg(builder.src.join("src/tools/rustdoc-js/tester.js"))
761 .arg("--resource-suffix")
762 .arg(&builder.version)
764 .arg(builder.doc_out(self.target))
765 .arg("--test-folder")
766 .arg(builder.src.join("src/test/rustdoc-js-std"));
767 for path in &builder.paths {
769 util::is_valid_test_suite_arg(path, "src/test/rustdoc-js-std", builder)
771 if !p.ends_with(".js") {
772 eprintln!("A non-js file was given: `{}`", path.display());
773 panic!("Cannot run rustdoc-js-std tests");
775 command.arg("--test-file").arg(path);
778 builder.ensure(crate::doc::Std { target: self.target, stage: builder.top_stage });
779 builder.run(&mut command);
781 builder.info("No nodejs found, skipping \"src/test/rustdoc-js-std\" tests");
786 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
787 pub struct RustdocJSNotStd {
788 pub target: TargetSelection,
789 pub compiler: Compiler,
792 impl Step for RustdocJSNotStd {
794 const DEFAULT: bool = true;
795 const ONLY_HOSTS: bool = true;
797 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
798 run.suite_path("src/test/rustdoc-js")
801 fn make_run(run: RunConfig<'_>) {
802 let compiler = run.builder.compiler(run.builder.top_stage, run.build_triple());
803 run.builder.ensure(RustdocJSNotStd { target: run.target, compiler });
806 fn run(self, builder: &Builder<'_>) {
807 if builder.config.nodejs.is_some() {
808 builder.ensure(Compiletest {
809 compiler: self.compiler,
813 path: "src/test/rustdoc-js",
817 builder.info("No nodejs found, skipping \"src/test/rustdoc-js\" tests");
822 fn get_browser_ui_test_version_inner(npm: &Path, global: bool) -> Option<String> {
823 let mut command = Command::new(&npm);
824 command.arg("list").arg("--parseable").arg("--long").arg("--depth=0");
826 command.arg("--global");
830 .map(|output| String::from_utf8_lossy(&output.stdout).into_owned())
831 .unwrap_or(String::new());
834 .find_map(|l| l.split(':').nth(1)?.strip_prefix("browser-ui-test@"))
835 .map(|v| v.to_owned())
838 fn get_browser_ui_test_version(npm: &Path) -> Option<String> {
839 get_browser_ui_test_version_inner(npm, false)
840 .or_else(|| get_browser_ui_test_version_inner(npm, true))
843 fn compare_browser_ui_test_version(installed_version: &str, src: &Path) {
844 match fs::read_to_string(
845 src.join("src/ci/docker/host-x86_64/x86_64-gnu-tools/browser-ui-test.version"),
848 if v.trim() != installed_version {
850 "⚠️ Installed version of browser-ui-test (`{}`) is different than the \
851 one used in the CI (`{}`)",
855 "You can install this version using `npm update browser-ui-test` or by using \
856 `npm install browser-ui-test@{}`",
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::new(self.compiler, 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 crate::detail_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 crate::detail_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::new(compiler, target));
1279 builder.ensure(compile::Std::new(compiler, target));
1280 // ensure that `libproc_macro` is available on the host.
1281 builder.ensure(compile::Std::new(compiler, compiler.host));
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 }));
1319 cmd.arg("--jsondoclint-path")
1320 .arg(builder.ensure(tool::JsonDocLint { compiler: json_compiler, target }));
1323 if mode == "run-make" {
1324 let rust_demangler = builder
1325 .ensure(tool::RustDemangler {
1327 target: compiler.host,
1328 extra_features: Vec::new(),
1330 .expect("in-tree tool");
1331 cmd.arg("--rust-demangler-path").arg(rust_demangler);
1334 cmd.arg("--src-base").arg(builder.src.join("src/test").join(suite));
1335 cmd.arg("--build-base").arg(testdir(builder, compiler.host).join(suite));
1336 cmd.arg("--stage-id").arg(format!("stage{}-{}", compiler.stage, target));
1337 cmd.arg("--suite").arg(suite);
1338 cmd.arg("--mode").arg(mode);
1339 cmd.arg("--target").arg(target.rustc_target_arg());
1340 cmd.arg("--host").arg(&*compiler.host.triple);
1341 cmd.arg("--llvm-filecheck").arg(builder.llvm_filecheck(builder.config.build));
1343 if builder.config.cmd.bless() {
1347 if builder.config.cmd.force_rerun() {
1348 cmd.arg("--force-rerun");
1352 builder.config.cmd.compare_mode().or_else(|| {
1353 if builder.config.test_compare_mode { self.compare_mode } else { None }
1356 if let Some(ref pass) = builder.config.cmd.pass() {
1361 if let Some(ref run) = builder.config.cmd.run() {
1366 if let Some(ref nodejs) = builder.config.nodejs {
1367 cmd.arg("--nodejs").arg(nodejs);
1369 if let Some(ref npm) = builder.config.npm {
1370 cmd.arg("--npm").arg(npm);
1372 if builder.config.rust_optimize_tests {
1373 cmd.arg("--optimize-tests");
1375 let mut flags = if is_rustdoc { Vec::new() } else { vec!["-Crpath".to_string()] };
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 for exclude in &builder.config.exclude {
1429 cmd.arg(&exclude.path);
1432 // Get paths from cmd args
1433 let paths = match &builder.config.cmd {
1434 Subcommand::Test { ref paths, .. } => &paths[..],
1438 // Get test-args by striping suite path
1439 let mut test_args: Vec<&str> = paths
1441 .filter_map(|p| util::is_valid_test_suite_arg(p, suite_path, builder))
1444 test_args.append(&mut builder.config.cmd.test_args());
1446 // On Windows, replace forward slashes in test-args by backslashes
1447 // so the correct filters are passed to libtest
1449 let test_args_win: Vec<String> =
1450 test_args.iter().map(|s| s.replace("/", "\\")).collect();
1451 cmd.args(&test_args_win);
1453 cmd.args(&test_args);
1456 if builder.is_verbose() {
1457 cmd.arg("--verbose");
1460 if !builder.config.verbose_tests {
1464 let mut llvm_components_passed = false;
1465 let mut copts_passed = false;
1466 if builder.config.llvm_enabled() {
1467 let llvm_config = builder.ensure(native::Llvm { target: builder.config.build });
1468 if !builder.config.dry_run {
1469 let llvm_version = output(Command::new(&llvm_config).arg("--version"));
1470 let llvm_components = output(Command::new(&llvm_config).arg("--components"));
1471 // Remove trailing newline from llvm-config output.
1472 cmd.arg("--llvm-version")
1473 .arg(llvm_version.trim())
1474 .arg("--llvm-components")
1475 .arg(llvm_components.trim());
1476 llvm_components_passed = true;
1478 if !builder.is_rust_llvm(target) {
1479 cmd.arg("--system-llvm");
1482 // Tests that use compiler libraries may inherit the `-lLLVM` link
1483 // requirement, but the `-L` library path is not propagated across
1484 // separate compilations. We can add LLVM's library path to the
1485 // platform-specific environment variable as a workaround.
1486 if !builder.config.dry_run && suite.ends_with("fulldeps") {
1487 let llvm_libdir = output(Command::new(&llvm_config).arg("--libdir"));
1488 add_link_lib_path(vec![llvm_libdir.trim().into()], &mut cmd);
1491 // Only pass correct values for these flags for the `run-make` suite as it
1492 // requires that a C++ compiler was configured which isn't always the case.
1493 if !builder.config.dry_run && matches!(suite, "run-make" | "run-make-fulldeps") {
1494 // The llvm/bin directory contains many useful cross-platform
1495 // tools. Pass the path to run-make tests so they can use them.
1496 let llvm_bin_path = llvm_config
1498 .expect("Expected llvm-config to be contained in directory");
1499 assert!(llvm_bin_path.is_dir());
1500 cmd.arg("--llvm-bin-dir").arg(llvm_bin_path);
1502 // If LLD is available, add it to the PATH
1503 if builder.config.lld_enabled {
1504 let lld_install_root =
1505 builder.ensure(native::Lld { target: builder.config.build });
1507 let lld_bin_path = lld_install_root.join("bin");
1509 let old_path = env::var_os("PATH").unwrap_or_default();
1510 let new_path = env::join_paths(
1511 std::iter::once(lld_bin_path).chain(env::split_paths(&old_path)),
1513 .expect("Could not add LLD bin path to PATH");
1514 cmd.env("PATH", new_path);
1519 // Only pass correct values for these flags for the `run-make` suite as it
1520 // requires that a C++ compiler was configured which isn't always the case.
1521 if !builder.config.dry_run && matches!(suite, "run-make" | "run-make-fulldeps") {
1523 .arg(builder.cc(target))
1525 .arg(builder.cxx(target).unwrap())
1527 .arg(builder.cflags(target, GitRepo::Rustc, CLang::C).join(" "))
1529 .arg(builder.cflags(target, GitRepo::Rustc, CLang::Cxx).join(" "));
1530 copts_passed = true;
1531 if let Some(ar) = builder.ar(target) {
1532 cmd.arg("--ar").arg(ar);
1536 if !llvm_components_passed {
1537 cmd.arg("--llvm-components").arg("");
1550 if builder.remote_tested(target) {
1551 cmd.arg("--remote-test-client").arg(builder.tool_exe(Tool::RemoteTestClient));
1554 // Running a C compiler on MSVC requires a few env vars to be set, to be
1555 // sure to set them here.
1557 // Note that if we encounter `PATH` we make sure to append to our own `PATH`
1558 // rather than stomp over it.
1559 if target.contains("msvc") {
1560 for &(ref k, ref v) in builder.cc[&target].env() {
1566 cmd.env("RUSTC_BOOTSTRAP", "1");
1567 // Override the rustc version used in symbol hashes to reduce the amount of normalization
1568 // needed when diffing test output.
1569 cmd.env("RUSTC_FORCE_RUSTC_VERSION", "compiletest");
1570 cmd.env("DOC_RUST_LANG_ORG_CHANNEL", builder.doc_rust_lang_org_channel());
1571 builder.add_rust_test_threads(&mut cmd);
1573 if builder.config.sanitizers_enabled(target) {
1574 cmd.env("RUSTC_SANITIZER_SUPPORT", "1");
1577 if builder.config.profiler_enabled(target) {
1578 cmd.env("RUSTC_PROFILER_SUPPORT", "1");
1581 cmd.env("RUST_TEST_TMPDIR", builder.tempdir());
1583 cmd.arg("--adb-path").arg("adb");
1584 cmd.arg("--adb-test-dir").arg(ADB_TEST_DIR);
1585 if target.contains("android") {
1586 // Assume that cc for this target comes from the android sysroot
1587 cmd.arg("--android-cross-path")
1588 .arg(builder.cc(target).parent().unwrap().parent().unwrap());
1590 cmd.arg("--android-cross-path").arg("");
1593 if builder.config.cmd.rustfix_coverage() {
1594 cmd.arg("--rustfix-coverage");
1597 cmd.env("BOOTSTRAP_CARGO", &builder.initial_cargo);
1599 cmd.arg("--channel").arg(&builder.config.channel);
1601 builder.ci_env.force_coloring_in_ci(&mut cmd);
1603 builder.info(&format!(
1604 "Check compiletest suite={} mode={} ({} -> {})",
1605 suite, mode, &compiler.host, target
1607 let _time = util::timeit(&builder);
1608 try_run(builder, &mut cmd);
1610 if let Some(compare_mode) = compare_mode {
1611 cmd.arg("--compare-mode").arg(compare_mode);
1612 builder.info(&format!(
1613 "Check compiletest suite={} mode={} compare_mode={} ({} -> {})",
1614 suite, mode, compare_mode, &compiler.host, target
1616 let _time = util::timeit(&builder);
1617 try_run(builder, &mut cmd);
1622 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
1630 impl Step for BookTest {
1632 const ONLY_HOSTS: bool = true;
1634 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1638 /// Runs the documentation tests for a book in `src/doc`.
1640 /// This uses the `rustdoc` that sits next to `compiler`.
1641 fn run(self, builder: &Builder<'_>) {
1642 // External docs are different from local because:
1643 // - Some books need pre-processing by mdbook before being tested.
1644 // - They need to save their state to toolstate.
1645 // - They are only tested on the "checktools" builders.
1647 // The local docs are tested by default, and we don't want to pay the
1648 // cost of building mdbook, so they use `rustdoc --test` directly.
1649 // Also, the unstable book is special because SUMMARY.md is generated,
1650 // so it is easier to just run `rustdoc` on its files.
1651 if self.is_ext_doc {
1652 self.run_ext_doc(builder);
1654 self.run_local_doc(builder);
1660 /// This runs the equivalent of `mdbook test` (via the rustbook wrapper)
1661 /// which in turn runs `rustdoc --test` on each file in the book.
1662 fn run_ext_doc(self, builder: &Builder<'_>) {
1663 let compiler = self.compiler;
1665 builder.ensure(compile::Std::new(compiler, compiler.host));
1667 // mdbook just executes a binary named "rustdoc", so we need to update
1668 // PATH so that it points to our rustdoc.
1669 let mut rustdoc_path = builder.rustdoc(compiler);
1671 let old_path = env::var_os("PATH").unwrap_or_default();
1672 let new_path = env::join_paths(iter::once(rustdoc_path).chain(env::split_paths(&old_path)))
1673 .expect("could not add rustdoc to PATH");
1675 let mut rustbook_cmd = builder.tool_cmd(Tool::Rustbook);
1676 let path = builder.src.join(&self.path);
1677 rustbook_cmd.env("PATH", new_path).arg("test").arg(path);
1678 builder.add_rust_test_threads(&mut rustbook_cmd);
1679 builder.info(&format!("Testing rustbook {}", self.path.display()));
1680 let _time = util::timeit(&builder);
1681 let toolstate = if try_run(builder, &mut rustbook_cmd) {
1686 builder.save_toolstate(self.name, toolstate);
1689 /// This runs `rustdoc --test` on all `.md` files in the path.
1690 fn run_local_doc(self, builder: &Builder<'_>) {
1691 let compiler = self.compiler;
1693 builder.ensure(compile::Std::new(compiler, compiler.host));
1695 // Do a breadth-first traversal of the `src/doc` directory and just run
1696 // tests for all files that end in `*.md`
1697 let mut stack = vec![builder.src.join(self.path)];
1698 let _time = util::timeit(&builder);
1699 let mut files = Vec::new();
1700 while let Some(p) = stack.pop() {
1702 stack.extend(t!(p.read_dir()).map(|p| t!(p).path()));
1706 if p.extension().and_then(|s| s.to_str()) != Some("md") {
1716 markdown_test(builder, compiler, &file);
1721 macro_rules! test_book {
1722 ($($name:ident, $path:expr, $book_name:expr, default=$default:expr;)+) => {
1724 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1729 impl Step for $name {
1731 const DEFAULT: bool = $default;
1732 const ONLY_HOSTS: bool = true;
1734 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1738 fn make_run(run: RunConfig<'_>) {
1739 run.builder.ensure($name {
1740 compiler: run.builder.compiler(run.builder.top_stage, run.target),
1744 fn run(self, builder: &Builder<'_>) {
1745 builder.ensure(BookTest {
1746 compiler: self.compiler,
1747 path: PathBuf::from($path),
1749 is_ext_doc: !$default,
1758 Nomicon, "src/doc/nomicon", "nomicon", default=false;
1759 Reference, "src/doc/reference", "reference", default=false;
1760 RustdocBook, "src/doc/rustdoc", "rustdoc", default=true;
1761 RustcBook, "src/doc/rustc", "rustc", default=true;
1762 RustByExample, "src/doc/rust-by-example", "rust-by-example", default=false;
1763 EmbeddedBook, "src/doc/embedded-book", "embedded-book", default=false;
1764 TheBook, "src/doc/book", "book", default=false;
1765 UnstableBook, "src/doc/unstable-book", "unstable-book", default=true;
1766 EditionGuide, "src/doc/edition-guide", "edition-guide", default=false;
1769 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1770 pub struct ErrorIndex {
1774 impl Step for ErrorIndex {
1776 const DEFAULT: bool = true;
1777 const ONLY_HOSTS: bool = true;
1779 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1780 run.path("src/tools/error_index_generator")
1783 fn make_run(run: RunConfig<'_>) {
1784 // error_index_generator depends on librustdoc. Use the compiler that
1785 // is normally used to build rustdoc for other tests (like compiletest
1786 // tests in src/test/rustdoc) so that it shares the same artifacts.
1787 let compiler = run.builder.compiler(run.builder.top_stage, run.builder.config.build);
1788 run.builder.ensure(ErrorIndex { compiler });
1791 /// Runs the error index generator tool to execute the tests located in the error
1794 /// The `error_index_generator` tool lives in `src/tools` and is used to
1795 /// generate a markdown file from the error indexes of the code base which is
1796 /// then passed to `rustdoc --test`.
1797 fn run(self, builder: &Builder<'_>) {
1798 let compiler = self.compiler;
1800 let dir = testdir(builder, compiler.host);
1801 t!(fs::create_dir_all(&dir));
1802 let output = dir.join("error-index.md");
1804 let mut tool = tool::ErrorIndex::command(builder);
1805 tool.arg("markdown").arg(&output);
1807 builder.info(&format!("Testing error-index stage{}", compiler.stage));
1808 let _time = util::timeit(&builder);
1809 builder.run_quiet(&mut tool);
1810 // The tests themselves need to link to std, so make sure it is
1812 builder.ensure(compile::Std::new(compiler, compiler.host));
1813 markdown_test(builder, compiler, &output);
1817 fn markdown_test(builder: &Builder<'_>, compiler: Compiler, markdown: &Path) -> bool {
1818 if let Ok(contents) = fs::read_to_string(markdown) {
1819 if !contents.contains("```") {
1824 builder.info(&format!("doc tests for: {}", markdown.display()));
1825 let mut cmd = builder.rustdoc_cmd(compiler);
1826 builder.add_rust_test_threads(&mut cmd);
1827 // allow for unstable options such as new editions
1829 cmd.arg("unstable-options");
1832 cmd.env("RUSTC_BOOTSTRAP", "1");
1834 let test_args = builder.config.cmd.test_args().join(" ");
1835 cmd.arg("--test-args").arg(test_args);
1837 if builder.config.verbose_tests {
1838 try_run(builder, &mut cmd)
1840 try_run_quiet(builder, &mut cmd)
1844 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1845 pub struct RustcGuide;
1847 impl Step for RustcGuide {
1849 const DEFAULT: bool = false;
1850 const ONLY_HOSTS: bool = true;
1852 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1853 run.path("src/doc/rustc-dev-guide")
1856 fn make_run(run: RunConfig<'_>) {
1857 run.builder.ensure(RustcGuide);
1860 fn run(self, builder: &Builder<'_>) {
1861 let relative_path = Path::new("src").join("doc").join("rustc-dev-guide");
1862 builder.update_submodule(&relative_path);
1864 let src = builder.src.join(relative_path);
1865 let mut rustbook_cmd = builder.tool_cmd(Tool::Rustbook);
1866 let toolstate = if try_run(builder, rustbook_cmd.arg("linkcheck").arg(&src)) {
1871 builder.save_toolstate("rustc-dev-guide", toolstate);
1875 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
1876 pub struct CrateLibrustc {
1878 target: TargetSelection,
1879 test_kind: TestKind,
1880 crates: Vec<Interned<String>>,
1883 impl Step for CrateLibrustc {
1885 const DEFAULT: bool = true;
1886 const ONLY_HOSTS: bool = true;
1888 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1889 run.crate_or_deps("rustc-main")
1892 fn make_run(run: RunConfig<'_>) {
1893 let builder = run.builder;
1894 let host = run.build_triple();
1895 let compiler = builder.compiler_for(builder.top_stage, host, host);
1899 .map(|p| builder.crate_paths[&p.assert_single_path().path].clone())
1901 let test_kind = builder.kind.into();
1903 builder.ensure(CrateLibrustc { compiler, target: run.target, test_kind, crates });
1906 fn run(self, builder: &Builder<'_>) {
1907 builder.ensure(Crate {
1908 compiler: self.compiler,
1909 target: self.target,
1911 test_kind: self.test_kind,
1912 crates: self.crates,
1917 #[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
1919 pub compiler: Compiler,
1920 pub target: TargetSelection,
1922 pub test_kind: TestKind,
1923 pub crates: Vec<Interned<String>>,
1926 impl Step for Crate {
1928 const DEFAULT: bool = true;
1930 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1931 run.crate_or_deps("test")
1934 fn make_run(run: RunConfig<'_>) {
1935 let builder = run.builder;
1936 let host = run.build_triple();
1937 let compiler = builder.compiler_for(builder.top_stage, host, host);
1938 let test_kind = builder.kind.into();
1942 .map(|p| builder.crate_paths[&p.assert_single_path().path].clone())
1945 builder.ensure(Crate { compiler, target: run.target, mode: Mode::Std, test_kind, crates });
1948 /// Runs all unit tests plus documentation tests for a given crate defined
1949 /// by a `Cargo.toml` (single manifest)
1951 /// This is what runs tests for crates like the standard library, compiler, etc.
1952 /// It essentially is the driver for running `cargo test`.
1954 /// Currently this runs all tests for a DAG by passing a bunch of `-p foo`
1955 /// arguments, and those arguments are discovered from `cargo metadata`.
1956 fn run(self, builder: &Builder<'_>) {
1957 let compiler = self.compiler;
1958 let target = self.target;
1959 let mode = self.mode;
1960 let test_kind = self.test_kind;
1962 builder.ensure(compile::Std::new(compiler, target));
1963 builder.ensure(RemoteCopyLibs { compiler, target });
1965 // If we're not doing a full bootstrap but we're testing a stage2
1966 // version of libstd, then what we're actually testing is the libstd
1967 // produced in stage1. Reflect that here by updating the compiler that
1968 // we're working with automatically.
1969 let compiler = builder.compiler_for(compiler.stage, compiler.host, target);
1972 builder.cargo(compiler, mode, SourceType::InTree, target, test_kind.subcommand());
1975 compile::std_cargo(builder, target, compiler.stage, &mut cargo);
1978 compile::rustc_cargo(builder, &mut cargo, target);
1980 _ => panic!("can only test libraries"),
1983 // Build up the base `cargo test` command.
1985 // Pass in some standard flags then iterate over the graph we've discovered
1986 // in `cargo metadata` with the maps above and figure out what `-p`
1987 // arguments need to get passed.
1988 if test_kind.subcommand() == "test" && !builder.fail_fast {
1989 cargo.arg("--no-fail-fast");
1991 match builder.doc_tests {
1996 cargo.args(&["--lib", "--bins", "--examples", "--tests", "--benches"]);
2001 for krate in &self.crates {
2002 cargo.arg("-p").arg(krate);
2005 // The tests are going to run with the *target* libraries, so we need to
2006 // ensure that those libraries show up in the LD_LIBRARY_PATH equivalent.
2008 // Note that to run the compiler we need to run with the *host* libraries,
2009 // but our wrapper scripts arrange for that to be the case anyway.
2010 let mut dylib_path = dylib_path();
2011 dylib_path.insert(0, PathBuf::from(&*builder.sysroot_libdir(compiler, target)));
2012 cargo.env(dylib_path_var(), env::join_paths(&dylib_path).unwrap());
2015 cargo.args(&builder.config.cmd.test_args());
2017 if !builder.config.verbose_tests {
2018 cargo.arg("--quiet");
2021 if target.contains("emscripten") {
2023 format!("CARGO_TARGET_{}_RUNNER", envify(&target.triple)),
2024 builder.config.nodejs.as_ref().expect("nodejs not configured"),
2026 } else if target.starts_with("wasm32") {
2027 let node = builder.config.nodejs.as_ref().expect("nodejs not configured");
2029 format!("{} {}/src/etc/wasm32-shim.js", node.display(), builder.src.display());
2030 cargo.env(format!("CARGO_TARGET_{}_RUNNER", envify(&target.triple)), &runner);
2031 } else if builder.remote_tested(target) {
2033 format!("CARGO_TARGET_{}_RUNNER", envify(&target.triple)),
2034 format!("{} run 0", builder.tool_exe(Tool::RemoteTestClient).display()),
2038 builder.info(&format!(
2039 "{} {:?} stage{} ({} -> {})",
2040 test_kind, self.crates, compiler.stage, &compiler.host, target
2042 let _time = util::timeit(&builder);
2043 try_run(builder, &mut cargo.into());
2047 /// Rustdoc is special in various ways, which is why this step is different from `Crate`.
2048 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2049 pub struct CrateRustdoc {
2050 host: TargetSelection,
2051 test_kind: TestKind,
2054 impl Step for CrateRustdoc {
2056 const DEFAULT: bool = true;
2057 const ONLY_HOSTS: bool = true;
2059 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2060 run.paths(&["src/librustdoc", "src/tools/rustdoc"])
2063 fn make_run(run: RunConfig<'_>) {
2064 let builder = run.builder;
2066 let test_kind = builder.kind.into();
2068 builder.ensure(CrateRustdoc { host: run.target, test_kind });
2071 fn run(self, builder: &Builder<'_>) {
2072 let test_kind = self.test_kind;
2073 let target = self.host;
2075 let compiler = if builder.download_rustc() {
2076 builder.compiler(builder.top_stage, target)
2078 // Use the previous stage compiler to reuse the artifacts that are
2079 // created when running compiletest for src/test/rustdoc. If this used
2080 // `compiler`, then it would cause rustdoc to be built *again*, which
2081 // isn't really necessary.
2082 builder.compiler_for(builder.top_stage, target, target)
2084 builder.ensure(compile::Rustc::new(compiler, target));
2086 let mut cargo = tool::prepare_tool_cargo(
2091 test_kind.subcommand(),
2092 "src/tools/rustdoc",
2096 if test_kind.subcommand() == "test" && !builder.fail_fast {
2097 cargo.arg("--no-fail-fast");
2099 match builder.doc_tests {
2104 cargo.args(&["--lib", "--bins", "--examples", "--tests", "--benches"]);
2109 cargo.arg("-p").arg("rustdoc:0.0.0");
2112 cargo.args(&builder.config.cmd.test_args());
2114 if self.host.contains("musl") {
2115 cargo.arg("'-Ctarget-feature=-crt-static'");
2118 // This is needed for running doctests on librustdoc. This is a bit of
2119 // an unfortunate interaction with how bootstrap works and how cargo
2120 // sets up the dylib path, and the fact that the doctest (in
2121 // html/markdown.rs) links to rustc-private libs. For stage1, the
2122 // compiler host dylibs (in stage1/lib) are not the same as the target
2123 // dylibs (in stage1/lib/rustlib/...). This is different from a normal
2124 // rust distribution where they are the same.
2126 // On the cargo side, normal tests use `target_process` which handles
2127 // setting up the dylib for a *target* (stage1/lib/rustlib/... in this
2128 // case). However, for doctests it uses `rustdoc_process` which only
2129 // sets up the dylib path for the *host* (stage1/lib), which is the
2132 // Recall that we special-cased `compiler_for(top_stage)` above, so we always use stage1.
2134 // It should be considered to just stop running doctests on
2135 // librustdoc. There is only one test, and it doesn't look too
2136 // important. There might be other ways to avoid this, but it seems
2137 // pretty convoluted.
2139 // See also https://github.com/rust-lang/rust/issues/13983 where the
2140 // host vs target dylibs for rustdoc are consistently tricky to deal
2143 // Note that this set the host libdir for `download_rustc`, which uses a normal rust distribution.
2144 let libdir = if builder.download_rustc() {
2145 builder.rustc_libdir(compiler)
2147 builder.sysroot_libdir(compiler, target).to_path_buf()
2149 let mut dylib_path = dylib_path();
2150 dylib_path.insert(0, PathBuf::from(&*libdir));
2151 cargo.env(dylib_path_var(), env::join_paths(&dylib_path).unwrap());
2153 if !builder.config.verbose_tests {
2154 cargo.arg("--quiet");
2157 builder.info(&format!(
2158 "{} rustdoc stage{} ({} -> {})",
2159 test_kind, compiler.stage, &compiler.host, target
2161 let _time = util::timeit(&builder);
2163 try_run(builder, &mut cargo.into());
2167 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2168 pub struct CrateRustdocJsonTypes {
2169 host: TargetSelection,
2170 test_kind: TestKind,
2173 impl Step for CrateRustdocJsonTypes {
2175 const DEFAULT: bool = true;
2176 const ONLY_HOSTS: bool = true;
2178 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2179 run.path("src/rustdoc-json-types")
2182 fn make_run(run: RunConfig<'_>) {
2183 let builder = run.builder;
2185 let test_kind = builder.kind.into();
2187 builder.ensure(CrateRustdocJsonTypes { host: run.target, test_kind });
2190 fn run(self, builder: &Builder<'_>) {
2191 let test_kind = self.test_kind;
2192 let target = self.host;
2194 // Use the previous stage compiler to reuse the artifacts that are
2195 // created when running compiletest for src/test/rustdoc. If this used
2196 // `compiler`, then it would cause rustdoc to be built *again*, which
2197 // isn't really necessary.
2198 let compiler = builder.compiler_for(builder.top_stage, target, target);
2199 builder.ensure(compile::Rustc::new(compiler, target));
2201 let mut cargo = tool::prepare_tool_cargo(
2206 test_kind.subcommand(),
2207 "src/rustdoc-json-types",
2211 if test_kind.subcommand() == "test" && !builder.fail_fast {
2212 cargo.arg("--no-fail-fast");
2215 cargo.arg("-p").arg("rustdoc-json-types");
2218 cargo.args(&builder.config.cmd.test_args());
2220 if self.host.contains("musl") {
2221 cargo.arg("'-Ctarget-feature=-crt-static'");
2224 if !builder.config.verbose_tests {
2225 cargo.arg("--quiet");
2228 builder.info(&format!(
2229 "{} rustdoc-json-types stage{} ({} -> {})",
2230 test_kind, compiler.stage, &compiler.host, target
2232 let _time = util::timeit(&builder);
2234 try_run(builder, &mut cargo.into());
2238 /// Some test suites are run inside emulators or on remote devices, and most
2239 /// of our test binaries are linked dynamically which means we need to ship
2240 /// the standard library and such to the emulator ahead of time. This step
2241 /// represents this and is a dependency of all test suites.
2243 /// Most of the time this is a no-op. For some steps such as shipping data to
2244 /// QEMU we have to build our own tools so we've got conditional dependencies
2245 /// on those programs as well. Note that the remote test client is built for
2246 /// the build target (us) and the server is built for the target.
2247 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2248 pub struct RemoteCopyLibs {
2250 target: TargetSelection,
2253 impl Step for RemoteCopyLibs {
2256 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2260 fn run(self, builder: &Builder<'_>) {
2261 let compiler = self.compiler;
2262 let target = self.target;
2263 if !builder.remote_tested(target) {
2267 builder.ensure(compile::Std::new(compiler, target));
2269 builder.info(&format!("REMOTE copy libs to emulator ({})", target));
2271 let server = builder.ensure(tool::RemoteTestServer { compiler, target });
2273 // Spawn the emulator and wait for it to come online
2274 let tool = builder.tool_exe(Tool::RemoteTestClient);
2275 let mut cmd = Command::new(&tool);
2276 cmd.arg("spawn-emulator").arg(target.triple).arg(&server).arg(builder.tempdir());
2277 if let Some(rootfs) = builder.qemu_rootfs(target) {
2280 builder.run(&mut cmd);
2282 // Push all our dylibs to the emulator
2283 for f in t!(builder.sysroot_libdir(compiler, target).read_dir()) {
2285 let name = f.file_name().into_string().unwrap();
2286 if util::is_dylib(&name) {
2287 builder.run(Command::new(&tool).arg("push").arg(f.path()));
2293 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2294 pub struct Distcheck;
2296 impl Step for Distcheck {
2299 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2300 run.alias("distcheck")
2303 fn make_run(run: RunConfig<'_>) {
2304 run.builder.ensure(Distcheck);
2307 /// Runs "distcheck", a 'make check' from a tarball
2308 fn run(self, builder: &Builder<'_>) {
2309 builder.info("Distcheck");
2310 let dir = builder.tempdir().join("distcheck");
2311 let _ = fs::remove_dir_all(&dir);
2312 t!(fs::create_dir_all(&dir));
2314 // Guarantee that these are built before we begin running.
2315 builder.ensure(dist::PlainSourceTarball);
2316 builder.ensure(dist::Src);
2318 let mut cmd = Command::new("tar");
2320 .arg(builder.ensure(dist::PlainSourceTarball).tarball())
2321 .arg("--strip-components=1")
2323 builder.run(&mut cmd);
2325 Command::new("./configure")
2326 .args(&builder.config.configure_args)
2327 .arg("--enable-vendor")
2331 Command::new(util::make(&builder.config.build.triple)).arg("check").current_dir(&dir),
2334 // Now make sure that rust-src has all of libstd's dependencies
2335 builder.info("Distcheck rust-src");
2336 let dir = builder.tempdir().join("distcheck-src");
2337 let _ = fs::remove_dir_all(&dir);
2338 t!(fs::create_dir_all(&dir));
2340 let mut cmd = Command::new("tar");
2342 .arg(builder.ensure(dist::Src).tarball())
2343 .arg("--strip-components=1")
2345 builder.run(&mut cmd);
2347 let toml = dir.join("rust-src/lib/rustlib/src/rust/library/std/Cargo.toml");
2349 Command::new(&builder.initial_cargo)
2350 .arg("generate-lockfile")
2351 .arg("--manifest-path")
2358 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2359 pub struct Bootstrap;
2361 impl Step for Bootstrap {
2363 const DEFAULT: bool = true;
2364 const ONLY_HOSTS: bool = true;
2366 /// Tests the build system itself.
2367 fn run(self, builder: &Builder<'_>) {
2368 let mut check_bootstrap = Command::new(&builder.python());
2369 check_bootstrap.arg("bootstrap_test.py").current_dir(builder.src.join("src/bootstrap/"));
2370 try_run(builder, &mut check_bootstrap);
2372 let mut cmd = Command::new(&builder.initial_cargo);
2374 .current_dir(builder.src.join("src/bootstrap"))
2375 .env("RUSTFLAGS", "-Cdebuginfo=2")
2376 .env("CARGO_TARGET_DIR", builder.out.join("bootstrap"))
2377 .env("RUSTC_BOOTSTRAP", "1")
2378 .env("RUSTDOC", builder.rustdoc(builder.compiler(0, builder.build.build)))
2379 .env("RUSTC", &builder.initial_rustc);
2380 if let Some(flags) = option_env!("RUSTFLAGS") {
2381 // Use the same rustc flags for testing as for "normal" compilation,
2382 // so that Cargo doesn’t recompile the entire dependency graph every time:
2383 // https://github.com/rust-lang/rust/issues/49215
2384 cmd.env("RUSTFLAGS", flags);
2386 if !builder.fail_fast {
2387 cmd.arg("--no-fail-fast");
2389 match builder.doc_tests {
2394 cmd.args(&["--lib", "--bins", "--examples", "--tests", "--benches"]);
2399 cmd.arg("--").args(&builder.config.cmd.test_args());
2400 // rustbuild tests are racy on directory creation so just run them one at a time.
2401 // Since there's not many this shouldn't be a problem.
2402 cmd.arg("--test-threads=1");
2403 try_run(builder, &mut cmd);
2406 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2407 run.path("src/bootstrap")
2410 fn make_run(run: RunConfig<'_>) {
2411 run.builder.ensure(Bootstrap);
2415 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2416 pub struct TierCheck {
2417 pub compiler: Compiler,
2420 impl Step for TierCheck {
2422 const DEFAULT: bool = true;
2423 const ONLY_HOSTS: bool = true;
2425 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2426 run.path("src/tools/tier-check")
2429 fn make_run(run: RunConfig<'_>) {
2431 run.builder.compiler_for(run.builder.top_stage, run.builder.build.build, run.target);
2432 run.builder.ensure(TierCheck { compiler });
2435 /// Tests the Platform Support page in the rustc book.
2436 fn run(self, builder: &Builder<'_>) {
2437 builder.ensure(compile::Std::new(self.compiler, self.compiler.host));
2438 let mut cargo = tool::prepare_tool_cargo(
2444 "src/tools/tier-check",
2448 cargo.arg(builder.src.join("src/doc/rustc/src/platform-support.md"));
2449 cargo.arg(&builder.rustc(self.compiler));
2450 if builder.is_verbose() {
2451 cargo.arg("--verbose");
2454 builder.info("platform support check");
2455 try_run(builder, &mut cargo.into());
2459 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2460 pub struct ReplacePlaceholderTest;
2462 impl Step for ReplacePlaceholderTest {
2464 const ONLY_HOSTS: bool = true;
2465 const DEFAULT: bool = true;
2467 /// Ensure the version placeholder replacement tool builds
2468 fn run(self, builder: &Builder<'_>) {
2469 builder.info("build check for version replacement placeholder");
2471 // Test the version placeholder replacement tool itself.
2472 let bootstrap_host = builder.config.build;
2473 let compiler = builder.compiler(0, bootstrap_host);
2474 let cargo = tool::prepare_tool_cargo(
2477 Mode::ToolBootstrap,
2480 "src/tools/replace-version-placeholder",
2484 try_run(builder, &mut cargo.into());
2487 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2488 run.path("src/tools/replace-version-placeholder")
2491 fn make_run(run: RunConfig<'_>) {
2492 run.builder.ensure(Self);
2496 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2497 pub struct LintDocs {
2498 pub compiler: Compiler,
2499 pub target: TargetSelection,
2502 impl Step for LintDocs {
2504 const DEFAULT: bool = true;
2505 const ONLY_HOSTS: bool = true;
2507 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2508 run.path("src/tools/lint-docs")
2511 fn make_run(run: RunConfig<'_>) {
2512 run.builder.ensure(LintDocs {
2513 compiler: run.builder.compiler(run.builder.top_stage, run.builder.config.build),
2518 /// Tests that the lint examples in the rustc book generate the correct
2519 /// lints and have the expected format.
2520 fn run(self, builder: &Builder<'_>) {
2521 builder.ensure(crate::doc::RustcBook {
2522 compiler: self.compiler,
2523 target: self.target,