2 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
3 use rustc_data_structures::sync::Lrc;
4 use rustc_errors::{ColorConfig, ErrorGuaranteed, FatalError};
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::hir::nested_filter;
12 use rustc_middle::ty::TyCtxt;
13 use rustc_parse::maybe_new_parser_from_source_str;
14 use rustc_parse::parser::attr::InnerAttrPolicy;
15 use rustc_session::config::{self, CrateType, ErrorOutputType};
16 use rustc_session::parse::ParseSess;
17 use rustc_session::{lint, DiagnosticOutput, Session};
18 use rustc_span::edition::Edition;
19 use rustc_span::source_map::SourceMap;
20 use rustc_span::symbol::sym;
21 use rustc_span::Symbol;
22 use rustc_span::{BytePos, FileName, Pos, Span, DUMMY_SP};
23 use rustc_target::spec::TargetTriple;
24 use tempfile::Builder as TempFileBuilder;
27 use std::io::{self, Write};
29 use std::path::PathBuf;
30 use std::process::{self, Command, Stdio};
32 use std::sync::atomic::{AtomicUsize, Ordering};
33 use std::sync::{Arc, Mutex};
35 use crate::clean::{types::AttributesExt, Attributes};
36 use crate::config::Options as RustdocOptions;
37 use crate::html::markdown::{self, ErrorCodes, Ignore, LangString};
38 use crate::lint::init_lints;
39 use crate::passes::span_of_attrs;
41 /// Options that apply to all doctests in a crate or Markdown file (for `rustdoc foo.md`).
42 #[derive(Clone, Default)]
43 pub(crate) struct GlobalTestOptions {
44 /// Whether to disable the default `extern crate my_crate;` when creating doctests.
45 pub(crate) no_crate_inject: bool,
46 /// Additional crate-level attributes to add to doctests.
47 pub(crate) attrs: Vec<String>,
50 pub(crate) fn run(options: RustdocOptions) -> Result<(), ErrorGuaranteed> {
51 let input = config::Input::File(options.input.clone());
53 let invalid_codeblock_attributes_name = crate::lint::INVALID_CODEBLOCK_ATTRIBUTES.name;
55 // See core::create_config for what's going on here.
56 let allowed_lints = vec![
57 invalid_codeblock_attributes_name.to_owned(),
58 lint::builtin::UNKNOWN_LINTS.name.to_owned(),
59 lint::builtin::RENAMED_AND_REMOVED_LINTS.name.to_owned(),
62 let (lint_opts, lint_caps) = init_lints(allowed_lints, options.lint_opts.clone(), |lint| {
63 if lint.name == invalid_codeblock_attributes_name {
66 Some((lint.name_lower(), lint::Allow))
73 if options.proc_macro_crate { vec![CrateType::ProcMacro] } else { vec![CrateType::Rlib] };
75 let sessopts = config::Options {
76 maybe_sysroot: options.maybe_sysroot.clone(),
77 search_paths: options.libs.clone(),
80 lint_cap: Some(options.lint_cap.unwrap_or(lint::Forbid)),
81 cg: options.codegen_options.clone(),
82 externs: options.externs.clone(),
83 unstable_features: options.render_options.unstable_features,
84 actually_rustdoc: true,
85 edition: options.edition,
86 target_triple: options.target.clone(),
87 crate_name: options.crate_name.clone(),
88 ..config::Options::default()
91 let mut cfgs = options.cfgs.clone();
92 cfgs.push("doc".to_owned());
93 cfgs.push("doctest".to_owned());
94 let config = interface::Config {
96 crate_cfg: interface::parse_cfgspecs(cfgs),
97 crate_check_cfg: interface::parse_check_cfg(options.check_cfgs.clone()),
103 diagnostic_output: DiagnosticOutput::Default,
105 parse_sess_created: None,
106 register_lints: Some(Box::new(crate::lint::register_lints)),
107 override_queries: None,
108 make_codegen_backend: None,
109 registry: rustc_driver::diagnostics_registry(),
112 let test_args = options.test_args.clone();
113 let nocapture = options.nocapture;
114 let externs = options.externs.clone();
115 let json_unused_externs = options.json_unused_externs;
117 let (tests, unused_extern_reports, compiling_test_count) =
118 interface::run_compiler(config, |compiler| {
119 compiler.enter(|queries| {
120 let mut global_ctxt = queries.global_ctxt()?.take();
122 let collector = global_ctxt.enter(|tcx| {
123 let crate_attrs = tcx.hir().attrs(CRATE_HIR_ID);
125 let opts = scrape_test_config(crate_attrs);
126 let enable_per_target_ignores = options.enable_per_target_ignores;
127 let mut collector = Collector::new(
128 tcx.crate_name(LOCAL_CRATE),
132 Some(compiler.session().parse_sess.clone_source_map()),
134 enable_per_target_ignores,
137 let mut hir_collector = HirCollector {
138 sess: compiler.session(),
139 collector: &mut collector,
141 codes: ErrorCodes::from(
142 compiler.session().opts.unstable_features.is_nightly_build(),
146 hir_collector.visit_testable(
149 tcx.hir().span(CRATE_HIR_ID),
150 |this| tcx.hir().walk_toplevel_module(this),
155 if compiler.session().diagnostic().has_errors_or_lint_errors().is_some() {
159 let unused_extern_reports = collector.unused_extern_reports.clone();
160 let compiling_test_count = collector.compiling_test_count.load(Ordering::SeqCst);
161 let ret: Result<_, ErrorGuaranteed> =
162 Ok((collector.tests, unused_extern_reports, compiling_test_count));
167 run_tests(test_args, nocapture, tests);
169 // Collect and warn about unused externs, but only if we've gotten
170 // reports for each doctest
171 if json_unused_externs.is_enabled() {
172 let unused_extern_reports: Vec<_> =
173 std::mem::take(&mut unused_extern_reports.lock().unwrap());
174 if unused_extern_reports.len() == compiling_test_count {
175 let extern_names = externs.iter().map(|(name, _)| name).collect::<FxHashSet<&String>>();
176 let mut unused_extern_names = unused_extern_reports
178 .map(|uexts| uexts.unused_extern_names.iter().collect::<FxHashSet<&String>>())
179 .fold(extern_names, |uextsa, uextsb| {
180 uextsa.intersection(&uextsb).copied().collect::<FxHashSet<&String>>()
183 .map(|v| (*v).clone())
184 .collect::<Vec<String>>();
185 unused_extern_names.sort();
186 // Take the most severe lint level
187 let lint_level = unused_extern_reports
189 .map(|uexts| uexts.lint_level.as_str())
190 .max_by_key(|v| match *v {
194 // The allow lint level is not expected,
195 // as if allow is specified, no message
197 v => unreachable!("Invalid lint level '{}'", v),
201 let uext = UnusedExterns { lint_level, unused_extern_names };
202 let unused_extern_json = serde_json::to_string(&uext).unwrap();
203 eprintln!("{unused_extern_json}");
210 pub(crate) fn run_tests(
211 mut test_args: Vec<String>,
213 tests: Vec<test::TestDescAndFn>,
215 test_args.insert(0, "rustdoctest".to_string());
217 test_args.push("--nocapture".to_string());
219 test::test_main(&test_args, tests, None);
222 // Look for `#![doc(test(no_crate_inject))]`, used by crates in the std facade.
223 fn scrape_test_config(attrs: &[ast::Attribute]) -> GlobalTestOptions {
224 use rustc_ast_pretty::pprust;
226 let mut opts = GlobalTestOptions { no_crate_inject: false, attrs: Vec::new() };
228 let test_attrs: Vec<_> = attrs
230 .filter(|a| a.has_name(sym::doc))
231 .flat_map(|a| a.meta_item_list().unwrap_or_default())
232 .filter(|a| a.has_name(sym::test))
234 let attrs = test_attrs.iter().flat_map(|a| a.meta_item_list().unwrap_or(&[]));
237 if attr.has_name(sym::no_crate_inject) {
238 opts.no_crate_inject = true;
240 if attr.has_name(sym::attr) {
241 if let Some(l) = attr.meta_item_list() {
243 opts.attrs.push(pprust::meta_list_item_to_string(item));
252 /// Documentation test failure modes.
254 /// The test failed to compile.
256 /// The test is marked `compile_fail` but compiled successfully.
257 UnexpectedCompilePass,
258 /// The test failed to compile (as expected) but the compiler output did not contain all
259 /// expected error codes.
260 MissingErrorCodes(Vec<String>),
261 /// The test binary was unable to be executed.
262 ExecutionError(io::Error),
263 /// The test binary exited with a non-zero exit code.
265 /// This typically means an assertion in the test failed or another form of panic occurred.
266 ExecutionFailure(process::Output),
267 /// The test is marked `should_panic` but the test binary executed successfully.
272 Temp(tempfile::TempDir),
277 fn path(&self) -> &std::path::Path {
279 DirState::Temp(t) => t.path(),
280 DirState::Perm(p) => p.as_path(),
285 // NOTE: Keep this in sync with the equivalent structs in rustc
287 // We could unify this struct the one in rustc but they have different
288 // ownership semantics, so doing so would create wasteful allocations.
289 #[derive(serde::Serialize, serde::Deserialize)]
290 struct UnusedExterns {
291 /// Lint level of the unused_crate_dependencies lint
293 /// List of unused externs by their names.
294 unused_extern_names: Vec<String>,
301 rustdoc_options: RustdocOptions,
302 mut lang_string: LangString,
304 runtool: Option<String>,
305 runtool_args: Vec<String>,
306 target: TargetTriple,
307 opts: &GlobalTestOptions,
312 report_unused_externs: impl Fn(UnusedExterns),
313 ) -> Result<(), TestFailure> {
314 let (test, line_offset, supports_color) =
315 make_test(test, Some(crate_name), lang_string.test_harness, opts, edition, Some(test_id));
317 let output_file = outdir.path().join("rust_out");
319 let rustc_binary = rustdoc_options
322 .unwrap_or_else(|| rustc_interface::util::rustc_path().expect("found rustc"));
323 let mut compiler = Command::new(&rustc_binary);
324 compiler.arg("--crate-type").arg("bin");
325 for cfg in &rustdoc_options.cfgs {
326 compiler.arg("--cfg").arg(&cfg);
328 if !rustdoc_options.check_cfgs.is_empty() {
329 compiler.arg("-Z").arg("unstable-options");
330 for check_cfg in &rustdoc_options.check_cfgs {
331 compiler.arg("--check-cfg").arg(&check_cfg);
334 if let Some(sysroot) = rustdoc_options.maybe_sysroot {
335 compiler.arg("--sysroot").arg(sysroot);
337 compiler.arg("--edition").arg(&edition.to_string());
338 compiler.env("UNSTABLE_RUSTDOC_TEST_PATH", path);
339 compiler.env("UNSTABLE_RUSTDOC_TEST_LINE", format!("{}", line as isize - line_offset as isize));
340 compiler.arg("-o").arg(&output_file);
341 if lang_string.test_harness {
342 compiler.arg("--test");
344 if rustdoc_options.json_unused_externs.is_enabled() && !lang_string.compile_fail {
345 compiler.arg("--error-format=json");
346 compiler.arg("--json").arg("unused-externs");
347 compiler.arg("-Z").arg("unstable-options");
348 compiler.arg("-W").arg("unused_crate_dependencies");
350 for lib_str in &rustdoc_options.lib_strs {
351 compiler.arg("-L").arg(&lib_str);
353 for extern_str in &rustdoc_options.extern_strs {
354 compiler.arg("--extern").arg(&extern_str);
356 compiler.arg("-Ccodegen-units=1");
357 for codegen_options_str in &rustdoc_options.codegen_options_strs {
358 compiler.arg("-C").arg(&codegen_options_str);
360 for unstable_option_str in &rustdoc_options.unstable_opts_strs {
361 compiler.arg("-Z").arg(&unstable_option_str);
363 if no_run && !lang_string.compile_fail && rustdoc_options.persist_doctests.is_none() {
364 compiler.arg("--emit=metadata");
366 compiler.arg("--target").arg(match target {
367 TargetTriple::TargetTriple(s) => s,
368 TargetTriple::TargetJson { path_for_rustdoc, .. } => {
369 path_for_rustdoc.to_str().expect("target path must be valid unicode").to_string()
372 if let ErrorOutputType::HumanReadable(kind) = rustdoc_options.error_format {
373 let (short, color_config) = kind.unzip();
376 compiler.arg("--error-format").arg("short");
380 ColorConfig::Never => {
381 compiler.arg("--color").arg("never");
383 ColorConfig::Always => {
384 compiler.arg("--color").arg("always");
386 ColorConfig::Auto => {
387 compiler.arg("--color").arg(if supports_color { "always" } else { "never" });
393 compiler.stdin(Stdio::piped());
394 compiler.stderr(Stdio::piped());
396 let mut child = compiler.spawn().expect("Failed to spawn rustc process");
398 let stdin = child.stdin.as_mut().expect("Failed to open stdin");
399 stdin.write_all(test.as_bytes()).expect("could write out test sources");
401 let output = child.wait_with_output().expect("Failed to read stdout");
403 struct Bomb<'a>(&'a str);
404 impl Drop for Bomb<'_> {
406 eprint!("{}", self.0);
409 let mut out = str::from_utf8(&output.stderr)
413 if let Ok(uext) = serde_json::from_str::<UnusedExterns>(l) {
414 report_unused_externs(uext);
420 .intersperse_with(|| "\n")
421 .collect::<String>();
423 // Add a \n to the end to properly terminate the last line,
424 // but only if there was output to be printed
429 let _bomb = Bomb(&out);
430 match (output.status.success(), lang_string.compile_fail) {
432 return Err(TestFailure::UnexpectedCompilePass);
436 if !lang_string.error_codes.is_empty() {
437 // We used to check if the output contained "error[{}]: " but since we added the
438 // colored output, we can't anymore because of the color escape characters before
440 lang_string.error_codes.retain(|err| !out.contains(&format!("error[{err}]")));
442 if !lang_string.error_codes.is_empty() {
443 return Err(TestFailure::MissingErrorCodes(lang_string.error_codes));
448 return Err(TestFailure::CompileError);
459 if let Some(tool) = runtool {
460 cmd = Command::new(tool);
461 cmd.args(runtool_args);
462 cmd.arg(output_file);
464 cmd = Command::new(output_file);
466 if let Some(run_directory) = rustdoc_options.test_run_directory {
467 cmd.current_dir(run_directory);
470 let result = if rustdoc_options.nocapture {
471 cmd.status().map(|status| process::Output {
480 Err(e) => return Err(TestFailure::ExecutionError(e)),
482 if lang_string.should_panic && out.status.success() {
483 return Err(TestFailure::UnexpectedRunPass);
484 } else if !lang_string.should_panic && !out.status.success() {
485 return Err(TestFailure::ExecutionFailure(out));
493 /// Transforms a test into code that can be compiled into a Rust binary, and returns the number of
494 /// lines before the test code begins as well as if the output stream supports colors or not.
495 pub(crate) fn make_test(
497 crate_name: Option<&str>,
498 dont_insert_main: bool,
499 opts: &GlobalTestOptions,
501 test_id: Option<&str>,
502 ) -> (String, usize, bool) {
503 let (crate_attrs, everything_else, crates) = partition_source(s, edition);
504 let everything_else = everything_else.trim();
505 let mut line_offset = 0;
506 let mut prog = String::new();
507 let mut supports_color = false;
509 if opts.attrs.is_empty() {
510 // If there aren't any attributes supplied by #![doc(test(attr(...)))], then allow some
511 // lints that are commonly triggered in doctests. The crate-level test attributes are
512 // commonly used to make tests fail in case they trigger warnings, so having this there in
513 // that case may cause some tests to pass when they shouldn't have.
514 prog.push_str("#![allow(unused)]\n");
518 // Next, any attributes that came from the crate root via #![doc(test(attr(...)))].
519 for attr in &opts.attrs {
520 prog.push_str(&format!("#![{attr}]\n"));
524 // Now push any outer attributes from the example, assuming they
525 // are intended to be crate attributes.
526 prog.push_str(&crate_attrs);
527 prog.push_str(&crates);
529 // Uses librustc_ast to parse the doctest and find if there's a main fn and the extern
530 // crate already is included.
531 let result = rustc_driver::catch_fatal_errors(|| {
532 rustc_span::create_session_if_not_set_then(edition, |_| {
533 use rustc_errors::emitter::{Emitter, EmitterWriter};
534 use rustc_errors::Handler;
535 use rustc_parse::parser::ForceCollect;
536 use rustc_span::source_map::FilePathMapping;
538 let filename = FileName::anon_source_code(s);
539 let source = crates + everything_else;
541 // Any errors in parsing should also appear when the doctest is compiled for real, so just
542 // send all the errors that librustc_ast emits directly into a `Sink` instead of stderr.
543 let sm = Lrc::new(SourceMap::new(FilePathMapping::empty()));
544 let fallback_bundle =
545 rustc_errors::fallback_fluent_bundle(rustc_errors::DEFAULT_LOCALE_RESOURCES, false);
546 supports_color = EmitterWriter::stderr(
550 fallback_bundle.clone(),
558 let emitter = EmitterWriter::new(
559 Box::new(io::sink()),
570 // FIXME(misdreavus): pass `-Z treat-err-as-bug` to the doctest parser
571 let handler = Handler::with_emitter(false, None, Box::new(emitter));
572 let sess = ParseSess::with_span_handler(handler, sm);
574 let mut found_main = false;
575 let mut found_extern_crate = crate_name.is_none();
576 let mut found_macro = false;
578 let mut parser = match maybe_new_parser_from_source_str(&sess, filename, source) {
582 return (found_main, found_extern_crate, found_macro);
587 match parser.parse_item(ForceCollect::No) {
590 if let ast::ItemKind::Fn(..) = item.kind {
591 if item.ident.name == sym::main {
597 if !found_extern_crate {
598 if let ast::ItemKind::ExternCrate(original) = item.kind {
599 // This code will never be reached if `crate_name` is none because
600 // `found_extern_crate` is initialized to `true` if it is none.
601 let crate_name = crate_name.unwrap();
604 Some(name) => found_extern_crate = name.as_str() == crate_name,
605 None => found_extern_crate = item.ident.as_str() == crate_name,
611 if let ast::ItemKind::MacCall(..) = item.kind {
616 if found_main && found_extern_crate {
627 // The supplied slice is only used for diagnostics,
628 // which are swallowed here anyway.
629 parser.maybe_consume_incorrect_semicolon(&[]);
632 // Reset errors so that they won't be reported as compiler bugs when dropping the
633 // handler. Any errors in the tests will be reported when the test file is compiled,
634 // Note that we still need to cancel the errors above otherwise `DiagnosticBuilder`
635 // will panic on drop.
636 sess.span_diagnostic.reset_err_count();
638 (found_main, found_extern_crate, found_macro)
641 let Ok((already_has_main, already_has_extern_crate, found_macro)) = result
643 // If the parser panicked due to a fatal error, pass the test code through unchanged.
644 // The error will be reported during compilation.
645 return (s.to_owned(), 0, false);
648 // If a doctest's `fn main` is being masked by a wrapper macro, the parsing loop above won't
649 // see it. In that case, run the old text-based scan to see if they at least have a main
650 // function written inside a macro invocation. See
651 // https://github.com/rust-lang/rust/issues/56898
652 let already_has_main = if found_macro && !already_has_main {
655 let comment = line.find("//");
656 if let Some(comment_begins) = comment { &line[0..comment_begins] } else { line }
658 .any(|code| code.contains("fn main"))
663 // Don't inject `extern crate std` because it's already injected by the
665 if !already_has_extern_crate && !opts.no_crate_inject && crate_name != Some("std") {
666 if let Some(crate_name) = crate_name {
667 // Don't inject `extern crate` if the crate is never used.
668 // NOTE: this is terribly inaccurate because it doesn't actually
669 // parse the source, but only has false positives, not false
671 if s.contains(crate_name) {
672 prog.push_str(&format!("extern crate r#{crate_name};\n"));
678 // FIXME: This code cannot yet handle no_std test cases yet
679 if dont_insert_main || already_has_main || prog.contains("![no_std]") {
680 prog.push_str(everything_else);
682 let returns_result = everything_else.trim_end().ends_with("(())");
683 // Give each doctest main function a unique name.
684 // This is for example needed for the tooling around `-C instrument-coverage`.
685 let inner_fn_name = if let Some(test_id) = test_id {
686 format!("_doctest_main_{test_id}")
690 let inner_attr = if test_id.is_some() { "#[allow(non_snake_case)] " } else { "" };
691 let (main_pre, main_post) = if returns_result {
694 "fn main() {{ {inner_attr}fn {inner_fn_name}() -> Result<(), impl core::fmt::Debug> {{\n",
696 format!("\n}} {inner_fn_name}().unwrap() }}"),
698 } else if test_id.is_some() {
700 format!("fn main() {{ {inner_attr}fn {inner_fn_name}() {{\n",),
701 format!("\n}} {inner_fn_name}() }}"),
704 ("fn main() {\n".into(), "\n}".into())
706 // Note on newlines: We insert a line/newline *before*, and *after*
707 // the doctest and adjust the `line_offset` accordingly.
708 // In the case of `-C instrument-coverage`, this means that the generated
709 // inner `main` function spans from the doctest opening codeblock to the
710 // closing one. For example
711 // /// ``` <- start of the inner main
712 // /// <- code under doctest
713 // /// ``` <- end of the inner main
716 prog.extend([&main_pre, everything_else, &main_post].iter().cloned());
719 debug!("final doctest:\n{prog}");
721 (prog, line_offset, supports_color)
724 fn check_if_attr_is_complete(source: &str, edition: Edition) -> bool {
725 if source.is_empty() {
726 // Empty content so nothing to check in here...
729 rustc_driver::catch_fatal_errors(|| {
730 rustc_span::create_session_if_not_set_then(edition, |_| {
731 use rustc_errors::emitter::EmitterWriter;
732 use rustc_errors::Handler;
733 use rustc_span::source_map::FilePathMapping;
735 let filename = FileName::anon_source_code(source);
736 // Any errors in parsing should also appear when the doctest is compiled for real, so just
737 // send all the errors that librustc_ast emits directly into a `Sink` instead of stderr.
738 let sm = Lrc::new(SourceMap::new(FilePathMapping::empty()));
739 let fallback_bundle =
740 rustc_errors::fallback_fluent_bundle(rustc_errors::DEFAULT_LOCALE_RESOURCES, false);
742 let emitter = EmitterWriter::new(
743 Box::new(io::sink()),
754 let handler = Handler::with_emitter(false, None, Box::new(emitter));
755 let sess = ParseSess::with_span_handler(handler, sm);
757 match maybe_new_parser_from_source_str(&sess, filename, source.to_owned()) {
760 debug!("Cannot build a parser to check mod attr so skipping...");
764 // If a parsing error happened, it's very likely that the attribute is incomplete.
765 if let Err(e) = parser.parse_attribute(InnerAttrPolicy::Permitted) {
769 // We now check if there is an unclosed delimiter for the attribute. To do so, we look at
770 // the `unclosed_delims` and see if the opening square bracket was closed.
775 unclosed.unclosed_span.map(|s| s.lo()).unwrap_or(BytePos(0)) != BytePos(2)
783 fn partition_source(s: &str, edition: Edition) -> (String, String, String) {
784 #[derive(Copy, Clone, PartialEq)]
785 enum PartitionState {
790 let mut state = PartitionState::Attrs;
791 let mut before = String::new();
792 let mut crates = String::new();
793 let mut after = String::new();
795 let mut mod_attr_pending = String::new();
797 for line in s.lines() {
798 let trimline = line.trim();
800 // FIXME(misdreavus): if a doc comment is placed on an extern crate statement, it will be
801 // shunted into "everything else"
803 PartitionState::Attrs => {
804 state = if trimline.starts_with("#![") {
805 if !check_if_attr_is_complete(line, edition) {
806 mod_attr_pending = line.to_owned();
808 mod_attr_pending.clear();
810 PartitionState::Attrs
811 } else if trimline.chars().all(|c| c.is_whitespace())
812 || (trimline.starts_with("//") && !trimline.starts_with("///"))
814 PartitionState::Attrs
815 } else if trimline.starts_with("extern crate")
816 || trimline.starts_with("#[macro_use] extern crate")
818 PartitionState::Crates
820 // First we check if the previous attribute was "complete"...
821 if !mod_attr_pending.is_empty() {
822 // If not, then we append the new line into the pending attribute to check
823 // if this time it's complete...
824 mod_attr_pending.push_str(line);
825 if !trimline.is_empty()
826 && check_if_attr_is_complete(&mod_attr_pending, edition)
828 // If it's complete, then we can clear the pending content.
829 mod_attr_pending.clear();
831 // In any case, this is considered as `PartitionState::Attrs` so it's
832 // prepended before rustdoc's inserts.
833 PartitionState::Attrs
835 PartitionState::Other
839 PartitionState::Crates => {
840 state = if trimline.starts_with("extern crate")
841 || trimline.starts_with("#[macro_use] extern crate")
842 || trimline.chars().all(|c| c.is_whitespace())
843 || (trimline.starts_with("//") && !trimline.starts_with("///"))
845 PartitionState::Crates
847 PartitionState::Other
850 PartitionState::Other => {}
854 PartitionState::Attrs => {
855 before.push_str(line);
858 PartitionState::Crates => {
859 crates.push_str(line);
862 PartitionState::Other => {
863 after.push_str(line);
869 debug!("before:\n{before}");
870 debug!("crates:\n{crates}");
871 debug!("after:\n{after}");
873 (before, after, crates)
876 pub(crate) trait Tester {
877 fn add_test(&mut self, test: String, config: LangString, line: usize);
878 fn get_line(&self) -> usize {
881 fn register_header(&mut self, _name: &str, _level: u32) {}
884 pub(crate) struct Collector {
885 pub(crate) tests: Vec<test::TestDescAndFn>,
887 // The name of the test displayed to the user, separated by `::`.
889 // In tests from Rust source, this is the path to the item
890 // e.g., `["std", "vec", "Vec", "push"]`.
892 // In tests from a markdown file, this is the titles of all headers (h1~h6)
893 // of the sections that contain the code block, e.g., if the markdown file is
906 // the `names` vector of that test will be `["Title", "Subtitle"]`.
909 rustdoc_options: RustdocOptions,
911 enable_per_target_ignores: bool,
913 opts: GlobalTestOptions,
915 source_map: Option<Lrc<SourceMap>>,
916 filename: Option<PathBuf>,
917 visited_tests: FxHashMap<(String, usize), usize>,
918 unused_extern_reports: Arc<Mutex<Vec<UnusedExterns>>>,
919 compiling_test_count: AtomicUsize,
925 rustdoc_options: RustdocOptions,
927 opts: GlobalTestOptions,
928 source_map: Option<Lrc<SourceMap>>,
929 filename: Option<PathBuf>,
930 enable_per_target_ignores: bool,
937 enable_per_target_ignores,
943 visited_tests: FxHashMap::default(),
944 unused_extern_reports: Default::default(),
945 compiling_test_count: AtomicUsize::new(0),
949 fn generate_name(&self, line: usize, filename: &FileName) -> String {
950 let mut item_path = self.names.join("::");
951 item_path.retain(|c| c != ' ');
952 if !item_path.is_empty() {
955 format!("{} - {}(line {})", filename.prefer_local(), item_path, line)
958 pub(crate) fn set_position(&mut self, position: Span) {
959 self.position = position;
962 fn get_filename(&self) -> FileName {
963 if let Some(ref source_map) = self.source_map {
964 let filename = source_map.span_to_filename(self.position);
965 if let FileName::Real(ref filename) = filename {
966 if let Ok(cur_dir) = env::current_dir() {
967 if let Some(local_path) = filename.local_path() {
968 if let Ok(path) = local_path.strip_prefix(&cur_dir) {
969 return path.to_owned().into();
975 } else if let Some(ref filename) = self.filename {
976 filename.clone().into()
978 FileName::Custom("input".to_owned())
983 impl Tester for Collector {
984 fn add_test(&mut self, test: String, config: LangString, line: usize) {
985 let filename = self.get_filename();
986 let name = self.generate_name(line, &filename);
987 let crate_name = self.crate_name.to_string();
988 let opts = self.opts.clone();
989 let edition = config.edition.unwrap_or(self.rustdoc_options.edition);
990 let rustdoc_options = self.rustdoc_options.clone();
991 let runtool = self.rustdoc_options.runtool.clone();
992 let runtool_args = self.rustdoc_options.runtool_args.clone();
993 let target = self.rustdoc_options.target.clone();
994 let target_str = target.to_string();
995 let unused_externs = self.unused_extern_reports.clone();
996 let no_run = config.no_run || rustdoc_options.no_run;
997 if !config.compile_fail {
998 self.compiling_test_count.fetch_add(1, Ordering::SeqCst);
1001 let path = match &filename {
1002 FileName::Real(path) => {
1003 if let Some(local_path) = path.local_path() {
1004 local_path.to_path_buf()
1006 // Somehow we got the filename from the metadata of another crate, should never happen
1007 unreachable!("doctest from a different crate");
1010 _ => PathBuf::from(r"doctest.rs"),
1013 // For example `module/file.rs` would become `module_file_rs`
1018 .map(|c| if c.is_ascii_alphanumeric() { c } else { '_' })
1019 .collect::<String>();
1020 let test_id = format!(
1021 "{file}_{line}_{number}",
1025 // Increases the current test number, if this file already
1026 // exists or it creates a new entry with a test number of 0.
1027 self.visited_tests.entry((file.clone(), line)).and_modify(|v| *v += 1).or_insert(0)
1030 let outdir = if let Some(mut path) = rustdoc_options.persist_doctests.clone() {
1031 path.push(&test_id);
1033 if let Err(err) = std::fs::create_dir_all(&path) {
1034 eprintln!("Couldn't create directory for doctest executables: {}", err);
1035 panic::resume_unwind(Box::new(()));
1038 DirState::Perm(path)
1041 TempFileBuilder::new()
1042 .prefix("rustdoctest")
1044 .expect("rustdoc needs a tempdir"),
1048 debug!("creating test {name}: {test}");
1049 self.tests.push(test::TestDescAndFn {
1050 desc: test::TestDesc {
1051 name: test::DynTestName(name),
1052 ignore: match config.ignore {
1053 Ignore::All => true,
1054 Ignore::None => false,
1055 Ignore::Some(ref ignores) => ignores.iter().any(|s| target_str.contains(s)),
1057 ignore_message: None,
1058 // compiler failures are test failures
1059 should_panic: test::ShouldPanic::No,
1060 compile_fail: config.compile_fail,
1062 test_type: test::TestType::DocTest,
1064 testfn: test::DynTestFn(Box::new(move || {
1065 let report_unused_externs = |uext| {
1066 unused_externs.lock().unwrap().push(uext);
1083 report_unused_externs,
1086 if let Err(err) = res {
1088 TestFailure::CompileError => {
1089 eprint!("Couldn't compile the test.");
1091 TestFailure::UnexpectedCompilePass => {
1092 eprint!("Test compiled successfully, but it's marked `compile_fail`.");
1094 TestFailure::UnexpectedRunPass => {
1095 eprint!("Test executable succeeded, but it's marked `should_panic`.");
1097 TestFailure::MissingErrorCodes(codes) => {
1098 eprint!("Some expected error codes were not found: {:?}", codes);
1100 TestFailure::ExecutionError(err) => {
1101 eprint!("Couldn't run the test: {err}");
1102 if err.kind() == io::ErrorKind::PermissionDenied {
1103 eprint!(" - maybe your tempdir is mounted with noexec?");
1106 TestFailure::ExecutionFailure(out) => {
1107 eprintln!("Test executable failed ({reason}).", reason = out.status);
1109 // FIXME(#12309): An unfortunate side-effect of capturing the test
1110 // executable's output is that the relative ordering between the test's
1111 // stdout and stderr is lost. However, this is better than the
1112 // alternative: if the test executable inherited the parent's I/O
1113 // handles the output wouldn't be captured at all, even on success.
1115 // The ordering could be preserved if the test process' stderr was
1116 // redirected to stdout, but that functionality does not exist in the
1117 // standard library, so it may not be portable enough.
1118 let stdout = str::from_utf8(&out.stdout).unwrap_or_default();
1119 let stderr = str::from_utf8(&out.stderr).unwrap_or_default();
1121 if !stdout.is_empty() || !stderr.is_empty() {
1124 if !stdout.is_empty() {
1125 eprintln!("stdout:\n{stdout}");
1128 if !stderr.is_empty() {
1129 eprintln!("stderr:\n{stderr}");
1135 panic::resume_unwind(Box::new(()));
1141 fn get_line(&self) -> usize {
1142 if let Some(ref source_map) = self.source_map {
1143 let line = self.position.lo().to_usize();
1144 let line = source_map.lookup_char_pos(BytePos(line as u32)).line;
1145 if line > 0 { line - 1 } else { line }
1151 fn register_header(&mut self, name: &str, level: u32) {
1152 if self.use_headers {
1153 // We use these headings as test names, so it's good if
1154 // they're valid identifiers.
1159 if (i == 0 && rustc_lexer::is_id_start(c))
1160 || (i != 0 && rustc_lexer::is_id_continue(c))
1167 .collect::<String>();
1169 // Here we try to efficiently assemble the header titles into the
1170 // test name in the form of `h1::h2::h3::h4::h5::h6`.
1172 // Suppose that originally `self.names` contains `[h1, h2, h3]`...
1173 let level = level as usize;
1174 if level <= self.names.len() {
1175 // ... Consider `level == 2`. All headers in the lower levels
1176 // are irrelevant in this new level. So we should reset
1177 // `self.names` to contain headers until <h2>, and replace that
1178 // slot with the new name: `[h1, name]`.
1179 self.names.truncate(level);
1180 self.names[level - 1] = name;
1182 // ... On the other hand, consider `level == 5`. This means we
1183 // need to extend `self.names` to contain five headers. We fill
1184 // in the missing level (<h4>) with `_`. Thus `self.names` will
1185 // become `[h1, h2, h3, "_", name]`.
1186 if level - 1 > self.names.len() {
1187 self.names.resize(level - 1, "_".to_owned());
1189 self.names.push(name);
1195 struct HirCollector<'a, 'hir, 'tcx> {
1197 collector: &'a mut Collector,
1203 impl<'a, 'hir, 'tcx> HirCollector<'a, 'hir, 'tcx> {
1204 fn visit_testable<F: FnOnce(&mut Self)>(
1211 let ast_attrs = self.tcx.hir().attrs(hir_id);
1212 if let Some(ref cfg) = ast_attrs.cfg(self.tcx, &FxHashSet::default()) {
1213 if !cfg.matches(&self.sess.parse_sess, Some(self.sess.features_untracked())) {
1218 let has_name = !name.is_empty();
1220 self.collector.names.push(name);
1223 // The collapse-docs pass won't combine sugared/raw doc attributes, or included files with
1224 // anything else, this will combine them for us.
1225 let attrs = Attributes::from_ast(ast_attrs);
1226 if let Some(doc) = attrs.collapsed_doc_value() {
1227 // Use the outermost invocation, so that doctest names come from where the docs were written.
1228 let span = ast_attrs
1230 .map(|span| span.ctxt().outer_expn().expansion_cause().unwrap_or(span))
1231 .unwrap_or(DUMMY_SP);
1232 self.collector.set_position(span);
1233 markdown::find_testable_code(
1237 self.collector.enable_per_target_ignores,
1238 Some(&crate::html::markdown::ExtraInfo::new(
1241 span_of_attrs(&attrs).unwrap_or(sp),
1249 self.collector.names.pop();
1254 impl<'a, 'hir, 'tcx> intravisit::Visitor<'hir> for HirCollector<'a, 'hir, 'tcx> {
1255 type NestedFilter = nested_filter::All;
1257 fn nested_visit_map(&mut self) -> Self::Map {
1261 fn visit_item(&mut self, item: &'hir hir::Item<'_>) {
1262 let name = match &item.kind {
1263 hir::ItemKind::Impl(impl_) => {
1264 rustc_hir_pretty::id_to_string(&self.map, impl_.self_ty.hir_id)
1266 _ => item.ident.to_string(),
1269 self.visit_testable(name, item.hir_id(), item.span, |this| {
1270 intravisit::walk_item(this, item);
1274 fn visit_trait_item(&mut self, item: &'hir hir::TraitItem<'_>) {
1275 self.visit_testable(item.ident.to_string(), item.hir_id(), item.span, |this| {
1276 intravisit::walk_trait_item(this, item);
1280 fn visit_impl_item(&mut self, item: &'hir hir::ImplItem<'_>) {
1281 self.visit_testable(item.ident.to_string(), item.hir_id(), item.span, |this| {
1282 intravisit::walk_impl_item(this, item);
1286 fn visit_foreign_item(&mut self, item: &'hir hir::ForeignItem<'_>) {
1287 self.visit_testable(item.ident.to_string(), item.hir_id(), item.span, |this| {
1288 intravisit::walk_foreign_item(this, item);
1292 fn visit_variant(&mut self, v: &'hir hir::Variant<'_>) {
1293 self.visit_testable(v.ident.to_string(), v.id, v.span, |this| {
1294 intravisit::walk_variant(this, v);
1298 fn visit_field_def(&mut self, f: &'hir hir::FieldDef<'_>) {
1299 self.visit_testable(f.ident.to_string(), f.hir_id, f.span, |this| {
1300 intravisit::walk_field_def(this, f);