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 extern crate build_helper;
18 use std::collections::HashSet;
22 use std::path::{PathBuf, Path};
23 use std::process::Command;
25 use build_helper::output;
27 use {Build, Compiler, Mode};
29 use util::{self, dylib_path, dylib_path_var, exe};
31 const ADB_TEST_DIR: &'static str = "/data/tmp/work";
33 /// The two modes of the test runner; tests or benchmarks.
34 #[derive(Copy, Clone)]
43 // Return the cargo subcommand for this test kind
44 fn subcommand(self) -> &'static str {
46 TestKind::Test => "test",
47 TestKind::Bench => "bench",
52 impl fmt::Display for TestKind {
53 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
54 f.write_str(match *self {
55 TestKind::Test => "Testing",
56 TestKind::Bench => "Benchmarking",
61 fn try_run(build: &Build, cmd: &mut Command) {
62 if build.flags.cmd.no_fail_fast() {
63 if !build.try_run(cmd) {
64 let failures = build.delayed_failures.get();
65 build.delayed_failures.set(failures + 1);
72 fn try_run_quiet(build: &Build, cmd: &mut Command) {
73 if build.flags.cmd.no_fail_fast() {
74 if !build.try_run_quiet(cmd) {
75 let failures = build.delayed_failures.get();
76 build.delayed_failures.set(failures + 1);
83 /// Runs the `linkchecker` tool as compiled in `stage` by the `host` compiler.
85 /// This tool in `src/tools` will verify the validity of all our links in the
86 /// documentation to ensure we don't have a bunch of dead ones.
87 pub fn linkcheck(build: &Build, host: &str) {
88 println!("Linkcheck ({})", host);
89 let compiler = Compiler::new(0, host);
91 let _time = util::timeit();
92 try_run(build, build.tool_cmd(&compiler, "linkchecker")
93 .arg(build.out.join(host).join("doc")));
96 /// Runs the `cargotest` tool as compiled in `stage` by the `host` compiler.
98 /// This tool in `src/tools` will check out a few Rust projects and run `cargo
99 /// test` to ensure that we don't regress the test suites there.
100 pub fn cargotest(build: &Build, stage: u32, host: &str) {
101 let ref compiler = Compiler::new(stage, host);
103 // Note that this is a short, cryptic, and not scoped directory name. This
104 // is currently to minimize the length of path on Windows where we otherwise
105 // quickly run into path name limit constraints.
106 let out_dir = build.out.join("ct");
107 t!(fs::create_dir_all(&out_dir));
109 let _time = util::timeit();
110 let mut cmd = Command::new(build.tool(&Compiler::new(0, host), "cargotest"));
111 build.prepare_tool_cmd(compiler, &mut cmd);
112 try_run(build, cmd.arg(&build.cargo)
114 .env("RUSTC", build.compiler_path(compiler))
115 .env("RUSTDOC", build.rustdoc(compiler)));
118 /// Runs `cargo test` for `cargo` packaged with Rust.
119 pub fn cargo(build: &Build, stage: u32, host: &str) {
120 let ref compiler = Compiler::new(stage, host);
122 // Configure PATH to find the right rustc. NB. we have to use PATH
123 // and not RUSTC because the Cargo test suite has tests that will
124 // fail if rustc is not spelled `rustc`.
125 let path = build.sysroot(compiler).join("bin");
126 let old_path = ::std::env::var("PATH").expect("");
127 let sep = if cfg!(windows) { ";" } else {":" };
128 let ref newpath = format!("{}{}{}", path.display(), sep, old_path);
130 let mut cargo = build.cargo(compiler, Mode::Tool, host, "test");
131 cargo.arg("--manifest-path").arg(build.src.join("src/tools/cargo/Cargo.toml"));
132 if build.flags.cmd.no_fail_fast() {
133 cargo.arg("--no-fail-fast");
136 // Don't build tests dynamically, just a pain to work with
137 cargo.env("RUSTC_NO_PREFER_DYNAMIC", "1");
139 // Don't run cross-compile tests, we may not have cross-compiled libstd libs
141 cargo.env("CFG_DISABLE_CROSS_TESTS", "1");
143 try_run(build, cargo.env("PATH", newpath));
146 /// Runs the `tidy` tool as compiled in `stage` by the `host` compiler.
148 /// This tool in `src/tools` checks up on various bits and pieces of style and
149 /// otherwise just implements a few lint-like checks that are specific to the
151 pub fn tidy(build: &Build, host: &str) {
152 let _folder = build.fold_output(|| "tidy");
153 println!("tidy check ({})", host);
154 let compiler = Compiler::new(0, host);
155 let mut cmd = build.tool_cmd(&compiler, "tidy");
156 cmd.arg(build.src.join("src"));
157 if !build.config.vendor {
158 cmd.arg("--no-vendor");
160 if build.config.quiet_tests {
163 try_run(build, &mut cmd);
166 fn testdir(build: &Build, host: &str) -> PathBuf {
167 build.out.join(host).join("test")
170 /// Executes the `compiletest` tool to run a suite of tests.
172 /// Compiles all tests with `compiler` for `target` with the specified
173 /// compiletest `mode` and `suite` arguments. For example `mode` can be
174 /// "run-pass" or `suite` can be something like `debuginfo`.
175 pub fn compiletest(build: &Build,
180 let _folder = build.fold_output(|| format!("test_{}", suite));
181 println!("Check compiletest suite={} mode={} ({} -> {})",
182 suite, mode, compiler.host, target);
183 let mut cmd = Command::new(build.tool(&Compiler::new(0, compiler.host),
185 build.prepare_tool_cmd(compiler, &mut cmd);
187 // compiletest currently has... a lot of arguments, so let's just pass all
190 cmd.arg("--compile-lib-path").arg(build.rustc_libdir(compiler));
191 cmd.arg("--run-lib-path").arg(build.sysroot_libdir(compiler, target));
192 cmd.arg("--rustc-path").arg(build.compiler_path(compiler));
193 cmd.arg("--rustdoc-path").arg(build.rustdoc(compiler));
194 cmd.arg("--src-base").arg(build.src.join("src/test").join(suite));
195 cmd.arg("--build-base").arg(testdir(build, compiler.host).join(suite));
196 cmd.arg("--stage-id").arg(format!("stage{}-{}", compiler.stage, target));
197 cmd.arg("--mode").arg(mode);
198 cmd.arg("--target").arg(target);
199 cmd.arg("--host").arg(compiler.host);
200 cmd.arg("--llvm-filecheck").arg(build.llvm_filecheck(&build.config.build));
202 if let Some(nodejs) = build.config.nodejs.as_ref() {
203 cmd.arg("--nodejs").arg(nodejs);
206 let mut flags = vec!["-Crpath".to_string()];
207 if build.config.rust_optimize_tests {
208 flags.push("-O".to_string());
210 if build.config.rust_debuginfo_tests {
211 flags.push("-g".to_string());
214 let mut hostflags = build.rustc_flags(&compiler.host);
215 hostflags.extend(flags.clone());
216 cmd.arg("--host-rustcflags").arg(hostflags.join(" "));
218 let mut targetflags = build.rustc_flags(&target);
219 targetflags.extend(flags);
220 targetflags.push(format!("-Lnative={}",
221 build.test_helpers_out(target).display()));
222 cmd.arg("--target-rustcflags").arg(targetflags.join(" "));
224 cmd.arg("--docck-python").arg(build.python());
226 if build.config.build.ends_with("apple-darwin") {
227 // Force /usr/bin/python on macOS for LLDB tests because we're loading the
228 // LLDB plugin's compiled module which only works with the system python
229 // (namely not Homebrew-installed python)
230 cmd.arg("--lldb-python").arg("/usr/bin/python");
232 cmd.arg("--lldb-python").arg(build.python());
235 if let Some(ref gdb) = build.config.gdb {
236 cmd.arg("--gdb").arg(gdb);
238 if let Some(ref vers) = build.lldb_version {
239 cmd.arg("--lldb-version").arg(vers);
241 if let Some(ref dir) = build.lldb_python_dir {
242 cmd.arg("--lldb-python-dir").arg(dir);
244 let llvm_config = build.llvm_config(target);
245 let llvm_version = output(Command::new(&llvm_config).arg("--version"));
246 cmd.arg("--llvm-version").arg(llvm_version);
248 cmd.args(&build.flags.cmd.test_args());
250 if build.config.verbose() || build.flags.verbose() {
251 cmd.arg("--verbose");
254 if build.config.quiet_tests {
258 // Only pass correct values for these flags for the `run-make` suite as it
259 // requires that a C++ compiler was configured which isn't always the case.
260 if suite == "run-make" {
261 let llvm_components = output(Command::new(&llvm_config).arg("--components"));
262 let llvm_cxxflags = output(Command::new(&llvm_config).arg("--cxxflags"));
263 cmd.arg("--cc").arg(build.cc(target))
264 .arg("--cxx").arg(build.cxx(target))
265 .arg("--cflags").arg(build.cflags(target).join(" "))
266 .arg("--llvm-components").arg(llvm_components.trim())
267 .arg("--llvm-cxxflags").arg(llvm_cxxflags.trim());
269 cmd.arg("--cc").arg("")
270 .arg("--cxx").arg("")
271 .arg("--cflags").arg("")
272 .arg("--llvm-components").arg("")
273 .arg("--llvm-cxxflags").arg("");
276 if build.remote_tested(target) {
277 cmd.arg("--remote-test-client")
278 .arg(build.tool(&Compiler::new(0, &build.config.build),
279 "remote-test-client"));
282 // Running a C compiler on MSVC requires a few env vars to be set, to be
283 // sure to set them here.
285 // Note that if we encounter `PATH` we make sure to append to our own `PATH`
286 // rather than stomp over it.
287 if target.contains("msvc") {
288 for &(ref k, ref v) in build.cc[target].0.env() {
294 cmd.env("RUSTC_BOOTSTRAP", "1");
295 build.add_rust_test_threads(&mut cmd);
297 if build.config.sanitizers {
298 cmd.env("SANITIZER_SUPPORT", "1");
301 cmd.arg("--adb-path").arg("adb");
302 cmd.arg("--adb-test-dir").arg(ADB_TEST_DIR);
303 if target.contains("android") {
304 // Assume that cc for this target comes from the android sysroot
305 cmd.arg("--android-cross-path")
306 .arg(build.cc(target).parent().unwrap().parent().unwrap());
308 cmd.arg("--android-cross-path").arg("");
311 build.ci_env.force_coloring_in_ci(&mut cmd);
313 let _time = util::timeit();
314 try_run(build, &mut cmd);
317 /// Run `rustdoc --test` for all documentation in `src/doc`.
319 /// This will run all tests in our markdown documentation (e.g. the book)
320 /// located in `src/doc`. The `rustdoc` that's run is the one that sits next to
322 pub fn docs(build: &Build, compiler: &Compiler) {
323 // Do a breadth-first traversal of the `src/doc` directory and just run
324 // tests for all files that end in `*.md`
325 let mut stack = vec![build.src.join("src/doc")];
326 let _time = util::timeit();
327 let _folder = build.fold_output(|| "test_docs");
329 while let Some(p) = stack.pop() {
331 stack.extend(t!(p.read_dir()).map(|p| t!(p).path()));
335 if p.extension().and_then(|s| s.to_str()) != Some("md") {
339 // The nostarch directory in the book is for no starch, and so isn't guaranteed to build.
340 // we don't care if it doesn't build, so skip it.
342 let path: &OsStr = p.as_ref();
343 if let Some(path) = path.to_str() {
344 if path.contains("nostarch") {
349 println!("doc tests for: {}", p.display());
350 markdown_test(build, compiler, &p);
354 /// Run the error index generator tool to execute the tests located in the error
357 /// The `error_index_generator` tool lives in `src/tools` and is used to
358 /// generate a markdown file from the error indexes of the code base which is
359 /// then passed to `rustdoc --test`.
360 pub fn error_index(build: &Build, compiler: &Compiler) {
361 let _folder = build.fold_output(|| "test_error_index");
362 println!("Testing error-index stage{}", compiler.stage);
364 let dir = testdir(build, compiler.host);
365 t!(fs::create_dir_all(&dir));
366 let output = dir.join("error-index.md");
368 let _time = util::timeit();
369 build.run(build.tool_cmd(&Compiler::new(0, compiler.host),
370 "error_index_generator")
373 .env("CFG_BUILD", &build.config.build));
375 markdown_test(build, compiler, &output);
378 fn markdown_test(build: &Build, compiler: &Compiler, markdown: &Path) {
379 let mut cmd = Command::new(build.rustdoc(compiler));
380 build.add_rustc_lib_path(compiler, &mut cmd);
381 build.add_rust_test_threads(&mut cmd);
384 cmd.env("RUSTC_BOOTSTRAP", "1");
386 let test_args = build.flags.cmd.test_args().join(" ");
387 cmd.arg("--test-args").arg(test_args);
389 if build.config.quiet_tests {
390 try_run_quiet(build, &mut cmd);
392 try_run(build, &mut cmd);
396 /// Run all unit tests plus documentation tests for an entire crate DAG defined
397 /// by a `Cargo.toml`
399 /// This is what runs tests for crates like the standard library, compiler, etc.
400 /// It essentially is the driver for running `cargo test`.
402 /// Currently this runs all tests for a DAG by passing a bunch of `-p foo`
403 /// arguments, and those arguments are discovered from `cargo metadata`.
404 pub fn krate(build: &Build,
409 krate: Option<&str>) {
410 let (name, path, features, root) = match mode {
412 ("libstd", "src/libstd", build.std_features(), "std")
415 ("libtest", "src/libtest", String::new(), "test")
418 ("librustc", "src/rustc", build.rustc_features(), "rustc-main")
420 _ => panic!("can only test libraries"),
422 let _folder = build.fold_output(|| {
423 format!("{}_stage{}-{}", test_kind.subcommand(), compiler.stage, name)
425 println!("{} {} stage{} ({} -> {})", test_kind, name, compiler.stage,
426 compiler.host, target);
428 // If we're not doing a full bootstrap but we're testing a stage2 version of
429 // libstd, then what we're actually testing is the libstd produced in
430 // stage1. Reflect that here by updating the compiler that we're working
431 // with automatically.
432 let compiler = if build.force_use_stage1(compiler, target) {
433 Compiler::new(1, compiler.host)
438 // Build up the base `cargo test` command.
440 // Pass in some standard flags then iterate over the graph we've discovered
441 // in `cargo metadata` with the maps above and figure out what `-p`
442 // arguments need to get passed.
443 let mut cargo = build.cargo(&compiler, mode, target, test_kind.subcommand());
444 cargo.arg("--manifest-path")
445 .arg(build.src.join(path).join("Cargo.toml"))
446 .arg("--features").arg(features);
447 if test_kind.subcommand() == "test" && build.flags.cmd.no_fail_fast() {
448 cargo.arg("--no-fail-fast");
453 cargo.arg("-p").arg(krate);
456 let mut visited = HashSet::new();
457 let mut next = vec![root];
458 while let Some(name) = next.pop() {
459 // Right now jemalloc is our only target-specific crate in the
460 // sense that it's not present on all platforms. Custom skip it
461 // here for now, but if we add more this probably wants to get
464 // Also skip `build_helper` as it's not compiled normally for
465 // target during the bootstrap and it's just meant to be a
466 // helper crate, not tested. If it leaks through then it ends up
467 // messing with various mtime calculations and such.
468 if !name.contains("jemalloc") && name != "build_helper" {
469 cargo.arg("-p").arg(&format!("{}:0.0.0", name));
471 for dep in build.crates[name].deps.iter() {
472 if visited.insert(dep) {
480 // The tests are going to run with the *target* libraries, so we need to
481 // ensure that those libraries show up in the LD_LIBRARY_PATH equivalent.
483 // Note that to run the compiler we need to run with the *host* libraries,
484 // but our wrapper scripts arrange for that to be the case anyway.
485 let mut dylib_path = dylib_path();
486 dylib_path.insert(0, build.sysroot_libdir(&compiler, target));
487 cargo.env(dylib_path_var(), env::join_paths(&dylib_path).unwrap());
489 if target.contains("emscripten") || build.remote_tested(target) {
490 cargo.arg("--no-run");
495 if build.config.quiet_tests {
496 cargo.arg("--quiet");
499 let _time = util::timeit();
501 if target.contains("emscripten") {
502 build.run(&mut cargo);
503 krate_emscripten(build, &compiler, target, mode);
504 } else if build.remote_tested(target) {
505 build.run(&mut cargo);
506 krate_remote(build, &compiler, target, mode);
508 cargo.args(&build.flags.cmd.test_args());
509 try_run(build, &mut cargo);
513 fn krate_emscripten(build: &Build,
517 let mut tests = Vec::new();
518 let out_dir = build.cargo_out(compiler, mode, target);
519 find_tests(&out_dir.join("deps"), target, &mut tests);
522 let test_file_name = test.to_string_lossy().into_owned();
523 println!("running {}", test_file_name);
524 let nodejs = build.config.nodejs.as_ref().expect("nodejs not configured");
525 let mut cmd = Command::new(nodejs);
526 cmd.arg(&test_file_name);
527 if build.config.quiet_tests {
530 try_run(build, &mut cmd);
534 fn krate_remote(build: &Build,
538 let mut tests = Vec::new();
539 let out_dir = build.cargo_out(compiler, mode, target);
540 find_tests(&out_dir.join("deps"), target, &mut tests);
542 let tool = build.tool(&Compiler::new(0, &build.config.build),
543 "remote-test-client");
545 let mut cmd = Command::new(&tool);
548 if build.config.quiet_tests {
551 cmd.args(&build.flags.cmd.test_args());
552 try_run(build, &mut cmd);
556 fn find_tests(dir: &Path,
558 dst: &mut Vec<PathBuf>) {
559 for e in t!(dir.read_dir()).map(|e| t!(e)) {
560 let file_type = t!(e.file_type());
561 if !file_type.is_file() {
564 let filename = e.file_name().into_string().unwrap();
565 if (target.contains("windows") && filename.ends_with(".exe")) ||
566 (!target.contains("windows") && !filename.contains(".")) ||
567 (target.contains("emscripten") && filename.ends_with(".js")) {
573 pub fn remote_copy_libs(build: &Build, compiler: &Compiler, target: &str) {
574 if !build.remote_tested(target) {
578 println!("REMOTE copy libs to emulator ({})", target);
579 t!(fs::create_dir_all(build.out.join("tmp")));
581 let server = build.cargo_out(compiler, Mode::Tool, target)
582 .join(exe("remote-test-server", target));
584 // Spawn the emulator and wait for it to come online
585 let tool = build.tool(&Compiler::new(0, &build.config.build),
586 "remote-test-client");
587 let mut cmd = Command::new(&tool);
588 cmd.arg("spawn-emulator")
591 .arg(build.out.join("tmp"));
592 if let Some(rootfs) = build.qemu_rootfs(target) {
597 // Push all our dylibs to the emulator
598 for f in t!(build.sysroot_libdir(compiler, target).read_dir()) {
600 let name = f.file_name().into_string().unwrap();
601 if util::is_dylib(&name) {
602 build.run(Command::new(&tool)
609 /// Run "distcheck", a 'make check' from a tarball
610 pub fn distcheck(build: &Build) {
611 if build.config.build != "x86_64-unknown-linux-gnu" {
614 if !build.config.host.iter().any(|s| s == "x86_64-unknown-linux-gnu") {
617 if !build.config.target.iter().any(|s| s == "x86_64-unknown-linux-gnu") {
621 println!("Distcheck");
622 let dir = build.out.join("tmp").join("distcheck");
623 let _ = fs::remove_dir_all(&dir);
624 t!(fs::create_dir_all(&dir));
626 let mut cmd = Command::new("tar");
628 .arg(dist::rust_src_location(build))
629 .arg("--strip-components=1")
632 build.run(Command::new("./configure")
633 .args(&build.config.configure_args)
634 .arg("--enable-vendor")
636 build.run(Command::new(build_helper::make(&build.config.build))
640 // Now make sure that rust-src has all of libstd's dependencies
641 println!("Distcheck rust-src");
642 let dir = build.out.join("tmp").join("distcheck-src");
643 let _ = fs::remove_dir_all(&dir);
644 t!(fs::create_dir_all(&dir));
646 let mut cmd = Command::new("tar");
648 .arg(dist::rust_src_installer(build))
649 .arg("--strip-components=1")
653 let toml = dir.join("rust-src/lib/rustlib/src/rust/src/libstd/Cargo.toml");
654 build.run(Command::new(&build.cargo)
655 .arg("generate-lockfile")
656 .arg("--manifest-path")
661 /// Test the build system itself
662 pub fn bootstrap(build: &Build) {
663 let mut cmd = Command::new(&build.cargo);
665 .current_dir(build.src.join("src/bootstrap"))
666 .env("CARGO_TARGET_DIR", build.out.join("bootstrap"))
667 .env("RUSTC", &build.rustc);
668 if build.flags.cmd.no_fail_fast() {
669 cmd.arg("--no-fail-fast");
671 cmd.arg("--").args(&build.flags.cmd.test_args());
672 try_run(build, &mut cmd);