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, PartialEq)]
454 static DEFAULT_COMPILETESTS: &[Test] = &[
455 Test { path: "src/test/ui", mode: "ui", suite: "ui" },
456 Test { path: "src/test/run-pass", mode: "run-pass", suite: "run-pass" },
457 Test { path: "src/test/compile-fail", mode: "compile-fail", suite: "compile-fail" },
458 Test { path: "src/test/parse-fail", mode: "parse-fail", suite: "parse-fail" },
459 Test { path: "src/test/run-fail", mode: "run-fail", suite: "run-fail" },
461 path: "src/test/run-pass-valgrind",
462 mode: "run-pass-valgrind",
463 suite: "run-pass-valgrind"
465 Test { path: "src/test/mir-opt", mode: "mir-opt", suite: "mir-opt" },
466 Test { path: "src/test/codegen", mode: "codegen", suite: "codegen" },
467 Test { path: "src/test/codegen-units", mode: "codegen-units", suite: "codegen-units" },
468 Test { path: "src/test/incremental", mode: "incremental", suite: "incremental" },
470 // What this runs varies depending on the native platform being apple
471 Test { path: "src/test/debuginfo", mode: "debuginfo-XXX", suite: "debuginfo" },
474 // Also default, but host-only.
475 static HOST_COMPILETESTS: &[Test] = &[
476 Test { path: "src/test/ui-fulldeps", mode: "ui", suite: "ui-fulldeps" },
477 Test { path: "src/test/run-pass-fulldeps", mode: "run-pass", suite: "run-pass-fulldeps" },
478 Test { path: "src/test/run-fail-fulldeps", mode: "run-fail", suite: "run-fail-fulldeps" },
480 path: "src/test/compile-fail-fulldeps",
481 mode: "compile-fail",
482 suite: "compile-fail-fulldeps",
484 Test { path: "src/test/run-make", mode: "run-make", suite: "run-make" },
485 Test { path: "src/test/rustdoc", mode: "rustdoc", suite: "rustdoc" },
487 Test { path: "src/test/pretty", mode: "pretty", suite: "pretty" },
488 Test { path: "src/test/run-pass/pretty", mode: "pretty", suite: "run-pass" },
489 Test { path: "src/test/run-fail/pretty", mode: "pretty", suite: "run-fail" },
490 Test { path: "src/test/run-pass-valgrind/pretty", mode: "pretty", suite: "run-pass-valgrind" },
491 Test { path: "src/test/run-pass-fulldeps/pretty", mode: "pretty", suite: "run-pass-fulldeps" },
492 Test { path: "src/test/run-fail-fulldeps/pretty", mode: "pretty", suite: "run-fail-fulldeps" },
495 static COMPILETESTS: &[Test] = &[
496 Test { path: "src/test/debuginfo-lldb", mode: "debuginfo-lldb", suite: "debuginfo" },
497 Test { path: "src/test/debuginfo-gdb", mode: "debuginfo-gdb", suite: "debuginfo" },
500 impl<'a> Step<'a> for Compiletest<'a> {
502 const DEFAULT: bool = true;
504 fn should_run(_builder: &Builder, path: &Path) -> bool {
505 // Note that this is general, while a few more cases are skipped inside
506 // run() itself. This is to avoid duplication across should_run and
508 COMPILETESTS.iter().chain(DEFAULT_COMPILETESTS).chain(HOST_COMPILETESTS).any(|&test| {
509 path.ends_with(test.path)
513 fn make_run(builder: &Builder, path: Option<&Path>, host: &str, target: &str) {
514 let compiler = builder.compiler(builder.top_stage, host);
516 let test = path.map(|path| {
517 COMPILETESTS.iter().chain(DEFAULT_COMPILETESTS).chain(HOST_COMPILETESTS).find(|&&test| {
518 path.ends_with(test.path)
519 }).unwrap_or_else(|| {
520 panic!("make_run in compile test to receive test path, received {:?}", path);
524 if let Some(test) = test { // specific test
525 let target = if HOST_COMPILETESTS.contains(test) {
530 builder.ensure(Compiletest {
531 compiler, target, mode: test.mode, suite: test.suite
533 } else { // default tests
534 for test in DEFAULT_COMPILETESTS {
535 builder.ensure(Compiletest {
542 for test in HOST_COMPILETESTS {
543 if test.mode != "pretty" {
544 builder.ensure(Compiletest {
555 /// Executes the `compiletest` tool to run a suite of tests.
557 /// Compiles all tests with `compiler` for `target` with the specified
558 /// compiletest `mode` and `suite` arguments. For example `mode` can be
559 /// "run-pass" or `suite` can be something like `debuginfo`.
560 fn run(self, builder: &Builder) {
561 let build = builder.build;
562 let compiler = self.compiler;
563 let target = self.target;
564 let mode = self.mode;
565 let suite = self.suite;
567 // Skip codegen tests if they aren't enabled in configuration.
568 if !build.config.codegen_tests && suite == "codegen" {
572 if suite == "debuginfo" {
573 if mode == "debuginfo-XXX" {
574 return if build.build.contains("apple") {
575 builder.ensure(Compiletest {
576 mode: "debuginfo-lldb",
580 builder.ensure(Compiletest {
581 mode: "debuginfo-gdb",
587 // Skip debuginfo tests on MSVC
588 if build.build.contains("msvc") {
592 builder.ensure(dist::DebuggerScripts {
593 sysroot: &builder.sysroot(compiler),
597 if mode == "debuginfo-gdb" {
598 builder.ensure(RemoteCopyLibs { compiler, target });
602 if suite.ends_with("fulldeps") ||
603 // FIXME: Does pretty need librustc compiled? Note that there are
604 // fulldeps test suites with mode = pretty as well.
608 builder.ensure(compile::Rustc { compiler, target });
611 builder.ensure(compile::Test { compiler, target });
612 builder.ensure(native::TestHelpers { target });
613 builder.ensure(RemoteCopyLibs { compiler, target });
615 let _folder = build.fold_output(|| format!("test_{}", suite));
616 println!("Check compiletest suite={} mode={} ({} -> {})",
617 suite, mode, compiler.host, target);
618 let mut cmd = builder.tool_cmd(Tool::Compiletest);
620 // compiletest currently has... a lot of arguments, so let's just pass all
623 cmd.arg("--compile-lib-path").arg(builder.rustc_libdir(compiler));
624 cmd.arg("--run-lib-path").arg(builder.sysroot_libdir(compiler, target));
625 cmd.arg("--rustc-path").arg(builder.rustc(compiler));
626 cmd.arg("--rustdoc-path").arg(builder.rustdoc(compiler));
627 cmd.arg("--src-base").arg(build.src.join("src/test").join(suite));
628 cmd.arg("--build-base").arg(testdir(build, compiler.host).join(suite));
629 cmd.arg("--stage-id").arg(format!("stage{}-{}", compiler.stage, target));
630 cmd.arg("--mode").arg(mode);
631 cmd.arg("--target").arg(target);
632 cmd.arg("--host").arg(compiler.host);
633 cmd.arg("--llvm-filecheck").arg(build.llvm_filecheck(&build.build));
635 if let Some(ref nodejs) = build.config.nodejs {
636 cmd.arg("--nodejs").arg(nodejs);
639 let mut flags = vec!["-Crpath".to_string()];
640 if build.config.rust_optimize_tests {
641 flags.push("-O".to_string());
643 if build.config.rust_debuginfo_tests {
644 flags.push("-g".to_string());
647 let mut hostflags = build.rustc_flags(compiler.host);
648 hostflags.extend(flags.clone());
649 cmd.arg("--host-rustcflags").arg(hostflags.join(" "));
651 let mut targetflags = build.rustc_flags(&target);
652 targetflags.extend(flags);
653 targetflags.push(format!("-Lnative={}",
654 build.test_helpers_out(target).display()));
655 cmd.arg("--target-rustcflags").arg(targetflags.join(" "));
657 cmd.arg("--docck-python").arg(build.python());
659 if build.build.ends_with("apple-darwin") {
660 // Force /usr/bin/python on macOS for LLDB tests because we're loading the
661 // LLDB plugin's compiled module which only works with the system python
662 // (namely not Homebrew-installed python)
663 cmd.arg("--lldb-python").arg("/usr/bin/python");
665 cmd.arg("--lldb-python").arg(build.python());
668 if let Some(ref gdb) = build.config.gdb {
669 cmd.arg("--gdb").arg(gdb);
671 if let Some(ref vers) = build.lldb_version {
672 cmd.arg("--lldb-version").arg(vers);
674 if let Some(ref dir) = build.lldb_python_dir {
675 cmd.arg("--lldb-python-dir").arg(dir);
677 let llvm_config = build.llvm_config(target);
678 let llvm_version = output(Command::new(&llvm_config).arg("--version"));
679 cmd.arg("--llvm-version").arg(llvm_version);
680 if !build.is_rust_llvm(target) {
681 cmd.arg("--system-llvm");
684 cmd.args(&build.flags.cmd.test_args());
686 if build.is_verbose() {
687 cmd.arg("--verbose");
690 if build.config.quiet_tests {
694 // Only pass correct values for these flags for the `run-make` suite as it
695 // requires that a C++ compiler was configured which isn't always the case.
696 if suite == "run-make" {
697 let llvm_components = output(Command::new(&llvm_config).arg("--components"));
698 let llvm_cxxflags = output(Command::new(&llvm_config).arg("--cxxflags"));
699 cmd.arg("--cc").arg(build.cc(target))
700 .arg("--cxx").arg(build.cxx(target).unwrap())
701 .arg("--cflags").arg(build.cflags(target).join(" "))
702 .arg("--llvm-components").arg(llvm_components.trim())
703 .arg("--llvm-cxxflags").arg(llvm_cxxflags.trim());
705 cmd.arg("--cc").arg("")
706 .arg("--cxx").arg("")
707 .arg("--cflags").arg("")
708 .arg("--llvm-components").arg("")
709 .arg("--llvm-cxxflags").arg("");
712 if build.remote_tested(target) {
713 cmd.arg("--remote-test-client").arg(builder.tool_exe(Tool::RemoteTestClient));
716 // Running a C compiler on MSVC requires a few env vars to be set, to be
717 // sure to set them here.
719 // Note that if we encounter `PATH` we make sure to append to our own `PATH`
720 // rather than stomp over it.
721 if target.contains("msvc") {
722 for &(ref k, ref v) in build.cc[target].0.env() {
728 cmd.env("RUSTC_BOOTSTRAP", "1");
729 build.add_rust_test_threads(&mut cmd);
731 if build.config.sanitizers {
732 cmd.env("SANITIZER_SUPPORT", "1");
735 if build.config.profiler {
736 cmd.env("PROFILER_SUPPORT", "1");
739 cmd.arg("--adb-path").arg("adb");
740 cmd.arg("--adb-test-dir").arg(ADB_TEST_DIR);
741 if target.contains("android") {
742 // Assume that cc for this target comes from the android sysroot
743 cmd.arg("--android-cross-path")
744 .arg(build.cc(target).parent().unwrap().parent().unwrap());
746 cmd.arg("--android-cross-path").arg("");
749 build.ci_env.force_coloring_in_ci(&mut cmd);
751 let _time = util::timeit();
752 try_run(build, &mut cmd);
756 // rules.test("check-docs", "src/doc")
757 // .dep(|s| s.name("libtest"))
760 // .run(move |s| check::docs(build, &s.compiler()));
761 /// Run `rustdoc --test` for all documentation in `src/doc`.
763 /// This will run all tests in our markdown documentation (e.g. the book)
764 /// located in `src/doc`. The `rustdoc` that's run is the one that sits next to
766 pub fn docs(build: &Build, compiler: &Compiler) {
767 // Do a breadth-first traversal of the `src/doc` directory and just run
768 // tests for all files that end in `*.md`
769 let mut stack = vec![build.src.join("src/doc")];
770 let _time = util::timeit();
771 let _folder = build.fold_output(|| "test_docs");
773 while let Some(p) = stack.pop() {
775 stack.extend(t!(p.read_dir()).map(|p| t!(p).path()));
779 if p.extension().and_then(|s| s.to_str()) != Some("md") {
783 // The nostarch directory in the book is for no starch, and so isn't
784 // guaranteed to build. We don't care if it doesn't build, so skip it.
785 if p.to_str().map_or(false, |p| p.contains("nostarch")) {
789 markdown_test(build, compiler, &p);
793 //rules.test("check-error-index", "src/tools/error_index_generator")
794 // .dep(|s| s.name("libstd"))
795 // .dep(|s| s.name("tool-error-index").host(s.host).stage(0))
798 // .run(move |s| check::error_index(build, &s.compiler()));
801 pub struct ErrorIndex<'a> {
802 compiler: Compiler<'a>,
805 impl<'a> Step<'a> for ErrorIndex<'a> {
807 const DEFAULT: bool = true;
808 const ONLY_HOSTS: bool = true;
810 fn should_run(_builder: &Builder, path: &Path) -> bool {
811 path.ends_with("src/tools/error_index_generator")
814 fn make_run(builder: &Builder, _path: Option<&Path>, host: &str, _target: &str) {
815 builder.ensure(ErrorIndex {
816 compiler: builder.compiler(builder.top_stage, host),
820 /// Run the error index generator tool to execute the tests located in the error
823 /// The `error_index_generator` tool lives in `src/tools` and is used to
824 /// generate a markdown file from the error indexes of the code base which is
825 /// then passed to `rustdoc --test`.
826 fn run(self, builder: &Builder) {
827 let build = builder.build;
828 let compiler = self.compiler;
830 builder.ensure(compile::Std { compiler, target: compiler.host });
832 let _folder = build.fold_output(|| "test_error_index");
833 println!("Testing error-index stage{}", compiler.stage);
835 let dir = testdir(build, compiler.host);
836 t!(fs::create_dir_all(&dir));
837 let output = dir.join("error-index.md");
839 let _time = util::timeit();
840 build.run(builder.tool_cmd(Tool::ErrorIndex)
843 .env("CFG_BUILD", &build.build));
845 markdown_test(builder, compiler, &output);
849 fn markdown_test(builder: &Builder, compiler: Compiler, markdown: &Path) {
850 let build = builder.build;
851 let mut file = t!(File::open(markdown));
852 let mut contents = String::new();
853 t!(file.read_to_string(&mut contents));
854 if !contents.contains("```") {
858 println!("doc tests for: {}", markdown.display());
859 let mut cmd = Command::new(builder.rustdoc(compiler));
860 builder.add_rustc_lib_path(compiler, &mut cmd);
861 build.add_rust_test_threads(&mut cmd);
864 cmd.env("RUSTC_BOOTSTRAP", "1");
866 let test_args = build.flags.cmd.test_args().join(" ");
867 cmd.arg("--test-args").arg(test_args);
869 if build.config.quiet_tests {
870 try_run_quiet(build, &mut cmd);
872 try_run(build, &mut cmd);
876 // for (krate, path, _default) in krates("rustc-main") {
877 // rules.test(&krate.test_step, path)
878 // .dep(|s| s.name("librustc"))
879 // .dep(|s| s.name("remote-copy-libs"))
881 // .run(move |s| check::krate(build, &s.compiler(), s.target,
882 // Mode::Librustc, TestKind::Test,
883 // Some(&krate.name)));
885 // rules.test("check-rustc-all", "path/to/nowhere")
886 // .dep(|s| s.name("librustc"))
887 // .dep(|s| s.name("remote-copy-libs"))
890 // .run(move |s| check::krate(build, &s.compiler(), s.target,
891 // Mode::Librustc, TestKind::Test, None));
893 pub struct KrateLibrustc<'a> {
894 compiler: Compiler<'a>,
897 krate: Option<&'a str>,
900 impl<'a> Step<'a> for KrateLibrustc<'a> {
902 const DEFAULT: bool = true;
903 const ONLY_HOSTS: bool = true;
905 fn should_run(builder: &Builder, path: &Path) -> bool {
906 builder.crates("rustc-main").into_iter().any(|(_, krate_path)| {
907 path.ends_with(krate_path)
911 fn make_run(builder: &Builder, path: Option<&Path>, host: &str, target: &str) {
912 let compiler = builder.compiler(builder.top_stage, host);
914 let run = |name: Option<&str>| {
915 let test_kind = if builder.kind == Kind::Test {
917 } else if builder.kind == Kind::Bench {
920 panic!("unexpected builder.kind in Krate: {:?}", builder.kind);
923 builder.ensure(KrateLibrustc {
926 test_kind: test_kind,
931 if let Some(path) = path {
932 for (name, krate_path) in builder.crates("rustc-main") {
933 if path.ends_with(krate_path) {
943 fn run(self, builder: &Builder) {
944 builder.ensure(Krate {
945 compiler: self.compiler,
947 mode: Mode::Librustc,
948 test_kind: self.test_kind,
955 // for (krate, path, _default) in krates("std") {
956 // rules.test(&krate.test_step, path)
957 // .dep(|s| s.name("libtest"))
958 // .dep(|s| s.name("remote-copy-libs"))
959 // .run(move |s| check::krate(build, &s.compiler(), s.target,
960 // Mode::Libstd, TestKind::Test,
961 // Some(&krate.name)));
963 // rules.test("check-std-all", "path/to/nowhere")
964 // .dep(|s| s.name("libtest"))
965 // .dep(|s| s.name("remote-copy-libs"))
967 // .run(move |s| check::krate(build, &s.compiler(), s.target,
968 // Mode::Libstd, TestKind::Test, None));
971 // for (krate, path, _default) in krates("std") {
972 // rules.bench(&krate.bench_step, path)
973 // .dep(|s| s.name("libtest"))
974 // .dep(|s| s.name("remote-copy-libs"))
975 // .run(move |s| check::krate(build, &s.compiler(), s.target,
976 // Mode::Libstd, TestKind::Bench,
977 // Some(&krate.name)));
979 // rules.bench("bench-std-all", "path/to/nowhere")
980 // .dep(|s| s.name("libtest"))
981 // .dep(|s| s.name("remote-copy-libs"))
983 // .run(move |s| check::krate(build, &s.compiler(), s.target,
984 // Mode::Libstd, TestKind::Bench, None));
986 // for (krate, path, _default) in krates("test") {
987 // rules.test(&krate.test_step, path)
988 // .dep(|s| s.name("libtest"))
989 // .dep(|s| s.name("remote-copy-libs"))
990 // .run(move |s| check::krate(build, &s.compiler(), s.target,
991 // Mode::Libtest, TestKind::Test,
992 // Some(&krate.name)));
994 // rules.test("check-test-all", "path/to/nowhere")
995 // .dep(|s| s.name("libtest"))
996 // .dep(|s| s.name("remote-copy-libs"))
998 // .run(move |s| check::krate(build, &s.compiler(), s.target,
999 // Mode::Libtest, TestKind::Test, None));
1001 #[derive(Serialize)]
1002 pub struct Krate<'a> {
1003 compiler: Compiler<'a>,
1006 test_kind: TestKind,
1007 krate: Option<&'a str>,
1010 impl<'a> Step<'a> for Krate<'a> {
1012 const DEFAULT: bool = true;
1014 fn should_run(builder: &Builder, path: &Path) -> bool {
1015 builder.crates("std").into_iter().any(|(_, krate_path)| {
1016 path.ends_with(krate_path)
1018 builder.crates("test").into_iter().any(|(_, krate_path)| {
1019 path.ends_with(krate_path)
1023 fn make_run(builder: &Builder, path: Option<&Path>, host: &str, target: &str) {
1024 let compiler = builder.compiler(builder.top_stage, host);
1026 let run = |mode: Mode, name: Option<&str>| {
1027 let test_kind = if builder.kind == Kind::Test {
1029 } else if builder.kind == Kind::Bench {
1032 panic!("unexpected builder.kind in Krate: {:?}", builder.kind);
1035 builder.ensure(Krate {
1038 test_kind: test_kind,
1043 if let Some(path) = path {
1044 for (name, krate_path) in builder.crates("std") {
1045 if path.ends_with(krate_path) {
1046 run(Mode::Libstd, Some(name));
1049 for (name, krate_path) in builder.crates("test") {
1050 if path.ends_with(krate_path) {
1051 run(Mode::Libtest, Some(name));
1055 run(Mode::Libstd, None);
1056 run(Mode::Libtest, None);
1060 /// Run all unit tests plus documentation tests for an entire crate DAG defined
1061 /// by a `Cargo.toml`
1063 /// This is what runs tests for crates like the standard library, compiler, etc.
1064 /// It essentially is the driver for running `cargo test`.
1066 /// Currently this runs all tests for a DAG by passing a bunch of `-p foo`
1067 /// arguments, and those arguments are discovered from `cargo metadata`.
1068 fn run(self, builder: &Builder) {
1069 let build = builder.build;
1070 let compiler = self.compiler;
1071 let target = self.target;
1072 let mode = self.mode;
1073 let test_kind = self.test_kind;
1074 let krate = self.krate;
1076 builder.ensure(compile::Test { compiler, target });
1077 builder.ensure(RemoteCopyLibs { compiler, target });
1078 let (name, path, features, root) = match mode {
1080 ("libstd", "src/libstd", build.std_features(), "std")
1083 ("libtest", "src/libtest", String::new(), "test")
1086 ("librustc", "src/rustc", build.rustc_features(), "rustc-main")
1088 _ => panic!("can only test libraries"),
1090 let _folder = build.fold_output(|| {
1091 format!("{}_stage{}-{}", test_kind.subcommand(), compiler.stage, name)
1093 println!("{} {} stage{} ({} -> {})", test_kind, name, compiler.stage,
1094 compiler.host, target);
1096 // If we're not doing a full bootstrap but we're testing a stage2 version of
1097 // libstd, then what we're actually testing is the libstd produced in
1098 // stage1. Reflect that here by updating the compiler that we're working
1099 // with automatically.
1100 let compiler = if build.force_use_stage1(compiler, target) {
1101 builder.compiler(1, compiler.host)
1106 // Build up the base `cargo test` command.
1108 // Pass in some standard flags then iterate over the graph we've discovered
1109 // in `cargo metadata` with the maps above and figure out what `-p`
1110 // arguments need to get passed.
1111 let mut cargo = builder.cargo(compiler, mode, target, test_kind.subcommand());
1112 cargo.arg("--manifest-path")
1113 .arg(build.src.join(path).join("Cargo.toml"))
1114 .arg("--features").arg(features);
1115 if test_kind.subcommand() == "test" && !build.fail_fast {
1116 cargo.arg("--no-fail-fast");
1121 cargo.arg("-p").arg(krate);
1124 let mut visited = HashSet::new();
1125 let mut next = vec![root];
1126 while let Some(name) = next.pop() {
1127 // Right now jemalloc is our only target-specific crate in the
1128 // sense that it's not present on all platforms. Custom skip it
1129 // here for now, but if we add more this probably wants to get
1130 // more generalized.
1132 // Also skip `build_helper` as it's not compiled normally for
1133 // target during the bootstrap and it's just meant to be a
1134 // helper crate, not tested. If it leaks through then it ends up
1135 // messing with various mtime calculations and such.
1136 if !name.contains("jemalloc") && name != "build_helper" {
1137 cargo.arg("-p").arg(&format!("{}:0.0.0", name));
1139 for dep in build.crates[name].deps.iter() {
1140 if visited.insert(dep) {
1148 // The tests are going to run with the *target* libraries, so we need to
1149 // ensure that those libraries show up in the LD_LIBRARY_PATH equivalent.
1151 // Note that to run the compiler we need to run with the *host* libraries,
1152 // but our wrapper scripts arrange for that to be the case anyway.
1153 let mut dylib_path = dylib_path();
1154 dylib_path.insert(0, builder.sysroot_libdir(compiler, target));
1155 cargo.env(dylib_path_var(), env::join_paths(&dylib_path).unwrap());
1157 if target.contains("emscripten") || build.remote_tested(target) {
1158 cargo.arg("--no-run");
1163 if build.config.quiet_tests {
1164 cargo.arg("--quiet");
1167 let _time = util::timeit();
1169 if target.contains("emscripten") {
1170 build.run(&mut cargo);
1171 krate_emscripten(build, compiler, target, mode);
1172 } else if build.remote_tested(target) {
1173 build.run(&mut cargo);
1174 krate_remote(builder, compiler, target, mode);
1176 cargo.args(&build.flags.cmd.test_args());
1177 try_run(build, &mut cargo);
1182 fn krate_emscripten(build: &Build,
1186 let out_dir = build.cargo_out(compiler, mode, target);
1187 let tests = find_tests(&out_dir.join("deps"), target);
1189 let nodejs = build.config.nodejs.as_ref().expect("nodejs not configured");
1191 println!("running {}", test.display());
1192 let mut cmd = Command::new(nodejs);
1194 if build.config.quiet_tests {
1197 try_run(build, &mut cmd);
1201 fn krate_remote(builder: &Builder,
1205 let build = builder.build;
1206 let out_dir = build.cargo_out(compiler, mode, target);
1207 let tests = find_tests(&out_dir.join("deps"), target);
1209 let tool = builder.tool_exe(Tool::RemoteTestClient);
1211 let mut cmd = Command::new(&tool);
1214 if build.config.quiet_tests {
1217 cmd.args(&build.flags.cmd.test_args());
1218 try_run(build, &mut cmd);
1222 fn find_tests(dir: &Path, target: &str) -> Vec<PathBuf> {
1223 let mut dst = Vec::new();
1224 for e in t!(dir.read_dir()).map(|e| t!(e)) {
1225 let file_type = t!(e.file_type());
1226 if !file_type.is_file() {
1229 let filename = e.file_name().into_string().unwrap();
1230 if (target.contains("windows") && filename.ends_with(".exe")) ||
1231 (!target.contains("windows") && !filename.contains(".")) ||
1232 (target.contains("emscripten") &&
1233 filename.ends_with(".js") &&
1234 !filename.ends_with(".asm.js")) {
1241 // // Some test suites are run inside emulators or on remote devices, and most
1242 // // of our test binaries are linked dynamically which means we need to ship
1243 // // the standard library and such to the emulator ahead of time. This step
1244 // // represents this and is a dependency of all test suites.
1246 // // Most of the time this step is a noop (the `check::emulator_copy_libs`
1247 // // only does work if necessary). For some steps such as shipping data to
1248 // // QEMU we have to build our own tools so we've got conditional dependencies
1249 // // on those programs as well. Note that the remote test client is built for
1250 // // the build target (us) and the server is built for the target.
1251 // rules.test("remote-copy-libs", "path/to/nowhere")
1252 // .dep(|s| s.name("libtest"))
1254 // if build.remote_tested(s.target) {
1255 // s.name("tool-remote-test-client").target(s.host).stage(0)
1261 // if build.remote_tested(s.target) {
1262 // s.name("tool-remote-test-server")
1267 // .run(move |s| check::remote_copy_libs(build, &s.compiler(), s.target));
1270 #[derive(Serialize)]
1271 pub struct RemoteCopyLibs<'a> {
1272 compiler: Compiler<'a>,
1276 impl<'a> Step<'a> for RemoteCopyLibs<'a> {
1279 fn run(self, builder: &Builder) {
1280 let build = builder.build;
1281 let compiler = self.compiler;
1282 let target = self.target;
1283 if !build.remote_tested(target) {
1287 builder.ensure(compile::Test { compiler, target });
1289 println!("REMOTE copy libs to emulator ({})", target);
1290 t!(fs::create_dir_all(build.out.join("tmp")));
1292 // FIXME: This builds the tool for the native build triple
1293 // (build.build); that is probably wrong. Should build for target.
1294 let server = builder.tool_exe(Tool::RemoteTestServer);
1296 // Spawn the emulator and wait for it to come online
1297 let tool = builder.tool_exe(Tool::RemoteTestClient);
1298 let mut cmd = Command::new(&tool);
1299 cmd.arg("spawn-emulator")
1302 .arg(build.out.join("tmp"));
1303 if let Some(rootfs) = build.qemu_rootfs(target) {
1306 build.run(&mut cmd);
1308 // Push all our dylibs to the emulator
1309 for f in t!(builder.sysroot_libdir(compiler, target).read_dir()) {
1311 let name = f.file_name().into_string().unwrap();
1312 if util::is_dylib(&name) {
1313 build.run(Command::new(&tool)
1321 //rules.test("check-distcheck", "distcheck")
1322 // .dep(|s| s.name("dist-plain-source-tarball"))
1323 // .dep(|s| s.name("dist-src"))
1324 // .run(move |_| check::distcheck(build));
1326 #[derive(Serialize)]
1327 pub struct Distcheck;
1329 impl<'a> Step<'a> for Distcheck {
1332 /// Run "distcheck", a 'make check' from a tarball
1333 fn run(self, builder: &Builder) {
1334 let build = builder.build;
1336 if build.build != "x86_64-unknown-linux-gnu" {
1339 if !build.config.host.iter().any(|s| s == "x86_64-unknown-linux-gnu") {
1342 if !build.config.target.iter().any(|s| s == "x86_64-unknown-linux-gnu") {
1346 builder.ensure(dist::PlainSourceTarball);
1347 builder.ensure(dist::Src);
1349 println!("Distcheck");
1350 let dir = build.out.join("tmp").join("distcheck");
1351 let _ = fs::remove_dir_all(&dir);
1352 t!(fs::create_dir_all(&dir));
1354 let mut cmd = Command::new("tar");
1356 .arg(dist::rust_src_location(build))
1357 .arg("--strip-components=1")
1359 build.run(&mut cmd);
1360 build.run(Command::new("./configure")
1361 .args(&build.config.configure_args)
1362 .arg("--enable-vendor")
1363 .current_dir(&dir));
1364 build.run(Command::new(build_helper::make(&build.build))
1366 .current_dir(&dir));
1368 // Now make sure that rust-src has all of libstd's dependencies
1369 println!("Distcheck rust-src");
1370 let dir = build.out.join("tmp").join("distcheck-src");
1371 let _ = fs::remove_dir_all(&dir);
1372 t!(fs::create_dir_all(&dir));
1374 let mut cmd = Command::new("tar");
1376 .arg(dist::rust_src_installer(build))
1377 .arg("--strip-components=1")
1379 build.run(&mut cmd);
1381 let toml = dir.join("rust-src/lib/rustlib/src/rust/src/libstd/Cargo.toml");
1382 build.run(Command::new(&build.initial_cargo)
1383 .arg("generate-lockfile")
1384 .arg("--manifest-path")
1386 .current_dir(&dir));
1390 //rules.test("check-bootstrap", "src/bootstrap")
1393 // .only_build(true)
1394 // .run(move |_| check::bootstrap(build));
1396 #[derive(Serialize)]
1397 pub struct Bootstrap;
1399 impl<'a> Step<'a> for Bootstrap {
1401 const DEFAULT: bool = true;
1402 const ONLY_HOSTS: bool = true;
1403 const ONLY_BUILD: bool = true;
1405 /// Test the build system itself
1406 fn run(self, builder: &Builder) {
1407 let build = builder.build;
1408 let mut cmd = Command::new(&build.initial_cargo);
1410 .current_dir(build.src.join("src/bootstrap"))
1411 .env("CARGO_TARGET_DIR", build.out.join("bootstrap"))
1412 .env("RUSTC_BOOTSTRAP", "1")
1413 .env("RUSTC", &build.initial_rustc);
1414 if !build.fail_fast {
1415 cmd.arg("--no-fail-fast");
1417 cmd.arg("--").args(&build.flags.cmd.test_args());
1418 try_run(build, &mut cmd);
1421 fn should_run(_builder: &Builder, path: &Path) -> bool {
1422 path.ends_with("src/bootstrap")
1425 fn make_run(builder: &Builder, _path: Option<&Path>, _host: &str, _target: &str) {
1426 builder.ensure(Bootstrap);