src/bootstrap/test.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::env;
  17 use std::ffi::OsString;
  18 use std::fmt;
  19 use std::fs::{self, File};
  20 use std::io::Read;
  21 use std::iter;
  22 use std::path::{Path, PathBuf};
  23 use std::process::Command;
  24
  25 use build_helper::{self, output};
  26
  27 use builder::{Builder, Compiler, Kind, RunConfig, ShouldRun, Step};
  28 use cache::{Interned, INTERNER};
  29 use compile;
  30 use dist;
  31 use flags::Subcommand;
  32 use native;
  33 use tool::{self, Tool, SourceType};
  34 use toolstate::ToolState;
  35 use util::{self, dylib_path, dylib_path_var};
  36 use Crate as CargoCrate;
  37 use {DocTests, Mode, GitRepo};
  38
  39 const ADB_TEST_DIR: &str = "/data/tmp/work";
  40
  41 /// The two modes of the test runner; tests or benchmarks.
  42 #[derive(Debug, PartialEq, Eq, Hash, Copy, Clone, PartialOrd, Ord)]
  43 pub enum TestKind {
  44     /// Run `cargo test`
  45     Test,
  46     /// Run `cargo bench`
  47     Bench,
  48 }
  49
  50 impl From<Kind> for TestKind {
  51     fn from(kind: Kind) -> Self {
  52         match kind {
  53             Kind::Test => TestKind::Test,
  54             Kind::Bench => TestKind::Bench,
  55             _ => panic!("unexpected kind in crate: {:?}", kind),
  56         }
  57     }
  58 }
  59
  60 impl TestKind {
  61     // Return the cargo subcommand for this test kind
  62     fn subcommand(self) -> &'static str {
  63         match self {
  64             TestKind::Test => "test",
  65             TestKind::Bench => "bench",
  66         }
  67     }
  68 }
  69
  70 impl fmt::Display for TestKind {
  71     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
  72         f.write_str(match *self {
  73             TestKind::Test => "Testing",
  74             TestKind::Bench => "Benchmarking",
  75         })
  76     }
  77 }
  78
  79 fn try_run(builder: &Builder, cmd: &mut Command) -> bool {
  80     if !builder.fail_fast {
  81         if !builder.try_run(cmd) {
  82             let mut failures = builder.delayed_failures.borrow_mut();
  83             failures.push(format!("{:?}", cmd));
  84             return false;
  85         }
  86     } else {
  87         builder.run(cmd);
  88     }
  89     true
  90 }
  91
  92 fn try_run_quiet(builder: &Builder, cmd: &mut Command) -> bool {
  93     if !builder.fail_fast {
  94         if !builder.try_run_quiet(cmd) {
  95             let mut failures = builder.delayed_failures.borrow_mut();
  96             failures.push(format!("{:?}", cmd));
  97             return false;
  98         }
  99     } else {
 100         builder.run_quiet(cmd);
 101     }
 102     true
 103 }
 104
 105 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 106 pub struct Linkcheck {
 107     host: Interned<String>,
 108 }
 109
 110 impl Step for Linkcheck {
 111     type Output = ();
 112     const ONLY_HOSTS: bool = true;
 113     const DEFAULT: bool = true;
 114
 115     /// Runs the `linkchecker` tool as compiled in `stage` by the `host` compiler.
 116     ///
 117     /// This tool in `src/tools` will verify the validity of all our links in the
 118     /// documentation to ensure we don't have a bunch of dead ones.
 119     fn run(self, builder: &Builder) {
 120         let host = self.host;
 121
 122         builder.info(&format!("Linkcheck ({})", host));
 123
 124         builder.default_doc(None);
 125
 126         let _time = util::timeit(&builder);
 127         try_run(
 128             builder,
 129             builder
 130                 .tool_cmd(Tool::Linkchecker)
 131                 .arg(builder.out.join(host).join("doc")),
 132         );
 133     }
 134
 135     fn should_run(run: ShouldRun) -> ShouldRun {
 136         let builder = run.builder;
 137         run.path("src/tools/linkchecker")
 138             .default_condition(builder.config.docs)
 139     }
 140
 141     fn make_run(run: RunConfig) {
 142         run.builder.ensure(Linkcheck { host: run.target });
 143     }
 144 }
 145
 146 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 147 pub struct Cargotest {
 148     stage: u32,
 149     host: Interned<String>,
 150 }
 151
 152 impl Step for Cargotest {
 153     type Output = ();
 154     const ONLY_HOSTS: bool = true;
 155
 156     fn should_run(run: ShouldRun) -> ShouldRun {
 157         run.path("src/tools/cargotest")
 158     }
 159
 160     fn make_run(run: RunConfig) {
 161         run.builder.ensure(Cargotest {
 162             stage: run.builder.top_stage,
 163             host: run.target,
 164         });
 165     }
 166
 167     /// Runs the `cargotest` tool as compiled in `stage` by the `host` compiler.
 168     ///
 169     /// This tool in `src/tools` will check out a few Rust projects and run `cargo
 170     /// test` to ensure that we don't regress the test suites there.
 171     fn run(self, builder: &Builder) {
 172         let compiler = builder.compiler(self.stage, self.host);
 173         builder.ensure(compile::Rustc {
 174             compiler,
 175             target: compiler.host,
 176         });
 177
 178         // Note that this is a short, cryptic, and not scoped directory name. This
 179         // is currently to minimize the length of path on Windows where we otherwise
 180         // quickly run into path name limit constraints.
 181         let out_dir = builder.out.join("ct");
 182         t!(fs::create_dir_all(&out_dir));
 183
 184         let _time = util::timeit(&builder);
 185         let mut cmd = builder.tool_cmd(Tool::CargoTest);
 186         try_run(
 187             builder,
 188             cmd.arg(&builder.initial_cargo)
 189                 .arg(&out_dir)
 190                 .env("RUSTC", builder.rustc(compiler))
 191                 .env("RUSTDOC", builder.rustdoc(compiler.host)),
 192         );
 193     }
 194 }
 195
 196 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 197 pub struct Cargo {
 198     stage: u32,
 199     host: Interned<String>,
 200 }
 201
 202 impl Step for Cargo {
 203     type Output = ();
 204     const ONLY_HOSTS: bool = true;
 205
 206     fn should_run(run: ShouldRun) -> ShouldRun {
 207         run.path("src/tools/cargo")
 208     }
 209
 210     fn make_run(run: RunConfig) {
 211         run.builder.ensure(Cargo {
 212             stage: run.builder.top_stage,
 213             host: run.target,
 214         });
 215     }
 216
 217     /// Runs `cargo test` for `cargo` packaged with Rust.
 218     fn run(self, builder: &Builder) {
 219         let compiler = builder.compiler(self.stage, self.host);
 220
 221         builder.ensure(tool::Cargo {
 222             compiler,
 223             target: self.host,
 224         });
 225         let mut cargo = tool::prepare_tool_cargo(builder,
 226                                                  compiler,
 227                                                  Mode::ToolRustc,
 228                                                  self.host,
 229                                                  "test",
 230                                                  "src/tools/cargo",
 231                                                  SourceType::Submodule);
 232
 233         if !builder.fail_fast {
 234             cargo.arg("--no-fail-fast");
 235         }
 236
 237         // Don't run cross-compile tests, we may not have cross-compiled libstd libs
 238         // available.
 239         cargo.env("CFG_DISABLE_CROSS_TESTS", "1");
 240         // Disable a test that has issues with mingw.
 241         cargo.env("CARGO_TEST_DISABLE_GIT_CLI", "1");
 242
 243         try_run(
 244             builder,
 245             cargo.env("PATH", &path_for_cargo(builder, compiler)),
 246         );
 247     }
 248 }
 249
 250 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 251 pub struct Rls {
 252     stage: u32,
 253     host: Interned<String>,
 254 }
 255
 256 impl Step for Rls {
 257     type Output = ();
 258     const ONLY_HOSTS: bool = true;
 259
 260     fn should_run(run: ShouldRun) -> ShouldRun {
 261         run.path("src/tools/rls")
 262     }
 263
 264     fn make_run(run: RunConfig) {
 265         run.builder.ensure(Rls {
 266             stage: run.builder.top_stage,
 267             host: run.target,
 268         });
 269     }
 270
 271     /// Runs `cargo test` for the rls.
 272     fn run(self, builder: &Builder) {
 273         let stage = self.stage;
 274         let host = self.host;
 275         let compiler = builder.compiler(stage, host);
 276
 277         let build_result = builder.ensure(tool::Rls {
 278             compiler,
 279             target: self.host,
 280             extra_features: Vec::new(),
 281         });
 282         if build_result.is_none() {
 283             eprintln!("failed to test rls: could not build");
 284             return;
 285         }
 286
 287         let mut cargo = tool::prepare_tool_cargo(builder,
 288                                                  compiler,
 289                                                  Mode::ToolRustc,
 290                                                  host,
 291                                                  "test",
 292                                                  "src/tools/rls",
 293                                                  SourceType::Submodule);
 294
 295         // Copy `src/tools/rls/test_data` to a writable drive.
 296         let test_workspace_path = builder.out.join("rls-test-data");
 297         let test_data_path = test_workspace_path.join("test_data");
 298         builder.create_dir(&test_data_path);
 299         builder.cp_r(&builder.src.join("src/tools/rls/test_data"), &test_data_path);
 300         cargo.env("RLS_TEST_WORKSPACE_DIR", test_workspace_path);
 301
 302         builder.add_rustc_lib_path(compiler, &mut cargo);
 303         cargo.arg("--")
 304             .args(builder.config.cmd.test_args());
 305
 306         if try_run(builder, &mut cargo) {
 307             builder.save_toolstate("rls", ToolState::TestPass);
 308         }
 309     }
 310 }
 311
 312 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 313 pub struct Rustfmt {
 314     stage: u32,
 315     host: Interned<String>,
 316 }
 317
 318 impl Step for Rustfmt {
 319     type Output = ();
 320     const ONLY_HOSTS: bool = true;
 321
 322     fn should_run(run: ShouldRun) -> ShouldRun {
 323         run.path("src/tools/rustfmt")
 324     }
 325
 326     fn make_run(run: RunConfig) {
 327         run.builder.ensure(Rustfmt {
 328             stage: run.builder.top_stage,
 329             host: run.target,
 330         });
 331     }
 332
 333     /// Runs `cargo test` for rustfmt.
 334     fn run(self, builder: &Builder) {
 335         let stage = self.stage;
 336         let host = self.host;
 337         let compiler = builder.compiler(stage, host);
 338
 339         let build_result = builder.ensure(tool::Rustfmt {
 340             compiler,
 341             target: self.host,
 342             extra_features: Vec::new(),
 343         });
 344         if build_result.is_none() {
 345             eprintln!("failed to test rustfmt: could not build");
 346             return;
 347         }
 348
 349         let mut cargo = tool::prepare_tool_cargo(builder,
 350                                                  compiler,
 351                                                  Mode::ToolRustc,
 352                                                  host,
 353                                                  "test",
 354                                                  "src/tools/rustfmt",
 355                                                  SourceType::Submodule);
 356
 357         let dir = testdir(builder, compiler.host);
 358         t!(fs::create_dir_all(&dir));
 359         cargo.env("RUSTFMT_TEST_DIR", dir);
 360
 361         builder.add_rustc_lib_path(compiler, &mut cargo);
 362
 363         if try_run(builder, &mut cargo) {
 364             builder.save_toolstate("rustfmt", ToolState::TestPass);
 365         }
 366     }
 367 }
 368
 369 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 370 pub struct Miri {
 371     stage: u32,
 372     host: Interned<String>,
 373 }
 374
 375 impl Step for Miri {
 376     type Output = ();
 377     const ONLY_HOSTS: bool = true;
 378     const DEFAULT: bool = true;
 379
 380     fn should_run(run: ShouldRun) -> ShouldRun {
 381         let test_miri = run.builder.config.test_miri;
 382         run.path("src/tools/miri").default_condition(test_miri)
 383     }
 384
 385     fn make_run(run: RunConfig) {
 386         run.builder.ensure(Miri {
 387             stage: run.builder.top_stage,
 388             host: run.target,
 389         });
 390     }
 391
 392     /// Runs `cargo test` for miri.
 393     fn run(self, builder: &Builder) {
 394         let stage = self.stage;
 395         let host = self.host;
 396         let compiler = builder.compiler(stage, host);
 397
 398         let miri = builder.ensure(tool::Miri {
 399             compiler,
 400             target: self.host,
 401             extra_features: Vec::new(),
 402         });
 403         if let Some(miri) = miri {
 404             let mut cargo = tool::prepare_tool_cargo(builder,
 405                                                  compiler,
 406                                                  Mode::ToolRustc,
 407                                                  host,
 408                                                  "test",
 409                                                  "src/tools/miri",
 410                                                  SourceType::Submodule);
 411
 412             // miri tests need to know about the stage sysroot
 413             cargo.env("MIRI_SYSROOT", builder.sysroot(compiler));
 414             cargo.env("RUSTC_TEST_SUITE", builder.rustc(compiler));
 415             cargo.env("RUSTC_LIB_PATH", builder.rustc_libdir(compiler));
 416             cargo.env("MIRI_PATH", miri);
 417
 418             builder.add_rustc_lib_path(compiler, &mut cargo);
 419
 420             if try_run(builder, &mut cargo) {
 421                 builder.save_toolstate("miri", ToolState::TestPass);
 422             }
 423         } else {
 424             eprintln!("failed to test miri: could not build");
 425         }
 426     }
 427 }
 428
 429 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 430 pub struct Clippy {
 431     stage: u32,
 432     host: Interned<String>,
 433 }
 434
 435 impl Step for Clippy {
 436     type Output = ();
 437     const ONLY_HOSTS: bool = true;
 438     const DEFAULT: bool = false;
 439
 440     fn should_run(run: ShouldRun) -> ShouldRun {
 441         run.path("src/tools/clippy")
 442     }
 443
 444     fn make_run(run: RunConfig) {
 445         run.builder.ensure(Clippy {
 446             stage: run.builder.top_stage,
 447             host: run.target,
 448         });
 449     }
 450
 451     /// Runs `cargo test` for clippy.
 452     fn run(self, builder: &Builder) {
 453         let stage = self.stage;
 454         let host = self.host;
 455         let compiler = builder.compiler(stage, host);
 456
 457         let clippy = builder.ensure(tool::Clippy {
 458             compiler,
 459             target: self.host,
 460             extra_features: Vec::new(),
 461         });
 462         if let Some(clippy) = clippy {
 463             let mut cargo = tool::prepare_tool_cargo(builder,
 464                                                  compiler,
 465                                                  Mode::ToolRustc,
 466                                                  host,
 467                                                  "test",
 468                                                  "src/tools/clippy",
 469                                                  SourceType::Submodule);
 470
 471             // clippy tests need to know about the stage sysroot
 472             cargo.env("SYSROOT", builder.sysroot(compiler));
 473             cargo.env("RUSTC_TEST_SUITE", builder.rustc(compiler));
 474             cargo.env("RUSTC_LIB_PATH", builder.rustc_libdir(compiler));
 475             let host_libs = builder
 476                 .stage_out(compiler, Mode::ToolRustc)
 477                 .join(builder.cargo_dir());
 478             cargo.env("HOST_LIBS", host_libs);
 479             // clippy tests need to find the driver
 480             cargo.env("CLIPPY_DRIVER_PATH", clippy);
 481
 482             builder.add_rustc_lib_path(compiler, &mut cargo);
 483
 484             if try_run(builder, &mut cargo) {
 485                 builder.save_toolstate("clippy-driver", ToolState::TestPass);
 486             }
 487         } else {
 488             eprintln!("failed to test clippy: could not build");
 489         }
 490     }
 491 }
 492
 493 fn path_for_cargo(builder: &Builder, compiler: Compiler) -> OsString {
 494     // Configure PATH to find the right rustc. NB. we have to use PATH
 495     // and not RUSTC because the Cargo test suite has tests that will
 496     // fail if rustc is not spelled `rustc`.
 497     let path = builder.sysroot(compiler).join("bin");
 498     let old_path = env::var_os("PATH").unwrap_or_default();
 499     env::join_paths(iter::once(path).chain(env::split_paths(&old_path))).expect("")
 500 }
 501
 502 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
 503 pub struct RustdocTheme {
 504     pub compiler: Compiler,
 505 }
 506
 507 impl Step for RustdocTheme {
 508     type Output = ();
 509     const DEFAULT: bool = true;
 510     const ONLY_HOSTS: bool = true;
 511
 512     fn should_run(run: ShouldRun) -> ShouldRun {
 513         run.path("src/tools/rustdoc-themes")
 514     }
 515
 516     fn make_run(run: RunConfig) {
 517         let compiler = run.builder.compiler(run.builder.top_stage, run.host);
 518
 519         run.builder.ensure(RustdocTheme { compiler: compiler });
 520     }
 521
 522     fn run(self, builder: &Builder) {
 523         let rustdoc = builder.out.join("bootstrap/debug/rustdoc");
 524         let mut cmd = builder.tool_cmd(Tool::RustdocTheme);
 525         cmd.arg(rustdoc.to_str().unwrap())
 526             .arg(
 527                 builder
 528                     .src
 529                     .join("src/librustdoc/html/static/themes")
 530                     .to_str()
 531                     .unwrap(),
 532             )
 533             .env("RUSTC_STAGE", self.compiler.stage.to_string())
 534             .env("RUSTC_SYSROOT", builder.sysroot(self.compiler))
 535             .env(
 536                 "RUSTDOC_LIBDIR",
 537                 builder.sysroot_libdir(self.compiler, self.compiler.host),
 538             )
 539             .env("CFG_RELEASE_CHANNEL", &builder.config.channel)
 540             .env("RUSTDOC_REAL", builder.rustdoc(self.compiler.host))
 541             .env("RUSTDOC_CRATE_VERSION", builder.rust_version())
 542             .env("RUSTC_BOOTSTRAP", "1");
 543         if let Some(linker) = builder.linker(self.compiler.host) {
 544             cmd.env("RUSTC_TARGET_LINKER", linker);
 545         }
 546         try_run(builder, &mut cmd);
 547     }
 548 }
 549
 550 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
 551 pub struct RustdocJS {
 552     pub host: Interned<String>,
 553     pub target: Interned<String>,
 554 }
 555
 556 impl Step for RustdocJS {
 557     type Output = ();
 558     const DEFAULT: bool = true;
 559     const ONLY_HOSTS: bool = true;
 560
 561     fn should_run(run: ShouldRun) -> ShouldRun {
 562         run.path("src/test/rustdoc-js")
 563     }
 564
 565     fn make_run(run: RunConfig) {
 566         run.builder.ensure(RustdocJS {
 567             host: run.host,
 568             target: run.target,
 569         });
 570     }
 571
 572     fn run(self, builder: &Builder) {
 573         if let Some(ref nodejs) = builder.config.nodejs {
 574             let mut command = Command::new(nodejs);
 575             command.args(&["src/tools/rustdoc-js/tester.js", &*self.host]);
 576             builder.ensure(::doc::Std {
 577                 target: self.target,
 578                 stage: builder.top_stage,
 579             });
 580             builder.run(&mut command);
 581         } else {
 582             builder.info(&format!(
 583                 "No nodejs found, skipping \"src/test/rustdoc-js\" tests"
 584             ));
 585         }
 586     }
 587 }
 588
 589 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
 590 pub struct RustdocUi {
 591     pub host: Interned<String>,
 592     pub target: Interned<String>,
 593     pub compiler: Compiler,
 594 }
 595
 596 impl Step for RustdocUi {
 597     type Output = ();
 598     const DEFAULT: bool = true;
 599     const ONLY_HOSTS: bool = true;
 600
 601     fn should_run(run: ShouldRun) -> ShouldRun {
 602         run.path("src/test/rustdoc-ui")
 603     }
 604
 605     fn make_run(run: RunConfig) {
 606         let compiler = run.builder.compiler(run.builder.top_stage, run.host);
 607         run.builder.ensure(RustdocUi {
 608             host: run.host,
 609             target: run.target,
 610             compiler,
 611         });
 612     }
 613
 614     fn run(self, builder: &Builder) {
 615         builder.ensure(Compiletest {
 616             compiler: self.compiler,
 617             target: self.target,
 618             mode: "ui",
 619             suite: "rustdoc-ui",
 620             path: None,
 621             compare_mode: None,
 622         })
 623     }
 624 }
 625
 626 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 627 pub struct Tidy;
 628
 629 impl Step for Tidy {
 630     type Output = ();
 631     const DEFAULT: bool = true;
 632     const ONLY_HOSTS: bool = true;
 633
 634     /// Runs the `tidy` tool.
 635     ///
 636     /// This tool in `src/tools` checks up on various bits and pieces of style and
 637     /// otherwise just implements a few lint-like checks that are specific to the
 638     /// compiler itself.
 639     fn run(self, builder: &Builder) {
 640         let mut cmd = builder.tool_cmd(Tool::Tidy);
 641         cmd.arg(builder.src.join("src"));
 642         cmd.arg(&builder.initial_cargo);
 643         if !builder.config.vendor {
 644             cmd.arg("--no-vendor");
 645         }
 646         if !builder.config.verbose_tests {
 647             cmd.arg("--quiet");
 648         }
 649
 650         let _folder = builder.fold_output(|| "tidy");
 651         builder.info(&format!("tidy check"));
 652         try_run(builder, &mut cmd);
 653     }
 654
 655     fn should_run(run: ShouldRun) -> ShouldRun {
 656         run.path("src/tools/tidy")
 657     }
 658
 659     fn make_run(run: RunConfig) {
 660         run.builder.ensure(Tidy);
 661     }
 662 }
 663
 664 fn testdir(builder: &Builder, host: Interned<String>) -> PathBuf {
 665     builder.out.join(host).join("test")
 666 }
 667
 668 macro_rules! default_test {
 669     ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr }) => {
 670         test!($name { path: $path, mode: $mode, suite: $suite, default: true, host: false });
 671     }
 672 }
 673
 674 macro_rules! default_test_with_compare_mode {
 675     ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr,
 676                    compare_mode: $compare_mode:expr }) => {
 677         test_with_compare_mode!($name { path: $path, mode: $mode, suite: $suite, default: true,
 678                                         host: false, compare_mode: $compare_mode });
 679     }
 680 }
 681
 682 macro_rules! host_test {
 683     ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr }) => {
 684         test!($name { path: $path, mode: $mode, suite: $suite, default: true, host: true });
 685     }
 686 }
 687
 688 macro_rules! test {
 689     ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr, default: $default:expr,
 690                    host: $host:expr }) => {
 691         test_definitions!($name { path: $path, mode: $mode, suite: $suite, default: $default,
 692                                   host: $host, compare_mode: None });
 693     }
 694 }
 695
 696 macro_rules! test_with_compare_mode {
 697     ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr, default: $default:expr,
 698                    host: $host:expr, compare_mode: $compare_mode:expr }) => {
 699         test_definitions!($name { path: $path, mode: $mode, suite: $suite, default: $default,
 700                                   host: $host, compare_mode: Some($compare_mode) });
 701     }
 702 }
 703
 704 macro_rules! test_definitions {
 705     ($name:ident {
 706         path: $path:expr,
 707         mode: $mode:expr,
 708         suite: $suite:expr,
 709         default: $default:expr,
 710         host: $host:expr,
 711         compare_mode: $compare_mode:expr
 712     }) => {
 713         #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 714         pub struct $name {
 715             pub compiler: Compiler,
 716             pub target: Interned<String>,
 717         }
 718
 719         impl Step for $name {
 720             type Output = ();
 721             const DEFAULT: bool = $default;
 722             const ONLY_HOSTS: bool = $host;
 723
 724             fn should_run(run: ShouldRun) -> ShouldRun {
 725                 run.suite_path($path)
 726             }
 727
 728             fn make_run(run: RunConfig) {
 729                 let compiler = run.builder.compiler(run.builder.top_stage, run.host);
 730
 731                 run.builder.ensure($name {
 732                     compiler,
 733                     target: run.target,
 734                 });
 735             }
 736
 737             fn run(self, builder: &Builder) {
 738                 builder.ensure(Compiletest {
 739                     compiler: self.compiler,
 740                     target: self.target,
 741                     mode: $mode,
 742                     suite: $suite,
 743                     path: Some($path),
 744                     compare_mode: $compare_mode,
 745                 })
 746             }
 747         }
 748     }
 749 }
 750
 751 default_test_with_compare_mode!(Ui {
 752     path: "src/test/ui",
 753     mode: "ui",
 754     suite: "ui",
 755     compare_mode: "nll"
 756 });
 757
 758 default_test_with_compare_mode!(RunPass {
 759     path: "src/test/run-pass",
 760     mode: "run-pass",
 761     suite: "run-pass",
 762     compare_mode: "nll"
 763 });
 764
 765 default_test!(CompileFail {
 766     path: "src/test/compile-fail",
 767     mode: "compile-fail",
 768     suite: "compile-fail"
 769 });
 770
 771 default_test!(ParseFail {
 772     path: "src/test/parse-fail",
 773     mode: "parse-fail",
 774     suite: "parse-fail"
 775 });
 776
 777 default_test!(RunFail {
 778     path: "src/test/run-fail",
 779     mode: "run-fail",
 780     suite: "run-fail"
 781 });
 782
 783 default_test!(RunPassValgrind {
 784     path: "src/test/run-pass-valgrind",
 785     mode: "run-pass-valgrind",
 786     suite: "run-pass-valgrind"
 787 });
 788
 789 default_test!(MirOpt {
 790     path: "src/test/mir-opt",
 791     mode: "mir-opt",
 792     suite: "mir-opt"
 793 });
 794
 795 default_test!(Codegen {
 796     path: "src/test/codegen",
 797     mode: "codegen",
 798     suite: "codegen"
 799 });
 800
 801 default_test!(CodegenUnits {
 802     path: "src/test/codegen-units",
 803     mode: "codegen-units",
 804     suite: "codegen-units"
 805 });
 806
 807 default_test!(Incremental {
 808     path: "src/test/incremental",
 809     mode: "incremental",
 810     suite: "incremental"
 811 });
 812
 813 default_test!(Debuginfo {
 814     path: "src/test/debuginfo",
 815     mode: "debuginfo",
 816     suite: "debuginfo"
 817 });
 818
 819 host_test!(UiFullDeps {
 820     path: "src/test/ui-fulldeps",
 821     mode: "ui",
 822     suite: "ui-fulldeps"
 823 });
 824
 825 host_test!(RunPassFullDeps {
 826     path: "src/test/run-pass-fulldeps",
 827     mode: "run-pass",
 828     suite: "run-pass-fulldeps"
 829 });
 830
 831 host_test!(RunFailFullDeps {
 832     path: "src/test/run-fail-fulldeps",
 833     mode: "run-fail",
 834     suite: "run-fail-fulldeps"
 835 });
 836
 837 host_test!(CompileFailFullDeps {
 838     path: "src/test/compile-fail-fulldeps",
 839     mode: "compile-fail",
 840     suite: "compile-fail-fulldeps"
 841 });
 842
 843 host_test!(IncrementalFullDeps {
 844     path: "src/test/incremental-fulldeps",
 845     mode: "incremental",
 846     suite: "incremental-fulldeps"
 847 });
 848
 849 host_test!(Rustdoc {
 850     path: "src/test/rustdoc",
 851     mode: "rustdoc",
 852     suite: "rustdoc"
 853 });
 854
 855 test!(Pretty {
 856     path: "src/test/pretty",
 857     mode: "pretty",
 858     suite: "pretty",
 859     default: false,
 860     host: true
 861 });
 862 test!(RunPassPretty {
 863     path: "src/test/run-pass/pretty",
 864     mode: "pretty",
 865     suite: "run-pass",
 866     default: false,
 867     host: true
 868 });
 869 test!(RunFailPretty {
 870     path: "src/test/run-fail/pretty",
 871     mode: "pretty",
 872     suite: "run-fail",
 873     default: false,
 874     host: true
 875 });
 876 test!(RunPassValgrindPretty {
 877     path: "src/test/run-pass-valgrind/pretty",
 878     mode: "pretty",
 879     suite: "run-pass-valgrind",
 880     default: false,
 881     host: true
 882 });
 883 test!(RunPassFullDepsPretty {
 884     path: "src/test/run-pass-fulldeps/pretty",
 885     mode: "pretty",
 886     suite: "run-pass-fulldeps",
 887     default: false,
 888     host: true
 889 });
 890 test!(RunFailFullDepsPretty {
 891     path: "src/test/run-fail-fulldeps/pretty",
 892     mode: "pretty",
 893     suite: "run-fail-fulldeps",
 894     default: false,
 895     host: true
 896 });
 897
 898 default_test!(RunMake {
 899     path: "src/test/run-make",
 900     mode: "run-make",
 901     suite: "run-make"
 902 });
 903
 904 host_test!(RunMakeFullDeps {
 905     path: "src/test/run-make-fulldeps",
 906     mode: "run-make",
 907     suite: "run-make-fulldeps"
 908 });
 909
 910 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 911 struct Compiletest {
 912     compiler: Compiler,
 913     target: Interned<String>,
 914     mode: &'static str,
 915     suite: &'static str,
 916     path: Option<&'static str>,
 917     compare_mode: Option<&'static str>,
 918 }
 919
 920 impl Step for Compiletest {
 921     type Output = ();
 922
 923     fn should_run(run: ShouldRun) -> ShouldRun {
 924         run.never()
 925     }
 926
 927     /// Executes the `compiletest` tool to run a suite of tests.
 928     ///
 929     /// Compiles all tests with `compiler` for `target` with the specified
 930     /// compiletest `mode` and `suite` arguments. For example `mode` can be
 931     /// "run-pass" or `suite` can be something like `debuginfo`.
 932     fn run(self, builder: &Builder) {
 933         let compiler = self.compiler;
 934         let target = self.target;
 935         let mode = self.mode;
 936         let suite = self.suite;
 937
 938         // Path for test suite
 939         let suite_path = self.path.unwrap_or("");
 940
 941         // Skip codegen tests if they aren't enabled in configuration.
 942         if !builder.config.codegen_tests && suite == "codegen" {
 943             return;
 944         }
 945
 946         if suite == "debuginfo" {
 947             // Skip debuginfo tests on MSVC
 948             if builder.config.build.contains("msvc") {
 949                 return;
 950             }
 951
 952             if mode == "debuginfo" {
 953                 return builder.ensure(Compiletest {
 954                     mode: "debuginfo-both",
 955                     ..self
 956                 });
 957             }
 958
 959             builder.ensure(dist::DebuggerScripts {
 960                 sysroot: builder.sysroot(compiler),
 961                 host: target,
 962             });
 963         }
 964
 965         if suite.ends_with("fulldeps") ||
 966             // FIXME: Does pretty need librustc compiled? Note that there are
 967             // fulldeps test suites with mode = pretty as well.
 968             mode == "pretty"
 969         {
 970             builder.ensure(compile::Rustc { compiler, target });
 971         }
 972
 973         if builder.no_std(target) == Some(true) {
 974             // the `test` doesn't compile for no-std targets
 975             builder.ensure(compile::Std { compiler, target });
 976         } else {
 977             builder.ensure(compile::Test { compiler, target });
 978         }
 979
 980         if builder.no_std(target) == Some(true) {
 981             // for no_std run-make (e.g. thumb*),
 982             // we need a host compiler which is called by cargo.
 983             builder.ensure(compile::Std { compiler, target: compiler.host });
 984         }
 985
 986         builder.ensure(native::TestHelpers { target });
 987         builder.ensure(RemoteCopyLibs { compiler, target });
 988
 989         let mut cmd = builder.tool_cmd(Tool::Compiletest);
 990
 991         // compiletest currently has... a lot of arguments, so let's just pass all
 992         // of them!
 993
 994         cmd.arg("--compile-lib-path")
 995             .arg(builder.rustc_libdir(compiler));
 996         cmd.arg("--run-lib-path")
 997             .arg(builder.sysroot_libdir(compiler, target));
 998         cmd.arg("--rustc-path").arg(builder.rustc(compiler));
 999
1000         let is_rustdoc_ui = suite.ends_with("rustdoc-ui");
1001
1002         // Avoid depending on rustdoc when we don't need it.
1003         if mode == "rustdoc"
1004             || (mode == "run-make" && suite.ends_with("fulldeps"))
1005             || (mode == "ui" && is_rustdoc_ui)
1006         {
1007             cmd.arg("--rustdoc-path")
1008                 .arg(builder.rustdoc(compiler.host));
1009         }
1010
1011         cmd.arg("--src-base")
1012             .arg(builder.src.join("src/test").join(suite));
1013         cmd.arg("--build-base")
1014             .arg(testdir(builder, compiler.host).join(suite));
1015         cmd.arg("--stage-id")
1016             .arg(format!("stage{}-{}", compiler.stage, target));
1017         cmd.arg("--mode").arg(mode);
1018         cmd.arg("--target").arg(target);
1019         cmd.arg("--host").arg(&*compiler.host);
1020         cmd.arg("--llvm-filecheck")
1021             .arg(builder.llvm_filecheck(builder.config.build));
1022
1023         if builder.config.cmd.bless() {
1024             cmd.arg("--bless");
1025         }
1026
1027         let compare_mode = builder.config.cmd.compare_mode().or(self.compare_mode);
1028
1029         if let Some(ref nodejs) = builder.config.nodejs {
1030             cmd.arg("--nodejs").arg(nodejs);
1031         }
1032
1033         let mut flags = if is_rustdoc_ui {
1034             Vec::new()
1035         } else {
1036             vec!["-Crpath".to_string()]
1037         };
1038         if !is_rustdoc_ui {
1039             if builder.config.rust_optimize_tests {
1040                 flags.push("-O".to_string());
1041             }
1042             if builder.config.rust_debuginfo_tests {
1043                 flags.push("-g".to_string());
1044             }
1045         }
1046         flags.push("-Zunstable-options".to_string());
1047         flags.push(builder.config.cmd.rustc_args().join(" "));
1048
1049         if let Some(linker) = builder.linker(target) {
1050             cmd.arg("--linker").arg(linker);
1051         }
1052
1053         let hostflags = flags.clone();
1054         cmd.arg("--host-rustcflags").arg(hostflags.join(" "));
1055
1056         let mut targetflags = flags.clone();
1057         targetflags.push(format!(
1058             "-Lnative={}",
1059             builder.test_helpers_out(target).display()
1060         ));
1061         cmd.arg("--target-rustcflags").arg(targetflags.join(" "));
1062
1063         cmd.arg("--docck-python").arg(builder.python());
1064
1065         if builder.config.build.ends_with("apple-darwin") {
1066             // Force /usr/bin/python on macOS for LLDB tests because we're loading the
1067             // LLDB plugin's compiled module which only works with the system python
1068             // (namely not Homebrew-installed python)
1069             cmd.arg("--lldb-python").arg("/usr/bin/python");
1070         } else {
1071             cmd.arg("--lldb-python").arg(builder.python());
1072         }
1073
1074         if let Some(ref gdb) = builder.config.gdb {
1075             cmd.arg("--gdb").arg(gdb);
1076         }
1077
1078         let run = |cmd: &mut Command| {
1079             cmd.output().map(|output| {
1080                 String::from_utf8_lossy(&output.stdout)
1081                     .lines().next().unwrap_or_else(|| {
1082                         panic!("{:?} failed {:?}", cmd, output)
1083                     }).to_string()
1084             })
1085         };
1086         let lldb_exe = if builder.config.lldb_enabled && !target.contains("emscripten") {
1087             // Test against the lldb that was just built.
1088             builder.llvm_out(target)
1089                 .join("bin")
1090                 .join("lldb")
1091         } else {
1092             PathBuf::from("lldb")
1093         };
1094         let lldb_version = Command::new(&lldb_exe)
1095             .arg("--version")
1096             .output()
1097             .map(|output| { String::from_utf8_lossy(&output.stdout).to_string() })
1098             .ok();
1099         if let Some(ref vers) = lldb_version {
1100             cmd.arg("--lldb-version").arg(vers);
1101             let lldb_python_dir = run(Command::new(&lldb_exe).arg("-P")).ok();
1102             if let Some(ref dir) = lldb_python_dir {
1103                 cmd.arg("--lldb-python-dir").arg(dir);
1104             }
1105         }
1106
1107         // Get paths from cmd args
1108         let paths = match &builder.config.cmd {
1109             Subcommand::Test { ref paths, .. } => &paths[..],
1110             _ => &[],
1111         };
1112
1113         // Get test-args by striping suite path
1114         let mut test_args: Vec<&str> = paths
1115             .iter()
1116             .map(|p| {
1117                 match p.strip_prefix(".") {
1118                     Ok(path) => path,
1119                     Err(_) => p,
1120                 }
1121             })
1122             .filter(|p| p.starts_with(suite_path) && p.is_file())
1123             .map(|p| p.strip_prefix(suite_path).unwrap().to_str().unwrap())
1124             .collect();
1125
1126         test_args.append(&mut builder.config.cmd.test_args());
1127
1128         cmd.args(&test_args);
1129
1130         if builder.is_verbose() {
1131             cmd.arg("--verbose");
1132         }
1133
1134         if !builder.config.verbose_tests {
1135             cmd.arg("--quiet");
1136         }
1137
1138         if builder.config.llvm_enabled {
1139             let llvm_config = builder.ensure(native::Llvm {
1140                 target: builder.config.build,
1141                 emscripten: false,
1142             });
1143             if !builder.config.dry_run {
1144                 let llvm_version = output(Command::new(&llvm_config).arg("--version"));
1145                 cmd.arg("--llvm-version").arg(llvm_version);
1146             }
1147             if !builder.is_rust_llvm(target) {
1148                 cmd.arg("--system-llvm");
1149             }
1150
1151             // Only pass correct values for these flags for the `run-make` suite as it
1152             // requires that a C++ compiler was configured which isn't always the case.
1153             if !builder.config.dry_run && suite == "run-make-fulldeps" {
1154                 let llvm_components = output(Command::new(&llvm_config).arg("--components"));
1155                 let llvm_cxxflags = output(Command::new(&llvm_config).arg("--cxxflags"));
1156                 cmd.arg("--cc")
1157                     .arg(builder.cc(target))
1158                     .arg("--cxx")
1159                     .arg(builder.cxx(target).unwrap())
1160                     .arg("--cflags")
1161                     .arg(builder.cflags(target, GitRepo::Rustc).join(" "))
1162                     .arg("--llvm-components")
1163                     .arg(llvm_components.trim())
1164                     .arg("--llvm-cxxflags")
1165                     .arg(llvm_cxxflags.trim());
1166                 if let Some(ar) = builder.ar(target) {
1167                     cmd.arg("--ar").arg(ar);
1168                 }
1169             }
1170         }
1171         if suite == "run-make-fulldeps" && !builder.config.llvm_enabled {
1172             builder.info(&format!(
1173                 "Ignoring run-make test suite as they generally don't work without LLVM"
1174             ));
1175             return;
1176         }
1177
1178         if suite != "run-make-fulldeps" {
1179             cmd.arg("--cc")
1180                 .arg("")
1181                 .arg("--cxx")
1182                 .arg("")
1183                 .arg("--cflags")
1184                 .arg("")
1185                 .arg("--llvm-components")
1186                 .arg("")
1187                 .arg("--llvm-cxxflags")
1188                 .arg("");
1189         }
1190
1191         if builder.remote_tested(target) {
1192             cmd.arg("--remote-test-client")
1193                 .arg(builder.tool_exe(Tool::RemoteTestClient));
1194         }
1195
1196         // Running a C compiler on MSVC requires a few env vars to be set, to be
1197         // sure to set them here.
1198         //
1199         // Note that if we encounter `PATH` we make sure to append to our own `PATH`
1200         // rather than stomp over it.
1201         if target.contains("msvc") {
1202             for &(ref k, ref v) in builder.cc[&target].env() {
1203                 if k != "PATH" {
1204                     cmd.env(k, v);
1205                 }
1206             }
1207         }
1208         cmd.env("RUSTC_BOOTSTRAP", "1");
1209         builder.add_rust_test_threads(&mut cmd);
1210
1211         if builder.config.sanitizers {
1212             cmd.env("SANITIZER_SUPPORT", "1");
1213         }
1214
1215         if builder.config.profiler {
1216             cmd.env("PROFILER_SUPPORT", "1");
1217         }
1218
1219         cmd.env("RUST_TEST_TMPDIR", builder.out.join("tmp"));
1220
1221         cmd.arg("--adb-path").arg("adb");
1222         cmd.arg("--adb-test-dir").arg(ADB_TEST_DIR);
1223         if target.contains("android") {
1224             // Assume that cc for this target comes from the android sysroot
1225             cmd.arg("--android-cross-path")
1226                 .arg(builder.cc(target).parent().unwrap().parent().unwrap());
1227         } else {
1228             cmd.arg("--android-cross-path").arg("");
1229         }
1230
1231         builder.ci_env.force_coloring_in_ci(&mut cmd);
1232
1233         let _folder = builder.fold_output(|| format!("test_{}", suite));
1234         builder.info(&format!(
1235             "Check compiletest suite={} mode={} ({} -> {})",
1236             suite, mode, &compiler.host, target
1237         ));
1238         let _time = util::timeit(&builder);
1239         try_run(builder, &mut cmd);
1240
1241         if let Some(compare_mode) = compare_mode {
1242             cmd.arg("--compare-mode").arg(compare_mode);
1243             let _folder = builder.fold_output(|| format!("test_{}_{}", suite, compare_mode));
1244             builder.info(&format!(
1245                 "Check compiletest suite={} mode={} compare_mode={} ({} -> {})",
1246                 suite, mode, compare_mode, &compiler.host, target
1247             ));
1248             let _time = util::timeit(&builder);
1249             try_run(builder, &mut cmd);
1250         }
1251     }
1252 }
1253
1254 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1255 struct DocTest {
1256     compiler: Compiler,
1257     path: &'static str,
1258     name: &'static str,
1259     is_ext_doc: bool,
1260 }
1261
1262 impl Step for DocTest {
1263     type Output = ();
1264     const ONLY_HOSTS: bool = true;
1265
1266     fn should_run(run: ShouldRun) -> ShouldRun {
1267         run.never()
1268     }
1269
1270     /// Run `rustdoc --test` for all documentation in `src/doc`.
1271     ///
1272     /// This will run all tests in our markdown documentation (e.g. the book)
1273     /// located in `src/doc`. The `rustdoc` that's run is the one that sits next to
1274     /// `compiler`.
1275     fn run(self, builder: &Builder) {
1276         let compiler = self.compiler;
1277
1278         builder.ensure(compile::Test {
1279             compiler,
1280             target: compiler.host,
1281         });
1282
1283         // Do a breadth-first traversal of the `src/doc` directory and just run
1284         // tests for all files that end in `*.md`
1285         let mut stack = vec![builder.src.join(self.path)];
1286         let _time = util::timeit(&builder);
1287         let _folder = builder.fold_output(|| format!("test_{}", self.name));
1288
1289         let mut files = Vec::new();
1290         while let Some(p) = stack.pop() {
1291             if p.is_dir() {
1292                 stack.extend(t!(p.read_dir()).map(|p| t!(p).path()));
1293                 continue;
1294             }
1295
1296             if p.extension().and_then(|s| s.to_str()) != Some("md") {
1297                 continue;
1298             }
1299
1300             // The nostarch directory in the book is for no starch, and so isn't
1301             // guaranteed to builder. We don't care if it doesn't build, so skip it.
1302             if p.to_str().map_or(false, |p| p.contains("nostarch")) {
1303                 continue;
1304             }
1305
1306             files.push(p);
1307         }
1308
1309         files.sort();
1310
1311         let mut toolstate = ToolState::TestPass;
1312         for file in files {
1313             if !markdown_test(builder, compiler, &file) {
1314                 toolstate = ToolState::TestFail;
1315             }
1316         }
1317         if self.is_ext_doc {
1318             builder.save_toolstate(self.name, toolstate);
1319         }
1320     }
1321 }
1322
1323 macro_rules! test_book {
1324     ($($name:ident, $path:expr, $book_name:expr, default=$default:expr;)+) => {
1325         $(
1326             #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1327             pub struct $name {
1328                 compiler: Compiler,
1329             }
1330
1331             impl Step for $name {
1332                 type Output = ();
1333                 const DEFAULT: bool = $default;
1334                 const ONLY_HOSTS: bool = true;
1335
1336                 fn should_run(run: ShouldRun) -> ShouldRun {
1337                     run.path($path)
1338                 }
1339
1340                 fn make_run(run: RunConfig) {
1341                     run.builder.ensure($name {
1342                         compiler: run.builder.compiler(run.builder.top_stage, run.host),
1343                     });
1344                 }
1345
1346                 fn run(self, builder: &Builder) {
1347                     builder.ensure(DocTest {
1348                         compiler: self.compiler,
1349                         path: $path,
1350                         name: $book_name,
1351                         is_ext_doc: !$default,
1352                     });
1353                 }
1354             }
1355         )+
1356     }
1357 }
1358
1359 test_book!(
1360     Nomicon, "src/doc/nomicon", "nomicon", default=false;
1361     Reference, "src/doc/reference", "reference", default=false;
1362     RustdocBook, "src/doc/rustdoc", "rustdoc", default=true;
1363     RustcBook, "src/doc/rustc", "rustc", default=true;
1364     RustByExample, "src/doc/rust-by-example", "rust-by-example", default=false;
1365     TheBook, "src/doc/book", "book", default=false;
1366     UnstableBook, "src/doc/unstable-book", "unstable-book", default=true;
1367 );
1368
1369 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1370 pub struct ErrorIndex {
1371     compiler: Compiler,
1372 }
1373
1374 impl Step for ErrorIndex {
1375     type Output = ();
1376     const DEFAULT: bool = true;
1377     const ONLY_HOSTS: bool = true;
1378
1379     fn should_run(run: ShouldRun) -> ShouldRun {
1380         run.path("src/tools/error_index_generator")
1381     }
1382
1383     fn make_run(run: RunConfig) {
1384         run.builder.ensure(ErrorIndex {
1385             compiler: run.builder.compiler(run.builder.top_stage, run.host),
1386         });
1387     }
1388
1389     /// Run the error index generator tool to execute the tests located in the error
1390     /// index.
1391     ///
1392     /// The `error_index_generator` tool lives in `src/tools` and is used to
1393     /// generate a markdown file from the error indexes of the code base which is
1394     /// then passed to `rustdoc --test`.
1395     fn run(self, builder: &Builder) {
1396         let compiler = self.compiler;
1397
1398         builder.ensure(compile::Std {
1399             compiler,
1400             target: compiler.host,
1401         });
1402
1403         let dir = testdir(builder, compiler.host);
1404         t!(fs::create_dir_all(&dir));
1405         let output = dir.join("error-index.md");
1406
1407         let mut tool = builder.tool_cmd(Tool::ErrorIndex);
1408         tool.arg("markdown")
1409             .arg(&output)
1410             .env("CFG_BUILD", &builder.config.build)
1411             .env("RUSTC_ERROR_METADATA_DST", builder.extended_error_dir());
1412
1413         let _folder = builder.fold_output(|| "test_error_index");
1414         builder.info(&format!("Testing error-index stage{}", compiler.stage));
1415         let _time = util::timeit(&builder);
1416         builder.run(&mut tool);
1417         markdown_test(builder, compiler, &output);
1418     }
1419 }
1420
1421 fn markdown_test(builder: &Builder, compiler: Compiler, markdown: &Path) -> bool {
1422     match File::open(markdown) {
1423         Ok(mut file) => {
1424             let mut contents = String::new();
1425             t!(file.read_to_string(&mut contents));
1426             if !contents.contains("```") {
1427                 return true;
1428             }
1429         }
1430         Err(_) => {}
1431     }
1432
1433     builder.info(&format!("doc tests for: {}", markdown.display()));
1434     let mut cmd = builder.rustdoc_cmd(compiler.host);
1435     builder.add_rust_test_threads(&mut cmd);
1436     cmd.arg("--test");
1437     cmd.arg(markdown);
1438     cmd.env("RUSTC_BOOTSTRAP", "1");
1439
1440     let test_args = builder.config.cmd.test_args().join(" ");
1441     cmd.arg("--test-args").arg(test_args);
1442
1443     if builder.config.verbose_tests {
1444         try_run(builder, &mut cmd)
1445     } else {
1446         try_run_quiet(builder, &mut cmd)
1447     }
1448 }
1449
1450 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1451 pub struct CrateLibrustc {
1452     compiler: Compiler,
1453     target: Interned<String>,
1454     test_kind: TestKind,
1455     krate: Interned<String>,
1456 }
1457
1458 impl Step for CrateLibrustc {
1459     type Output = ();
1460     const DEFAULT: bool = true;
1461     const ONLY_HOSTS: bool = true;
1462
1463     fn should_run(run: ShouldRun) -> ShouldRun {
1464         run.krate("rustc-main")
1465     }
1466
1467     fn make_run(run: RunConfig) {
1468         let builder = run.builder;
1469         let compiler = builder.compiler(builder.top_stage, run.host);
1470
1471         for krate in builder.in_tree_crates("rustc-main") {
1472             if run.path.ends_with(&krate.path) {
1473                 let test_kind = builder.kind.into();
1474
1475                 builder.ensure(CrateLibrustc {
1476                     compiler,
1477                     target: run.target,
1478                     test_kind,
1479                     krate: krate.name,
1480                 });
1481             }
1482         }
1483     }
1484
1485     fn run(self, builder: &Builder) {
1486         builder.ensure(Crate {
1487             compiler: self.compiler,
1488             target: self.target,
1489             mode: Mode::Rustc,
1490             test_kind: self.test_kind,
1491             krate: self.krate,
1492         });
1493     }
1494 }
1495
1496 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1497 pub struct CrateNotDefault {
1498     compiler: Compiler,
1499     target: Interned<String>,
1500     test_kind: TestKind,
1501     krate: &'static str,
1502 }
1503
1504 impl Step for CrateNotDefault {
1505     type Output = ();
1506
1507     fn should_run(run: ShouldRun) -> ShouldRun {
1508         run.path("src/liballoc_jemalloc")
1509             .path("src/librustc_asan")
1510             .path("src/librustc_lsan")
1511             .path("src/librustc_msan")
1512             .path("src/librustc_tsan")
1513     }
1514
1515     fn make_run(run: RunConfig) {
1516         let builder = run.builder;
1517         let compiler = builder.compiler(builder.top_stage, run.host);
1518
1519         let test_kind = builder.kind.into();
1520
1521         builder.ensure(CrateNotDefault {
1522             compiler,
1523             target: run.target,
1524             test_kind,
1525             krate: match run.path {
1526                 _ if run.path.ends_with("src/liballoc_jemalloc") => "alloc_jemalloc",
1527                 _ if run.path.ends_with("src/librustc_asan") => "rustc_asan",
1528                 _ if run.path.ends_with("src/librustc_lsan") => "rustc_lsan",
1529                 _ if run.path.ends_with("src/librustc_msan") => "rustc_msan",
1530                 _ if run.path.ends_with("src/librustc_tsan") => "rustc_tsan",
1531                 _ => panic!("unexpected path {:?}", run.path),
1532             },
1533         });
1534     }
1535
1536     fn run(self, builder: &Builder) {
1537         builder.ensure(Crate {
1538             compiler: self.compiler,
1539             target: self.target,
1540             mode: Mode::Std,
1541             test_kind: self.test_kind,
1542             krate: INTERNER.intern_str(self.krate),
1543         });
1544     }
1545 }
1546
1547 #[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
1548 pub struct Crate {
1549     pub compiler: Compiler,
1550     pub target: Interned<String>,
1551     pub mode: Mode,
1552     pub test_kind: TestKind,
1553     pub krate: Interned<String>,
1554 }
1555
1556 impl Step for Crate {
1557     type Output = ();
1558     const DEFAULT: bool = true;
1559
1560     fn should_run(mut run: ShouldRun) -> ShouldRun {
1561         let builder = run.builder;
1562         run = run.krate("test");
1563         for krate in run.builder.in_tree_crates("std") {
1564             if krate.is_local(&run.builder)
1565                 && !krate.name.contains("jemalloc")
1566                 && !(krate.name.starts_with("rustc_") && krate.name.ends_with("san"))
1567                 && krate.name != "dlmalloc"
1568             {
1569                 run = run.path(krate.local_path(&builder).to_str().unwrap());
1570             }
1571         }
1572         run
1573     }
1574
1575     fn make_run(run: RunConfig) {
1576         let builder = run.builder;
1577         let compiler = builder.compiler(builder.top_stage, run.host);
1578
1579         let make = |mode: Mode, krate: &CargoCrate| {
1580             let test_kind = builder.kind.into();
1581
1582             builder.ensure(Crate {
1583                 compiler,
1584                 target: run.target,
1585                 mode,
1586                 test_kind,
1587                 krate: krate.name,
1588             });
1589         };
1590
1591         for krate in builder.in_tree_crates("std") {
1592             if run.path.ends_with(&krate.local_path(&builder)) {
1593                 make(Mode::Std, krate);
1594             }
1595         }
1596         for krate in builder.in_tree_crates("test") {
1597             if run.path.ends_with(&krate.local_path(&builder)) {
1598                 make(Mode::Test, krate);
1599             }
1600         }
1601     }
1602
1603     /// Run all unit tests plus documentation tests for a given crate defined
1604     /// by a `Cargo.toml` (single manifest)
1605     ///
1606     /// This is what runs tests for crates like the standard library, compiler, etc.
1607     /// It essentially is the driver for running `cargo test`.
1608     ///
1609     /// Currently this runs all tests for a DAG by passing a bunch of `-p foo`
1610     /// arguments, and those arguments are discovered from `cargo metadata`.
1611     fn run(self, builder: &Builder) {
1612         let compiler = self.compiler;
1613         let target = self.target;
1614         let mode = self.mode;
1615         let test_kind = self.test_kind;
1616         let krate = self.krate;
1617
1618         builder.ensure(compile::Test { compiler, target });
1619         builder.ensure(RemoteCopyLibs { compiler, target });
1620
1621         // If we're not doing a full bootstrap but we're testing a stage2 version of
1622         // libstd, then what we're actually testing is the libstd produced in
1623         // stage1. Reflect that here by updating the compiler that we're working
1624         // with automatically.
1625         let compiler = if builder.force_use_stage1(compiler, target) {
1626             builder.compiler(1, compiler.host)
1627         } else {
1628             compiler.clone()
1629         };
1630
1631         let mut cargo = builder.cargo(compiler, mode, target, test_kind.subcommand());
1632         match mode {
1633             Mode::Std => {
1634                 compile::std_cargo(builder, &compiler, target, &mut cargo);
1635             }
1636             Mode::Test => {
1637                 compile::test_cargo(builder, &compiler, target, &mut cargo);
1638             }
1639             Mode::Rustc => {
1640                 builder.ensure(compile::Rustc { compiler, target });
1641                 compile::rustc_cargo(builder, &mut cargo);
1642             }
1643             _ => panic!("can only test libraries"),
1644         };
1645
1646         // Build up the base `cargo test` command.
1647         //
1648         // Pass in some standard flags then iterate over the graph we've discovered
1649         // in `cargo metadata` with the maps above and figure out what `-p`
1650         // arguments need to get passed.
1651         if test_kind.subcommand() == "test" && !builder.fail_fast {
1652             cargo.arg("--no-fail-fast");
1653         }
1654         match builder.doc_tests {
1655             DocTests::Only => {
1656                 cargo.arg("--doc");
1657             }
1658             DocTests::No => {
1659                 cargo.args(&["--lib", "--bins", "--examples", "--tests", "--benches"]);
1660             }
1661             DocTests::Yes => {}
1662         }
1663
1664         cargo.arg("-p").arg(krate);
1665
1666         // The tests are going to run with the *target* libraries, so we need to
1667         // ensure that those libraries show up in the LD_LIBRARY_PATH equivalent.
1668         //
1669         // Note that to run the compiler we need to run with the *host* libraries,
1670         // but our wrapper scripts arrange for that to be the case anyway.
1671         let mut dylib_path = dylib_path();
1672         dylib_path.insert(0, PathBuf::from(&*builder.sysroot_libdir(compiler, target)));
1673         cargo.env(dylib_path_var(), env::join_paths(&dylib_path).unwrap());
1674
1675         cargo.arg("--");
1676         cargo.args(&builder.config.cmd.test_args());
1677
1678         if !builder.config.verbose_tests {
1679             cargo.arg("--quiet");
1680         }
1681
1682         if target.contains("emscripten") {
1683             cargo.env(
1684                 format!("CARGO_TARGET_{}_RUNNER", envify(&target)),
1685                 builder
1686                     .config
1687                     .nodejs
1688                     .as_ref()
1689                     .expect("nodejs not configured"),
1690             );
1691         } else if target.starts_with("wasm32") {
1692             // Warn about running tests without the `wasm_syscall` feature enabled.
1693             // The javascript shim implements the syscall interface so that test
1694             // output can be correctly reported.
1695             if !builder.config.wasm_syscall {
1696                 builder.info(&format!(
1697                     "Libstd was built without `wasm_syscall` feature enabled: \
1698                      test output may not be visible."
1699                 ));
1700             }
1701
1702             // On the wasm32-unknown-unknown target we're using LTO which is
1703             // incompatible with `-C prefer-dynamic`, so disable that here
1704             cargo.env("RUSTC_NO_PREFER_DYNAMIC", "1");
1705
1706             let node = builder
1707                 .config
1708                 .nodejs
1709                 .as_ref()
1710                 .expect("nodejs not configured");
1711             let runner = format!(
1712                 "{} {}/src/etc/wasm32-shim.js",
1713                 node.display(),
1714                 builder.src.display()
1715             );
1716             cargo.env(format!("CARGO_TARGET_{}_RUNNER", envify(&target)), &runner);
1717         } else if builder.remote_tested(target) {
1718             cargo.env(
1719                 format!("CARGO_TARGET_{}_RUNNER", envify(&target)),
1720                 format!("{} run", builder.tool_exe(Tool::RemoteTestClient).display()),
1721             );
1722         }
1723
1724         let _folder = builder.fold_output(|| {
1725             format!(
1726                 "{}_stage{}-{}",
1727                 test_kind.subcommand(),
1728                 compiler.stage,
1729                 krate
1730             )
1731         });
1732         builder.info(&format!(
1733             "{} {} stage{} ({} -> {})",
1734             test_kind, krate, compiler.stage, &compiler.host, target
1735         ));
1736         let _time = util::timeit(&builder);
1737         try_run(builder, &mut cargo);
1738     }
1739 }
1740
1741 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1742 pub struct CrateRustdoc {
1743     host: Interned<String>,
1744     test_kind: TestKind,
1745 }
1746
1747 impl Step for CrateRustdoc {
1748     type Output = ();
1749     const DEFAULT: bool = true;
1750     const ONLY_HOSTS: bool = true;
1751
1752     fn should_run(run: ShouldRun) -> ShouldRun {
1753         run.paths(&["src/librustdoc", "src/tools/rustdoc"])
1754     }
1755
1756     fn make_run(run: RunConfig) {
1757         let builder = run.builder;
1758
1759         let test_kind = builder.kind.into();
1760
1761         builder.ensure(CrateRustdoc {
1762             host: run.host,
1763             test_kind,
1764         });
1765     }
1766
1767     fn run(self, builder: &Builder) {
1768         let test_kind = self.test_kind;
1769
1770         let compiler = builder.compiler(builder.top_stage, self.host);
1771         let target = compiler.host;
1772         builder.ensure(compile::Rustc { compiler, target });
1773
1774         let mut cargo = tool::prepare_tool_cargo(builder,
1775                                                  compiler,
1776                                                  Mode::ToolRustc,
1777                                                  target,
1778                                                  test_kind.subcommand(),
1779                                                  "src/tools/rustdoc",
1780                                                  SourceType::InTree);
1781         if test_kind.subcommand() == "test" && !builder.fail_fast {
1782             cargo.arg("--no-fail-fast");
1783         }
1784
1785         cargo.arg("-p").arg("rustdoc:0.0.0");
1786
1787         cargo.arg("--");
1788         cargo.args(&builder.config.cmd.test_args());
1789
1790         if !builder.config.verbose_tests {
1791             cargo.arg("--quiet");
1792         }
1793
1794         let _folder = builder
1795             .fold_output(|| format!("{}_stage{}-rustdoc", test_kind.subcommand(), compiler.stage));
1796         builder.info(&format!(
1797             "{} rustdoc stage{} ({} -> {})",
1798             test_kind, compiler.stage, &compiler.host, target
1799         ));
1800         let _time = util::timeit(&builder);
1801
1802         try_run(builder, &mut cargo);
1803     }
1804 }
1805
1806 fn envify(s: &str) -> String {
1807     s.chars()
1808         .map(|c| match c {
1809             '-' => '_',
1810             c => c,
1811         })
1812         .flat_map(|c| c.to_uppercase())
1813         .collect()
1814 }
1815
1816 /// Some test suites are run inside emulators or on remote devices, and most
1817 /// of our test binaries are linked dynamically which means we need to ship
1818 /// the standard library and such to the emulator ahead of time. This step
1819 /// represents this and is a dependency of all test suites.
1820 ///
1821 /// Most of the time this is a noop. For some steps such as shipping data to
1822 /// QEMU we have to build our own tools so we've got conditional dependencies
1823 /// on those programs as well. Note that the remote test client is built for
1824 /// the build target (us) and the server is built for the target.
1825 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1826 pub struct RemoteCopyLibs {
1827     compiler: Compiler,
1828     target: Interned<String>,
1829 }
1830
1831 impl Step for RemoteCopyLibs {
1832     type Output = ();
1833
1834     fn should_run(run: ShouldRun) -> ShouldRun {
1835         run.never()
1836     }
1837
1838     fn run(self, builder: &Builder) {
1839         let compiler = self.compiler;
1840         let target = self.target;
1841         if !builder.remote_tested(target) {
1842             return;
1843         }
1844
1845         builder.ensure(compile::Test { compiler, target });
1846
1847         builder.info(&format!("REMOTE copy libs to emulator ({})", target));
1848         t!(fs::create_dir_all(builder.out.join("tmp")));
1849
1850         let server = builder.ensure(tool::RemoteTestServer {
1851             compiler: compiler.with_stage(0),
1852             target,
1853         });
1854
1855         // Spawn the emulator and wait for it to come online
1856         let tool = builder.tool_exe(Tool::RemoteTestClient);
1857         let mut cmd = Command::new(&tool);
1858         cmd.arg("spawn-emulator")
1859             .arg(target)
1860             .arg(&server)
1861             .arg(builder.out.join("tmp"));
1862         if let Some(rootfs) = builder.qemu_rootfs(target) {
1863             cmd.arg(rootfs);
1864         }
1865         builder.run(&mut cmd);
1866
1867         // Push all our dylibs to the emulator
1868         for f in t!(builder.sysroot_libdir(compiler, target).read_dir()) {
1869             let f = t!(f);
1870             let name = f.file_name().into_string().unwrap();
1871             if util::is_dylib(&name) {
1872                 builder.run(Command::new(&tool).arg("push").arg(f.path()));
1873             }
1874         }
1875     }
1876 }
1877
1878 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1879 pub struct Distcheck;
1880
1881 impl Step for Distcheck {
1882     type Output = ();
1883
1884     fn should_run(run: ShouldRun) -> ShouldRun {
1885         run.path("distcheck")
1886     }
1887
1888     fn make_run(run: RunConfig) {
1889         run.builder.ensure(Distcheck);
1890     }
1891
1892     /// Run "distcheck", a 'make check' from a tarball
1893     fn run(self, builder: &Builder) {
1894         builder.info(&format!("Distcheck"));
1895         let dir = builder.out.join("tmp").join("distcheck");
1896         let _ = fs::remove_dir_all(&dir);
1897         t!(fs::create_dir_all(&dir));
1898
1899         // Guarantee that these are built before we begin running.
1900         builder.ensure(dist::PlainSourceTarball);
1901         builder.ensure(dist::Src);
1902
1903         let mut cmd = Command::new("tar");
1904         cmd.arg("-xzf")
1905             .arg(builder.ensure(dist::PlainSourceTarball))
1906             .arg("--strip-components=1")
1907             .current_dir(&dir);
1908         builder.run(&mut cmd);
1909         builder.run(
1910             Command::new("./configure")
1911                 .args(&builder.config.configure_args)
1912                 .arg("--enable-vendor")
1913                 .current_dir(&dir),
1914         );
1915         builder.run(
1916             Command::new(build_helper::make(&builder.config.build))
1917                 .arg("check")
1918                 .current_dir(&dir),
1919         );
1920
1921         // Now make sure that rust-src has all of libstd's dependencies
1922         builder.info(&format!("Distcheck rust-src"));
1923         let dir = builder.out.join("tmp").join("distcheck-src");
1924         let _ = fs::remove_dir_all(&dir);
1925         t!(fs::create_dir_all(&dir));
1926
1927         let mut cmd = Command::new("tar");
1928         cmd.arg("-xzf")
1929             .arg(builder.ensure(dist::Src))
1930             .arg("--strip-components=1")
1931             .current_dir(&dir);
1932         builder.run(&mut cmd);
1933
1934         let toml = dir.join("rust-src/lib/rustlib/src/rust/src/libstd/Cargo.toml");
1935         builder.run(
1936             Command::new(&builder.initial_cargo)
1937                 .arg("generate-lockfile")
1938                 .arg("--manifest-path")
1939                 .arg(&toml)
1940                 .current_dir(&dir),
1941         );
1942     }
1943 }
1944
1945 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1946 pub struct Bootstrap;
1947
1948 impl Step for Bootstrap {
1949     type Output = ();
1950     const DEFAULT: bool = true;
1951     const ONLY_HOSTS: bool = true;
1952
1953     /// Test the build system itself
1954     fn run(self, builder: &Builder) {
1955         let mut cmd = Command::new(&builder.initial_cargo);
1956         cmd.arg("test")
1957             .current_dir(builder.src.join("src/bootstrap"))
1958             .env("RUSTFLAGS", "-Cdebuginfo=2")
1959             .env("CARGO_TARGET_DIR", builder.out.join("bootstrap"))
1960             .env("RUSTC_BOOTSTRAP", "1")
1961             .env("RUSTC", &builder.initial_rustc);
1962         if let Some(flags) = option_env!("RUSTFLAGS") {
1963             // Use the same rustc flags for testing as for "normal" compilation,
1964             // so that Cargo doesn’t recompile the entire dependency graph every time:
1965             // https://github.com/rust-lang/rust/issues/49215
1966             cmd.env("RUSTFLAGS", flags);
1967         }
1968         if !builder.fail_fast {
1969             cmd.arg("--no-fail-fast");
1970         }
1971         cmd.arg("--").args(&builder.config.cmd.test_args());
1972         // rustbuild tests are racy on directory creation so just run them one at a time.
1973         // Since there's not many this shouldn't be a problem.
1974         cmd.arg("--test-threads=1");
1975         try_run(builder, &mut cmd);
1976     }
1977
1978     fn should_run(run: ShouldRun) -> ShouldRun {
1979         run.path("src/bootstrap")
1980     }
1981
1982     fn make_run(run: RunConfig) {
1983         run.builder.ensure(Bootstrap);
1984     }
1985 }