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", build.compiler_path(compiler))
174 .env("RUSTDOC", build.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 = build.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 static COMPILETESTS: &[(bool, &str, &str, &str)] = &[
448 // default, path, mode, suite
449 (true, "src/test/codegen", "codegen", "codegen"),
450 (true, "src/test/codegen-units", "codegen-units", "codegen-units"),
451 (true, "src/test/compile-fail", "compile-fail", "compile-fail"),
452 (true, "src/test/incremental", "incremental", "incremental"),
453 (true, "src/test/mir-opt", "mir-opt", "mir-opt"),
454 (true, "src/test/parse-fail", "parse-fail", "parse-fail"),
455 (true, "src/test/run-fail", "run-fail", "run-fail"),
456 (true, "src/test/run-pass", "run-pass", "run-pass"),
457 (true, "src/test/run-pass-valgrind", "run-pass-valgrind", "run-pass-valgrind"),
458 (true, "src/test/ui", "ui", "ui"),
459 (false, "src/test/debuginfo-lldb", "debuginfo-lldb", "debuginfo"),
460 (false, "src/test/debuginfo-gdb", "debuginfo-gdb", "debuginfo"),
462 // FIXME: What this runs varies depending on the native platform being apple
463 (true, "src/test/debuginfo", "debuginfo-XXX", "debuginfo"),
465 (true, "src/test/ui-fulldeps", "ui", "ui-fulldeps"),
466 (true, "src/test/run-pass-fulldeps", "run-pass", "run-pass-fulldeps"),
467 (true, "src/test/run-fail-fulldeps", "run-fail", "run-fail-fulldeps"),
468 (true, "src/test/compile-fail-fulldeps", "compile-fail", "compile-fail-fulldeps"),
469 (true, "src/test/run-make", "run-make", "run-make"),
470 (true, "src/test/rustdoc", "rustdoc", "rustdoc"),
472 (false, "src/test/pretty", "pretty", "pretty"),
473 (false, "src/test/run-pass/pretty", "pretty", "run-pass"),
474 (false, "src/test/run-fail/pretty", "pretty", "run-fail"),
475 (false, "src/test/run-pass-valgrind/pretty", "pretty", "run-pass-valgrind"),
476 (false, "src/test/run-pass-fulldeps/pretty", "pretty", "run-pass-fulldeps"),
477 (false, "src/test/run-fail-fulldeps/pretty", "pretty", "run-fail-fulldeps"),
481 impl<'a> Step<'a> for Compiletest<'a> {
483 const DEFAULT: bool = true;
485 fn should_run(_builder: &Builder, path: &Path) -> bool {
486 // Note that this is general, while a few more cases are skipped inside
487 // run() itself. This is to avoid duplication across should_run and
489 COMPILETESTS.iter().any(|&(_, test_path, _, _)| {
490 path.ends_with(test_path)
494 fn make_run(builder: &Builder, path: Option<&Path>, host: &str, target: &str) {
495 let compiler = builder.compiler(builder.top_stage, host);
497 let test = path.map(|path| {
498 COMPILETESTS.iter().find(|&&(_, test_path, _, _)| {
499 path.ends_with(test_path)
500 }).unwrap_or_else(|| {
501 panic!("make_run in compile test to receive test path, received {:?}", path);
505 if let Some(test) = test { // specific test
506 builder.ensure(Compiletest {
507 compiler, target, mode: test.2, suite: test.3
509 } else { // default tests
510 for &(default, _, mode, suite) in COMPILETESTS {
512 builder.ensure(Compiletest {
513 compiler, target, mode, suite
520 /// Executes the `compiletest` tool to run a suite of tests.
522 /// Compiles all tests with `compiler` for `target` with the specified
523 /// compiletest `mode` and `suite` arguments. For example `mode` can be
524 /// "run-pass" or `suite` can be something like `debuginfo`.
525 fn run(self, builder: &Builder) {
526 let build = builder.build;
527 let compiler = self.compiler;
528 let target = self.target;
529 let mode = self.mode;
530 let suite = self.suite;
532 // Skip codegen tests if they aren't enabled in configuration.
533 if !build.config.codegen_tests && suite == "codegen" {
537 if suite == "debuginfo" {
538 if mode == "debuginfo-XXX" {
539 return if build.build.contains("apple") {
540 builder.ensure(Compiletest {
541 mode: "debuginfo-lldb",
545 builder.ensure(Compiletest {
546 mode: "debuginfo-gdb",
552 // Skip debuginfo tests on MSVC
553 if build.build.contains("msvc") {
557 builder.ensure(dist::DebuggerScripts {
558 sysroot: &builder.sysroot(compiler),
563 if suite.ends_with("fulldeps") ||
564 // FIXME: Does pretty need librustc compiled? Note that there are
565 // fulldeps test suites with mode = pretty as well.
569 builder.ensure(compile::Rustc { compiler, target });
572 builder.ensure(compile::Test { compiler, target });
573 builder.ensure(native::TestHelpers { target });
575 if mode == "debuginfo-gdb" {
576 builder.ensure(RemoteCopyLibs { compiler, target });
579 let _folder = build.fold_output(|| format!("test_{}", suite));
580 println!("Check compiletest suite={} mode={} ({} -> {})",
581 suite, mode, compiler.host, target);
582 let mut cmd = builder.tool_cmd(Tool::Compiletest);
584 // compiletest currently has... a lot of arguments, so let's just pass all
587 cmd.arg("--compile-lib-path").arg(build.rustc_libdir(compiler));
588 cmd.arg("--run-lib-path").arg(builder.sysroot_libdir(compiler, target));
589 cmd.arg("--rustc-path").arg(build.compiler_path(compiler));
590 cmd.arg("--rustdoc-path").arg(build.rustdoc(compiler));
591 cmd.arg("--src-base").arg(build.src.join("src/test").join(suite));
592 cmd.arg("--build-base").arg(testdir(build, compiler.host).join(suite));
593 cmd.arg("--stage-id").arg(format!("stage{}-{}", compiler.stage, target));
594 cmd.arg("--mode").arg(mode);
595 cmd.arg("--target").arg(target);
596 cmd.arg("--host").arg(compiler.host);
597 cmd.arg("--llvm-filecheck").arg(build.llvm_filecheck(&build.build));
599 if let Some(ref nodejs) = build.config.nodejs {
600 cmd.arg("--nodejs").arg(nodejs);
603 let mut flags = vec!["-Crpath".to_string()];
604 if build.config.rust_optimize_tests {
605 flags.push("-O".to_string());
607 if build.config.rust_debuginfo_tests {
608 flags.push("-g".to_string());
611 let mut hostflags = build.rustc_flags(compiler.host);
612 hostflags.extend(flags.clone());
613 cmd.arg("--host-rustcflags").arg(hostflags.join(" "));
615 let mut targetflags = build.rustc_flags(&target);
616 targetflags.extend(flags);
617 targetflags.push(format!("-Lnative={}",
618 build.test_helpers_out(target).display()));
619 cmd.arg("--target-rustcflags").arg(targetflags.join(" "));
621 cmd.arg("--docck-python").arg(build.python());
623 if build.build.ends_with("apple-darwin") {
624 // Force /usr/bin/python on macOS for LLDB tests because we're loading the
625 // LLDB plugin's compiled module which only works with the system python
626 // (namely not Homebrew-installed python)
627 cmd.arg("--lldb-python").arg("/usr/bin/python");
629 cmd.arg("--lldb-python").arg(build.python());
632 if let Some(ref gdb) = build.config.gdb {
633 cmd.arg("--gdb").arg(gdb);
635 if let Some(ref vers) = build.lldb_version {
636 cmd.arg("--lldb-version").arg(vers);
638 if let Some(ref dir) = build.lldb_python_dir {
639 cmd.arg("--lldb-python-dir").arg(dir);
641 let llvm_config = build.llvm_config(target);
642 let llvm_version = output(Command::new(&llvm_config).arg("--version"));
643 cmd.arg("--llvm-version").arg(llvm_version);
644 if !build.is_rust_llvm(target) {
645 cmd.arg("--system-llvm");
648 cmd.args(&build.flags.cmd.test_args());
650 if build.is_verbose() {
651 cmd.arg("--verbose");
654 if build.config.quiet_tests {
658 // Only pass correct values for these flags for the `run-make` suite as it
659 // requires that a C++ compiler was configured which isn't always the case.
660 if suite == "run-make" {
661 let llvm_components = output(Command::new(&llvm_config).arg("--components"));
662 let llvm_cxxflags = output(Command::new(&llvm_config).arg("--cxxflags"));
663 cmd.arg("--cc").arg(build.cc(target))
664 .arg("--cxx").arg(build.cxx(target).unwrap())
665 .arg("--cflags").arg(build.cflags(target).join(" "))
666 .arg("--llvm-components").arg(llvm_components.trim())
667 .arg("--llvm-cxxflags").arg(llvm_cxxflags.trim());
669 cmd.arg("--cc").arg("")
670 .arg("--cxx").arg("")
671 .arg("--cflags").arg("")
672 .arg("--llvm-components").arg("")
673 .arg("--llvm-cxxflags").arg("");
676 if build.remote_tested(target) {
677 cmd.arg("--remote-test-client").arg(builder.tool_exe(Tool::RemoteTestClient));
680 // Running a C compiler on MSVC requires a few env vars to be set, to be
681 // sure to set them here.
683 // Note that if we encounter `PATH` we make sure to append to our own `PATH`
684 // rather than stomp over it.
685 if target.contains("msvc") {
686 for &(ref k, ref v) in build.cc[target].0.env() {
692 cmd.env("RUSTC_BOOTSTRAP", "1");
693 build.add_rust_test_threads(&mut cmd);
695 if build.config.sanitizers {
696 cmd.env("SANITIZER_SUPPORT", "1");
699 if build.config.profiler {
700 cmd.env("PROFILER_SUPPORT", "1");
703 cmd.arg("--adb-path").arg("adb");
704 cmd.arg("--adb-test-dir").arg(ADB_TEST_DIR);
705 if target.contains("android") {
706 // Assume that cc for this target comes from the android sysroot
707 cmd.arg("--android-cross-path")
708 .arg(build.cc(target).parent().unwrap().parent().unwrap());
710 cmd.arg("--android-cross-path").arg("");
713 build.ci_env.force_coloring_in_ci(&mut cmd);
715 let _time = util::timeit();
716 try_run(build, &mut cmd);
720 // rules.test("check-docs", "src/doc")
721 // .dep(|s| s.name("libtest"))
724 // .run(move |s| check::docs(build, &s.compiler()));
725 /// Run `rustdoc --test` for all documentation in `src/doc`.
727 /// This will run all tests in our markdown documentation (e.g. the book)
728 /// located in `src/doc`. The `rustdoc` that's run is the one that sits next to
730 pub fn docs(build: &Build, compiler: &Compiler) {
731 // Do a breadth-first traversal of the `src/doc` directory and just run
732 // tests for all files that end in `*.md`
733 let mut stack = vec![build.src.join("src/doc")];
734 let _time = util::timeit();
735 let _folder = build.fold_output(|| "test_docs");
737 while let Some(p) = stack.pop() {
739 stack.extend(t!(p.read_dir()).map(|p| t!(p).path()));
743 if p.extension().and_then(|s| s.to_str()) != Some("md") {
747 // The nostarch directory in the book is for no starch, and so isn't
748 // guaranteed to build. We don't care if it doesn't build, so skip it.
749 if p.to_str().map_or(false, |p| p.contains("nostarch")) {
753 markdown_test(build, compiler, &p);
757 //rules.test("check-error-index", "src/tools/error_index_generator")
758 // .dep(|s| s.name("libstd"))
759 // .dep(|s| s.name("tool-error-index").host(s.host).stage(0))
762 // .run(move |s| check::error_index(build, &s.compiler()));
765 pub struct ErrorIndex<'a> {
766 compiler: Compiler<'a>,
769 impl<'a> Step<'a> for ErrorIndex<'a> {
771 const DEFAULT: bool = true;
772 const ONLY_HOSTS: bool = true;
774 fn should_run(_builder: &Builder, path: &Path) -> bool {
775 path.ends_with("src/tools/error_index_generator")
778 fn make_run(builder: &Builder, _path: Option<&Path>, host: &str, _target: &str) {
779 builder.ensure(ErrorIndex {
780 compiler: builder.compiler(builder.top_stage, host),
784 /// Run the error index generator tool to execute the tests located in the error
787 /// The `error_index_generator` tool lives in `src/tools` and is used to
788 /// generate a markdown file from the error indexes of the code base which is
789 /// then passed to `rustdoc --test`.
790 fn run(self, builder: &Builder) {
791 let build = builder.build;
792 let compiler = self.compiler;
794 builder.ensure(compile::Std { compiler, target: compiler.host });
796 let _folder = build.fold_output(|| "test_error_index");
797 println!("Testing error-index stage{}", compiler.stage);
799 let dir = testdir(build, compiler.host);
800 t!(fs::create_dir_all(&dir));
801 let output = dir.join("error-index.md");
803 let _time = util::timeit();
804 build.run(builder.tool_cmd(Tool::ErrorIndex)
807 .env("CFG_BUILD", &build.build));
809 markdown_test(build, compiler, &output);
813 fn markdown_test(build: &Build, compiler: Compiler, markdown: &Path) {
814 let mut file = t!(File::open(markdown));
815 let mut contents = String::new();
816 t!(file.read_to_string(&mut contents));
817 if !contents.contains("```") {
821 println!("doc tests for: {}", markdown.display());
822 let mut cmd = Command::new(build.rustdoc(compiler));
823 build.add_rustc_lib_path(compiler, &mut cmd);
824 build.add_rust_test_threads(&mut cmd);
827 cmd.env("RUSTC_BOOTSTRAP", "1");
829 let test_args = build.flags.cmd.test_args().join(" ");
830 cmd.arg("--test-args").arg(test_args);
832 if build.config.quiet_tests {
833 try_run_quiet(build, &mut cmd);
835 try_run(build, &mut cmd);
839 // for (krate, path, _default) in krates("rustc-main") {
840 // rules.test(&krate.test_step, path)
841 // .dep(|s| s.name("librustc"))
842 // .dep(|s| s.name("remote-copy-libs"))
844 // .run(move |s| check::krate(build, &s.compiler(), s.target,
845 // Mode::Librustc, TestKind::Test,
846 // Some(&krate.name)));
848 // rules.test("check-rustc-all", "path/to/nowhere")
849 // .dep(|s| s.name("librustc"))
850 // .dep(|s| s.name("remote-copy-libs"))
853 // .run(move |s| check::krate(build, &s.compiler(), s.target,
854 // Mode::Librustc, TestKind::Test, None));
856 pub struct KrateLibrustc<'a> {
857 compiler: Compiler<'a>,
860 krate: Option<&'a str>,
863 impl<'a> Step<'a> for KrateLibrustc<'a> {
865 const DEFAULT: bool = true;
866 const ONLY_HOSTS: bool = true;
868 fn should_run(builder: &Builder, path: &Path) -> bool {
869 builder.crates("rustc-main").into_iter().any(|(_, krate_path)| {
870 path.ends_with(krate_path)
874 fn make_run(builder: &Builder, path: Option<&Path>, host: &str, target: &str) {
875 let compiler = builder.compiler(builder.top_stage, host);
877 let run = |name: Option<&str>| {
878 let test_kind = if builder.kind == Kind::Test {
880 } else if builder.kind == Kind::Bench {
883 panic!("unexpected builder.kind in Krate: {:?}", builder.kind);
886 builder.ensure(KrateLibrustc {
889 test_kind: test_kind,
894 if let Some(path) = path {
895 for (name, krate_path) in builder.crates("rustc-main") {
896 if path.ends_with(krate_path) {
906 fn run(self, builder: &Builder) {
907 builder.ensure(Krate {
908 compiler: self.compiler,
910 mode: Mode::Librustc,
911 test_kind: self.test_kind,
918 // for (krate, path, _default) in krates("std") {
919 // rules.test(&krate.test_step, path)
920 // .dep(|s| s.name("libtest"))
921 // .dep(|s| s.name("remote-copy-libs"))
922 // .run(move |s| check::krate(build, &s.compiler(), s.target,
923 // Mode::Libstd, TestKind::Test,
924 // Some(&krate.name)));
926 // rules.test("check-std-all", "path/to/nowhere")
927 // .dep(|s| s.name("libtest"))
928 // .dep(|s| s.name("remote-copy-libs"))
930 // .run(move |s| check::krate(build, &s.compiler(), s.target,
931 // Mode::Libstd, TestKind::Test, None));
934 // for (krate, path, _default) in krates("std") {
935 // rules.bench(&krate.bench_step, path)
936 // .dep(|s| s.name("libtest"))
937 // .dep(|s| s.name("remote-copy-libs"))
938 // .run(move |s| check::krate(build, &s.compiler(), s.target,
939 // Mode::Libstd, TestKind::Bench,
940 // Some(&krate.name)));
942 // rules.bench("bench-std-all", "path/to/nowhere")
943 // .dep(|s| s.name("libtest"))
944 // .dep(|s| s.name("remote-copy-libs"))
946 // .run(move |s| check::krate(build, &s.compiler(), s.target,
947 // Mode::Libstd, TestKind::Bench, None));
949 // for (krate, path, _default) in krates("test") {
950 // rules.test(&krate.test_step, path)
951 // .dep(|s| s.name("libtest"))
952 // .dep(|s| s.name("remote-copy-libs"))
953 // .run(move |s| check::krate(build, &s.compiler(), s.target,
954 // Mode::Libtest, TestKind::Test,
955 // Some(&krate.name)));
957 // rules.test("check-test-all", "path/to/nowhere")
958 // .dep(|s| s.name("libtest"))
959 // .dep(|s| s.name("remote-copy-libs"))
961 // .run(move |s| check::krate(build, &s.compiler(), s.target,
962 // Mode::Libtest, TestKind::Test, None));
965 pub struct Krate<'a> {
966 compiler: Compiler<'a>,
970 krate: Option<&'a str>,
973 impl<'a> Step<'a> for Krate<'a> {
975 const DEFAULT: bool = true;
977 fn should_run(builder: &Builder, path: &Path) -> bool {
978 builder.crates("std").into_iter().any(|(_, krate_path)| {
979 path.ends_with(krate_path)
981 builder.crates("test").into_iter().any(|(_, krate_path)| {
982 path.ends_with(krate_path)
986 fn make_run(builder: &Builder, path: Option<&Path>, host: &str, target: &str) {
987 let compiler = builder.compiler(builder.top_stage, host);
989 let run = |mode: Mode, name: Option<&str>| {
990 let test_kind = if builder.kind == Kind::Test {
992 } else if builder.kind == Kind::Bench {
995 panic!("unexpected builder.kind in Krate: {:?}", builder.kind);
998 builder.ensure(Krate {
1001 test_kind: test_kind,
1006 if let Some(path) = path {
1007 for (name, krate_path) in builder.crates("std") {
1008 if path.ends_with(krate_path) {
1009 run(Mode::Libstd, Some(name));
1012 for (name, krate_path) in builder.crates("test") {
1013 if path.ends_with(krate_path) {
1014 run(Mode::Libtest, Some(name));
1018 run(Mode::Libstd, None);
1019 run(Mode::Libtest, None);
1023 /// Run all unit tests plus documentation tests for an entire crate DAG defined
1024 /// by a `Cargo.toml`
1026 /// This is what runs tests for crates like the standard library, compiler, etc.
1027 /// It essentially is the driver for running `cargo test`.
1029 /// Currently this runs all tests for a DAG by passing a bunch of `-p foo`
1030 /// arguments, and those arguments are discovered from `cargo metadata`.
1031 fn run(self, builder: &Builder) {
1032 let build = builder.build;
1033 let compiler = self.compiler;
1034 let target = self.target;
1035 let mode = self.mode;
1036 let test_kind = self.test_kind;
1037 let krate = self.krate;
1039 builder.ensure(compile::Test { compiler, target });
1040 builder.ensure(RemoteCopyLibs { compiler, target });
1041 let (name, path, features, root) = match mode {
1043 ("libstd", "src/libstd", build.std_features(), "std")
1046 ("libtest", "src/libtest", String::new(), "test")
1049 ("librustc", "src/rustc", build.rustc_features(), "rustc-main")
1051 _ => panic!("can only test libraries"),
1053 let _folder = build.fold_output(|| {
1054 format!("{}_stage{}-{}", test_kind.subcommand(), compiler.stage, name)
1056 println!("{} {} stage{} ({} -> {})", test_kind, name, compiler.stage,
1057 compiler.host, target);
1059 // If we're not doing a full bootstrap but we're testing a stage2 version of
1060 // libstd, then what we're actually testing is the libstd produced in
1061 // stage1. Reflect that here by updating the compiler that we're working
1062 // with automatically.
1063 let compiler = if build.force_use_stage1(compiler, target) {
1064 builder.compiler(1, compiler.host)
1069 // Build up the base `cargo test` command.
1071 // Pass in some standard flags then iterate over the graph we've discovered
1072 // in `cargo metadata` with the maps above and figure out what `-p`
1073 // arguments need to get passed.
1074 let mut cargo = build.cargo(compiler, mode, target, test_kind.subcommand());
1075 cargo.arg("--manifest-path")
1076 .arg(build.src.join(path).join("Cargo.toml"))
1077 .arg("--features").arg(features);
1078 if test_kind.subcommand() == "test" && !build.fail_fast {
1079 cargo.arg("--no-fail-fast");
1084 cargo.arg("-p").arg(krate);
1087 let mut visited = HashSet::new();
1088 let mut next = vec![root];
1089 while let Some(name) = next.pop() {
1090 // Right now jemalloc is our only target-specific crate in the
1091 // sense that it's not present on all platforms. Custom skip it
1092 // here for now, but if we add more this probably wants to get
1093 // more generalized.
1095 // Also skip `build_helper` as it's not compiled normally for
1096 // target during the bootstrap and it's just meant to be a
1097 // helper crate, not tested. If it leaks through then it ends up
1098 // messing with various mtime calculations and such.
1099 if !name.contains("jemalloc") && name != "build_helper" {
1100 cargo.arg("-p").arg(&format!("{}:0.0.0", name));
1102 for dep in build.crates[name].deps.iter() {
1103 if visited.insert(dep) {
1111 // The tests are going to run with the *target* libraries, so we need to
1112 // ensure that those libraries show up in the LD_LIBRARY_PATH equivalent.
1114 // Note that to run the compiler we need to run with the *host* libraries,
1115 // but our wrapper scripts arrange for that to be the case anyway.
1116 let mut dylib_path = dylib_path();
1117 dylib_path.insert(0, builder.sysroot_libdir(compiler, target));
1118 cargo.env(dylib_path_var(), env::join_paths(&dylib_path).unwrap());
1120 if target.contains("emscripten") || build.remote_tested(target) {
1121 cargo.arg("--no-run");
1126 if build.config.quiet_tests {
1127 cargo.arg("--quiet");
1130 let _time = util::timeit();
1132 if target.contains("emscripten") {
1133 build.run(&mut cargo);
1134 krate_emscripten(build, compiler, target, mode);
1135 } else if build.remote_tested(target) {
1136 build.run(&mut cargo);
1137 krate_remote(builder, compiler, target, mode);
1139 cargo.args(&build.flags.cmd.test_args());
1140 try_run(build, &mut cargo);
1145 fn krate_emscripten(build: &Build,
1149 let out_dir = build.cargo_out(compiler, mode, target);
1150 let tests = find_tests(&out_dir.join("deps"), target);
1152 let nodejs = build.config.nodejs.as_ref().expect("nodejs not configured");
1154 println!("running {}", test.display());
1155 let mut cmd = Command::new(nodejs);
1157 if build.config.quiet_tests {
1160 try_run(build, &mut cmd);
1164 fn krate_remote(builder: &Builder,
1168 let build = builder.build;
1169 let out_dir = build.cargo_out(compiler, mode, target);
1170 let tests = find_tests(&out_dir.join("deps"), target);
1172 let tool = builder.tool_exe(Tool::RemoteTestClient);
1174 let mut cmd = Command::new(&tool);
1177 if build.config.quiet_tests {
1180 cmd.args(&build.flags.cmd.test_args());
1181 try_run(build, &mut cmd);
1185 fn find_tests(dir: &Path, target: &str) -> Vec<PathBuf> {
1186 let mut dst = Vec::new();
1187 for e in t!(dir.read_dir()).map(|e| t!(e)) {
1188 let file_type = t!(e.file_type());
1189 if !file_type.is_file() {
1192 let filename = e.file_name().into_string().unwrap();
1193 if (target.contains("windows") && filename.ends_with(".exe")) ||
1194 (!target.contains("windows") && !filename.contains(".")) ||
1195 (target.contains("emscripten") &&
1196 filename.ends_with(".js") &&
1197 !filename.ends_with(".asm.js")) {
1204 // // Some test suites are run inside emulators or on remote devices, and most
1205 // // of our test binaries are linked dynamically which means we need to ship
1206 // // the standard library and such to the emulator ahead of time. This step
1207 // // represents this and is a dependency of all test suites.
1209 // // Most of the time this step is a noop (the `check::emulator_copy_libs`
1210 // // only does work if necessary). For some steps such as shipping data to
1211 // // QEMU we have to build our own tools so we've got conditional dependencies
1212 // // on those programs as well. Note that the remote test client is built for
1213 // // the build target (us) and the server is built for the target.
1214 // rules.test("remote-copy-libs", "path/to/nowhere")
1215 // .dep(|s| s.name("libtest"))
1217 // if build.remote_tested(s.target) {
1218 // s.name("tool-remote-test-client").target(s.host).stage(0)
1224 // if build.remote_tested(s.target) {
1225 // s.name("tool-remote-test-server")
1230 // .run(move |s| check::remote_copy_libs(build, &s.compiler(), s.target));
1233 #[derive(Serialize)]
1234 pub struct RemoteCopyLibs<'a> {
1235 compiler: Compiler<'a>,
1239 impl<'a> Step<'a> for RemoteCopyLibs<'a> {
1242 fn run(self, builder: &Builder) {
1243 let build = builder.build;
1244 let compiler = self.compiler;
1245 let target = self.target;
1246 if !build.remote_tested(target) {
1250 builder.ensure(compile::Test { compiler, target });
1252 println!("REMOTE copy libs to emulator ({})", target);
1253 t!(fs::create_dir_all(build.out.join("tmp")));
1255 // FIXME: This builds the tool for the native build triple
1256 // (build.build); that is probably wrong. Should build for target.
1257 let server = builder.tool_exe(Tool::RemoteTestServer);
1259 // Spawn the emulator and wait for it to come online
1260 let tool = builder.tool_exe(Tool::RemoteTestClient);
1261 let mut cmd = Command::new(&tool);
1262 cmd.arg("spawn-emulator")
1265 .arg(build.out.join("tmp"));
1266 if let Some(rootfs) = build.qemu_rootfs(target) {
1269 build.run(&mut cmd);
1271 // Push all our dylibs to the emulator
1272 for f in t!(builder.sysroot_libdir(compiler, target).read_dir()) {
1274 let name = f.file_name().into_string().unwrap();
1275 if util::is_dylib(&name) {
1276 build.run(Command::new(&tool)
1284 //rules.test("check-distcheck", "distcheck")
1285 // .dep(|s| s.name("dist-plain-source-tarball"))
1286 // .dep(|s| s.name("dist-src"))
1287 // .run(move |_| check::distcheck(build));
1289 #[derive(Serialize)]
1290 pub struct Distcheck;
1292 impl<'a> Step<'a> for Distcheck {
1295 /// Run "distcheck", a 'make check' from a tarball
1296 fn run(self, builder: &Builder) {
1297 let build = builder.build;
1299 if build.build != "x86_64-unknown-linux-gnu" {
1302 if !build.config.host.iter().any(|s| s == "x86_64-unknown-linux-gnu") {
1305 if !build.config.target.iter().any(|s| s == "x86_64-unknown-linux-gnu") {
1309 builder.ensure(dist::PlainSourceTarball);
1310 builder.ensure(dist::Src);
1312 println!("Distcheck");
1313 let dir = build.out.join("tmp").join("distcheck");
1314 let _ = fs::remove_dir_all(&dir);
1315 t!(fs::create_dir_all(&dir));
1317 let mut cmd = Command::new("tar");
1319 .arg(dist::rust_src_location(build))
1320 .arg("--strip-components=1")
1322 build.run(&mut cmd);
1323 build.run(Command::new("./configure")
1324 .args(&build.config.configure_args)
1325 .arg("--enable-vendor")
1326 .current_dir(&dir));
1327 build.run(Command::new(build_helper::make(&build.build))
1329 .current_dir(&dir));
1331 // Now make sure that rust-src has all of libstd's dependencies
1332 println!("Distcheck rust-src");
1333 let dir = build.out.join("tmp").join("distcheck-src");
1334 let _ = fs::remove_dir_all(&dir);
1335 t!(fs::create_dir_all(&dir));
1337 let mut cmd = Command::new("tar");
1339 .arg(dist::rust_src_installer(build))
1340 .arg("--strip-components=1")
1342 build.run(&mut cmd);
1344 let toml = dir.join("rust-src/lib/rustlib/src/rust/src/libstd/Cargo.toml");
1345 build.run(Command::new(&build.initial_cargo)
1346 .arg("generate-lockfile")
1347 .arg("--manifest-path")
1349 .current_dir(&dir));
1353 //rules.test("check-bootstrap", "src/bootstrap")
1356 // .only_build(true)
1357 // .run(move |_| check::bootstrap(build));
1359 #[derive(Serialize)]
1360 pub struct Bootstrap;
1362 impl<'a> Step<'a> for Bootstrap {
1364 const DEFAULT: bool = true;
1365 const ONLY_HOSTS: bool = true;
1366 const ONLY_BUILD: bool = true;
1368 /// Test the build system itself
1369 fn run(self, builder: &Builder) {
1370 let build = builder.build;
1371 let mut cmd = Command::new(&build.initial_cargo);
1373 .current_dir(build.src.join("src/bootstrap"))
1374 .env("CARGO_TARGET_DIR", build.out.join("bootstrap"))
1375 .env("RUSTC_BOOTSTRAP", "1")
1376 .env("RUSTC", &build.initial_rustc);
1377 if !build.fail_fast {
1378 cmd.arg("--no-fail-fast");
1380 cmd.arg("--").args(&build.flags.cmd.test_args());
1381 try_run(build, &mut cmd);
1384 fn should_run(_builder: &Builder, path: &Path) -> bool {
1385 path.ends_with("src/bootstrap")
1388 fn make_run(builder: &Builder, _path: Option<&Path>, _host: &str, _target: &str) {
1389 builder.ensure(Bootstrap);