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,
464 target: TargetSelection,
469 const ONLY_HOSTS: bool = false;
471 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
472 run.path("src/tools/miri")
475 fn make_run(run: RunConfig<'_>) {
476 run.builder.ensure(Miri {
477 stage: run.builder.top_stage,
478 host: run.build_triple(),
483 /// Runs `cargo test` for miri.
484 fn run(self, builder: &Builder<'_>) {
485 let stage = self.stage;
486 let host = self.host;
487 let target = self.target;
488 let compiler = builder.compiler(stage, host);
489 // We need the stdlib for the *next* stage, as it was built with this compiler that also built Miri.
490 // Except if we are at stage 2, the bootstrap loop is complete and we can stick with our current stage.
491 let compiler_std = builder.compiler(if stage < 2 { stage + 1 } else { stage }, host);
494 .ensure(tool::Miri { compiler, target: self.host, extra_features: Vec::new() })
495 .expect("in-tree tool");
496 let _cargo_miri = builder
497 .ensure(tool::CargoMiri { compiler, target: self.host, extra_features: Vec::new() })
498 .expect("in-tree tool");
499 // The stdlib we need might be at a different stage. And just asking for the
500 // sysroot does not seem to populate it, so we do that first.
501 builder.ensure(compile::Std::new(compiler_std, host));
502 let sysroot = builder.sysroot(compiler_std);
504 // # Run `cargo miri setup` for the given target.
505 let mut cargo = tool::prepare_tool_cargo(
511 "src/tools/miri/cargo-miri",
515 cargo.add_rustc_lib_path(builder, compiler);
516 cargo.arg("--").arg("miri").arg("setup");
517 cargo.arg("--target").arg(target.rustc_target_arg());
519 // Tell `cargo miri setup` where to find the sources.
520 cargo.env("MIRI_LIB_SRC", builder.src.join("library"));
521 // Tell it where to find Miri.
522 cargo.env("MIRI", &miri);
524 cargo.env("RUST_BACKTRACE", "1");
526 let mut cargo = Command::from(cargo);
527 builder.run(&mut cargo);
529 // # Determine where Miri put its sysroot.
530 // To this end, we run `cargo miri setup --print-sysroot` and capture the output.
531 // (We do this separately from the above so that when the setup actually
532 // happens we get some output.)
533 // We re-use the `cargo` from above.
534 cargo.arg("--print-sysroot");
536 // FIXME: Is there a way in which we can re-use the usual `run` helpers?
537 let miri_sysroot = if builder.config.dry_run {
540 builder.verbose(&format!("running: {:?}", cargo));
542 cargo.output().expect("We already ran `cargo miri setup` before and that worked");
543 assert!(out.status.success(), "`cargo miri setup` returned with non-0 exit code");
544 // Output is "<sysroot>\n".
545 let stdout = String::from_utf8(out.stdout)
546 .expect("`cargo miri setup` stdout is not valid UTF-8");
547 let sysroot = stdout.trim_end();
548 builder.verbose(&format!("`cargo miri setup --print-sysroot` said: {:?}", sysroot));
552 // # Run `cargo test`.
553 let mut cargo = tool::prepare_tool_cargo(
563 cargo.add_rustc_lib_path(builder, compiler);
565 // miri tests need to know about the stage sysroot
566 cargo.env("MIRI_SYSROOT", &miri_sysroot);
567 cargo.env("MIRI_HOST_SYSROOT", sysroot);
568 cargo.env("RUSTC_LIB_PATH", builder.rustc_libdir(compiler));
569 cargo.env("MIRI", &miri);
571 if builder.config.cmd.bless() {
572 cargo.env("MIRI_BLESS", "Gesundheit");
576 cargo.env("MIRI_TEST_TARGET", target.rustc_target_arg());
577 // Forward test filters.
578 cargo.arg("--").args(builder.config.cmd.test_args());
580 let mut cargo = Command::from(cargo);
581 builder.run(&mut cargo);
583 // # Run `cargo miri test`.
584 // This is just a smoke test (Miri's own CI invokes this in a bunch of different ways and ensures
585 // that we get the desired output), but that is sufficient to make sure that the libtest harness
586 // itself executes properly under Miri.
587 let mut cargo = tool::prepare_tool_cargo(
593 "src/tools/miri/cargo-miri",
594 SourceType::Submodule,
597 cargo.add_rustc_lib_path(builder, compiler);
598 cargo.arg("--").arg("miri").arg("test");
600 .arg("--manifest-path")
601 .arg(builder.src.join("src/tools/miri/test-cargo-miri/Cargo.toml"));
602 cargo.arg("--target").arg(target.rustc_target_arg());
603 cargo.arg("--tests"); // don't run doctests, they are too confused by the staging
604 cargo.arg("--").args(builder.config.cmd.test_args());
606 // Tell `cargo miri` where to find things.
607 cargo.env("MIRI_SYSROOT", &miri_sysroot);
608 cargo.env("MIRI_HOST_SYSROOT", sysroot);
609 cargo.env("RUSTC_LIB_PATH", builder.rustc_libdir(compiler));
610 cargo.env("MIRI", &miri);
612 cargo.env("RUST_BACKTRACE", "1");
614 let mut cargo = Command::from(cargo);
615 builder.run(&mut cargo);
619 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
620 pub struct CompiletestTest {
621 host: TargetSelection,
624 impl Step for CompiletestTest {
627 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
628 run.path("src/tools/compiletest")
631 fn make_run(run: RunConfig<'_>) {
632 run.builder.ensure(CompiletestTest { host: run.target });
635 /// Runs `cargo test` for compiletest.
636 fn run(self, builder: &Builder<'_>) {
637 let host = self.host;
638 let compiler = builder.compiler(0, host);
640 // We need `ToolStd` for the locally-built sysroot because
641 // compiletest uses unstable features of the `test` crate.
642 builder.ensure(compile::Std::new(compiler, host));
643 let cargo = tool::prepare_tool_cargo(
649 "src/tools/compiletest",
654 try_run(builder, &mut cargo.into());
658 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
661 host: TargetSelection,
664 impl Step for Clippy {
666 const ONLY_HOSTS: bool = true;
667 const DEFAULT: bool = false;
669 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
670 run.path("src/tools/clippy")
673 fn make_run(run: RunConfig<'_>) {
674 run.builder.ensure(Clippy { stage: run.builder.top_stage, host: run.target });
677 /// Runs `cargo test` for clippy.
678 fn run(self, builder: &Builder<'_>) {
679 let stage = self.stage;
680 let host = self.host;
681 let compiler = builder.compiler(stage, host);
684 .ensure(tool::Clippy { compiler, target: self.host, extra_features: Vec::new() })
685 .expect("in-tree tool");
686 let mut cargo = tool::prepare_tool_cargo(
697 cargo.env("RUSTC_TEST_SUITE", builder.rustc(compiler));
698 cargo.env("RUSTC_LIB_PATH", builder.rustc_libdir(compiler));
699 let host_libs = builder.stage_out(compiler, Mode::ToolRustc).join(builder.cargo_dir());
700 cargo.env("HOST_LIBS", host_libs);
702 cargo.arg("--").args(builder.config.cmd.test_args());
704 cargo.add_rustc_lib_path(builder, compiler);
706 if builder.try_run(&mut cargo.into()) {
707 // The tests succeeded; nothing to do.
711 if !builder.config.cmd.bless() {
712 crate::detail_exit(1);
715 let mut cargo = builder.cargo(compiler, Mode::ToolRustc, SourceType::InTree, host, "run");
716 cargo.arg("-p").arg("clippy_dev");
717 // clippy_dev gets confused if it can't find `clippy/Cargo.toml`
718 cargo.current_dir(&builder.src.join("src").join("tools").join("clippy"));
719 if builder.config.rust_optimize {
720 cargo.env("PROFILE", "release");
722 cargo.env("PROFILE", "debug");
726 builder.run(&mut cargo.into());
730 fn path_for_cargo(builder: &Builder<'_>, compiler: Compiler) -> OsString {
731 // Configure PATH to find the right rustc. NB. we have to use PATH
732 // and not RUSTC because the Cargo test suite has tests that will
733 // fail if rustc is not spelled `rustc`.
734 let path = builder.sysroot(compiler).join("bin");
735 let old_path = env::var_os("PATH").unwrap_or_default();
736 env::join_paths(iter::once(path).chain(env::split_paths(&old_path))).expect("")
739 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
740 pub struct RustdocTheme {
741 pub compiler: Compiler,
744 impl Step for RustdocTheme {
746 const DEFAULT: bool = true;
747 const ONLY_HOSTS: bool = true;
749 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
750 run.path("src/tools/rustdoc-themes")
753 fn make_run(run: RunConfig<'_>) {
754 let compiler = run.builder.compiler(run.builder.top_stage, run.target);
756 run.builder.ensure(RustdocTheme { compiler });
759 fn run(self, builder: &Builder<'_>) {
760 let rustdoc = builder.bootstrap_out.join("rustdoc");
761 let mut cmd = builder.tool_cmd(Tool::RustdocTheme);
762 cmd.arg(rustdoc.to_str().unwrap())
763 .arg(builder.src.join("src/librustdoc/html/static/css/themes").to_str().unwrap())
764 .env("RUSTC_STAGE", self.compiler.stage.to_string())
765 .env("RUSTC_SYSROOT", builder.sysroot(self.compiler))
766 .env("RUSTDOC_LIBDIR", builder.sysroot_libdir(self.compiler, self.compiler.host))
767 .env("CFG_RELEASE_CHANNEL", &builder.config.channel)
768 .env("RUSTDOC_REAL", builder.rustdoc(self.compiler))
769 .env("RUSTC_BOOTSTRAP", "1");
770 if let Some(linker) = builder.linker(self.compiler.host) {
771 cmd.env("RUSTDOC_LINKER", linker);
773 if builder.is_fuse_ld_lld(self.compiler.host) {
775 "RUSTDOC_LLD_NO_THREADS",
776 util::lld_flag_no_threads(self.compiler.host.contains("windows")),
779 try_run(builder, &mut cmd);
783 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
784 pub struct RustdocJSStd {
785 pub target: TargetSelection,
788 impl Step for RustdocJSStd {
790 const DEFAULT: bool = true;
791 const ONLY_HOSTS: bool = true;
793 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
794 run.suite_path("src/test/rustdoc-js-std")
797 fn make_run(run: RunConfig<'_>) {
798 run.builder.ensure(RustdocJSStd { target: run.target });
801 fn run(self, builder: &Builder<'_>) {
802 if let Some(ref nodejs) = builder.config.nodejs {
803 let mut command = Command::new(nodejs);
805 .arg(builder.src.join("src/tools/rustdoc-js/tester.js"))
808 .arg("--resource-suffix")
809 .arg(&builder.version)
811 .arg(builder.doc_out(self.target))
812 .arg("--test-folder")
813 .arg(builder.src.join("src/test/rustdoc-js-std"));
814 for path in &builder.paths {
816 util::is_valid_test_suite_arg(path, "src/test/rustdoc-js-std", builder)
818 if !p.ends_with(".js") {
819 eprintln!("A non-js file was given: `{}`", path.display());
820 panic!("Cannot run rustdoc-js-std tests");
822 command.arg("--test-file").arg(path);
825 builder.ensure(crate::doc::Std { target: self.target, stage: builder.top_stage });
826 builder.run(&mut command);
828 builder.info("No nodejs found, skipping \"src/test/rustdoc-js-std\" tests");
833 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
834 pub struct RustdocJSNotStd {
835 pub target: TargetSelection,
836 pub compiler: Compiler,
839 impl Step for RustdocJSNotStd {
841 const DEFAULT: bool = true;
842 const ONLY_HOSTS: bool = true;
844 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
845 run.suite_path("src/test/rustdoc-js")
848 fn make_run(run: RunConfig<'_>) {
849 let compiler = run.builder.compiler(run.builder.top_stage, run.build_triple());
850 run.builder.ensure(RustdocJSNotStd { target: run.target, compiler });
853 fn run(self, builder: &Builder<'_>) {
854 if builder.config.nodejs.is_some() {
855 builder.ensure(Compiletest {
856 compiler: self.compiler,
860 path: "src/test/rustdoc-js",
864 builder.info("No nodejs found, skipping \"src/test/rustdoc-js\" tests");
869 fn get_browser_ui_test_version_inner(npm: &Path, global: bool) -> Option<String> {
870 let mut command = Command::new(&npm);
871 command.arg("list").arg("--parseable").arg("--long").arg("--depth=0");
873 command.arg("--global");
877 .map(|output| String::from_utf8_lossy(&output.stdout).into_owned())
878 .unwrap_or(String::new());
881 .find_map(|l| l.split(':').nth(1)?.strip_prefix("browser-ui-test@"))
882 .map(|v| v.to_owned())
885 fn get_browser_ui_test_version(npm: &Path) -> Option<String> {
886 get_browser_ui_test_version_inner(npm, false)
887 .or_else(|| get_browser_ui_test_version_inner(npm, true))
890 fn compare_browser_ui_test_version(installed_version: &str, src: &Path) {
891 match fs::read_to_string(
892 src.join("src/ci/docker/host-x86_64/x86_64-gnu-tools/browser-ui-test.version"),
895 if v.trim() != installed_version {
897 "⚠️ Installed version of browser-ui-test (`{}`) is different than the \
898 one used in the CI (`{}`)",
902 "You can install this version using `npm update browser-ui-test` or by using \
903 `npm install browser-ui-test@{}`",
908 Err(e) => eprintln!("Couldn't find the CI browser-ui-test version: {:?}", e),
912 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
913 pub struct RustdocGUI {
914 pub target: TargetSelection,
915 pub compiler: Compiler,
918 impl Step for RustdocGUI {
920 const DEFAULT: bool = true;
921 const ONLY_HOSTS: bool = true;
923 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
924 let builder = run.builder;
925 let run = run.suite_path("src/test/rustdoc-gui");
926 run.lazy_default_condition(Box::new(move || {
927 builder.config.nodejs.is_some()
932 .map(|p| get_browser_ui_test_version(p).is_some())
937 fn make_run(run: RunConfig<'_>) {
938 let compiler = run.builder.compiler(run.builder.top_stage, run.build_triple());
939 run.builder.ensure(RustdocGUI { target: run.target, compiler });
942 fn run(self, builder: &Builder<'_>) {
943 let nodejs = builder.config.nodejs.as_ref().expect("nodejs isn't available");
944 let npm = builder.config.npm.as_ref().expect("npm isn't available");
946 builder.ensure(compile::Std::new(self.compiler, self.target));
948 // The goal here is to check if the necessary packages are installed, and if not, we
950 match get_browser_ui_test_version(&npm) {
952 // We also check the version currently used in CI and emit a warning if it's not the
954 compare_browser_ui_test_version(&version, &builder.build.src);
958 "error: rustdoc-gui test suite cannot be run because npm `browser-ui-test` \
959 dependency is missing",
962 "If you want to install the `{0}` dependency, run `npm install {0}`",
965 panic!("Cannot run rustdoc-gui tests");
969 let out_dir = builder.test_out(self.target).join("rustdoc-gui");
971 // We remove existing folder to be sure there won't be artifacts remaining.
972 builder.clear_if_dirty(&out_dir, &builder.rustdoc(self.compiler));
974 let src_path = builder.build.src.join("src/test/rustdoc-gui/src");
975 // We generate docs for the libraries present in the rustdoc-gui's src folder.
976 for entry in src_path.read_dir().expect("read_dir call failed") {
977 if let Ok(entry) = entry {
978 let path = entry.path();
984 let mut cargo = Command::new(&builder.initial_cargo);
989 .env("RUSTC_BOOTSTRAP", "1")
990 .env("RUSTDOC", builder.rustdoc(self.compiler))
991 .env("RUSTC", builder.rustc(self.compiler))
993 // FIXME: implement a `// compile-flags` command or similar
994 // instead of hard-coding this test
995 if entry.file_name() == "link_to_definition" {
996 cargo.env("RUSTDOCFLAGS", "-Zunstable-options --generate-link-to-definition");
998 builder.run(&mut cargo);
1002 // We now run GUI tests.
1003 let mut command = Command::new(&nodejs);
1005 .arg(builder.build.src.join("src/tools/rustdoc-gui/tester.js"))
1007 .arg(&builder.jobs().to_string())
1008 .arg("--doc-folder")
1009 .arg(out_dir.join("doc"))
1010 .arg("--tests-folder")
1011 .arg(builder.build.src.join("src/test/rustdoc-gui"));
1012 for path in &builder.paths {
1013 if let Some(p) = util::is_valid_test_suite_arg(path, "src/test/rustdoc-gui", builder) {
1014 if !p.ends_with(".goml") {
1015 eprintln!("A non-goml file was given: `{}`", path.display());
1016 panic!("Cannot run rustdoc-gui tests");
1018 if let Some(name) = path.file_name().and_then(|f| f.to_str()) {
1019 command.arg("--file").arg(name);
1023 for test_arg in builder.config.cmd.test_args() {
1024 command.arg(test_arg);
1026 builder.run(&mut command);
1030 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1033 impl Step for Tidy {
1035 const DEFAULT: bool = true;
1036 const ONLY_HOSTS: bool = true;
1038 /// Runs the `tidy` tool.
1040 /// This tool in `src/tools` checks up on various bits and pieces of style and
1041 /// otherwise just implements a few lint-like checks that are specific to the
1042 /// compiler itself.
1044 /// Once tidy passes, this step also runs `fmt --check` if tests are being run
1045 /// for the `dev` or `nightly` channels.
1046 fn run(self, builder: &Builder<'_>) {
1047 let mut cmd = builder.tool_cmd(Tool::Tidy);
1048 cmd.arg(&builder.src);
1049 cmd.arg(&builder.initial_cargo);
1050 cmd.arg(&builder.out);
1051 cmd.arg(builder.jobs().to_string());
1052 if builder.is_verbose() {
1053 cmd.arg("--verbose");
1055 if builder.config.cmd.bless() {
1059 builder.info("tidy check");
1060 try_run(builder, &mut cmd);
1062 if builder.config.channel == "dev" || builder.config.channel == "nightly" {
1063 builder.info("fmt check");
1064 if builder.initial_rustfmt().is_none() {
1065 let inferred_rustfmt_dir = builder.config.initial_rustc.parent().unwrap();
1068 error: no `rustfmt` binary found in {PATH}
1069 info: `rust.channel` is currently set to \"{CHAN}\"
1070 help: if you are testing a beta branch, set `rust.channel` to \"beta\" in the `config.toml` file
1071 help: to skip test's attempt to check tidiness, pass `--exclude src/tools/tidy` to `x.py test`",
1072 PATH = inferred_rustfmt_dir.display(),
1073 CHAN = builder.config.channel,
1075 crate::detail_exit(1);
1077 crate::format::format(&builder, !builder.config.cmd.bless(), &[]);
1081 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1082 run.path("src/tools/tidy")
1085 fn make_run(run: RunConfig<'_>) {
1086 run.builder.ensure(Tidy);
1090 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1091 pub struct ExpandYamlAnchors;
1093 impl Step for ExpandYamlAnchors {
1095 const ONLY_HOSTS: bool = true;
1097 /// Ensure the `generate-ci-config` tool was run locally.
1099 /// The tool in `src/tools` reads the CI definition in `src/ci/builders.yml` and generates the
1100 /// appropriate configuration for all our CI providers. This step ensures the tool was called
1101 /// by the user before committing CI changes.
1102 fn run(self, builder: &Builder<'_>) {
1103 builder.info("Ensuring the YAML anchors in the GitHub Actions config were expanded");
1106 &mut builder.tool_cmd(Tool::ExpandYamlAnchors).arg("check").arg(&builder.src),
1110 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1111 run.path("src/tools/expand-yaml-anchors")
1114 fn make_run(run: RunConfig<'_>) {
1115 run.builder.ensure(ExpandYamlAnchors);
1119 fn testdir(builder: &Builder<'_>, host: TargetSelection) -> PathBuf {
1120 builder.out.join(host.triple).join("test")
1123 macro_rules! default_test {
1124 ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr }) => {
1125 test!($name { path: $path, mode: $mode, suite: $suite, default: true, host: false });
1129 macro_rules! default_test_with_compare_mode {
1130 ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr,
1131 compare_mode: $compare_mode:expr }) => {
1132 test_with_compare_mode!($name {
1138 compare_mode: $compare_mode
1143 macro_rules! host_test {
1144 ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr }) => {
1145 test!($name { path: $path, mode: $mode, suite: $suite, default: true, host: true });
1150 ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr, default: $default:expr,
1151 host: $host:expr }) => {
1152 test_definitions!($name {
1163 macro_rules! test_with_compare_mode {
1164 ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr, default: $default:expr,
1165 host: $host:expr, compare_mode: $compare_mode:expr }) => {
1166 test_definitions!($name {
1172 compare_mode: Some($compare_mode)
1177 macro_rules! test_definitions {
1182 default: $default:expr,
1184 compare_mode: $compare_mode:expr
1186 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1188 pub compiler: Compiler,
1189 pub target: TargetSelection,
1192 impl Step for $name {
1194 const DEFAULT: bool = $default;
1195 const ONLY_HOSTS: bool = $host;
1197 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1198 run.suite_path($path)
1201 fn make_run(run: RunConfig<'_>) {
1202 let compiler = run.builder.compiler(run.builder.top_stage, run.build_triple());
1204 run.builder.ensure($name { compiler, target: run.target });
1207 fn run(self, builder: &Builder<'_>) {
1208 builder.ensure(Compiletest {
1209 compiler: self.compiler,
1210 target: self.target,
1214 compare_mode: $compare_mode,
1221 default_test!(Ui { path: "src/test/ui", mode: "ui", suite: "ui" });
1223 default_test!(RunPassValgrind {
1224 path: "src/test/run-pass-valgrind",
1225 mode: "run-pass-valgrind",
1226 suite: "run-pass-valgrind"
1229 default_test!(MirOpt { path: "src/test/mir-opt", mode: "mir-opt", suite: "mir-opt" });
1231 default_test!(Codegen { path: "src/test/codegen", mode: "codegen", suite: "codegen" });
1233 default_test!(CodegenUnits {
1234 path: "src/test/codegen-units",
1235 mode: "codegen-units",
1236 suite: "codegen-units"
1239 default_test!(Incremental {
1240 path: "src/test/incremental",
1241 mode: "incremental",
1242 suite: "incremental"
1245 default_test_with_compare_mode!(Debuginfo {
1246 path: "src/test/debuginfo",
1249 compare_mode: "split-dwarf"
1252 host_test!(UiFullDeps { path: "src/test/ui-fulldeps", mode: "ui", suite: "ui-fulldeps" });
1254 host_test!(Rustdoc { path: "src/test/rustdoc", mode: "rustdoc", suite: "rustdoc" });
1255 host_test!(RustdocUi { path: "src/test/rustdoc-ui", mode: "ui", suite: "rustdoc-ui" });
1257 host_test!(RustdocJson {
1258 path: "src/test/rustdoc-json",
1259 mode: "rustdoc-json",
1260 suite: "rustdoc-json"
1263 host_test!(Pretty { path: "src/test/pretty", mode: "pretty", suite: "pretty" });
1265 default_test!(RunMake { path: "src/test/run-make", mode: "run-make", suite: "run-make" });
1267 host_test!(RunMakeFullDeps {
1268 path: "src/test/run-make-fulldeps",
1270 suite: "run-make-fulldeps"
1273 default_test!(Assembly { path: "src/test/assembly", mode: "assembly", suite: "assembly" });
1275 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1276 struct Compiletest {
1278 target: TargetSelection,
1280 suite: &'static str,
1282 compare_mode: Option<&'static str>,
1285 impl Step for Compiletest {
1288 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1292 /// Executes the `compiletest` tool to run a suite of tests.
1294 /// Compiles all tests with `compiler` for `target` with the specified
1295 /// compiletest `mode` and `suite` arguments. For example `mode` can be
1296 /// "run-pass" or `suite` can be something like `debuginfo`.
1297 fn run(self, builder: &Builder<'_>) {
1298 if builder.top_stage == 0 && env::var("COMPILETEST_FORCE_STAGE0").is_err() {
1300 error: `--stage 0` runs compiletest on the beta compiler, not your local changes, and will almost always cause tests to fail
1301 help: to test the compiler, use `--stage 1` instead
1302 help: to test the standard library, use `--stage 0 library/std` instead
1303 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`."
1305 crate::detail_exit(1);
1308 let compiler = self.compiler;
1309 let target = self.target;
1310 let mode = self.mode;
1311 let suite = self.suite;
1313 // Path for test suite
1314 let suite_path = self.path;
1316 // Skip codegen tests if they aren't enabled in configuration.
1317 if !builder.config.codegen_tests && suite == "codegen" {
1321 if suite == "debuginfo" {
1323 .ensure(dist::DebuggerScripts { sysroot: builder.sysroot(compiler), host: target });
1326 if suite.ends_with("fulldeps") {
1327 builder.ensure(compile::Rustc::new(compiler, target));
1330 builder.ensure(compile::Std::new(compiler, target));
1331 // ensure that `libproc_macro` is available on the host.
1332 builder.ensure(compile::Std::new(compiler, compiler.host));
1334 // Also provide `rust_test_helpers` for the host.
1335 builder.ensure(native::TestHelpers { target: compiler.host });
1337 // As well as the target, except for plain wasm32, which can't build it
1338 if !target.contains("wasm") || target.contains("emscripten") {
1339 builder.ensure(native::TestHelpers { target });
1342 builder.ensure(RemoteCopyLibs { compiler, target });
1344 let mut cmd = builder.tool_cmd(Tool::Compiletest);
1346 // compiletest currently has... a lot of arguments, so let's just pass all
1349 cmd.arg("--compile-lib-path").arg(builder.rustc_libdir(compiler));
1350 cmd.arg("--run-lib-path").arg(builder.sysroot_libdir(compiler, target));
1351 cmd.arg("--rustc-path").arg(builder.rustc(compiler));
1353 let is_rustdoc = suite.ends_with("rustdoc-ui") || suite.ends_with("rustdoc-js");
1355 // Avoid depending on rustdoc when we don't need it.
1356 if mode == "rustdoc"
1357 || mode == "run-make"
1358 || (mode == "ui" && is_rustdoc)
1359 || mode == "js-doc-test"
1360 || mode == "rustdoc-json"
1362 cmd.arg("--rustdoc-path").arg(builder.rustdoc(compiler));
1365 if mode == "rustdoc-json" {
1366 // Use the beta compiler for jsondocck
1367 let json_compiler = compiler.with_stage(0);
1368 cmd.arg("--jsondocck-path")
1369 .arg(builder.ensure(tool::JsonDocCk { compiler: json_compiler, target }));
1370 cmd.arg("--jsondoclint-path")
1371 .arg(builder.ensure(tool::JsonDocLint { compiler: json_compiler, target }));
1374 if mode == "run-make" {
1375 let rust_demangler = builder
1376 .ensure(tool::RustDemangler {
1378 target: compiler.host,
1379 extra_features: Vec::new(),
1381 .expect("in-tree tool");
1382 cmd.arg("--rust-demangler-path").arg(rust_demangler);
1385 cmd.arg("--src-base").arg(builder.src.join("src/test").join(suite));
1386 cmd.arg("--build-base").arg(testdir(builder, compiler.host).join(suite));
1387 cmd.arg("--stage-id").arg(format!("stage{}-{}", compiler.stage, target));
1388 cmd.arg("--suite").arg(suite);
1389 cmd.arg("--mode").arg(mode);
1390 cmd.arg("--target").arg(target.rustc_target_arg());
1391 cmd.arg("--host").arg(&*compiler.host.triple);
1392 cmd.arg("--llvm-filecheck").arg(builder.llvm_filecheck(builder.config.build));
1394 if builder.config.cmd.bless() {
1398 if builder.config.cmd.force_rerun() {
1399 cmd.arg("--force-rerun");
1403 builder.config.cmd.compare_mode().or_else(|| {
1404 if builder.config.test_compare_mode { self.compare_mode } else { None }
1407 if let Some(ref pass) = builder.config.cmd.pass() {
1412 if let Some(ref run) = builder.config.cmd.run() {
1417 if let Some(ref nodejs) = builder.config.nodejs {
1418 cmd.arg("--nodejs").arg(nodejs);
1420 if let Some(ref npm) = builder.config.npm {
1421 cmd.arg("--npm").arg(npm);
1423 if builder.config.rust_optimize_tests {
1424 cmd.arg("--optimize-tests");
1426 let mut flags = if is_rustdoc { Vec::new() } else { vec!["-Crpath".to_string()] };
1427 flags.push(format!("-Cdebuginfo={}", builder.config.rust_debuginfo_level_tests));
1428 flags.extend(builder.config.cmd.rustc_args().iter().map(|s| s.to_string()));
1430 if let Some(linker) = builder.linker(target) {
1431 cmd.arg("--linker").arg(linker);
1434 let mut hostflags = flags.clone();
1435 hostflags.push(format!("-Lnative={}", builder.test_helpers_out(compiler.host).display()));
1436 hostflags.extend(builder.lld_flags(compiler.host));
1437 for flag in hostflags {
1438 cmd.arg("--host-rustcflags").arg(flag);
1441 let mut targetflags = flags;
1442 targetflags.push(format!("-Lnative={}", builder.test_helpers_out(target).display()));
1443 targetflags.extend(builder.lld_flags(target));
1444 for flag in targetflags {
1445 cmd.arg("--target-rustcflags").arg(flag);
1448 cmd.arg("--python").arg(builder.python());
1450 if let Some(ref gdb) = builder.config.gdb {
1451 cmd.arg("--gdb").arg(gdb);
1454 let run = |cmd: &mut Command| {
1455 cmd.output().map(|output| {
1456 String::from_utf8_lossy(&output.stdout)
1459 .unwrap_or_else(|| panic!("{:?} failed {:?}", cmd, output))
1463 let lldb_exe = "lldb";
1464 let lldb_version = Command::new(lldb_exe)
1467 .map(|output| String::from_utf8_lossy(&output.stdout).to_string())
1469 if let Some(ref vers) = lldb_version {
1470 cmd.arg("--lldb-version").arg(vers);
1471 let lldb_python_dir = run(Command::new(lldb_exe).arg("-P")).ok();
1472 if let Some(ref dir) = lldb_python_dir {
1473 cmd.arg("--lldb-python-dir").arg(dir);
1477 if util::forcing_clang_based_tests() {
1478 let clang_exe = builder.llvm_out(target).join("bin").join("clang");
1479 cmd.arg("--run-clang-based-tests-with").arg(clang_exe);
1482 for exclude in &builder.config.exclude {
1484 cmd.arg(&exclude.path);
1487 // Get paths from cmd args
1488 let paths = match &builder.config.cmd {
1489 Subcommand::Test { ref paths, .. } => &paths[..],
1493 // Get test-args by striping suite path
1494 let mut test_args: Vec<&str> = paths
1496 .filter_map(|p| util::is_valid_test_suite_arg(p, suite_path, builder))
1499 test_args.append(&mut builder.config.cmd.test_args());
1501 // On Windows, replace forward slashes in test-args by backslashes
1502 // so the correct filters are passed to libtest
1504 let test_args_win: Vec<String> =
1505 test_args.iter().map(|s| s.replace("/", "\\")).collect();
1506 cmd.args(&test_args_win);
1508 cmd.args(&test_args);
1511 if builder.is_verbose() {
1512 cmd.arg("--verbose");
1515 if !builder.config.verbose_tests {
1519 let mut llvm_components_passed = false;
1520 let mut copts_passed = false;
1521 if builder.config.llvm_enabled() {
1522 let llvm_config = builder.ensure(native::Llvm { target: builder.config.build });
1523 if !builder.config.dry_run {
1524 let llvm_version = output(Command::new(&llvm_config).arg("--version"));
1525 let llvm_components = output(Command::new(&llvm_config).arg("--components"));
1526 // Remove trailing newline from llvm-config output.
1527 cmd.arg("--llvm-version")
1528 .arg(llvm_version.trim())
1529 .arg("--llvm-components")
1530 .arg(llvm_components.trim());
1531 llvm_components_passed = true;
1533 if !builder.is_rust_llvm(target) {
1534 cmd.arg("--system-llvm");
1537 // Tests that use compiler libraries may inherit the `-lLLVM` link
1538 // requirement, but the `-L` library path is not propagated across
1539 // separate compilations. We can add LLVM's library path to the
1540 // platform-specific environment variable as a workaround.
1541 if !builder.config.dry_run && suite.ends_with("fulldeps") {
1542 let llvm_libdir = output(Command::new(&llvm_config).arg("--libdir"));
1543 add_link_lib_path(vec![llvm_libdir.trim().into()], &mut cmd);
1546 // Only pass correct values for these flags for the `run-make` suite as it
1547 // requires that a C++ compiler was configured which isn't always the case.
1548 if !builder.config.dry_run && matches!(suite, "run-make" | "run-make-fulldeps") {
1549 // The llvm/bin directory contains many useful cross-platform
1550 // tools. Pass the path to run-make tests so they can use them.
1551 let llvm_bin_path = llvm_config
1553 .expect("Expected llvm-config to be contained in directory");
1554 assert!(llvm_bin_path.is_dir());
1555 cmd.arg("--llvm-bin-dir").arg(llvm_bin_path);
1557 // If LLD is available, add it to the PATH
1558 if builder.config.lld_enabled {
1559 let lld_install_root =
1560 builder.ensure(native::Lld { target: builder.config.build });
1562 let lld_bin_path = lld_install_root.join("bin");
1564 let old_path = env::var_os("PATH").unwrap_or_default();
1565 let new_path = env::join_paths(
1566 std::iter::once(lld_bin_path).chain(env::split_paths(&old_path)),
1568 .expect("Could not add LLD bin path to PATH");
1569 cmd.env("PATH", new_path);
1574 // Only pass correct values for these flags for the `run-make` suite as it
1575 // requires that a C++ compiler was configured which isn't always the case.
1576 if !builder.config.dry_run && matches!(suite, "run-make" | "run-make-fulldeps") {
1578 .arg(builder.cc(target))
1580 .arg(builder.cxx(target).unwrap())
1582 .arg(builder.cflags(target, GitRepo::Rustc, CLang::C).join(" "))
1584 .arg(builder.cflags(target, GitRepo::Rustc, CLang::Cxx).join(" "));
1585 copts_passed = true;
1586 if let Some(ar) = builder.ar(target) {
1587 cmd.arg("--ar").arg(ar);
1591 if !llvm_components_passed {
1592 cmd.arg("--llvm-components").arg("");
1605 if builder.remote_tested(target) {
1606 cmd.arg("--remote-test-client").arg(builder.tool_exe(Tool::RemoteTestClient));
1609 // Running a C compiler on MSVC requires a few env vars to be set, to be
1610 // sure to set them here.
1612 // Note that if we encounter `PATH` we make sure to append to our own `PATH`
1613 // rather than stomp over it.
1614 if target.contains("msvc") {
1615 for &(ref k, ref v) in builder.cc[&target].env() {
1621 cmd.env("RUSTC_BOOTSTRAP", "1");
1622 // Override the rustc version used in symbol hashes to reduce the amount of normalization
1623 // needed when diffing test output.
1624 cmd.env("RUSTC_FORCE_RUSTC_VERSION", "compiletest");
1625 cmd.env("DOC_RUST_LANG_ORG_CHANNEL", builder.doc_rust_lang_org_channel());
1626 builder.add_rust_test_threads(&mut cmd);
1628 if builder.config.sanitizers_enabled(target) {
1629 cmd.env("RUSTC_SANITIZER_SUPPORT", "1");
1632 if builder.config.profiler_enabled(target) {
1633 cmd.env("RUSTC_PROFILER_SUPPORT", "1");
1636 cmd.env("RUST_TEST_TMPDIR", builder.tempdir());
1638 cmd.arg("--adb-path").arg("adb");
1639 cmd.arg("--adb-test-dir").arg(ADB_TEST_DIR);
1640 if target.contains("android") {
1641 // Assume that cc for this target comes from the android sysroot
1642 cmd.arg("--android-cross-path")
1643 .arg(builder.cc(target).parent().unwrap().parent().unwrap());
1645 cmd.arg("--android-cross-path").arg("");
1648 if builder.config.cmd.rustfix_coverage() {
1649 cmd.arg("--rustfix-coverage");
1652 cmd.env("BOOTSTRAP_CARGO", &builder.initial_cargo);
1654 cmd.arg("--channel").arg(&builder.config.channel);
1656 builder.ci_env.force_coloring_in_ci(&mut cmd);
1658 builder.info(&format!(
1659 "Check compiletest suite={} mode={} ({} -> {})",
1660 suite, mode, &compiler.host, target
1662 let _time = util::timeit(&builder);
1663 try_run(builder, &mut cmd);
1665 if let Some(compare_mode) = compare_mode {
1666 cmd.arg("--compare-mode").arg(compare_mode);
1667 builder.info(&format!(
1668 "Check compiletest suite={} mode={} compare_mode={} ({} -> {})",
1669 suite, mode, compare_mode, &compiler.host, target
1671 let _time = util::timeit(&builder);
1672 try_run(builder, &mut cmd);
1677 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
1685 impl Step for BookTest {
1687 const ONLY_HOSTS: bool = true;
1689 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1693 /// Runs the documentation tests for a book in `src/doc`.
1695 /// This uses the `rustdoc` that sits next to `compiler`.
1696 fn run(self, builder: &Builder<'_>) {
1697 // External docs are different from local because:
1698 // - Some books need pre-processing by mdbook before being tested.
1699 // - They need to save their state to toolstate.
1700 // - They are only tested on the "checktools" builders.
1702 // The local docs are tested by default, and we don't want to pay the
1703 // cost of building mdbook, so they use `rustdoc --test` directly.
1704 // Also, the unstable book is special because SUMMARY.md is generated,
1705 // so it is easier to just run `rustdoc` on its files.
1706 if self.is_ext_doc {
1707 self.run_ext_doc(builder);
1709 self.run_local_doc(builder);
1715 /// This runs the equivalent of `mdbook test` (via the rustbook wrapper)
1716 /// which in turn runs `rustdoc --test` on each file in the book.
1717 fn run_ext_doc(self, builder: &Builder<'_>) {
1718 let compiler = self.compiler;
1720 builder.ensure(compile::Std::new(compiler, compiler.host));
1722 // mdbook just executes a binary named "rustdoc", so we need to update
1723 // PATH so that it points to our rustdoc.
1724 let mut rustdoc_path = builder.rustdoc(compiler);
1726 let old_path = env::var_os("PATH").unwrap_or_default();
1727 let new_path = env::join_paths(iter::once(rustdoc_path).chain(env::split_paths(&old_path)))
1728 .expect("could not add rustdoc to PATH");
1730 let mut rustbook_cmd = builder.tool_cmd(Tool::Rustbook);
1731 let path = builder.src.join(&self.path);
1732 // Books often have feature-gated example text.
1733 rustbook_cmd.env("RUSTC_BOOTSTRAP", "1");
1734 rustbook_cmd.env("PATH", new_path).arg("test").arg(path);
1735 builder.add_rust_test_threads(&mut rustbook_cmd);
1736 builder.info(&format!("Testing rustbook {}", self.path.display()));
1737 let _time = util::timeit(&builder);
1738 let toolstate = if try_run(builder, &mut rustbook_cmd) {
1743 builder.save_toolstate(self.name, toolstate);
1746 /// This runs `rustdoc --test` on all `.md` files in the path.
1747 fn run_local_doc(self, builder: &Builder<'_>) {
1748 let compiler = self.compiler;
1750 builder.ensure(compile::Std::new(compiler, compiler.host));
1752 // Do a breadth-first traversal of the `src/doc` directory and just run
1753 // tests for all files that end in `*.md`
1754 let mut stack = vec![builder.src.join(self.path)];
1755 let _time = util::timeit(&builder);
1756 let mut files = Vec::new();
1757 while let Some(p) = stack.pop() {
1759 stack.extend(t!(p.read_dir()).map(|p| t!(p).path()));
1763 if p.extension().and_then(|s| s.to_str()) != Some("md") {
1773 markdown_test(builder, compiler, &file);
1778 macro_rules! test_book {
1779 ($($name:ident, $path:expr, $book_name:expr, default=$default:expr;)+) => {
1781 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1786 impl Step for $name {
1788 const DEFAULT: bool = $default;
1789 const ONLY_HOSTS: bool = true;
1791 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1795 fn make_run(run: RunConfig<'_>) {
1796 run.builder.ensure($name {
1797 compiler: run.builder.compiler(run.builder.top_stage, run.target),
1801 fn run(self, builder: &Builder<'_>) {
1802 builder.ensure(BookTest {
1803 compiler: self.compiler,
1804 path: PathBuf::from($path),
1806 is_ext_doc: !$default,
1815 Nomicon, "src/doc/nomicon", "nomicon", default=false;
1816 Reference, "src/doc/reference", "reference", default=false;
1817 RustdocBook, "src/doc/rustdoc", "rustdoc", default=true;
1818 RustcBook, "src/doc/rustc", "rustc", default=true;
1819 RustByExample, "src/doc/rust-by-example", "rust-by-example", default=false;
1820 EmbeddedBook, "src/doc/embedded-book", "embedded-book", default=false;
1821 TheBook, "src/doc/book", "book", default=false;
1822 UnstableBook, "src/doc/unstable-book", "unstable-book", default=true;
1823 EditionGuide, "src/doc/edition-guide", "edition-guide", default=false;
1826 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1827 pub struct ErrorIndex {
1831 impl Step for ErrorIndex {
1833 const DEFAULT: bool = true;
1834 const ONLY_HOSTS: bool = true;
1836 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1837 run.path("src/tools/error_index_generator")
1840 fn make_run(run: RunConfig<'_>) {
1841 // error_index_generator depends on librustdoc. Use the compiler that
1842 // is normally used to build rustdoc for other tests (like compiletest
1843 // tests in src/test/rustdoc) so that it shares the same artifacts.
1844 let compiler = run.builder.compiler(run.builder.top_stage, run.builder.config.build);
1845 run.builder.ensure(ErrorIndex { compiler });
1848 /// Runs the error index generator tool to execute the tests located in the error
1851 /// The `error_index_generator` tool lives in `src/tools` and is used to
1852 /// generate a markdown file from the error indexes of the code base which is
1853 /// then passed to `rustdoc --test`.
1854 fn run(self, builder: &Builder<'_>) {
1855 let compiler = self.compiler;
1857 let dir = testdir(builder, compiler.host);
1858 t!(fs::create_dir_all(&dir));
1859 let output = dir.join("error-index.md");
1861 let mut tool = tool::ErrorIndex::command(builder);
1862 tool.arg("markdown").arg(&output);
1864 builder.info(&format!("Testing error-index stage{}", compiler.stage));
1865 let _time = util::timeit(&builder);
1866 builder.run_quiet(&mut tool);
1867 // The tests themselves need to link to std, so make sure it is
1869 builder.ensure(compile::Std::new(compiler, compiler.host));
1870 markdown_test(builder, compiler, &output);
1874 fn markdown_test(builder: &Builder<'_>, compiler: Compiler, markdown: &Path) -> bool {
1875 if let Ok(contents) = fs::read_to_string(markdown) {
1876 if !contents.contains("```") {
1881 builder.info(&format!("doc tests for: {}", markdown.display()));
1882 let mut cmd = builder.rustdoc_cmd(compiler);
1883 builder.add_rust_test_threads(&mut cmd);
1884 // allow for unstable options such as new editions
1886 cmd.arg("unstable-options");
1889 cmd.env("RUSTC_BOOTSTRAP", "1");
1891 let test_args = builder.config.cmd.test_args().join(" ");
1892 cmd.arg("--test-args").arg(test_args);
1894 if builder.config.verbose_tests {
1895 try_run(builder, &mut cmd)
1897 try_run_quiet(builder, &mut cmd)
1901 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1902 pub struct RustcGuide;
1904 impl Step for RustcGuide {
1906 const DEFAULT: bool = false;
1907 const ONLY_HOSTS: bool = true;
1909 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1910 run.path("src/doc/rustc-dev-guide")
1913 fn make_run(run: RunConfig<'_>) {
1914 run.builder.ensure(RustcGuide);
1917 fn run(self, builder: &Builder<'_>) {
1918 let relative_path = Path::new("src").join("doc").join("rustc-dev-guide");
1919 builder.update_submodule(&relative_path);
1921 let src = builder.src.join(relative_path);
1922 let mut rustbook_cmd = builder.tool_cmd(Tool::Rustbook);
1923 let toolstate = if try_run(builder, rustbook_cmd.arg("linkcheck").arg(&src)) {
1928 builder.save_toolstate("rustc-dev-guide", toolstate);
1932 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
1933 pub struct CrateLibrustc {
1935 target: TargetSelection,
1936 test_kind: TestKind,
1937 crates: Vec<Interned<String>>,
1940 impl Step for CrateLibrustc {
1942 const DEFAULT: bool = true;
1943 const ONLY_HOSTS: bool = true;
1945 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1946 run.crate_or_deps("rustc-main")
1949 fn make_run(run: RunConfig<'_>) {
1950 let builder = run.builder;
1951 let host = run.build_triple();
1952 let compiler = builder.compiler_for(builder.top_stage, host, host);
1956 .map(|p| builder.crate_paths[&p.assert_single_path().path].clone())
1958 let test_kind = builder.kind.into();
1960 builder.ensure(CrateLibrustc { compiler, target: run.target, test_kind, crates });
1963 fn run(self, builder: &Builder<'_>) {
1964 builder.ensure(Crate {
1965 compiler: self.compiler,
1966 target: self.target,
1968 test_kind: self.test_kind,
1969 crates: self.crates,
1974 #[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
1976 pub compiler: Compiler,
1977 pub target: TargetSelection,
1979 pub test_kind: TestKind,
1980 pub crates: Vec<Interned<String>>,
1983 impl Step for Crate {
1985 const DEFAULT: bool = true;
1987 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1988 run.crate_or_deps("test")
1991 fn make_run(run: RunConfig<'_>) {
1992 let builder = run.builder;
1993 let host = run.build_triple();
1994 let compiler = builder.compiler_for(builder.top_stage, host, host);
1995 let test_kind = builder.kind.into();
1999 .map(|p| builder.crate_paths[&p.assert_single_path().path].clone())
2002 builder.ensure(Crate { compiler, target: run.target, mode: Mode::Std, test_kind, crates });
2005 /// Runs all unit tests plus documentation tests for a given crate defined
2006 /// by a `Cargo.toml` (single manifest)
2008 /// This is what runs tests for crates like the standard library, compiler, etc.
2009 /// It essentially is the driver for running `cargo test`.
2011 /// Currently this runs all tests for a DAG by passing a bunch of `-p foo`
2012 /// arguments, and those arguments are discovered from `cargo metadata`.
2013 fn run(self, builder: &Builder<'_>) {
2014 let compiler = self.compiler;
2015 let target = self.target;
2016 let mode = self.mode;
2017 let test_kind = self.test_kind;
2019 builder.ensure(compile::Std::new(compiler, target));
2020 builder.ensure(RemoteCopyLibs { compiler, target });
2022 // If we're not doing a full bootstrap but we're testing a stage2
2023 // version of libstd, then what we're actually testing is the libstd
2024 // produced in stage1. Reflect that here by updating the compiler that
2025 // we're working with automatically.
2026 let compiler = builder.compiler_for(compiler.stage, compiler.host, target);
2029 builder.cargo(compiler, mode, SourceType::InTree, target, test_kind.subcommand());
2032 compile::std_cargo(builder, target, compiler.stage, &mut cargo);
2035 compile::rustc_cargo(builder, &mut cargo, target);
2037 _ => panic!("can only test libraries"),
2040 // Build up the base `cargo test` command.
2042 // Pass in some standard flags then iterate over the graph we've discovered
2043 // in `cargo metadata` with the maps above and figure out what `-p`
2044 // arguments need to get passed.
2045 if test_kind.subcommand() == "test" && !builder.fail_fast {
2046 cargo.arg("--no-fail-fast");
2048 match builder.doc_tests {
2053 cargo.args(&["--lib", "--bins", "--examples", "--tests", "--benches"]);
2058 for krate in &self.crates {
2059 cargo.arg("-p").arg(krate);
2062 // The tests are going to run with the *target* libraries, so we need to
2063 // ensure that those libraries show up in the LD_LIBRARY_PATH equivalent.
2065 // Note that to run the compiler we need to run with the *host* libraries,
2066 // but our wrapper scripts arrange for that to be the case anyway.
2067 let mut dylib_path = dylib_path();
2068 dylib_path.insert(0, PathBuf::from(&*builder.sysroot_libdir(compiler, target)));
2069 cargo.env(dylib_path_var(), env::join_paths(&dylib_path).unwrap());
2072 cargo.args(&builder.config.cmd.test_args());
2074 if !builder.config.verbose_tests {
2075 cargo.arg("--quiet");
2078 if target.contains("emscripten") {
2080 format!("CARGO_TARGET_{}_RUNNER", envify(&target.triple)),
2081 builder.config.nodejs.as_ref().expect("nodejs not configured"),
2083 } else if target.starts_with("wasm32") {
2084 let node = builder.config.nodejs.as_ref().expect("nodejs not configured");
2086 format!("{} {}/src/etc/wasm32-shim.js", node.display(), builder.src.display());
2087 cargo.env(format!("CARGO_TARGET_{}_RUNNER", envify(&target.triple)), &runner);
2088 } else if builder.remote_tested(target) {
2090 format!("CARGO_TARGET_{}_RUNNER", envify(&target.triple)),
2091 format!("{} run 0", builder.tool_exe(Tool::RemoteTestClient).display()),
2095 builder.info(&format!(
2096 "{} {:?} stage{} ({} -> {})",
2097 test_kind, self.crates, compiler.stage, &compiler.host, target
2099 let _time = util::timeit(&builder);
2100 try_run(builder, &mut cargo.into());
2104 /// Rustdoc is special in various ways, which is why this step is different from `Crate`.
2105 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2106 pub struct CrateRustdoc {
2107 host: TargetSelection,
2108 test_kind: TestKind,
2111 impl Step for CrateRustdoc {
2113 const DEFAULT: bool = true;
2114 const ONLY_HOSTS: bool = true;
2116 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2117 run.paths(&["src/librustdoc", "src/tools/rustdoc"])
2120 fn make_run(run: RunConfig<'_>) {
2121 let builder = run.builder;
2123 let test_kind = builder.kind.into();
2125 builder.ensure(CrateRustdoc { host: run.target, test_kind });
2128 fn run(self, builder: &Builder<'_>) {
2129 let test_kind = self.test_kind;
2130 let target = self.host;
2132 let compiler = if builder.download_rustc() {
2133 builder.compiler(builder.top_stage, target)
2135 // Use the previous stage compiler to reuse the artifacts that are
2136 // created when running compiletest for src/test/rustdoc. If this used
2137 // `compiler`, then it would cause rustdoc to be built *again*, which
2138 // isn't really necessary.
2139 builder.compiler_for(builder.top_stage, target, target)
2141 builder.ensure(compile::Rustc::new(compiler, target));
2143 let mut cargo = tool::prepare_tool_cargo(
2148 test_kind.subcommand(),
2149 "src/tools/rustdoc",
2153 if test_kind.subcommand() == "test" && !builder.fail_fast {
2154 cargo.arg("--no-fail-fast");
2156 match builder.doc_tests {
2161 cargo.args(&["--lib", "--bins", "--examples", "--tests", "--benches"]);
2166 cargo.arg("-p").arg("rustdoc:0.0.0");
2169 cargo.args(&builder.config.cmd.test_args());
2171 if self.host.contains("musl") {
2172 cargo.arg("'-Ctarget-feature=-crt-static'");
2175 // This is needed for running doctests on librustdoc. This is a bit of
2176 // an unfortunate interaction with how bootstrap works and how cargo
2177 // sets up the dylib path, and the fact that the doctest (in
2178 // html/markdown.rs) links to rustc-private libs. For stage1, the
2179 // compiler host dylibs (in stage1/lib) are not the same as the target
2180 // dylibs (in stage1/lib/rustlib/...). This is different from a normal
2181 // rust distribution where they are the same.
2183 // On the cargo side, normal tests use `target_process` which handles
2184 // setting up the dylib for a *target* (stage1/lib/rustlib/... in this
2185 // case). However, for doctests it uses `rustdoc_process` which only
2186 // sets up the dylib path for the *host* (stage1/lib), which is the
2189 // Recall that we special-cased `compiler_for(top_stage)` above, so we always use stage1.
2191 // It should be considered to just stop running doctests on
2192 // librustdoc. There is only one test, and it doesn't look too
2193 // important. There might be other ways to avoid this, but it seems
2194 // pretty convoluted.
2196 // See also https://github.com/rust-lang/rust/issues/13983 where the
2197 // host vs target dylibs for rustdoc are consistently tricky to deal
2200 // Note that this set the host libdir for `download_rustc`, which uses a normal rust distribution.
2201 let libdir = if builder.download_rustc() {
2202 builder.rustc_libdir(compiler)
2204 builder.sysroot_libdir(compiler, target).to_path_buf()
2206 let mut dylib_path = dylib_path();
2207 dylib_path.insert(0, PathBuf::from(&*libdir));
2208 cargo.env(dylib_path_var(), env::join_paths(&dylib_path).unwrap());
2210 if !builder.config.verbose_tests {
2211 cargo.arg("--quiet");
2214 builder.info(&format!(
2215 "{} rustdoc stage{} ({} -> {})",
2216 test_kind, compiler.stage, &compiler.host, target
2218 let _time = util::timeit(&builder);
2220 try_run(builder, &mut cargo.into());
2224 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2225 pub struct CrateRustdocJsonTypes {
2226 host: TargetSelection,
2227 test_kind: TestKind,
2230 impl Step for CrateRustdocJsonTypes {
2232 const DEFAULT: bool = true;
2233 const ONLY_HOSTS: bool = true;
2235 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2236 run.path("src/rustdoc-json-types")
2239 fn make_run(run: RunConfig<'_>) {
2240 let builder = run.builder;
2242 let test_kind = builder.kind.into();
2244 builder.ensure(CrateRustdocJsonTypes { host: run.target, test_kind });
2247 fn run(self, builder: &Builder<'_>) {
2248 let test_kind = self.test_kind;
2249 let target = self.host;
2251 // Use the previous stage compiler to reuse the artifacts that are
2252 // created when running compiletest for src/test/rustdoc. If this used
2253 // `compiler`, then it would cause rustdoc to be built *again*, which
2254 // isn't really necessary.
2255 let compiler = builder.compiler_for(builder.top_stage, target, target);
2256 builder.ensure(compile::Rustc::new(compiler, target));
2258 let mut cargo = tool::prepare_tool_cargo(
2263 test_kind.subcommand(),
2264 "src/rustdoc-json-types",
2268 if test_kind.subcommand() == "test" && !builder.fail_fast {
2269 cargo.arg("--no-fail-fast");
2272 cargo.arg("-p").arg("rustdoc-json-types");
2275 cargo.args(&builder.config.cmd.test_args());
2277 if self.host.contains("musl") {
2278 cargo.arg("'-Ctarget-feature=-crt-static'");
2281 if !builder.config.verbose_tests {
2282 cargo.arg("--quiet");
2285 builder.info(&format!(
2286 "{} rustdoc-json-types stage{} ({} -> {})",
2287 test_kind, compiler.stage, &compiler.host, target
2289 let _time = util::timeit(&builder);
2291 try_run(builder, &mut cargo.into());
2295 /// Some test suites are run inside emulators or on remote devices, and most
2296 /// of our test binaries are linked dynamically which means we need to ship
2297 /// the standard library and such to the emulator ahead of time. This step
2298 /// represents this and is a dependency of all test suites.
2300 /// Most of the time this is a no-op. For some steps such as shipping data to
2301 /// QEMU we have to build our own tools so we've got conditional dependencies
2302 /// on those programs as well. Note that the remote test client is built for
2303 /// the build target (us) and the server is built for the target.
2304 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2305 pub struct RemoteCopyLibs {
2307 target: TargetSelection,
2310 impl Step for RemoteCopyLibs {
2313 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2317 fn run(self, builder: &Builder<'_>) {
2318 let compiler = self.compiler;
2319 let target = self.target;
2320 if !builder.remote_tested(target) {
2324 builder.ensure(compile::Std::new(compiler, target));
2326 builder.info(&format!("REMOTE copy libs to emulator ({})", target));
2328 let server = builder.ensure(tool::RemoteTestServer { compiler, target });
2330 // Spawn the emulator and wait for it to come online
2331 let tool = builder.tool_exe(Tool::RemoteTestClient);
2332 let mut cmd = Command::new(&tool);
2333 cmd.arg("spawn-emulator").arg(target.triple).arg(&server).arg(builder.tempdir());
2334 if let Some(rootfs) = builder.qemu_rootfs(target) {
2337 builder.run(&mut cmd);
2339 // Push all our dylibs to the emulator
2340 for f in t!(builder.sysroot_libdir(compiler, target).read_dir()) {
2342 let name = f.file_name().into_string().unwrap();
2343 if util::is_dylib(&name) {
2344 builder.run(Command::new(&tool).arg("push").arg(f.path()));
2350 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2351 pub struct Distcheck;
2353 impl Step for Distcheck {
2356 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2357 run.alias("distcheck")
2360 fn make_run(run: RunConfig<'_>) {
2361 run.builder.ensure(Distcheck);
2364 /// Runs "distcheck", a 'make check' from a tarball
2365 fn run(self, builder: &Builder<'_>) {
2366 builder.info("Distcheck");
2367 let dir = builder.tempdir().join("distcheck");
2368 let _ = fs::remove_dir_all(&dir);
2369 t!(fs::create_dir_all(&dir));
2371 // Guarantee that these are built before we begin running.
2372 builder.ensure(dist::PlainSourceTarball);
2373 builder.ensure(dist::Src);
2375 let mut cmd = Command::new("tar");
2377 .arg(builder.ensure(dist::PlainSourceTarball).tarball())
2378 .arg("--strip-components=1")
2380 builder.run(&mut cmd);
2382 Command::new("./configure")
2383 .args(&builder.config.configure_args)
2384 .arg("--enable-vendor")
2388 Command::new(util::make(&builder.config.build.triple)).arg("check").current_dir(&dir),
2391 // Now make sure that rust-src has all of libstd's dependencies
2392 builder.info("Distcheck rust-src");
2393 let dir = builder.tempdir().join("distcheck-src");
2394 let _ = fs::remove_dir_all(&dir);
2395 t!(fs::create_dir_all(&dir));
2397 let mut cmd = Command::new("tar");
2399 .arg(builder.ensure(dist::Src).tarball())
2400 .arg("--strip-components=1")
2402 builder.run(&mut cmd);
2404 let toml = dir.join("rust-src/lib/rustlib/src/rust/library/std/Cargo.toml");
2406 Command::new(&builder.initial_cargo)
2407 .arg("generate-lockfile")
2408 .arg("--manifest-path")
2415 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2416 pub struct Bootstrap;
2418 impl Step for Bootstrap {
2420 const DEFAULT: bool = true;
2421 const ONLY_HOSTS: bool = true;
2423 /// Tests the build system itself.
2424 fn run(self, builder: &Builder<'_>) {
2425 let mut check_bootstrap = Command::new(&builder.python());
2426 check_bootstrap.arg("bootstrap_test.py").current_dir(builder.src.join("src/bootstrap/"));
2427 try_run(builder, &mut check_bootstrap);
2429 let mut cmd = Command::new(&builder.initial_cargo);
2431 .current_dir(builder.src.join("src/bootstrap"))
2432 .env("RUSTFLAGS", "-Cdebuginfo=2")
2433 .env("CARGO_TARGET_DIR", builder.out.join("bootstrap"))
2434 .env("RUSTC_BOOTSTRAP", "1")
2435 .env("RUSTDOC", builder.rustdoc(builder.compiler(0, builder.build.build)))
2436 .env("RUSTC", &builder.initial_rustc);
2437 if let Some(flags) = option_env!("RUSTFLAGS") {
2438 // Use the same rustc flags for testing as for "normal" compilation,
2439 // so that Cargo doesn’t recompile the entire dependency graph every time:
2440 // https://github.com/rust-lang/rust/issues/49215
2441 cmd.env("RUSTFLAGS", flags);
2443 if !builder.fail_fast {
2444 cmd.arg("--no-fail-fast");
2446 match builder.doc_tests {
2451 cmd.args(&["--lib", "--bins", "--examples", "--tests", "--benches"]);
2456 cmd.arg("--").args(&builder.config.cmd.test_args());
2457 // rustbuild tests are racy on directory creation so just run them one at a time.
2458 // Since there's not many this shouldn't be a problem.
2459 cmd.arg("--test-threads=1");
2460 try_run(builder, &mut cmd);
2463 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2464 run.path("src/bootstrap")
2467 fn make_run(run: RunConfig<'_>) {
2468 run.builder.ensure(Bootstrap);
2472 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2473 pub struct TierCheck {
2474 pub compiler: Compiler,
2477 impl Step for TierCheck {
2479 const DEFAULT: bool = true;
2480 const ONLY_HOSTS: bool = true;
2482 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2483 run.path("src/tools/tier-check")
2486 fn make_run(run: RunConfig<'_>) {
2488 run.builder.compiler_for(run.builder.top_stage, run.builder.build.build, run.target);
2489 run.builder.ensure(TierCheck { compiler });
2492 /// Tests the Platform Support page in the rustc book.
2493 fn run(self, builder: &Builder<'_>) {
2494 builder.ensure(compile::Std::new(self.compiler, self.compiler.host));
2495 let mut cargo = tool::prepare_tool_cargo(
2501 "src/tools/tier-check",
2505 cargo.arg(builder.src.join("src/doc/rustc/src/platform-support.md"));
2506 cargo.arg(&builder.rustc(self.compiler));
2507 if builder.is_verbose() {
2508 cargo.arg("--verbose");
2511 builder.info("platform support check");
2512 try_run(builder, &mut cargo.into());
2516 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2517 pub struct ReplacePlaceholderTest;
2519 impl Step for ReplacePlaceholderTest {
2521 const ONLY_HOSTS: bool = true;
2522 const DEFAULT: bool = true;
2524 /// Ensure the version placeholder replacement tool builds
2525 fn run(self, builder: &Builder<'_>) {
2526 builder.info("build check for version replacement placeholder");
2528 // Test the version placeholder replacement tool itself.
2529 let bootstrap_host = builder.config.build;
2530 let compiler = builder.compiler(0, bootstrap_host);
2531 let cargo = tool::prepare_tool_cargo(
2534 Mode::ToolBootstrap,
2537 "src/tools/replace-version-placeholder",
2541 try_run(builder, &mut cargo.into());
2544 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2545 run.path("src/tools/replace-version-placeholder")
2548 fn make_run(run: RunConfig<'_>) {
2549 run.builder.ensure(Self);
2553 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2554 pub struct LintDocs {
2555 pub compiler: Compiler,
2556 pub target: TargetSelection,
2559 impl Step for LintDocs {
2561 const DEFAULT: bool = true;
2562 const ONLY_HOSTS: bool = true;
2564 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2565 run.path("src/tools/lint-docs")
2568 fn make_run(run: RunConfig<'_>) {
2569 run.builder.ensure(LintDocs {
2570 compiler: run.builder.compiler(run.builder.top_stage, run.builder.config.build),
2575 /// Tests that the lint examples in the rustc book generate the correct
2576 /// lints and have the expected format.
2577 fn run(self, builder: &Builder<'_>) {
2578 builder.ensure(crate::doc::RustcBook {
2579 compiler: self.compiler,
2580 target: self.target,