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