src/bootstrap/check.rs

   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.
   4 //
   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.
  10
  11 //! Implementation of the test-related targets of the build system.
  12 //!
  13 //! This file implements the various regression test suites that we execute on
  14 //! our CI.
  15
  16 extern crate build_helper;
  17
  18 use std::collections::HashSet;
  19 use std::env;
  20 use std::fmt;
  21 use std::fs;
  22 use std::path::{PathBuf, Path};
  23 use std::process::Command;
  24
  25 use build_helper::output;
  26
  27 use {Build, Compiler, Mode};
  28 use dist;
  29 use util::{self, dylib_path, dylib_path_var};
  30
  31 const ADB_TEST_DIR: &'static str = "/data/tmp";
  32
  33 /// The two modes of the test runner; tests or benchmarks.
  34 #[derive(Copy, Clone)]
  35 pub enum TestKind {
  36     /// Run `cargo test`
  37     Test,
  38     /// Run `cargo bench`
  39     Bench,
  40 }
  41
  42 impl TestKind {
  43     // Return the cargo subcommand for this test kind
  44     fn subcommand(self) -> &'static str {
  45         match self {
  46             TestKind::Test => "test",
  47             TestKind::Bench => "bench",
  48         }
  49     }
  50 }
  51
  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",
  57         })
  58     }
  59 }
  60
  61 /// Runs the `linkchecker` tool as compiled in `stage` by the `host` compiler.
  62 ///
  63 /// This tool in `src/tools` will verify the validity of all our links in the
  64 /// documentation to ensure we don't have a bunch of dead ones.
  65 pub fn linkcheck(build: &Build, host: &str) {
  66     println!("Linkcheck ({})", host);
  67     let compiler = Compiler::new(0, host);
  68
  69     let _time = util::timeit();
  70     build.run(build.tool_cmd(&compiler, "linkchecker")
  71                    .arg(build.out.join(host).join("doc")));
  72 }
  73
  74 /// Runs the `cargotest` tool as compiled in `stage` by the `host` compiler.
  75 ///
  76 /// This tool in `src/tools` will check out a few Rust projects and run `cargo
  77 /// test` to ensure that we don't regress the test suites there.
  78 pub fn cargotest(build: &Build, stage: u32, host: &str) {
  79     let ref compiler = Compiler::new(stage, host);
  80
  81     // Configure PATH to find the right rustc. NB. we have to use PATH
  82     // and not RUSTC because the Cargo test suite has tests that will
  83     // fail if rustc is not spelled `rustc`.
  84     let path = build.sysroot(compiler).join("bin");
  85     let old_path = ::std::env::var("PATH").expect("");
  86     let sep = if cfg!(windows) { ";" } else {":" };
  87     let ref newpath = format!("{}{}{}", path.display(), sep, old_path);
  88
  89     // Note that this is a short, cryptic, and not scoped directory name. This
  90     // is currently to minimize the length of path on Windows where we otherwise
  91     // quickly run into path name limit constraints.
  92     let out_dir = build.out.join("ct");
  93     t!(fs::create_dir_all(&out_dir));
  94
  95     let _time = util::timeit();
  96     let mut cmd = Command::new(build.tool(&Compiler::new(0, host), "cargotest"));
  97     build.prepare_tool_cmd(compiler, &mut cmd);
  98     build.run(cmd.env("PATH", newpath)
  99                  .arg(&build.cargo)
 100                  .arg(&out_dir));
 101 }
 102
 103 /// Runs the `tidy` tool as compiled in `stage` by the `host` compiler.
 104 ///
 105 /// This tool in `src/tools` checks up on various bits and pieces of style and
 106 /// otherwise just implements a few lint-like checks that are specific to the
 107 /// compiler itself.
 108 pub fn tidy(build: &Build, host: &str) {
 109     println!("tidy check ({})", host);
 110     let compiler = Compiler::new(0, host);
 111     build.run(build.tool_cmd(&compiler, "tidy")
 112                    .arg(build.src.join("src")));
 113 }
 114
 115 fn testdir(build: &Build, host: &str) -> PathBuf {
 116     build.out.join(host).join("test")
 117 }
 118
 119 /// Executes the `compiletest` tool to run a suite of tests.
 120 ///
 121 /// Compiles all tests with `compiler` for `target` with the specified
 122 /// compiletest `mode` and `suite` arguments. For example `mode` can be
 123 /// "run-pass" or `suite` can be something like `debuginfo`.
 124 pub fn compiletest(build: &Build,
 125                    compiler: &Compiler,
 126                    target: &str,
 127                    mode: &str,
 128                    suite: &str) {
 129     println!("Check compiletest suite={} mode={} ({} -> {})",
 130              suite, mode, compiler.host, target);
 131     let mut cmd = Command::new(build.tool(&Compiler::new(0, compiler.host),
 132                                           "compiletest"));
 133     build.prepare_tool_cmd(compiler, &mut cmd);
 134
 135     // compiletest currently has... a lot of arguments, so let's just pass all
 136     // of them!
 137
 138     cmd.arg("--compile-lib-path").arg(build.rustc_libdir(compiler));
 139     cmd.arg("--run-lib-path").arg(build.sysroot_libdir(compiler, target));
 140     cmd.arg("--rustc-path").arg(build.compiler_path(compiler));
 141     cmd.arg("--rustdoc-path").arg(build.rustdoc(compiler));
 142     cmd.arg("--src-base").arg(build.src.join("src/test").join(suite));
 143     cmd.arg("--build-base").arg(testdir(build, compiler.host).join(suite));
 144     cmd.arg("--stage-id").arg(format!("stage{}-{}", compiler.stage, target));
 145     cmd.arg("--mode").arg(mode);
 146     cmd.arg("--target").arg(target);
 147     cmd.arg("--host").arg(compiler.host);
 148     cmd.arg("--llvm-filecheck").arg(build.llvm_filecheck(&build.config.build));
 149
 150     if let Some(nodejs) = build.config.nodejs.as_ref() {
 151         cmd.arg("--nodejs").arg(nodejs);
 152     }
 153
 154     let mut flags = vec!["-Crpath".to_string()];
 155     if build.config.rust_optimize_tests {
 156         flags.push("-O".to_string());
 157     }
 158     if build.config.rust_debuginfo_tests {
 159         flags.push("-g".to_string());
 160     }
 161
 162     let mut hostflags = build.rustc_flags(&compiler.host);
 163     hostflags.extend(flags.clone());
 164     cmd.arg("--host-rustcflags").arg(hostflags.join(" "));
 165
 166     let mut targetflags = build.rustc_flags(&target);
 167     targetflags.extend(flags);
 168     targetflags.push(format!("-Lnative={}",
 169                              build.test_helpers_out(target).display()));
 170     cmd.arg("--target-rustcflags").arg(targetflags.join(" "));
 171
 172     cmd.arg("--docck-python").arg(build.python());
 173
 174     if build.config.build.ends_with("apple-darwin") {
 175         // Force /usr/bin/python on OSX for LLDB tests because we're loading the
 176         // LLDB plugin's compiled module which only works with the system python
 177         // (namely not Homebrew-installed python)
 178         cmd.arg("--lldb-python").arg("/usr/bin/python");
 179     } else {
 180         cmd.arg("--lldb-python").arg(build.python());
 181     }
 182
 183     if let Some(ref gdb) = build.config.gdb {
 184         cmd.arg("--gdb").arg(gdb);
 185     }
 186     if let Some(ref vers) = build.lldb_version {
 187         cmd.arg("--lldb-version").arg(vers);
 188     }
 189     if let Some(ref dir) = build.lldb_python_dir {
 190         cmd.arg("--lldb-python-dir").arg(dir);
 191     }
 192     let llvm_config = build.llvm_config(target);
 193     let llvm_version = output(Command::new(&llvm_config).arg("--version"));
 194     cmd.arg("--llvm-version").arg(llvm_version);
 195
 196     cmd.args(&build.flags.cmd.test_args());
 197
 198     if build.config.verbose() || build.flags.verbose() {
 199         cmd.arg("--verbose");
 200     }
 201
 202     if build.config.quiet_tests {
 203         cmd.arg("--quiet");
 204     }
 205
 206     // Only pass correct values for these flags for the `run-make` suite as it
 207     // requires that a C++ compiler was configured which isn't always the case.
 208     if suite == "run-make" {
 209         let llvm_components = output(Command::new(&llvm_config).arg("--components"));
 210         let llvm_cxxflags = output(Command::new(&llvm_config).arg("--cxxflags"));
 211         cmd.arg("--cc").arg(build.cc(target))
 212            .arg("--cxx").arg(build.cxx(target))
 213            .arg("--cflags").arg(build.cflags(target).join(" "))
 214            .arg("--llvm-components").arg(llvm_components.trim())
 215            .arg("--llvm-cxxflags").arg(llvm_cxxflags.trim());
 216     } else {
 217         cmd.arg("--cc").arg("")
 218            .arg("--cxx").arg("")
 219            .arg("--cflags").arg("")
 220            .arg("--llvm-components").arg("")
 221            .arg("--llvm-cxxflags").arg("");
 222     }
 223
 224     // Running a C compiler on MSVC requires a few env vars to be set, to be
 225     // sure to set them here.
 226     //
 227     // Note that if we encounter `PATH` we make sure to append to our own `PATH`
 228     // rather than stomp over it.
 229     if target.contains("msvc") {
 230         for &(ref k, ref v) in build.cc[target].0.env() {
 231             if k != "PATH" {
 232                 cmd.env(k, v);
 233             }
 234         }
 235     }
 236     cmd.env("RUSTC_BOOTSTRAP", "1");
 237     build.add_rust_test_threads(&mut cmd);
 238
 239     cmd.arg("--adb-path").arg("adb");
 240     cmd.arg("--adb-test-dir").arg(ADB_TEST_DIR);
 241     if target.contains("android") {
 242         // Assume that cc for this target comes from the android sysroot
 243         cmd.arg("--android-cross-path")
 244            .arg(build.cc(target).parent().unwrap().parent().unwrap());
 245     } else {
 246         cmd.arg("--android-cross-path").arg("");
 247     }
 248
 249     let _time = util::timeit();
 250     build.run(&mut cmd);
 251 }
 252
 253 /// Run `rustdoc --test` for all documentation in `src/doc`.
 254 ///
 255 /// This will run all tests in our markdown documentation (e.g. the book)
 256 /// located in `src/doc`. The `rustdoc` that's run is the one that sits next to
 257 /// `compiler`.
 258 pub fn docs(build: &Build, compiler: &Compiler) {
 259     // Do a breadth-first traversal of the `src/doc` directory and just run
 260     // tests for all files that end in `*.md`
 261     let mut stack = vec![build.src.join("src/doc")];
 262     let _time = util::timeit();
 263
 264     while let Some(p) = stack.pop() {
 265         if p.is_dir() {
 266             stack.extend(t!(p.read_dir()).map(|p| t!(p).path()));
 267             continue
 268         }
 269
 270         if p.extension().and_then(|s| s.to_str()) != Some("md") {
 271             continue
 272         }
 273
 274         println!("doc tests for: {}", p.display());
 275         markdown_test(build, compiler, &p);
 276     }
 277 }
 278
 279 /// Run the error index generator tool to execute the tests located in the error
 280 /// index.
 281 ///
 282 /// The `error_index_generator` tool lives in `src/tools` and is used to
 283 /// generate a markdown file from the error indexes of the code base which is
 284 /// then passed to `rustdoc --test`.
 285 pub fn error_index(build: &Build, compiler: &Compiler) {
 286     println!("Testing error-index stage{}", compiler.stage);
 287
 288     let dir = testdir(build, compiler.host);
 289     t!(fs::create_dir_all(&dir));
 290     let output = dir.join("error-index.md");
 291
 292     let _time = util::timeit();
 293     build.run(build.tool_cmd(&Compiler::new(0, compiler.host),
 294                              "error_index_generator")
 295                    .arg("markdown")
 296                    .arg(&output)
 297                    .env("CFG_BUILD", &build.config.build));
 298
 299     markdown_test(build, compiler, &output);
 300 }
 301
 302 fn markdown_test(build: &Build, compiler: &Compiler, markdown: &Path) {
 303     let mut cmd = Command::new(build.rustdoc(compiler));
 304     build.add_rustc_lib_path(compiler, &mut cmd);
 305     build.add_rust_test_threads(&mut cmd);
 306     cmd.arg("--test");
 307     cmd.arg(markdown);
 308     cmd.env("RUSTC_BOOTSTRAP", "1");
 309
 310     let mut test_args = build.flags.cmd.test_args().join(" ");
 311     if build.config.quiet_tests {
 312         test_args.push_str(" --quiet");
 313     }
 314     cmd.arg("--test-args").arg(test_args);
 315
 316     build.run(&mut cmd);
 317 }
 318
 319 /// Run all unit tests plus documentation tests for an entire crate DAG defined
 320 /// by a `Cargo.toml`
 321 ///
 322 /// This is what runs tests for crates like the standard library, compiler, etc.
 323 /// It essentially is the driver for running `cargo test`.
 324 ///
 325 /// Currently this runs all tests for a DAG by passing a bunch of `-p foo`
 326 /// arguments, and those arguments are discovered from `cargo metadata`.
 327 pub fn krate(build: &Build,
 328              compiler: &Compiler,
 329              target: &str,
 330              mode: Mode,
 331              test_kind: TestKind,
 332              krate: Option<&str>) {
 333     let (name, path, features, root) = match mode {
 334         Mode::Libstd => {
 335             ("libstd", "src/rustc/std_shim", build.std_features(), "std_shim")
 336         }
 337         Mode::Libtest => {
 338             ("libtest", "src/rustc/test_shim", String::new(), "test_shim")
 339         }
 340         Mode::Librustc => {
 341             ("librustc", "src/rustc", build.rustc_features(), "rustc-main")
 342         }
 343         _ => panic!("can only test libraries"),
 344     };
 345     println!("{} {} stage{} ({} -> {})", test_kind, name, compiler.stage,
 346              compiler.host, target);
 347
 348     // If we're not doing a full bootstrap but we're testing a stage2 version of
 349     // libstd, then what we're actually testing is the libstd produced in
 350     // stage1. Reflect that here by updating the compiler that we're working
 351     // with automatically.
 352     let compiler = if build.force_use_stage1(compiler, target) {
 353         Compiler::new(1, compiler.host)
 354     } else {
 355         compiler.clone()
 356     };
 357
 358     // Build up the base `cargo test` command.
 359     //
 360     // Pass in some standard flags then iterate over the graph we've discovered
 361     // in `cargo metadata` with the maps above and figure out what `-p`
 362     // arguments need to get passed.
 363     let mut cargo = build.cargo(&compiler, mode, target, test_kind.subcommand());
 364     cargo.arg("--manifest-path")
 365          .arg(build.src.join(path).join("Cargo.toml"))
 366          .arg("--features").arg(features);
 367
 368     match krate {
 369         Some(krate) => {
 370             cargo.arg("-p").arg(krate);
 371         }
 372         None => {
 373             let mut visited = HashSet::new();
 374             let mut next = vec![root];
 375             while let Some(name) = next.pop() {
 376                 // Right now jemalloc is our only target-specific crate in the
 377                 // sense that it's not present on all platforms. Custom skip it
 378                 // here for now, but if we add more this probably wants to get
 379                 // more generalized.
 380                 //
 381                 // Also skip `build_helper` as it's not compiled normally for
 382                 // target during the bootstrap and it's just meant to be a
 383                 // helper crate, not tested. If it leaks through then it ends up
 384                 // messing with various mtime calculations and such.
 385                 if !name.contains("jemalloc") && name != "build_helper" {
 386                     cargo.arg("-p").arg(&format!("{}:0.0.0", name));
 387                 }
 388                 for dep in build.crates[name].deps.iter() {
 389                     if visited.insert(dep) {
 390                         next.push(dep);
 391                     }
 392                 }
 393             }
 394         }
 395     }
 396
 397     // The tests are going to run with the *target* libraries, so we need to
 398     // ensure that those libraries show up in the LD_LIBRARY_PATH equivalent.
 399     //
 400     // Note that to run the compiler we need to run with the *host* libraries,
 401     // but our wrapper scripts arrange for that to be the case anyway.
 402     let mut dylib_path = dylib_path();
 403     dylib_path.insert(0, build.sysroot_libdir(&compiler, target));
 404     cargo.env(dylib_path_var(), env::join_paths(&dylib_path).unwrap());
 405
 406     if target.contains("android") {
 407         cargo.arg("--no-run");
 408     } else if target.contains("emscripten") {
 409         cargo.arg("--no-run");
 410     }
 411
 412     cargo.arg("--");
 413
 414     if build.config.quiet_tests {
 415         cargo.arg("--quiet");
 416     }
 417
 418     let _time = util::timeit();
 419
 420     if target.contains("android") {
 421         build.run(&mut cargo);
 422         krate_android(build, &compiler, target, mode);
 423     } else if target.contains("emscripten") {
 424         build.run(&mut cargo);
 425         krate_emscripten(build, &compiler, target, mode);
 426     } else {
 427         cargo.args(&build.flags.cmd.test_args());
 428         build.run(&mut cargo);
 429     }
 430 }
 431
 432 fn krate_android(build: &Build,
 433                  compiler: &Compiler,
 434                  target: &str,
 435                  mode: Mode) {
 436     let mut tests = Vec::new();
 437     let out_dir = build.cargo_out(compiler, mode, target);
 438     find_tests(&out_dir, target, &mut tests);
 439     find_tests(&out_dir.join("deps"), target, &mut tests);
 440
 441     for test in tests {
 442         build.run(Command::new("adb").arg("push").arg(&test).arg(ADB_TEST_DIR));
 443
 444         let test_file_name = test.file_name().unwrap().to_string_lossy();
 445         let log = format!("{}/check-stage{}-T-{}-H-{}-{}.log",
 446                           ADB_TEST_DIR,
 447                           compiler.stage,
 448                           target,
 449                           compiler.host,
 450                           test_file_name);
 451         let quiet = if build.config.quiet_tests { "--quiet" } else { "" };
 452         let program = format!("(cd {dir}; \
 453                                 LD_LIBRARY_PATH=./{target} ./{test} \
 454                                     --logfile {log} \
 455                                     {quiet} \
 456                                     {args})",
 457                               dir = ADB_TEST_DIR,
 458                               target = target,
 459                               test = test_file_name,
 460                               log = log,
 461                               quiet = quiet,
 462                               args = build.flags.cmd.test_args().join(" "));
 463
 464         let output = output(Command::new("adb").arg("shell").arg(&program));
 465         println!("{}", output);
 466
 467         t!(fs::create_dir_all(build.out.join("tmp")));
 468         build.run(Command::new("adb")
 469                           .arg("pull")
 470                           .arg(&log)
 471                           .arg(build.out.join("tmp")));
 472         build.run(Command::new("adb").arg("shell").arg("rm").arg(&log));
 473         if !output.contains("result: ok") {
 474             panic!("some tests failed");
 475         }
 476     }
 477 }
 478
 479 fn krate_emscripten(build: &Build,
 480                     compiler: &Compiler,
 481                     target: &str,
 482                     mode: Mode) {
 483      let mut tests = Vec::new();
 484      let out_dir = build.cargo_out(compiler, mode, target);
 485      find_tests(&out_dir, target, &mut tests);
 486      find_tests(&out_dir.join("deps"), target, &mut tests);
 487
 488      for test in tests {
 489          let test_file_name = test.to_string_lossy().into_owned();
 490          println!("running {}", test_file_name);
 491          let nodejs = build.config.nodejs.as_ref().expect("nodejs not configured");
 492          let mut cmd = Command::new(nodejs);
 493          cmd.arg(&test_file_name);
 494          if build.config.quiet_tests {
 495              cmd.arg("--quiet");
 496          }
 497          build.run(&mut cmd);
 498      }
 499  }
 500
 501
 502 fn find_tests(dir: &Path,
 503               target: &str,
 504               dst: &mut Vec<PathBuf>) {
 505     for e in t!(dir.read_dir()).map(|e| t!(e)) {
 506         let file_type = t!(e.file_type());
 507         if !file_type.is_file() {
 508             continue
 509         }
 510         let filename = e.file_name().into_string().unwrap();
 511         if (target.contains("windows") && filename.ends_with(".exe")) ||
 512            (!target.contains("windows") && !filename.contains(".")) ||
 513            (target.contains("emscripten") && filename.contains(".js")){
 514             dst.push(e.path());
 515         }
 516     }
 517 }
 518
 519 pub fn android_copy_libs(build: &Build,
 520                          compiler: &Compiler,
 521                          target: &str) {
 522     if !target.contains("android") {
 523         return
 524     }
 525
 526     println!("Android copy libs to emulator ({})", target);
 527     build.run(Command::new("adb").arg("wait-for-device"));
 528     build.run(Command::new("adb").arg("remount"));
 529     build.run(Command::new("adb").args(&["shell", "rm", "-r", ADB_TEST_DIR]));
 530     build.run(Command::new("adb").args(&["shell", "mkdir", ADB_TEST_DIR]));
 531     build.run(Command::new("adb")
 532                       .arg("push")
 533                       .arg(build.src.join("src/etc/adb_run_wrapper.sh"))
 534                       .arg(ADB_TEST_DIR));
 535
 536     let target_dir = format!("{}/{}", ADB_TEST_DIR, target);
 537     build.run(Command::new("adb").args(&["shell", "mkdir", &target_dir[..]]));
 538
 539     for f in t!(build.sysroot_libdir(compiler, target).read_dir()) {
 540         let f = t!(f);
 541         let name = f.file_name().into_string().unwrap();
 542         if util::is_dylib(&name) {
 543             build.run(Command::new("adb")
 544                               .arg("push")
 545                               .arg(f.path())
 546                               .arg(&target_dir));
 547         }
 548     }
 549 }
 550
 551 /// Run "distcheck", a 'make check' from a tarball
 552 pub fn distcheck(build: &Build) {
 553     if build.config.build != "x86_64-unknown-linux-gnu" {
 554         return
 555     }
 556     if !build.config.host.iter().any(|s| s == "x86_64-unknown-linux-gnu") {
 557         return
 558     }
 559     if !build.config.target.iter().any(|s| s == "x86_64-unknown-linux-gnu") {
 560         return
 561     }
 562
 563     let dir = build.out.join("tmp").join("distcheck");
 564     let _ = fs::remove_dir_all(&dir);
 565     t!(fs::create_dir_all(&dir));
 566
 567     let mut cmd = Command::new("tar");
 568     cmd.arg("-xzf")
 569        .arg(dist::rust_src_location(build))
 570        .arg("--strip-components=1")
 571        .current_dir(&dir);
 572     build.run(&mut cmd);
 573     build.run(Command::new("./configure")
 574                      .args(&build.config.configure_args)
 575                      .current_dir(&dir));
 576     build.run(Command::new(build_helper::make(&build.config.build))
 577                      .arg("check")
 578                      .current_dir(&dir));
 579 }
 580
 581 /// Test the build system itself
 582 pub fn bootstrap(build: &Build) {
 583     let mut cmd = Command::new(&build.cargo);
 584     cmd.arg("test")
 585        .current_dir(build.src.join("src/bootstrap"))
 586        .env("CARGO_TARGET_DIR", build.out.join("bootstrap"))
 587        .env("RUSTC", &build.rustc);
 588     cmd.arg("--").args(&build.flags.cmd.test_args());
 589     build.run(&mut cmd);
 590 }