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
16 use std::collections::HashSet;
18 use std::ffi::OsString;
21 use std::fs::{self, File};
22 use std::path::{PathBuf, Path};
23 use std::process::Command;
26 use build_helper::{self, output};
30 use util::{self, dylib_path, dylib_path_var};
34 use builder::{Kind, Builder, Compiler, Step};
37 const ADB_TEST_DIR: &str = "/data/tmp/work";
39 /// The two modes of the test runner; tests or benchmarks.
40 #[derive(Serialize, Copy, Clone)]
49 // Return the cargo subcommand for this test kind
50 fn subcommand(self) -> &'static str {
52 TestKind::Test => "test",
53 TestKind::Bench => "bench",
58 impl fmt::Display for TestKind {
59 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
60 f.write_str(match *self {
61 TestKind::Test => "Testing",
62 TestKind::Bench => "Benchmarking",
67 fn try_run(build: &Build, cmd: &mut Command) {
69 if !build.try_run(cmd) {
70 let failures = build.delayed_failures.get();
71 build.delayed_failures.set(failures + 1);
78 fn try_run_quiet(build: &Build, cmd: &mut Command) {
80 if !build.try_run_quiet(cmd) {
81 let failures = build.delayed_failures.get();
82 build.delayed_failures.set(failures + 1);
89 // rules.test("check-linkchecker", "src/tools/linkchecker")
90 // .dep(|s| s.name("tool-linkchecker").stage(0))
91 // .dep(|s| s.name("default:doc"))
92 // .default(build.config.docs)
94 // .run(move |s| check::linkcheck(build, s.target));
97 pub struct Linkcheck<'a> {
101 impl<'a> Step<'a> for Linkcheck<'a> {
103 const ONLY_HOSTS: bool = true;
104 const DEFAULT: bool = true;
106 /// Runs the `linkchecker` tool as compiled in `stage` by the `host` compiler.
108 /// This tool in `src/tools` will verify the validity of all our links in the
109 /// documentation to ensure we don't have a bunch of dead ones.
110 fn run(self, builder: &Builder) {
111 let build = builder.build;
112 let host = self.host;
114 println!("Linkcheck ({})", host);
116 builder.default_doc(None);
118 let _time = util::timeit();
119 try_run(build, builder.tool_cmd(Tool::Linkchecker)
120 .arg(build.out.join(host).join("doc")));
123 fn should_run(_builder: &Builder, path: &Path) -> bool {
124 path.ends_with("src/tools/linkchecker")
127 fn make_run(builder: &Builder, path: Option<&Path>, host: &str, _target: &str) {
129 builder.ensure(Linkcheck { host });
131 if builder.build.config.docs {
132 builder.ensure(Linkcheck { host });
138 // rules.test("check-cargotest", "src/tools/cargotest")
139 // .dep(|s| s.name("tool-cargotest").stage(0))
140 // .dep(|s| s.name("librustc"))
142 // .run(move |s| check::cargotest(build, s.stage, s.target));
145 pub struct Cargotest<'a> {
150 impl<'a> Step<'a> for Cargotest<'a> {
152 const ONLY_HOSTS: bool = true;
154 /// Runs the `cargotest` tool as compiled in `stage` by the `host` compiler.
156 /// This tool in `src/tools` will check out a few Rust projects and run `cargo
157 /// test` to ensure that we don't regress the test suites there.
158 fn run(self, builder: &Builder) {
159 let build = builder.build;
160 let compiler = builder.compiler(self.stage, self.host);
161 builder.ensure(compile::Rustc { compiler, target: compiler.host });
163 // Note that this is a short, cryptic, and not scoped directory name. This
164 // is currently to minimize the length of path on Windows where we otherwise
165 // quickly run into path name limit constraints.
166 let out_dir = build.out.join("ct");
167 t!(fs::create_dir_all(&out_dir));
169 let _time = util::timeit();
170 let mut cmd = builder.tool_cmd(Tool::CargoTest);
171 try_run(build, cmd.arg(&build.initial_cargo)
173 .env("RUSTC", builder.rustc(compiler))
174 .env("RUSTDOC", builder.rustdoc(compiler)));
178 //rules.test("check-cargo", "cargo")
179 // .dep(|s| s.name("tool-cargo"))
181 // .run(move |s| check::cargo(build, s.stage, s.target));
184 pub struct Cargo<'a> {
189 impl<'a> Step<'a> for Cargo<'a> {
191 const ONLY_HOSTS: bool = true;
193 fn should_run(_builder: &Builder, path: &Path) -> bool {
194 path.ends_with("cargo") // FIXME: Why is this not src/tools/cargo?
197 fn make_run(builder: &Builder, _path: Option<&Path>, _host: &str, target: &str) {
198 builder.ensure(Cargotest {
199 stage: builder.top_stage,
204 /// Runs `cargo test` for `cargo` packaged with Rust.
205 fn run(self, builder: &Builder) {
206 let build = builder.build;
207 let compiler = builder.compiler(self.stage, self.host);
209 // Configure PATH to find the right rustc. NB. we have to use PATH
210 // and not RUSTC because the Cargo test suite has tests that will
211 // fail if rustc is not spelled `rustc`.
212 let path = builder.sysroot(compiler).join("bin");
213 let old_path = env::var_os("PATH").unwrap_or_default();
214 let newpath = env::join_paths(
215 iter::once(path).chain(env::split_paths(&old_path))
218 let mut cargo = builder.cargo(compiler, Mode::Tool, self.host, "test");
219 cargo.arg("--manifest-path").arg(build.src.join("src/tools/cargo/Cargo.toml"));
220 if !build.fail_fast {
221 cargo.arg("--no-fail-fast");
224 let compiler = &Compiler::new(stage, host);
226 let mut cargo = build.cargo(compiler, Mode::Tool, host, "test");
227 cargo.arg("--manifest-path").arg(build.src.join("src/tools/cargo/Cargo.toml"));
228 if !build.fail_fast {
229 cargo.arg("--no-fail-fast");
232 // Don't build tests dynamically, just a pain to work with
233 cargo.env("RUSTC_NO_PREFER_DYNAMIC", "1");
235 // Don't run cross-compile tests, we may not have cross-compiled libstd libs
237 cargo.env("CFG_DISABLE_CROSS_TESTS", "1");
239 try_run(build, cargo.env("PATH", &path_for_cargo(build, compiler)));
249 impl<'a> Step<'a> for Rls<'a> {
252 /// Runs `cargo test` for the rls.
253 fn run(self, builder: &Builder) {
254 let build = builder.build;
255 let stage = self.stage;
256 let host = self.host;
257 let compiler = &Compiler::new(stage, host);
259 let mut cargo = build.cargo(compiler, Mode::Tool, host, "test");
260 cargo.arg("--manifest-path").arg(build.src.join("src/tools/rls/Cargo.toml"));
262 // Don't build tests dynamically, just a pain to work with
263 cargo.env("RUSTC_NO_PREFER_DYNAMIC", "1");
265 build.add_rustc_lib_path(compiler, &mut cargo);
267 try_run(build, &mut cargo);
271 fn path_for_cargo(build: &Build, compiler: &Compiler) -> OsString {
272 // Configure PATH to find the right rustc. NB. we have to use PATH
273 // and not RUSTC because the Cargo test suite has tests that will
274 // fail if rustc is not spelled `rustc`.
275 let path = build.sysroot(compiler).join("bin");
276 let old_path = env::var_os("PATH").unwrap_or_default();
277 env::join_paths(iter::once(path).chain(env::split_paths(&old_path))).expect("")
278 ||||||| parent of adabe3889e... Move code into Step trait implementations.
279 try_run(build, cargo.env("PATH", newpath));
281 try_run(build, cargo.env("PATH", newpath));
283 >>>>>>> adabe3889e... Move code into Step trait implementations.
286 //rules.test("check-tidy", "src/tools/tidy")
287 // .dep(|s| s.name("tool-tidy").stage(0))
291 // .run(move |s| check::tidy(build, s.target));
294 pub struct Tidy<'a> {
298 impl<'a> Step<'a> for Tidy<'a> {
300 const DEFAULT: bool = true;
301 const ONLY_HOSTS: bool = true;
302 const ONLY_BUILD: bool = true;
304 /// Runs the `tidy` tool as compiled in `stage` by the `host` compiler.
306 /// This tool in `src/tools` checks up on various bits and pieces of style and
307 /// otherwise just implements a few lint-like checks that are specific to the
309 fn run(self, builder: &Builder) {
310 let build = builder.build;
311 let host = self.host;
313 let _folder = build.fold_output(|| "tidy");
314 println!("tidy check ({})", host);
315 let mut cmd = builder.tool_cmd(Tool::Tidy);
316 cmd.arg(build.src.join("src"));
317 if !build.config.vendor {
318 cmd.arg("--no-vendor");
320 if build.config.quiet_tests {
323 try_run(build, &mut cmd);
326 fn should_run(_builder: &Builder, path: &Path) -> bool {
327 path.ends_with("src/tools/tidy")
330 fn make_run(builder: &Builder, _path: Option<&Path>, _host: &str, _target: &str) {
331 builder.ensure(Tidy {
332 host: &builder.build.build,
337 fn testdir(build: &Build, host: &str) -> PathBuf {
338 build.out.join(host).join("test")
341 // // ========================================================================
344 // // Various unit tests and tests suites we can run
346 // let mut suite = |name, path, mode, dir| {
347 // rules.test(name, path)
348 // .dep(|s| s.name("libtest"))
349 // .dep(|s| s.name("tool-compiletest").target(s.host).stage(0))
350 // .dep(|s| s.name("test-helpers"))
351 // .dep(|s| s.name("remote-copy-libs"))
352 // .default(mode != "pretty") // pretty tests don't run everywhere
354 // check::compiletest(build, &s.compiler(), s.target, mode, dir)
358 // suite("check-ui", "src/test/ui", "ui", "ui");
359 // suite("check-rpass", "src/test/run-pass", "run-pass", "run-pass");
360 // suite("check-cfail", "src/test/compile-fail", "compile-fail", "compile-fail");
361 // suite("check-pfail", "src/test/parse-fail", "parse-fail", "parse-fail");
362 // suite("check-rfail", "src/test/run-fail", "run-fail", "run-fail");
363 // suite("check-rpass-valgrind", "src/test/run-pass-valgrind",
364 // "run-pass-valgrind", "run-pass-valgrind");
365 // suite("check-mir-opt", "src/test/mir-opt", "mir-opt", "mir-opt");
366 // if build.config.codegen_tests {
367 // suite("check-codegen", "src/test/codegen", "codegen", "codegen");
369 // suite("check-codegen-units", "src/test/codegen-units", "codegen-units",
371 // suite("check-incremental", "src/test/incremental", "incremental",
375 // if build.build.contains("msvc") {
376 // // nothing to do for debuginfo tests
378 // rules.test("check-debuginfo-lldb", "src/test/debuginfo-lldb")
379 // .dep(|s| s.name("libtest"))
380 // .dep(|s| s.name("tool-compiletest").target(s.host).stage(0))
381 // .dep(|s| s.name("test-helpers"))
382 // .dep(|s| s.name("debugger-scripts"))
383 // .run(move |s| check::compiletest(build, &s.compiler(), s.target,
384 // "debuginfo-lldb", "debuginfo"));
385 // rules.test("check-debuginfo-gdb", "src/test/debuginfo-gdb")
386 // .dep(|s| s.name("libtest"))
387 // .dep(|s| s.name("tool-compiletest").target(s.host).stage(0))
388 // .dep(|s| s.name("test-helpers"))
389 // .dep(|s| s.name("debugger-scripts"))
390 // .dep(|s| s.name("remote-copy-libs"))
391 // .run(move |s| check::compiletest(build, &s.compiler(), s.target,
392 // "debuginfo-gdb", "debuginfo"));
393 // let mut rule = rules.test("check-debuginfo", "src/test/debuginfo");
394 // rule.default(true);
395 // if build.build.contains("apple") {
396 // rule.dep(|s| s.name("check-debuginfo-lldb"));
398 // rule.dep(|s| s.name("check-debuginfo-gdb"));
405 // let mut suite = |name, path, mode, dir| {
406 // rules.test(name, path)
407 // .dep(|s| s.name("librustc"))
408 // .dep(|s| s.name("test-helpers"))
409 // .dep(|s| s.name("tool-compiletest").target(s.host).stage(0))
410 // .default(mode != "pretty")
413 // check::compiletest(build, &s.compiler(), s.target, mode, dir)
417 // suite("check-ui-full", "src/test/ui-fulldeps", "ui", "ui-fulldeps");
418 // suite("check-rpass-full", "src/test/run-pass-fulldeps",
419 // "run-pass", "run-pass-fulldeps");
420 // suite("check-rfail-full", "src/test/run-fail-fulldeps",
421 // "run-fail", "run-fail-fulldeps");
422 // suite("check-cfail-full", "src/test/compile-fail-fulldeps",
423 // "compile-fail", "compile-fail-fulldeps");
424 // suite("check-rmake", "src/test/run-make", "run-make", "run-make");
425 // suite("check-rustdoc", "src/test/rustdoc", "rustdoc", "rustdoc");
426 // suite("check-pretty", "src/test/pretty", "pretty", "pretty");
427 // suite("check-pretty-rpass", "src/test/run-pass/pretty", "pretty",
429 // suite("check-pretty-rfail", "src/test/run-fail/pretty", "pretty",
431 // suite("check-pretty-valgrind", "src/test/run-pass-valgrind/pretty", "pretty",
432 // "run-pass-valgrind");
433 // suite("check-pretty-rpass-full", "src/test/run-pass-fulldeps/pretty",
434 // "pretty", "run-pass-fulldeps");
435 // suite("check-pretty-rfail-full", "src/test/run-fail-fulldeps/pretty",
436 // "pretty", "run-fail-fulldeps");
440 pub struct Compiletest<'a> {
441 compiler: Compiler<'a>,
447 #[derive(Copy, Clone, Debug)]
455 static COMPILETESTS: &[Test] = &[
456 Test { default: true, path: "src/test/codegen", mode: "codegen", suite: "codegen" },
459 path: "src/test/codegen-units",
460 mode: "codegen-units",
461 suite: "codegen-units",
465 path: "src/test/compile-fail",
466 mode: "compile-fail",
467 suite: "compile-fail",
469 Test { default: true, path: "src/test/incremental", mode: "incremental", suite: "incremental" },
470 Test { default: true, path: "src/test/mir-opt", mode: "mir-opt", suite: "mir-opt" },
471 Test { default: true, path: "src/test/parse-fail", mode: "parse-fail", suite: "parse-fail" },
472 Test { default: true, path: "src/test/run-fail", mode: "run-fail", suite: "run-fail" },
473 Test { default: true, path: "src/test/run-pass", mode: "run-pass", suite: "run-pass" },
476 path: "src/test/run-pass-valgrind",
477 mode: "run-pass-valgrind",
478 suite: "run-pass-valgrind"
480 Test { default: true, path: "src/test/ui", mode: "ui", suite: "ui" },
483 path: "src/test/debuginfo-lldb",
484 mode: "debuginfo-lldb",
489 path: "src/test/debuginfo-gdb",
490 mode: "debuginfo-gdb",
494 // FIXME: What this runs varies depending on the native platform being apple
495 Test { default: true, path: "src/test/debuginfo", mode: "debuginfo-XXX", suite: "debuginfo" },
497 Test { default: true, path: "src/test/ui-fulldeps", mode: "ui", suite: "ui-fulldeps" },
500 path: "src/test/run-pass-fulldeps",
502 suite: "run-pass-fulldeps",
506 path: "src/test/run-fail-fulldeps",
508 suite: "run-fail-fulldeps",
512 path: "src/test/compile-fail-fulldeps",
513 mode: "compile-fail",
514 suite: "compile-fail-fulldeps",
516 Test { default: true, path: "src/test/run-make", mode: "run-make", suite: "run-make" },
517 Test { default: true, path: "src/test/rustdoc", mode: "rustdoc", suite: "rustdoc" },
519 Test { default: false, path: "src/test/pretty", mode: "pretty", suite: "pretty" },
520 Test { default: false, path: "src/test/run-pass/pretty", mode: "pretty", suite: "run-pass" },
521 Test { default: false, path: "src/test/run-fail/pretty", mode: "pretty", suite: "run-fail" },
524 path: "src/test/run-pass-valgrind/pretty",
526 suite: "run-pass-valgrind"
530 path: "src/test/run-pass-fulldeps/pretty",
532 suite: "run-pass-fulldeps",
536 path: "src/test/run-fail-fulldeps/pretty",
538 suite: "run-fail-fulldeps",
543 impl<'a> Step<'a> for Compiletest<'a> {
545 const DEFAULT: bool = true;
547 fn should_run(_builder: &Builder, path: &Path) -> bool {
548 // Note that this is general, while a few more cases are skipped inside
549 // run() itself. This is to avoid duplication across should_run and
551 COMPILETESTS.iter().any(|&test| {
552 path.ends_with(test.path)
556 fn make_run(builder: &Builder, path: Option<&Path>, host: &str, target: &str) {
557 let compiler = builder.compiler(builder.top_stage, host);
559 let test = path.map(|path| {
560 COMPILETESTS.iter().find(|&&test| {
561 path.ends_with(test.path)
562 }).unwrap_or_else(|| {
563 panic!("make_run in compile test to receive test path, received {:?}", path);
567 if let Some(test) = test { // specific test
568 builder.ensure(Compiletest {
569 compiler, target, mode: test.mode, suite: test.suite
571 } else { // default tests
572 for test in COMPILETESTS {
574 builder.ensure(Compiletest {
585 /// Executes the `compiletest` tool to run a suite of tests.
587 /// Compiles all tests with `compiler` for `target` with the specified
588 /// compiletest `mode` and `suite` arguments. For example `mode` can be
589 /// "run-pass" or `suite` can be something like `debuginfo`.
590 fn run(self, builder: &Builder) {
591 let build = builder.build;
592 let compiler = self.compiler;
593 let target = self.target;
594 let mode = self.mode;
595 let suite = self.suite;
597 // Skip codegen tests if they aren't enabled in configuration.
598 if !build.config.codegen_tests && suite == "codegen" {
602 if suite == "debuginfo" {
603 if mode == "debuginfo-XXX" {
604 return if build.build.contains("apple") {
605 builder.ensure(Compiletest {
606 mode: "debuginfo-lldb",
610 builder.ensure(Compiletest {
611 mode: "debuginfo-gdb",
617 // Skip debuginfo tests on MSVC
618 if build.build.contains("msvc") {
622 builder.ensure(dist::DebuggerScripts {
623 sysroot: &builder.sysroot(compiler),
628 if suite.ends_with("fulldeps") ||
629 // FIXME: Does pretty need librustc compiled? Note that there are
630 // fulldeps test suites with mode = pretty as well.
634 builder.ensure(compile::Rustc { compiler, target });
637 builder.ensure(compile::Test { compiler, target });
638 builder.ensure(native::TestHelpers { target });
640 if mode == "debuginfo-gdb" {
641 builder.ensure(RemoteCopyLibs { compiler, target });
644 let _folder = build.fold_output(|| format!("test_{}", suite));
645 println!("Check compiletest suite={} mode={} ({} -> {})",
646 suite, mode, compiler.host, target);
647 let mut cmd = builder.tool_cmd(Tool::Compiletest);
649 // compiletest currently has... a lot of arguments, so let's just pass all
652 cmd.arg("--compile-lib-path").arg(builder.rustc_libdir(compiler));
653 cmd.arg("--run-lib-path").arg(builder.sysroot_libdir(compiler, target));
654 cmd.arg("--rustc-path").arg(builder.rustc(compiler));
655 cmd.arg("--rustdoc-path").arg(builder.rustdoc(compiler));
656 cmd.arg("--src-base").arg(build.src.join("src/test").join(suite));
657 cmd.arg("--build-base").arg(testdir(build, compiler.host).join(suite));
658 cmd.arg("--stage-id").arg(format!("stage{}-{}", compiler.stage, target));
659 cmd.arg("--mode").arg(mode);
660 cmd.arg("--target").arg(target);
661 cmd.arg("--host").arg(compiler.host);
662 cmd.arg("--llvm-filecheck").arg(build.llvm_filecheck(&build.build));
664 if let Some(ref nodejs) = build.config.nodejs {
665 cmd.arg("--nodejs").arg(nodejs);
668 let mut flags = vec!["-Crpath".to_string()];
669 if build.config.rust_optimize_tests {
670 flags.push("-O".to_string());
672 if build.config.rust_debuginfo_tests {
673 flags.push("-g".to_string());
676 let mut hostflags = build.rustc_flags(compiler.host);
677 hostflags.extend(flags.clone());
678 cmd.arg("--host-rustcflags").arg(hostflags.join(" "));
680 let mut targetflags = build.rustc_flags(&target);
681 targetflags.extend(flags);
682 targetflags.push(format!("-Lnative={}",
683 build.test_helpers_out(target).display()));
684 cmd.arg("--target-rustcflags").arg(targetflags.join(" "));
686 cmd.arg("--docck-python").arg(build.python());
688 if build.build.ends_with("apple-darwin") {
689 // Force /usr/bin/python on macOS for LLDB tests because we're loading the
690 // LLDB plugin's compiled module which only works with the system python
691 // (namely not Homebrew-installed python)
692 cmd.arg("--lldb-python").arg("/usr/bin/python");
694 cmd.arg("--lldb-python").arg(build.python());
697 if let Some(ref gdb) = build.config.gdb {
698 cmd.arg("--gdb").arg(gdb);
700 if let Some(ref vers) = build.lldb_version {
701 cmd.arg("--lldb-version").arg(vers);
703 if let Some(ref dir) = build.lldb_python_dir {
704 cmd.arg("--lldb-python-dir").arg(dir);
706 let llvm_config = build.llvm_config(target);
707 let llvm_version = output(Command::new(&llvm_config).arg("--version"));
708 cmd.arg("--llvm-version").arg(llvm_version);
709 if !build.is_rust_llvm(target) {
710 cmd.arg("--system-llvm");
713 cmd.args(&build.flags.cmd.test_args());
715 if build.is_verbose() {
716 cmd.arg("--verbose");
719 if build.config.quiet_tests {
723 // Only pass correct values for these flags for the `run-make` suite as it
724 // requires that a C++ compiler was configured which isn't always the case.
725 if suite == "run-make" {
726 let llvm_components = output(Command::new(&llvm_config).arg("--components"));
727 let llvm_cxxflags = output(Command::new(&llvm_config).arg("--cxxflags"));
728 cmd.arg("--cc").arg(build.cc(target))
729 .arg("--cxx").arg(build.cxx(target).unwrap())
730 .arg("--cflags").arg(build.cflags(target).join(" "))
731 .arg("--llvm-components").arg(llvm_components.trim())
732 .arg("--llvm-cxxflags").arg(llvm_cxxflags.trim());
734 cmd.arg("--cc").arg("")
735 .arg("--cxx").arg("")
736 .arg("--cflags").arg("")
737 .arg("--llvm-components").arg("")
738 .arg("--llvm-cxxflags").arg("");
741 if build.remote_tested(target) {
742 cmd.arg("--remote-test-client").arg(builder.tool_exe(Tool::RemoteTestClient));
745 // Running a C compiler on MSVC requires a few env vars to be set, to be
746 // sure to set them here.
748 // Note that if we encounter `PATH` we make sure to append to our own `PATH`
749 // rather than stomp over it.
750 if target.contains("msvc") {
751 for &(ref k, ref v) in build.cc[target].0.env() {
757 cmd.env("RUSTC_BOOTSTRAP", "1");
758 build.add_rust_test_threads(&mut cmd);
760 if build.config.sanitizers {
761 cmd.env("SANITIZER_SUPPORT", "1");
764 if build.config.profiler {
765 cmd.env("PROFILER_SUPPORT", "1");
768 cmd.arg("--adb-path").arg("adb");
769 cmd.arg("--adb-test-dir").arg(ADB_TEST_DIR);
770 if target.contains("android") {
771 // Assume that cc for this target comes from the android sysroot
772 cmd.arg("--android-cross-path")
773 .arg(build.cc(target).parent().unwrap().parent().unwrap());
775 cmd.arg("--android-cross-path").arg("");
778 build.ci_env.force_coloring_in_ci(&mut cmd);
780 let _time = util::timeit();
781 try_run(build, &mut cmd);
785 // rules.test("check-docs", "src/doc")
786 // .dep(|s| s.name("libtest"))
789 // .run(move |s| check::docs(build, &s.compiler()));
790 /// Run `rustdoc --test` for all documentation in `src/doc`.
792 /// This will run all tests in our markdown documentation (e.g. the book)
793 /// located in `src/doc`. The `rustdoc` that's run is the one that sits next to
795 pub fn docs(build: &Build, compiler: &Compiler) {
796 // Do a breadth-first traversal of the `src/doc` directory and just run
797 // tests for all files that end in `*.md`
798 let mut stack = vec![build.src.join("src/doc")];
799 let _time = util::timeit();
800 let _folder = build.fold_output(|| "test_docs");
802 while let Some(p) = stack.pop() {
804 stack.extend(t!(p.read_dir()).map(|p| t!(p).path()));
808 if p.extension().and_then(|s| s.to_str()) != Some("md") {
812 // The nostarch directory in the book is for no starch, and so isn't
813 // guaranteed to build. We don't care if it doesn't build, so skip it.
814 if p.to_str().map_or(false, |p| p.contains("nostarch")) {
818 markdown_test(build, compiler, &p);
822 //rules.test("check-error-index", "src/tools/error_index_generator")
823 // .dep(|s| s.name("libstd"))
824 // .dep(|s| s.name("tool-error-index").host(s.host).stage(0))
827 // .run(move |s| check::error_index(build, &s.compiler()));
830 pub struct ErrorIndex<'a> {
831 compiler: Compiler<'a>,
834 impl<'a> Step<'a> for ErrorIndex<'a> {
836 const DEFAULT: bool = true;
837 const ONLY_HOSTS: bool = true;
839 fn should_run(_builder: &Builder, path: &Path) -> bool {
840 path.ends_with("src/tools/error_index_generator")
843 fn make_run(builder: &Builder, _path: Option<&Path>, host: &str, _target: &str) {
844 builder.ensure(ErrorIndex {
845 compiler: builder.compiler(builder.top_stage, host),
849 /// Run the error index generator tool to execute the tests located in the error
852 /// The `error_index_generator` tool lives in `src/tools` and is used to
853 /// generate a markdown file from the error indexes of the code base which is
854 /// then passed to `rustdoc --test`.
855 fn run(self, builder: &Builder) {
856 let build = builder.build;
857 let compiler = self.compiler;
859 builder.ensure(compile::Std { compiler, target: compiler.host });
861 let _folder = build.fold_output(|| "test_error_index");
862 println!("Testing error-index stage{}", compiler.stage);
864 let dir = testdir(build, compiler.host);
865 t!(fs::create_dir_all(&dir));
866 let output = dir.join("error-index.md");
868 let _time = util::timeit();
869 build.run(builder.tool_cmd(Tool::ErrorIndex)
872 .env("CFG_BUILD", &build.build));
874 markdown_test(builder, compiler, &output);
878 fn markdown_test(builder: &Builder, compiler: Compiler, markdown: &Path) {
879 let build = builder.build;
880 let mut file = t!(File::open(markdown));
881 let mut contents = String::new();
882 t!(file.read_to_string(&mut contents));
883 if !contents.contains("```") {
887 println!("doc tests for: {}", markdown.display());
888 let mut cmd = Command::new(builder.rustdoc(compiler));
889 builder.add_rustc_lib_path(compiler, &mut cmd);
890 build.add_rust_test_threads(&mut cmd);
893 cmd.env("RUSTC_BOOTSTRAP", "1");
895 let test_args = build.flags.cmd.test_args().join(" ");
896 cmd.arg("--test-args").arg(test_args);
898 if build.config.quiet_tests {
899 try_run_quiet(build, &mut cmd);
901 try_run(build, &mut cmd);
905 // for (krate, path, _default) in krates("rustc-main") {
906 // rules.test(&krate.test_step, path)
907 // .dep(|s| s.name("librustc"))
908 // .dep(|s| s.name("remote-copy-libs"))
910 // .run(move |s| check::krate(build, &s.compiler(), s.target,
911 // Mode::Librustc, TestKind::Test,
912 // Some(&krate.name)));
914 // rules.test("check-rustc-all", "path/to/nowhere")
915 // .dep(|s| s.name("librustc"))
916 // .dep(|s| s.name("remote-copy-libs"))
919 // .run(move |s| check::krate(build, &s.compiler(), s.target,
920 // Mode::Librustc, TestKind::Test, None));
922 pub struct KrateLibrustc<'a> {
923 compiler: Compiler<'a>,
926 krate: Option<&'a str>,
929 impl<'a> Step<'a> for KrateLibrustc<'a> {
931 const DEFAULT: bool = true;
932 const ONLY_HOSTS: bool = true;
934 fn should_run(builder: &Builder, path: &Path) -> bool {
935 builder.crates("rustc-main").into_iter().any(|(_, krate_path)| {
936 path.ends_with(krate_path)
940 fn make_run(builder: &Builder, path: Option<&Path>, host: &str, target: &str) {
941 let compiler = builder.compiler(builder.top_stage, host);
943 let run = |name: Option<&str>| {
944 let test_kind = if builder.kind == Kind::Test {
946 } else if builder.kind == Kind::Bench {
949 panic!("unexpected builder.kind in Krate: {:?}", builder.kind);
952 builder.ensure(KrateLibrustc {
955 test_kind: test_kind,
960 if let Some(path) = path {
961 for (name, krate_path) in builder.crates("rustc-main") {
962 if path.ends_with(krate_path) {
972 fn run(self, builder: &Builder) {
973 builder.ensure(Krate {
974 compiler: self.compiler,
976 mode: Mode::Librustc,
977 test_kind: self.test_kind,
984 // for (krate, path, _default) in krates("std") {
985 // rules.test(&krate.test_step, path)
986 // .dep(|s| s.name("libtest"))
987 // .dep(|s| s.name("remote-copy-libs"))
988 // .run(move |s| check::krate(build, &s.compiler(), s.target,
989 // Mode::Libstd, TestKind::Test,
990 // Some(&krate.name)));
992 // rules.test("check-std-all", "path/to/nowhere")
993 // .dep(|s| s.name("libtest"))
994 // .dep(|s| s.name("remote-copy-libs"))
996 // .run(move |s| check::krate(build, &s.compiler(), s.target,
997 // Mode::Libstd, TestKind::Test, None));
1000 // for (krate, path, _default) in krates("std") {
1001 // rules.bench(&krate.bench_step, path)
1002 // .dep(|s| s.name("libtest"))
1003 // .dep(|s| s.name("remote-copy-libs"))
1004 // .run(move |s| check::krate(build, &s.compiler(), s.target,
1005 // Mode::Libstd, TestKind::Bench,
1006 // Some(&krate.name)));
1008 // rules.bench("bench-std-all", "path/to/nowhere")
1009 // .dep(|s| s.name("libtest"))
1010 // .dep(|s| s.name("remote-copy-libs"))
1012 // .run(move |s| check::krate(build, &s.compiler(), s.target,
1013 // Mode::Libstd, TestKind::Bench, None));
1015 // for (krate, path, _default) in krates("test") {
1016 // rules.test(&krate.test_step, path)
1017 // .dep(|s| s.name("libtest"))
1018 // .dep(|s| s.name("remote-copy-libs"))
1019 // .run(move |s| check::krate(build, &s.compiler(), s.target,
1020 // Mode::Libtest, TestKind::Test,
1021 // Some(&krate.name)));
1023 // rules.test("check-test-all", "path/to/nowhere")
1024 // .dep(|s| s.name("libtest"))
1025 // .dep(|s| s.name("remote-copy-libs"))
1027 // .run(move |s| check::krate(build, &s.compiler(), s.target,
1028 // Mode::Libtest, TestKind::Test, None));
1030 #[derive(Serialize)]
1031 pub struct Krate<'a> {
1032 compiler: Compiler<'a>,
1035 test_kind: TestKind,
1036 krate: Option<&'a str>,
1039 impl<'a> Step<'a> for Krate<'a> {
1041 const DEFAULT: bool = true;
1043 fn should_run(builder: &Builder, path: &Path) -> bool {
1044 builder.crates("std").into_iter().any(|(_, krate_path)| {
1045 path.ends_with(krate_path)
1047 builder.crates("test").into_iter().any(|(_, krate_path)| {
1048 path.ends_with(krate_path)
1052 fn make_run(builder: &Builder, path: Option<&Path>, host: &str, target: &str) {
1053 let compiler = builder.compiler(builder.top_stage, host);
1055 let run = |mode: Mode, name: Option<&str>| {
1056 let test_kind = if builder.kind == Kind::Test {
1058 } else if builder.kind == Kind::Bench {
1061 panic!("unexpected builder.kind in Krate: {:?}", builder.kind);
1064 builder.ensure(Krate {
1067 test_kind: test_kind,
1072 if let Some(path) = path {
1073 for (name, krate_path) in builder.crates("std") {
1074 if path.ends_with(krate_path) {
1075 run(Mode::Libstd, Some(name));
1078 for (name, krate_path) in builder.crates("test") {
1079 if path.ends_with(krate_path) {
1080 run(Mode::Libtest, Some(name));
1084 run(Mode::Libstd, None);
1085 run(Mode::Libtest, None);
1089 /// Run all unit tests plus documentation tests for an entire crate DAG defined
1090 /// by a `Cargo.toml`
1092 /// This is what runs tests for crates like the standard library, compiler, etc.
1093 /// It essentially is the driver for running `cargo test`.
1095 /// Currently this runs all tests for a DAG by passing a bunch of `-p foo`
1096 /// arguments, and those arguments are discovered from `cargo metadata`.
1097 fn run(self, builder: &Builder) {
1098 let build = builder.build;
1099 let compiler = self.compiler;
1100 let target = self.target;
1101 let mode = self.mode;
1102 let test_kind = self.test_kind;
1103 let krate = self.krate;
1105 builder.ensure(compile::Test { compiler, target });
1106 builder.ensure(RemoteCopyLibs { compiler, target });
1107 let (name, path, features, root) = match mode {
1109 ("libstd", "src/libstd", build.std_features(), "std")
1112 ("libtest", "src/libtest", String::new(), "test")
1115 ("librustc", "src/rustc", build.rustc_features(), "rustc-main")
1117 _ => panic!("can only test libraries"),
1119 let _folder = build.fold_output(|| {
1120 format!("{}_stage{}-{}", test_kind.subcommand(), compiler.stage, name)
1122 println!("{} {} stage{} ({} -> {})", test_kind, name, compiler.stage,
1123 compiler.host, target);
1125 // If we're not doing a full bootstrap but we're testing a stage2 version of
1126 // libstd, then what we're actually testing is the libstd produced in
1127 // stage1. Reflect that here by updating the compiler that we're working
1128 // with automatically.
1129 let compiler = if build.force_use_stage1(compiler, target) {
1130 builder.compiler(1, compiler.host)
1135 // Build up the base `cargo test` command.
1137 // Pass in some standard flags then iterate over the graph we've discovered
1138 // in `cargo metadata` with the maps above and figure out what `-p`
1139 // arguments need to get passed.
1140 let mut cargo = builder.cargo(compiler, mode, target, test_kind.subcommand());
1141 cargo.arg("--manifest-path")
1142 .arg(build.src.join(path).join("Cargo.toml"))
1143 .arg("--features").arg(features);
1144 if test_kind.subcommand() == "test" && !build.fail_fast {
1145 cargo.arg("--no-fail-fast");
1150 cargo.arg("-p").arg(krate);
1153 let mut visited = HashSet::new();
1154 let mut next = vec![root];
1155 while let Some(name) = next.pop() {
1156 // Right now jemalloc is our only target-specific crate in the
1157 // sense that it's not present on all platforms. Custom skip it
1158 // here for now, but if we add more this probably wants to get
1159 // more generalized.
1161 // Also skip `build_helper` as it's not compiled normally for
1162 // target during the bootstrap and it's just meant to be a
1163 // helper crate, not tested. If it leaks through then it ends up
1164 // messing with various mtime calculations and such.
1165 if !name.contains("jemalloc") && name != "build_helper" {
1166 cargo.arg("-p").arg(&format!("{}:0.0.0", name));
1168 for dep in build.crates[name].deps.iter() {
1169 if visited.insert(dep) {
1177 // The tests are going to run with the *target* libraries, so we need to
1178 // ensure that those libraries show up in the LD_LIBRARY_PATH equivalent.
1180 // Note that to run the compiler we need to run with the *host* libraries,
1181 // but our wrapper scripts arrange for that to be the case anyway.
1182 let mut dylib_path = dylib_path();
1183 dylib_path.insert(0, builder.sysroot_libdir(compiler, target));
1184 cargo.env(dylib_path_var(), env::join_paths(&dylib_path).unwrap());
1186 if target.contains("emscripten") || build.remote_tested(target) {
1187 cargo.arg("--no-run");
1192 if build.config.quiet_tests {
1193 cargo.arg("--quiet");
1196 let _time = util::timeit();
1198 if target.contains("emscripten") {
1199 build.run(&mut cargo);
1200 krate_emscripten(build, compiler, target, mode);
1201 } else if build.remote_tested(target) {
1202 build.run(&mut cargo);
1203 krate_remote(builder, compiler, target, mode);
1205 cargo.args(&build.flags.cmd.test_args());
1206 try_run(build, &mut cargo);
1211 fn krate_emscripten(build: &Build,
1215 let out_dir = build.cargo_out(compiler, mode, target);
1216 let tests = find_tests(&out_dir.join("deps"), target);
1218 let nodejs = build.config.nodejs.as_ref().expect("nodejs not configured");
1220 println!("running {}", test.display());
1221 let mut cmd = Command::new(nodejs);
1223 if build.config.quiet_tests {
1226 try_run(build, &mut cmd);
1230 fn krate_remote(builder: &Builder,
1234 let build = builder.build;
1235 let out_dir = build.cargo_out(compiler, mode, target);
1236 let tests = find_tests(&out_dir.join("deps"), target);
1238 let tool = builder.tool_exe(Tool::RemoteTestClient);
1240 let mut cmd = Command::new(&tool);
1243 if build.config.quiet_tests {
1246 cmd.args(&build.flags.cmd.test_args());
1247 try_run(build, &mut cmd);
1251 fn find_tests(dir: &Path, target: &str) -> Vec<PathBuf> {
1252 let mut dst = Vec::new();
1253 for e in t!(dir.read_dir()).map(|e| t!(e)) {
1254 let file_type = t!(e.file_type());
1255 if !file_type.is_file() {
1258 let filename = e.file_name().into_string().unwrap();
1259 if (target.contains("windows") && filename.ends_with(".exe")) ||
1260 (!target.contains("windows") && !filename.contains(".")) ||
1261 (target.contains("emscripten") &&
1262 filename.ends_with(".js") &&
1263 !filename.ends_with(".asm.js")) {
1270 // // Some test suites are run inside emulators or on remote devices, and most
1271 // // of our test binaries are linked dynamically which means we need to ship
1272 // // the standard library and such to the emulator ahead of time. This step
1273 // // represents this and is a dependency of all test suites.
1275 // // Most of the time this step is a noop (the `check::emulator_copy_libs`
1276 // // only does work if necessary). For some steps such as shipping data to
1277 // // QEMU we have to build our own tools so we've got conditional dependencies
1278 // // on those programs as well. Note that the remote test client is built for
1279 // // the build target (us) and the server is built for the target.
1280 // rules.test("remote-copy-libs", "path/to/nowhere")
1281 // .dep(|s| s.name("libtest"))
1283 // if build.remote_tested(s.target) {
1284 // s.name("tool-remote-test-client").target(s.host).stage(0)
1290 // if build.remote_tested(s.target) {
1291 // s.name("tool-remote-test-server")
1296 // .run(move |s| check::remote_copy_libs(build, &s.compiler(), s.target));
1299 #[derive(Serialize)]
1300 pub struct RemoteCopyLibs<'a> {
1301 compiler: Compiler<'a>,
1305 impl<'a> Step<'a> for RemoteCopyLibs<'a> {
1308 fn run(self, builder: &Builder) {
1309 let build = builder.build;
1310 let compiler = self.compiler;
1311 let target = self.target;
1312 if !build.remote_tested(target) {
1316 builder.ensure(compile::Test { compiler, target });
1318 println!("REMOTE copy libs to emulator ({})", target);
1319 t!(fs::create_dir_all(build.out.join("tmp")));
1321 // FIXME: This builds the tool for the native build triple
1322 // (build.build); that is probably wrong. Should build for target.
1323 let server = builder.tool_exe(Tool::RemoteTestServer);
1325 // Spawn the emulator and wait for it to come online
1326 let tool = builder.tool_exe(Tool::RemoteTestClient);
1327 let mut cmd = Command::new(&tool);
1328 cmd.arg("spawn-emulator")
1331 .arg(build.out.join("tmp"));
1332 if let Some(rootfs) = build.qemu_rootfs(target) {
1335 build.run(&mut cmd);
1337 // Push all our dylibs to the emulator
1338 for f in t!(builder.sysroot_libdir(compiler, target).read_dir()) {
1340 let name = f.file_name().into_string().unwrap();
1341 if util::is_dylib(&name) {
1342 build.run(Command::new(&tool)
1350 //rules.test("check-distcheck", "distcheck")
1351 // .dep(|s| s.name("dist-plain-source-tarball"))
1352 // .dep(|s| s.name("dist-src"))
1353 // .run(move |_| check::distcheck(build));
1355 #[derive(Serialize)]
1356 pub struct Distcheck;
1358 impl<'a> Step<'a> for Distcheck {
1361 /// Run "distcheck", a 'make check' from a tarball
1362 fn run(self, builder: &Builder) {
1363 let build = builder.build;
1365 if build.build != "x86_64-unknown-linux-gnu" {
1368 if !build.config.host.iter().any(|s| s == "x86_64-unknown-linux-gnu") {
1371 if !build.config.target.iter().any(|s| s == "x86_64-unknown-linux-gnu") {
1375 builder.ensure(dist::PlainSourceTarball);
1376 builder.ensure(dist::Src);
1378 println!("Distcheck");
1379 let dir = build.out.join("tmp").join("distcheck");
1380 let _ = fs::remove_dir_all(&dir);
1381 t!(fs::create_dir_all(&dir));
1383 let mut cmd = Command::new("tar");
1385 .arg(dist::rust_src_location(build))
1386 .arg("--strip-components=1")
1388 build.run(&mut cmd);
1389 build.run(Command::new("./configure")
1390 .args(&build.config.configure_args)
1391 .arg("--enable-vendor")
1392 .current_dir(&dir));
1393 build.run(Command::new(build_helper::make(&build.build))
1395 .current_dir(&dir));
1397 // Now make sure that rust-src has all of libstd's dependencies
1398 println!("Distcheck rust-src");
1399 let dir = build.out.join("tmp").join("distcheck-src");
1400 let _ = fs::remove_dir_all(&dir);
1401 t!(fs::create_dir_all(&dir));
1403 let mut cmd = Command::new("tar");
1405 .arg(dist::rust_src_installer(build))
1406 .arg("--strip-components=1")
1408 build.run(&mut cmd);
1410 let toml = dir.join("rust-src/lib/rustlib/src/rust/src/libstd/Cargo.toml");
1411 build.run(Command::new(&build.initial_cargo)
1412 .arg("generate-lockfile")
1413 .arg("--manifest-path")
1415 .current_dir(&dir));
1419 //rules.test("check-bootstrap", "src/bootstrap")
1422 // .only_build(true)
1423 // .run(move |_| check::bootstrap(build));
1425 #[derive(Serialize)]
1426 pub struct Bootstrap;
1428 impl<'a> Step<'a> for Bootstrap {
1430 const DEFAULT: bool = true;
1431 const ONLY_HOSTS: bool = true;
1432 const ONLY_BUILD: bool = true;
1434 /// Test the build system itself
1435 fn run(self, builder: &Builder) {
1436 let build = builder.build;
1437 let mut cmd = Command::new(&build.initial_cargo);
1439 .current_dir(build.src.join("src/bootstrap"))
1440 .env("CARGO_TARGET_DIR", build.out.join("bootstrap"))
1441 .env("RUSTC_BOOTSTRAP", "1")
1442 .env("RUSTC", &build.initial_rustc);
1443 if !build.fail_fast {
1444 cmd.arg("--no-fail-fast");
1446 cmd.arg("--").args(&build.flags.cmd.test_args());
1447 try_run(build, &mut cmd);
1450 fn should_run(_builder: &Builder, path: &Path) -> bool {
1451 path.ends_with("src/bootstrap")
1454 fn make_run(builder: &Builder, _path: Option<&Path>, _host: &str, _target: &str) {
1455 builder.ensure(Bootstrap);