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;
14 use build_helper::{self, output, t};
16 use crate::builder::{Builder, Compiler, Kind, RunConfig, ShouldRun, Step};
17 use crate::cache::{Interned, INTERNER};
20 use crate::flags::Subcommand;
22 use crate::tool::{self, SourceType, Tool};
23 use crate::toolstate::ToolState;
24 use crate::util::{self, dylib_path, dylib_path_var};
25 use crate::Crate as CargoCrate;
26 use crate::{envify, DocTests, GitRepo, Mode};
28 const ADB_TEST_DIR: &str = "/data/tmp/work";
30 /// The two modes of the test runner; tests or benchmarks.
31 #[derive(Debug, PartialEq, Eq, Hash, Copy, Clone, PartialOrd, Ord)]
35 /// Run `cargo bench`.
39 impl From<Kind> for TestKind {
40 fn from(kind: Kind) -> Self {
42 Kind::Test => TestKind::Test,
43 Kind::Bench => TestKind::Bench,
44 _ => panic!("unexpected kind in crate: {:?}", kind),
50 // Return the cargo subcommand for this test kind
51 fn subcommand(self) -> &'static str {
53 TestKind::Test => "test",
54 TestKind::Bench => "bench",
59 impl fmt::Display for TestKind {
60 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
61 f.write_str(match *self {
62 TestKind::Test => "Testing",
63 TestKind::Bench => "Benchmarking",
68 fn try_run(builder: &Builder<'_>, cmd: &mut Command) -> bool {
69 if !builder.fail_fast {
70 if !builder.try_run(cmd) {
71 let mut failures = builder.delayed_failures.borrow_mut();
72 failures.push(format!("{:?}", cmd));
81 fn try_run_quiet(builder: &Builder<'_>, cmd: &mut Command) -> bool {
82 if !builder.fail_fast {
83 if !builder.try_run_quiet(cmd) {
84 let mut failures = builder.delayed_failures.borrow_mut();
85 failures.push(format!("{:?}", cmd));
89 builder.run_quiet(cmd);
94 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
95 pub struct Linkcheck {
96 host: Interned<String>,
99 impl Step for Linkcheck {
101 const ONLY_HOSTS: bool = true;
102 const DEFAULT: bool = true;
104 /// Runs the `linkchecker` tool as compiled in `stage` by the `host` compiler.
106 /// This tool in `src/tools` will verify the validity of all our links in the
107 /// documentation to ensure we don't have a bunch of dead ones.
108 fn run(self, builder: &Builder<'_>) {
109 let host = self.host;
111 builder.info(&format!("Linkcheck ({})", host));
113 builder.default_doc(None);
115 let _time = util::timeit(&builder);
118 builder.tool_cmd(Tool::Linkchecker).arg(builder.out.join(host).join("doc")),
122 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
123 let builder = run.builder;
124 run.path("src/tools/linkchecker").default_condition(builder.config.docs)
127 fn make_run(run: RunConfig<'_>) {
128 run.builder.ensure(Linkcheck { host: run.target });
132 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
133 pub struct Cargotest {
135 host: Interned<String>,
138 impl Step for Cargotest {
140 const ONLY_HOSTS: bool = true;
142 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
143 run.path("src/tools/cargotest")
146 fn make_run(run: RunConfig<'_>) {
147 run.builder.ensure(Cargotest { stage: run.builder.top_stage, host: run.target });
150 /// Runs the `cargotest` tool as compiled in `stage` by the `host` compiler.
152 /// This tool in `src/tools` will check out a few Rust projects and run `cargo
153 /// test` to ensure that we don't regress the test suites there.
154 fn run(self, builder: &Builder<'_>) {
155 let compiler = builder.compiler(self.stage, self.host);
156 builder.ensure(compile::Rustc { compiler, target: compiler.host });
158 // Note that this is a short, cryptic, and not scoped directory name. This
159 // is currently to minimize the length of path on Windows where we otherwise
160 // quickly run into path name limit constraints.
161 let out_dir = builder.out.join("ct");
162 t!(fs::create_dir_all(&out_dir));
164 let _time = util::timeit(&builder);
165 let mut cmd = builder.tool_cmd(Tool::CargoTest);
168 cmd.arg(&builder.initial_cargo)
170 .env("RUSTC", builder.rustc(compiler))
171 .env("RUSTDOC", builder.rustdoc(compiler)),
176 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
179 host: Interned<String>,
182 impl Step for Cargo {
184 const ONLY_HOSTS: bool = true;
186 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
187 run.path("src/tools/cargo")
190 fn make_run(run: RunConfig<'_>) {
191 run.builder.ensure(Cargo { stage: run.builder.top_stage, host: run.target });
194 /// Runs `cargo test` for `cargo` packaged with Rust.
195 fn run(self, builder: &Builder<'_>) {
196 let compiler = builder.compiler(self.stage, self.host);
198 builder.ensure(tool::Cargo { compiler, target: self.host });
199 let mut cargo = tool::prepare_tool_cargo(
206 SourceType::Submodule,
210 if !builder.fail_fast {
211 cargo.arg("--no-fail-fast");
214 // Don't run cross-compile tests, we may not have cross-compiled libstd libs
216 cargo.env("CFG_DISABLE_CROSS_TESTS", "1");
217 // Disable a test that has issues with mingw.
218 cargo.env("CARGO_TEST_DISABLE_GIT_CLI", "1");
219 // Forcibly disable tests using nightly features since any changes to
220 // those features won't be able to land.
221 cargo.env("CARGO_TEST_DISABLE_NIGHTLY", "1");
223 cargo.env("PATH", &path_for_cargo(builder, compiler));
225 try_run(builder, &mut cargo.into());
229 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
232 host: Interned<String>,
237 const ONLY_HOSTS: bool = true;
239 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
240 run.path("src/tools/rls")
243 fn make_run(run: RunConfig<'_>) {
244 run.builder.ensure(Rls { stage: run.builder.top_stage, host: run.target });
247 /// Runs `cargo test` for the rls.
248 fn run(self, builder: &Builder<'_>) {
249 let stage = self.stage;
250 let host = self.host;
251 let compiler = builder.compiler(stage, host);
254 builder.ensure(tool::Rls { compiler, target: self.host, extra_features: Vec::new() });
255 if build_result.is_none() {
256 eprintln!("failed to test rls: could not build");
260 let mut cargo = tool::prepare_tool_cargo(
267 SourceType::Submodule,
271 builder.add_rustc_lib_path(compiler, &mut cargo);
272 cargo.arg("--").args(builder.config.cmd.test_args());
274 if try_run(builder, &mut cargo.into()) {
275 builder.save_toolstate("rls", ToolState::TestPass);
280 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
283 host: Interned<String>,
286 impl Step for Rustfmt {
288 const ONLY_HOSTS: bool = true;
290 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
291 run.path("src/tools/rustfmt")
294 fn make_run(run: RunConfig<'_>) {
295 run.builder.ensure(Rustfmt { stage: run.builder.top_stage, host: run.target });
298 /// Runs `cargo test` for rustfmt.
299 fn run(self, builder: &Builder<'_>) {
300 let stage = self.stage;
301 let host = self.host;
302 let compiler = builder.compiler(stage, host);
304 let build_result = builder.ensure(tool::Rustfmt {
307 extra_features: Vec::new(),
309 if build_result.is_none() {
310 eprintln!("failed to test rustfmt: could not build");
314 let mut cargo = tool::prepare_tool_cargo(
321 SourceType::Submodule,
325 let dir = testdir(builder, compiler.host);
326 t!(fs::create_dir_all(&dir));
327 cargo.env("RUSTFMT_TEST_DIR", dir);
329 builder.add_rustc_lib_path(compiler, &mut cargo);
331 if try_run(builder, &mut cargo.into()) {
332 builder.save_toolstate("rustfmt", ToolState::TestPass);
337 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
340 host: Interned<String>,
345 const ONLY_HOSTS: bool = true;
347 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
348 run.path("src/tools/miri")
351 fn make_run(run: RunConfig<'_>) {
352 run.builder.ensure(Miri { stage: run.builder.top_stage, host: run.target });
355 /// Runs `cargo test` for miri.
356 fn run(self, builder: &Builder<'_>) {
357 let stage = self.stage;
358 let host = self.host;
359 let compiler = builder.compiler(stage, host);
362 builder.ensure(tool::Miri { compiler, target: self.host, extra_features: Vec::new() });
363 if let Some(miri) = miri {
364 let mut cargo = builder.cargo(compiler, Mode::ToolRustc, host, "install");
366 // Configure `cargo install` path. cargo adds a `bin/`.
367 cargo.env("CARGO_INSTALL_ROOT", &builder.out);
369 let mut cargo = Command::from(cargo);
370 if !try_run(builder, &mut cargo) {
374 // # Run `cargo miri setup`.
375 let mut cargo = tool::prepare_tool_cargo(
382 SourceType::Submodule,
385 cargo.arg("--bin").arg("cargo-miri").arg("--").arg("miri").arg("setup");
387 // Tell `cargo miri setup` where to find the sources.
388 cargo.env("XARGO_RUST_SRC", builder.src.join("src"));
390 cargo.env("RUST_BACKTRACE", "1");
391 // Let cargo-miri know where xargo ended up.
392 cargo.env("XARGO", builder.out.join("bin").join("xargo"));
394 let mut cargo = Command::from(cargo);
395 if !try_run(builder, &mut cargo) {
399 // # Determine where Miri put its sysroot.
400 // To this end, we run `cargo miri setup --env` and capture the output.
401 // (We do this separately from the above so that when the setup actually
402 // happens we get some output.)
403 // We re-use the `cargo` from above.
404 cargo.arg("--print-sysroot");
406 // FIXME: Is there a way in which we can re-use the usual `run` helpers?
407 let miri_sysroot = if builder.config.dry_run {
410 builder.verbose(&format!("running: {:?}", cargo));
413 .expect("We already ran `cargo miri setup` before and that worked");
414 assert!(out.status.success(), "`cargo miri setup` returned with non-0 exit code");
415 // Output is "<sysroot>\n".
416 let stdout = String::from_utf8(out.stdout)
417 .expect("`cargo miri setup` stdout is not valid UTF-8");
418 let sysroot = stdout.trim_end();
419 builder.verbose(&format!("`cargo miri setup --print-sysroot` said: {:?}", sysroot));
423 // # Run `cargo test`.
424 let mut cargo = tool::prepare_tool_cargo(
431 SourceType::Submodule,
435 // miri tests need to know about the stage sysroot
436 cargo.env("MIRI_SYSROOT", miri_sysroot);
437 cargo.env("RUSTC_TEST_SUITE", builder.rustc(compiler));
438 cargo.env("RUSTC_LIB_PATH", builder.rustc_libdir(compiler));
439 cargo.env("MIRI_PATH", miri);
441 builder.add_rustc_lib_path(compiler, &mut cargo);
443 if !try_run(builder, &mut cargo.into()) {
448 builder.save_toolstate("miri", ToolState::TestPass);
450 eprintln!("failed to test miri: could not build");
455 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
456 pub struct CompiletestTest {
457 host: Interned<String>,
460 impl Step for CompiletestTest {
463 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
464 run.path("src/tools/compiletest")
467 fn make_run(run: RunConfig<'_>) {
468 run.builder.ensure(CompiletestTest { host: run.target });
471 /// Runs `cargo test` for compiletest.
472 fn run(self, builder: &Builder<'_>) {
473 let host = self.host;
474 let compiler = builder.compiler(0, host);
476 let cargo = tool::prepare_tool_cargo(
482 "src/tools/compiletest",
487 try_run(builder, &mut cargo.into());
491 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
494 host: Interned<String>,
497 impl Step for Clippy {
499 const ONLY_HOSTS: bool = true;
500 const DEFAULT: bool = false;
502 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
503 run.path("src/tools/clippy")
506 fn make_run(run: RunConfig<'_>) {
507 run.builder.ensure(Clippy { stage: run.builder.top_stage, host: run.target });
510 /// Runs `cargo test` for clippy.
511 fn run(self, builder: &Builder<'_>) {
512 let stage = self.stage;
513 let host = self.host;
514 let compiler = builder.compiler(stage, host);
516 let clippy = builder.ensure(tool::Clippy {
519 extra_features: Vec::new(),
521 if let Some(clippy) = clippy {
522 let mut cargo = tool::prepare_tool_cargo(
529 SourceType::Submodule,
533 // clippy tests need to know about the stage sysroot
534 cargo.env("SYSROOT", builder.sysroot(compiler));
535 cargo.env("RUSTC_TEST_SUITE", builder.rustc(compiler));
536 cargo.env("RUSTC_LIB_PATH", builder.rustc_libdir(compiler));
537 let host_libs = builder.stage_out(compiler, Mode::ToolRustc).join(builder.cargo_dir());
538 let target_libs = builder
539 .stage_out(compiler, Mode::ToolRustc)
541 .join(builder.cargo_dir());
542 cargo.env("HOST_LIBS", host_libs);
543 cargo.env("TARGET_LIBS", target_libs);
544 // clippy tests need to find the driver
545 cargo.env("CLIPPY_DRIVER_PATH", clippy);
547 builder.add_rustc_lib_path(compiler, &mut cargo);
549 if try_run(builder, &mut cargo.into()) {
550 builder.save_toolstate("clippy-driver", ToolState::TestPass);
553 eprintln!("failed to test clippy: could not build");
558 fn path_for_cargo(builder: &Builder<'_>, compiler: Compiler) -> OsString {
559 // Configure PATH to find the right rustc. NB. we have to use PATH
560 // and not RUSTC because the Cargo test suite has tests that will
561 // fail if rustc is not spelled `rustc`.
562 let path = builder.sysroot(compiler).join("bin");
563 let old_path = env::var_os("PATH").unwrap_or_default();
564 env::join_paths(iter::once(path).chain(env::split_paths(&old_path))).expect("")
567 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
568 pub struct RustdocTheme {
569 pub compiler: Compiler,
572 impl Step for RustdocTheme {
574 const DEFAULT: bool = true;
575 const ONLY_HOSTS: bool = true;
577 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
578 run.path("src/tools/rustdoc-themes")
581 fn make_run(run: RunConfig<'_>) {
582 let compiler = run.builder.compiler(run.builder.top_stage, run.host);
584 run.builder.ensure(RustdocTheme { compiler });
587 fn run(self, builder: &Builder<'_>) {
588 let rustdoc = builder.out.join("bootstrap/debug/rustdoc");
589 let mut cmd = builder.tool_cmd(Tool::RustdocTheme);
590 cmd.arg(rustdoc.to_str().unwrap())
591 .arg(builder.src.join("src/librustdoc/html/static/themes").to_str().unwrap())
592 .env("RUSTC_STAGE", self.compiler.stage.to_string())
593 .env("RUSTC_SYSROOT", builder.sysroot(self.compiler))
594 .env("RUSTDOC_LIBDIR", builder.sysroot_libdir(self.compiler, self.compiler.host))
595 .env("CFG_RELEASE_CHANNEL", &builder.config.channel)
596 .env("RUSTDOC_REAL", builder.rustdoc(self.compiler))
597 .env("RUSTDOC_CRATE_VERSION", builder.rust_version())
598 .env("RUSTC_BOOTSTRAP", "1");
599 if let Some(linker) = builder.linker(self.compiler.host) {
600 cmd.env("RUSTC_TARGET_LINKER", linker);
602 try_run(builder, &mut cmd);
606 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
607 pub struct RustdocJSStd {
608 pub host: Interned<String>,
609 pub target: Interned<String>,
612 impl Step for RustdocJSStd {
614 const DEFAULT: bool = true;
615 const ONLY_HOSTS: bool = true;
617 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
618 run.path("src/test/rustdoc-js-std")
621 fn make_run(run: RunConfig<'_>) {
622 run.builder.ensure(RustdocJSStd { host: run.host, target: run.target });
625 fn run(self, builder: &Builder<'_>) {
626 if let Some(ref nodejs) = builder.config.nodejs {
627 let mut command = Command::new(nodejs);
628 command.args(&["src/tools/rustdoc-js-std/tester.js", &*self.host]);
629 builder.ensure(crate::doc::Std { target: self.target, stage: builder.top_stage });
630 builder.run(&mut command);
632 builder.info("No nodejs found, skipping \"src/test/rustdoc-js-std\" tests");
637 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
638 pub struct RustdocJSNotStd {
639 pub host: Interned<String>,
640 pub target: Interned<String>,
641 pub compiler: Compiler,
644 impl Step for RustdocJSNotStd {
646 const DEFAULT: bool = true;
647 const ONLY_HOSTS: bool = true;
649 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
650 run.path("src/test/rustdoc-js")
653 fn make_run(run: RunConfig<'_>) {
654 let compiler = run.builder.compiler(run.builder.top_stage, run.host);
655 run.builder.ensure(RustdocJSNotStd { host: run.host, target: run.target, compiler });
658 fn run(self, builder: &Builder<'_>) {
659 if builder.config.nodejs.is_some() {
660 builder.ensure(Compiletest {
661 compiler: self.compiler,
669 builder.info("No nodejs found, skipping \"src/test/rustdoc-js\" tests");
674 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
675 pub struct RustdocUi {
676 pub host: Interned<String>,
677 pub target: Interned<String>,
678 pub compiler: Compiler,
681 impl Step for RustdocUi {
683 const DEFAULT: bool = true;
684 const ONLY_HOSTS: bool = true;
686 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
687 run.path("src/test/rustdoc-ui")
690 fn make_run(run: RunConfig<'_>) {
691 let compiler = run.builder.compiler(run.builder.top_stage, run.host);
692 run.builder.ensure(RustdocUi { host: run.host, target: run.target, compiler });
695 fn run(self, builder: &Builder<'_>) {
696 builder.ensure(Compiletest {
697 compiler: self.compiler,
701 path: Some("src/test/rustdoc-ui"),
707 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
712 const DEFAULT: bool = true;
713 const ONLY_HOSTS: bool = true;
715 /// Runs the `tidy` tool.
717 /// This tool in `src/tools` checks up on various bits and pieces of style and
718 /// otherwise just implements a few lint-like checks that are specific to the
721 /// Once tidy passes, this step also runs `fmt --check` if tests are being run
722 /// for the `dev` or `nightly` channels.
723 fn run(self, builder: &Builder<'_>) {
724 let mut cmd = builder.tool_cmd(Tool::Tidy);
725 cmd.arg(builder.src.join("src"));
726 cmd.arg(&builder.initial_cargo);
727 if !builder.config.vendor {
728 cmd.arg("--no-vendor");
730 if builder.is_verbose() {
731 cmd.arg("--verbose");
734 builder.info("tidy check");
735 try_run(builder, &mut cmd);
737 if builder.config.channel == "dev" || builder.config.channel == "nightly" {
738 builder.info("fmt check");
739 crate::format::format(&builder.build, !builder.config.cmd.bless());
743 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
744 run.path("src/tools/tidy")
747 fn make_run(run: RunConfig<'_>) {
748 run.builder.ensure(Tidy);
752 fn testdir(builder: &Builder<'_>, host: Interned<String>) -> PathBuf {
753 builder.out.join(host).join("test")
756 macro_rules! default_test {
757 ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr }) => {
758 test!($name { path: $path, mode: $mode, suite: $suite, default: true, host: false });
762 macro_rules! default_test_with_compare_mode {
763 ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr,
764 compare_mode: $compare_mode:expr }) => {
765 test_with_compare_mode!($name {
771 compare_mode: $compare_mode
776 macro_rules! host_test {
777 ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr }) => {
778 test!($name { path: $path, mode: $mode, suite: $suite, default: true, host: true });
783 ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr, default: $default:expr,
784 host: $host:expr }) => {
785 test_definitions!($name {
796 macro_rules! test_with_compare_mode {
797 ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr, default: $default:expr,
798 host: $host:expr, compare_mode: $compare_mode:expr }) => {
799 test_definitions!($name {
805 compare_mode: Some($compare_mode)
810 macro_rules! test_definitions {
815 default: $default:expr,
817 compare_mode: $compare_mode:expr
819 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
821 pub compiler: Compiler,
822 pub target: Interned<String>,
825 impl Step for $name {
827 const DEFAULT: bool = $default;
828 const ONLY_HOSTS: bool = $host;
830 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
831 run.suite_path($path)
834 fn make_run(run: RunConfig<'_>) {
835 let compiler = run.builder.compiler(run.builder.top_stage, run.host);
837 run.builder.ensure($name { compiler, target: run.target });
840 fn run(self, builder: &Builder<'_>) {
841 builder.ensure(Compiletest {
842 compiler: self.compiler,
847 compare_mode: $compare_mode,
854 default_test_with_compare_mode!(Ui {
861 default_test!(CompileFail {
862 path: "src/test/compile-fail",
863 mode: "compile-fail",
864 suite: "compile-fail"
867 default_test!(RunFail { path: "src/test/run-fail", mode: "run-fail", suite: "run-fail" });
869 default_test!(RunPassValgrind {
870 path: "src/test/run-pass-valgrind",
871 mode: "run-pass-valgrind",
872 suite: "run-pass-valgrind"
875 default_test!(MirOpt { path: "src/test/mir-opt", mode: "mir-opt", suite: "mir-opt" });
877 default_test!(Codegen { path: "src/test/codegen", mode: "codegen", suite: "codegen" });
879 default_test!(CodegenUnits {
880 path: "src/test/codegen-units",
881 mode: "codegen-units",
882 suite: "codegen-units"
885 default_test!(Incremental {
886 path: "src/test/incremental",
891 default_test!(Debuginfo { path: "src/test/debuginfo", mode: "debuginfo", suite: "debuginfo" });
893 host_test!(UiFullDeps { path: "src/test/ui-fulldeps", mode: "ui", suite: "ui-fulldeps" });
895 host_test!(Rustdoc { path: "src/test/rustdoc", mode: "rustdoc", suite: "rustdoc" });
897 host_test!(Pretty { path: "src/test/pretty", mode: "pretty", suite: "pretty" });
898 test!(RunFailPretty {
899 path: "src/test/run-fail/pretty",
905 test!(RunPassValgrindPretty {
906 path: "src/test/run-pass-valgrind/pretty",
908 suite: "run-pass-valgrind",
913 default_test!(RunMake { path: "src/test/run-make", mode: "run-make", suite: "run-make" });
915 host_test!(RunMakeFullDeps {
916 path: "src/test/run-make-fulldeps",
918 suite: "run-make-fulldeps"
921 default_test!(Assembly { path: "src/test/assembly", mode: "assembly", suite: "assembly" });
923 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
926 target: Interned<String>,
929 path: Option<&'static str>,
930 compare_mode: Option<&'static str>,
933 impl Step for Compiletest {
936 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
940 /// Executes the `compiletest` tool to run a suite of tests.
942 /// Compiles all tests with `compiler` for `target` with the specified
943 /// compiletest `mode` and `suite` arguments. For example `mode` can be
944 /// "run-pass" or `suite` can be something like `debuginfo`.
945 fn run(self, builder: &Builder<'_>) {
946 let compiler = self.compiler;
947 let target = self.target;
948 let mode = self.mode;
949 let suite = self.suite;
951 // Path for test suite
952 let suite_path = self.path.unwrap_or("");
954 // Skip codegen tests if they aren't enabled in configuration.
955 if !builder.config.codegen_tests && suite == "codegen" {
959 if suite == "debuginfo" {
961 .ensure(dist::DebuggerScripts { sysroot: builder.sysroot(compiler), host: target });
964 if suite.ends_with("fulldeps") {
965 builder.ensure(compile::Rustc { compiler, target });
968 builder.ensure(compile::Std { compiler, target });
969 // ensure that `libproc_macro` is available on the host.
970 builder.ensure(compile::Std { compiler, target: compiler.host });
972 // Also provide `rust_test_helpers` for the host.
973 builder.ensure(native::TestHelpers { target: compiler.host });
975 // As well as the target, except for plain wasm32, which can't build it
976 if !target.contains("wasm32") || target.contains("emscripten") {
977 builder.ensure(native::TestHelpers { target });
980 builder.ensure(RemoteCopyLibs { compiler, target });
982 let mut cmd = builder.tool_cmd(Tool::Compiletest);
984 // compiletest currently has... a lot of arguments, so let's just pass all
987 cmd.arg("--compile-lib-path").arg(builder.rustc_libdir(compiler));
988 cmd.arg("--run-lib-path").arg(builder.sysroot_libdir(compiler, target));
989 cmd.arg("--rustc-path").arg(builder.rustc(compiler));
991 let is_rustdoc = suite.ends_with("rustdoc-ui") || suite.ends_with("rustdoc-js");
993 // Avoid depending on rustdoc when we don't need it.
995 || (mode == "run-make" && suite.ends_with("fulldeps"))
996 || (mode == "ui" && is_rustdoc)
997 || mode == "js-doc-test"
999 cmd.arg("--rustdoc-path").arg(builder.rustdoc(compiler));
1002 cmd.arg("--src-base").arg(builder.src.join("src/test").join(suite));
1003 cmd.arg("--build-base").arg(testdir(builder, compiler.host).join(suite));
1004 cmd.arg("--stage-id").arg(format!("stage{}-{}", compiler.stage, target));
1005 cmd.arg("--mode").arg(mode);
1006 cmd.arg("--target").arg(target);
1007 cmd.arg("--host").arg(&*compiler.host);
1008 cmd.arg("--llvm-filecheck").arg(builder.llvm_filecheck(builder.config.build));
1010 if builder.config.cmd.bless() {
1015 builder.config.cmd.compare_mode().or_else(|| {
1016 if builder.config.test_compare_mode { self.compare_mode } else { None }
1019 if let Some(ref pass) = builder.config.cmd.pass() {
1024 if let Some(ref nodejs) = builder.config.nodejs {
1025 cmd.arg("--nodejs").arg(nodejs);
1028 let mut flags = if is_rustdoc { Vec::new() } else { vec!["-Crpath".to_string()] };
1030 if builder.config.rust_optimize_tests {
1031 flags.push("-O".to_string());
1034 flags.push(format!("-Cdebuginfo={}", builder.config.rust_debuginfo_level_tests));
1035 flags.push("-Zunstable-options".to_string());
1036 flags.push(builder.config.cmd.rustc_args().join(" "));
1038 if let Some(linker) = builder.linker(target) {
1039 cmd.arg("--linker").arg(linker);
1042 let mut hostflags = flags.clone();
1043 hostflags.push(format!("-Lnative={}", builder.test_helpers_out(compiler.host).display()));
1044 cmd.arg("--host-rustcflags").arg(hostflags.join(" "));
1046 let mut targetflags = flags;
1047 targetflags.push(format!("-Lnative={}", builder.test_helpers_out(target).display()));
1048 cmd.arg("--target-rustcflags").arg(targetflags.join(" "));
1050 cmd.arg("--docck-python").arg(builder.python());
1052 if builder.config.build.ends_with("apple-darwin") {
1053 // Force /usr/bin/python on macOS for LLDB tests because we're loading the
1054 // LLDB plugin's compiled module which only works with the system python
1055 // (namely not Homebrew-installed python)
1056 cmd.arg("--lldb-python").arg("/usr/bin/python");
1058 cmd.arg("--lldb-python").arg(builder.python());
1061 if let Some(ref gdb) = builder.config.gdb {
1062 cmd.arg("--gdb").arg(gdb);
1065 let run = |cmd: &mut Command| {
1066 cmd.output().map(|output| {
1067 String::from_utf8_lossy(&output.stdout)
1070 .unwrap_or_else(|| panic!("{:?} failed {:?}", cmd, output))
1074 let lldb_exe = if builder.config.lldb_enabled {
1075 // Test against the lldb that was just built.
1076 builder.llvm_out(target).join("bin").join("lldb")
1078 PathBuf::from("lldb")
1080 let lldb_version = Command::new(&lldb_exe)
1083 .map(|output| String::from_utf8_lossy(&output.stdout).to_string())
1085 if let Some(ref vers) = lldb_version {
1086 cmd.arg("--lldb-version").arg(vers);
1087 let lldb_python_dir = run(Command::new(&lldb_exe).arg("-P")).ok();
1088 if let Some(ref dir) = lldb_python_dir {
1089 cmd.arg("--lldb-python-dir").arg(dir);
1093 if util::forcing_clang_based_tests() {
1094 let clang_exe = builder.llvm_out(target).join("bin").join("clang");
1095 cmd.arg("--run-clang-based-tests-with").arg(clang_exe);
1098 // Get paths from cmd args
1099 let paths = match &builder.config.cmd {
1100 Subcommand::Test { ref paths, .. } => &paths[..],
1104 // Get test-args by striping suite path
1105 let mut test_args: Vec<&str> = paths
1107 .map(|p| match p.strip_prefix(".") {
1111 .filter(|p| p.starts_with(suite_path) && (p.is_dir() || p.is_file()))
1113 // Since test suite paths are themselves directories, if we don't
1114 // specify a directory or file, we'll get an empty string here
1115 // (the result of the test suite directory without its suite prefix).
1116 // Therefore, we need to filter these out, as only the first --test-args
1117 // flag is respected, so providing an empty --test-args conflicts with
1118 // any following it.
1119 match p.strip_prefix(suite_path).ok().and_then(|p| p.to_str()) {
1120 Some(s) if s != "" => Some(s),
1126 test_args.append(&mut builder.config.cmd.test_args());
1128 cmd.args(&test_args);
1130 if builder.is_verbose() {
1131 cmd.arg("--verbose");
1134 if !builder.config.verbose_tests {
1138 if builder.config.llvm_enabled() {
1139 let llvm_config = builder.ensure(native::Llvm { target: builder.config.build });
1140 if !builder.config.dry_run {
1141 let llvm_version = output(Command::new(&llvm_config).arg("--version"));
1142 cmd.arg("--llvm-version").arg(llvm_version);
1144 if !builder.is_rust_llvm(target) {
1145 cmd.arg("--system-llvm");
1148 // Only pass correct values for these flags for the `run-make` suite as it
1149 // requires that a C++ compiler was configured which isn't always the case.
1150 if !builder.config.dry_run && suite == "run-make-fulldeps" {
1151 let llvm_components = output(Command::new(&llvm_config).arg("--components"));
1152 let llvm_cxxflags = output(Command::new(&llvm_config).arg("--cxxflags"));
1154 .arg(builder.cc(target))
1156 .arg(builder.cxx(target).unwrap())
1158 .arg(builder.cflags(target, GitRepo::Rustc).join(" "))
1159 .arg("--llvm-components")
1160 .arg(llvm_components.trim())
1161 .arg("--llvm-cxxflags")
1162 .arg(llvm_cxxflags.trim());
1163 if let Some(ar) = builder.ar(target) {
1164 cmd.arg("--ar").arg(ar);
1167 // The llvm/bin directory contains many useful cross-platform
1168 // tools. Pass the path to run-make tests so they can use them.
1169 let llvm_bin_path = llvm_config
1171 .expect("Expected llvm-config to be contained in directory");
1172 assert!(llvm_bin_path.is_dir());
1173 cmd.arg("--llvm-bin-dir").arg(llvm_bin_path);
1175 // If LLD is available, add it to the PATH
1176 if builder.config.lld_enabled {
1177 let lld_install_root =
1178 builder.ensure(native::Lld { target: builder.config.build });
1180 let lld_bin_path = lld_install_root.join("bin");
1182 let old_path = env::var_os("PATH").unwrap_or_default();
1183 let new_path = env::join_paths(
1184 std::iter::once(lld_bin_path).chain(env::split_paths(&old_path)),
1186 .expect("Could not add LLD bin path to PATH");
1187 cmd.env("PATH", new_path);
1192 if suite != "run-make-fulldeps" {
1199 .arg("--llvm-components")
1201 .arg("--llvm-cxxflags")
1205 if builder.remote_tested(target) {
1206 cmd.arg("--remote-test-client").arg(builder.tool_exe(Tool::RemoteTestClient));
1209 // Running a C compiler on MSVC requires a few env vars to be set, to be
1210 // sure to set them here.
1212 // Note that if we encounter `PATH` we make sure to append to our own `PATH`
1213 // rather than stomp over it.
1214 if target.contains("msvc") {
1215 for &(ref k, ref v) in builder.cc[&target].env() {
1221 cmd.env("RUSTC_BOOTSTRAP", "1");
1222 builder.add_rust_test_threads(&mut cmd);
1224 if builder.config.sanitizers {
1225 cmd.env("RUSTC_SANITIZER_SUPPORT", "1");
1228 if builder.config.profiler {
1229 cmd.env("RUSTC_PROFILER_SUPPORT", "1");
1232 let tmp = builder.out.join("tmp");
1233 std::fs::create_dir_all(&tmp).unwrap();
1234 cmd.env("RUST_TEST_TMPDIR", tmp);
1236 cmd.arg("--adb-path").arg("adb");
1237 cmd.arg("--adb-test-dir").arg(ADB_TEST_DIR);
1238 if target.contains("android") {
1239 // Assume that cc for this target comes from the android sysroot
1240 cmd.arg("--android-cross-path")
1241 .arg(builder.cc(target).parent().unwrap().parent().unwrap());
1243 cmd.arg("--android-cross-path").arg("");
1246 if builder.config.cmd.rustfix_coverage() {
1247 cmd.arg("--rustfix-coverage");
1250 builder.ci_env.force_coloring_in_ci(&mut cmd);
1252 builder.info(&format!(
1253 "Check compiletest suite={} mode={} ({} -> {})",
1254 suite, mode, &compiler.host, target
1256 let _time = util::timeit(&builder);
1257 try_run(builder, &mut cmd);
1259 if let Some(compare_mode) = compare_mode {
1260 cmd.arg("--compare-mode").arg(compare_mode);
1261 builder.info(&format!(
1262 "Check compiletest suite={} mode={} compare_mode={} ({} -> {})",
1263 suite, mode, compare_mode, &compiler.host, target
1265 let _time = util::timeit(&builder);
1266 try_run(builder, &mut cmd);
1271 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1279 impl Step for DocTest {
1281 const ONLY_HOSTS: bool = true;
1283 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1287 /// Runs `rustdoc --test` for all documentation in `src/doc`.
1289 /// This will run all tests in our markdown documentation (e.g., the book)
1290 /// located in `src/doc`. The `rustdoc` that's run is the one that sits next to
1292 fn run(self, builder: &Builder<'_>) {
1293 let compiler = self.compiler;
1295 builder.ensure(compile::Std { compiler, target: compiler.host });
1297 // Do a breadth-first traversal of the `src/doc` directory and just run
1298 // tests for all files that end in `*.md`
1299 let mut stack = vec![builder.src.join(self.path)];
1300 let _time = util::timeit(&builder);
1302 let mut files = Vec::new();
1303 while let Some(p) = stack.pop() {
1305 stack.extend(t!(p.read_dir()).map(|p| t!(p).path()));
1309 if p.extension().and_then(|s| s.to_str()) != Some("md") {
1313 // The nostarch directory in the book is for no starch, and so isn't
1314 // guaranteed to builder. We don't care if it doesn't build, so skip it.
1315 if p.to_str().map_or(false, |p| p.contains("nostarch")) {
1324 let mut toolstate = ToolState::TestPass;
1326 if !markdown_test(builder, compiler, &file) {
1327 toolstate = ToolState::TestFail;
1330 if self.is_ext_doc {
1331 builder.save_toolstate(self.name, toolstate);
1336 macro_rules! test_book {
1337 ($($name:ident, $path:expr, $book_name:expr, default=$default:expr;)+) => {
1339 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1344 impl Step for $name {
1346 const DEFAULT: bool = $default;
1347 const ONLY_HOSTS: bool = true;
1349 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1353 fn make_run(run: RunConfig<'_>) {
1354 run.builder.ensure($name {
1355 compiler: run.builder.compiler(run.builder.top_stage, run.host),
1359 fn run(self, builder: &Builder<'_>) {
1360 builder.ensure(DocTest {
1361 compiler: self.compiler,
1364 is_ext_doc: !$default,
1373 Nomicon, "src/doc/nomicon", "nomicon", default=false;
1374 Reference, "src/doc/reference", "reference", default=false;
1375 RustdocBook, "src/doc/rustdoc", "rustdoc", default=true;
1376 RustcBook, "src/doc/rustc", "rustc", default=true;
1377 RustByExample, "src/doc/rust-by-example", "rust-by-example", default=false;
1378 EmbeddedBook, "src/doc/embedded-book", "embedded-book", default=false;
1379 TheBook, "src/doc/book", "book", default=false;
1380 UnstableBook, "src/doc/unstable-book", "unstable-book", default=true;
1381 EditionGuide, "src/doc/edition-guide", "edition-guide", default=false;
1384 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1385 pub struct ErrorIndex {
1389 impl Step for ErrorIndex {
1391 const DEFAULT: bool = true;
1392 const ONLY_HOSTS: bool = true;
1394 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1395 run.path("src/tools/error_index_generator")
1398 fn make_run(run: RunConfig<'_>) {
1400 .ensure(ErrorIndex { compiler: run.builder.compiler(run.builder.top_stage, run.host) });
1403 /// Runs the error index generator tool to execute the tests located in the error
1406 /// The `error_index_generator` tool lives in `src/tools` and is used to
1407 /// generate a markdown file from the error indexes of the code base which is
1408 /// then passed to `rustdoc --test`.
1409 fn run(self, builder: &Builder<'_>) {
1410 let compiler = self.compiler;
1412 builder.ensure(compile::Std { compiler, target: compiler.host });
1414 let dir = testdir(builder, compiler.host);
1415 t!(fs::create_dir_all(&dir));
1416 let output = dir.join("error-index.md");
1418 let mut tool = tool::ErrorIndex::command(
1420 builder.compiler(compiler.stage, builder.config.build),
1422 tool.arg("markdown").arg(&output).env("CFG_BUILD", &builder.config.build);
1424 builder.info(&format!("Testing error-index stage{}", compiler.stage));
1425 let _time = util::timeit(&builder);
1426 builder.run_quiet(&mut tool);
1427 markdown_test(builder, compiler, &output);
1431 fn markdown_test(builder: &Builder<'_>, compiler: Compiler, markdown: &Path) -> bool {
1432 match fs::read_to_string(markdown) {
1434 if !contents.contains("```") {
1441 builder.info(&format!("doc tests for: {}", markdown.display()));
1442 let mut cmd = builder.rustdoc_cmd(compiler);
1443 builder.add_rust_test_threads(&mut cmd);
1446 cmd.env("RUSTC_BOOTSTRAP", "1");
1448 let test_args = builder.config.cmd.test_args().join(" ");
1449 cmd.arg("--test-args").arg(test_args);
1451 if builder.config.verbose_tests {
1452 try_run(builder, &mut cmd)
1454 try_run_quiet(builder, &mut cmd)
1458 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1459 pub struct RustcGuide;
1461 impl Step for RustcGuide {
1463 const DEFAULT: bool = false;
1464 const ONLY_HOSTS: bool = true;
1466 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1467 run.path("src/doc/rustc-guide")
1470 fn make_run(run: RunConfig<'_>) {
1471 run.builder.ensure(RustcGuide);
1474 fn run(self, builder: &Builder<'_>) {
1475 let src = builder.src.join("src/doc/rustc-guide");
1476 let mut rustbook_cmd = builder.tool_cmd(Tool::Rustbook);
1477 let toolstate = if try_run(builder, rustbook_cmd.arg("linkcheck").arg(&src)) {
1482 builder.save_toolstate("rustc-guide", toolstate);
1486 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1487 pub struct CrateLibrustc {
1489 target: Interned<String>,
1490 test_kind: TestKind,
1491 krate: Interned<String>,
1494 impl Step for CrateLibrustc {
1496 const DEFAULT: bool = true;
1497 const ONLY_HOSTS: bool = true;
1499 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1500 run.krate("rustc-main")
1503 fn make_run(run: RunConfig<'_>) {
1504 let builder = run.builder;
1505 let compiler = builder.compiler(builder.top_stage, run.host);
1507 for krate in builder.in_tree_crates("rustc-main") {
1508 if run.path.ends_with(&krate.path) {
1509 let test_kind = builder.kind.into();
1511 builder.ensure(CrateLibrustc {
1521 fn run(self, builder: &Builder<'_>) {
1522 builder.ensure(Crate {
1523 compiler: self.compiler,
1524 target: self.target,
1526 test_kind: self.test_kind,
1532 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1533 pub struct CrateNotDefault {
1535 target: Interned<String>,
1536 test_kind: TestKind,
1537 krate: &'static str,
1540 impl Step for CrateNotDefault {
1543 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1544 run.path("src/librustc_asan")
1545 .path("src/librustc_lsan")
1546 .path("src/librustc_msan")
1547 .path("src/librustc_tsan")
1550 fn make_run(run: RunConfig<'_>) {
1551 let builder = run.builder;
1552 let compiler = builder.compiler(builder.top_stage, run.host);
1554 let test_kind = builder.kind.into();
1556 builder.ensure(CrateNotDefault {
1560 krate: match run.path {
1561 _ if run.path.ends_with("src/librustc_asan") => "rustc_asan",
1562 _ if run.path.ends_with("src/librustc_lsan") => "rustc_lsan",
1563 _ if run.path.ends_with("src/librustc_msan") => "rustc_msan",
1564 _ if run.path.ends_with("src/librustc_tsan") => "rustc_tsan",
1565 _ => panic!("unexpected path {:?}", run.path),
1570 fn run(self, builder: &Builder<'_>) {
1571 builder.ensure(Crate {
1572 compiler: self.compiler,
1573 target: self.target,
1575 test_kind: self.test_kind,
1576 krate: INTERNER.intern_str(self.krate),
1581 #[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
1583 pub compiler: Compiler,
1584 pub target: Interned<String>,
1586 pub test_kind: TestKind,
1587 pub krate: Interned<String>,
1590 impl Step for Crate {
1592 const DEFAULT: bool = true;
1594 fn should_run(mut run: ShouldRun<'_>) -> ShouldRun<'_> {
1595 let builder = run.builder;
1596 for krate in run.builder.in_tree_crates("test") {
1597 if !(krate.name.starts_with("rustc_") && krate.name.ends_with("san")) {
1598 run = run.path(krate.local_path(&builder).to_str().unwrap());
1604 fn make_run(run: RunConfig<'_>) {
1605 let builder = run.builder;
1606 let compiler = builder.compiler(builder.top_stage, run.host);
1608 let make = |mode: Mode, krate: &CargoCrate| {
1609 let test_kind = builder.kind.into();
1611 builder.ensure(Crate {
1620 for krate in builder.in_tree_crates("test") {
1621 if run.path.ends_with(&krate.local_path(&builder)) {
1622 make(Mode::Std, krate);
1627 /// Runs all unit tests plus documentation tests for a given crate defined
1628 /// by a `Cargo.toml` (single manifest)
1630 /// This is what runs tests for crates like the standard library, compiler, etc.
1631 /// It essentially is the driver for running `cargo test`.
1633 /// Currently this runs all tests for a DAG by passing a bunch of `-p foo`
1634 /// arguments, and those arguments are discovered from `cargo metadata`.
1635 fn run(self, builder: &Builder<'_>) {
1636 let compiler = self.compiler;
1637 let target = self.target;
1638 let mode = self.mode;
1639 let test_kind = self.test_kind;
1640 let krate = self.krate;
1642 builder.ensure(compile::Std { compiler, target });
1643 builder.ensure(RemoteCopyLibs { compiler, target });
1645 // If we're not doing a full bootstrap but we're testing a stage2
1646 // version of libstd, then what we're actually testing is the libstd
1647 // produced in stage1. Reflect that here by updating the compiler that
1648 // we're working with automatically.
1649 let compiler = builder.compiler_for(compiler.stage, compiler.host, target);
1651 let mut cargo = builder.cargo(compiler, mode, target, test_kind.subcommand());
1654 compile::std_cargo(builder, target, &mut cargo);
1657 builder.ensure(compile::Rustc { compiler, target });
1658 compile::rustc_cargo(builder, &mut cargo, target);
1660 _ => panic!("can only test libraries"),
1663 // Build up the base `cargo test` command.
1665 // Pass in some standard flags then iterate over the graph we've discovered
1666 // in `cargo metadata` with the maps above and figure out what `-p`
1667 // arguments need to get passed.
1668 if test_kind.subcommand() == "test" && !builder.fail_fast {
1669 cargo.arg("--no-fail-fast");
1671 match builder.doc_tests {
1676 cargo.args(&["--lib", "--bins", "--examples", "--tests", "--benches"]);
1681 cargo.arg("-p").arg(krate);
1683 // The tests are going to run with the *target* libraries, so we need to
1684 // ensure that those libraries show up in the LD_LIBRARY_PATH equivalent.
1686 // Note that to run the compiler we need to run with the *host* libraries,
1687 // but our wrapper scripts arrange for that to be the case anyway.
1688 let mut dylib_path = dylib_path();
1689 dylib_path.insert(0, PathBuf::from(&*builder.sysroot_libdir(compiler, target)));
1690 cargo.env(dylib_path_var(), env::join_paths(&dylib_path).unwrap());
1693 cargo.args(&builder.config.cmd.test_args());
1695 if !builder.config.verbose_tests {
1696 cargo.arg("--quiet");
1699 if target.contains("emscripten") {
1701 format!("CARGO_TARGET_{}_RUNNER", envify(&target)),
1702 builder.config.nodejs.as_ref().expect("nodejs not configured"),
1704 } else if target.starts_with("wasm32") {
1705 let node = builder.config.nodejs.as_ref().expect("nodejs not configured");
1707 format!("{} {}/src/etc/wasm32-shim.js", node.display(), builder.src.display());
1708 cargo.env(format!("CARGO_TARGET_{}_RUNNER", envify(&target)), &runner);
1709 } else if builder.remote_tested(target) {
1711 format!("CARGO_TARGET_{}_RUNNER", envify(&target)),
1712 format!("{} run", builder.tool_exe(Tool::RemoteTestClient).display()),
1716 builder.info(&format!(
1717 "{} {} stage{} ({} -> {})",
1718 test_kind, krate, compiler.stage, &compiler.host, target
1720 let _time = util::timeit(&builder);
1721 try_run(builder, &mut cargo.into());
1725 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1726 pub struct CrateRustdoc {
1727 host: Interned<String>,
1728 test_kind: TestKind,
1731 impl Step for CrateRustdoc {
1733 const DEFAULT: bool = true;
1734 const ONLY_HOSTS: bool = true;
1736 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1737 run.paths(&["src/librustdoc", "src/tools/rustdoc"])
1740 fn make_run(run: RunConfig<'_>) {
1741 let builder = run.builder;
1743 let test_kind = builder.kind.into();
1745 builder.ensure(CrateRustdoc { host: run.host, test_kind });
1748 fn run(self, builder: &Builder<'_>) {
1749 let test_kind = self.test_kind;
1751 let compiler = builder.compiler(builder.top_stage, self.host);
1752 let target = compiler.host;
1753 builder.ensure(compile::Rustc { compiler, target });
1755 let mut cargo = tool::prepare_tool_cargo(
1760 test_kind.subcommand(),
1761 "src/tools/rustdoc",
1765 if test_kind.subcommand() == "test" && !builder.fail_fast {
1766 cargo.arg("--no-fail-fast");
1769 cargo.arg("-p").arg("rustdoc:0.0.0");
1772 cargo.args(&builder.config.cmd.test_args());
1774 if self.host.contains("musl") {
1775 cargo.arg("'-Ctarget-feature=-crt-static'");
1778 if !builder.config.verbose_tests {
1779 cargo.arg("--quiet");
1782 builder.info(&format!(
1783 "{} rustdoc stage{} ({} -> {})",
1784 test_kind, compiler.stage, &compiler.host, target
1786 let _time = util::timeit(&builder);
1788 try_run(builder, &mut cargo.into());
1792 /// Some test suites are run inside emulators or on remote devices, and most
1793 /// of our test binaries are linked dynamically which means we need to ship
1794 /// the standard library and such to the emulator ahead of time. This step
1795 /// represents this and is a dependency of all test suites.
1797 /// Most of the time this is a no-op. For some steps such as shipping data to
1798 /// QEMU we have to build our own tools so we've got conditional dependencies
1799 /// on those programs as well. Note that the remote test client is built for
1800 /// the build target (us) and the server is built for the target.
1801 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1802 pub struct RemoteCopyLibs {
1804 target: Interned<String>,
1807 impl Step for RemoteCopyLibs {
1810 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1814 fn run(self, builder: &Builder<'_>) {
1815 let compiler = self.compiler;
1816 let target = self.target;
1817 if !builder.remote_tested(target) {
1821 builder.ensure(compile::Std { compiler, target });
1823 builder.info(&format!("REMOTE copy libs to emulator ({})", target));
1824 t!(fs::create_dir_all(builder.out.join("tmp")));
1827 builder.ensure(tool::RemoteTestServer { compiler: compiler.with_stage(0), target });
1829 // Spawn the emulator and wait for it to come online
1830 let tool = builder.tool_exe(Tool::RemoteTestClient);
1831 let mut cmd = Command::new(&tool);
1832 cmd.arg("spawn-emulator").arg(target).arg(&server).arg(builder.out.join("tmp"));
1833 if let Some(rootfs) = builder.qemu_rootfs(target) {
1836 builder.run(&mut cmd);
1838 // Push all our dylibs to the emulator
1839 for f in t!(builder.sysroot_libdir(compiler, target).read_dir()) {
1841 let name = f.file_name().into_string().unwrap();
1842 if util::is_dylib(&name) {
1843 builder.run(Command::new(&tool).arg("push").arg(f.path()));
1849 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1850 pub struct Distcheck;
1852 impl Step for Distcheck {
1855 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1856 run.path("distcheck")
1859 fn make_run(run: RunConfig<'_>) {
1860 run.builder.ensure(Distcheck);
1863 /// Runs "distcheck", a 'make check' from a tarball
1864 fn run(self, builder: &Builder<'_>) {
1865 builder.info("Distcheck");
1866 let dir = builder.out.join("tmp").join("distcheck");
1867 let _ = fs::remove_dir_all(&dir);
1868 t!(fs::create_dir_all(&dir));
1870 // Guarantee that these are built before we begin running.
1871 builder.ensure(dist::PlainSourceTarball);
1872 builder.ensure(dist::Src);
1874 let mut cmd = Command::new("tar");
1876 .arg(builder.ensure(dist::PlainSourceTarball))
1877 .arg("--strip-components=1")
1879 builder.run(&mut cmd);
1881 Command::new("./configure")
1882 .args(&builder.config.configure_args)
1883 .arg("--enable-vendor")
1887 Command::new(build_helper::make(&builder.config.build)).arg("check").current_dir(&dir),
1890 // Now make sure that rust-src has all of libstd's dependencies
1891 builder.info("Distcheck rust-src");
1892 let dir = builder.out.join("tmp").join("distcheck-src");
1893 let _ = fs::remove_dir_all(&dir);
1894 t!(fs::create_dir_all(&dir));
1896 let mut cmd = Command::new("tar");
1898 .arg(builder.ensure(dist::Src))
1899 .arg("--strip-components=1")
1901 builder.run(&mut cmd);
1903 let toml = dir.join("rust-src/lib/rustlib/src/rust/src/libstd/Cargo.toml");
1905 Command::new(&builder.initial_cargo)
1906 .arg("generate-lockfile")
1907 .arg("--manifest-path")
1914 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1915 pub struct Bootstrap;
1917 impl Step for Bootstrap {
1919 const DEFAULT: bool = true;
1920 const ONLY_HOSTS: bool = true;
1922 /// Tests the build system itself.
1923 fn run(self, builder: &Builder<'_>) {
1924 let mut cmd = Command::new(&builder.initial_cargo);
1926 .current_dir(builder.src.join("src/bootstrap"))
1927 .env("RUSTFLAGS", "-Cdebuginfo=2")
1928 .env("CARGO_TARGET_DIR", builder.out.join("bootstrap"))
1929 .env("RUSTC_BOOTSTRAP", "1")
1930 .env("RUSTC", &builder.initial_rustc);
1931 if let Some(flags) = option_env!("RUSTFLAGS") {
1932 // Use the same rustc flags for testing as for "normal" compilation,
1933 // so that Cargo doesn’t recompile the entire dependency graph every time:
1934 // https://github.com/rust-lang/rust/issues/49215
1935 cmd.env("RUSTFLAGS", flags);
1937 if !builder.fail_fast {
1938 cmd.arg("--no-fail-fast");
1940 cmd.arg("--").args(&builder.config.cmd.test_args());
1941 // rustbuild tests are racy on directory creation so just run them one at a time.
1942 // Since there's not many this shouldn't be a problem.
1943 cmd.arg("--test-threads=1");
1944 try_run(builder, &mut cmd);
1947 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1948 run.path("src/bootstrap")
1951 fn make_run(run: RunConfig<'_>) {
1952 run.builder.ensure(Bootstrap);