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::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)]
305 host: TargetSelection,
310 const ONLY_HOSTS: bool = true;
312 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
313 run.path("src/tools/rls")
316 fn make_run(run: RunConfig<'_>) {
317 run.builder.ensure(Rls { stage: run.builder.top_stage, host: run.target });
320 /// Runs `cargo test` for the rls.
321 fn run(self, builder: &Builder<'_>) {
322 let stage = self.stage;
323 let host = self.host;
324 let compiler = builder.compiler(stage, host);
327 builder.ensure(tool::Rls { compiler, target: self.host, extra_features: Vec::new() });
328 if build_result.is_none() {
329 eprintln!("failed to test rls: could not build");
333 let mut cargo = tool::prepare_tool_cargo(
340 SourceType::Submodule,
344 cargo.add_rustc_lib_path(builder, compiler);
345 cargo.arg("--").args(builder.config.cmd.test_args());
347 if try_run(builder, &mut cargo.into()) {
348 builder.save_toolstate("rls", ToolState::TestPass);
353 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
354 pub struct RustAnalyzer {
356 host: TargetSelection,
359 impl Step for RustAnalyzer {
361 const ONLY_HOSTS: bool = true;
362 const DEFAULT: bool = true;
364 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
365 run.path("src/tools/rust-analyzer")
368 fn make_run(run: RunConfig<'_>) {
369 run.builder.ensure(Self { stage: run.builder.top_stage, host: run.target });
372 /// Runs `cargo test` for rust-analyzer
373 fn run(self, builder: &Builder<'_>) {
374 let stage = self.stage;
375 let host = self.host;
376 let compiler = builder.compiler(stage, host);
378 builder.ensure(tool::RustAnalyzer { compiler, target: self.host }).expect("in-tree tool");
380 let workspace_path = "src/tools/rust-analyzer";
381 // until the whole RA test suite runs on `i686`, we only run
382 // `proc-macro-srv` tests
383 let crate_path = "src/tools/rust-analyzer/crates/proc-macro-srv";
384 let mut cargo = tool::prepare_tool_cargo(
392 &["sysroot-abi".to_owned()],
395 let dir = builder.src.join(workspace_path);
396 // needed by rust-analyzer to find its own text fixtures, cf.
397 // https://github.com/rust-analyzer/expect-test/issues/33
398 cargo.env("CARGO_WORKSPACE_DIR", &dir);
400 // RA's test suite tries to write to the source directory, that can't
402 cargo.env("SKIP_SLOW_TESTS", "1");
404 cargo.add_rustc_lib_path(builder, compiler);
405 cargo.arg("--").args(builder.config.cmd.test_args());
407 builder.run(&mut cargo.into());
411 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
414 host: TargetSelection,
417 impl Step for Rustfmt {
419 const ONLY_HOSTS: bool = true;
421 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
422 run.path("src/tools/rustfmt")
425 fn make_run(run: RunConfig<'_>) {
426 run.builder.ensure(Rustfmt { stage: run.builder.top_stage, host: run.target });
429 /// Runs `cargo test` for rustfmt.
430 fn run(self, builder: &Builder<'_>) {
431 let stage = self.stage;
432 let host = self.host;
433 let compiler = builder.compiler(stage, host);
436 .ensure(tool::Rustfmt { compiler, target: self.host, extra_features: Vec::new() })
437 .expect("in-tree tool");
439 let mut cargo = tool::prepare_tool_cargo(
450 let dir = testdir(builder, compiler.host);
451 t!(fs::create_dir_all(&dir));
452 cargo.env("RUSTFMT_TEST_DIR", dir);
454 cargo.add_rustc_lib_path(builder, compiler);
456 builder.run(&mut cargo.into());
460 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
461 pub struct RustDemangler {
463 host: TargetSelection,
466 impl Step for RustDemangler {
468 const ONLY_HOSTS: bool = true;
470 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
471 run.path("src/tools/rust-demangler")
474 fn make_run(run: RunConfig<'_>) {
475 run.builder.ensure(RustDemangler { stage: run.builder.top_stage, host: run.target });
478 /// Runs `cargo test` for rust-demangler.
479 fn run(self, builder: &Builder<'_>) {
480 let stage = self.stage;
481 let host = self.host;
482 let compiler = builder.compiler(stage, host);
484 let rust_demangler = builder
485 .ensure(tool::RustDemangler { compiler, target: self.host, extra_features: Vec::new() })
486 .expect("in-tree tool");
487 let mut cargo = tool::prepare_tool_cargo(
493 "src/tools/rust-demangler",
498 let dir = testdir(builder, compiler.host);
499 t!(fs::create_dir_all(&dir));
501 cargo.env("RUST_DEMANGLER_DRIVER_PATH", rust_demangler);
503 cargo.arg("--").args(builder.config.cmd.test_args());
505 cargo.add_rustc_lib_path(builder, compiler);
507 builder.run(&mut cargo.into());
511 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
514 host: TargetSelection,
519 const ONLY_HOSTS: bool = true;
521 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
522 run.path("src/tools/miri")
525 fn make_run(run: RunConfig<'_>) {
526 run.builder.ensure(Miri { stage: run.builder.top_stage, host: run.target });
529 /// Runs `cargo test` for miri.
530 fn run(self, builder: &Builder<'_>) {
531 let stage = self.stage;
532 let host = self.host;
533 let compiler = builder.compiler(stage, host);
534 // We need the stdlib for the *next* stage, as it was built with this compiler that also built Miri.
535 // Except if we are at stage 2, the bootstrap loop is complete and we can stick with our current stage.
536 let compiler_std = builder.compiler(if stage < 2 { stage + 1 } else { stage }, host);
539 builder.ensure(tool::Miri { compiler, target: self.host, extra_features: Vec::new() });
540 let cargo_miri = builder.ensure(tool::CargoMiri {
543 extra_features: Vec::new(),
545 // The stdlib we need might be at a different stage. And just asking for the
546 // sysroot does not seem to populate it, so we do that first.
547 builder.ensure(compile::Std::new(compiler_std, host));
548 let sysroot = builder.sysroot(compiler_std);
549 if let (Some(miri), Some(_cargo_miri)) = (miri, cargo_miri) {
551 builder.cargo(compiler, Mode::ToolRustc, SourceType::Submodule, host, "install");
553 // Configure `cargo install` path. cargo adds a `bin/`.
554 cargo.env("CARGO_INSTALL_ROOT", &builder.out);
556 let mut cargo = Command::from(cargo);
557 if !try_run(builder, &mut cargo) {
561 // # Run `cargo miri setup`.
562 let mut cargo = tool::prepare_tool_cargo(
568 "src/tools/miri/cargo-miri",
569 SourceType::Submodule,
572 cargo.add_rustc_lib_path(builder, compiler);
573 cargo.arg("--").arg("miri").arg("setup");
575 // Tell `cargo miri setup` where to find the sources.
576 cargo.env("XARGO_RUST_SRC", builder.src.join("library"));
577 // Tell it where to find Miri.
578 cargo.env("MIRI", &miri);
580 cargo.env("RUST_BACKTRACE", "1");
581 // Let cargo-miri know where xargo ended up.
582 cargo.env("XARGO_CHECK", builder.out.join("bin").join("xargo-check"));
584 let mut cargo = Command::from(cargo);
585 if !try_run(builder, &mut cargo) {
589 // # Determine where Miri put its sysroot.
590 // To this end, we run `cargo miri setup --print-sysroot` and capture the output.
591 // (We do this separately from the above so that when the setup actually
592 // happens we get some output.)
593 // We re-use the `cargo` from above.
594 cargo.arg("--print-sysroot");
596 // FIXME: Is there a way in which we can re-use the usual `run` helpers?
597 let miri_sysroot = if builder.config.dry_run {
600 builder.verbose(&format!("running: {:?}", cargo));
603 .expect("We already ran `cargo miri setup` before and that worked");
604 assert!(out.status.success(), "`cargo miri setup` returned with non-0 exit code");
605 // Output is "<sysroot>\n".
606 let stdout = String::from_utf8(out.stdout)
607 .expect("`cargo miri setup` stdout is not valid UTF-8");
608 let sysroot = stdout.trim_end();
609 builder.verbose(&format!("`cargo miri setup --print-sysroot` said: {:?}", sysroot));
613 // # Run `cargo test`.
614 let mut cargo = tool::prepare_tool_cargo(
621 SourceType::Submodule,
624 cargo.add_rustc_lib_path(builder, compiler);
626 // miri tests need to know about the stage sysroot
627 cargo.env("MIRI_SYSROOT", miri_sysroot);
628 cargo.env("MIRI_HOST_SYSROOT", sysroot);
629 cargo.env("RUSTC_LIB_PATH", builder.rustc_libdir(compiler));
630 cargo.env("MIRI", miri);
632 if builder.config.cmd.bless() {
633 cargo.env("MIRI_BLESS", "Gesundheit");
636 cargo.arg("--").args(builder.config.cmd.test_args());
638 let mut cargo = Command::from(cargo);
639 if !try_run(builder, &mut cargo) {
644 builder.save_toolstate("miri", ToolState::TestPass);
646 eprintln!("failed to test miri: could not build");
651 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
652 pub struct CompiletestTest {
653 host: TargetSelection,
656 impl Step for CompiletestTest {
659 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
660 run.path("src/tools/compiletest")
663 fn make_run(run: RunConfig<'_>) {
664 run.builder.ensure(CompiletestTest { host: run.target });
667 /// Runs `cargo test` for compiletest.
668 fn run(self, builder: &Builder<'_>) {
669 let host = self.host;
670 let compiler = builder.compiler(0, host);
672 // We need `ToolStd` for the locally-built sysroot because
673 // compiletest uses unstable features of the `test` crate.
674 builder.ensure(compile::Std::new(compiler, host));
675 let cargo = tool::prepare_tool_cargo(
681 "src/tools/compiletest",
686 try_run(builder, &mut cargo.into());
690 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
693 host: TargetSelection,
696 impl Step for Clippy {
698 const ONLY_HOSTS: bool = true;
699 const DEFAULT: bool = false;
701 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
702 run.path("src/tools/clippy")
705 fn make_run(run: RunConfig<'_>) {
706 run.builder.ensure(Clippy { stage: run.builder.top_stage, host: run.target });
709 /// Runs `cargo test` for clippy.
710 fn run(self, builder: &Builder<'_>) {
711 let stage = self.stage;
712 let host = self.host;
713 let compiler = builder.compiler(stage, host);
716 .ensure(tool::Clippy { compiler, target: self.host, extra_features: Vec::new() })
717 .expect("in-tree tool");
718 let mut cargo = tool::prepare_tool_cargo(
729 cargo.env("RUSTC_TEST_SUITE", builder.rustc(compiler));
730 cargo.env("RUSTC_LIB_PATH", builder.rustc_libdir(compiler));
731 let host_libs = builder.stage_out(compiler, Mode::ToolRustc).join(builder.cargo_dir());
732 cargo.env("HOST_LIBS", host_libs);
734 cargo.arg("--").args(builder.config.cmd.test_args());
736 cargo.add_rustc_lib_path(builder, compiler);
738 if builder.try_run(&mut cargo.into()) {
739 // The tests succeeded; nothing to do.
743 if !builder.config.cmd.bless() {
744 crate::detail_exit(1);
747 let mut cargo = builder.cargo(compiler, Mode::ToolRustc, SourceType::InTree, host, "run");
748 cargo.arg("-p").arg("clippy_dev");
749 // clippy_dev gets confused if it can't find `clippy/Cargo.toml`
750 cargo.current_dir(&builder.src.join("src").join("tools").join("clippy"));
751 if builder.config.rust_optimize {
752 cargo.env("PROFILE", "release");
754 cargo.env("PROFILE", "debug");
758 builder.run(&mut cargo.into());
762 fn path_for_cargo(builder: &Builder<'_>, compiler: Compiler) -> OsString {
763 // Configure PATH to find the right rustc. NB. we have to use PATH
764 // and not RUSTC because the Cargo test suite has tests that will
765 // fail if rustc is not spelled `rustc`.
766 let path = builder.sysroot(compiler).join("bin");
767 let old_path = env::var_os("PATH").unwrap_or_default();
768 env::join_paths(iter::once(path).chain(env::split_paths(&old_path))).expect("")
771 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
772 pub struct RustdocTheme {
773 pub compiler: Compiler,
776 impl Step for RustdocTheme {
778 const DEFAULT: bool = true;
779 const ONLY_HOSTS: bool = true;
781 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
782 run.path("src/tools/rustdoc-themes")
785 fn make_run(run: RunConfig<'_>) {
786 let compiler = run.builder.compiler(run.builder.top_stage, run.target);
788 run.builder.ensure(RustdocTheme { compiler });
791 fn run(self, builder: &Builder<'_>) {
792 let rustdoc = builder.bootstrap_out.join("rustdoc");
793 let mut cmd = builder.tool_cmd(Tool::RustdocTheme);
794 cmd.arg(rustdoc.to_str().unwrap())
795 .arg(builder.src.join("src/librustdoc/html/static/css/themes").to_str().unwrap())
796 .env("RUSTC_STAGE", self.compiler.stage.to_string())
797 .env("RUSTC_SYSROOT", builder.sysroot(self.compiler))
798 .env("RUSTDOC_LIBDIR", builder.sysroot_libdir(self.compiler, self.compiler.host))
799 .env("CFG_RELEASE_CHANNEL", &builder.config.channel)
800 .env("RUSTDOC_REAL", builder.rustdoc(self.compiler))
801 .env("RUSTC_BOOTSTRAP", "1");
802 if let Some(linker) = builder.linker(self.compiler.host) {
803 cmd.env("RUSTDOC_LINKER", linker);
805 if builder.is_fuse_ld_lld(self.compiler.host) {
806 cmd.env("RUSTDOC_FUSE_LD_LLD", "1");
808 try_run(builder, &mut cmd);
812 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
813 pub struct RustdocJSStd {
814 pub target: TargetSelection,
817 impl Step for RustdocJSStd {
819 const DEFAULT: bool = true;
820 const ONLY_HOSTS: bool = true;
822 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
823 run.suite_path("src/test/rustdoc-js-std")
826 fn make_run(run: RunConfig<'_>) {
827 run.builder.ensure(RustdocJSStd { target: run.target });
830 fn run(self, builder: &Builder<'_>) {
831 if let Some(ref nodejs) = builder.config.nodejs {
832 let mut command = Command::new(nodejs);
834 .arg(builder.src.join("src/tools/rustdoc-js/tester.js"))
837 .arg("--resource-suffix")
838 .arg(&builder.version)
840 .arg(builder.doc_out(self.target))
841 .arg("--test-folder")
842 .arg(builder.src.join("src/test/rustdoc-js-std"));
843 for path in &builder.paths {
845 util::is_valid_test_suite_arg(path, "src/test/rustdoc-js-std", builder)
847 if !p.ends_with(".js") {
848 eprintln!("A non-js file was given: `{}`", path.display());
849 panic!("Cannot run rustdoc-js-std tests");
851 command.arg("--test-file").arg(path);
854 builder.ensure(crate::doc::Std { target: self.target, stage: builder.top_stage });
855 builder.run(&mut command);
857 builder.info("No nodejs found, skipping \"src/test/rustdoc-js-std\" tests");
862 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
863 pub struct RustdocJSNotStd {
864 pub target: TargetSelection,
865 pub compiler: Compiler,
868 impl Step for RustdocJSNotStd {
870 const DEFAULT: bool = true;
871 const ONLY_HOSTS: bool = true;
873 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
874 run.suite_path("src/test/rustdoc-js")
877 fn make_run(run: RunConfig<'_>) {
878 let compiler = run.builder.compiler(run.builder.top_stage, run.build_triple());
879 run.builder.ensure(RustdocJSNotStd { target: run.target, compiler });
882 fn run(self, builder: &Builder<'_>) {
883 if builder.config.nodejs.is_some() {
884 builder.ensure(Compiletest {
885 compiler: self.compiler,
889 path: "src/test/rustdoc-js",
893 builder.info("No nodejs found, skipping \"src/test/rustdoc-js\" tests");
898 fn get_browser_ui_test_version_inner(npm: &Path, global: bool) -> Option<String> {
899 let mut command = Command::new(&npm);
900 command.arg("list").arg("--parseable").arg("--long").arg("--depth=0");
902 command.arg("--global");
906 .map(|output| String::from_utf8_lossy(&output.stdout).into_owned())
907 .unwrap_or(String::new());
908 lines.lines().find_map(|l| l.split(":browser-ui-test@").skip(1).next()).map(|v| v.to_owned())
911 fn get_browser_ui_test_version(npm: &Path) -> Option<String> {
912 get_browser_ui_test_version_inner(npm, false)
913 .or_else(|| get_browser_ui_test_version_inner(npm, true))
916 fn compare_browser_ui_test_version(installed_version: &str, src: &Path) {
917 match fs::read_to_string(
918 src.join("src/ci/docker/host-x86_64/x86_64-gnu-tools/browser-ui-test.version"),
921 if v.trim() != installed_version {
923 "⚠️ Installed version of browser-ui-test (`{}`) is different than the \
924 one used in the CI (`{}`)",
928 "You can install this version using `npm update browser-ui-test` or by using \
929 `npm install browser-ui-test@{}`",
934 Err(e) => eprintln!("Couldn't find the CI browser-ui-test version: {:?}", e),
938 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
939 pub struct RustdocGUI {
940 pub target: TargetSelection,
941 pub compiler: Compiler,
944 impl Step for RustdocGUI {
946 const DEFAULT: bool = true;
947 const ONLY_HOSTS: bool = true;
949 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
950 let builder = run.builder;
951 let run = run.suite_path("src/test/rustdoc-gui");
952 run.lazy_default_condition(Box::new(move || {
953 builder.config.nodejs.is_some()
958 .map(|p| get_browser_ui_test_version(p).is_some())
963 fn make_run(run: RunConfig<'_>) {
964 let compiler = run.builder.compiler(run.builder.top_stage, run.build_triple());
965 run.builder.ensure(RustdocGUI { target: run.target, compiler });
968 fn run(self, builder: &Builder<'_>) {
969 let nodejs = builder.config.nodejs.as_ref().expect("nodejs isn't available");
970 let npm = builder.config.npm.as_ref().expect("npm isn't available");
972 builder.ensure(compile::Std::new(self.compiler, self.target));
974 // The goal here is to check if the necessary packages are installed, and if not, we
976 match get_browser_ui_test_version(&npm) {
978 // We also check the version currently used in CI and emit a warning if it's not the
980 compare_browser_ui_test_version(&version, &builder.build.src);
984 "error: rustdoc-gui test suite cannot be run because npm `browser-ui-test` \
985 dependency is missing",
988 "If you want to install the `{0}` dependency, run `npm install {0}`",
991 panic!("Cannot run rustdoc-gui tests");
995 let out_dir = builder.test_out(self.target).join("rustdoc-gui");
997 // We remove existing folder to be sure there won't be artifacts remaining.
998 builder.clear_if_dirty(&out_dir, &builder.rustdoc(self.compiler));
1000 let src_path = builder.build.src.join("src/test/rustdoc-gui/src");
1001 // We generate docs for the libraries present in the rustdoc-gui's src folder.
1002 for entry in src_path.read_dir().expect("read_dir call failed") {
1003 if let Ok(entry) = entry {
1004 let path = entry.path();
1010 let mut cargo = Command::new(&builder.initial_cargo);
1013 .arg("--target-dir")
1015 .env("RUSTDOC", builder.rustdoc(self.compiler))
1016 .env("RUSTC", builder.rustc(self.compiler))
1018 // FIXME: implement a `// compile-flags` command or similar
1019 // instead of hard-coding this test
1020 if entry.file_name() == "link_to_definition" {
1021 cargo.env("RUSTDOCFLAGS", "-Zunstable-options --generate-link-to-definition");
1023 builder.run(&mut cargo);
1027 // We now run GUI tests.
1028 let mut command = Command::new(&nodejs);
1030 .arg(builder.build.src.join("src/tools/rustdoc-gui/tester.js"))
1032 .arg(&builder.jobs().to_string())
1033 .arg("--doc-folder")
1034 .arg(out_dir.join("doc"))
1035 .arg("--tests-folder")
1036 .arg(builder.build.src.join("src/test/rustdoc-gui"));
1037 for path in &builder.paths {
1038 if let Some(p) = util::is_valid_test_suite_arg(path, "src/test/rustdoc-gui", builder) {
1039 if !p.ends_with(".goml") {
1040 eprintln!("A non-goml file was given: `{}`", path.display());
1041 panic!("Cannot run rustdoc-gui tests");
1043 if let Some(name) = path.file_name().and_then(|f| f.to_str()) {
1044 command.arg("--file").arg(name);
1048 for test_arg in builder.config.cmd.test_args() {
1049 command.arg(test_arg);
1051 builder.run(&mut command);
1055 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1058 impl Step for Tidy {
1060 const DEFAULT: bool = true;
1061 const ONLY_HOSTS: bool = true;
1063 /// Runs the `tidy` tool.
1065 /// This tool in `src/tools` checks up on various bits and pieces of style and
1066 /// otherwise just implements a few lint-like checks that are specific to the
1067 /// compiler itself.
1069 /// Once tidy passes, this step also runs `fmt --check` if tests are being run
1070 /// for the `dev` or `nightly` channels.
1071 fn run(self, builder: &Builder<'_>) {
1072 let mut cmd = builder.tool_cmd(Tool::Tidy);
1073 cmd.arg(&builder.src);
1074 cmd.arg(&builder.initial_cargo);
1075 cmd.arg(&builder.out);
1076 cmd.arg(builder.jobs().to_string());
1077 if builder.is_verbose() {
1078 cmd.arg("--verbose");
1081 builder.info("tidy check");
1082 try_run(builder, &mut cmd);
1084 if builder.config.channel == "dev" || builder.config.channel == "nightly" {
1085 builder.info("fmt check");
1086 if builder.initial_rustfmt().is_none() {
1087 let inferred_rustfmt_dir = builder.config.initial_rustc.parent().unwrap();
1090 error: no `rustfmt` binary found in {PATH}
1091 info: `rust.channel` is currently set to \"{CHAN}\"
1092 help: if you are testing a beta branch, set `rust.channel` to \"beta\" in the `config.toml` file
1093 help: to skip test's attempt to check tidiness, pass `--exclude src/tools/tidy` to `x.py test`",
1094 PATH = inferred_rustfmt_dir.display(),
1095 CHAN = builder.config.channel,
1097 crate::detail_exit(1);
1099 crate::format::format(&builder, !builder.config.cmd.bless(), &[]);
1103 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1104 run.path("src/tools/tidy")
1107 fn make_run(run: RunConfig<'_>) {
1108 run.builder.ensure(Tidy);
1112 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1113 pub struct ExpandYamlAnchors;
1115 impl Step for ExpandYamlAnchors {
1117 const ONLY_HOSTS: bool = true;
1119 /// Ensure the `generate-ci-config` tool was run locally.
1121 /// The tool in `src/tools` reads the CI definition in `src/ci/builders.yml` and generates the
1122 /// appropriate configuration for all our CI providers. This step ensures the tool was called
1123 /// by the user before committing CI changes.
1124 fn run(self, builder: &Builder<'_>) {
1125 builder.info("Ensuring the YAML anchors in the GitHub Actions config were expanded");
1128 &mut builder.tool_cmd(Tool::ExpandYamlAnchors).arg("check").arg(&builder.src),
1132 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1133 run.path("src/tools/expand-yaml-anchors")
1136 fn make_run(run: RunConfig<'_>) {
1137 run.builder.ensure(ExpandYamlAnchors);
1141 fn testdir(builder: &Builder<'_>, host: TargetSelection) -> PathBuf {
1142 builder.out.join(host.triple).join("test")
1145 macro_rules! default_test {
1146 ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr }) => {
1147 test!($name { path: $path, mode: $mode, suite: $suite, default: true, host: false });
1151 macro_rules! default_test_with_compare_mode {
1152 ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr,
1153 compare_mode: $compare_mode:expr }) => {
1154 test_with_compare_mode!($name {
1160 compare_mode: $compare_mode
1165 macro_rules! host_test {
1166 ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr }) => {
1167 test!($name { path: $path, mode: $mode, suite: $suite, default: true, host: true });
1172 ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr, default: $default:expr,
1173 host: $host:expr }) => {
1174 test_definitions!($name {
1185 macro_rules! test_with_compare_mode {
1186 ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr, default: $default:expr,
1187 host: $host:expr, compare_mode: $compare_mode:expr }) => {
1188 test_definitions!($name {
1194 compare_mode: Some($compare_mode)
1199 macro_rules! test_definitions {
1204 default: $default:expr,
1206 compare_mode: $compare_mode:expr
1208 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1210 pub compiler: Compiler,
1211 pub target: TargetSelection,
1214 impl Step for $name {
1216 const DEFAULT: bool = $default;
1217 const ONLY_HOSTS: bool = $host;
1219 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1220 run.suite_path($path)
1223 fn make_run(run: RunConfig<'_>) {
1224 let compiler = run.builder.compiler(run.builder.top_stage, run.build_triple());
1226 run.builder.ensure($name { compiler, target: run.target });
1229 fn run(self, builder: &Builder<'_>) {
1230 builder.ensure(Compiletest {
1231 compiler: self.compiler,
1232 target: self.target,
1236 compare_mode: $compare_mode,
1243 default_test!(Ui { path: "src/test/ui", mode: "ui", suite: "ui" });
1245 default_test!(RunPassValgrind {
1246 path: "src/test/run-pass-valgrind",
1247 mode: "run-pass-valgrind",
1248 suite: "run-pass-valgrind"
1251 default_test!(MirOpt { path: "src/test/mir-opt", mode: "mir-opt", suite: "mir-opt" });
1253 default_test!(Codegen { path: "src/test/codegen", mode: "codegen", suite: "codegen" });
1255 default_test!(CodegenUnits {
1256 path: "src/test/codegen-units",
1257 mode: "codegen-units",
1258 suite: "codegen-units"
1261 default_test!(Incremental {
1262 path: "src/test/incremental",
1263 mode: "incremental",
1264 suite: "incremental"
1267 default_test_with_compare_mode!(Debuginfo {
1268 path: "src/test/debuginfo",
1271 compare_mode: "split-dwarf"
1274 host_test!(UiFullDeps { path: "src/test/ui-fulldeps", mode: "ui", suite: "ui-fulldeps" });
1276 host_test!(Rustdoc { path: "src/test/rustdoc", mode: "rustdoc", suite: "rustdoc" });
1277 host_test!(RustdocUi { path: "src/test/rustdoc-ui", mode: "ui", suite: "rustdoc-ui" });
1279 host_test!(RustdocJson {
1280 path: "src/test/rustdoc-json",
1281 mode: "rustdoc-json",
1282 suite: "rustdoc-json"
1285 host_test!(Pretty { path: "src/test/pretty", mode: "pretty", suite: "pretty" });
1287 default_test!(RunMake { path: "src/test/run-make", mode: "run-make", suite: "run-make" });
1289 host_test!(RunMakeFullDeps {
1290 path: "src/test/run-make-fulldeps",
1292 suite: "run-make-fulldeps"
1295 default_test!(Assembly { path: "src/test/assembly", mode: "assembly", suite: "assembly" });
1297 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1298 struct Compiletest {
1300 target: TargetSelection,
1302 suite: &'static str,
1304 compare_mode: Option<&'static str>,
1307 impl Step for Compiletest {
1310 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1314 /// Executes the `compiletest` tool to run a suite of tests.
1316 /// Compiles all tests with `compiler` for `target` with the specified
1317 /// compiletest `mode` and `suite` arguments. For example `mode` can be
1318 /// "run-pass" or `suite` can be something like `debuginfo`.
1319 fn run(self, builder: &Builder<'_>) {
1320 if builder.top_stage == 0 && env::var("COMPILETEST_FORCE_STAGE0").is_err() {
1322 error: `--stage 0` runs compiletest on the beta compiler, not your local changes, and will almost always cause tests to fail
1323 help: to test the compiler, use `--stage 1` instead
1324 help: to test the standard library, use `--stage 0 library/std` instead
1325 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`."
1327 crate::detail_exit(1);
1330 let compiler = self.compiler;
1331 let target = self.target;
1332 let mode = self.mode;
1333 let suite = self.suite;
1335 // Path for test suite
1336 let suite_path = self.path;
1338 // Skip codegen tests if they aren't enabled in configuration.
1339 if !builder.config.codegen_tests && suite == "codegen" {
1343 if suite == "debuginfo" {
1345 .ensure(dist::DebuggerScripts { sysroot: builder.sysroot(compiler), host: target });
1348 if suite.ends_with("fulldeps") {
1349 builder.ensure(compile::Rustc::new(compiler, target));
1352 builder.ensure(compile::Std::new(compiler, target));
1353 // ensure that `libproc_macro` is available on the host.
1354 builder.ensure(compile::Std::new(compiler, compiler.host));
1356 // Also provide `rust_test_helpers` for the host.
1357 builder.ensure(native::TestHelpers { target: compiler.host });
1359 // As well as the target, except for plain wasm32, which can't build it
1360 if !target.contains("wasm") || target.contains("emscripten") {
1361 builder.ensure(native::TestHelpers { target });
1364 builder.ensure(RemoteCopyLibs { compiler, target });
1366 let mut cmd = builder.tool_cmd(Tool::Compiletest);
1368 // compiletest currently has... a lot of arguments, so let's just pass all
1371 cmd.arg("--compile-lib-path").arg(builder.rustc_libdir(compiler));
1372 cmd.arg("--run-lib-path").arg(builder.sysroot_libdir(compiler, target));
1373 cmd.arg("--rustc-path").arg(builder.rustc(compiler));
1375 let is_rustdoc = suite.ends_with("rustdoc-ui") || suite.ends_with("rustdoc-js");
1377 // Avoid depending on rustdoc when we don't need it.
1378 if mode == "rustdoc"
1379 || mode == "run-make"
1380 || (mode == "ui" && is_rustdoc)
1381 || mode == "js-doc-test"
1382 || mode == "rustdoc-json"
1384 cmd.arg("--rustdoc-path").arg(builder.rustdoc(compiler));
1387 if mode == "rustdoc-json" {
1388 // Use the beta compiler for jsondocck
1389 let json_compiler = compiler.with_stage(0);
1390 cmd.arg("--jsondocck-path")
1391 .arg(builder.ensure(tool::JsonDocCk { compiler: json_compiler, target }));
1394 if mode == "run-make" {
1395 let rust_demangler = builder
1396 .ensure(tool::RustDemangler {
1398 target: compiler.host,
1399 extra_features: Vec::new(),
1401 .expect("in-tree tool");
1402 cmd.arg("--rust-demangler-path").arg(rust_demangler);
1405 cmd.arg("--src-base").arg(builder.src.join("src/test").join(suite));
1406 cmd.arg("--build-base").arg(testdir(builder, compiler.host).join(suite));
1407 cmd.arg("--stage-id").arg(format!("stage{}-{}", compiler.stage, target));
1408 cmd.arg("--suite").arg(suite);
1409 cmd.arg("--mode").arg(mode);
1410 cmd.arg("--target").arg(target.rustc_target_arg());
1411 cmd.arg("--host").arg(&*compiler.host.triple);
1412 cmd.arg("--llvm-filecheck").arg(builder.llvm_filecheck(builder.config.build));
1414 if builder.config.cmd.bless() {
1418 if builder.config.cmd.force_rerun() {
1419 cmd.arg("--force-rerun");
1423 builder.config.cmd.compare_mode().or_else(|| {
1424 if builder.config.test_compare_mode { self.compare_mode } else { None }
1427 if let Some(ref pass) = builder.config.cmd.pass() {
1432 if let Some(ref run) = builder.config.cmd.run() {
1437 if let Some(ref nodejs) = builder.config.nodejs {
1438 cmd.arg("--nodejs").arg(nodejs);
1440 if let Some(ref npm) = builder.config.npm {
1441 cmd.arg("--npm").arg(npm);
1443 if builder.config.rust_optimize_tests {
1444 cmd.arg("--optimize-tests");
1446 let mut flags = if is_rustdoc { Vec::new() } else { vec!["-Crpath".to_string()] };
1447 flags.push(format!("-Cdebuginfo={}", builder.config.rust_debuginfo_level_tests));
1448 flags.push(builder.config.cmd.rustc_args().join(" "));
1450 if let Some(linker) = builder.linker(target) {
1451 cmd.arg("--linker").arg(linker);
1454 let mut hostflags = flags.clone();
1455 hostflags.push(format!("-Lnative={}", builder.test_helpers_out(compiler.host).display()));
1456 hostflags.extend(builder.lld_flags(compiler.host));
1457 cmd.arg("--host-rustcflags").arg(hostflags.join(" "));
1459 let mut targetflags = flags;
1460 targetflags.push(format!("-Lnative={}", builder.test_helpers_out(target).display()));
1461 targetflags.extend(builder.lld_flags(target));
1462 cmd.arg("--target-rustcflags").arg(targetflags.join(" "));
1464 cmd.arg("--python").arg(builder.python());
1466 if let Some(ref gdb) = builder.config.gdb {
1467 cmd.arg("--gdb").arg(gdb);
1470 let run = |cmd: &mut Command| {
1471 cmd.output().map(|output| {
1472 String::from_utf8_lossy(&output.stdout)
1475 .unwrap_or_else(|| panic!("{:?} failed {:?}", cmd, output))
1479 let lldb_exe = "lldb";
1480 let lldb_version = Command::new(lldb_exe)
1483 .map(|output| String::from_utf8_lossy(&output.stdout).to_string())
1485 if let Some(ref vers) = lldb_version {
1486 cmd.arg("--lldb-version").arg(vers);
1487 let lldb_python_dir = run(Command::new(lldb_exe).arg("-P")).ok();
1488 if let Some(ref dir) = lldb_python_dir {
1489 cmd.arg("--lldb-python-dir").arg(dir);
1493 if util::forcing_clang_based_tests() {
1494 let clang_exe = builder.llvm_out(target).join("bin").join("clang");
1495 cmd.arg("--run-clang-based-tests-with").arg(clang_exe);
1498 for exclude in &builder.config.exclude {
1500 cmd.arg(&exclude.path);
1503 // Get paths from cmd args
1504 let paths = match &builder.config.cmd {
1505 Subcommand::Test { ref paths, .. } => &paths[..],
1509 // Get test-args by striping suite path
1510 let mut test_args: Vec<&str> = paths
1512 .filter_map(|p| util::is_valid_test_suite_arg(p, suite_path, builder))
1515 test_args.append(&mut builder.config.cmd.test_args());
1517 cmd.args(&test_args);
1519 if builder.is_verbose() {
1520 cmd.arg("--verbose");
1523 if !builder.config.verbose_tests {
1527 let mut llvm_components_passed = false;
1528 let mut copts_passed = false;
1529 if builder.config.llvm_enabled() {
1530 let llvm_config = builder.ensure(native::Llvm { target: builder.config.build });
1531 if !builder.config.dry_run {
1532 let llvm_version = output(Command::new(&llvm_config).arg("--version"));
1533 let llvm_components = output(Command::new(&llvm_config).arg("--components"));
1534 // Remove trailing newline from llvm-config output.
1535 cmd.arg("--llvm-version")
1536 .arg(llvm_version.trim())
1537 .arg("--llvm-components")
1538 .arg(llvm_components.trim());
1539 llvm_components_passed = true;
1541 if !builder.is_rust_llvm(target) {
1542 cmd.arg("--system-llvm");
1545 // Tests that use compiler libraries may inherit the `-lLLVM` link
1546 // requirement, but the `-L` library path is not propagated across
1547 // separate compilations. We can add LLVM's library path to the
1548 // platform-specific environment variable as a workaround.
1549 if !builder.config.dry_run && suite.ends_with("fulldeps") {
1550 let llvm_libdir = output(Command::new(&llvm_config).arg("--libdir"));
1551 add_link_lib_path(vec![llvm_libdir.trim().into()], &mut cmd);
1554 // Only pass correct values for these flags for the `run-make` suite as it
1555 // requires that a C++ compiler was configured which isn't always the case.
1556 if !builder.config.dry_run && matches!(suite, "run-make" | "run-make-fulldeps") {
1557 // The llvm/bin directory contains many useful cross-platform
1558 // tools. Pass the path to run-make tests so they can use them.
1559 let llvm_bin_path = llvm_config
1561 .expect("Expected llvm-config to be contained in directory");
1562 assert!(llvm_bin_path.is_dir());
1563 cmd.arg("--llvm-bin-dir").arg(llvm_bin_path);
1565 // If LLD is available, add it to the PATH
1566 if builder.config.lld_enabled {
1567 let lld_install_root =
1568 builder.ensure(native::Lld { target: builder.config.build });
1570 let lld_bin_path = lld_install_root.join("bin");
1572 let old_path = env::var_os("PATH").unwrap_or_default();
1573 let new_path = env::join_paths(
1574 std::iter::once(lld_bin_path).chain(env::split_paths(&old_path)),
1576 .expect("Could not add LLD bin path to PATH");
1577 cmd.env("PATH", new_path);
1582 // Only pass correct values for these flags for the `run-make` suite as it
1583 // requires that a C++ compiler was configured which isn't always the case.
1584 if !builder.config.dry_run && matches!(suite, "run-make" | "run-make-fulldeps") {
1586 .arg(builder.cc(target))
1588 .arg(builder.cxx(target).unwrap())
1590 .arg(builder.cflags(target, GitRepo::Rustc, CLang::C).join(" "))
1592 .arg(builder.cflags(target, GitRepo::Rustc, CLang::Cxx).join(" "));
1593 copts_passed = true;
1594 if let Some(ar) = builder.ar(target) {
1595 cmd.arg("--ar").arg(ar);
1599 if !llvm_components_passed {
1600 cmd.arg("--llvm-components").arg("");
1613 if builder.remote_tested(target) {
1614 cmd.arg("--remote-test-client").arg(builder.tool_exe(Tool::RemoteTestClient));
1617 // Running a C compiler on MSVC requires a few env vars to be set, to be
1618 // sure to set them here.
1620 // Note that if we encounter `PATH` we make sure to append to our own `PATH`
1621 // rather than stomp over it.
1622 if target.contains("msvc") {
1623 for &(ref k, ref v) in builder.cc[&target].env() {
1629 cmd.env("RUSTC_BOOTSTRAP", "1");
1630 // Override the rustc version used in symbol hashes to reduce the amount of normalization
1631 // needed when diffing test output.
1632 cmd.env("RUSTC_FORCE_RUSTC_VERSION", "compiletest");
1633 cmd.env("DOC_RUST_LANG_ORG_CHANNEL", builder.doc_rust_lang_org_channel());
1634 builder.add_rust_test_threads(&mut cmd);
1636 if builder.config.sanitizers_enabled(target) {
1637 cmd.env("RUSTC_SANITIZER_SUPPORT", "1");
1640 if builder.config.profiler_enabled(target) {
1641 cmd.env("RUSTC_PROFILER_SUPPORT", "1");
1644 cmd.env("RUST_TEST_TMPDIR", builder.tempdir());
1646 cmd.arg("--adb-path").arg("adb");
1647 cmd.arg("--adb-test-dir").arg(ADB_TEST_DIR);
1648 if target.contains("android") {
1649 // Assume that cc for this target comes from the android sysroot
1650 cmd.arg("--android-cross-path")
1651 .arg(builder.cc(target).parent().unwrap().parent().unwrap());
1653 cmd.arg("--android-cross-path").arg("");
1656 if builder.config.cmd.rustfix_coverage() {
1657 cmd.arg("--rustfix-coverage");
1660 cmd.env("BOOTSTRAP_CARGO", &builder.initial_cargo);
1662 cmd.arg("--channel").arg(&builder.config.channel);
1664 builder.ci_env.force_coloring_in_ci(&mut cmd);
1666 builder.info(&format!(
1667 "Check compiletest suite={} mode={} ({} -> {})",
1668 suite, mode, &compiler.host, target
1670 let _time = util::timeit(&builder);
1671 try_run(builder, &mut cmd);
1673 if let Some(compare_mode) = compare_mode {
1674 cmd.arg("--compare-mode").arg(compare_mode);
1675 builder.info(&format!(
1676 "Check compiletest suite={} mode={} compare_mode={} ({} -> {})",
1677 suite, mode, compare_mode, &compiler.host, target
1679 let _time = util::timeit(&builder);
1680 try_run(builder, &mut cmd);
1685 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
1693 impl Step for BookTest {
1695 const ONLY_HOSTS: bool = true;
1697 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1701 /// Runs the documentation tests for a book in `src/doc`.
1703 /// This uses the `rustdoc` that sits next to `compiler`.
1704 fn run(self, builder: &Builder<'_>) {
1705 // External docs are different from local because:
1706 // - Some books need pre-processing by mdbook before being tested.
1707 // - They need to save their state to toolstate.
1708 // - They are only tested on the "checktools" builders.
1710 // The local docs are tested by default, and we don't want to pay the
1711 // cost of building mdbook, so they use `rustdoc --test` directly.
1712 // Also, the unstable book is special because SUMMARY.md is generated,
1713 // so it is easier to just run `rustdoc` on its files.
1714 if self.is_ext_doc {
1715 self.run_ext_doc(builder);
1717 self.run_local_doc(builder);
1723 /// This runs the equivalent of `mdbook test` (via the rustbook wrapper)
1724 /// which in turn runs `rustdoc --test` on each file in the book.
1725 fn run_ext_doc(self, builder: &Builder<'_>) {
1726 let compiler = self.compiler;
1728 builder.ensure(compile::Std::new(compiler, compiler.host));
1730 // mdbook just executes a binary named "rustdoc", so we need to update
1731 // PATH so that it points to our rustdoc.
1732 let mut rustdoc_path = builder.rustdoc(compiler);
1734 let old_path = env::var_os("PATH").unwrap_or_default();
1735 let new_path = env::join_paths(iter::once(rustdoc_path).chain(env::split_paths(&old_path)))
1736 .expect("could not add rustdoc to PATH");
1738 let mut rustbook_cmd = builder.tool_cmd(Tool::Rustbook);
1739 let path = builder.src.join(&self.path);
1740 rustbook_cmd.env("PATH", new_path).arg("test").arg(path);
1741 builder.add_rust_test_threads(&mut rustbook_cmd);
1742 builder.info(&format!("Testing rustbook {}", self.path.display()));
1743 let _time = util::timeit(&builder);
1744 let toolstate = if try_run(builder, &mut rustbook_cmd) {
1749 builder.save_toolstate(self.name, toolstate);
1752 /// This runs `rustdoc --test` on all `.md` files in the path.
1753 fn run_local_doc(self, builder: &Builder<'_>) {
1754 let compiler = self.compiler;
1756 builder.ensure(compile::Std::new(compiler, compiler.host));
1758 // Do a breadth-first traversal of the `src/doc` directory and just run
1759 // tests for all files that end in `*.md`
1760 let mut stack = vec![builder.src.join(self.path)];
1761 let _time = util::timeit(&builder);
1762 let mut files = Vec::new();
1763 while let Some(p) = stack.pop() {
1765 stack.extend(t!(p.read_dir()).map(|p| t!(p).path()));
1769 if p.extension().and_then(|s| s.to_str()) != Some("md") {
1779 markdown_test(builder, compiler, &file);
1784 macro_rules! test_book {
1785 ($($name:ident, $path:expr, $book_name:expr, default=$default:expr;)+) => {
1787 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1792 impl Step for $name {
1794 const DEFAULT: bool = $default;
1795 const ONLY_HOSTS: bool = true;
1797 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1801 fn make_run(run: RunConfig<'_>) {
1802 run.builder.ensure($name {
1803 compiler: run.builder.compiler(run.builder.top_stage, run.target),
1807 fn run(self, builder: &Builder<'_>) {
1808 builder.ensure(BookTest {
1809 compiler: self.compiler,
1810 path: PathBuf::from($path),
1812 is_ext_doc: !$default,
1821 Nomicon, "src/doc/nomicon", "nomicon", default=false;
1822 Reference, "src/doc/reference", "reference", default=false;
1823 RustdocBook, "src/doc/rustdoc", "rustdoc", default=true;
1824 RustcBook, "src/doc/rustc", "rustc", default=true;
1825 RustByExample, "src/doc/rust-by-example", "rust-by-example", default=false;
1826 EmbeddedBook, "src/doc/embedded-book", "embedded-book", default=false;
1827 TheBook, "src/doc/book", "book", default=false;
1828 UnstableBook, "src/doc/unstable-book", "unstable-book", default=true;
1829 EditionGuide, "src/doc/edition-guide", "edition-guide", default=false;
1832 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1833 pub struct ErrorIndex {
1837 impl Step for ErrorIndex {
1839 const DEFAULT: bool = true;
1840 const ONLY_HOSTS: bool = true;
1842 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1843 run.path("src/tools/error_index_generator")
1846 fn make_run(run: RunConfig<'_>) {
1847 // error_index_generator depends on librustdoc. Use the compiler that
1848 // is normally used to build rustdoc for other tests (like compiletest
1849 // tests in src/test/rustdoc) so that it shares the same artifacts.
1850 let compiler = run.builder.compiler(run.builder.top_stage, run.builder.config.build);
1851 run.builder.ensure(ErrorIndex { compiler });
1854 /// Runs the error index generator tool to execute the tests located in the error
1857 /// The `error_index_generator` tool lives in `src/tools` and is used to
1858 /// generate a markdown file from the error indexes of the code base which is
1859 /// then passed to `rustdoc --test`.
1860 fn run(self, builder: &Builder<'_>) {
1861 let compiler = self.compiler;
1863 let dir = testdir(builder, compiler.host);
1864 t!(fs::create_dir_all(&dir));
1865 let output = dir.join("error-index.md");
1867 let mut tool = tool::ErrorIndex::command(builder);
1868 tool.arg("markdown").arg(&output);
1870 builder.info(&format!("Testing error-index stage{}", compiler.stage));
1871 let _time = util::timeit(&builder);
1872 builder.run_quiet(&mut tool);
1873 // The tests themselves need to link to std, so make sure it is
1875 builder.ensure(compile::Std::new(compiler, compiler.host));
1876 markdown_test(builder, compiler, &output);
1880 fn markdown_test(builder: &Builder<'_>, compiler: Compiler, markdown: &Path) -> bool {
1881 if let Ok(contents) = fs::read_to_string(markdown) {
1882 if !contents.contains("```") {
1887 builder.info(&format!("doc tests for: {}", markdown.display()));
1888 let mut cmd = builder.rustdoc_cmd(compiler);
1889 builder.add_rust_test_threads(&mut cmd);
1890 // allow for unstable options such as new editions
1892 cmd.arg("unstable-options");
1895 cmd.env("RUSTC_BOOTSTRAP", "1");
1897 let test_args = builder.config.cmd.test_args().join(" ");
1898 cmd.arg("--test-args").arg(test_args);
1900 if builder.config.verbose_tests {
1901 try_run(builder, &mut cmd)
1903 try_run_quiet(builder, &mut cmd)
1907 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1908 pub struct RustcGuide;
1910 impl Step for RustcGuide {
1912 const DEFAULT: bool = false;
1913 const ONLY_HOSTS: bool = true;
1915 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1916 run.path("src/doc/rustc-dev-guide")
1919 fn make_run(run: RunConfig<'_>) {
1920 run.builder.ensure(RustcGuide);
1923 fn run(self, builder: &Builder<'_>) {
1924 let relative_path = Path::new("src").join("doc").join("rustc-dev-guide");
1925 builder.update_submodule(&relative_path);
1927 let src = builder.src.join(relative_path);
1928 let mut rustbook_cmd = builder.tool_cmd(Tool::Rustbook);
1929 let toolstate = if try_run(builder, rustbook_cmd.arg("linkcheck").arg(&src)) {
1934 builder.save_toolstate("rustc-dev-guide", toolstate);
1938 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
1939 pub struct CrateLibrustc {
1941 target: TargetSelection,
1942 test_kind: TestKind,
1943 crates: Vec<Interned<String>>,
1946 impl Step for CrateLibrustc {
1948 const DEFAULT: bool = true;
1949 const ONLY_HOSTS: bool = true;
1951 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1952 run.crate_or_deps("rustc-main")
1955 fn make_run(run: RunConfig<'_>) {
1956 let builder = run.builder;
1957 let host = run.build_triple();
1958 let compiler = builder.compiler_for(builder.top_stage, host, host);
1962 .map(|p| builder.crate_paths[&p.assert_single_path().path].clone())
1964 let test_kind = builder.kind.into();
1966 builder.ensure(CrateLibrustc { compiler, target: run.target, test_kind, crates });
1969 fn run(self, builder: &Builder<'_>) {
1970 builder.ensure(Crate {
1971 compiler: self.compiler,
1972 target: self.target,
1974 test_kind: self.test_kind,
1975 crates: self.crates,
1980 #[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
1982 pub compiler: Compiler,
1983 pub target: TargetSelection,
1985 pub test_kind: TestKind,
1986 pub crates: Vec<Interned<String>>,
1989 impl Step for Crate {
1991 const DEFAULT: bool = true;
1993 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1994 run.crate_or_deps("test")
1997 fn make_run(run: RunConfig<'_>) {
1998 let builder = run.builder;
1999 let host = run.build_triple();
2000 let compiler = builder.compiler_for(builder.top_stage, host, host);
2001 let test_kind = builder.kind.into();
2005 .map(|p| builder.crate_paths[&p.assert_single_path().path].clone())
2008 builder.ensure(Crate { compiler, target: run.target, mode: Mode::Std, test_kind, crates });
2011 /// Runs all unit tests plus documentation tests for a given crate defined
2012 /// by a `Cargo.toml` (single manifest)
2014 /// This is what runs tests for crates like the standard library, compiler, etc.
2015 /// It essentially is the driver for running `cargo test`.
2017 /// Currently this runs all tests for a DAG by passing a bunch of `-p foo`
2018 /// arguments, and those arguments are discovered from `cargo metadata`.
2019 fn run(self, builder: &Builder<'_>) {
2020 let compiler = self.compiler;
2021 let target = self.target;
2022 let mode = self.mode;
2023 let test_kind = self.test_kind;
2025 builder.ensure(compile::Std::new(compiler, target));
2026 builder.ensure(RemoteCopyLibs { compiler, target });
2028 // If we're not doing a full bootstrap but we're testing a stage2
2029 // version of libstd, then what we're actually testing is the libstd
2030 // produced in stage1. Reflect that here by updating the compiler that
2031 // we're working with automatically.
2032 let compiler = builder.compiler_for(compiler.stage, compiler.host, target);
2035 builder.cargo(compiler, mode, SourceType::InTree, target, test_kind.subcommand());
2038 compile::std_cargo(builder, target, compiler.stage, &mut cargo);
2041 compile::rustc_cargo(builder, &mut cargo, target);
2043 _ => panic!("can only test libraries"),
2046 // Build up the base `cargo test` command.
2048 // Pass in some standard flags then iterate over the graph we've discovered
2049 // in `cargo metadata` with the maps above and figure out what `-p`
2050 // arguments need to get passed.
2051 if test_kind.subcommand() == "test" && !builder.fail_fast {
2052 cargo.arg("--no-fail-fast");
2054 match builder.doc_tests {
2059 cargo.args(&["--lib", "--bins", "--examples", "--tests", "--benches"]);
2064 for krate in &self.crates {
2065 cargo.arg("-p").arg(krate);
2068 // The tests are going to run with the *target* libraries, so we need to
2069 // ensure that those libraries show up in the LD_LIBRARY_PATH equivalent.
2071 // Note that to run the compiler we need to run with the *host* libraries,
2072 // but our wrapper scripts arrange for that to be the case anyway.
2073 let mut dylib_path = dylib_path();
2074 dylib_path.insert(0, PathBuf::from(&*builder.sysroot_libdir(compiler, target)));
2075 cargo.env(dylib_path_var(), env::join_paths(&dylib_path).unwrap());
2078 cargo.args(&builder.config.cmd.test_args());
2080 if !builder.config.verbose_tests {
2081 cargo.arg("--quiet");
2084 if target.contains("emscripten") {
2086 format!("CARGO_TARGET_{}_RUNNER", envify(&target.triple)),
2087 builder.config.nodejs.as_ref().expect("nodejs not configured"),
2089 } else if target.starts_with("wasm32") {
2090 let node = builder.config.nodejs.as_ref().expect("nodejs not configured");
2092 format!("{} {}/src/etc/wasm32-shim.js", node.display(), builder.src.display());
2093 cargo.env(format!("CARGO_TARGET_{}_RUNNER", envify(&target.triple)), &runner);
2094 } else if builder.remote_tested(target) {
2096 format!("CARGO_TARGET_{}_RUNNER", envify(&target.triple)),
2097 format!("{} run 0", builder.tool_exe(Tool::RemoteTestClient).display()),
2101 builder.info(&format!(
2102 "{} {:?} stage{} ({} -> {})",
2103 test_kind, self.crates, compiler.stage, &compiler.host, target
2105 let _time = util::timeit(&builder);
2106 try_run(builder, &mut cargo.into());
2110 /// Rustdoc is special in various ways, which is why this step is different from `Crate`.
2111 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2112 pub struct CrateRustdoc {
2113 host: TargetSelection,
2114 test_kind: TestKind,
2117 impl Step for CrateRustdoc {
2119 const DEFAULT: bool = true;
2120 const ONLY_HOSTS: bool = true;
2122 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2123 run.paths(&["src/librustdoc", "src/tools/rustdoc"])
2126 fn make_run(run: RunConfig<'_>) {
2127 let builder = run.builder;
2129 let test_kind = builder.kind.into();
2131 builder.ensure(CrateRustdoc { host: run.target, test_kind });
2134 fn run(self, builder: &Builder<'_>) {
2135 let test_kind = self.test_kind;
2136 let target = self.host;
2138 let compiler = if builder.download_rustc() {
2139 builder.compiler(builder.top_stage, target)
2141 // Use the previous stage compiler to reuse the artifacts that are
2142 // created when running compiletest for src/test/rustdoc. If this used
2143 // `compiler`, then it would cause rustdoc to be built *again*, which
2144 // isn't really necessary.
2145 builder.compiler_for(builder.top_stage, target, target)
2147 builder.ensure(compile::Rustc::new(compiler, target));
2149 let mut cargo = tool::prepare_tool_cargo(
2154 test_kind.subcommand(),
2155 "src/tools/rustdoc",
2159 if test_kind.subcommand() == "test" && !builder.fail_fast {
2160 cargo.arg("--no-fail-fast");
2162 match builder.doc_tests {
2167 cargo.args(&["--lib", "--bins", "--examples", "--tests", "--benches"]);
2172 cargo.arg("-p").arg("rustdoc:0.0.0");
2175 cargo.args(&builder.config.cmd.test_args());
2177 if self.host.contains("musl") {
2178 cargo.arg("'-Ctarget-feature=-crt-static'");
2181 // This is needed for running doctests on librustdoc. This is a bit of
2182 // an unfortunate interaction with how bootstrap works and how cargo
2183 // sets up the dylib path, and the fact that the doctest (in
2184 // html/markdown.rs) links to rustc-private libs. For stage1, the
2185 // compiler host dylibs (in stage1/lib) are not the same as the target
2186 // dylibs (in stage1/lib/rustlib/...). This is different from a normal
2187 // rust distribution where they are the same.
2189 // On the cargo side, normal tests use `target_process` which handles
2190 // setting up the dylib for a *target* (stage1/lib/rustlib/... in this
2191 // case). However, for doctests it uses `rustdoc_process` which only
2192 // sets up the dylib path for the *host* (stage1/lib), which is the
2195 // Recall that we special-cased `compiler_for(top_stage)` above, so we always use stage1.
2197 // It should be considered to just stop running doctests on
2198 // librustdoc. There is only one test, and it doesn't look too
2199 // important. There might be other ways to avoid this, but it seems
2200 // pretty convoluted.
2202 // See also https://github.com/rust-lang/rust/issues/13983 where the
2203 // host vs target dylibs for rustdoc are consistently tricky to deal
2206 // Note that this set the host libdir for `download_rustc`, which uses a normal rust distribution.
2207 let libdir = if builder.download_rustc() {
2208 builder.rustc_libdir(compiler)
2210 builder.sysroot_libdir(compiler, target).to_path_buf()
2212 let mut dylib_path = dylib_path();
2213 dylib_path.insert(0, PathBuf::from(&*libdir));
2214 cargo.env(dylib_path_var(), env::join_paths(&dylib_path).unwrap());
2216 if !builder.config.verbose_tests {
2217 cargo.arg("--quiet");
2220 builder.info(&format!(
2221 "{} rustdoc stage{} ({} -> {})",
2222 test_kind, compiler.stage, &compiler.host, target
2224 let _time = util::timeit(&builder);
2226 try_run(builder, &mut cargo.into());
2230 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2231 pub struct CrateRustdocJsonTypes {
2232 host: TargetSelection,
2233 test_kind: TestKind,
2236 impl Step for CrateRustdocJsonTypes {
2238 const DEFAULT: bool = true;
2239 const ONLY_HOSTS: bool = true;
2241 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2242 run.path("src/rustdoc-json-types")
2245 fn make_run(run: RunConfig<'_>) {
2246 let builder = run.builder;
2248 let test_kind = builder.kind.into();
2250 builder.ensure(CrateRustdocJsonTypes { host: run.target, test_kind });
2253 fn run(self, builder: &Builder<'_>) {
2254 let test_kind = self.test_kind;
2255 let target = self.host;
2257 // Use the previous stage compiler to reuse the artifacts that are
2258 // created when running compiletest for src/test/rustdoc. If this used
2259 // `compiler`, then it would cause rustdoc to be built *again*, which
2260 // isn't really necessary.
2261 let compiler = builder.compiler_for(builder.top_stage, target, target);
2262 builder.ensure(compile::Rustc::new(compiler, target));
2264 let mut cargo = tool::prepare_tool_cargo(
2269 test_kind.subcommand(),
2270 "src/rustdoc-json-types",
2274 if test_kind.subcommand() == "test" && !builder.fail_fast {
2275 cargo.arg("--no-fail-fast");
2278 cargo.arg("-p").arg("rustdoc-json-types");
2281 cargo.args(&builder.config.cmd.test_args());
2283 if self.host.contains("musl") {
2284 cargo.arg("'-Ctarget-feature=-crt-static'");
2287 if !builder.config.verbose_tests {
2288 cargo.arg("--quiet");
2291 builder.info(&format!(
2292 "{} rustdoc-json-types stage{} ({} -> {})",
2293 test_kind, compiler.stage, &compiler.host, target
2295 let _time = util::timeit(&builder);
2297 try_run(builder, &mut cargo.into());
2301 /// Some test suites are run inside emulators or on remote devices, and most
2302 /// of our test binaries are linked dynamically which means we need to ship
2303 /// the standard library and such to the emulator ahead of time. This step
2304 /// represents this and is a dependency of all test suites.
2306 /// Most of the time this is a no-op. For some steps such as shipping data to
2307 /// QEMU we have to build our own tools so we've got conditional dependencies
2308 /// on those programs as well. Note that the remote test client is built for
2309 /// the build target (us) and the server is built for the target.
2310 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2311 pub struct RemoteCopyLibs {
2313 target: TargetSelection,
2316 impl Step for RemoteCopyLibs {
2319 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2323 fn run(self, builder: &Builder<'_>) {
2324 let compiler = self.compiler;
2325 let target = self.target;
2326 if !builder.remote_tested(target) {
2330 builder.ensure(compile::Std::new(compiler, target));
2332 builder.info(&format!("REMOTE copy libs to emulator ({})", target));
2334 let server = builder.ensure(tool::RemoteTestServer { compiler, target });
2336 // Spawn the emulator and wait for it to come online
2337 let tool = builder.tool_exe(Tool::RemoteTestClient);
2338 let mut cmd = Command::new(&tool);
2339 cmd.arg("spawn-emulator").arg(target.triple).arg(&server).arg(builder.tempdir());
2340 if let Some(rootfs) = builder.qemu_rootfs(target) {
2343 builder.run(&mut cmd);
2345 // Push all our dylibs to the emulator
2346 for f in t!(builder.sysroot_libdir(compiler, target).read_dir()) {
2348 let name = f.file_name().into_string().unwrap();
2349 if util::is_dylib(&name) {
2350 builder.run(Command::new(&tool).arg("push").arg(f.path()));
2356 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2357 pub struct Distcheck;
2359 impl Step for Distcheck {
2362 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2363 run.alias("distcheck")
2366 fn make_run(run: RunConfig<'_>) {
2367 run.builder.ensure(Distcheck);
2370 /// Runs "distcheck", a 'make check' from a tarball
2371 fn run(self, builder: &Builder<'_>) {
2372 builder.info("Distcheck");
2373 let dir = builder.tempdir().join("distcheck");
2374 let _ = fs::remove_dir_all(&dir);
2375 t!(fs::create_dir_all(&dir));
2377 // Guarantee that these are built before we begin running.
2378 builder.ensure(dist::PlainSourceTarball);
2379 builder.ensure(dist::Src);
2381 let mut cmd = Command::new("tar");
2383 .arg(builder.ensure(dist::PlainSourceTarball).tarball())
2384 .arg("--strip-components=1")
2386 builder.run(&mut cmd);
2388 Command::new("./configure")
2389 .args(&builder.config.configure_args)
2390 .arg("--enable-vendor")
2394 Command::new(util::make(&builder.config.build.triple)).arg("check").current_dir(&dir),
2397 // Now make sure that rust-src has all of libstd's dependencies
2398 builder.info("Distcheck rust-src");
2399 let dir = builder.tempdir().join("distcheck-src");
2400 let _ = fs::remove_dir_all(&dir);
2401 t!(fs::create_dir_all(&dir));
2403 let mut cmd = Command::new("tar");
2405 .arg(builder.ensure(dist::Src).tarball())
2406 .arg("--strip-components=1")
2408 builder.run(&mut cmd);
2410 let toml = dir.join("rust-src/lib/rustlib/src/rust/library/std/Cargo.toml");
2412 Command::new(&builder.initial_cargo)
2413 .arg("generate-lockfile")
2414 .arg("--manifest-path")
2421 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2422 pub struct Bootstrap;
2424 impl Step for Bootstrap {
2426 const DEFAULT: bool = true;
2427 const ONLY_HOSTS: bool = true;
2429 /// Tests the build system itself.
2430 fn run(self, builder: &Builder<'_>) {
2431 let mut check_bootstrap = Command::new(&builder.python());
2432 check_bootstrap.arg("bootstrap_test.py").current_dir(builder.src.join("src/bootstrap/"));
2433 try_run(builder, &mut check_bootstrap);
2435 let mut cmd = Command::new(&builder.initial_cargo);
2437 .current_dir(builder.src.join("src/bootstrap"))
2438 .env("RUSTFLAGS", "-Cdebuginfo=2")
2439 .env("CARGO_TARGET_DIR", builder.out.join("bootstrap"))
2440 .env("RUSTC_BOOTSTRAP", "1")
2441 .env("RUSTDOC", builder.rustdoc(builder.compiler(0, builder.build.build)))
2442 .env("RUSTC", &builder.initial_rustc);
2443 if let Some(flags) = option_env!("RUSTFLAGS") {
2444 // Use the same rustc flags for testing as for "normal" compilation,
2445 // so that Cargo doesn’t recompile the entire dependency graph every time:
2446 // https://github.com/rust-lang/rust/issues/49215
2447 cmd.env("RUSTFLAGS", flags);
2449 if !builder.fail_fast {
2450 cmd.arg("--no-fail-fast");
2452 match builder.doc_tests {
2457 cmd.args(&["--lib", "--bins", "--examples", "--tests", "--benches"]);
2462 cmd.arg("--").args(&builder.config.cmd.test_args());
2463 // rustbuild tests are racy on directory creation so just run them one at a time.
2464 // Since there's not many this shouldn't be a problem.
2465 cmd.arg("--test-threads=1");
2466 try_run(builder, &mut cmd);
2469 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2470 run.path("src/bootstrap")
2473 fn make_run(run: RunConfig<'_>) {
2474 run.builder.ensure(Bootstrap);
2478 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2479 pub struct TierCheck {
2480 pub compiler: Compiler,
2483 impl Step for TierCheck {
2485 const DEFAULT: bool = true;
2486 const ONLY_HOSTS: bool = true;
2488 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2489 run.path("src/tools/tier-check")
2492 fn make_run(run: RunConfig<'_>) {
2494 run.builder.compiler_for(run.builder.top_stage, run.builder.build.build, run.target);
2495 run.builder.ensure(TierCheck { compiler });
2498 /// Tests the Platform Support page in the rustc book.
2499 fn run(self, builder: &Builder<'_>) {
2500 builder.ensure(compile::Std::new(self.compiler, self.compiler.host));
2501 let mut cargo = tool::prepare_tool_cargo(
2507 "src/tools/tier-check",
2511 cargo.arg(builder.src.join("src/doc/rustc/src/platform-support.md"));
2512 cargo.arg(&builder.rustc(self.compiler));
2513 if builder.is_verbose() {
2514 cargo.arg("--verbose");
2517 builder.info("platform support check");
2518 try_run(builder, &mut cargo.into());
2522 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2523 pub struct LintDocs {
2524 pub compiler: Compiler,
2525 pub target: TargetSelection,
2528 impl Step for LintDocs {
2530 const DEFAULT: bool = true;
2531 const ONLY_HOSTS: bool = true;
2533 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2534 run.path("src/tools/lint-docs")
2537 fn make_run(run: RunConfig<'_>) {
2538 run.builder.ensure(LintDocs {
2539 compiler: run.builder.compiler(run.builder.top_stage, run.builder.config.build),
2544 /// Tests that the lint examples in the rustc book generate the correct
2545 /// lints and have the expected format.
2546 fn run(self, builder: &Builder<'_>) {
2547 builder.ensure(crate::doc::RustcBook {
2548 compiler: self.compiler,
2549 target: self.target,