1 use rustc_ast as ast;
2 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
3 use rustc_data_structures::sync::Lrc;
4 use rustc_errors::{ColorConfig, ErrorReported, FatalError};
5 use rustc_hir as hir;
6 use rustc_hir::def_id::LOCAL_CRATE;
7 use rustc_hir::intravisit;
8 use rustc_hir::{HirId, CRATE_HIR_ID};
9 use rustc_interface::interface;
10 use rustc_middle::hir::map::Map;
11 use rustc_middle::ty::TyCtxt;
12 use rustc_session::config::{self, CrateType, ErrorOutputType};
13 use rustc_session::{lint, DiagnosticOutput, Session};
14 use rustc_span::edition::Edition;
15 use rustc_span::source_map::SourceMap;
16 use rustc_span::symbol::sym;
17 use rustc_span::Symbol;
18 use rustc_span::{BytePos, FileName, Pos, Span, DUMMY_SP};
19 use rustc_target::spec::TargetTriple;
20 use tempfile::Builder as TempFileBuilder;
21
22 use std::env;
23 use std::io::{self, Write};
24 use std::panic;
25 use std::path::PathBuf;
26 use std::process::{self, Command, Stdio};
27 use std::str;
28 use std::sync::atomic::{AtomicUsize, Ordering};
29 use std::sync::{Arc, Mutex};
30
31 use crate::clean::{types::AttributesExt, Attributes};
32 use crate::config::Options;
33 use crate::html::markdown::{self, ErrorCodes, Ignore, LangString};
34 use crate::lint::init_lints;
35 use crate::passes::span_of_attrs;
36
37 #[derive(Clone, Default)]
38 crate struct TestOptions {
39 /// Whether to disable the default `extern crate my_crate;` when creating doctests.
40 crate no_crate_inject: bool,
41 /// Additional crate-level attributes to add to doctests.
42 crate attrs: Vec<String>,
43 }
44
run(options: Options) -> Result<(), ErrorReported>45 crate fn run(options: Options) -> Result<(), ErrorReported> {
46 let input = config::Input::File(options.input.clone());
47
48 let invalid_codeblock_attributes_name = crate::lint::INVALID_CODEBLOCK_ATTRIBUTES.name;
49
50 // See core::create_config for what's going on here.
51 let allowed_lints = vec![
52 invalid_codeblock_attributes_name.to_owned(),
53 lint::builtin::UNKNOWN_LINTS.name.to_owned(),
54 lint::builtin::RENAMED_AND_REMOVED_LINTS.name.to_owned(),
55 ];
56
57 let (lint_opts, lint_caps) = init_lints(allowed_lints, options.lint_opts.clone(), |lint| {
58 if lint.name == invalid_codeblock_attributes_name {
59 None
60 } else {
61 Some((lint.name_lower(), lint::Allow))
62 }
63 });
64
65 debug!(?lint_opts);
66
67 let crate_types =
68 if options.proc_macro_crate { vec![CrateType::ProcMacro] } else { vec![CrateType::Rlib] };
69
70 let sessopts = config::Options {
71 maybe_sysroot: options.maybe_sysroot.clone(),
72 search_paths: options.libs.clone(),
73 crate_types,
74 lint_opts,
75 lint_cap: Some(options.lint_cap.unwrap_or(lint::Forbid)),
76 cg: options.codegen_options.clone(),
77 externs: options.externs.clone(),
78 unstable_features: options.render_options.unstable_features,
79 actually_rustdoc: true,
80 edition: options.edition,
81 target_triple: options.target.clone(),
82 crate_name: options.crate_name.clone(),
83 ..config::Options::default()
84 };
85
86 let mut cfgs = options.cfgs.clone();
87 cfgs.push("doc".to_owned());
88 cfgs.push("doctest".to_owned());
89 let config = interface::Config {
90 opts: sessopts,
91 crate_cfg: interface::parse_cfgspecs(cfgs),
92 input,
93 input_path: None,
94 output_file: None,
95 output_dir: None,
96 file_loader: None,
97 diagnostic_output: DiagnosticOutput::Default,
98 stderr: None,
99 lint_caps,
100 parse_sess_created: None,
101 register_lints: Some(box crate::lint::register_lints),
102 override_queries: None,
103 make_codegen_backend: None,
104 registry: rustc_driver::diagnostics_registry(),
105 };
106
107 let test_args = options.test_args.clone();
108 let nocapture = options.nocapture;
109 let externs = options.externs.clone();
110 let json_unused_externs = options.json_unused_externs;
111
112 let res = interface::run_compiler(config, |compiler| {
113 compiler.enter(|queries| {
114 let mut global_ctxt = queries.global_ctxt()?.take();
115
116 let collector = global_ctxt.enter(|tcx| {
117 let crate_attrs = tcx.hir().attrs(CRATE_HIR_ID);
118
119 let opts = scrape_test_config(crate_attrs);
120 let enable_per_target_ignores = options.enable_per_target_ignores;
121 let mut collector = Collector::new(
122 tcx.crate_name(LOCAL_CRATE),
123 options,
124 false,
125 opts,
126 Some(compiler.session().parse_sess.clone_source_map()),
127 None,
128 enable_per_target_ignores,
129 );
130
131 let mut hir_collector = HirCollector {
132 sess: compiler.session(),
133 collector: &mut collector,
134 map: tcx.hir(),
135 codes: ErrorCodes::from(
136 compiler.session().opts.unstable_features.is_nightly_build(),
137 ),
138 tcx,
139 };
140 hir_collector.visit_testable(
141 "".to_string(),
142 CRATE_HIR_ID,
143 tcx.hir().span(CRATE_HIR_ID),
144 |this| tcx.hir().walk_toplevel_module(this),
145 );
146
147 collector
148 });
149 if compiler.session().diagnostic().has_errors_or_lint_errors() {
150 FatalError.raise();
151 }
152
153 let unused_extern_reports = collector.unused_extern_reports.clone();
154 let compiling_test_count = collector.compiling_test_count.load(Ordering::SeqCst);
155 let ret: Result<_, ErrorReported> =
156 Ok((collector.tests, unused_extern_reports, compiling_test_count));
157 ret
158 })
159 });
160 let (tests, unused_extern_reports, compiling_test_count) = match res {
161 Ok(res) => res,
162 Err(ErrorReported) => return Err(ErrorReported),
163 };
164
165 run_tests(test_args, nocapture, tests);
166
167 // Collect and warn about unused externs, but only if we've gotten
168 // reports for each doctest
169 if json_unused_externs {
170 let unused_extern_reports: Vec<_> =
171 std::mem::take(&mut unused_extern_reports.lock().unwrap());
172 if unused_extern_reports.len() == compiling_test_count {
173 let extern_names = externs.iter().map(|(name, _)| name).collect::<FxHashSet<&String>>();
174 let mut unused_extern_names = unused_extern_reports
175 .iter()
176 .map(|uexts| uexts.unused_extern_names.iter().collect::<FxHashSet<&String>>())
177 .fold(extern_names, |uextsa, uextsb| {
178 uextsa.intersection(&uextsb).copied().collect::<FxHashSet<&String>>()
179 })
180 .iter()
181 .map(|v| (*v).clone())
182 .collect::<Vec<String>>();
183 unused_extern_names.sort();
184 // Take the most severe lint level
185 let lint_level = unused_extern_reports
186 .iter()
187 .map(|uexts| uexts.lint_level.as_str())
188 .max_by_key(|v| match *v {
189 "warn" => 1,
190 "deny" => 2,
191 "forbid" => 3,
192 // The allow lint level is not expected,
193 // as if allow is specified, no message
194 // is to be emitted.
195 v => unreachable!("Invalid lint level '{}'", v),
196 })
197 .unwrap_or("warn")
198 .to_string();
199 let uext = UnusedExterns { lint_level, unused_extern_names };
200 let unused_extern_json = serde_json::to_string(&uext).unwrap();
201 eprintln!("{}", unused_extern_json);
202 }
203 }
204
205 Ok(())
206 }
207
run_tests(mut test_args: Vec<String>, nocapture: bool, tests: Vec<test::TestDescAndFn>)208 crate fn run_tests(mut test_args: Vec<String>, nocapture: bool, tests: Vec<test::TestDescAndFn>) {
209 test_args.insert(0, "rustdoctest".to_string());
210 if nocapture {
211 test_args.push("--nocapture".to_string());
212 }
213 test::test_main(&test_args, tests, None);
214 }
215
216 // Look for `#![doc(test(no_crate_inject))]`, used by crates in the std facade.
scrape_test_config(attrs: &[ast::Attribute]) -> TestOptions217 fn scrape_test_config(attrs: &[ast::Attribute]) -> TestOptions {
218 use rustc_ast_pretty::pprust;
219
220 let mut opts = TestOptions { no_crate_inject: false, attrs: Vec::new() };
221
222 let test_attrs: Vec<_> = attrs
223 .iter()
224 .filter(|a| a.has_name(sym::doc))
225 .flat_map(|a| a.meta_item_list().unwrap_or_else(Vec::new))
226 .filter(|a| a.has_name(sym::test))
227 .collect();
228 let attrs = test_attrs.iter().flat_map(|a| a.meta_item_list().unwrap_or(&[]));
229
230 for attr in attrs {
231 if attr.has_name(sym::no_crate_inject) {
232 opts.no_crate_inject = true;
233 }
234 if attr.has_name(sym::attr) {
235 if let Some(l) = attr.meta_item_list() {
236 for item in l {
237 opts.attrs.push(pprust::meta_list_item_to_string(item));
238 }
239 }
240 }
241 }
242
243 opts
244 }
245
246 /// Documentation test failure modes.
247 enum TestFailure {
248 /// The test failed to compile.
249 CompileError,
250 /// The test is marked `compile_fail` but compiled successfully.
251 UnexpectedCompilePass,
252 /// The test failed to compile (as expected) but the compiler output did not contain all
253 /// expected error codes.
254 MissingErrorCodes(Vec<String>),
255 /// The test binary was unable to be executed.
256 ExecutionError(io::Error),
257 /// The test binary exited with a non-zero exit code.
258 ///
259 /// This typically means an assertion in the test failed or another form of panic occurred.
260 ExecutionFailure(process::Output),
261 /// The test is marked `should_panic` but the test binary executed successfully.
262 UnexpectedRunPass,
263 }
264
265 enum DirState {
266 Temp(tempfile::TempDir),
267 Perm(PathBuf),
268 }
269
270 impl DirState {
path(&self) -> &std::path::Path271 fn path(&self) -> &std::path::Path {
272 match self {
273 DirState::Temp(t) => t.path(),
274 DirState::Perm(p) => p.as_path(),
275 }
276 }
277 }
278
279 // NOTE: Keep this in sync with the equivalent structs in rustc
280 // and cargo.
281 // We could unify this struct the one in rustc but they have different
282 // ownership semantics, so doing so would create wasteful allocations.
283 #[derive(serde::Serialize, serde::Deserialize)]
284 struct UnusedExterns {
285 /// Lint level of the unused_crate_dependencies lint
286 lint_level: String,
287 /// List of unused externs by their names.
288 unused_extern_names: Vec<String>,
289 }
290
run_test( test: &str, crate_name: &str, line: usize, options: Options, should_panic: bool, no_run: bool, as_test_harness: bool, runtool: Option<String>, runtool_args: Vec<String>, target: TargetTriple, compile_fail: bool, mut error_codes: Vec<String>, opts: &TestOptions, edition: Edition, outdir: DirState, path: PathBuf, test_id: &str, report_unused_externs: impl Fn(UnusedExterns), ) -> Result<(), TestFailure>291 fn run_test(
292 test: &str,
293 crate_name: &str,
294 line: usize,
295 options: Options,
296 should_panic: bool,
297 no_run: bool,
298 as_test_harness: bool,
299 runtool: Option<String>,
300 runtool_args: Vec<String>,
301 target: TargetTriple,
302 compile_fail: bool,
303 mut error_codes: Vec<String>,
304 opts: &TestOptions,
305 edition: Edition,
306 outdir: DirState,
307 path: PathBuf,
308 test_id: &str,
309 report_unused_externs: impl Fn(UnusedExterns),
310 ) -> Result<(), TestFailure> {
311 let (test, line_offset, supports_color) =
312 make_test(test, Some(crate_name), as_test_harness, opts, edition, Some(test_id));
313
314 let output_file = outdir.path().join("rust_out");
315
316 let rustc_binary = options
317 .test_builder
318 .as_deref()
319 .unwrap_or_else(|| rustc_interface::util::rustc_path().expect("found rustc"));
320 let mut compiler = Command::new(&rustc_binary);
321 compiler.arg("--crate-type").arg("bin");
322 for cfg in &options.cfgs {
323 compiler.arg("--cfg").arg(&cfg);
324 }
325 if let Some(sysroot) = options.maybe_sysroot {
326 compiler.arg("--sysroot").arg(sysroot);
327 }
328 compiler.arg("--edition").arg(&edition.to_string());
329 compiler.env("UNSTABLE_RUSTDOC_TEST_PATH", path);
330 compiler.env("UNSTABLE_RUSTDOC_TEST_LINE", format!("{}", line as isize - line_offset as isize));
331 compiler.arg("-o").arg(&output_file);
332 if as_test_harness {
333 compiler.arg("--test");
334 }
335 if options.json_unused_externs && !compile_fail {
336 compiler.arg("--error-format=json");
337 compiler.arg("--json").arg("unused-externs");
338 compiler.arg("-Z").arg("unstable-options");
339 compiler.arg("-W").arg("unused_crate_dependencies");
340 }
341 for lib_str in &options.lib_strs {
342 compiler.arg("-L").arg(&lib_str);
343 }
344 for extern_str in &options.extern_strs {
345 compiler.arg("--extern").arg(&extern_str);
346 }
347 compiler.arg("-Ccodegen-units=1");
348 for codegen_options_str in &options.codegen_options_strs {
349 compiler.arg("-C").arg(&codegen_options_str);
350 }
351 for debugging_option_str in &options.debugging_opts_strs {
352 compiler.arg("-Z").arg(&debugging_option_str);
353 }
354 if no_run && !compile_fail && options.persist_doctests.is_none() {
355 compiler.arg("--emit=metadata");
356 }
357 compiler.arg("--target").arg(match target {
358 TargetTriple::TargetTriple(s) => s,
359 TargetTriple::TargetPath(path) => {
360 path.to_str().expect("target path must be valid unicode").to_string()
361 }
362 });
363 if let ErrorOutputType::HumanReadable(kind) = options.error_format {
364 let (short, color_config) = kind.unzip();
365
366 if short {
367 compiler.arg("--error-format").arg("short");
368 }
369
370 match color_config {
371 ColorConfig::Never => {
372 compiler.arg("--color").arg("never");
373 }
374 ColorConfig::Always => {
375 compiler.arg("--color").arg("always");
376 }
377 ColorConfig::Auto => {
378 compiler.arg("--color").arg(if supports_color { "always" } else { "never" });
379 }
380 }
381 }
382
383 compiler.arg("-");
384 compiler.stdin(Stdio::piped());
385 compiler.stderr(Stdio::piped());
386
387 let mut child = compiler.spawn().expect("Failed to spawn rustc process");
388 {
389 let stdin = child.stdin.as_mut().expect("Failed to open stdin");
390 stdin.write_all(test.as_bytes()).expect("could write out test sources");
391 }
392 let output = child.wait_with_output().expect("Failed to read stdout");
393
394 struct Bomb<'a>(&'a str);
395 impl Drop for Bomb<'_> {
396 fn drop(&mut self) {
397 eprint!("{}", self.0);
398 }
399 }
400 let mut out_lines = str::from_utf8(&output.stderr)
401 .unwrap()
402 .lines()
403 .filter(|l| {
404 if let Ok(uext) = serde_json::from_str::<UnusedExterns>(l) {
405 report_unused_externs(uext);
406 false
407 } else {
408 true
409 }
410 })
411 .collect::<Vec<_>>();
412
413 // Add a \n to the end to properly terminate the last line,
414 // but only if there was output to be printed
415 if !out_lines.is_empty() {
416 out_lines.push("");
417 }
418
419 let out = out_lines.join("\n");
420 let _bomb = Bomb(&out);
421 match (output.status.success(), compile_fail) {
422 (true, true) => {
423 return Err(TestFailure::UnexpectedCompilePass);
424 }
425 (true, false) => {}
426 (false, true) => {
427 if !error_codes.is_empty() {
428 // We used to check if the output contained "error[{}]: " but since we added the
429 // colored output, we can't anymore because of the color escape characters before
430 // the ":".
431 error_codes.retain(|err| !out.contains(&format!("error[{}]", err)));
432
433 if !error_codes.is_empty() {
434 return Err(TestFailure::MissingErrorCodes(error_codes));
435 }
436 }
437 }
438 (false, false) => {
439 return Err(TestFailure::CompileError);
440 }
441 }
442
443 if no_run {
444 return Ok(());
445 }
446
447 // Run the code!
448 let mut cmd;
449
450 if let Some(tool) = runtool {
451 cmd = Command::new(tool);
452 cmd.args(runtool_args);
453 cmd.arg(output_file);
454 } else {
455 cmd = Command::new(output_file);
456 }
457 if let Some(run_directory) = options.test_run_directory {
458 cmd.current_dir(run_directory);
459 }
460
461 let result = if options.nocapture {
462 cmd.status().map(|status| process::Output {
463 status,
464 stdout: Vec::new(),
465 stderr: Vec::new(),
466 })
467 } else {
468 cmd.output()
469 };
470 match result {
471 Err(e) => return Err(TestFailure::ExecutionError(e)),
472 Ok(out) => {
473 if should_panic && out.status.success() {
474 return Err(TestFailure::UnexpectedRunPass);
475 } else if !should_panic && !out.status.success() {
476 return Err(TestFailure::ExecutionFailure(out));
477 }
478 }
479 }
480
481 Ok(())
482 }
483
484 /// Transforms a test into code that can be compiled into a Rust binary, and returns the number of
485 /// lines before the test code begins as well as if the output stream supports colors or not.
make_test( s: &str, crate_name: Option<&str>, dont_insert_main: bool, opts: &TestOptions, edition: Edition, test_id: Option<&str>, ) -> (String, usize, bool)486 crate fn make_test(
487 s: &str,
488 crate_name: Option<&str>,
489 dont_insert_main: bool,
490 opts: &TestOptions,
491 edition: Edition,
492 test_id: Option<&str>,
493 ) -> (String, usize, bool) {
494 let (crate_attrs, everything_else, crates) = partition_source(s);
495 let everything_else = everything_else.trim();
496 let mut line_offset = 0;
497 let mut prog = String::new();
498 let mut supports_color = false;
499
500 if opts.attrs.is_empty() {
501 // If there aren't any attributes supplied by #![doc(test(attr(...)))], then allow some
502 // lints that are commonly triggered in doctests. The crate-level test attributes are
503 // commonly used to make tests fail in case they trigger warnings, so having this there in
504 // that case may cause some tests to pass when they shouldn't have.
505 prog.push_str("#![allow(unused)]\n");
506 line_offset += 1;
507 }
508
509 // Next, any attributes that came from the crate root via #![doc(test(attr(...)))].
510 for attr in &opts.attrs {
511 prog.push_str(&format!("#![{}]\n", attr));
512 line_offset += 1;
513 }
514
515 // Now push any outer attributes from the example, assuming they
516 // are intended to be crate attributes.
517 prog.push_str(&crate_attrs);
518 prog.push_str(&crates);
519
520 // Uses librustc_ast to parse the doctest and find if there's a main fn and the extern
521 // crate already is included.
522 let result = rustc_driver::catch_fatal_errors(|| {
523 rustc_span::create_session_if_not_set_then(edition, |_| {
524 use rustc_errors::emitter::{Emitter, EmitterWriter};
525 use rustc_errors::Handler;
526 use rustc_parse::maybe_new_parser_from_source_str;
527 use rustc_parse::parser::ForceCollect;
528 use rustc_session::parse::ParseSess;
529 use rustc_span::source_map::FilePathMapping;
530
531 let filename = FileName::anon_source_code(s);
532 let source = crates + everything_else;
533
534 // Any errors in parsing should also appear when the doctest is compiled for real, so just
535 // send all the errors that librustc_ast emits directly into a `Sink` instead of stderr.
536 let sm = Lrc::new(SourceMap::new(FilePathMapping::empty()));
537 supports_color =
538 EmitterWriter::stderr(ColorConfig::Auto, None, false, false, Some(80), false)
539 .supports_color();
540
541 let emitter =
542 EmitterWriter::new(box io::sink(), None, false, false, false, None, false);
543
544 // FIXME(misdreavus): pass `-Z treat-err-as-bug` to the doctest parser
545 let handler = Handler::with_emitter(false, None, box emitter);
546 let sess = ParseSess::with_span_handler(handler, sm);
547
548 let mut found_main = false;
549 let mut found_extern_crate = crate_name.is_none();
550 let mut found_macro = false;
551
552 let mut parser = match maybe_new_parser_from_source_str(&sess, filename, source) {
553 Ok(p) => p,
554 Err(errs) => {
555 for mut err in errs {
556 err.cancel();
557 }
558
559 return (found_main, found_extern_crate, found_macro);
560 }
561 };
562
563 loop {
564 match parser.parse_item(ForceCollect::No) {
565 Ok(Some(item)) => {
566 if !found_main {
567 if let ast::ItemKind::Fn(..) = item.kind {
568 if item.ident.name == sym::main {
569 found_main = true;
570 }
571 }
572 }
573
574 if !found_extern_crate {
575 if let ast::ItemKind::ExternCrate(original) = item.kind {
576 // This code will never be reached if `crate_name` is none because
577 // `found_extern_crate` is initialized to `true` if it is none.
578 let crate_name = crate_name.unwrap();
579
580 match original {
581 Some(name) => found_extern_crate = name.as_str() == crate_name,
582 None => found_extern_crate = item.ident.as_str() == crate_name,
583 }
584 }
585 }
586
587 if !found_macro {
588 if let ast::ItemKind::MacCall(..) = item.kind {
589 found_macro = true;
590 }
591 }
592
593 if found_main && found_extern_crate {
594 break;
595 }
596 }
597 Ok(None) => break,
598 Err(mut e) => {
599 e.cancel();
600 break;
601 }
602 }
603
604 // The supplied slice is only used for diagnostics,
605 // which are swallowed here anyway.
606 parser.maybe_consume_incorrect_semicolon(&[]);
607 }
608
609 // Reset errors so that they won't be reported as compiler bugs when dropping the
610 // handler. Any errors in the tests will be reported when the test file is compiled,
611 // Note that we still need to cancel the errors above otherwise `DiagnosticBuilder`
612 // will panic on drop.
613 sess.span_diagnostic.reset_err_count();
614
615 (found_main, found_extern_crate, found_macro)
616 })
617 });
618 let (already_has_main, already_has_extern_crate, found_macro) = match result {
619 Ok(result) => result,
620 Err(ErrorReported) => {
621 // If the parser panicked due to a fatal error, pass the test code through unchanged.
622 // The error will be reported during compilation.
623 return (s.to_owned(), 0, false);
624 }
625 };
626
627 // If a doctest's `fn main` is being masked by a wrapper macro, the parsing loop above won't
628 // see it. In that case, run the old text-based scan to see if they at least have a main
629 // function written inside a macro invocation. See
630 // https://github.com/rust-lang/rust/issues/56898
631 let already_has_main = if found_macro && !already_has_main {
632 s.lines()
633 .map(|line| {
634 let comment = line.find("//");
635 if let Some(comment_begins) = comment { &line[0..comment_begins] } else { line }
636 })
637 .any(|code| code.contains("fn main"))
638 } else {
639 already_has_main
640 };
641
642 // Don't inject `extern crate std` because it's already injected by the
643 // compiler.
644 if !already_has_extern_crate && !opts.no_crate_inject && crate_name != Some("std") {
645 if let Some(crate_name) = crate_name {
646 // Don't inject `extern crate` if the crate is never used.
647 // NOTE: this is terribly inaccurate because it doesn't actually
648 // parse the source, but only has false positives, not false
649 // negatives.
650 if s.contains(crate_name) {
651 prog.push_str(&format!("extern crate r#{};\n", crate_name));
652 line_offset += 1;
653 }
654 }
655 }
656
657 // FIXME: This code cannot yet handle no_std test cases yet
658 if dont_insert_main || already_has_main || prog.contains("![no_std]") {
659 prog.push_str(everything_else);
660 } else {
661 let returns_result = everything_else.trim_end().ends_with("(())");
662 // Give each doctest main function a unique name.
663 // This is for example needed for the tooling around `-Z instrument-coverage`.
664 let inner_fn_name = if let Some(test_id) = test_id {
665 format!("_doctest_main_{}", test_id)
666 } else {
667 "_inner".into()
668 };
669 let inner_attr = if test_id.is_some() { "#[allow(non_snake_case)] " } else { "" };
670 let (main_pre, main_post) = if returns_result {
671 (
672 format!(
673 "fn main() {{ {}fn {}() -> Result<(), impl core::fmt::Debug> {{\n",
674 inner_attr, inner_fn_name
675 ),
676 format!("\n}} {}().unwrap() }}", inner_fn_name),
677 )
678 } else if test_id.is_some() {
679 (
680 format!("fn main() {{ {}fn {}() {{\n", inner_attr, inner_fn_name),
681 format!("\n}} {}() }}", inner_fn_name),
682 )
683 } else {
684 ("fn main() {\n".into(), "\n}".into())
685 };
686 // Note on newlines: We insert a line/newline *before*, and *after*
687 // the doctest and adjust the `line_offset` accordingly.
688 // In the case of `-Z instrument-coverage`, this means that the generated
689 // inner `main` function spans from the doctest opening codeblock to the
690 // closing one. For example
691 // /// ``` <- start of the inner main
692 // /// <- code under doctest
693 // /// ``` <- end of the inner main
694 line_offset += 1;
695
696 prog.extend([&main_pre, everything_else, &main_post].iter().cloned());
697 }
698
699 debug!("final doctest:\n{}", prog);
700
701 (prog, line_offset, supports_color)
702 }
703
704 // FIXME(aburka): use a real parser to deal with multiline attributes
partition_source(s: &str) -> (String, String, String)705 fn partition_source(s: &str) -> (String, String, String) {
706 #[derive(Copy, Clone, PartialEq)]
707 enum PartitionState {
708 Attrs,
709 Crates,
710 Other,
711 }
712 let mut state = PartitionState::Attrs;
713 let mut before = String::new();
714 let mut crates = String::new();
715 let mut after = String::new();
716
717 for line in s.lines() {
718 let trimline = line.trim();
719
720 // FIXME(misdreavus): if a doc comment is placed on an extern crate statement, it will be
721 // shunted into "everything else"
722 match state {
723 PartitionState::Attrs => {
724 state = if trimline.starts_with("#![")
725 || trimline.chars().all(|c| c.is_whitespace())
726 || (trimline.starts_with("//") && !trimline.starts_with("///"))
727 {
728 PartitionState::Attrs
729 } else if trimline.starts_with("extern crate")
730 || trimline.starts_with("#[macro_use] extern crate")
731 {
732 PartitionState::Crates
733 } else {
734 PartitionState::Other
735 };
736 }
737 PartitionState::Crates => {
738 state = if trimline.starts_with("extern crate")
739 || trimline.starts_with("#[macro_use] extern crate")
740 || trimline.chars().all(|c| c.is_whitespace())
741 || (trimline.starts_with("//") && !trimline.starts_with("///"))
742 {
743 PartitionState::Crates
744 } else {
745 PartitionState::Other
746 };
747 }
748 PartitionState::Other => {}
749 }
750
751 match state {
752 PartitionState::Attrs => {
753 before.push_str(line);
754 before.push('\n');
755 }
756 PartitionState::Crates => {
757 crates.push_str(line);
758 crates.push('\n');
759 }
760 PartitionState::Other => {
761 after.push_str(line);
762 after.push('\n');
763 }
764 }
765 }
766
767 debug!("before:\n{}", before);
768 debug!("crates:\n{}", crates);
769 debug!("after:\n{}", after);
770
771 (before, after, crates)
772 }
773
774 crate trait Tester {
add_test(&mut self, test: String, config: LangString, line: usize)775 fn add_test(&mut self, test: String, config: LangString, line: usize);
get_line(&self) -> usize776 fn get_line(&self) -> usize {
777 0
778 }
register_header(&mut self, _name: &str, _level: u32)779 fn register_header(&mut self, _name: &str, _level: u32) {}
780 }
781
782 crate struct Collector {
783 crate tests: Vec<test::TestDescAndFn>,
784
785 // The name of the test displayed to the user, separated by `::`.
786 //
787 // In tests from Rust source, this is the path to the item
788 // e.g., `["std", "vec", "Vec", "push"]`.
789 //
790 // In tests from a markdown file, this is the titles of all headers (h1~h6)
791 // of the sections that contain the code block, e.g., if the markdown file is
792 // written as:
793 //
794 // ``````markdown
795 // # Title
796 //
797 // ## Subtitle
798 //
799 // ```rust
800 // assert!(true);
801 // ```
802 // ``````
803 //
804 // the `names` vector of that test will be `["Title", "Subtitle"]`.
805 names: Vec<String>,
806
807 options: Options,
808 use_headers: bool,
809 enable_per_target_ignores: bool,
810 crate_name: Symbol,
811 opts: TestOptions,
812 position: Span,
813 source_map: Option<Lrc<SourceMap>>,
814 filename: Option<PathBuf>,
815 visited_tests: FxHashMap<(String, usize), usize>,
816 unused_extern_reports: Arc<Mutex<Vec<UnusedExterns>>>,
817 compiling_test_count: AtomicUsize,
818 }
819
820 impl Collector {
new( crate_name: Symbol, options: Options, use_headers: bool, opts: TestOptions, source_map: Option<Lrc<SourceMap>>, filename: Option<PathBuf>, enable_per_target_ignores: bool, ) -> Collector821 crate fn new(
822 crate_name: Symbol,
823 options: Options,
824 use_headers: bool,
825 opts: TestOptions,
826 source_map: Option<Lrc<SourceMap>>,
827 filename: Option<PathBuf>,
828 enable_per_target_ignores: bool,
829 ) -> Collector {
830 Collector {
831 tests: Vec::new(),
832 names: Vec::new(),
833 options,
834 use_headers,
835 enable_per_target_ignores,
836 crate_name,
837 opts,
838 position: DUMMY_SP,
839 source_map,
840 filename,
841 visited_tests: FxHashMap::default(),
842 unused_extern_reports: Default::default(),
843 compiling_test_count: AtomicUsize::new(0),
844 }
845 }
846
generate_name(&self, line: usize, filename: &FileName) -> String847 fn generate_name(&self, line: usize, filename: &FileName) -> String {
848 let mut item_path = self.names.join("::");
849 item_path.retain(|c| c != ' ');
850 if !item_path.is_empty() {
851 item_path.push(' ');
852 }
853 format!("{} - {}(line {})", filename.prefer_local(), item_path, line)
854 }
855
set_position(&mut self, position: Span)856 crate fn set_position(&mut self, position: Span) {
857 self.position = position;
858 }
859
get_filename(&self) -> FileName860 fn get_filename(&self) -> FileName {
861 if let Some(ref source_map) = self.source_map {
862 let filename = source_map.span_to_filename(self.position);
863 if let FileName::Real(ref filename) = filename {
864 if let Ok(cur_dir) = env::current_dir() {
865 if let Some(local_path) = filename.local_path() {
866 if let Ok(path) = local_path.strip_prefix(&cur_dir) {
867 return path.to_owned().into();
868 }
869 }
870 }
871 }
872 filename
873 } else if let Some(ref filename) = self.filename {
874 filename.clone().into()
875 } else {
876 FileName::Custom("input".to_owned())
877 }
878 }
879 }
880
881 impl Tester for Collector {
add_test(&mut self, test: String, config: LangString, line: usize)882 fn add_test(&mut self, test: String, config: LangString, line: usize) {
883 let filename = self.get_filename();
884 let name = self.generate_name(line, &filename);
885 let crate_name = self.crate_name.to_string();
886 let opts = self.opts.clone();
887 let edition = config.edition.unwrap_or(self.options.edition);
888 let options = self.options.clone();
889 let runtool = self.options.runtool.clone();
890 let runtool_args = self.options.runtool_args.clone();
891 let target = self.options.target.clone();
892 let target_str = target.to_string();
893 let unused_externs = self.unused_extern_reports.clone();
894 let no_run = config.no_run || options.no_run;
895 if !config.compile_fail {
896 self.compiling_test_count.fetch_add(1, Ordering::SeqCst);
897 }
898
899 let path = match &filename {
900 FileName::Real(path) => {
901 if let Some(local_path) = path.local_path() {
902 local_path.to_path_buf()
903 } else {
904 // Somehow we got the filename from the metadata of another crate, should never happen
905 unreachable!("doctest from a different crate");
906 }
907 }
908 _ => PathBuf::from(r"doctest.rs"),
909 };
910
911 // For example `module/file.rs` would become `module_file_rs`
912 let file = filename
913 .prefer_local()
914 .to_string_lossy()
915 .chars()
916 .map(|c| if c.is_ascii_alphanumeric() { c } else { '_' })
917 .collect::<String>();
918 let test_id = format!(
919 "{file}_{line}_{number}",
920 file = file,
921 line = line,
922 number = {
923 // Increases the current test number, if this file already
924 // exists or it creates a new entry with a test number of 0.
925 self.visited_tests.entry((file.clone(), line)).and_modify(|v| *v += 1).or_insert(0)
926 },
927 );
928 let outdir = if let Some(mut path) = options.persist_doctests.clone() {
929 path.push(&test_id);
930
931 std::fs::create_dir_all(&path)
932 .expect("Couldn't create directory for doctest executables");
933
934 DirState::Perm(path)
935 } else {
936 DirState::Temp(
937 TempFileBuilder::new()
938 .prefix("rustdoctest")
939 .tempdir()
940 .expect("rustdoc needs a tempdir"),
941 )
942 };
943
944 debug!("creating test {}: {}", name, test);
945 self.tests.push(test::TestDescAndFn {
946 desc: test::TestDesc {
947 name: test::DynTestName(name),
948 ignore: match config.ignore {
949 Ignore::All => true,
950 Ignore::None => false,
951 Ignore::Some(ref ignores) => ignores.iter().any(|s| target_str.contains(s)),
952 },
953 // compiler failures are test failures
954 should_panic: test::ShouldPanic::No,
955 allow_fail: config.allow_fail,
956 compile_fail: config.compile_fail,
957 no_run,
958 test_type: test::TestType::DocTest,
959 },
960 testfn: test::DynTestFn(box move || {
961 let report_unused_externs = |uext| {
962 unused_externs.lock().unwrap().push(uext);
963 };
964 let res = run_test(
965 &test,
966 &crate_name,
967 line,
968 options,
969 config.should_panic,
970 no_run,
971 config.test_harness,
972 runtool,
973 runtool_args,
974 target,
975 config.compile_fail,
976 config.error_codes,
977 &opts,
978 edition,
979 outdir,
980 path,
981 &test_id,
982 report_unused_externs,
983 );
984
985 if let Err(err) = res {
986 match err {
987 TestFailure::CompileError => {
988 eprint!("Couldn't compile the test.");
989 }
990 TestFailure::UnexpectedCompilePass => {
991 eprint!("Test compiled successfully, but it's marked `compile_fail`.");
992 }
993 TestFailure::UnexpectedRunPass => {
994 eprint!("Test executable succeeded, but it's marked `should_panic`.");
995 }
996 TestFailure::MissingErrorCodes(codes) => {
997 eprint!("Some expected error codes were not found: {:?}", codes);
998 }
999 TestFailure::ExecutionError(err) => {
1000 eprint!("Couldn't run the test: {}", err);
1001 if err.kind() == io::ErrorKind::PermissionDenied {
1002 eprint!(" - maybe your tempdir is mounted with noexec?");
1003 }
1004 }
1005 TestFailure::ExecutionFailure(out) => {
1006 let reason = if let Some(code) = out.status.code() {
1007 format!("exit code {}", code)
1008 } else {
1009 String::from("terminated by signal")
1010 };
1011
1012 eprintln!("Test executable failed ({}).", reason);
1013
1014 // FIXME(#12309): An unfortunate side-effect of capturing the test
1015 // executable's output is that the relative ordering between the test's
1016 // stdout and stderr is lost. However, this is better than the
1017 // alternative: if the test executable inherited the parent's I/O
1018 // handles the output wouldn't be captured at all, even on success.
1019 //
1020 // The ordering could be preserved if the test process' stderr was
1021 // redirected to stdout, but that functionality does not exist in the
1022 // standard library, so it may not be portable enough.
1023 let stdout = str::from_utf8(&out.stdout).unwrap_or_default();
1024 let stderr = str::from_utf8(&out.stderr).unwrap_or_default();
1025
1026 if !stdout.is_empty() || !stderr.is_empty() {
1027 eprintln!();
1028
1029 if !stdout.is_empty() {
1030 eprintln!("stdout:\n{}", stdout);
1031 }
1032
1033 if !stderr.is_empty() {
1034 eprintln!("stderr:\n{}", stderr);
1035 }
1036 }
1037 }
1038 }
1039
1040 panic::resume_unwind(box ());
1041 }
1042 }),
1043 });
1044 }
1045
get_line(&self) -> usize1046 fn get_line(&self) -> usize {
1047 if let Some(ref source_map) = self.source_map {
1048 let line = self.position.lo().to_usize();
1049 let line = source_map.lookup_char_pos(BytePos(line as u32)).line;
1050 if line > 0 { line - 1 } else { line }
1051 } else {
1052 0
1053 }
1054 }
1055
register_header(&mut self, name: &str, level: u32)1056 fn register_header(&mut self, name: &str, level: u32) {
1057 if self.use_headers {
1058 // We use these headings as test names, so it's good if
1059 // they're valid identifiers.
1060 let name = name
1061 .chars()
1062 .enumerate()
1063 .map(|(i, c)| {
1064 if (i == 0 && rustc_lexer::is_id_start(c))
1065 || (i != 0 && rustc_lexer::is_id_continue(c))
1066 {
1067 c
1068 } else {
1069 '_'
1070 }
1071 })
1072 .collect::<String>();
1073
1074 // Here we try to efficiently assemble the header titles into the
1075 // test name in the form of `h1::h2::h3::h4::h5::h6`.
1076 //
1077 // Suppose that originally `self.names` contains `[h1, h2, h3]`...
1078 let level = level as usize;
1079 if level <= self.names.len() {
1080 // ... Consider `level == 2`. All headers in the lower levels
1081 // are irrelevant in this new level. So we should reset
1082 // `self.names` to contain headers until <h2>, and replace that
1083 // slot with the new name: `[h1, name]`.
1084 self.names.truncate(level);
1085 self.names[level - 1] = name;
1086 } else {
1087 // ... On the other hand, consider `level == 5`. This means we
1088 // need to extend `self.names` to contain five headers. We fill
1089 // in the missing level (<h4>) with `_`. Thus `self.names` will
1090 // become `[h1, h2, h3, "_", name]`.
1091 if level - 1 > self.names.len() {
1092 self.names.resize(level - 1, "_".to_owned());
1093 }
1094 self.names.push(name);
1095 }
1096 }
1097 }
1098 }
1099
1100 struct HirCollector<'a, 'hir, 'tcx> {
1101 sess: &'a Session,
1102 collector: &'a mut Collector,
1103 map: Map<'hir>,
1104 codes: ErrorCodes,
1105 tcx: TyCtxt<'tcx>,
1106 }
1107
1108 impl<'a, 'hir, 'tcx> HirCollector<'a, 'hir, 'tcx> {
visit_testable<F: FnOnce(&mut Self)>( &mut self, name: String, hir_id: HirId, sp: Span, nested: F, )1109 fn visit_testable<F: FnOnce(&mut Self)>(
1110 &mut self,
1111 name: String,
1112 hir_id: HirId,
1113 sp: Span,
1114 nested: F,
1115 ) {
1116 let ast_attrs = self.tcx.hir().attrs(hir_id);
1117 let mut attrs = Attributes::from_ast(ast_attrs, None);
1118
1119 if let Some(ref cfg) = ast_attrs.cfg(self.tcx, &FxHashSet::default()) {
1120 if !cfg.matches(&self.sess.parse_sess, Some(self.sess.features_untracked())) {
1121 return;
1122 }
1123 }
1124
1125 let has_name = !name.is_empty();
1126 if has_name {
1127 self.collector.names.push(name);
1128 }
1129
1130 attrs.unindent_doc_comments();
1131 // The collapse-docs pass won't combine sugared/raw doc attributes, or included files with
1132 // anything else, this will combine them for us.
1133 if let Some(doc) = attrs.collapsed_doc_value() {
1134 // Use the outermost invocation, so that doctest names come from where the docs were written.
1135 let span = ast_attrs
1136 .span()
1137 .map(|span| span.ctxt().outer_expn().expansion_cause().unwrap_or(span))
1138 .unwrap_or(DUMMY_SP);
1139 self.collector.set_position(span);
1140 markdown::find_testable_code(
1141 &doc,
1142 self.collector,
1143 self.codes,
1144 self.collector.enable_per_target_ignores,
1145 Some(&crate::html::markdown::ExtraInfo::new(
1146 self.tcx,
1147 hir_id,
1148 span_of_attrs(&attrs).unwrap_or(sp),
1149 )),
1150 );
1151 }
1152
1153 nested(self);
1154
1155 if has_name {
1156 self.collector.names.pop();
1157 }
1158 }
1159 }
1160
1161 impl<'a, 'hir, 'tcx> intravisit::Visitor<'hir> for HirCollector<'a, 'hir, 'tcx> {
1162 type Map = Map<'hir>;
1163
nested_visit_map(&mut self) -> intravisit::NestedVisitorMap<Self::Map>1164 fn nested_visit_map(&mut self) -> intravisit::NestedVisitorMap<Self::Map> {
1165 intravisit::NestedVisitorMap::All(self.map)
1166 }
1167
visit_item(&mut self, item: &'hir hir::Item<'_>)1168 fn visit_item(&mut self, item: &'hir hir::Item<'_>) {
1169 let name = match &item.kind {
1170 hir::ItemKind::Macro(ref macro_def) => {
1171 // FIXME(#88038): Non exported macros have historically not been tested,
1172 // but we really ought to start testing them.
1173 let def_id = item.def_id.to_def_id();
1174 if macro_def.macro_rules && !self.tcx.has_attr(def_id, sym::macro_export) {
1175 intravisit::walk_item(self, item);
1176 return;
1177 }
1178 item.ident.to_string()
1179 }
1180 hir::ItemKind::Impl(impl_) => {
1181 rustc_hir_pretty::id_to_string(&self.map, impl_.self_ty.hir_id)
1182 }
1183 _ => item.ident.to_string(),
1184 };
1185
1186 self.visit_testable(name, item.hir_id(), item.span, |this| {
1187 intravisit::walk_item(this, item);
1188 });
1189 }
1190
visit_trait_item(&mut self, item: &'hir hir::TraitItem<'_>)1191 fn visit_trait_item(&mut self, item: &'hir hir::TraitItem<'_>) {
1192 self.visit_testable(item.ident.to_string(), item.hir_id(), item.span, |this| {
1193 intravisit::walk_trait_item(this, item);
1194 });
1195 }
1196
visit_impl_item(&mut self, item: &'hir hir::ImplItem<'_>)1197 fn visit_impl_item(&mut self, item: &'hir hir::ImplItem<'_>) {
1198 self.visit_testable(item.ident.to_string(), item.hir_id(), item.span, |this| {
1199 intravisit::walk_impl_item(this, item);
1200 });
1201 }
1202
visit_foreign_item(&mut self, item: &'hir hir::ForeignItem<'_>)1203 fn visit_foreign_item(&mut self, item: &'hir hir::ForeignItem<'_>) {
1204 self.visit_testable(item.ident.to_string(), item.hir_id(), item.span, |this| {
1205 intravisit::walk_foreign_item(this, item);
1206 });
1207 }
1208
visit_variant( &mut self, v: &'hir hir::Variant<'_>, g: &'hir hir::Generics<'_>, item_id: hir::HirId, )1209 fn visit_variant(
1210 &mut self,
1211 v: &'hir hir::Variant<'_>,
1212 g: &'hir hir::Generics<'_>,
1213 item_id: hir::HirId,
1214 ) {
1215 self.visit_testable(v.ident.to_string(), v.id, v.span, |this| {
1216 intravisit::walk_variant(this, v, g, item_id);
1217 });
1218 }
1219
visit_field_def(&mut self, f: &'hir hir::FieldDef<'_>)1220 fn visit_field_def(&mut self, f: &'hir hir::FieldDef<'_>) {
1221 self.visit_testable(f.ident.to_string(), f.hir_id, f.span, |this| {
1222 intravisit::walk_field_def(this, f);
1223 });
1224 }
1225 }
1226
1227 #[cfg(test)]
1228 mod tests;
1229