1 // Copyright 2016 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
11 //! Implementation of the test-related targets of the build system.
13 //! This file implements the various regression test suites that we execute on
17 use std::ffi::OsString;
20 use std::fs::{self, File};
21 use std::path::{PathBuf, Path};
22 use std::process::Command;
25 use build_helper::{self, output};
27 use builder::{Kind, RunConfig, ShouldRun, Builder, Compiler, Step};
28 use Crate as CargoCrate;
29 use cache::{INTERNER, Interned};
33 use tool::{self, Tool};
34 use util::{self, dylib_path, dylib_path_var};
36 use toolstate::ToolState;
38 const ADB_TEST_DIR: &str = "/data/tmp/work";
40 /// The two modes of the test runner; tests or benchmarks.
41 #[derive(Debug, PartialEq, Eq, Hash, Copy, Clone)]
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(build: &Build, cmd: &mut Command) -> bool {
70 if !build.try_run(cmd) {
71 let mut failures = build.delayed_failures.borrow_mut();
72 failures.push(format!("{:?}", cmd));
81 fn try_run_quiet(build: &Build, cmd: &mut Command) {
83 if !build.try_run_quiet(cmd) {
84 let mut failures = build.delayed_failures.borrow_mut();
85 failures.push(format!("{:?}", cmd));
92 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
93 pub struct Linkcheck {
94 host: Interned<String>,
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 build = builder.build;
108 let host = self.host;
110 println!("Linkcheck ({})", host);
112 builder.default_doc(None);
114 let _time = util::timeit();
115 try_run(build, builder.tool_cmd(Tool::Linkchecker)
116 .arg(build.out.join(host).join("doc")));
119 fn should_run(run: ShouldRun) -> ShouldRun {
120 let builder = run.builder;
121 run.path("src/tools/linkchecker").default_condition(builder.build.config.docs)
124 fn make_run(run: RunConfig) {
125 run.builder.ensure(Linkcheck { host: run.target });
129 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
130 pub struct Cargotest {
132 host: Interned<String>,
135 impl Step for Cargotest {
137 const ONLY_HOSTS: bool = true;
139 fn should_run(run: ShouldRun) -> ShouldRun {
140 run.path("src/tools/cargotest")
143 fn make_run(run: RunConfig) {
144 run.builder.ensure(Cargotest {
145 stage: run.builder.top_stage,
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 build = builder.build;
156 let compiler = builder.compiler(self.stage, self.host);
157 builder.ensure(compile::Rustc { compiler, target: compiler.host });
159 // Note that this is a short, cryptic, and not scoped directory name. This
160 // is currently to minimize the length of path on Windows where we otherwise
161 // quickly run into path name limit constraints.
162 let out_dir = build.out.join("ct");
163 t!(fs::create_dir_all(&out_dir));
165 let _time = util::timeit();
166 let mut cmd = builder.tool_cmd(Tool::CargoTest);
167 try_run(build, cmd.arg(&build.initial_cargo)
169 .env("RUSTC", builder.rustc(compiler))
170 .env("RUSTDOC", builder.rustdoc(compiler.host)));
174 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
177 host: Interned<String>,
180 impl Step for Cargo {
182 const ONLY_HOSTS: bool = true;
184 fn should_run(run: ShouldRun) -> ShouldRun {
185 run.path("src/tools/cargo")
188 fn make_run(run: RunConfig) {
189 run.builder.ensure(Cargo {
190 stage: run.builder.top_stage,
195 /// Runs `cargo test` for `cargo` packaged with Rust.
196 fn run(self, builder: &Builder) {
197 let build = builder.build;
198 let compiler = builder.compiler(self.stage, self.host);
200 builder.ensure(tool::Cargo { compiler, target: self.host });
201 let mut cargo = builder.cargo(compiler, Mode::Tool, self.host, "test");
202 cargo.arg("--manifest-path").arg(build.src.join("src/tools/cargo/Cargo.toml"));
203 if !build.fail_fast {
204 cargo.arg("--no-fail-fast");
207 // Don't build tests dynamically, just a pain to work with
208 cargo.env("RUSTC_NO_PREFER_DYNAMIC", "1");
210 // Don't run cross-compile tests, we may not have cross-compiled libstd libs
212 cargo.env("CFG_DISABLE_CROSS_TESTS", "1");
214 try_run(build, cargo.env("PATH", &path_for_cargo(builder, compiler)));
218 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
221 host: Interned<String>,
226 const ONLY_HOSTS: bool = true;
228 fn should_run(run: ShouldRun) -> ShouldRun {
229 run.path("src/tools/rls")
232 fn make_run(run: RunConfig) {
233 run.builder.ensure(Rls {
234 stage: run.builder.top_stage,
239 /// Runs `cargo test` for the rls.
240 fn run(self, builder: &Builder) {
241 let build = builder.build;
242 let stage = self.stage;
243 let host = self.host;
244 let compiler = builder.compiler(stage, host);
246 builder.ensure(tool::Rls { compiler, target: self.host });
247 let mut cargo = tool::prepare_tool_cargo(builder,
253 // Don't build tests dynamically, just a pain to work with
254 cargo.env("RUSTC_NO_PREFER_DYNAMIC", "1");
256 builder.add_rustc_lib_path(compiler, &mut cargo);
258 if try_run(build, &mut cargo) {
259 build.save_toolstate("rls", ToolState::TestPass);
264 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
267 host: Interned<String>,
270 impl Step for Rustfmt {
272 const ONLY_HOSTS: bool = true;
274 fn should_run(run: ShouldRun) -> ShouldRun {
275 run.path("src/tools/rustfmt")
278 fn make_run(run: RunConfig) {
279 run.builder.ensure(Rustfmt {
280 stage: run.builder.top_stage,
285 /// Runs `cargo test` for rustfmt.
286 fn run(self, builder: &Builder) {
287 let build = builder.build;
288 let stage = self.stage;
289 let host = self.host;
290 let compiler = builder.compiler(stage, host);
292 builder.ensure(tool::Rustfmt { compiler, target: self.host });
293 let mut cargo = tool::prepare_tool_cargo(builder,
297 "src/tools/rustfmt");
299 // Don't build tests dynamically, just a pain to work with
300 cargo.env("RUSTC_NO_PREFER_DYNAMIC", "1");
302 builder.add_rustc_lib_path(compiler, &mut cargo);
304 if try_run(build, &mut cargo) {
305 build.save_toolstate("rustfmt", ToolState::TestPass);
310 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
313 host: Interned<String>,
318 const ONLY_HOSTS: bool = true;
319 const DEFAULT: bool = true;
321 fn should_run(run: ShouldRun) -> ShouldRun {
322 let test_miri = run.builder.build.config.test_miri;
323 run.path("src/tools/miri").default_condition(test_miri)
326 fn make_run(run: RunConfig) {
327 run.builder.ensure(Miri {
328 stage: run.builder.top_stage,
333 /// Runs `cargo test` for miri.
334 fn run(self, builder: &Builder) {
335 let build = builder.build;
336 let stage = self.stage;
337 let host = self.host;
338 let compiler = builder.compiler(stage, host);
340 if let Some(miri) = builder.ensure(tool::Miri { compiler, target: self.host }) {
341 let mut cargo = builder.cargo(compiler, Mode::Tool, host, "test");
342 cargo.arg("--manifest-path").arg(build.src.join("src/tools/miri/Cargo.toml"));
344 // Don't build tests dynamically, just a pain to work with
345 cargo.env("RUSTC_NO_PREFER_DYNAMIC", "1");
346 // miri tests need to know about the stage sysroot
347 cargo.env("MIRI_SYSROOT", builder.sysroot(compiler));
348 cargo.env("RUSTC_TEST_SUITE", builder.rustc(compiler));
349 cargo.env("RUSTC_LIB_PATH", builder.rustc_libdir(compiler));
350 cargo.env("MIRI_PATH", miri);
352 builder.add_rustc_lib_path(compiler, &mut cargo);
354 if try_run(build, &mut cargo) {
355 build.save_toolstate("miri", ToolState::TestPass);
358 eprintln!("failed to test miri: could not build");
363 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
366 host: Interned<String>,
369 impl Step for Clippy {
371 const ONLY_HOSTS: bool = true;
372 const DEFAULT: bool = false;
374 fn should_run(run: ShouldRun) -> ShouldRun {
375 run.path("src/tools/clippy")
378 fn make_run(run: RunConfig) {
379 run.builder.ensure(Clippy {
380 stage: run.builder.top_stage,
385 /// Runs `cargo test` for clippy.
386 fn run(self, builder: &Builder) {
387 let build = builder.build;
388 let stage = self.stage;
389 let host = self.host;
390 let compiler = builder.compiler(stage, host);
392 if let Some(clippy) = builder.ensure(tool::Clippy { compiler, target: self.host }) {
393 let mut cargo = builder.cargo(compiler, Mode::Tool, host, "test");
394 cargo.arg("--manifest-path").arg(build.src.join("src/tools/clippy/Cargo.toml"));
396 // Don't build tests dynamically, just a pain to work with
397 cargo.env("RUSTC_NO_PREFER_DYNAMIC", "1");
398 // clippy tests need to know about the stage sysroot
399 cargo.env("SYSROOT", builder.sysroot(compiler));
400 cargo.env("RUSTC_TEST_SUITE", builder.rustc(compiler));
401 cargo.env("RUSTC_LIB_PATH", builder.rustc_libdir(compiler));
402 let host_libs = builder.stage_out(compiler, Mode::Tool).join(builder.cargo_dir());
403 cargo.env("HOST_LIBS", host_libs);
404 // clippy tests need to find the driver
405 cargo.env("CLIPPY_DRIVER_PATH", clippy);
407 builder.add_rustc_lib_path(compiler, &mut cargo);
409 if try_run(build, &mut cargo) {
410 build.save_toolstate("clippy-driver", ToolState::TestPass);
413 eprintln!("failed to test clippy: could not build");
418 fn path_for_cargo(builder: &Builder, compiler: Compiler) -> OsString {
419 // Configure PATH to find the right rustc. NB. we have to use PATH
420 // and not RUSTC because the Cargo test suite has tests that will
421 // fail if rustc is not spelled `rustc`.
422 let path = builder.sysroot(compiler).join("bin");
423 let old_path = env::var_os("PATH").unwrap_or_default();
424 env::join_paths(iter::once(path).chain(env::split_paths(&old_path))).expect("")
427 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
428 pub struct RustdocTheme {
429 pub compiler: Compiler,
432 impl Step for RustdocTheme {
434 const DEFAULT: bool = true;
435 const ONLY_HOSTS: bool = true;
437 fn should_run(run: ShouldRun) -> ShouldRun {
438 run.path("src/tools/rustdoc-themes")
441 fn make_run(run: RunConfig) {
442 let compiler = run.builder.compiler(run.builder.top_stage, run.host);
444 run.builder.ensure(RustdocTheme {
449 fn run(self, builder: &Builder) {
450 let rustdoc = builder.rustdoc(self.compiler.host);
451 let mut cmd = builder.tool_cmd(Tool::RustdocTheme);
452 cmd.arg(rustdoc.to_str().unwrap())
453 .arg(builder.src.join("src/librustdoc/html/static/themes").to_str().unwrap())
454 .env("RUSTC_STAGE", self.compiler.stage.to_string())
455 .env("RUSTC_SYSROOT", builder.sysroot(self.compiler))
456 .env("RUSTDOC_LIBDIR", builder.sysroot_libdir(self.compiler, self.compiler.host))
457 .env("CFG_RELEASE_CHANNEL", &builder.build.config.channel)
458 .env("RUSTDOC_REAL", builder.rustdoc(self.compiler.host))
459 .env("RUSTDOC_CRATE_VERSION", builder.build.rust_version())
460 .env("RUSTC_BOOTSTRAP", "1");
461 if let Some(linker) = builder.build.linker(self.compiler.host) {
462 cmd.env("RUSTC_TARGET_LINKER", linker);
464 try_run(builder.build, &mut cmd);
468 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
469 pub struct RustdocJS {
470 pub host: Interned<String>,
471 pub target: Interned<String>,
474 impl Step for RustdocJS {
476 const DEFAULT: bool = true;
477 const ONLY_HOSTS: bool = true;
479 fn should_run(run: ShouldRun) -> ShouldRun {
480 run.path("src/test/rustdoc-js")
483 fn make_run(run: RunConfig) {
484 run.builder.ensure(RustdocJS {
490 fn run(self, builder: &Builder) {
491 if let Some(ref nodejs) = builder.config.nodejs {
492 let mut command = Command::new(nodejs);
493 command.args(&["src/tools/rustdoc-js/tester.js", &*self.host]);
494 builder.ensure(::doc::Std {
496 stage: builder.top_stage,
498 builder.run(&mut command);
500 println!("No nodejs found, skipping \"src/test/rustdoc-js\" tests");
505 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
507 host: Interned<String>,
512 const DEFAULT: bool = true;
513 const ONLY_HOSTS: bool = true;
514 const ONLY_BUILD: bool = true;
516 /// Runs the `tidy` tool as compiled in `stage` by the `host` compiler.
518 /// This tool in `src/tools` checks up on various bits and pieces of style and
519 /// otherwise just implements a few lint-like checks that are specific to the
521 fn run(self, builder: &Builder) {
522 let build = builder.build;
523 let host = self.host;
525 let _folder = build.fold_output(|| "tidy");
526 println!("tidy check ({})", host);
527 let mut cmd = builder.tool_cmd(Tool::Tidy);
528 cmd.arg(build.src.join("src"));
529 if !build.config.vendor {
530 cmd.arg("--no-vendor");
532 if build.config.quiet_tests {
535 try_run(build, &mut cmd);
538 fn should_run(run: ShouldRun) -> ShouldRun {
539 run.path("src/tools/tidy")
542 fn make_run(run: RunConfig) {
543 run.builder.ensure(Tidy {
544 host: run.builder.build.build,
549 fn testdir(build: &Build, host: Interned<String>) -> PathBuf {
550 build.out.join(host).join("test")
553 macro_rules! default_test {
554 ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr }) => {
555 test!($name { path: $path, mode: $mode, suite: $suite, default: true, host: false });
559 macro_rules! host_test {
560 ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr }) => {
561 test!($name { path: $path, mode: $mode, suite: $suite, default: true, host: true });
570 default: $default:expr,
573 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
575 pub compiler: Compiler,
576 pub target: Interned<String>,
579 impl Step for $name {
581 const DEFAULT: bool = $default;
582 const ONLY_HOSTS: bool = $host;
584 fn should_run(run: ShouldRun) -> ShouldRun {
588 fn make_run(run: RunConfig) {
589 let compiler = run.builder.compiler(run.builder.top_stage, run.host);
591 run.builder.ensure($name {
597 fn run(self, builder: &Builder) {
598 builder.ensure(Compiletest {
599 compiler: self.compiler,
615 default_test!(RunPass {
616 path: "src/test/run-pass",
621 default_test!(CompileFail {
622 path: "src/test/compile-fail",
623 mode: "compile-fail",
624 suite: "compile-fail"
627 default_test!(ParseFail {
628 path: "src/test/parse-fail",
633 default_test!(RunFail {
634 path: "src/test/run-fail",
639 default_test!(RunPassValgrind {
640 path: "src/test/run-pass-valgrind",
641 mode: "run-pass-valgrind",
642 suite: "run-pass-valgrind"
645 default_test!(MirOpt {
646 path: "src/test/mir-opt",
651 default_test!(Codegen {
652 path: "src/test/codegen",
657 default_test!(CodegenUnits {
658 path: "src/test/codegen-units",
659 mode: "codegen-units",
660 suite: "codegen-units"
663 default_test!(Incremental {
664 path: "src/test/incremental",
669 default_test!(Debuginfo {
670 path: "src/test/debuginfo",
671 // What this runs varies depending on the native platform being apple
672 mode: "debuginfo-XXX",
676 host_test!(UiFullDeps {
677 path: "src/test/ui-fulldeps",
682 host_test!(RunPassFullDeps {
683 path: "src/test/run-pass-fulldeps",
685 suite: "run-pass-fulldeps"
688 host_test!(RunFailFullDeps {
689 path: "src/test/run-fail-fulldeps",
691 suite: "run-fail-fulldeps"
694 host_test!(CompileFailFullDeps {
695 path: "src/test/compile-fail-fulldeps",
696 mode: "compile-fail",
697 suite: "compile-fail-fulldeps"
700 host_test!(IncrementalFullDeps {
701 path: "src/test/incremental-fulldeps",
703 suite: "incremental-fulldeps"
707 path: "src/test/rustdoc",
713 path: "src/test/pretty",
719 test!(RunPassPretty {
720 path: "src/test/run-pass/pretty",
726 test!(RunFailPretty {
727 path: "src/test/run-fail/pretty",
733 test!(RunPassValgrindPretty {
734 path: "src/test/run-pass-valgrind/pretty",
736 suite: "run-pass-valgrind",
740 test!(RunPassFullDepsPretty {
741 path: "src/test/run-pass-fulldeps/pretty",
743 suite: "run-pass-fulldeps",
747 test!(RunFailFullDepsPretty {
748 path: "src/test/run-fail-fulldeps/pretty",
750 suite: "run-fail-fulldeps",
756 path: "src/test/run-make",
761 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
764 target: Interned<String>,
769 impl Step for Compiletest {
772 fn should_run(run: ShouldRun) -> ShouldRun {
776 /// Executes the `compiletest` tool to run a suite of tests.
778 /// Compiles all tests with `compiler` for `target` with the specified
779 /// compiletest `mode` and `suite` arguments. For example `mode` can be
780 /// "run-pass" or `suite` can be something like `debuginfo`.
781 fn run(self, builder: &Builder) {
782 let build = builder.build;
783 let compiler = self.compiler;
784 let target = self.target;
785 let mode = self.mode;
786 let suite = self.suite;
788 // Skip codegen tests if they aren't enabled in configuration.
789 if !build.config.codegen_tests && suite == "codegen" {
793 if suite == "debuginfo" {
794 // Skip debuginfo tests on MSVC
795 if build.build.contains("msvc") {
799 if mode == "debuginfo-XXX" {
800 return if build.build.contains("apple") {
801 builder.ensure(Compiletest {
802 mode: "debuginfo-lldb",
806 builder.ensure(Compiletest {
807 mode: "debuginfo-gdb",
813 builder.ensure(dist::DebuggerScripts {
814 sysroot: builder.sysroot(compiler),
819 if suite.ends_with("fulldeps") ||
820 // FIXME: Does pretty need librustc compiled? Note that there are
821 // fulldeps test suites with mode = pretty as well.
825 builder.ensure(compile::Rustc { compiler, target });
828 builder.ensure(compile::Test { compiler, target });
829 builder.ensure(native::TestHelpers { target });
830 builder.ensure(RemoteCopyLibs { compiler, target });
832 let _folder = build.fold_output(|| format!("test_{}", suite));
833 println!("Check compiletest suite={} mode={} ({} -> {})",
834 suite, mode, &compiler.host, target);
835 let mut cmd = builder.tool_cmd(Tool::Compiletest);
837 // compiletest currently has... a lot of arguments, so let's just pass all
840 cmd.arg("--compile-lib-path").arg(builder.rustc_libdir(compiler));
841 cmd.arg("--run-lib-path").arg(builder.sysroot_libdir(compiler, target));
842 cmd.arg("--rustc-path").arg(builder.rustc(compiler));
844 // Avoid depending on rustdoc when we don't need it.
845 if mode == "rustdoc" || mode == "run-make" {
846 cmd.arg("--rustdoc-path").arg(builder.rustdoc(compiler.host));
849 cmd.arg("--src-base").arg(build.src.join("src/test").join(suite));
850 cmd.arg("--build-base").arg(testdir(build, compiler.host).join(suite));
851 cmd.arg("--stage-id").arg(format!("stage{}-{}", compiler.stage, target));
852 cmd.arg("--mode").arg(mode);
853 cmd.arg("--target").arg(target);
854 cmd.arg("--host").arg(&*compiler.host);
855 cmd.arg("--llvm-filecheck").arg(build.llvm_filecheck(build.build));
857 if let Some(ref nodejs) = build.config.nodejs {
858 cmd.arg("--nodejs").arg(nodejs);
861 let mut flags = vec!["-Crpath".to_string()];
862 if build.config.rust_optimize_tests {
863 flags.push("-O".to_string());
865 if build.config.rust_debuginfo_tests {
866 flags.push("-g".to_string());
868 flags.push("-Zmiri -Zunstable-options".to_string());
869 flags.push(build.config.cmd.rustc_args().join(" "));
871 if let Some(linker) = build.linker(target) {
872 cmd.arg("--linker").arg(linker);
875 let hostflags = flags.clone();
876 cmd.arg("--host-rustcflags").arg(hostflags.join(" "));
878 let mut targetflags = flags.clone();
879 targetflags.push(format!("-Lnative={}",
880 build.test_helpers_out(target).display()));
881 cmd.arg("--target-rustcflags").arg(targetflags.join(" "));
883 cmd.arg("--docck-python").arg(build.python());
885 if build.build.ends_with("apple-darwin") {
886 // Force /usr/bin/python on macOS for LLDB tests because we're loading the
887 // LLDB plugin's compiled module which only works with the system python
888 // (namely not Homebrew-installed python)
889 cmd.arg("--lldb-python").arg("/usr/bin/python");
891 cmd.arg("--lldb-python").arg(build.python());
894 if let Some(ref gdb) = build.config.gdb {
895 cmd.arg("--gdb").arg(gdb);
897 if let Some(ref vers) = build.lldb_version {
898 cmd.arg("--lldb-version").arg(vers);
900 if let Some(ref dir) = build.lldb_python_dir {
901 cmd.arg("--lldb-python-dir").arg(dir);
904 cmd.args(&build.config.cmd.test_args());
906 if build.is_verbose() {
907 cmd.arg("--verbose");
910 if build.config.quiet_tests {
914 if build.config.llvm_enabled {
915 let llvm_config = build.llvm_config(target);
916 let llvm_version = output(Command::new(&llvm_config).arg("--version"));
917 cmd.arg("--llvm-version").arg(llvm_version);
918 if !build.is_rust_llvm(target) {
919 cmd.arg("--system-llvm");
922 // Only pass correct values for these flags for the `run-make` suite as it
923 // requires that a C++ compiler was configured which isn't always the case.
924 if suite == "run-make" {
925 let llvm_components = output(Command::new(&llvm_config).arg("--components"));
926 let llvm_cxxflags = output(Command::new(&llvm_config).arg("--cxxflags"));
927 cmd.arg("--cc").arg(build.cc(target))
928 .arg("--cxx").arg(build.cxx(target).unwrap())
929 .arg("--cflags").arg(build.cflags(target).join(" "))
930 .arg("--llvm-components").arg(llvm_components.trim())
931 .arg("--llvm-cxxflags").arg(llvm_cxxflags.trim());
932 if let Some(ar) = build.ar(target) {
933 cmd.arg("--ar").arg(ar);
937 if suite == "run-make" && !build.config.llvm_enabled {
938 println!("Ignoring run-make test suite as they generally don't work without LLVM");
942 if suite != "run-make" {
943 cmd.arg("--cc").arg("")
944 .arg("--cxx").arg("")
945 .arg("--cflags").arg("")
946 .arg("--llvm-components").arg("")
947 .arg("--llvm-cxxflags").arg("");
950 if build.remote_tested(target) {
951 cmd.arg("--remote-test-client").arg(builder.tool_exe(Tool::RemoteTestClient));
954 // Running a C compiler on MSVC requires a few env vars to be set, to be
955 // sure to set them here.
957 // Note that if we encounter `PATH` we make sure to append to our own `PATH`
958 // rather than stomp over it.
959 if target.contains("msvc") {
960 for &(ref k, ref v) in build.cc[&target].env() {
966 cmd.env("RUSTC_BOOTSTRAP", "1");
967 build.add_rust_test_threads(&mut cmd);
969 if build.config.sanitizers {
970 cmd.env("SANITIZER_SUPPORT", "1");
973 if build.config.profiler {
974 cmd.env("PROFILER_SUPPORT", "1");
977 cmd.env("RUST_TEST_TMPDIR", build.out.join("tmp"));
979 cmd.arg("--adb-path").arg("adb");
980 cmd.arg("--adb-test-dir").arg(ADB_TEST_DIR);
981 if target.contains("android") {
982 // Assume that cc for this target comes from the android sysroot
983 cmd.arg("--android-cross-path")
984 .arg(build.cc(target).parent().unwrap().parent().unwrap());
986 cmd.arg("--android-cross-path").arg("");
989 build.ci_env.force_coloring_in_ci(&mut cmd);
991 let _time = util::timeit();
992 try_run(build, &mut cmd);
996 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1001 impl Step for Docs {
1003 const DEFAULT: bool = true;
1004 const ONLY_HOSTS: bool = true;
1006 fn should_run(run: ShouldRun) -> ShouldRun {
1010 fn make_run(run: RunConfig) {
1011 run.builder.ensure(Docs {
1012 compiler: run.builder.compiler(run.builder.top_stage, run.host),
1016 /// Run `rustdoc --test` for all documentation in `src/doc`.
1018 /// This will run all tests in our markdown documentation (e.g. the book)
1019 /// located in `src/doc`. The `rustdoc` that's run is the one that sits next to
1021 fn run(self, builder: &Builder) {
1022 let build = builder.build;
1023 let compiler = self.compiler;
1025 builder.ensure(compile::Test { compiler, target: compiler.host });
1027 // Do a breadth-first traversal of the `src/doc` directory and just run
1028 // tests for all files that end in `*.md`
1029 let mut stack = vec![build.src.join("src/doc")];
1030 let _time = util::timeit();
1031 let _folder = build.fold_output(|| "test_docs");
1033 while let Some(p) = stack.pop() {
1035 stack.extend(t!(p.read_dir()).map(|p| t!(p).path()));
1039 if p.extension().and_then(|s| s.to_str()) != Some("md") {
1043 // The nostarch directory in the book is for no starch, and so isn't
1044 // guaranteed to build. We don't care if it doesn't build, so skip it.
1045 if p.to_str().map_or(false, |p| p.contains("nostarch")) {
1049 markdown_test(builder, compiler, &p);
1054 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1055 pub struct ErrorIndex {
1059 impl Step for ErrorIndex {
1061 const DEFAULT: bool = true;
1062 const ONLY_HOSTS: bool = true;
1064 fn should_run(run: ShouldRun) -> ShouldRun {
1065 run.path("src/tools/error_index_generator")
1068 fn make_run(run: RunConfig) {
1069 run.builder.ensure(ErrorIndex {
1070 compiler: run.builder.compiler(run.builder.top_stage, run.host),
1074 /// Run the error index generator tool to execute the tests located in the error
1077 /// The `error_index_generator` tool lives in `src/tools` and is used to
1078 /// generate a markdown file from the error indexes of the code base which is
1079 /// then passed to `rustdoc --test`.
1080 fn run(self, builder: &Builder) {
1081 let build = builder.build;
1082 let compiler = self.compiler;
1084 builder.ensure(compile::Std { compiler, target: compiler.host });
1086 let _folder = build.fold_output(|| "test_error_index");
1087 println!("Testing error-index stage{}", compiler.stage);
1089 let dir = testdir(build, compiler.host);
1090 t!(fs::create_dir_all(&dir));
1091 let output = dir.join("error-index.md");
1093 let _time = util::timeit();
1094 build.run(builder.tool_cmd(Tool::ErrorIndex)
1097 .env("CFG_BUILD", &build.build)
1098 .env("RUSTC_ERROR_METADATA_DST", build.extended_error_dir()));
1100 markdown_test(builder, compiler, &output);
1104 fn markdown_test(builder: &Builder, compiler: Compiler, markdown: &Path) {
1105 let build = builder.build;
1106 let mut file = t!(File::open(markdown));
1107 let mut contents = String::new();
1108 t!(file.read_to_string(&mut contents));
1109 if !contents.contains("```") {
1113 println!("doc tests for: {}", markdown.display());
1114 let mut cmd = builder.rustdoc_cmd(compiler.host);
1115 build.add_rust_test_threads(&mut cmd);
1118 cmd.env("RUSTC_BOOTSTRAP", "1");
1120 let test_args = build.config.cmd.test_args().join(" ");
1121 cmd.arg("--test-args").arg(test_args);
1123 if build.config.quiet_tests {
1124 try_run_quiet(build, &mut cmd);
1126 try_run(build, &mut cmd);
1130 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1131 pub struct CrateLibrustc {
1133 target: Interned<String>,
1134 test_kind: TestKind,
1135 krate: Interned<String>,
1138 impl Step for CrateLibrustc {
1140 const DEFAULT: bool = true;
1141 const ONLY_HOSTS: bool = true;
1143 fn should_run(run: ShouldRun) -> ShouldRun {
1144 run.krate("rustc-main")
1147 fn make_run(run: RunConfig) {
1148 let builder = run.builder;
1149 let compiler = builder.compiler(builder.top_stage, run.host);
1151 for krate in builder.in_tree_crates("rustc-main") {
1152 if run.path.ends_with(&krate.path) {
1153 let test_kind = if builder.kind == Kind::Test {
1155 } else if builder.kind == Kind::Bench {
1158 panic!("unexpected builder.kind in crate: {:?}", builder.kind);
1161 builder.ensure(CrateLibrustc {
1171 fn run(self, builder: &Builder) {
1172 builder.ensure(Crate {
1173 compiler: self.compiler,
1174 target: self.target,
1175 mode: Mode::Librustc,
1176 test_kind: self.test_kind,
1182 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1183 pub struct CrateNotDefault {
1185 target: Interned<String>,
1186 test_kind: TestKind,
1187 krate: &'static str,
1190 impl Step for CrateNotDefault {
1193 fn should_run(run: ShouldRun) -> ShouldRun {
1194 run.path("src/liballoc_jemalloc")
1195 .path("src/librustc_asan")
1196 .path("src/librustc_lsan")
1197 .path("src/librustc_msan")
1198 .path("src/librustc_tsan")
1201 fn make_run(run: RunConfig) {
1202 let builder = run.builder;
1203 let compiler = builder.compiler(builder.top_stage, run.host);
1205 let test_kind = if builder.kind == Kind::Test {
1207 } else if builder.kind == Kind::Bench {
1210 panic!("unexpected builder.kind in crate: {:?}", builder.kind);
1213 builder.ensure(CrateNotDefault {
1217 krate: match run.path {
1218 _ if run.path.ends_with("src/liballoc_jemalloc") => "alloc_jemalloc",
1219 _ if run.path.ends_with("src/librustc_asan") => "rustc_asan",
1220 _ if run.path.ends_with("src/librustc_lsan") => "rustc_lsan",
1221 _ if run.path.ends_with("src/librustc_msan") => "rustc_msan",
1222 _ if run.path.ends_with("src/librustc_tsan") => "rustc_tsan",
1223 _ => panic!("unexpected path {:?}", run.path),
1228 fn run(self, builder: &Builder) {
1229 builder.ensure(Crate {
1230 compiler: self.compiler,
1231 target: self.target,
1233 test_kind: self.test_kind,
1234 krate: INTERNER.intern_str(self.krate),
1240 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1243 target: Interned<String>,
1245 test_kind: TestKind,
1246 krate: Interned<String>,
1249 impl Step for Crate {
1251 const DEFAULT: bool = true;
1253 fn should_run(mut run: ShouldRun) -> ShouldRun {
1254 let builder = run.builder;
1255 run = run.krate("test");
1256 for krate in run.builder.in_tree_crates("std") {
1257 if krate.is_local(&run.builder) &&
1258 !krate.name.contains("jemalloc") &&
1259 !(krate.name.starts_with("rustc_") && krate.name.ends_with("san")) &&
1260 krate.name != "dlmalloc" {
1261 run = run.path(krate.local_path(&builder).to_str().unwrap());
1267 fn make_run(run: RunConfig) {
1268 let builder = run.builder;
1269 let compiler = builder.compiler(builder.top_stage, run.host);
1271 let make = |mode: Mode, krate: &CargoCrate| {
1272 let test_kind = if builder.kind == Kind::Test {
1274 } else if builder.kind == Kind::Bench {
1277 panic!("unexpected builder.kind in crate: {:?}", builder.kind);
1280 builder.ensure(Crate {
1289 for krate in builder.in_tree_crates("std") {
1290 if run.path.ends_with(&krate.local_path(&builder)) {
1291 make(Mode::Libstd, krate);
1294 for krate in builder.in_tree_crates("test") {
1295 if run.path.ends_with(&krate.local_path(&builder)) {
1296 make(Mode::Libtest, krate);
1301 /// Run all unit tests plus documentation tests for a given crate defined
1302 /// by a `Cargo.toml` (single manifest)
1304 /// This is what runs tests for crates like the standard library, compiler, etc.
1305 /// It essentially is the driver for running `cargo test`.
1307 /// Currently this runs all tests for a DAG by passing a bunch of `-p foo`
1308 /// arguments, and those arguments are discovered from `cargo metadata`.
1309 fn run(self, builder: &Builder) {
1310 let build = builder.build;
1311 let compiler = self.compiler;
1312 let target = self.target;
1313 let mode = self.mode;
1314 let test_kind = self.test_kind;
1315 let krate = self.krate;
1317 builder.ensure(compile::Test { compiler, target });
1318 builder.ensure(RemoteCopyLibs { compiler, target });
1320 // If we're not doing a full bootstrap but we're testing a stage2 version of
1321 // libstd, then what we're actually testing is the libstd produced in
1322 // stage1. Reflect that here by updating the compiler that we're working
1323 // with automatically.
1324 let compiler = if build.force_use_stage1(compiler, target) {
1325 builder.compiler(1, compiler.host)
1330 let mut cargo = builder.cargo(compiler, mode, target, test_kind.subcommand());
1333 compile::std_cargo(build, &compiler, target, &mut cargo);
1336 compile::test_cargo(build, &compiler, target, &mut cargo);
1339 builder.ensure(compile::Rustc { compiler, target });
1340 compile::rustc_cargo(build, &mut cargo);
1342 _ => panic!("can only test libraries"),
1344 let _folder = build.fold_output(|| {
1345 format!("{}_stage{}-{}", test_kind.subcommand(), compiler.stage, krate)
1347 println!("{} {} stage{} ({} -> {})", test_kind, krate, compiler.stage,
1348 &compiler.host, target);
1350 // Build up the base `cargo test` command.
1352 // Pass in some standard flags then iterate over the graph we've discovered
1353 // in `cargo metadata` with the maps above and figure out what `-p`
1354 // arguments need to get passed.
1355 if test_kind.subcommand() == "test" && !build.fail_fast {
1356 cargo.arg("--no-fail-fast");
1358 if build.doc_tests {
1362 cargo.arg("-p").arg(krate);
1364 // The tests are going to run with the *target* libraries, so we need to
1365 // ensure that those libraries show up in the LD_LIBRARY_PATH equivalent.
1367 // Note that to run the compiler we need to run with the *host* libraries,
1368 // but our wrapper scripts arrange for that to be the case anyway.
1369 let mut dylib_path = dylib_path();
1370 dylib_path.insert(0, PathBuf::from(&*builder.sysroot_libdir(compiler, target)));
1371 cargo.env(dylib_path_var(), env::join_paths(&dylib_path).unwrap());
1374 cargo.args(&build.config.cmd.test_args());
1376 if build.config.quiet_tests {
1377 cargo.arg("--quiet");
1380 let _time = util::timeit();
1382 if target.contains("emscripten") {
1383 cargo.env(format!("CARGO_TARGET_{}_RUNNER", envify(&target)),
1384 build.config.nodejs.as_ref().expect("nodejs not configured"));
1385 } else if target.starts_with("wasm32") {
1386 // Warn about running tests without the `wasm_syscall` feature enabled.
1387 // The javascript shim implements the syscall interface so that test
1388 // output can be correctly reported.
1389 if !build.config.wasm_syscall {
1390 println!("Libstd was built without `wasm_syscall` feature enabled: \
1391 test output may not be visible.");
1394 // On the wasm32-unknown-unknown target we're using LTO which is
1395 // incompatible with `-C prefer-dynamic`, so disable that here
1396 cargo.env("RUSTC_NO_PREFER_DYNAMIC", "1");
1398 let node = build.config.nodejs.as_ref()
1399 .expect("nodejs not configured");
1400 let runner = format!("{} {}/src/etc/wasm32-shim.js",
1402 build.src.display());
1403 cargo.env(format!("CARGO_TARGET_{}_RUNNER", envify(&target)), &runner);
1404 } else if build.remote_tested(target) {
1405 cargo.env(format!("CARGO_TARGET_{}_RUNNER", envify(&target)),
1407 builder.tool_exe(Tool::RemoteTestClient).display()));
1409 try_run(build, &mut cargo);
1413 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1414 pub struct CrateRustdoc {
1415 host: Interned<String>,
1416 test_kind: TestKind,
1419 impl Step for CrateRustdoc {
1421 const DEFAULT: bool = true;
1422 const ONLY_HOSTS: bool = true;
1424 fn should_run(run: ShouldRun) -> ShouldRun {
1425 run.paths(&["src/librustdoc", "src/tools/rustdoc"])
1428 fn make_run(run: RunConfig) {
1429 let builder = run.builder;
1431 let test_kind = if builder.kind == Kind::Test {
1433 } else if builder.kind == Kind::Bench {
1436 panic!("unexpected builder.kind in crate: {:?}", builder.kind);
1439 builder.ensure(CrateRustdoc {
1445 fn run(self, builder: &Builder) {
1446 let build = builder.build;
1447 let test_kind = self.test_kind;
1449 let compiler = builder.compiler(builder.top_stage, self.host);
1450 let target = compiler.host;
1452 let mut cargo = tool::prepare_tool_cargo(builder,
1455 test_kind.subcommand(),
1456 "src/tools/rustdoc");
1457 let _folder = build.fold_output(|| {
1458 format!("{}_stage{}-rustdoc", test_kind.subcommand(), compiler.stage)
1460 println!("{} rustdoc stage{} ({} -> {})", test_kind, compiler.stage,
1461 &compiler.host, target);
1463 if test_kind.subcommand() == "test" && !build.fail_fast {
1464 cargo.arg("--no-fail-fast");
1467 cargo.arg("-p").arg("rustdoc:0.0.0");
1470 cargo.args(&build.config.cmd.test_args());
1472 if build.config.quiet_tests {
1473 cargo.arg("--quiet");
1476 let _time = util::timeit();
1478 try_run(build, &mut cargo);
1482 fn envify(s: &str) -> String {
1488 }).flat_map(|c| c.to_uppercase()).collect()
1491 /// Some test suites are run inside emulators or on remote devices, and most
1492 /// of our test binaries are linked dynamically which means we need to ship
1493 /// the standard library and such to the emulator ahead of time. This step
1494 /// represents this and is a dependency of all test suites.
1496 /// Most of the time this is a noop. For some steps such as shipping data to
1497 /// QEMU we have to build our own tools so we've got conditional dependencies
1498 /// on those programs as well. Note that the remote test client is built for
1499 /// the build target (us) and the server is built for the target.
1500 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1501 pub struct RemoteCopyLibs {
1503 target: Interned<String>,
1506 impl Step for RemoteCopyLibs {
1509 fn should_run(run: ShouldRun) -> ShouldRun {
1513 fn run(self, builder: &Builder) {
1514 let build = builder.build;
1515 let compiler = self.compiler;
1516 let target = self.target;
1517 if !build.remote_tested(target) {
1521 builder.ensure(compile::Test { compiler, target });
1523 println!("REMOTE copy libs to emulator ({})", target);
1524 t!(fs::create_dir_all(build.out.join("tmp")));
1526 let server = builder.ensure(tool::RemoteTestServer { compiler, target });
1528 // Spawn the emulator and wait for it to come online
1529 let tool = builder.tool_exe(Tool::RemoteTestClient);
1530 let mut cmd = Command::new(&tool);
1531 cmd.arg("spawn-emulator")
1534 .arg(build.out.join("tmp"));
1535 if let Some(rootfs) = build.qemu_rootfs(target) {
1538 build.run(&mut cmd);
1540 // Push all our dylibs to the emulator
1541 for f in t!(builder.sysroot_libdir(compiler, target).read_dir()) {
1543 let name = f.file_name().into_string().unwrap();
1544 if util::is_dylib(&name) {
1545 build.run(Command::new(&tool)
1553 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1554 pub struct Distcheck;
1556 impl Step for Distcheck {
1558 const ONLY_BUILD: bool = true;
1560 fn should_run(run: ShouldRun) -> ShouldRun {
1561 run.path("distcheck")
1564 fn make_run(run: RunConfig) {
1565 run.builder.ensure(Distcheck);
1568 /// Run "distcheck", a 'make check' from a tarball
1569 fn run(self, builder: &Builder) {
1570 let build = builder.build;
1572 println!("Distcheck");
1573 let dir = build.out.join("tmp").join("distcheck");
1574 let _ = fs::remove_dir_all(&dir);
1575 t!(fs::create_dir_all(&dir));
1577 // Guarantee that these are built before we begin running.
1578 builder.ensure(dist::PlainSourceTarball);
1579 builder.ensure(dist::Src);
1581 let mut cmd = Command::new("tar");
1583 .arg(builder.ensure(dist::PlainSourceTarball))
1584 .arg("--strip-components=1")
1586 build.run(&mut cmd);
1587 build.run(Command::new("./configure")
1588 .args(&build.config.configure_args)
1589 .arg("--enable-vendor")
1590 .current_dir(&dir));
1591 build.run(Command::new(build_helper::make(&build.build))
1593 .current_dir(&dir));
1595 // Now make sure that rust-src has all of libstd's dependencies
1596 println!("Distcheck rust-src");
1597 let dir = build.out.join("tmp").join("distcheck-src");
1598 let _ = fs::remove_dir_all(&dir);
1599 t!(fs::create_dir_all(&dir));
1601 let mut cmd = Command::new("tar");
1603 .arg(builder.ensure(dist::Src))
1604 .arg("--strip-components=1")
1606 build.run(&mut cmd);
1608 let toml = dir.join("rust-src/lib/rustlib/src/rust/src/libstd/Cargo.toml");
1609 build.run(Command::new(&build.initial_cargo)
1610 .arg("generate-lockfile")
1611 .arg("--manifest-path")
1613 .current_dir(&dir));
1617 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1618 pub struct Bootstrap;
1620 impl Step for Bootstrap {
1622 const DEFAULT: bool = true;
1623 const ONLY_HOSTS: bool = true;
1624 const ONLY_BUILD: bool = true;
1626 /// Test the build system itself
1627 fn run(self, builder: &Builder) {
1628 let build = builder.build;
1629 let mut cmd = Command::new(&build.initial_cargo);
1631 .current_dir(build.src.join("src/bootstrap"))
1632 .env("CARGO_TARGET_DIR", build.out.join("bootstrap"))
1633 .env("RUSTC_BOOTSTRAP", "1")
1634 .env("RUSTC", &build.initial_rustc);
1635 if !build.fail_fast {
1636 cmd.arg("--no-fail-fast");
1638 cmd.arg("--").args(&build.config.cmd.test_args());
1639 try_run(build, &mut cmd);
1642 fn should_run(run: ShouldRun) -> ShouldRun {
1643 run.path("src/bootstrap")
1646 fn make_run(run: RunConfig) {
1647 run.builder.ensure(Bootstrap);