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 use std::collections::HashSet;
  17 use std::env;
  18 use std::ffi::OsString;
  19 use std::iter;
  20 use std::fmt;
  21 use std::fs::{self, File};
  22 use std::path::{PathBuf, Path};
  23 use std::process::Command;
  24 use std::io::Read;
  25
  26 use build_helper::{self, output};
  27
  28 use builder::{Kind, RunConfig, ShouldRun, Builder, Compiler, Step};
  29 use cache::{INTERNER, Interned};
  30 use compile;
  31 use dist;
  32 use native;
  33 use tool::{self, Tool};
  34 use util::{self, dylib_path, dylib_path_var};
  35 use {Build, Mode};
  36 use toolstate::ToolState;
  37
  38 const ADB_TEST_DIR: &str = "/data/tmp/work";
  39
  40 /// The two modes of the test runner; tests or benchmarks.
  41 #[derive(Debug, PartialEq, Eq, Hash, Copy, Clone)]
  42 pub enum TestKind {
  43     /// Run `cargo test`
  44     Test,
  45     /// Run `cargo bench`
  46     Bench,
  47 }
  48
  49 impl TestKind {
  50     // Return the cargo subcommand for this test kind
  51     fn subcommand(self) -> &'static str {
  52         match self {
  53             TestKind::Test => "test",
  54             TestKind::Bench => "bench",
  55         }
  56     }
  57 }
  58
  59 impl fmt::Display for TestKind {
  60     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
  61         f.write_str(match *self {
  62             TestKind::Test => "Testing",
  63             TestKind::Bench => "Benchmarking",
  64         })
  65     }
  66 }
  67
  68 fn try_run(build: &Build, cmd: &mut Command) -> bool {
  69     if !build.fail_fast {
  70         if !build.try_run(cmd) {
  71             let mut failures = build.delayed_failures.borrow_mut();
  72             failures.push(format!("{:?}", cmd));
  73             return false;
  74         }
  75     } else {
  76         build.run(cmd);
  77     }
  78     true
  79 }
  80
  81 fn try_run_quiet(build: &Build, cmd: &mut Command) {
  82     if !build.fail_fast {
  83         if !build.try_run_quiet(cmd) {
  84             let mut failures = build.delayed_failures.borrow_mut();
  85             failures.push(format!("{:?}", cmd));
  86         }
  87     } else {
  88         build.run_quiet(cmd);
  89     }
  90 }
  91
  92 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
  93 pub struct Linkcheck {
  94     host: Interned<String>,
  95 }
  96
  97 impl Step for Linkcheck {
  98     type Output = ();
  99     const ONLY_HOSTS: bool = true;
 100     const DEFAULT: bool = true;
 101
 102     /// Runs the `linkchecker` tool as compiled in `stage` by the `host` compiler.
 103     ///
 104     /// This tool in `src/tools` will verify the validity of all our links in the
 105     /// documentation to ensure we don't have a bunch of dead ones.
 106     fn run(self, builder: &Builder) {
 107         let build = builder.build;
 108         let host = self.host;
 109
 110         println!("Linkcheck ({})", host);
 111
 112         builder.default_doc(None);
 113
 114         let _time = util::timeit();
 115         try_run(build, builder.tool_cmd(Tool::Linkchecker)
 116                             .arg(build.out.join(host).join("doc")));
 117     }
 118
 119     fn should_run(run: ShouldRun) -> ShouldRun {
 120         let builder = run.builder;
 121         run.path("src/tools/linkchecker").default_condition(builder.build.config.docs)
 122     }
 123
 124     fn make_run(run: RunConfig) {
 125         run.builder.ensure(Linkcheck { host: run.target });
 126     }
 127 }
 128
 129 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 130 pub struct Cargotest {
 131     stage: u32,
 132     host: Interned<String>,
 133 }
 134
 135 impl Step for Cargotest {
 136     type Output = ();
 137     const ONLY_HOSTS: bool = true;
 138
 139     fn should_run(run: ShouldRun) -> ShouldRun {
 140         run.path("src/tools/cargotest")
 141     }
 142
 143     fn make_run(run: RunConfig) {
 144         run.builder.ensure(Cargotest {
 145             stage: run.builder.top_stage,
 146             host: run.target,
 147         });
 148     }
 149
 150     /// Runs the `cargotest` tool as compiled in `stage` by the `host` compiler.
 151     ///
 152     /// This tool in `src/tools` will check out a few Rust projects and run `cargo
 153     /// test` to ensure that we don't regress the test suites there.
 154     fn run(self, builder: &Builder) {
 155         let build = builder.build;
 156         let compiler = builder.compiler(self.stage, self.host);
 157         builder.ensure(compile::Rustc { compiler, target: compiler.host });
 158
 159         // Note that this is a short, cryptic, and not scoped directory name. This
 160         // is currently to minimize the length of path on Windows where we otherwise
 161         // quickly run into path name limit constraints.
 162         let out_dir = build.out.join("ct");
 163         t!(fs::create_dir_all(&out_dir));
 164
 165         let _time = util::timeit();
 166         let mut cmd = builder.tool_cmd(Tool::CargoTest);
 167         try_run(build, cmd.arg(&build.initial_cargo)
 168                           .arg(&out_dir)
 169                           .env("RUSTC", builder.rustc(compiler))
 170                           .env("RUSTDOC", builder.rustdoc(compiler.host)));
 171     }
 172 }
 173
 174 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 175 pub struct Cargo {
 176     stage: u32,
 177     host: Interned<String>,
 178 }
 179
 180 impl Step for Cargo {
 181     type Output = ();
 182     const ONLY_HOSTS: bool = true;
 183
 184     fn should_run(run: ShouldRun) -> ShouldRun {
 185         run.path("src/tools/cargo")
 186     }
 187
 188     fn make_run(run: RunConfig) {
 189         run.builder.ensure(Cargo {
 190             stage: run.builder.top_stage,
 191             host: run.target,
 192         });
 193     }
 194
 195     /// Runs `cargo test` for `cargo` packaged with Rust.
 196     fn run(self, builder: &Builder) {
 197         let build = builder.build;
 198         let compiler = builder.compiler(self.stage, self.host);
 199
 200         builder.ensure(tool::Cargo { compiler, target: self.host });
 201         let mut cargo = builder.cargo(compiler, Mode::Tool, self.host, "test");
 202         cargo.arg("--manifest-path").arg(build.src.join("src/tools/cargo/Cargo.toml"));
 203         if !build.fail_fast {
 204             cargo.arg("--no-fail-fast");
 205         }
 206
 207         // Don't build tests dynamically, just a pain to work with
 208         cargo.env("RUSTC_NO_PREFER_DYNAMIC", "1");
 209
 210         // Don't run cross-compile tests, we may not have cross-compiled libstd libs
 211         // available.
 212         cargo.env("CFG_DISABLE_CROSS_TESTS", "1");
 213
 214         try_run(build, cargo.env("PATH", &path_for_cargo(builder, compiler)));
 215     }
 216 }
 217
 218 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 219 pub struct Rls {
 220     stage: u32,
 221     host: Interned<String>,
 222 }
 223
 224 impl Step for Rls {
 225     type Output = ();
 226     const ONLY_HOSTS: bool = true;
 227
 228     fn should_run(run: ShouldRun) -> ShouldRun {
 229         run.path("src/tools/rls")
 230     }
 231
 232     fn make_run(run: RunConfig) {
 233         run.builder.ensure(Rls {
 234             stage: run.builder.top_stage,
 235             host: run.target,
 236         });
 237     }
 238
 239     /// Runs `cargo test` for the rls.
 240     fn run(self, builder: &Builder) {
 241         let build = builder.build;
 242         let stage = self.stage;
 243         let host = self.host;
 244         let compiler = builder.compiler(stage, host);
 245
 246         builder.ensure(tool::Rls { compiler, target: self.host });
 247         let mut cargo = tool::prepare_tool_cargo(builder,
 248                                                  compiler,
 249                                                  host,
 250                                                  "test",
 251                                                  "src/tools/rls");
 252
 253         // Don't build tests dynamically, just a pain to work with
 254         cargo.env("RUSTC_NO_PREFER_DYNAMIC", "1");
 255
 256         builder.add_rustc_lib_path(compiler, &mut cargo);
 257
 258         if try_run(build, &mut cargo) {
 259             build.save_toolstate("rls", ToolState::TestPass);
 260         }
 261     }
 262 }
 263
 264 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 265 pub struct Rustfmt {
 266     stage: u32,
 267     host: Interned<String>,
 268 }
 269
 270 impl Step for Rustfmt {
 271     type Output = ();
 272     const ONLY_HOSTS: bool = true;
 273
 274     fn should_run(run: ShouldRun) -> ShouldRun {
 275         run.path("src/tools/rustfmt")
 276     }
 277
 278     fn make_run(run: RunConfig) {
 279         run.builder.ensure(Rustfmt {
 280             stage: run.builder.top_stage,
 281             host: run.target,
 282         });
 283     }
 284
 285     /// Runs `cargo test` for rustfmt.
 286     fn run(self, builder: &Builder) {
 287         let build = builder.build;
 288         let stage = self.stage;
 289         let host = self.host;
 290         let compiler = builder.compiler(stage, host);
 291
 292         builder.ensure(tool::Rustfmt { compiler, target: self.host });
 293         let mut cargo = tool::prepare_tool_cargo(builder,
 294                                                  compiler,
 295                                                  host,
 296                                                  "test",
 297                                                  "src/tools/rustfmt");
 298
 299         // Don't build tests dynamically, just a pain to work with
 300         cargo.env("RUSTC_NO_PREFER_DYNAMIC", "1");
 301
 302         builder.add_rustc_lib_path(compiler, &mut cargo);
 303
 304         if try_run(build, &mut cargo) {
 305             build.save_toolstate("rustfmt", ToolState::TestPass);
 306         }
 307     }
 308 }
 309
 310 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 311 pub struct Miri {
 312     stage: u32,
 313     host: Interned<String>,
 314 }
 315
 316 impl Step for Miri {
 317     type Output = ();
 318     const ONLY_HOSTS: bool = true;
 319     const DEFAULT: bool = true;
 320
 321     fn should_run(run: ShouldRun) -> ShouldRun {
 322         let test_miri = run.builder.build.config.test_miri;
 323         run.path("src/tools/miri").default_condition(test_miri)
 324     }
 325
 326     fn make_run(run: RunConfig) {
 327         run.builder.ensure(Miri {
 328             stage: run.builder.top_stage,
 329             host: run.target,
 330         });
 331     }
 332
 333     /// Runs `cargo test` for miri.
 334     fn run(self, builder: &Builder) {
 335         let build = builder.build;
 336         let stage = self.stage;
 337         let host = self.host;
 338         let compiler = builder.compiler(stage, host);
 339
 340         if let Some(miri) = builder.ensure(tool::Miri { compiler, target: self.host }) {
 341             let mut cargo = builder.cargo(compiler, Mode::Tool, host, "test");
 342             cargo.arg("--manifest-path").arg(build.src.join("src/tools/miri/Cargo.toml"));
 343
 344             // Don't build tests dynamically, just a pain to work with
 345             cargo.env("RUSTC_NO_PREFER_DYNAMIC", "1");
 346             // miri tests need to know about the stage sysroot
 347             cargo.env("MIRI_SYSROOT", builder.sysroot(compiler));
 348             cargo.env("RUSTC_TEST_SUITE", builder.rustc(compiler));
 349             cargo.env("RUSTC_LIB_PATH", builder.rustc_libdir(compiler));
 350             cargo.env("MIRI_PATH", miri);
 351
 352             builder.add_rustc_lib_path(compiler, &mut cargo);
 353
 354             if try_run(build, &mut cargo) {
 355                 build.save_toolstate("miri", ToolState::TestPass);
 356             }
 357         } else {
 358             eprintln!("failed to test miri: could not build");
 359         }
 360     }
 361 }
 362
 363 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 364 pub struct Clippy {
 365     stage: u32,
 366     host: Interned<String>,
 367 }
 368
 369 impl Step for Clippy {
 370     type Output = ();
 371     const ONLY_HOSTS: bool = true;
 372     const DEFAULT: bool = false;
 373
 374     fn should_run(run: ShouldRun) -> ShouldRun {
 375         run.path("src/tools/clippy")
 376     }
 377
 378     fn make_run(run: RunConfig) {
 379         run.builder.ensure(Clippy {
 380             stage: run.builder.top_stage,
 381             host: run.target,
 382         });
 383     }
 384
 385     /// Runs `cargo test` for clippy.
 386     fn run(self, builder: &Builder) {
 387         let build = builder.build;
 388         let stage = self.stage;
 389         let host = self.host;
 390         let compiler = builder.compiler(stage, host);
 391
 392         if let Some(clippy) = builder.ensure(tool::Clippy { compiler, target: self.host }) {
 393             let mut cargo = builder.cargo(compiler, Mode::Tool, host, "test");
 394             cargo.arg("--manifest-path").arg(build.src.join("src/tools/clippy/Cargo.toml"));
 395
 396             // Don't build tests dynamically, just a pain to work with
 397             cargo.env("RUSTC_NO_PREFER_DYNAMIC", "1");
 398             // clippy tests need to know about the stage sysroot
 399             cargo.env("SYSROOT", builder.sysroot(compiler));
 400             cargo.env("RUSTC_TEST_SUITE", builder.rustc(compiler));
 401             cargo.env("RUSTC_LIB_PATH", builder.rustc_libdir(compiler));
 402             let host_libs = builder.stage_out(compiler, Mode::Tool).join(builder.cargo_dir());
 403             cargo.env("HOST_LIBS", host_libs);
 404             // clippy tests need to find the driver
 405             cargo.env("CLIPPY_DRIVER_PATH", clippy);
 406
 407             builder.add_rustc_lib_path(compiler, &mut cargo);
 408
 409             if try_run(build, &mut cargo) {
 410                 build.save_toolstate("clippy-driver", ToolState::TestPass);
 411             }
 412         } else {
 413             eprintln!("failed to test clippy: could not build");
 414         }
 415     }
 416 }
 417
 418 fn path_for_cargo(builder: &Builder, compiler: Compiler) -> OsString {
 419     // Configure PATH to find the right rustc. NB. we have to use PATH
 420     // and not RUSTC because the Cargo test suite has tests that will
 421     // fail if rustc is not spelled `rustc`.
 422     let path = builder.sysroot(compiler).join("bin");
 423     let old_path = env::var_os("PATH").unwrap_or_default();
 424     env::join_paths(iter::once(path).chain(env::split_paths(&old_path))).expect("")
 425 }
 426
 427 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
 428 pub struct RustdocJS {
 429     pub host: Interned<String>,
 430     pub target: Interned<String>,
 431 }
 432
 433 impl Step for RustdocJS {
 434     type Output = ();
 435     const DEFAULT: bool = true;
 436     const ONLY_HOSTS: bool = true;
 437
 438     fn should_run(run: ShouldRun) -> ShouldRun {
 439         run.path("src/test/rustdoc-js")
 440     }
 441
 442     fn make_run(run: RunConfig) {
 443         run.builder.ensure(RustdocJS {
 444             host: run.host,
 445             target: run.target,
 446         });
 447     }
 448
 449     fn run(self, builder: &Builder) {
 450         if let Some(ref nodejs) = builder.config.nodejs {
 451             let mut command = Command::new(nodejs);
 452             command.args(&["src/tools/rustdoc-js/tester.js", &*self.host]);
 453             builder.ensure(::doc::Std {
 454                 target: self.target,
 455                 stage: builder.top_stage,
 456             });
 457             builder.run(&mut command);
 458         } else {
 459             println!("No nodejs found, skipping \"src/test/rustdoc-js\" tests");
 460         }
 461     }
 462 }
 463
 464 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 465 pub struct Tidy {
 466     host: Interned<String>,
 467 }
 468
 469 impl Step for Tidy {
 470     type Output = ();
 471     const DEFAULT: bool = true;
 472     const ONLY_HOSTS: bool = true;
 473     const ONLY_BUILD: bool = true;
 474
 475     /// Runs the `tidy` tool as compiled in `stage` by the `host` compiler.
 476     ///
 477     /// This tool in `src/tools` checks up on various bits and pieces of style and
 478     /// otherwise just implements a few lint-like checks that are specific to the
 479     /// compiler itself.
 480     fn run(self, builder: &Builder) {
 481         let build = builder.build;
 482         let host = self.host;
 483
 484         let _folder = build.fold_output(|| "tidy");
 485         println!("tidy check ({})", host);
 486         let mut cmd = builder.tool_cmd(Tool::Tidy);
 487         cmd.arg(build.src.join("src"));
 488         if !build.config.vendor {
 489             cmd.arg("--no-vendor");
 490         }
 491         if build.config.quiet_tests {
 492             cmd.arg("--quiet");
 493         }
 494         try_run(build, &mut cmd);
 495     }
 496
 497     fn should_run(run: ShouldRun) -> ShouldRun {
 498         run.path("src/tools/tidy")
 499     }
 500
 501     fn make_run(run: RunConfig) {
 502         run.builder.ensure(Tidy {
 503             host: run.builder.build.build,
 504         });
 505     }
 506 }
 507
 508 fn testdir(build: &Build, host: Interned<String>) -> PathBuf {
 509     build.out.join(host).join("test")
 510 }
 511
 512 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 513 struct Test {
 514     path: &'static str,
 515     mode: &'static str,
 516     suite: &'static str,
 517 }
 518
 519 static DEFAULT_COMPILETESTS: &[Test] = &[
 520     Test { path: "src/test/ui", mode: "ui", suite: "ui" },
 521     Test { path: "src/test/run-pass", mode: "run-pass", suite: "run-pass" },
 522     Test { path: "src/test/compile-fail", mode: "compile-fail", suite: "compile-fail" },
 523     Test { path: "src/test/parse-fail", mode: "parse-fail", suite: "parse-fail" },
 524     Test { path: "src/test/run-fail", mode: "run-fail", suite: "run-fail" },
 525     Test {
 526         path: "src/test/run-pass-valgrind",
 527         mode: "run-pass-valgrind",
 528         suite: "run-pass-valgrind"
 529     },
 530     Test { path: "src/test/mir-opt", mode: "mir-opt", suite: "mir-opt" },
 531     Test { path: "src/test/codegen", mode: "codegen", suite: "codegen" },
 532     Test { path: "src/test/codegen-units", mode: "codegen-units", suite: "codegen-units" },
 533     Test { path: "src/test/incremental", mode: "incremental", suite: "incremental" },
 534
 535     // What this runs varies depending on the native platform being apple
 536     Test { path: "src/test/debuginfo", mode: "debuginfo-XXX", suite: "debuginfo" },
 537 ];
 538
 539 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 540 pub struct DefaultCompiletest {
 541     compiler: Compiler,
 542     target: Interned<String>,
 543     mode: &'static str,
 544     suite: &'static str,
 545 }
 546
 547 impl Step for DefaultCompiletest {
 548     type Output = ();
 549     const DEFAULT: bool = true;
 550
 551     fn should_run(mut run: ShouldRun) -> ShouldRun {
 552         for test in DEFAULT_COMPILETESTS {
 553             run = run.path(test.path);
 554         }
 555         run
 556     }
 557
 558     fn make_run(run: RunConfig) {
 559         let compiler = run.builder.compiler(run.builder.top_stage, run.host);
 560
 561         let test = run.path.map(|path| {
 562             DEFAULT_COMPILETESTS.iter().find(|&&test| {
 563                 path.ends_with(test.path)
 564             }).unwrap_or_else(|| {
 565                 panic!("make_run in compile test to receive test path, received {:?}", path);
 566             })
 567         });
 568
 569         if let Some(test) = test {
 570             run.builder.ensure(DefaultCompiletest {
 571                 compiler,
 572                 target: run.target,
 573                 mode: test.mode,
 574                 suite: test.suite,
 575             });
 576         } else {
 577             for test in DEFAULT_COMPILETESTS {
 578                 run.builder.ensure(DefaultCompiletest {
 579                     compiler,
 580                     target: run.target,
 581                     mode: test.mode,
 582                     suite: test.suite
 583                 });
 584             }
 585         }
 586     }
 587
 588     fn run(self, builder: &Builder) {
 589         builder.ensure(Compiletest {
 590             compiler: self.compiler,
 591             target: self.target,
 592             mode: self.mode,
 593             suite: self.suite,
 594         })
 595     }
 596 }
 597
 598 // Also default, but host-only.
 599 static HOST_COMPILETESTS: &[Test] = &[
 600     Test { path: "src/test/ui-fulldeps", mode: "ui", suite: "ui-fulldeps" },
 601     Test { path: "src/test/run-pass-fulldeps", mode: "run-pass", suite: "run-pass-fulldeps" },
 602     Test { path: "src/test/run-fail-fulldeps", mode: "run-fail", suite: "run-fail-fulldeps" },
 603     Test {
 604         path: "src/test/compile-fail-fulldeps",
 605         mode: "compile-fail",
 606         suite: "compile-fail-fulldeps",
 607     },
 608     Test {
 609         path: "src/test/incremental-fulldeps",
 610         mode: "incremental",
 611         suite: "incremental-fulldeps",
 612     },
 613     Test { path: "src/test/run-make", mode: "run-make", suite: "run-make" },
 614     Test { path: "src/test/rustdoc", mode: "rustdoc", suite: "rustdoc" },
 615
 616     Test { path: "src/test/pretty", mode: "pretty", suite: "pretty" },
 617     Test { path: "src/test/run-pass/pretty", mode: "pretty", suite: "run-pass" },
 618     Test { path: "src/test/run-fail/pretty", mode: "pretty", suite: "run-fail" },
 619     Test { path: "src/test/run-pass-valgrind/pretty", mode: "pretty", suite: "run-pass-valgrind" },
 620     Test { path: "src/test/run-pass-fulldeps/pretty", mode: "pretty", suite: "run-pass-fulldeps" },
 621     Test { path: "src/test/run-fail-fulldeps/pretty", mode: "pretty", suite: "run-fail-fulldeps" },
 622 ];
 623
 624 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 625 pub struct HostCompiletest {
 626     compiler: Compiler,
 627     target: Interned<String>,
 628     mode: &'static str,
 629     suite: &'static str,
 630 }
 631
 632 impl Step for HostCompiletest {
 633     type Output = ();
 634     const DEFAULT: bool = true;
 635     const ONLY_HOSTS: bool = true;
 636
 637     fn should_run(mut run: ShouldRun) -> ShouldRun {
 638         for test in HOST_COMPILETESTS {
 639             run = run.path(test.path);
 640         }
 641         run
 642     }
 643
 644     fn make_run(run: RunConfig) {
 645         let compiler = run.builder.compiler(run.builder.top_stage, run.host);
 646
 647         let test = run.path.map(|path| {
 648             HOST_COMPILETESTS.iter().find(|&&test| {
 649                 path.ends_with(test.path)
 650             }).unwrap_or_else(|| {
 651                 panic!("make_run in compile test to receive test path, received {:?}", path);
 652             })
 653         });
 654
 655         if let Some(test) = test {
 656             run.builder.ensure(HostCompiletest {
 657                 compiler,
 658                 target: run.target,
 659                 mode: test.mode,
 660                 suite: test.suite,
 661             });
 662         } else {
 663             for test in HOST_COMPILETESTS {
 664                 if test.mode == "pretty" {
 665                     continue;
 666                 }
 667                 run.builder.ensure(HostCompiletest {
 668                     compiler,
 669                     target: run.target,
 670                     mode: test.mode,
 671                     suite: test.suite
 672                 });
 673             }
 674         }
 675     }
 676
 677     fn run(self, builder: &Builder) {
 678         builder.ensure(Compiletest {
 679             compiler: self.compiler,
 680             target: self.target,
 681             mode: self.mode,
 682             suite: self.suite,
 683         })
 684     }
 685 }
 686
 687 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 688 struct Compiletest {
 689     compiler: Compiler,
 690     target: Interned<String>,
 691     mode: &'static str,
 692     suite: &'static str,
 693 }
 694
 695 impl Step for Compiletest {
 696     type Output = ();
 697
 698     fn should_run(run: ShouldRun) -> ShouldRun {
 699         run.never()
 700     }
 701
 702     /// Executes the `compiletest` tool to run a suite of tests.
 703     ///
 704     /// Compiles all tests with `compiler` for `target` with the specified
 705     /// compiletest `mode` and `suite` arguments. For example `mode` can be
 706     /// "run-pass" or `suite` can be something like `debuginfo`.
 707     fn run(self, builder: &Builder) {
 708         let build = builder.build;
 709         let compiler = self.compiler;
 710         let target = self.target;
 711         let mode = self.mode;
 712         let suite = self.suite;
 713
 714         // Skip codegen tests if they aren't enabled in configuration.
 715         if !build.config.codegen_tests && suite == "codegen" {
 716             return;
 717         }
 718
 719         if suite == "debuginfo" {
 720             // Skip debuginfo tests on MSVC
 721             if build.build.contains("msvc") {
 722                 return;
 723             }
 724
 725             if mode == "debuginfo-XXX" {
 726                 return if build.build.contains("apple") {
 727                     builder.ensure(Compiletest {
 728                         mode: "debuginfo-lldb",
 729                         ..self
 730                     });
 731                 } else {
 732                     builder.ensure(Compiletest {
 733                         mode: "debuginfo-gdb",
 734                         ..self
 735                     });
 736                 };
 737             }
 738
 739             builder.ensure(dist::DebuggerScripts {
 740                 sysroot: builder.sysroot(compiler),
 741                 host: target
 742             });
 743         }
 744
 745         if suite.ends_with("fulldeps") ||
 746             // FIXME: Does pretty need librustc compiled? Note that there are
 747             // fulldeps test suites with mode = pretty as well.
 748             mode == "pretty" ||
 749             mode == "rustdoc" ||
 750             mode == "run-make" {
 751             builder.ensure(compile::Rustc { compiler, target });
 752         }
 753
 754         builder.ensure(compile::Test { compiler, target });
 755         builder.ensure(native::TestHelpers { target });
 756         builder.ensure(RemoteCopyLibs { compiler, target });
 757
 758         let _folder = build.fold_output(|| format!("test_{}", suite));
 759         println!("Check compiletest suite={} mode={} ({} -> {})",
 760                  suite, mode, &compiler.host, target);
 761         let mut cmd = builder.tool_cmd(Tool::Compiletest);
 762
 763         // compiletest currently has... a lot of arguments, so let's just pass all
 764         // of them!
 765
 766         cmd.arg("--compile-lib-path").arg(builder.rustc_libdir(compiler));
 767         cmd.arg("--run-lib-path").arg(builder.sysroot_libdir(compiler, target));
 768         cmd.arg("--rustc-path").arg(builder.rustc(compiler));
 769
 770         // Avoid depending on rustdoc when we don't need it.
 771         if mode == "rustdoc" || mode == "run-make" {
 772             cmd.arg("--rustdoc-path").arg(builder.rustdoc(compiler.host));
 773         }
 774
 775         cmd.arg("--src-base").arg(build.src.join("src/test").join(suite));
 776         cmd.arg("--build-base").arg(testdir(build, compiler.host).join(suite));
 777         cmd.arg("--stage-id").arg(format!("stage{}-{}", compiler.stage, target));
 778         cmd.arg("--mode").arg(mode);
 779         cmd.arg("--target").arg(target);
 780         cmd.arg("--host").arg(&*compiler.host);
 781         cmd.arg("--llvm-filecheck").arg(build.llvm_filecheck(build.build));
 782
 783         if let Some(ref nodejs) = build.config.nodejs {
 784             cmd.arg("--nodejs").arg(nodejs);
 785         }
 786
 787         let mut flags = vec!["-Crpath".to_string()];
 788         if build.config.rust_optimize_tests {
 789             flags.push("-O".to_string());
 790         }
 791         if build.config.rust_debuginfo_tests {
 792             flags.push("-g".to_string());
 793         }
 794         flags.push("-Zmiri -Zunstable-options".to_string());
 795
 796         if let Some(linker) = build.linker(target) {
 797             cmd.arg("--linker").arg(linker);
 798         }
 799
 800         let hostflags = flags.clone();
 801         cmd.arg("--host-rustcflags").arg(hostflags.join(" "));
 802
 803         let mut targetflags = flags.clone();
 804         targetflags.push(format!("-Lnative={}",
 805                                  build.test_helpers_out(target).display()));
 806         cmd.arg("--target-rustcflags").arg(targetflags.join(" "));
 807
 808         cmd.arg("--docck-python").arg(build.python());
 809
 810         if build.build.ends_with("apple-darwin") {
 811             // Force /usr/bin/python on macOS for LLDB tests because we're loading the
 812             // LLDB plugin's compiled module which only works with the system python
 813             // (namely not Homebrew-installed python)
 814             cmd.arg("--lldb-python").arg("/usr/bin/python");
 815         } else {
 816             cmd.arg("--lldb-python").arg(build.python());
 817         }
 818
 819         if let Some(ref gdb) = build.config.gdb {
 820             cmd.arg("--gdb").arg(gdb);
 821         }
 822         if let Some(ref vers) = build.lldb_version {
 823             cmd.arg("--lldb-version").arg(vers);
 824         }
 825         if let Some(ref dir) = build.lldb_python_dir {
 826             cmd.arg("--lldb-python-dir").arg(dir);
 827         }
 828
 829         cmd.args(&build.config.cmd.test_args());
 830
 831         if build.is_verbose() {
 832             cmd.arg("--verbose");
 833         }
 834
 835         if build.config.quiet_tests {
 836             cmd.arg("--quiet");
 837         }
 838
 839         if build.config.llvm_enabled {
 840             let llvm_config = build.llvm_config(target);
 841             let llvm_version = output(Command::new(&llvm_config).arg("--version"));
 842             cmd.arg("--llvm-version").arg(llvm_version);
 843             if !build.is_rust_llvm(target) {
 844                 cmd.arg("--system-llvm");
 845             }
 846
 847             // Only pass correct values for these flags for the `run-make` suite as it
 848             // requires that a C++ compiler was configured which isn't always the case.
 849             if suite == "run-make" {
 850                 let llvm_components = output(Command::new(&llvm_config).arg("--components"));
 851                 let llvm_cxxflags = output(Command::new(&llvm_config).arg("--cxxflags"));
 852                 cmd.arg("--cc").arg(build.cc(target))
 853                 .arg("--cxx").arg(build.cxx(target).unwrap())
 854                 .arg("--cflags").arg(build.cflags(target).join(" "))
 855                 .arg("--llvm-components").arg(llvm_components.trim())
 856                 .arg("--llvm-cxxflags").arg(llvm_cxxflags.trim());
 857                 if let Some(ar) = build.ar(target) {
 858                     cmd.arg("--ar").arg(ar);
 859                 }
 860             }
 861         }
 862         if suite == "run-make" && !build.config.llvm_enabled {
 863             println!("Ignoring run-make test suite as they generally dont work without LLVM");
 864             return;
 865         }
 866
 867         if suite != "run-make" {
 868             cmd.arg("--cc").arg("")
 869                .arg("--cxx").arg("")
 870                .arg("--cflags").arg("")
 871                .arg("--llvm-components").arg("")
 872                .arg("--llvm-cxxflags").arg("");
 873         }
 874
 875         if build.remote_tested(target) {
 876             cmd.arg("--remote-test-client").arg(builder.tool_exe(Tool::RemoteTestClient));
 877         }
 878
 879         // Running a C compiler on MSVC requires a few env vars to be set, to be
 880         // sure to set them here.
 881         //
 882         // Note that if we encounter `PATH` we make sure to append to our own `PATH`
 883         // rather than stomp over it.
 884         if target.contains("msvc") {
 885             for &(ref k, ref v) in build.cc[&target].env() {
 886                 if k != "PATH" {
 887                     cmd.env(k, v);
 888                 }
 889             }
 890         }
 891         cmd.env("RUSTC_BOOTSTRAP", "1");
 892         build.add_rust_test_threads(&mut cmd);
 893
 894         if build.config.sanitizers {
 895             cmd.env("SANITIZER_SUPPORT", "1");
 896         }
 897
 898         if build.config.profiler {
 899             cmd.env("PROFILER_SUPPORT", "1");
 900         }
 901
 902         cmd.arg("--adb-path").arg("adb");
 903         cmd.arg("--adb-test-dir").arg(ADB_TEST_DIR);
 904         if target.contains("android") {
 905             // Assume that cc for this target comes from the android sysroot
 906             cmd.arg("--android-cross-path")
 907                .arg(build.cc(target).parent().unwrap().parent().unwrap());
 908         } else {
 909             cmd.arg("--android-cross-path").arg("");
 910         }
 911
 912         build.ci_env.force_coloring_in_ci(&mut cmd);
 913
 914         let _time = util::timeit();
 915         try_run(build, &mut cmd);
 916     }
 917 }
 918
 919 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 920 pub struct Docs {
 921     compiler: Compiler,
 922 }
 923
 924 impl Step for Docs {
 925     type Output = ();
 926     const DEFAULT: bool = true;
 927     const ONLY_HOSTS: bool = true;
 928
 929     fn should_run(run: ShouldRun) -> ShouldRun {
 930         run.path("src/doc")
 931     }
 932
 933     fn make_run(run: RunConfig) {
 934         run.builder.ensure(Docs {
 935             compiler: run.builder.compiler(run.builder.top_stage, run.host),
 936         });
 937     }
 938
 939     /// Run `rustdoc --test` for all documentation in `src/doc`.
 940     ///
 941     /// This will run all tests in our markdown documentation (e.g. the book)
 942     /// located in `src/doc`. The `rustdoc` that's run is the one that sits next to
 943     /// `compiler`.
 944     fn run(self, builder: &Builder) {
 945         let build = builder.build;
 946         let compiler = self.compiler;
 947
 948         builder.ensure(compile::Test { compiler, target: compiler.host });
 949
 950         // Do a breadth-first traversal of the `src/doc` directory and just run
 951         // tests for all files that end in `*.md`
 952         let mut stack = vec![build.src.join("src/doc")];
 953         let _time = util::timeit();
 954         let _folder = build.fold_output(|| "test_docs");
 955
 956         while let Some(p) = stack.pop() {
 957             if p.is_dir() {
 958                 stack.extend(t!(p.read_dir()).map(|p| t!(p).path()));
 959                 continue
 960             }
 961
 962             if p.extension().and_then(|s| s.to_str()) != Some("md") {
 963                 continue;
 964             }
 965
 966             // The nostarch directory in the book is for no starch, and so isn't
 967             // guaranteed to build. We don't care if it doesn't build, so skip it.
 968             if p.to_str().map_or(false, |p| p.contains("nostarch")) {
 969                 continue;
 970             }
 971
 972             markdown_test(builder, compiler, &p);
 973         }
 974     }
 975 }
 976
 977 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 978 pub struct ErrorIndex {
 979     compiler: Compiler,
 980 }
 981
 982 impl Step for ErrorIndex {
 983     type Output = ();
 984     const DEFAULT: bool = true;
 985     const ONLY_HOSTS: bool = true;
 986
 987     fn should_run(run: ShouldRun) -> ShouldRun {
 988         run.path("src/tools/error_index_generator")
 989     }
 990
 991     fn make_run(run: RunConfig) {
 992         run.builder.ensure(ErrorIndex {
 993             compiler: run.builder.compiler(run.builder.top_stage, run.host),
 994         });
 995     }
 996
 997     /// Run the error index generator tool to execute the tests located in the error
 998     /// index.
 999     ///
1000     /// The `error_index_generator` tool lives in `src/tools` and is used to
1001     /// generate a markdown file from the error indexes of the code base which is
1002     /// then passed to `rustdoc --test`.
1003     fn run(self, builder: &Builder) {
1004         let build = builder.build;
1005         let compiler = self.compiler;
1006
1007         builder.ensure(compile::Std { compiler, target: compiler.host });
1008
1009         let _folder = build.fold_output(|| "test_error_index");
1010         println!("Testing error-index stage{}", compiler.stage);
1011
1012         let dir = testdir(build, compiler.host);
1013         t!(fs::create_dir_all(&dir));
1014         let output = dir.join("error-index.md");
1015
1016         let _time = util::timeit();
1017         build.run(builder.tool_cmd(Tool::ErrorIndex)
1018                     .arg("markdown")
1019                     .arg(&output)
1020                     .env("CFG_BUILD", &build.build)
1021                     .env("RUSTC_ERROR_METADATA_DST", build.extended_error_dir()));
1022
1023         markdown_test(builder, compiler, &output);
1024     }
1025 }
1026
1027 fn markdown_test(builder: &Builder, compiler: Compiler, markdown: &Path) {
1028     let build = builder.build;
1029     let mut file = t!(File::open(markdown));
1030     let mut contents = String::new();
1031     t!(file.read_to_string(&mut contents));
1032     if !contents.contains("```") {
1033         return;
1034     }
1035
1036     println!("doc tests for: {}", markdown.display());
1037     let mut cmd = builder.rustdoc_cmd(compiler.host);
1038     build.add_rust_test_threads(&mut cmd);
1039     cmd.arg("--test");
1040     cmd.arg(markdown);
1041     cmd.env("RUSTC_BOOTSTRAP", "1");
1042
1043     let test_args = build.config.cmd.test_args().join(" ");
1044     cmd.arg("--test-args").arg(test_args);
1045
1046     if build.config.quiet_tests {
1047         try_run_quiet(build, &mut cmd);
1048     } else {
1049         try_run(build, &mut cmd);
1050     }
1051 }
1052
1053 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1054 pub struct CrateLibrustc {
1055     compiler: Compiler,
1056     target: Interned<String>,
1057     test_kind: TestKind,
1058     krate: Option<Interned<String>>,
1059 }
1060
1061 impl Step for CrateLibrustc {
1062     type Output = ();
1063     const DEFAULT: bool = true;
1064     const ONLY_HOSTS: bool = true;
1065
1066     fn should_run(run: ShouldRun) -> ShouldRun {
1067         run.krate("rustc-main")
1068     }
1069
1070     fn make_run(run: RunConfig) {
1071         let builder = run.builder;
1072         let compiler = builder.compiler(builder.top_stage, run.host);
1073
1074         let make = |name: Option<Interned<String>>| {
1075             let test_kind = if builder.kind == Kind::Test {
1076                 TestKind::Test
1077             } else if builder.kind == Kind::Bench {
1078                 TestKind::Bench
1079             } else {
1080                 panic!("unexpected builder.kind in crate: {:?}", builder.kind);
1081             };
1082
1083             builder.ensure(CrateLibrustc {
1084                 compiler,
1085                 target: run.target,
1086                 test_kind,
1087                 krate: name,
1088             });
1089         };
1090
1091         if let Some(path) = run.path {
1092             for (name, krate_path) in builder.crates("rustc-main") {
1093                 if path.ends_with(krate_path) {
1094                     make(Some(name));
1095                 }
1096             }
1097         } else {
1098             make(None);
1099         }
1100     }
1101
1102
1103     fn run(self, builder: &Builder) {
1104         builder.ensure(Crate {
1105             compiler: self.compiler,
1106             target: self.target,
1107             mode: Mode::Librustc,
1108             test_kind: self.test_kind,
1109             krate: self.krate,
1110         });
1111     }
1112 }
1113
1114 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1115 pub struct Crate {
1116     compiler: Compiler,
1117     target: Interned<String>,
1118     mode: Mode,
1119     test_kind: TestKind,
1120     krate: Option<Interned<String>>,
1121 }
1122
1123 impl Step for Crate {
1124     type Output = ();
1125     const DEFAULT: bool = true;
1126
1127     fn should_run(run: ShouldRun) -> ShouldRun {
1128         run.krate("std").krate("test")
1129     }
1130
1131     fn make_run(run: RunConfig) {
1132         let builder = run.builder;
1133         let compiler = builder.compiler(builder.top_stage, run.host);
1134
1135         let make = |mode: Mode, name: Option<Interned<String>>| {
1136             let test_kind = if builder.kind == Kind::Test {
1137                 TestKind::Test
1138             } else if builder.kind == Kind::Bench {
1139                 TestKind::Bench
1140             } else {
1141                 panic!("unexpected builder.kind in crate: {:?}", builder.kind);
1142             };
1143
1144             builder.ensure(Crate {
1145                 compiler,
1146                 target: run.target,
1147                 mode,
1148                 test_kind,
1149                 krate: name,
1150             });
1151         };
1152
1153         if let Some(path) = run.path {
1154             for (name, krate_path) in builder.crates("std") {
1155                 if path.ends_with(krate_path) {
1156                     make(Mode::Libstd, Some(name));
1157                 }
1158             }
1159             for (name, krate_path) in builder.crates("test") {
1160                 if path.ends_with(krate_path) {
1161                     make(Mode::Libtest, Some(name));
1162                 }
1163             }
1164         } else {
1165             make(Mode::Libstd, None);
1166             make(Mode::Libtest, None);
1167         }
1168     }
1169
1170     /// Run all unit tests plus documentation tests for an entire crate DAG defined
1171     /// by a `Cargo.toml`
1172     ///
1173     /// This is what runs tests for crates like the standard library, compiler, etc.
1174     /// It essentially is the driver for running `cargo test`.
1175     ///
1176     /// Currently this runs all tests for a DAG by passing a bunch of `-p foo`
1177     /// arguments, and those arguments are discovered from `cargo metadata`.
1178     fn run(self, builder: &Builder) {
1179         let build = builder.build;
1180         let compiler = self.compiler;
1181         let target = self.target;
1182         let mode = self.mode;
1183         let test_kind = self.test_kind;
1184         let krate = self.krate;
1185
1186         builder.ensure(compile::Test { compiler, target });
1187         builder.ensure(RemoteCopyLibs { compiler, target });
1188
1189         // If we're not doing a full bootstrap but we're testing a stage2 version of
1190         // libstd, then what we're actually testing is the libstd produced in
1191         // stage1. Reflect that here by updating the compiler that we're working
1192         // with automatically.
1193         let compiler = if build.force_use_stage1(compiler, target) {
1194             builder.compiler(1, compiler.host)
1195         } else {
1196             compiler.clone()
1197         };
1198
1199         let mut cargo = builder.cargo(compiler, mode, target, test_kind.subcommand());
1200         let (name, root) = match mode {
1201             Mode::Libstd => {
1202                 compile::std_cargo(build, &compiler, target, &mut cargo);
1203                 ("libstd", "std")
1204             }
1205             Mode::Libtest => {
1206                 compile::test_cargo(build, &compiler, target, &mut cargo);
1207                 ("libtest", "test")
1208             }
1209             Mode::Librustc => {
1210                 builder.ensure(compile::Rustc { compiler, target });
1211                 compile::rustc_cargo(build, target, &mut cargo);
1212                 ("librustc", "rustc-main")
1213             }
1214             _ => panic!("can only test libraries"),
1215         };
1216         let root = INTERNER.intern_string(String::from(root));
1217         let _folder = build.fold_output(|| {
1218             format!("{}_stage{}-{}", test_kind.subcommand(), compiler.stage, name)
1219         });
1220         println!("{} {} stage{} ({} -> {})", test_kind, name, compiler.stage,
1221                 &compiler.host, target);
1222
1223         // Build up the base `cargo test` command.
1224         //
1225         // Pass in some standard flags then iterate over the graph we've discovered
1226         // in `cargo metadata` with the maps above and figure out what `-p`
1227         // arguments need to get passed.
1228         if test_kind.subcommand() == "test" && !build.fail_fast {
1229             cargo.arg("--no-fail-fast");
1230         }
1231
1232         match krate {
1233             Some(krate) => {
1234                 cargo.arg("-p").arg(krate);
1235             }
1236             None => {
1237                 let mut visited = HashSet::new();
1238                 let mut next = vec![root];
1239                 while let Some(name) = next.pop() {
1240                     // Right now jemalloc and the sanitizer crates are
1241                     // target-specific crate in the sense that it's not present
1242                     // on all platforms. Custom skip it here for now, but if we
1243                     // add more this probably wants to get more generalized.
1244                     //
1245                     // Also skip `build_helper` as it's not compiled normally
1246                     // for target during the bootstrap and it's just meant to be
1247                     // a helper crate, not tested. If it leaks through then it
1248                     // ends up messing with various mtime calculations and such.
1249                     if !name.contains("jemalloc") &&
1250                        *name != *"build_helper" &&
1251                        !(name.starts_with("rustc_") && name.ends_with("san")) &&
1252                        name != "dlmalloc" {
1253                         cargo.arg("-p").arg(&format!("{}:0.0.0", name));
1254                     }
1255                     for dep in build.crates[&name].deps.iter() {
1256                         if visited.insert(dep) {
1257                             next.push(*dep);
1258                         }
1259                     }
1260                 }
1261             }
1262         }
1263
1264         // The tests are going to run with the *target* libraries, so we need to
1265         // ensure that those libraries show up in the LD_LIBRARY_PATH equivalent.
1266         //
1267         // Note that to run the compiler we need to run with the *host* libraries,
1268         // but our wrapper scripts arrange for that to be the case anyway.
1269         let mut dylib_path = dylib_path();
1270         dylib_path.insert(0, PathBuf::from(&*builder.sysroot_libdir(compiler, target)));
1271         cargo.env(dylib_path_var(), env::join_paths(&dylib_path).unwrap());
1272
1273         cargo.arg("--");
1274         cargo.args(&build.config.cmd.test_args());
1275
1276         if build.config.quiet_tests {
1277             cargo.arg("--quiet");
1278         }
1279
1280         let _time = util::timeit();
1281
1282         if target.contains("emscripten") {
1283             cargo.env(format!("CARGO_TARGET_{}_RUNNER", envify(&target)),
1284                       build.config.nodejs.as_ref().expect("nodejs not configured"));
1285         } else if target.starts_with("wasm32") {
1286             // On the wasm32-unknown-unknown target we're using LTO which is
1287             // incompatible with `-C prefer-dynamic`, so disable that here
1288             cargo.env("RUSTC_NO_PREFER_DYNAMIC", "1");
1289
1290             let node = build.config.nodejs.as_ref()
1291                 .expect("nodejs not configured");
1292             let runner = format!("{} {}/src/etc/wasm32-shim.js",
1293                                  node.display(),
1294                                  build.src.display());
1295             cargo.env(format!("CARGO_TARGET_{}_RUNNER", envify(&target)), &runner);
1296         } else if build.remote_tested(target) {
1297             cargo.env(format!("CARGO_TARGET_{}_RUNNER", envify(&target)),
1298                       format!("{} run",
1299                               builder.tool_exe(Tool::RemoteTestClient).display()));
1300         }
1301         try_run(build, &mut cargo);
1302     }
1303 }
1304
1305 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1306 pub struct Rustdoc {
1307     host: Interned<String>,
1308     test_kind: TestKind,
1309 }
1310
1311 impl Step for Rustdoc {
1312     type Output = ();
1313     const DEFAULT: bool = true;
1314     const ONLY_HOSTS: bool = true;
1315
1316     fn should_run(run: ShouldRun) -> ShouldRun {
1317         run.path("src/librustdoc").path("src/tools/rustdoc")
1318     }
1319
1320     fn make_run(run: RunConfig) {
1321         let builder = run.builder;
1322
1323         let test_kind = if builder.kind == Kind::Test {
1324             TestKind::Test
1325         } else if builder.kind == Kind::Bench {
1326             TestKind::Bench
1327         } else {
1328             panic!("unexpected builder.kind in crate: {:?}", builder.kind);
1329         };
1330
1331         builder.ensure(Rustdoc {
1332             host: run.host,
1333             test_kind,
1334         });
1335     }
1336
1337     fn run(self, builder: &Builder) {
1338         let build = builder.build;
1339         let test_kind = self.test_kind;
1340
1341         let compiler = builder.compiler(builder.top_stage, self.host);
1342         let target = compiler.host;
1343
1344         let mut cargo = tool::prepare_tool_cargo(builder,
1345                                                  compiler,
1346                                                  target,
1347                                                  test_kind.subcommand(),
1348                                                  "src/tools/rustdoc");
1349         let _folder = build.fold_output(|| {
1350             format!("{}_stage{}-rustdoc", test_kind.subcommand(), compiler.stage)
1351         });
1352         println!("{} rustdoc stage{} ({} -> {})", test_kind, compiler.stage,
1353                 &compiler.host, target);
1354
1355         if test_kind.subcommand() == "test" && !build.fail_fast {
1356             cargo.arg("--no-fail-fast");
1357         }
1358
1359         cargo.arg("-p").arg("rustdoc:0.0.0");
1360
1361         cargo.arg("--");
1362         cargo.args(&build.config.cmd.test_args());
1363
1364         if build.config.quiet_tests {
1365             cargo.arg("--quiet");
1366         }
1367
1368         let _time = util::timeit();
1369
1370         try_run(build, &mut cargo);
1371     }
1372 }
1373
1374 fn envify(s: &str) -> String {
1375     s.chars().map(|c| {
1376         match c {
1377             '-' => '_',
1378             c => c,
1379         }
1380     }).flat_map(|c| c.to_uppercase()).collect()
1381 }
1382
1383 /// Some test suites are run inside emulators or on remote devices, and most
1384 /// of our test binaries are linked dynamically which means we need to ship
1385 /// the standard library and such to the emulator ahead of time. This step
1386 /// represents this and is a dependency of all test suites.
1387 ///
1388 /// Most of the time this is a noop. For some steps such as shipping data to
1389 /// QEMU we have to build our own tools so we've got conditional dependencies
1390 /// on those programs as well. Note that the remote test client is built for
1391 /// the build target (us) and the server is built for the target.
1392 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1393 pub struct RemoteCopyLibs {
1394     compiler: Compiler,
1395     target: Interned<String>,
1396 }
1397
1398 impl Step for RemoteCopyLibs {
1399     type Output = ();
1400
1401     fn should_run(run: ShouldRun) -> ShouldRun {
1402         run.never()
1403     }
1404
1405     fn run(self, builder: &Builder) {
1406         let build = builder.build;
1407         let compiler = self.compiler;
1408         let target = self.target;
1409         if !build.remote_tested(target) {
1410             return
1411         }
1412
1413         builder.ensure(compile::Test { compiler, target });
1414
1415         println!("REMOTE copy libs to emulator ({})", target);
1416         t!(fs::create_dir_all(build.out.join("tmp")));
1417
1418         let server = builder.ensure(tool::RemoteTestServer { compiler, target });
1419
1420         // Spawn the emulator and wait for it to come online
1421         let tool = builder.tool_exe(Tool::RemoteTestClient);
1422         let mut cmd = Command::new(&tool);
1423         cmd.arg("spawn-emulator")
1424            .arg(target)
1425            .arg(&server)
1426            .arg(build.out.join("tmp"));
1427         if let Some(rootfs) = build.qemu_rootfs(target) {
1428             cmd.arg(rootfs);
1429         }
1430         build.run(&mut cmd);
1431
1432         // Push all our dylibs to the emulator
1433         for f in t!(builder.sysroot_libdir(compiler, target).read_dir()) {
1434             let f = t!(f);
1435             let name = f.file_name().into_string().unwrap();
1436             if util::is_dylib(&name) {
1437                 build.run(Command::new(&tool)
1438                                   .arg("push")
1439                                   .arg(f.path()));
1440             }
1441         }
1442     }
1443 }
1444
1445 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1446 pub struct Distcheck;
1447
1448 impl Step for Distcheck {
1449     type Output = ();
1450     const ONLY_BUILD: bool = true;
1451
1452     fn should_run(run: ShouldRun) -> ShouldRun {
1453         run.path("distcheck")
1454     }
1455
1456     fn make_run(run: RunConfig) {
1457         run.builder.ensure(Distcheck);
1458     }
1459
1460     /// Run "distcheck", a 'make check' from a tarball
1461     fn run(self, builder: &Builder) {
1462         let build = builder.build;
1463
1464         println!("Distcheck");
1465         let dir = build.out.join("tmp").join("distcheck");
1466         let _ = fs::remove_dir_all(&dir);
1467         t!(fs::create_dir_all(&dir));
1468
1469         // Guarantee that these are built before we begin running.
1470         builder.ensure(dist::PlainSourceTarball);
1471         builder.ensure(dist::Src);
1472
1473         let mut cmd = Command::new("tar");
1474         cmd.arg("-xzf")
1475            .arg(builder.ensure(dist::PlainSourceTarball))
1476            .arg("--strip-components=1")
1477            .current_dir(&dir);
1478         build.run(&mut cmd);
1479         build.run(Command::new("./configure")
1480                          .args(&build.config.configure_args)
1481                          .arg("--enable-vendor")
1482                          .current_dir(&dir));
1483         build.run(Command::new(build_helper::make(&build.build))
1484                          .arg("check")
1485                          .current_dir(&dir));
1486
1487         // Now make sure that rust-src has all of libstd's dependencies
1488         println!("Distcheck rust-src");
1489         let dir = build.out.join("tmp").join("distcheck-src");
1490         let _ = fs::remove_dir_all(&dir);
1491         t!(fs::create_dir_all(&dir));
1492
1493         let mut cmd = Command::new("tar");
1494         cmd.arg("-xzf")
1495            .arg(builder.ensure(dist::Src))
1496            .arg("--strip-components=1")
1497            .current_dir(&dir);
1498         build.run(&mut cmd);
1499
1500         let toml = dir.join("rust-src/lib/rustlib/src/rust/src/libstd/Cargo.toml");
1501         build.run(Command::new(&build.initial_cargo)
1502                          .arg("generate-lockfile")
1503                          .arg("--manifest-path")
1504                          .arg(&toml)
1505                          .current_dir(&dir));
1506     }
1507 }
1508
1509 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1510 pub struct Bootstrap;
1511
1512 impl Step for Bootstrap {
1513     type Output = ();
1514     const DEFAULT: bool = true;
1515     const ONLY_HOSTS: bool = true;
1516     const ONLY_BUILD: bool = true;
1517
1518     /// Test the build system itself
1519     fn run(self, builder: &Builder) {
1520         let build = builder.build;
1521         let mut cmd = Command::new(&build.initial_cargo);
1522         cmd.arg("test")
1523            .current_dir(build.src.join("src/bootstrap"))
1524            .env("CARGO_TARGET_DIR", build.out.join("bootstrap"))
1525            .env("RUSTC_BOOTSTRAP", "1")
1526            .env("RUSTC", &build.initial_rustc);
1527         if !build.fail_fast {
1528             cmd.arg("--no-fail-fast");
1529         }
1530         cmd.arg("--").args(&build.config.cmd.test_args());
1531         try_run(build, &mut cmd);
1532     }
1533
1534     fn should_run(run: ShouldRun) -> ShouldRun {
1535         run.path("src/bootstrap")
1536     }
1537
1538     fn make_run(run: RunConfig) {
1539         run.builder.ensure(Bootstrap);
1540     }
1541 }