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, Stdio};
13
14 use build_helper::{self, output, t};
15
16 use crate::builder::{Builder, Compiler, Kind, RunConfig, ShouldRun, Step};
17 use crate::cache::Interned;
18 use crate::compile;
19 use crate::config::TargetSelection;
20 use crate::dist;
21 use crate::flags::Subcommand;
22 use crate::native;
23 use crate::tool::{self, SourceType, Tool};
24 use crate::toolstate::ToolState;
25 use crate::util::{self, add_link_lib_path, dylib_path, dylib_path_var};
26 use crate::Crate as CargoCrate;
27 use crate::{envify, DocTests, GitRepo, Mode};
28
29 const ADB_TEST_DIR: &str = "/data/tmp/work";
30
31 /// The two modes of the test runner; tests or benchmarks.
32 #[derive(Debug, PartialEq, Eq, Hash, Copy, Clone, PartialOrd, Ord)]
33 pub enum TestKind {
34 /// Run `cargo test`.
35 Test,
36 /// Run `cargo bench`.
37 Bench,
38 }
39
40 impl From<Kind> for TestKind {
from(kind: Kind) -> Self41 fn from(kind: Kind) -> Self {
42 match kind {
43 Kind::Test => TestKind::Test,
44 Kind::Bench => TestKind::Bench,
45 _ => panic!("unexpected kind in crate: {:?}", kind),
46 }
47 }
48 }
49
50 impl TestKind {
51 // Return the cargo subcommand for this test kind
subcommand(self) -> &'static str52 fn subcommand(self) -> &'static str {
53 match self {
54 TestKind::Test => "test",
55 TestKind::Bench => "bench",
56 }
57 }
58 }
59
60 impl fmt::Display for TestKind {
fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result61 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
62 f.write_str(match *self {
63 TestKind::Test => "Testing",
64 TestKind::Bench => "Benchmarking",
65 })
66 }
67 }
68
try_run(builder: &Builder<'_>, cmd: &mut Command) -> bool69 fn try_run(builder: &Builder<'_>, cmd: &mut Command) -> bool {
70 if !builder.fail_fast {
71 if !builder.try_run(cmd) {
72 let mut failures = builder.delayed_failures.borrow_mut();
73 failures.push(format!("{:?}", cmd));
74 return false;
75 }
76 } else {
77 builder.run(cmd);
78 }
79 true
80 }
81
try_run_quiet(builder: &Builder<'_>, cmd: &mut Command) -> bool82 fn try_run_quiet(builder: &Builder<'_>, cmd: &mut Command) -> bool {
83 if !builder.fail_fast {
84 if !builder.try_run_quiet(cmd) {
85 let mut failures = builder.delayed_failures.borrow_mut();
86 failures.push(format!("{:?}", cmd));
87 return false;
88 }
89 } else {
90 builder.run_quiet(cmd);
91 }
92 true
93 }
94
95 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
96 pub struct Linkcheck {
97 host: TargetSelection,
98 }
99
100 impl Step for Linkcheck {
101 type Output = ();
102 const ONLY_HOSTS: bool = true;
103 const DEFAULT: bool = true;
104
105 /// Runs the `linkchecker` tool as compiled in `stage` by the `host` compiler.
106 ///
107 /// This tool in `src/tools` will verify the validity of all our links in the
108 /// documentation to ensure we don't have a bunch of dead ones.
run(self, builder: &Builder<'_>)109 fn run(self, builder: &Builder<'_>) {
110 let host = self.host;
111 let hosts = &builder.hosts;
112 let targets = &builder.targets;
113
114 // if we have different hosts and targets, some things may be built for
115 // the host (e.g. rustc) and others for the target (e.g. std). The
116 // documentation built for each will contain broken links to
117 // docs built for the other platform (e.g. rustc linking to cargo)
118 if (hosts != targets) && !hosts.is_empty() && !targets.is_empty() {
119 panic!(
120 "Linkcheck currently does not support builds with different hosts and targets.
121 You can skip linkcheck with --exclude src/tools/linkchecker"
122 );
123 }
124
125 builder.info(&format!("Linkcheck ({})", host));
126
127 // Test the linkchecker itself.
128 let bootstrap_host = builder.config.build;
129 let compiler = builder.compiler(0, bootstrap_host);
130 let cargo = tool::prepare_tool_cargo(
131 builder,
132 compiler,
133 Mode::ToolBootstrap,
134 bootstrap_host,
135 "test",
136 "src/tools/linkchecker",
137 SourceType::InTree,
138 &[],
139 );
140 try_run(builder, &mut cargo.into());
141
142 // Build all the default documentation.
143 builder.default_doc(&[]);
144
145 // Run the linkchecker.
146 let _time = util::timeit(&builder);
147 try_run(
148 builder,
149 builder.tool_cmd(Tool::Linkchecker).arg(builder.out.join(host.triple).join("doc")),
150 );
151 }
152
should_run(run: ShouldRun<'_>) -> ShouldRun<'_>153 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
154 let builder = run.builder;
155 let run = run.path("src/tools/linkchecker");
156 run.default_condition(builder.config.docs)
157 }
158
make_run(run: RunConfig<'_>)159 fn make_run(run: RunConfig<'_>) {
160 run.builder.ensure(Linkcheck { host: run.target });
161 }
162 }
163
check_if_tidy_is_installed() -> bool164 fn check_if_tidy_is_installed() -> bool {
165 Command::new("tidy")
166 .arg("--version")
167 .stdout(Stdio::null())
168 .status()
169 .map_or(false, |status| status.success())
170 }
171
172 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
173 pub struct HtmlCheck {
174 target: TargetSelection,
175 }
176
177 impl Step for HtmlCheck {
178 type Output = ();
179 const DEFAULT: bool = true;
180 const ONLY_HOSTS: bool = true;
181
should_run(run: ShouldRun<'_>) -> ShouldRun<'_>182 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
183 let run = run.path("src/tools/html-checker");
184 run.lazy_default_condition(Box::new(check_if_tidy_is_installed))
185 }
186
make_run(run: RunConfig<'_>)187 fn make_run(run: RunConfig<'_>) {
188 run.builder.ensure(HtmlCheck { target: run.target });
189 }
190
run(self, builder: &Builder<'_>)191 fn run(self, builder: &Builder<'_>) {
192 if !check_if_tidy_is_installed() {
193 eprintln!("not running HTML-check tool because `tidy` is missing");
194 eprintln!(
195 "Note that `tidy` is not the in-tree `src/tools/tidy` but needs to be installed"
196 );
197 panic!("Cannot run html-check tests");
198 }
199 // Ensure that a few different kinds of documentation are available.
200 builder.default_doc(&[]);
201 builder.ensure(crate::doc::Rustc { target: self.target, stage: builder.top_stage });
202
203 try_run(builder, builder.tool_cmd(Tool::HtmlChecker).arg(builder.doc_out(self.target)));
204 }
205 }
206
207 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
208 pub struct Cargotest {
209 stage: u32,
210 host: TargetSelection,
211 }
212
213 impl Step for Cargotest {
214 type Output = ();
215 const ONLY_HOSTS: bool = true;
216
should_run(run: ShouldRun<'_>) -> ShouldRun<'_>217 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
218 run.path("src/tools/cargotest")
219 }
220
make_run(run: RunConfig<'_>)221 fn make_run(run: RunConfig<'_>) {
222 run.builder.ensure(Cargotest { stage: run.builder.top_stage, host: run.target });
223 }
224
225 /// Runs the `cargotest` tool as compiled in `stage` by the `host` compiler.
226 ///
227 /// This tool in `src/tools` will check out a few Rust projects and run `cargo
228 /// test` to ensure that we don't regress the test suites there.
run(self, builder: &Builder<'_>)229 fn run(self, builder: &Builder<'_>) {
230 let compiler = builder.compiler(self.stage, self.host);
231 builder.ensure(compile::Rustc { compiler, target: compiler.host });
232 let cargo = builder.ensure(tool::Cargo { compiler, target: compiler.host });
233
234 // Note that this is a short, cryptic, and not scoped directory name. This
235 // is currently to minimize the length of path on Windows where we otherwise
236 // quickly run into path name limit constraints.
237 let out_dir = builder.out.join("ct");
238 t!(fs::create_dir_all(&out_dir));
239
240 let _time = util::timeit(&builder);
241 let mut cmd = builder.tool_cmd(Tool::CargoTest);
242 try_run(
243 builder,
244 cmd.arg(&cargo)
245 .arg(&out_dir)
246 .args(builder.config.cmd.test_args())
247 .env("RUSTC", builder.rustc(compiler))
248 .env("RUSTDOC", builder.rustdoc(compiler)),
249 );
250 }
251 }
252
253 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
254 pub struct Cargo {
255 stage: u32,
256 host: TargetSelection,
257 }
258
259 impl Step for Cargo {
260 type Output = ();
261 const ONLY_HOSTS: bool = true;
262
should_run(run: ShouldRun<'_>) -> ShouldRun<'_>263 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
264 run.path("src/tools/cargo")
265 }
266
make_run(run: RunConfig<'_>)267 fn make_run(run: RunConfig<'_>) {
268 run.builder.ensure(Cargo { stage: run.builder.top_stage, host: run.target });
269 }
270
271 /// Runs `cargo test` for `cargo` packaged with Rust.
run(self, builder: &Builder<'_>)272 fn run(self, builder: &Builder<'_>) {
273 let compiler = builder.compiler(self.stage, self.host);
274
275 builder.ensure(tool::Cargo { compiler, target: self.host });
276 let mut cargo = tool::prepare_tool_cargo(
277 builder,
278 compiler,
279 Mode::ToolRustc,
280 self.host,
281 "test",
282 "src/tools/cargo",
283 SourceType::Submodule,
284 &[],
285 );
286
287 if !builder.fail_fast {
288 cargo.arg("--no-fail-fast");
289 }
290 cargo.arg("--").args(builder.config.cmd.test_args());
291
292 // Don't run cross-compile tests, we may not have cross-compiled libstd libs
293 // available.
294 cargo.env("CFG_DISABLE_CROSS_TESTS", "1");
295 // Disable a test that has issues with mingw.
296 cargo.env("CARGO_TEST_DISABLE_GIT_CLI", "1");
297 // Forcibly disable tests using nightly features since any changes to
298 // those features won't be able to land.
299 cargo.env("CARGO_TEST_DISABLE_NIGHTLY", "1");
300
301 cargo.env("PATH", &path_for_cargo(builder, compiler));
302
303 try_run(builder, &mut cargo.into());
304 }
305 }
306
307 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
308 pub struct Rls {
309 stage: u32,
310 host: TargetSelection,
311 }
312
313 impl Step for Rls {
314 type Output = ();
315 const ONLY_HOSTS: bool = true;
316
should_run(run: ShouldRun<'_>) -> ShouldRun<'_>317 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
318 run.path("src/tools/rls")
319 }
320
make_run(run: RunConfig<'_>)321 fn make_run(run: RunConfig<'_>) {
322 run.builder.ensure(Rls { stage: run.builder.top_stage, host: run.target });
323 }
324
325 /// Runs `cargo test` for the rls.
run(self, builder: &Builder<'_>)326 fn run(self, builder: &Builder<'_>) {
327 let stage = self.stage;
328 let host = self.host;
329 let compiler = builder.compiler(stage, host);
330
331 let build_result =
332 builder.ensure(tool::Rls { compiler, target: self.host, extra_features: Vec::new() });
333 if build_result.is_none() {
334 eprintln!("failed to test rls: could not build");
335 return;
336 }
337
338 let mut cargo = tool::prepare_tool_cargo(
339 builder,
340 compiler,
341 Mode::ToolRustc,
342 host,
343 "test",
344 "src/tools/rls",
345 SourceType::Submodule,
346 &[],
347 );
348
349 cargo.add_rustc_lib_path(builder, compiler);
350 cargo.arg("--").args(builder.config.cmd.test_args());
351
352 if try_run(builder, &mut cargo.into()) {
353 builder.save_toolstate("rls", ToolState::TestPass);
354 }
355 }
356 }
357
358 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
359 pub struct Rustfmt {
360 stage: u32,
361 host: TargetSelection,
362 }
363
364 impl Step for Rustfmt {
365 type Output = ();
366 const ONLY_HOSTS: bool = true;
367
should_run(run: ShouldRun<'_>) -> ShouldRun<'_>368 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
369 run.path("src/tools/rustfmt")
370 }
371
make_run(run: RunConfig<'_>)372 fn make_run(run: RunConfig<'_>) {
373 run.builder.ensure(Rustfmt { stage: run.builder.top_stage, host: run.target });
374 }
375
376 /// Runs `cargo test` for rustfmt.
run(self, builder: &Builder<'_>)377 fn run(self, builder: &Builder<'_>) {
378 let stage = self.stage;
379 let host = self.host;
380 let compiler = builder.compiler(stage, host);
381
382 builder
383 .ensure(tool::Rustfmt { compiler, target: self.host, extra_features: Vec::new() })
384 .expect("in-tree tool");
385
386 let mut cargo = tool::prepare_tool_cargo(
387 builder,
388 compiler,
389 Mode::ToolRustc,
390 host,
391 "test",
392 "src/tools/rustfmt",
393 SourceType::InTree,
394 &[],
395 );
396
397 let dir = testdir(builder, compiler.host);
398 t!(fs::create_dir_all(&dir));
399 cargo.env("RUSTFMT_TEST_DIR", dir);
400
401 cargo.add_rustc_lib_path(builder, compiler);
402
403 builder.run(&mut cargo.into());
404 }
405 }
406
407 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
408 pub struct RustDemangler {
409 stage: u32,
410 host: TargetSelection,
411 }
412
413 impl Step for RustDemangler {
414 type Output = ();
415 const ONLY_HOSTS: bool = true;
416
should_run(run: ShouldRun<'_>) -> ShouldRun<'_>417 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
418 run.path("src/tools/rust-demangler")
419 }
420
make_run(run: RunConfig<'_>)421 fn make_run(run: RunConfig<'_>) {
422 run.builder.ensure(RustDemangler { stage: run.builder.top_stage, host: run.target });
423 }
424
425 /// Runs `cargo test` for rust-demangler.
run(self, builder: &Builder<'_>)426 fn run(self, builder: &Builder<'_>) {
427 let stage = self.stage;
428 let host = self.host;
429 let compiler = builder.compiler(stage, host);
430
431 let rust_demangler = builder
432 .ensure(tool::RustDemangler { compiler, target: self.host, extra_features: Vec::new() })
433 .expect("in-tree tool");
434 let mut cargo = tool::prepare_tool_cargo(
435 builder,
436 compiler,
437 Mode::ToolRustc,
438 host,
439 "test",
440 "src/tools/rust-demangler",
441 SourceType::InTree,
442 &[],
443 );
444
445 let dir = testdir(builder, compiler.host);
446 t!(fs::create_dir_all(&dir));
447
448 cargo.env("RUST_DEMANGLER_DRIVER_PATH", rust_demangler);
449
450 cargo.arg("--").args(builder.config.cmd.test_args());
451
452 cargo.add_rustc_lib_path(builder, compiler);
453
454 builder.run(&mut cargo.into());
455 }
456 }
457
458 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
459 pub struct Miri {
460 stage: u32,
461 host: TargetSelection,
462 }
463
464 impl Step for Miri {
465 type Output = ();
466 const ONLY_HOSTS: bool = true;
467
should_run(run: ShouldRun<'_>) -> ShouldRun<'_>468 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
469 run.path("src/tools/miri")
470 }
471
make_run(run: RunConfig<'_>)472 fn make_run(run: RunConfig<'_>) {
473 run.builder.ensure(Miri { stage: run.builder.top_stage, host: run.target });
474 }
475
476 /// Runs `cargo test` for miri.
run(self, builder: &Builder<'_>)477 fn run(self, builder: &Builder<'_>) {
478 let stage = self.stage;
479 let host = self.host;
480 let compiler = builder.compiler(stage, host);
481
482 let miri =
483 builder.ensure(tool::Miri { compiler, target: self.host, extra_features: Vec::new() });
484 let cargo_miri = builder.ensure(tool::CargoMiri {
485 compiler,
486 target: self.host,
487 extra_features: Vec::new(),
488 });
489 if let (Some(miri), Some(_cargo_miri)) = (miri, cargo_miri) {
490 let mut cargo =
491 builder.cargo(compiler, Mode::ToolRustc, SourceType::Submodule, host, "install");
492 cargo.arg("xargo");
493 // Configure `cargo install` path. cargo adds a `bin/`.
494 cargo.env("CARGO_INSTALL_ROOT", &builder.out);
495
496 let mut cargo = Command::from(cargo);
497 if !try_run(builder, &mut cargo) {
498 return;
499 }
500
501 // # Run `cargo miri setup`.
502 let mut cargo = tool::prepare_tool_cargo(
503 builder,
504 compiler,
505 Mode::ToolRustc,
506 host,
507 "run",
508 "src/tools/miri/cargo-miri",
509 SourceType::Submodule,
510 &[],
511 );
512 cargo.add_rustc_lib_path(builder, compiler);
513 cargo.arg("--").arg("miri").arg("setup");
514
515 // Tell `cargo miri setup` where to find the sources.
516 cargo.env("XARGO_RUST_SRC", builder.src.join("library"));
517 // Tell it where to find Miri.
518 cargo.env("MIRI", &miri);
519 // Debug things.
520 cargo.env("RUST_BACKTRACE", "1");
521 // Let cargo-miri know where xargo ended up.
522 cargo.env("XARGO_CHECK", builder.out.join("bin").join("xargo-check"));
523
524 let mut cargo = Command::from(cargo);
525 if !try_run(builder, &mut cargo) {
526 return;
527 }
528
529 // # Determine where Miri put its sysroot.
530 // To this end, we run `cargo miri setup --print-sysroot` and capture the output.
531 // (We do this separately from the above so that when the setup actually
532 // happens we get some output.)
533 // We re-use the `cargo` from above.
534 cargo.arg("--print-sysroot");
535
536 // FIXME: Is there a way in which we can re-use the usual `run` helpers?
537 let miri_sysroot = if builder.config.dry_run {
538 String::new()
539 } else {
540 builder.verbose(&format!("running: {:?}", cargo));
541 let out = cargo
542 .output()
543 .expect("We already ran `cargo miri setup` before and that worked");
544 assert!(out.status.success(), "`cargo miri setup` returned with non-0 exit code");
545 // Output is "<sysroot>\n".
546 let stdout = String::from_utf8(out.stdout)
547 .expect("`cargo miri setup` stdout is not valid UTF-8");
548 let sysroot = stdout.trim_end();
549 builder.verbose(&format!("`cargo miri setup --print-sysroot` said: {:?}", sysroot));
550 sysroot.to_owned()
551 };
552
553 // # Run `cargo test`.
554 let mut cargo = tool::prepare_tool_cargo(
555 builder,
556 compiler,
557 Mode::ToolRustc,
558 host,
559 "test",
560 "src/tools/miri",
561 SourceType::Submodule,
562 &[],
563 );
564 cargo.add_rustc_lib_path(builder, compiler);
565
566 // miri tests need to know about the stage sysroot
567 cargo.env("MIRI_SYSROOT", miri_sysroot);
568 cargo.env("RUSTC_LIB_PATH", builder.rustc_libdir(compiler));
569 cargo.env("MIRI", miri);
570
571 cargo.arg("--").args(builder.config.cmd.test_args());
572
573 let mut cargo = Command::from(cargo);
574 if !try_run(builder, &mut cargo) {
575 return;
576 }
577
578 // # Run `cargo test` with `-Zmir-opt-level=4`.
579 cargo.env("MIRIFLAGS", "-O -Zmir-opt-level=4");
580 if !try_run(builder, &mut cargo) {
581 return;
582 }
583
584 // # Done!
585 builder.save_toolstate("miri", ToolState::TestPass);
586 } else {
587 eprintln!("failed to test miri: could not build");
588 }
589 }
590 }
591
592 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
593 pub struct CompiletestTest {
594 host: TargetSelection,
595 }
596
597 impl Step for CompiletestTest {
598 type Output = ();
599
should_run(run: ShouldRun<'_>) -> ShouldRun<'_>600 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
601 run.path("src/tools/compiletest")
602 }
603
make_run(run: RunConfig<'_>)604 fn make_run(run: RunConfig<'_>) {
605 run.builder.ensure(CompiletestTest { host: run.target });
606 }
607
608 /// Runs `cargo test` for compiletest.
run(self, builder: &Builder<'_>)609 fn run(self, builder: &Builder<'_>) {
610 let host = self.host;
611 let compiler = builder.compiler(0, host);
612
613 // We need `ToolStd` for the locally-built sysroot because
614 // compiletest uses unstable features of the `test` crate.
615 builder.ensure(compile::Std { compiler, target: host });
616 let cargo = tool::prepare_tool_cargo(
617 builder,
618 compiler,
619 Mode::ToolStd,
620 host,
621 "test",
622 "src/tools/compiletest",
623 SourceType::InTree,
624 &[],
625 );
626
627 try_run(builder, &mut cargo.into());
628 }
629 }
630
631 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
632 pub struct Clippy {
633 stage: u32,
634 host: TargetSelection,
635 }
636
637 impl Step for Clippy {
638 type Output = ();
639 const ONLY_HOSTS: bool = true;
640 const DEFAULT: bool = false;
641
should_run(run: ShouldRun<'_>) -> ShouldRun<'_>642 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
643 run.path("src/tools/clippy")
644 }
645
make_run(run: RunConfig<'_>)646 fn make_run(run: RunConfig<'_>) {
647 run.builder.ensure(Clippy { stage: run.builder.top_stage, host: run.target });
648 }
649
650 /// Runs `cargo test` for clippy.
run(self, builder: &Builder<'_>)651 fn run(self, builder: &Builder<'_>) {
652 let stage = self.stage;
653 let host = self.host;
654 let compiler = builder.compiler(stage, host);
655
656 builder
657 .ensure(tool::Clippy { compiler, target: self.host, extra_features: Vec::new() })
658 .expect("in-tree tool");
659 let mut cargo = tool::prepare_tool_cargo(
660 builder,
661 compiler,
662 Mode::ToolRustc,
663 host,
664 "test",
665 "src/tools/clippy",
666 SourceType::InTree,
667 &[],
668 );
669
670 // clippy tests need to know about the stage sysroot
671 cargo.env("SYSROOT", builder.sysroot(compiler));
672 cargo.env("RUSTC_TEST_SUITE", builder.rustc(compiler));
673 cargo.env("RUSTC_LIB_PATH", builder.rustc_libdir(compiler));
674 let host_libs = builder.stage_out(compiler, Mode::ToolRustc).join(builder.cargo_dir());
675 cargo.env("HOST_LIBS", host_libs);
676
677 cargo.arg("--").args(builder.config.cmd.test_args());
678
679 cargo.add_rustc_lib_path(builder, compiler);
680
681 if builder.try_run(&mut cargo.into()) {
682 // The tests succeeded; nothing to do.
683 return;
684 }
685
686 if !builder.config.cmd.bless() {
687 std::process::exit(1);
688 }
689
690 let mut cargo = builder.cargo(compiler, Mode::ToolRustc, SourceType::InTree, host, "run");
691 cargo.arg("-p").arg("clippy_dev");
692 // clippy_dev gets confused if it can't find `clippy/Cargo.toml`
693 cargo.current_dir(&builder.src.join("src").join("tools").join("clippy"));
694 if builder.config.rust_optimize {
695 cargo.env("PROFILE", "release");
696 } else {
697 cargo.env("PROFILE", "debug");
698 }
699 cargo.arg("--");
700 cargo.arg("bless");
701 builder.run(&mut cargo.into());
702 }
703 }
704
path_for_cargo(builder: &Builder<'_>, compiler: Compiler) -> OsString705 fn path_for_cargo(builder: &Builder<'_>, compiler: Compiler) -> OsString {
706 // Configure PATH to find the right rustc. NB. we have to use PATH
707 // and not RUSTC because the Cargo test suite has tests that will
708 // fail if rustc is not spelled `rustc`.
709 let path = builder.sysroot(compiler).join("bin");
710 let old_path = env::var_os("PATH").unwrap_or_default();
711 env::join_paths(iter::once(path).chain(env::split_paths(&old_path))).expect("")
712 }
713
714 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
715 pub struct RustdocTheme {
716 pub compiler: Compiler,
717 }
718
719 impl Step for RustdocTheme {
720 type Output = ();
721 const DEFAULT: bool = true;
722 const ONLY_HOSTS: bool = true;
723
should_run(run: ShouldRun<'_>) -> ShouldRun<'_>724 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
725 run.path("src/tools/rustdoc-themes")
726 }
727
make_run(run: RunConfig<'_>)728 fn make_run(run: RunConfig<'_>) {
729 let compiler = run.builder.compiler(run.builder.top_stage, run.target);
730
731 run.builder.ensure(RustdocTheme { compiler });
732 }
733
run(self, builder: &Builder<'_>)734 fn run(self, builder: &Builder<'_>) {
735 let rustdoc = builder.out.join("bootstrap/debug/rustdoc");
736 let mut cmd = builder.tool_cmd(Tool::RustdocTheme);
737 cmd.arg(rustdoc.to_str().unwrap())
738 .arg(builder.src.join("src/librustdoc/html/static/css/themes").to_str().unwrap())
739 .env("RUSTC_STAGE", self.compiler.stage.to_string())
740 .env("RUSTC_SYSROOT", builder.sysroot(self.compiler))
741 .env("RUSTDOC_LIBDIR", builder.sysroot_libdir(self.compiler, self.compiler.host))
742 .env("CFG_RELEASE_CHANNEL", &builder.config.channel)
743 .env("RUSTDOC_REAL", builder.rustdoc(self.compiler))
744 .env("RUSTC_BOOTSTRAP", "1");
745 if let Some(linker) = builder.linker(self.compiler.host) {
746 cmd.env("RUSTDOC_LINKER", linker);
747 }
748 if builder.is_fuse_ld_lld(self.compiler.host) {
749 cmd.env("RUSTDOC_FUSE_LD_LLD", "1");
750 }
751 try_run(builder, &mut cmd);
752 }
753 }
754
755 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
756 pub struct RustdocJSStd {
757 pub target: TargetSelection,
758 }
759
760 impl Step for RustdocJSStd {
761 type Output = ();
762 const DEFAULT: bool = true;
763 const ONLY_HOSTS: bool = true;
764
should_run(run: ShouldRun<'_>) -> ShouldRun<'_>765 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
766 run.suite_path("src/test/rustdoc-js-std")
767 }
768
make_run(run: RunConfig<'_>)769 fn make_run(run: RunConfig<'_>) {
770 run.builder.ensure(RustdocJSStd { target: run.target });
771 }
772
run(self, builder: &Builder<'_>)773 fn run(self, builder: &Builder<'_>) {
774 if let Some(ref nodejs) = builder.config.nodejs {
775 let mut command = Command::new(nodejs);
776 command
777 .arg(builder.src.join("src/tools/rustdoc-js/tester.js"))
778 .arg("--crate-name")
779 .arg("std")
780 .arg("--resource-suffix")
781 .arg(&builder.version)
782 .arg("--doc-folder")
783 .arg(builder.doc_out(self.target))
784 .arg("--test-folder")
785 .arg(builder.src.join("src/test/rustdoc-js-std"));
786 for path in &builder.paths {
787 if let Some(p) =
788 util::is_valid_test_suite_arg(path, "src/test/rustdoc-js-std", builder)
789 {
790 if !p.ends_with(".js") {
791 eprintln!("A non-js file was given: `{}`", path.display());
792 panic!("Cannot run rustdoc-js-std tests");
793 }
794 command.arg("--test-file").arg(path);
795 }
796 }
797 builder.ensure(crate::doc::Std { target: self.target, stage: builder.top_stage });
798 builder.run(&mut command);
799 } else {
800 builder.info("No nodejs found, skipping \"src/test/rustdoc-js-std\" tests");
801 }
802 }
803 }
804
805 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
806 pub struct RustdocJSNotStd {
807 pub target: TargetSelection,
808 pub compiler: Compiler,
809 }
810
811 impl Step for RustdocJSNotStd {
812 type Output = ();
813 const DEFAULT: bool = true;
814 const ONLY_HOSTS: bool = true;
815
should_run(run: ShouldRun<'_>) -> ShouldRun<'_>816 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
817 run.suite_path("src/test/rustdoc-js")
818 }
819
make_run(run: RunConfig<'_>)820 fn make_run(run: RunConfig<'_>) {
821 let compiler = run.builder.compiler(run.builder.top_stage, run.build_triple());
822 run.builder.ensure(RustdocJSNotStd { target: run.target, compiler });
823 }
824
run(self, builder: &Builder<'_>)825 fn run(self, builder: &Builder<'_>) {
826 if builder.config.nodejs.is_some() {
827 builder.ensure(Compiletest {
828 compiler: self.compiler,
829 target: self.target,
830 mode: "js-doc-test",
831 suite: "rustdoc-js",
832 path: "src/test/rustdoc-js",
833 compare_mode: None,
834 });
835 } else {
836 builder.info("No nodejs found, skipping \"src/test/rustdoc-js\" tests");
837 }
838 }
839 }
840
check_if_browser_ui_test_is_installed_global(npm: &Path, global: bool) -> bool841 fn check_if_browser_ui_test_is_installed_global(npm: &Path, global: bool) -> bool {
842 let mut command = Command::new(&npm);
843 command.arg("list").arg("--depth=0");
844 if global {
845 command.arg("--global");
846 }
847 let lines = command
848 .output()
849 .map(|output| String::from_utf8_lossy(&output.stdout).into_owned())
850 .unwrap_or(String::new());
851 lines.contains(&" browser-ui-test@")
852 }
853
check_if_browser_ui_test_is_installed(npm: &Path) -> bool854 fn check_if_browser_ui_test_is_installed(npm: &Path) -> bool {
855 check_if_browser_ui_test_is_installed_global(npm, false)
856 || check_if_browser_ui_test_is_installed_global(npm, true)
857 }
858
859 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
860 pub struct RustdocGUI {
861 pub target: TargetSelection,
862 pub compiler: Compiler,
863 }
864
865 impl Step for RustdocGUI {
866 type Output = ();
867 const DEFAULT: bool = true;
868 const ONLY_HOSTS: bool = true;
869
should_run(run: ShouldRun<'_>) -> ShouldRun<'_>870 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
871 let builder = run.builder;
872 let run = run.suite_path("src/test/rustdoc-gui");
873 run.lazy_default_condition(Box::new(move || {
874 builder.config.nodejs.is_some()
875 && builder
876 .config
877 .npm
878 .as_ref()
879 .map(|p| check_if_browser_ui_test_is_installed(p))
880 .unwrap_or(false)
881 }))
882 }
883
make_run(run: RunConfig<'_>)884 fn make_run(run: RunConfig<'_>) {
885 let compiler = run.builder.compiler(run.builder.top_stage, run.build_triple());
886 run.builder.ensure(RustdocGUI { target: run.target, compiler });
887 }
888
run(self, builder: &Builder<'_>)889 fn run(self, builder: &Builder<'_>) {
890 let nodejs = builder.config.nodejs.as_ref().expect("nodejs isn't available");
891 let npm = builder.config.npm.as_ref().expect("npm isn't available");
892
893 builder.ensure(compile::Std { compiler: self.compiler, target: self.target });
894
895 // The goal here is to check if the necessary packages are installed, and if not, we
896 // panic.
897 if !check_if_browser_ui_test_is_installed(&npm) {
898 eprintln!(
899 "error: rustdoc-gui test suite cannot be run because npm `browser-ui-test` \
900 dependency is missing",
901 );
902 eprintln!(
903 "If you want to install the `{0}` dependency, run `npm install {0}`",
904 "browser-ui-test",
905 );
906 panic!("Cannot run rustdoc-gui tests");
907 }
908
909 let out_dir = builder.test_out(self.target).join("rustdoc-gui");
910
911 // We remove existing folder to be sure there won't be artifacts remaining.
912 builder.clear_if_dirty(&out_dir, &builder.rustdoc(self.compiler));
913
914 let src_path = builder.build.src.join("src/test/rustdoc-gui/src");
915 // We generate docs for the libraries present in the rustdoc-gui's src folder.
916 for entry in src_path.read_dir().expect("read_dir call failed") {
917 if let Ok(entry) = entry {
918 let path = entry.path();
919
920 if !path.is_dir() {
921 continue;
922 }
923
924 let mut cargo = Command::new(&builder.initial_cargo);
925 cargo
926 .arg("doc")
927 .arg("--target-dir")
928 .arg(&out_dir)
929 .env("RUSTDOC", builder.rustdoc(self.compiler))
930 .env("RUSTC", builder.rustc(self.compiler))
931 .current_dir(path);
932 // FIXME: implement a `// compile-flags` command or similar
933 // instead of hard-coding this test
934 if entry.file_name() == "link_to_definition" {
935 cargo.env("RUSTDOCFLAGS", "-Zunstable-options --generate-link-to-definition");
936 }
937 builder.run(&mut cargo);
938 }
939 }
940
941 // We now run GUI tests.
942 let mut command = Command::new(&nodejs);
943 command
944 .arg(builder.build.src.join("src/tools/rustdoc-gui/tester.js"))
945 .arg("--jobs")
946 .arg(&builder.jobs().to_string())
947 .arg("--doc-folder")
948 .arg(out_dir.join("doc"))
949 .arg("--tests-folder")
950 .arg(builder.build.src.join("src/test/rustdoc-gui"));
951 for path in &builder.paths {
952 if let Some(p) = util::is_valid_test_suite_arg(path, "src/test/rustdoc-gui", builder) {
953 if !p.ends_with(".goml") {
954 eprintln!("A non-goml file was given: `{}`", path.display());
955 panic!("Cannot run rustdoc-gui tests");
956 }
957 if let Some(name) = path.file_name().and_then(|f| f.to_str()) {
958 command.arg("--file").arg(name);
959 }
960 }
961 }
962 for test_arg in builder.config.cmd.test_args() {
963 command.arg(test_arg);
964 }
965 builder.run(&mut command);
966 }
967 }
968
969 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
970 pub struct Tidy;
971
972 impl Step for Tidy {
973 type Output = ();
974 const DEFAULT: bool = true;
975 const ONLY_HOSTS: bool = true;
976
977 /// Runs the `tidy` tool.
978 ///
979 /// This tool in `src/tools` checks up on various bits and pieces of style and
980 /// otherwise just implements a few lint-like checks that are specific to the
981 /// compiler itself.
982 ///
983 /// Once tidy passes, this step also runs `fmt --check` if tests are being run
984 /// for the `dev` or `nightly` channels.
run(self, builder: &Builder<'_>)985 fn run(self, builder: &Builder<'_>) {
986 let mut cmd = builder.tool_cmd(Tool::Tidy);
987 cmd.arg(&builder.src);
988 cmd.arg(&builder.initial_cargo);
989 cmd.arg(&builder.out);
990 cmd.arg(builder.jobs().to_string());
991 if builder.is_verbose() {
992 cmd.arg("--verbose");
993 }
994
995 builder.info("tidy check");
996 try_run(builder, &mut cmd);
997
998 if builder.config.channel == "dev" || builder.config.channel == "nightly" {
999 builder.info("fmt check");
1000 if builder.config.initial_rustfmt.is_none() {
1001 let inferred_rustfmt_dir = builder.config.initial_rustc.parent().unwrap();
1002 eprintln!(
1003 "\
1004 error: no `rustfmt` binary found in {PATH}
1005 info: `rust.channel` is currently set to \"{CHAN}\"
1006 help: if you are testing a beta branch, set `rust.channel` to \"beta\" in the `config.toml` file
1007 help: to skip test's attempt to check tidiness, pass `--exclude src/tools/tidy` to `x.py test`",
1008 PATH = inferred_rustfmt_dir.display(),
1009 CHAN = builder.config.channel,
1010 );
1011 std::process::exit(1);
1012 }
1013 crate::format::format(&builder.build, !builder.config.cmd.bless(), &[]);
1014 }
1015 }
1016
should_run(run: ShouldRun<'_>) -> ShouldRun<'_>1017 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1018 run.path("src/tools/tidy")
1019 }
1020
make_run(run: RunConfig<'_>)1021 fn make_run(run: RunConfig<'_>) {
1022 run.builder.ensure(Tidy);
1023 }
1024 }
1025
1026 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1027 pub struct ExpandYamlAnchors;
1028
1029 impl Step for ExpandYamlAnchors {
1030 type Output = ();
1031 const ONLY_HOSTS: bool = true;
1032
1033 /// Ensure the `generate-ci-config` tool was run locally.
1034 ///
1035 /// The tool in `src/tools` reads the CI definition in `src/ci/builders.yml` and generates the
1036 /// appropriate configuration for all our CI providers. This step ensures the tool was called
1037 /// by the user before committing CI changes.
run(self, builder: &Builder<'_>)1038 fn run(self, builder: &Builder<'_>) {
1039 builder.info("Ensuring the YAML anchors in the GitHub Actions config were expanded");
1040 try_run(
1041 builder,
1042 &mut builder.tool_cmd(Tool::ExpandYamlAnchors).arg("check").arg(&builder.src),
1043 );
1044 }
1045
should_run(run: ShouldRun<'_>) -> ShouldRun<'_>1046 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1047 run.path("src/tools/expand-yaml-anchors")
1048 }
1049
make_run(run: RunConfig<'_>)1050 fn make_run(run: RunConfig<'_>) {
1051 run.builder.ensure(ExpandYamlAnchors);
1052 }
1053 }
1054
testdir(builder: &Builder<'_>, host: TargetSelection) -> PathBuf1055 fn testdir(builder: &Builder<'_>, host: TargetSelection) -> PathBuf {
1056 builder.out.join(host.triple).join("test")
1057 }
1058
1059 macro_rules! default_test {
1060 ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr }) => {
1061 test!($name { path: $path, mode: $mode, suite: $suite, default: true, host: false });
1062 };
1063 }
1064
1065 macro_rules! default_test_with_compare_mode {
1066 ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr,
1067 compare_mode: $compare_mode:expr }) => {
1068 test_with_compare_mode!($name {
1069 path: $path,
1070 mode: $mode,
1071 suite: $suite,
1072 default: true,
1073 host: false,
1074 compare_mode: $compare_mode
1075 });
1076 };
1077 }
1078
1079 macro_rules! host_test {
1080 ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr }) => {
1081 test!($name { path: $path, mode: $mode, suite: $suite, default: true, host: true });
1082 };
1083 }
1084
1085 macro_rules! test {
1086 ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr, default: $default:expr,
1087 host: $host:expr }) => {
1088 test_definitions!($name {
1089 path: $path,
1090 mode: $mode,
1091 suite: $suite,
1092 default: $default,
1093 host: $host,
1094 compare_mode: None
1095 });
1096 };
1097 }
1098
1099 macro_rules! test_with_compare_mode {
1100 ($name:ident { path: $path:expr, mode: $mode:expr, suite: $suite:expr, default: $default:expr,
1101 host: $host:expr, compare_mode: $compare_mode:expr }) => {
1102 test_definitions!($name {
1103 path: $path,
1104 mode: $mode,
1105 suite: $suite,
1106 default: $default,
1107 host: $host,
1108 compare_mode: Some($compare_mode)
1109 });
1110 };
1111 }
1112
1113 macro_rules! test_definitions {
1114 ($name:ident {
1115 path: $path:expr,
1116 mode: $mode:expr,
1117 suite: $suite:expr,
1118 default: $default:expr,
1119 host: $host:expr,
1120 compare_mode: $compare_mode:expr
1121 }) => {
1122 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1123 pub struct $name {
1124 pub compiler: Compiler,
1125 pub target: TargetSelection,
1126 }
1127
1128 impl Step for $name {
1129 type Output = ();
1130 const DEFAULT: bool = $default;
1131 const ONLY_HOSTS: bool = $host;
1132
1133 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1134 run.suite_path($path)
1135 }
1136
1137 fn make_run(run: RunConfig<'_>) {
1138 let compiler = run.builder.compiler(run.builder.top_stage, run.build_triple());
1139
1140 run.builder.ensure($name { compiler, target: run.target });
1141 }
1142
1143 fn run(self, builder: &Builder<'_>) {
1144 builder.ensure(Compiletest {
1145 compiler: self.compiler,
1146 target: self.target,
1147 mode: $mode,
1148 suite: $suite,
1149 path: $path,
1150 compare_mode: $compare_mode,
1151 })
1152 }
1153 }
1154 };
1155 }
1156
1157 default_test_with_compare_mode!(Ui {
1158 path: "src/test/ui",
1159 mode: "ui",
1160 suite: "ui",
1161 compare_mode: "nll"
1162 });
1163
1164 default_test!(RunPassValgrind {
1165 path: "src/test/run-pass-valgrind",
1166 mode: "run-pass-valgrind",
1167 suite: "run-pass-valgrind"
1168 });
1169
1170 default_test!(MirOpt { path: "src/test/mir-opt", mode: "mir-opt", suite: "mir-opt" });
1171
1172 default_test!(Codegen { path: "src/test/codegen", mode: "codegen", suite: "codegen" });
1173
1174 default_test!(CodegenUnits {
1175 path: "src/test/codegen-units",
1176 mode: "codegen-units",
1177 suite: "codegen-units"
1178 });
1179
1180 default_test!(Incremental {
1181 path: "src/test/incremental",
1182 mode: "incremental",
1183 suite: "incremental"
1184 });
1185
1186 default_test_with_compare_mode!(Debuginfo {
1187 path: "src/test/debuginfo",
1188 mode: "debuginfo",
1189 suite: "debuginfo",
1190 compare_mode: "split-dwarf"
1191 });
1192
1193 host_test!(UiFullDeps { path: "src/test/ui-fulldeps", mode: "ui", suite: "ui-fulldeps" });
1194
1195 host_test!(Rustdoc { path: "src/test/rustdoc", mode: "rustdoc", suite: "rustdoc" });
1196 host_test!(RustdocUi { path: "src/test/rustdoc-ui", mode: "ui", suite: "rustdoc-ui" });
1197
1198 host_test!(RustdocJson {
1199 path: "src/test/rustdoc-json",
1200 mode: "rustdoc-json",
1201 suite: "rustdoc-json"
1202 });
1203
1204 host_test!(Pretty { path: "src/test/pretty", mode: "pretty", suite: "pretty" });
1205
1206 default_test!(RunMake { path: "src/test/run-make", mode: "run-make", suite: "run-make" });
1207
1208 host_test!(RunMakeFullDeps {
1209 path: "src/test/run-make-fulldeps",
1210 mode: "run-make",
1211 suite: "run-make-fulldeps"
1212 });
1213
1214 default_test!(Assembly { path: "src/test/assembly", mode: "assembly", suite: "assembly" });
1215
1216 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1217 struct Compiletest {
1218 compiler: Compiler,
1219 target: TargetSelection,
1220 mode: &'static str,
1221 suite: &'static str,
1222 path: &'static str,
1223 compare_mode: Option<&'static str>,
1224 }
1225
1226 impl Step for Compiletest {
1227 type Output = ();
1228
should_run(run: ShouldRun<'_>) -> ShouldRun<'_>1229 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1230 run.never()
1231 }
1232
1233 /// Executes the `compiletest` tool to run a suite of tests.
1234 ///
1235 /// Compiles all tests with `compiler` for `target` with the specified
1236 /// compiletest `mode` and `suite` arguments. For example `mode` can be
1237 /// "run-pass" or `suite` can be something like `debuginfo`.
run(self, builder: &Builder<'_>)1238 fn run(self, builder: &Builder<'_>) {
1239 if builder.top_stage == 0 && env::var("COMPILETEST_FORCE_STAGE0").is_err() {
1240 eprintln!("\
1241 error: `--stage 0` runs compiletest on the beta compiler, not your local changes, and will almost always cause tests to fail
1242 help: to test the compiler, use `--stage 1` instead
1243 help: to test the standard library, use `--stage 0 library/std` instead
1244 note: if you're sure you want to do this, please open an issue as to why. In the meantime, you can override this with `COMPILETEST_FORCE_STAGE0=1`."
1245 );
1246 std::process::exit(1);
1247 }
1248
1249 let compiler = self.compiler;
1250 let target = self.target;
1251 let mode = self.mode;
1252 let suite = self.suite;
1253
1254 // Path for test suite
1255 let suite_path = self.path;
1256
1257 // Skip codegen tests if they aren't enabled in configuration.
1258 if !builder.config.codegen_tests && suite == "codegen" {
1259 return;
1260 }
1261
1262 if suite == "debuginfo" {
1263 builder
1264 .ensure(dist::DebuggerScripts { sysroot: builder.sysroot(compiler), host: target });
1265 }
1266
1267 if suite.ends_with("fulldeps") {
1268 builder.ensure(compile::Rustc { compiler, target });
1269 }
1270
1271 builder.ensure(compile::Std { compiler, target });
1272 // ensure that `libproc_macro` is available on the host.
1273 builder.ensure(compile::Std { compiler, target: compiler.host });
1274
1275 // Also provide `rust_test_helpers` for the host.
1276 builder.ensure(native::TestHelpers { target: compiler.host });
1277
1278 // As well as the target, except for plain wasm32, which can't build it
1279 if !target.contains("wasm") || target.contains("emscripten") {
1280 builder.ensure(native::TestHelpers { target });
1281 }
1282
1283 builder.ensure(RemoteCopyLibs { compiler, target });
1284
1285 let mut cmd = builder.tool_cmd(Tool::Compiletest);
1286
1287 // compiletest currently has... a lot of arguments, so let's just pass all
1288 // of them!
1289
1290 cmd.arg("--compile-lib-path").arg(builder.rustc_libdir(compiler));
1291 cmd.arg("--run-lib-path").arg(builder.sysroot_libdir(compiler, target));
1292 cmd.arg("--rustc-path").arg(builder.rustc(compiler));
1293
1294 let is_rustdoc = suite.ends_with("rustdoc-ui") || suite.ends_with("rustdoc-js");
1295
1296 // Avoid depending on rustdoc when we don't need it.
1297 if mode == "rustdoc"
1298 || mode == "run-make"
1299 || (mode == "ui" && is_rustdoc)
1300 || mode == "js-doc-test"
1301 || mode == "rustdoc-json"
1302 {
1303 cmd.arg("--rustdoc-path").arg(builder.rustdoc(compiler));
1304 }
1305
1306 if mode == "rustdoc-json" {
1307 // Use the beta compiler for jsondocck
1308 let json_compiler = compiler.with_stage(0);
1309 cmd.arg("--jsondocck-path")
1310 .arg(builder.ensure(tool::JsonDocCk { compiler: json_compiler, target }));
1311 }
1312
1313 if mode == "run-make" && suite.ends_with("fulldeps") {
1314 let rust_demangler = builder
1315 .ensure(tool::RustDemangler { compiler, target, extra_features: Vec::new() })
1316 .expect("in-tree tool");
1317 cmd.arg("--rust-demangler-path").arg(rust_demangler);
1318 }
1319
1320 cmd.arg("--src-base").arg(builder.src.join("src/test").join(suite));
1321 cmd.arg("--build-base").arg(testdir(builder, compiler.host).join(suite));
1322 cmd.arg("--stage-id").arg(format!("stage{}-{}", compiler.stage, target));
1323 cmd.arg("--suite").arg(suite);
1324 cmd.arg("--mode").arg(mode);
1325 cmd.arg("--target").arg(target.rustc_target_arg());
1326 cmd.arg("--host").arg(&*compiler.host.triple);
1327 cmd.arg("--llvm-filecheck").arg(builder.llvm_filecheck(builder.config.build));
1328
1329 if builder.config.cmd.bless() {
1330 cmd.arg("--bless");
1331 }
1332
1333 if builder.config.cmd.force_rerun() {
1334 cmd.arg("--force-rerun");
1335 }
1336
1337 let compare_mode =
1338 builder.config.cmd.compare_mode().or_else(|| {
1339 if builder.config.test_compare_mode { self.compare_mode } else { None }
1340 });
1341
1342 if let Some(ref pass) = builder.config.cmd.pass() {
1343 cmd.arg("--pass");
1344 cmd.arg(pass);
1345 }
1346
1347 if let Some(ref run) = builder.config.cmd.run() {
1348 cmd.arg("--run");
1349 cmd.arg(run);
1350 }
1351
1352 if let Some(ref nodejs) = builder.config.nodejs {
1353 cmd.arg("--nodejs").arg(nodejs);
1354 }
1355 if let Some(ref npm) = builder.config.npm {
1356 cmd.arg("--npm").arg(npm);
1357 }
1358
1359 let mut flags = if is_rustdoc { Vec::new() } else { vec!["-Crpath".to_string()] };
1360 if !is_rustdoc {
1361 if builder.config.rust_optimize_tests {
1362 flags.push("-O".to_string());
1363 }
1364 }
1365 flags.push(format!("-Cdebuginfo={}", builder.config.rust_debuginfo_level_tests));
1366 flags.push(builder.config.cmd.rustc_args().join(" "));
1367
1368 if let Some(linker) = builder.linker(target) {
1369 cmd.arg("--linker").arg(linker);
1370 }
1371
1372 let mut hostflags = flags.clone();
1373 hostflags.push(format!("-Lnative={}", builder.test_helpers_out(compiler.host).display()));
1374 hostflags.extend(builder.lld_flags(compiler.host));
1375 cmd.arg("--host-rustcflags").arg(hostflags.join(" "));
1376
1377 let mut targetflags = flags;
1378 targetflags.push(format!("-Lnative={}", builder.test_helpers_out(target).display()));
1379 targetflags.extend(builder.lld_flags(target));
1380 cmd.arg("--target-rustcflags").arg(targetflags.join(" "));
1381
1382 cmd.arg("--docck-python").arg(builder.python());
1383
1384 if builder.config.build.ends_with("apple-darwin") {
1385 // Force /usr/bin/python3 on macOS for LLDB tests because we're loading the
1386 // LLDB plugin's compiled module which only works with the system python
1387 // (namely not Homebrew-installed python)
1388 cmd.arg("--lldb-python").arg("/usr/bin/python3");
1389 } else {
1390 cmd.arg("--lldb-python").arg(builder.python());
1391 }
1392
1393 if let Some(ref gdb) = builder.config.gdb {
1394 cmd.arg("--gdb").arg(gdb);
1395 }
1396
1397 let run = |cmd: &mut Command| {
1398 cmd.output().map(|output| {
1399 String::from_utf8_lossy(&output.stdout)
1400 .lines()
1401 .next()
1402 .unwrap_or_else(|| panic!("{:?} failed {:?}", cmd, output))
1403 .to_string()
1404 })
1405 };
1406 let lldb_exe = "lldb";
1407 let lldb_version = Command::new(lldb_exe)
1408 .arg("--version")
1409 .output()
1410 .map(|output| String::from_utf8_lossy(&output.stdout).to_string())
1411 .ok();
1412 if let Some(ref vers) = lldb_version {
1413 cmd.arg("--lldb-version").arg(vers);
1414 let lldb_python_dir = run(Command::new(lldb_exe).arg("-P")).ok();
1415 if let Some(ref dir) = lldb_python_dir {
1416 cmd.arg("--lldb-python-dir").arg(dir);
1417 }
1418 }
1419
1420 if util::forcing_clang_based_tests() {
1421 let clang_exe = builder.llvm_out(target).join("bin").join("clang");
1422 cmd.arg("--run-clang-based-tests-with").arg(clang_exe);
1423 }
1424
1425 // Get paths from cmd args
1426 let paths = match &builder.config.cmd {
1427 Subcommand::Test { ref paths, .. } => &paths[..],
1428 _ => &[],
1429 };
1430
1431 // Get test-args by striping suite path
1432 let mut test_args: Vec<&str> = paths
1433 .iter()
1434 .filter_map(|p| util::is_valid_test_suite_arg(p, suite_path, builder))
1435 .collect();
1436
1437 test_args.append(&mut builder.config.cmd.test_args());
1438
1439 cmd.args(&test_args);
1440
1441 if builder.is_verbose() {
1442 cmd.arg("--verbose");
1443 }
1444
1445 if !builder.config.verbose_tests {
1446 cmd.arg("--quiet");
1447 }
1448
1449 let mut llvm_components_passed = false;
1450 let mut copts_passed = false;
1451 if builder.config.llvm_enabled() {
1452 let llvm_config = builder.ensure(native::Llvm { target: builder.config.build });
1453 if !builder.config.dry_run {
1454 let llvm_version = output(Command::new(&llvm_config).arg("--version"));
1455 let llvm_components = output(Command::new(&llvm_config).arg("--components"));
1456 // Remove trailing newline from llvm-config output.
1457 cmd.arg("--llvm-version")
1458 .arg(llvm_version.trim())
1459 .arg("--llvm-components")
1460 .arg(llvm_components.trim());
1461 llvm_components_passed = true;
1462 }
1463 if !builder.is_rust_llvm(target) {
1464 cmd.arg("--system-llvm");
1465 }
1466
1467 // Tests that use compiler libraries may inherit the `-lLLVM` link
1468 // requirement, but the `-L` library path is not propagated across
1469 // separate compilations. We can add LLVM's library path to the
1470 // platform-specific environment variable as a workaround.
1471 if !builder.config.dry_run && suite.ends_with("fulldeps") {
1472 let llvm_libdir = output(Command::new(&llvm_config).arg("--libdir"));
1473 add_link_lib_path(vec![llvm_libdir.trim().into()], &mut cmd);
1474 }
1475
1476 // Only pass correct values for these flags for the `run-make` suite as it
1477 // requires that a C++ compiler was configured which isn't always the case.
1478 if !builder.config.dry_run && matches!(suite, "run-make" | "run-make-fulldeps") {
1479 // The llvm/bin directory contains many useful cross-platform
1480 // tools. Pass the path to run-make tests so they can use them.
1481 let llvm_bin_path = llvm_config
1482 .parent()
1483 .expect("Expected llvm-config to be contained in directory");
1484 assert!(llvm_bin_path.is_dir());
1485 cmd.arg("--llvm-bin-dir").arg(llvm_bin_path);
1486
1487 // If LLD is available, add it to the PATH
1488 if builder.config.lld_enabled {
1489 let lld_install_root =
1490 builder.ensure(native::Lld { target: builder.config.build });
1491
1492 let lld_bin_path = lld_install_root.join("bin");
1493
1494 let old_path = env::var_os("PATH").unwrap_or_default();
1495 let new_path = env::join_paths(
1496 std::iter::once(lld_bin_path).chain(env::split_paths(&old_path)),
1497 )
1498 .expect("Could not add LLD bin path to PATH");
1499 cmd.env("PATH", new_path);
1500 }
1501 }
1502 }
1503
1504 // Only pass correct values for these flags for the `run-make` suite as it
1505 // requires that a C++ compiler was configured which isn't always the case.
1506 if !builder.config.dry_run && matches!(suite, "run-make" | "run-make-fulldeps") {
1507 cmd.arg("--cc")
1508 .arg(builder.cc(target))
1509 .arg("--cxx")
1510 .arg(builder.cxx(target).unwrap())
1511 .arg("--cflags")
1512 .arg(builder.cflags(target, GitRepo::Rustc).join(" "));
1513 copts_passed = true;
1514 if let Some(ar) = builder.ar(target) {
1515 cmd.arg("--ar").arg(ar);
1516 }
1517 }
1518
1519 if !llvm_components_passed {
1520 cmd.arg("--llvm-components").arg("");
1521 }
1522 if !copts_passed {
1523 cmd.arg("--cc").arg("").arg("--cxx").arg("").arg("--cflags").arg("");
1524 }
1525
1526 if builder.remote_tested(target) {
1527 cmd.arg("--remote-test-client").arg(builder.tool_exe(Tool::RemoteTestClient));
1528 }
1529
1530 // Running a C compiler on MSVC requires a few env vars to be set, to be
1531 // sure to set them here.
1532 //
1533 // Note that if we encounter `PATH` we make sure to append to our own `PATH`
1534 // rather than stomp over it.
1535 if target.contains("msvc") {
1536 for &(ref k, ref v) in builder.cc[&target].env() {
1537 if k != "PATH" {
1538 cmd.env(k, v);
1539 }
1540 }
1541 }
1542 cmd.env("RUSTC_BOOTSTRAP", "1");
1543 cmd.env("DOC_RUST_LANG_ORG_CHANNEL", builder.doc_rust_lang_org_channel());
1544 builder.add_rust_test_threads(&mut cmd);
1545
1546 if builder.config.sanitizers_enabled(target) {
1547 cmd.env("RUSTC_SANITIZER_SUPPORT", "1");
1548 }
1549
1550 if builder.config.profiler_enabled(target) {
1551 cmd.env("RUSTC_PROFILER_SUPPORT", "1");
1552 }
1553
1554 let tmp = builder.out.join("tmp");
1555 std::fs::create_dir_all(&tmp).unwrap();
1556 cmd.env("RUST_TEST_TMPDIR", tmp);
1557
1558 cmd.arg("--adb-path").arg("adb");
1559 cmd.arg("--adb-test-dir").arg(ADB_TEST_DIR);
1560 if target.contains("android") {
1561 // Assume that cc for this target comes from the android sysroot
1562 cmd.arg("--android-cross-path")
1563 .arg(builder.cc(target).parent().unwrap().parent().unwrap());
1564 } else {
1565 cmd.arg("--android-cross-path").arg("");
1566 }
1567
1568 if builder.config.cmd.rustfix_coverage() {
1569 cmd.arg("--rustfix-coverage");
1570 }
1571
1572 cmd.env("BOOTSTRAP_CARGO", &builder.initial_cargo);
1573
1574 cmd.arg("--channel").arg(&builder.config.channel);
1575
1576 builder.ci_env.force_coloring_in_ci(&mut cmd);
1577
1578 builder.info(&format!(
1579 "Check compiletest suite={} mode={} ({} -> {})",
1580 suite, mode, &compiler.host, target
1581 ));
1582 let _time = util::timeit(&builder);
1583 try_run(builder, &mut cmd);
1584
1585 if let Some(compare_mode) = compare_mode {
1586 cmd.arg("--compare-mode").arg(compare_mode);
1587 builder.info(&format!(
1588 "Check compiletest suite={} mode={} compare_mode={} ({} -> {})",
1589 suite, mode, compare_mode, &compiler.host, target
1590 ));
1591 let _time = util::timeit(&builder);
1592 try_run(builder, &mut cmd);
1593 }
1594 }
1595 }
1596
1597 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
1598 struct BookTest {
1599 compiler: Compiler,
1600 path: PathBuf,
1601 name: &'static str,
1602 is_ext_doc: bool,
1603 }
1604
1605 impl Step for BookTest {
1606 type Output = ();
1607 const ONLY_HOSTS: bool = true;
1608
should_run(run: ShouldRun<'_>) -> ShouldRun<'_>1609 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1610 run.never()
1611 }
1612
1613 /// Runs the documentation tests for a book in `src/doc`.
1614 ///
1615 /// This uses the `rustdoc` that sits next to `compiler`.
run(self, builder: &Builder<'_>)1616 fn run(self, builder: &Builder<'_>) {
1617 // External docs are different from local because:
1618 // - Some books need pre-processing by mdbook before being tested.
1619 // - They need to save their state to toolstate.
1620 // - They are only tested on the "checktools" builders.
1621 //
1622 // The local docs are tested by default, and we don't want to pay the
1623 // cost of building mdbook, so they use `rustdoc --test` directly.
1624 // Also, the unstable book is special because SUMMARY.md is generated,
1625 // so it is easier to just run `rustdoc` on its files.
1626 if self.is_ext_doc {
1627 self.run_ext_doc(builder);
1628 } else {
1629 self.run_local_doc(builder);
1630 }
1631 }
1632 }
1633
1634 impl BookTest {
1635 /// This runs the equivalent of `mdbook test` (via the rustbook wrapper)
1636 /// which in turn runs `rustdoc --test` on each file in the book.
run_ext_doc(self, builder: &Builder<'_>)1637 fn run_ext_doc(self, builder: &Builder<'_>) {
1638 let compiler = self.compiler;
1639
1640 builder.ensure(compile::Std { compiler, target: compiler.host });
1641
1642 // mdbook just executes a binary named "rustdoc", so we need to update
1643 // PATH so that it points to our rustdoc.
1644 let mut rustdoc_path = builder.rustdoc(compiler);
1645 rustdoc_path.pop();
1646 let old_path = env::var_os("PATH").unwrap_or_default();
1647 let new_path = env::join_paths(iter::once(rustdoc_path).chain(env::split_paths(&old_path)))
1648 .expect("could not add rustdoc to PATH");
1649
1650 let mut rustbook_cmd = builder.tool_cmd(Tool::Rustbook);
1651 let path = builder.src.join(&self.path);
1652 rustbook_cmd.env("PATH", new_path).arg("test").arg(path);
1653 builder.add_rust_test_threads(&mut rustbook_cmd);
1654 builder.info(&format!("Testing rustbook {}", self.path.display()));
1655 let _time = util::timeit(&builder);
1656 let toolstate = if try_run(builder, &mut rustbook_cmd) {
1657 ToolState::TestPass
1658 } else {
1659 ToolState::TestFail
1660 };
1661 builder.save_toolstate(self.name, toolstate);
1662 }
1663
1664 /// This runs `rustdoc --test` on all `.md` files in the path.
run_local_doc(self, builder: &Builder<'_>)1665 fn run_local_doc(self, builder: &Builder<'_>) {
1666 let compiler = self.compiler;
1667
1668 builder.ensure(compile::Std { compiler, target: compiler.host });
1669
1670 // Do a breadth-first traversal of the `src/doc` directory and just run
1671 // tests for all files that end in `*.md`
1672 let mut stack = vec![builder.src.join(self.path)];
1673 let _time = util::timeit(&builder);
1674 let mut files = Vec::new();
1675 while let Some(p) = stack.pop() {
1676 if p.is_dir() {
1677 stack.extend(t!(p.read_dir()).map(|p| t!(p).path()));
1678 continue;
1679 }
1680
1681 if p.extension().and_then(|s| s.to_str()) != Some("md") {
1682 continue;
1683 }
1684
1685 files.push(p);
1686 }
1687
1688 files.sort();
1689
1690 for file in files {
1691 markdown_test(builder, compiler, &file);
1692 }
1693 }
1694 }
1695
1696 macro_rules! test_book {
1697 ($($name:ident, $path:expr, $book_name:expr, default=$default:expr;)+) => {
1698 $(
1699 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1700 pub struct $name {
1701 compiler: Compiler,
1702 }
1703
1704 impl Step for $name {
1705 type Output = ();
1706 const DEFAULT: bool = $default;
1707 const ONLY_HOSTS: bool = true;
1708
1709 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1710 run.path($path)
1711 }
1712
1713 fn make_run(run: RunConfig<'_>) {
1714 run.builder.ensure($name {
1715 compiler: run.builder.compiler(run.builder.top_stage, run.target),
1716 });
1717 }
1718
1719 fn run(self, builder: &Builder<'_>) {
1720 builder.ensure(BookTest {
1721 compiler: self.compiler,
1722 path: PathBuf::from($path),
1723 name: $book_name,
1724 is_ext_doc: !$default,
1725 });
1726 }
1727 }
1728 )+
1729 }
1730 }
1731
1732 test_book!(
1733 Nomicon, "src/doc/nomicon", "nomicon", default=false;
1734 Reference, "src/doc/reference", "reference", default=false;
1735 RustdocBook, "src/doc/rustdoc", "rustdoc", default=true;
1736 RustcBook, "src/doc/rustc", "rustc", default=true;
1737 RustByExample, "src/doc/rust-by-example", "rust-by-example", default=false;
1738 EmbeddedBook, "src/doc/embedded-book", "embedded-book", default=false;
1739 TheBook, "src/doc/book", "book", default=false;
1740 UnstableBook, "src/doc/unstable-book", "unstable-book", default=true;
1741 EditionGuide, "src/doc/edition-guide", "edition-guide", default=false;
1742 );
1743
1744 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1745 pub struct ErrorIndex {
1746 compiler: Compiler,
1747 }
1748
1749 impl Step for ErrorIndex {
1750 type Output = ();
1751 const DEFAULT: bool = true;
1752 const ONLY_HOSTS: bool = true;
1753
should_run(run: ShouldRun<'_>) -> ShouldRun<'_>1754 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1755 run.path("src/tools/error_index_generator")
1756 }
1757
make_run(run: RunConfig<'_>)1758 fn make_run(run: RunConfig<'_>) {
1759 // error_index_generator depends on librustdoc. Use the compiler that
1760 // is normally used to build rustdoc for other tests (like compiletest
1761 // tests in src/test/rustdoc) so that it shares the same artifacts.
1762 let compiler = run.builder.compiler(run.builder.top_stage, run.builder.config.build);
1763 run.builder.ensure(ErrorIndex { compiler });
1764 }
1765
1766 /// Runs the error index generator tool to execute the tests located in the error
1767 /// index.
1768 ///
1769 /// The `error_index_generator` tool lives in `src/tools` and is used to
1770 /// generate a markdown file from the error indexes of the code base which is
1771 /// then passed to `rustdoc --test`.
run(self, builder: &Builder<'_>)1772 fn run(self, builder: &Builder<'_>) {
1773 let compiler = self.compiler;
1774
1775 let dir = testdir(builder, compiler.host);
1776 t!(fs::create_dir_all(&dir));
1777 let output = dir.join("error-index.md");
1778
1779 let mut tool = tool::ErrorIndex::command(builder);
1780 tool.arg("markdown").arg(&output);
1781
1782 builder.info(&format!("Testing error-index stage{}", compiler.stage));
1783 let _time = util::timeit(&builder);
1784 builder.run_quiet(&mut tool);
1785 // The tests themselves need to link to std, so make sure it is
1786 // available.
1787 builder.ensure(compile::Std { compiler, target: compiler.host });
1788 markdown_test(builder, compiler, &output);
1789 }
1790 }
1791
markdown_test(builder: &Builder<'_>, compiler: Compiler, markdown: &Path) -> bool1792 fn markdown_test(builder: &Builder<'_>, compiler: Compiler, markdown: &Path) -> bool {
1793 if let Ok(contents) = fs::read_to_string(markdown) {
1794 if !contents.contains("```") {
1795 return true;
1796 }
1797 }
1798
1799 builder.info(&format!("doc tests for: {}", markdown.display()));
1800 let mut cmd = builder.rustdoc_cmd(compiler);
1801 builder.add_rust_test_threads(&mut cmd);
1802 // allow for unstable options such as new editions
1803 cmd.arg("-Z");
1804 cmd.arg("unstable-options");
1805 cmd.arg("--test");
1806 cmd.arg(markdown);
1807 cmd.env("RUSTC_BOOTSTRAP", "1");
1808
1809 let test_args = builder.config.cmd.test_args().join(" ");
1810 cmd.arg("--test-args").arg(test_args);
1811
1812 if builder.config.verbose_tests {
1813 try_run(builder, &mut cmd)
1814 } else {
1815 try_run_quiet(builder, &mut cmd)
1816 }
1817 }
1818
1819 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1820 pub struct RustcGuide;
1821
1822 impl Step for RustcGuide {
1823 type Output = ();
1824 const DEFAULT: bool = false;
1825 const ONLY_HOSTS: bool = true;
1826
should_run(run: ShouldRun<'_>) -> ShouldRun<'_>1827 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1828 run.path("src/doc/rustc-dev-guide")
1829 }
1830
make_run(run: RunConfig<'_>)1831 fn make_run(run: RunConfig<'_>) {
1832 run.builder.ensure(RustcGuide);
1833 }
1834
run(self, builder: &Builder<'_>)1835 fn run(self, builder: &Builder<'_>) {
1836 let relative_path = Path::new("src").join("doc").join("rustc-dev-guide");
1837 builder.update_submodule(&relative_path);
1838
1839 let src = builder.src.join(relative_path);
1840 let mut rustbook_cmd = builder.tool_cmd(Tool::Rustbook);
1841 let toolstate = if try_run(builder, rustbook_cmd.arg("linkcheck").arg(&src)) {
1842 ToolState::TestPass
1843 } else {
1844 ToolState::TestFail
1845 };
1846 builder.save_toolstate("rustc-dev-guide", toolstate);
1847 }
1848 }
1849
1850 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1851 pub struct CrateLibrustc {
1852 compiler: Compiler,
1853 target: TargetSelection,
1854 test_kind: TestKind,
1855 krate: Interned<String>,
1856 }
1857
1858 impl Step for CrateLibrustc {
1859 type Output = ();
1860 const DEFAULT: bool = true;
1861 const ONLY_HOSTS: bool = true;
1862
should_run(run: ShouldRun<'_>) -> ShouldRun<'_>1863 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1864 run.krate("rustc-main")
1865 }
1866
make_run(run: RunConfig<'_>)1867 fn make_run(run: RunConfig<'_>) {
1868 let builder = run.builder;
1869 let compiler = builder.compiler(builder.top_stage, run.build_triple());
1870
1871 for krate in builder.in_tree_crates("rustc-main", Some(run.target)) {
1872 if krate.path.ends_with(&run.path) {
1873 let test_kind = builder.kind.into();
1874
1875 builder.ensure(CrateLibrustc {
1876 compiler,
1877 target: run.target,
1878 test_kind,
1879 krate: krate.name,
1880 });
1881 }
1882 }
1883 }
1884
run(self, builder: &Builder<'_>)1885 fn run(self, builder: &Builder<'_>) {
1886 builder.ensure(Crate {
1887 compiler: self.compiler,
1888 target: self.target,
1889 mode: Mode::Rustc,
1890 test_kind: self.test_kind,
1891 krate: self.krate,
1892 });
1893 }
1894 }
1895
1896 #[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
1897 pub struct Crate {
1898 pub compiler: Compiler,
1899 pub target: TargetSelection,
1900 pub mode: Mode,
1901 pub test_kind: TestKind,
1902 pub krate: Interned<String>,
1903 }
1904
1905 impl Step for Crate {
1906 type Output = ();
1907 const DEFAULT: bool = true;
1908
should_run(run: ShouldRun<'_>) -> ShouldRun<'_>1909 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1910 run.krate("test")
1911 }
1912
make_run(run: RunConfig<'_>)1913 fn make_run(run: RunConfig<'_>) {
1914 let builder = run.builder;
1915 let compiler = builder.compiler(builder.top_stage, run.build_triple());
1916
1917 let make = |mode: Mode, krate: &CargoCrate| {
1918 let test_kind = builder.kind.into();
1919
1920 builder.ensure(Crate {
1921 compiler,
1922 target: run.target,
1923 mode,
1924 test_kind,
1925 krate: krate.name,
1926 });
1927 };
1928
1929 for krate in builder.in_tree_crates("test", Some(run.target)) {
1930 if krate.path.ends_with(&run.path) {
1931 make(Mode::Std, krate);
1932 }
1933 }
1934 }
1935
1936 /// Runs all unit tests plus documentation tests for a given crate defined
1937 /// by a `Cargo.toml` (single manifest)
1938 ///
1939 /// This is what runs tests for crates like the standard library, compiler, etc.
1940 /// It essentially is the driver for running `cargo test`.
1941 ///
1942 /// Currently this runs all tests for a DAG by passing a bunch of `-p foo`
1943 /// arguments, and those arguments are discovered from `cargo metadata`.
run(self, builder: &Builder<'_>)1944 fn run(self, builder: &Builder<'_>) {
1945 let compiler = self.compiler;
1946 let target = self.target;
1947 let mode = self.mode;
1948 let test_kind = self.test_kind;
1949 let krate = self.krate;
1950
1951 builder.ensure(compile::Std { compiler, target });
1952 builder.ensure(RemoteCopyLibs { compiler, target });
1953
1954 // If we're not doing a full bootstrap but we're testing a stage2
1955 // version of libstd, then what we're actually testing is the libstd
1956 // produced in stage1. Reflect that here by updating the compiler that
1957 // we're working with automatically.
1958 let compiler = builder.compiler_for(compiler.stage, compiler.host, target);
1959
1960 let mut cargo =
1961 builder.cargo(compiler, mode, SourceType::InTree, target, test_kind.subcommand());
1962 match mode {
1963 Mode::Std => {
1964 compile::std_cargo(builder, target, compiler.stage, &mut cargo);
1965 }
1966 Mode::Rustc => {
1967 builder.ensure(compile::Rustc { compiler, target });
1968 compile::rustc_cargo(builder, &mut cargo, target);
1969 }
1970 _ => panic!("can only test libraries"),
1971 };
1972
1973 // Build up the base `cargo test` command.
1974 //
1975 // Pass in some standard flags then iterate over the graph we've discovered
1976 // in `cargo metadata` with the maps above and figure out what `-p`
1977 // arguments need to get passed.
1978 if test_kind.subcommand() == "test" && !builder.fail_fast {
1979 cargo.arg("--no-fail-fast");
1980 }
1981 match builder.doc_tests {
1982 DocTests::Only => {
1983 cargo.arg("--doc");
1984 }
1985 DocTests::No => {
1986 cargo.args(&["--lib", "--bins", "--examples", "--tests", "--benches"]);
1987 }
1988 DocTests::Yes => {}
1989 }
1990
1991 cargo.arg("-p").arg(krate);
1992
1993 // The tests are going to run with the *target* libraries, so we need to
1994 // ensure that those libraries show up in the LD_LIBRARY_PATH equivalent.
1995 //
1996 // Note that to run the compiler we need to run with the *host* libraries,
1997 // but our wrapper scripts arrange for that to be the case anyway.
1998 let mut dylib_path = dylib_path();
1999 dylib_path.insert(0, PathBuf::from(&*builder.sysroot_libdir(compiler, target)));
2000 cargo.env(dylib_path_var(), env::join_paths(&dylib_path).unwrap());
2001
2002 cargo.arg("--");
2003 cargo.args(&builder.config.cmd.test_args());
2004
2005 if !builder.config.verbose_tests {
2006 cargo.arg("--quiet");
2007 }
2008
2009 if target.contains("emscripten") {
2010 cargo.env(
2011 format!("CARGO_TARGET_{}_RUNNER", envify(&target.triple)),
2012 builder.config.nodejs.as_ref().expect("nodejs not configured"),
2013 );
2014 } else if target.starts_with("wasm32") {
2015 let node = builder.config.nodejs.as_ref().expect("nodejs not configured");
2016 let runner =
2017 format!("{} {}/src/etc/wasm32-shim.js", node.display(), builder.src.display());
2018 cargo.env(format!("CARGO_TARGET_{}_RUNNER", envify(&target.triple)), &runner);
2019 } else if builder.remote_tested(target) {
2020 cargo.env(
2021 format!("CARGO_TARGET_{}_RUNNER", envify(&target.triple)),
2022 format!("{} run 0", builder.tool_exe(Tool::RemoteTestClient).display()),
2023 );
2024 }
2025
2026 builder.info(&format!(
2027 "{} {} stage{} ({} -> {})",
2028 test_kind, krate, compiler.stage, &compiler.host, target
2029 ));
2030 let _time = util::timeit(&builder);
2031 try_run(builder, &mut cargo.into());
2032 }
2033 }
2034
2035 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2036 pub struct CrateRustdoc {
2037 host: TargetSelection,
2038 test_kind: TestKind,
2039 }
2040
2041 impl Step for CrateRustdoc {
2042 type Output = ();
2043 const DEFAULT: bool = true;
2044 const ONLY_HOSTS: bool = true;
2045
should_run(run: ShouldRun<'_>) -> ShouldRun<'_>2046 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2047 run.paths(&["src/librustdoc", "src/tools/rustdoc"])
2048 }
2049
make_run(run: RunConfig<'_>)2050 fn make_run(run: RunConfig<'_>) {
2051 let builder = run.builder;
2052
2053 let test_kind = builder.kind.into();
2054
2055 builder.ensure(CrateRustdoc { host: run.target, test_kind });
2056 }
2057
run(self, builder: &Builder<'_>)2058 fn run(self, builder: &Builder<'_>) {
2059 let test_kind = self.test_kind;
2060 let target = self.host;
2061
2062 // Use the previous stage compiler to reuse the artifacts that are
2063 // created when running compiletest for src/test/rustdoc. If this used
2064 // `compiler`, then it would cause rustdoc to be built *again*, which
2065 // isn't really necessary.
2066 let compiler = builder.compiler_for(builder.top_stage, target, target);
2067 builder.ensure(compile::Rustc { compiler, target });
2068
2069 let mut cargo = tool::prepare_tool_cargo(
2070 builder,
2071 compiler,
2072 Mode::ToolRustc,
2073 target,
2074 test_kind.subcommand(),
2075 "src/tools/rustdoc",
2076 SourceType::InTree,
2077 &[],
2078 );
2079 if test_kind.subcommand() == "test" && !builder.fail_fast {
2080 cargo.arg("--no-fail-fast");
2081 }
2082
2083 cargo.arg("-p").arg("rustdoc:0.0.0");
2084
2085 cargo.arg("--");
2086 cargo.args(&builder.config.cmd.test_args());
2087
2088 if self.host.contains("musl") {
2089 cargo.arg("'-Ctarget-feature=-crt-static'");
2090 }
2091
2092 // This is needed for running doctests on librustdoc. This is a bit of
2093 // an unfortunate interaction with how bootstrap works and how cargo
2094 // sets up the dylib path, and the fact that the doctest (in
2095 // html/markdown.rs) links to rustc-private libs. For stage1, the
2096 // compiler host dylibs (in stage1/lib) are not the same as the target
2097 // dylibs (in stage1/lib/rustlib/...). This is different from a normal
2098 // rust distribution where they are the same.
2099 //
2100 // On the cargo side, normal tests use `target_process` which handles
2101 // setting up the dylib for a *target* (stage1/lib/rustlib/... in this
2102 // case). However, for doctests it uses `rustdoc_process` which only
2103 // sets up the dylib path for the *host* (stage1/lib), which is the
2104 // wrong directory.
2105 //
2106 // It should be considered to just stop running doctests on
2107 // librustdoc. There is only one test, and it doesn't look too
2108 // important. There might be other ways to avoid this, but it seems
2109 // pretty convoluted.
2110 //
2111 // See also https://github.com/rust-lang/rust/issues/13983 where the
2112 // host vs target dylibs for rustdoc are consistently tricky to deal
2113 // with.
2114 let mut dylib_path = dylib_path();
2115 dylib_path.insert(0, PathBuf::from(&*builder.sysroot_libdir(compiler, target)));
2116 cargo.env(dylib_path_var(), env::join_paths(&dylib_path).unwrap());
2117
2118 if !builder.config.verbose_tests {
2119 cargo.arg("--quiet");
2120 }
2121
2122 builder.info(&format!(
2123 "{} rustdoc stage{} ({} -> {})",
2124 test_kind, compiler.stage, &compiler.host, target
2125 ));
2126 let _time = util::timeit(&builder);
2127
2128 try_run(builder, &mut cargo.into());
2129 }
2130 }
2131
2132 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2133 pub struct CrateRustdocJsonTypes {
2134 host: TargetSelection,
2135 test_kind: TestKind,
2136 }
2137
2138 impl Step for CrateRustdocJsonTypes {
2139 type Output = ();
2140 const DEFAULT: bool = true;
2141 const ONLY_HOSTS: bool = true;
2142
should_run(run: ShouldRun<'_>) -> ShouldRun<'_>2143 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2144 run.path("src/rustdoc-json-types")
2145 }
2146
make_run(run: RunConfig<'_>)2147 fn make_run(run: RunConfig<'_>) {
2148 let builder = run.builder;
2149
2150 let test_kind = builder.kind.into();
2151
2152 builder.ensure(CrateRustdocJsonTypes { host: run.target, test_kind });
2153 }
2154
run(self, builder: &Builder<'_>)2155 fn run(self, builder: &Builder<'_>) {
2156 let test_kind = self.test_kind;
2157 let target = self.host;
2158
2159 // Use the previous stage compiler to reuse the artifacts that are
2160 // created when running compiletest for src/test/rustdoc. If this used
2161 // `compiler`, then it would cause rustdoc to be built *again*, which
2162 // isn't really necessary.
2163 let compiler = builder.compiler_for(builder.top_stage, target, target);
2164 builder.ensure(compile::Rustc { compiler, target });
2165
2166 let mut cargo = tool::prepare_tool_cargo(
2167 builder,
2168 compiler,
2169 Mode::ToolRustc,
2170 target,
2171 test_kind.subcommand(),
2172 "src/rustdoc-json-types",
2173 SourceType::InTree,
2174 &[],
2175 );
2176 if test_kind.subcommand() == "test" && !builder.fail_fast {
2177 cargo.arg("--no-fail-fast");
2178 }
2179
2180 cargo.arg("-p").arg("rustdoc-json-types");
2181
2182 cargo.arg("--");
2183 cargo.args(&builder.config.cmd.test_args());
2184
2185 if self.host.contains("musl") {
2186 cargo.arg("'-Ctarget-feature=-crt-static'");
2187 }
2188
2189 if !builder.config.verbose_tests {
2190 cargo.arg("--quiet");
2191 }
2192
2193 builder.info(&format!(
2194 "{} rustdoc-json-types stage{} ({} -> {})",
2195 test_kind, compiler.stage, &compiler.host, target
2196 ));
2197 let _time = util::timeit(&builder);
2198
2199 try_run(builder, &mut cargo.into());
2200 }
2201 }
2202
2203 /// Some test suites are run inside emulators or on remote devices, and most
2204 /// of our test binaries are linked dynamically which means we need to ship
2205 /// the standard library and such to the emulator ahead of time. This step
2206 /// represents this and is a dependency of all test suites.
2207 ///
2208 /// Most of the time this is a no-op. For some steps such as shipping data to
2209 /// QEMU we have to build our own tools so we've got conditional dependencies
2210 /// on those programs as well. Note that the remote test client is built for
2211 /// the build target (us) and the server is built for the target.
2212 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2213 pub struct RemoteCopyLibs {
2214 compiler: Compiler,
2215 target: TargetSelection,
2216 }
2217
2218 impl Step for RemoteCopyLibs {
2219 type Output = ();
2220
should_run(run: ShouldRun<'_>) -> ShouldRun<'_>2221 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2222 run.never()
2223 }
2224
run(self, builder: &Builder<'_>)2225 fn run(self, builder: &Builder<'_>) {
2226 let compiler = self.compiler;
2227 let target = self.target;
2228 if !builder.remote_tested(target) {
2229 return;
2230 }
2231
2232 builder.ensure(compile::Std { compiler, target });
2233
2234 builder.info(&format!("REMOTE copy libs to emulator ({})", target));
2235 t!(fs::create_dir_all(builder.out.join("tmp")));
2236
2237 let server = builder.ensure(tool::RemoteTestServer { compiler, target });
2238
2239 // Spawn the emulator and wait for it to come online
2240 let tool = builder.tool_exe(Tool::RemoteTestClient);
2241 let mut cmd = Command::new(&tool);
2242 cmd.arg("spawn-emulator").arg(target.triple).arg(&server).arg(builder.out.join("tmp"));
2243 if let Some(rootfs) = builder.qemu_rootfs(target) {
2244 cmd.arg(rootfs);
2245 }
2246 builder.run(&mut cmd);
2247
2248 // Push all our dylibs to the emulator
2249 for f in t!(builder.sysroot_libdir(compiler, target).read_dir()) {
2250 let f = t!(f);
2251 let name = f.file_name().into_string().unwrap();
2252 if util::is_dylib(&name) {
2253 builder.run(Command::new(&tool).arg("push").arg(f.path()));
2254 }
2255 }
2256 }
2257 }
2258
2259 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2260 pub struct Distcheck;
2261
2262 impl Step for Distcheck {
2263 type Output = ();
2264
should_run(run: ShouldRun<'_>) -> ShouldRun<'_>2265 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2266 run.path("distcheck")
2267 }
2268
make_run(run: RunConfig<'_>)2269 fn make_run(run: RunConfig<'_>) {
2270 run.builder.ensure(Distcheck);
2271 }
2272
2273 /// Runs "distcheck", a 'make check' from a tarball
run(self, builder: &Builder<'_>)2274 fn run(self, builder: &Builder<'_>) {
2275 builder.info("Distcheck");
2276 let dir = builder.out.join("tmp").join("distcheck");
2277 let _ = fs::remove_dir_all(&dir);
2278 t!(fs::create_dir_all(&dir));
2279
2280 // Guarantee that these are built before we begin running.
2281 builder.ensure(dist::PlainSourceTarball);
2282 builder.ensure(dist::Src);
2283
2284 let mut cmd = Command::new("tar");
2285 cmd.arg("-xf")
2286 .arg(builder.ensure(dist::PlainSourceTarball).tarball())
2287 .arg("--strip-components=1")
2288 .current_dir(&dir);
2289 builder.run(&mut cmd);
2290 builder.run(
2291 Command::new("./configure")
2292 .args(&builder.config.configure_args)
2293 .arg("--enable-vendor")
2294 .current_dir(&dir),
2295 );
2296 builder.run(
2297 Command::new(build_helper::make(&builder.config.build.triple))
2298 .arg("check")
2299 .current_dir(&dir),
2300 );
2301
2302 // Now make sure that rust-src has all of libstd's dependencies
2303 builder.info("Distcheck rust-src");
2304 let dir = builder.out.join("tmp").join("distcheck-src");
2305 let _ = fs::remove_dir_all(&dir);
2306 t!(fs::create_dir_all(&dir));
2307
2308 let mut cmd = Command::new("tar");
2309 cmd.arg("-xf")
2310 .arg(builder.ensure(dist::Src).tarball())
2311 .arg("--strip-components=1")
2312 .current_dir(&dir);
2313 builder.run(&mut cmd);
2314
2315 let toml = dir.join("rust-src/lib/rustlib/src/rust/library/std/Cargo.toml");
2316 builder.run(
2317 Command::new(&builder.initial_cargo)
2318 .arg("generate-lockfile")
2319 .arg("--manifest-path")
2320 .arg(&toml)
2321 .current_dir(&dir),
2322 );
2323 }
2324 }
2325
2326 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2327 pub struct Bootstrap;
2328
2329 impl Step for Bootstrap {
2330 type Output = ();
2331 const DEFAULT: bool = true;
2332 const ONLY_HOSTS: bool = true;
2333
2334 /// Tests the build system itself.
run(self, builder: &Builder<'_>)2335 fn run(self, builder: &Builder<'_>) {
2336 let mut cmd = Command::new(&builder.initial_cargo);
2337 cmd.arg("test")
2338 .current_dir(builder.src.join("src/bootstrap"))
2339 .env("RUSTFLAGS", "-Cdebuginfo=2")
2340 .env("CARGO_TARGET_DIR", builder.out.join("bootstrap"))
2341 .env("BOOTSTRAP_OUTPUT_DIRECTORY", &builder.config.out)
2342 .env("BOOTSTRAP_INITIAL_CARGO", &builder.config.initial_cargo)
2343 .env("RUSTC_BOOTSTRAP", "1")
2344 .env("RUSTC", &builder.initial_rustc);
2345 if let Some(flags) = option_env!("RUSTFLAGS") {
2346 // Use the same rustc flags for testing as for "normal" compilation,
2347 // so that Cargo doesn’t recompile the entire dependency graph every time:
2348 // https://github.com/rust-lang/rust/issues/49215
2349 cmd.env("RUSTFLAGS", flags);
2350 }
2351 if !builder.fail_fast {
2352 cmd.arg("--no-fail-fast");
2353 }
2354 cmd.arg("--").args(&builder.config.cmd.test_args());
2355 // rustbuild tests are racy on directory creation so just run them one at a time.
2356 // Since there's not many this shouldn't be a problem.
2357 cmd.arg("--test-threads=1");
2358 try_run(builder, &mut cmd);
2359 }
2360
should_run(run: ShouldRun<'_>) -> ShouldRun<'_>2361 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2362 run.path("src/bootstrap")
2363 }
2364
make_run(run: RunConfig<'_>)2365 fn make_run(run: RunConfig<'_>) {
2366 run.builder.ensure(Bootstrap);
2367 }
2368 }
2369
2370 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2371 pub struct TierCheck {
2372 pub compiler: Compiler,
2373 }
2374
2375 impl Step for TierCheck {
2376 type Output = ();
2377 const DEFAULT: bool = true;
2378 const ONLY_HOSTS: bool = true;
2379
should_run(run: ShouldRun<'_>) -> ShouldRun<'_>2380 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2381 run.path("src/tools/tier-check")
2382 }
2383
make_run(run: RunConfig<'_>)2384 fn make_run(run: RunConfig<'_>) {
2385 let compiler =
2386 run.builder.compiler_for(run.builder.top_stage, run.builder.build.build, run.target);
2387 run.builder.ensure(TierCheck { compiler });
2388 }
2389
2390 /// Tests the Platform Support page in the rustc book.
run(self, builder: &Builder<'_>)2391 fn run(self, builder: &Builder<'_>) {
2392 builder.ensure(compile::Std { compiler: self.compiler, target: self.compiler.host });
2393 let mut cargo = tool::prepare_tool_cargo(
2394 builder,
2395 self.compiler,
2396 Mode::ToolStd,
2397 self.compiler.host,
2398 "run",
2399 "src/tools/tier-check",
2400 SourceType::InTree,
2401 &[],
2402 );
2403 cargo.arg(builder.src.join("src/doc/rustc/src/platform-support.md"));
2404 cargo.arg(&builder.rustc(self.compiler));
2405 if builder.is_verbose() {
2406 cargo.arg("--verbose");
2407 }
2408
2409 builder.info("platform support check");
2410 try_run(builder, &mut cargo.into());
2411 }
2412 }
2413
2414 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
2415 pub struct LintDocs {
2416 pub compiler: Compiler,
2417 pub target: TargetSelection,
2418 }
2419
2420 impl Step for LintDocs {
2421 type Output = ();
2422 const DEFAULT: bool = true;
2423 const ONLY_HOSTS: bool = true;
2424
should_run(run: ShouldRun<'_>) -> ShouldRun<'_>2425 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
2426 run.path("src/tools/lint-docs")
2427 }
2428
make_run(run: RunConfig<'_>)2429 fn make_run(run: RunConfig<'_>) {
2430 run.builder.ensure(LintDocs {
2431 compiler: run.builder.compiler(run.builder.top_stage, run.builder.config.build),
2432 target: run.target,
2433 });
2434 }
2435
2436 /// Tests that the lint examples in the rustc book generate the correct
2437 /// lints and have the expected format.
run(self, builder: &Builder<'_>)2438 fn run(self, builder: &Builder<'_>) {
2439 builder.ensure(crate::doc::RustcBook {
2440 compiler: self.compiler,
2441 target: self.target,
2442 validate: true,
2443 });
2444 }
2445 }
2446