2 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
3 use rustc_data_structures::sync::Lrc;
4 use rustc_errors::{ColorConfig, ErrorGuaranteed, FatalError};
5 use rustc_hir::def_id::{LocalDefId, CRATE_DEF_ID, LOCAL_CRATE};
6 use rustc_hir::{self as hir, intravisit, CRATE_HIR_ID};
7 use rustc_interface::interface;
8 use rustc_middle::hir::map::Map;
9 use rustc_middle::hir::nested_filter;
10 use rustc_middle::ty::TyCtxt;
11 use rustc_parse::maybe_new_parser_from_source_str;
12 use rustc_parse::parser::attr::InnerAttrPolicy;
13 use rustc_session::config::{self, CrateType, ErrorOutputType};
14 use rustc_session::parse::ParseSess;
15 use rustc_session::{lint, Session};
16 use rustc_span::edition::Edition;
17 use rustc_span::source_map::SourceMap;
18 use rustc_span::symbol::sym;
19 use rustc_span::{BytePos, FileName, Pos, Span, DUMMY_SP};
20 use rustc_target::spec::{Target, TargetTriple};
21 use tempfile::Builder as TempFileBuilder;
24 use std::io::{self, Write};
26 use std::path::PathBuf;
27 use std::process::{self, Command, Stdio};
29 use std::sync::atomic::{AtomicUsize, Ordering};
30 use std::sync::{Arc, Mutex};
32 use crate::clean::{types::AttributesExt, Attributes};
33 use crate::config::Options as RustdocOptions;
34 use crate::html::markdown::{self, ErrorCodes, Ignore, LangString};
35 use crate::lint::init_lints;
36 use crate::passes::span_of_attrs;
38 /// Options that apply to all doctests in a crate or Markdown file (for `rustdoc foo.md`).
39 #[derive(Clone, Default)]
40 pub(crate) struct GlobalTestOptions {
41 /// Whether to disable the default `extern crate my_crate;` when creating doctests.
42 pub(crate) no_crate_inject: bool,
43 /// Additional crate-level attributes to add to doctests.
44 pub(crate) attrs: Vec<String>,
47 pub(crate) fn run(options: RustdocOptions) -> Result<(), ErrorGuaranteed> {
48 let input = config::Input::File(options.input.clone());
50 let invalid_codeblock_attributes_name = crate::lint::INVALID_CODEBLOCK_ATTRIBUTES.name;
52 // See core::create_config for what's going on here.
53 let allowed_lints = vec![
54 invalid_codeblock_attributes_name.to_owned(),
55 lint::builtin::UNKNOWN_LINTS.name.to_owned(),
56 lint::builtin::RENAMED_AND_REMOVED_LINTS.name.to_owned(),
59 let (lint_opts, lint_caps) = init_lints(allowed_lints, options.lint_opts.clone(), |lint| {
60 if lint.name == invalid_codeblock_attributes_name {
63 Some((lint.name_lower(), lint::Allow))
70 if options.proc_macro_crate { vec![CrateType::ProcMacro] } else { vec![CrateType::Rlib] };
72 let sessopts = config::Options {
73 maybe_sysroot: options.maybe_sysroot.clone(),
74 search_paths: options.libs.clone(),
77 lint_cap: Some(options.lint_cap.unwrap_or(lint::Forbid)),
78 cg: options.codegen_options.clone(),
79 externs: options.externs.clone(),
80 unstable_features: options.unstable_features,
81 actually_rustdoc: true,
82 edition: options.edition,
83 target_triple: options.target.clone(),
84 crate_name: options.crate_name.clone(),
85 ..config::Options::default()
88 let mut cfgs = options.cfgs.clone();
89 cfgs.push("doc".to_owned());
90 cfgs.push("doctest".to_owned());
91 let config = interface::Config {
93 crate_cfg: interface::parse_cfgspecs(cfgs),
94 crate_check_cfg: interface::parse_check_cfg(options.check_cfgs.clone()),
100 parse_sess_created: None,
101 register_lints: Some(Box::new(crate::lint::register_lints)),
102 override_queries: None,
103 make_codegen_backend: None,
104 registry: rustc_driver::diagnostics_registry(),
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;
112 let (tests, unused_extern_reports, compiling_test_count) =
113 interface::run_compiler(config, |compiler| {
114 compiler.enter(|queries| {
115 let collector = queries.global_ctxt()?.enter(|tcx| {
116 let crate_attrs = tcx.hir().attrs(CRATE_HIR_ID);
118 let opts = scrape_test_config(crate_attrs);
119 let enable_per_target_ignores = options.enable_per_target_ignores;
120 let mut collector = Collector::new(
121 tcx.crate_name(LOCAL_CRATE).to_string(),
125 Some(compiler.session().parse_sess.clone_source_map()),
127 enable_per_target_ignores,
130 let mut hir_collector = HirCollector {
131 sess: compiler.session(),
132 collector: &mut collector,
134 codes: ErrorCodes::from(
135 compiler.session().opts.unstable_features.is_nightly_build(),
139 hir_collector.visit_testable(
142 tcx.hir().span(CRATE_HIR_ID),
143 |this| tcx.hir().walk_toplevel_module(this),
148 if compiler.session().diagnostic().has_errors_or_lint_errors().is_some() {
152 let unused_extern_reports = collector.unused_extern_reports.clone();
153 let compiling_test_count = collector.compiling_test_count.load(Ordering::SeqCst);
154 Ok((collector.tests, unused_extern_reports, compiling_test_count))
158 run_tests(test_args, nocapture, tests);
160 // Collect and warn about unused externs, but only if we've gotten
161 // reports for each doctest
162 if json_unused_externs.is_enabled() {
163 let unused_extern_reports: Vec<_> =
164 std::mem::take(&mut unused_extern_reports.lock().unwrap());
165 if unused_extern_reports.len() == compiling_test_count {
166 let extern_names = externs.iter().map(|(name, _)| name).collect::<FxHashSet<&String>>();
167 let mut unused_extern_names = unused_extern_reports
169 .map(|uexts| uexts.unused_extern_names.iter().collect::<FxHashSet<&String>>())
170 .fold(extern_names, |uextsa, uextsb| {
171 uextsa.intersection(&uextsb).copied().collect::<FxHashSet<&String>>()
174 .map(|v| (*v).clone())
175 .collect::<Vec<String>>();
176 unused_extern_names.sort();
177 // Take the most severe lint level
178 let lint_level = unused_extern_reports
180 .map(|uexts| uexts.lint_level.as_str())
181 .max_by_key(|v| match *v {
185 // The allow lint level is not expected,
186 // as if allow is specified, no message
188 v => unreachable!("Invalid lint level '{}'", v),
192 let uext = UnusedExterns { lint_level, unused_extern_names };
193 let unused_extern_json = serde_json::to_string(&uext).unwrap();
194 eprintln!("{unused_extern_json}");
201 pub(crate) fn run_tests(
202 mut test_args: Vec<String>,
204 mut tests: Vec<test::TestDescAndFn>,
206 test_args.insert(0, "rustdoctest".to_string());
208 test_args.push("--nocapture".to_string());
210 tests.sort_by(|a, b| a.desc.name.as_slice().cmp(&b.desc.name.as_slice()));
211 test::test_main(&test_args, tests, None);
214 // Look for `#![doc(test(no_crate_inject))]`, used by crates in the std facade.
215 fn scrape_test_config(attrs: &[ast::Attribute]) -> GlobalTestOptions {
216 use rustc_ast_pretty::pprust;
218 let mut opts = GlobalTestOptions { no_crate_inject: false, attrs: Vec::new() };
220 let test_attrs: Vec<_> = attrs
222 .filter(|a| a.has_name(sym::doc))
223 .flat_map(|a| a.meta_item_list().unwrap_or_default())
224 .filter(|a| a.has_name(sym::test))
226 let attrs = test_attrs.iter().flat_map(|a| a.meta_item_list().unwrap_or(&[]));
229 if attr.has_name(sym::no_crate_inject) {
230 opts.no_crate_inject = true;
232 if attr.has_name(sym::attr) {
233 if let Some(l) = attr.meta_item_list() {
235 opts.attrs.push(pprust::meta_list_item_to_string(item));
244 /// Documentation test failure modes.
246 /// The test failed to compile.
248 /// The test is marked `compile_fail` but compiled successfully.
249 UnexpectedCompilePass,
250 /// The test failed to compile (as expected) but the compiler output did not contain all
251 /// expected error codes.
252 MissingErrorCodes(Vec<String>),
253 /// The test binary was unable to be executed.
254 ExecutionError(io::Error),
255 /// The test binary exited with a non-zero exit code.
257 /// This typically means an assertion in the test failed or another form of panic occurred.
258 ExecutionFailure(process::Output),
259 /// The test is marked `should_panic` but the test binary executed successfully.
264 Temp(tempfile::TempDir),
269 fn path(&self) -> &std::path::Path {
271 DirState::Temp(t) => t.path(),
272 DirState::Perm(p) => p.as_path(),
277 // NOTE: Keep this in sync with the equivalent structs in rustc
279 // We could unify this struct the one in rustc but they have different
280 // ownership semantics, so doing so would create wasteful allocations.
281 #[derive(serde::Serialize, serde::Deserialize)]
282 struct UnusedExterns {
283 /// Lint level of the unused_crate_dependencies lint
285 /// List of unused externs by their names.
286 unused_extern_names: Vec<String>,
289 fn add_exe_suffix(input: String, target: &TargetTriple) -> String {
290 let exe_suffix = match target {
291 TargetTriple::TargetTriple(_) => Target::expect_builtin(target).options.exe_suffix,
292 TargetTriple::TargetJson { contents, .. } => {
293 Target::from_json(contents.parse().unwrap()).unwrap().0.options.exe_suffix
303 rustdoc_options: RustdocOptions,
304 mut lang_string: LangString,
306 runtool: Option<String>,
307 runtool_args: Vec<String>,
308 target: TargetTriple,
309 opts: &GlobalTestOptions,
314 report_unused_externs: impl Fn(UnusedExterns),
315 ) -> Result<(), TestFailure> {
316 let (test, line_offset, supports_color) =
317 make_test(test, Some(crate_name), lang_string.test_harness, opts, edition, Some(test_id));
319 // Make sure we emit well-formed executable names for our target.
320 let rust_out = add_exe_suffix("rust_out".to_owned(), &target);
321 let output_file = outdir.path().join(rust_out);
323 let rustc_binary = rustdoc_options
326 .unwrap_or_else(|| rustc_interface::util::rustc_path().expect("found rustc"));
327 let mut compiler = Command::new(&rustc_binary);
328 compiler.arg("--crate-type").arg("bin");
329 for cfg in &rustdoc_options.cfgs {
330 compiler.arg("--cfg").arg(&cfg);
332 if !rustdoc_options.check_cfgs.is_empty() {
333 compiler.arg("-Z").arg("unstable-options");
334 for check_cfg in &rustdoc_options.check_cfgs {
335 compiler.arg("--check-cfg").arg(&check_cfg);
338 if let Some(sysroot) = rustdoc_options.maybe_sysroot {
339 compiler.arg("--sysroot").arg(sysroot);
341 compiler.arg("--edition").arg(&edition.to_string());
342 compiler.env("UNSTABLE_RUSTDOC_TEST_PATH", path);
343 compiler.env("UNSTABLE_RUSTDOC_TEST_LINE", format!("{}", line as isize - line_offset as isize));
344 compiler.arg("-o").arg(&output_file);
345 if lang_string.test_harness {
346 compiler.arg("--test");
348 if rustdoc_options.json_unused_externs.is_enabled() && !lang_string.compile_fail {
349 compiler.arg("--error-format=json");
350 compiler.arg("--json").arg("unused-externs");
351 compiler.arg("-Z").arg("unstable-options");
352 compiler.arg("-W").arg("unused_crate_dependencies");
354 for lib_str in &rustdoc_options.lib_strs {
355 compiler.arg("-L").arg(&lib_str);
357 for extern_str in &rustdoc_options.extern_strs {
358 compiler.arg("--extern").arg(&extern_str);
360 compiler.arg("-Ccodegen-units=1");
361 for codegen_options_str in &rustdoc_options.codegen_options_strs {
362 compiler.arg("-C").arg(&codegen_options_str);
364 for unstable_option_str in &rustdoc_options.unstable_opts_strs {
365 compiler.arg("-Z").arg(&unstable_option_str);
367 if no_run && !lang_string.compile_fail && rustdoc_options.persist_doctests.is_none() {
368 compiler.arg("--emit=metadata");
370 compiler.arg("--target").arg(match target {
371 TargetTriple::TargetTriple(s) => s,
372 TargetTriple::TargetJson { path_for_rustdoc, .. } => {
373 path_for_rustdoc.to_str().expect("target path must be valid unicode").to_string()
376 if let ErrorOutputType::HumanReadable(kind) = rustdoc_options.error_format {
377 let (short, color_config) = kind.unzip();
380 compiler.arg("--error-format").arg("short");
384 ColorConfig::Never => {
385 compiler.arg("--color").arg("never");
387 ColorConfig::Always => {
388 compiler.arg("--color").arg("always");
390 ColorConfig::Auto => {
391 compiler.arg("--color").arg(if supports_color { "always" } else { "never" });
397 compiler.stdin(Stdio::piped());
398 compiler.stderr(Stdio::piped());
400 let mut child = compiler.spawn().expect("Failed to spawn rustc process");
402 let stdin = child.stdin.as_mut().expect("Failed to open stdin");
403 stdin.write_all(test.as_bytes()).expect("could write out test sources");
405 let output = child.wait_with_output().expect("Failed to read stdout");
407 struct Bomb<'a>(&'a str);
408 impl Drop for Bomb<'_> {
410 eprint!("{}", self.0);
413 let mut out = str::from_utf8(&output.stderr)
417 if let Ok(uext) = serde_json::from_str::<UnusedExterns>(l) {
418 report_unused_externs(uext);
424 .intersperse_with(|| "\n")
425 .collect::<String>();
427 // Add a \n to the end to properly terminate the last line,
428 // but only if there was output to be printed
433 let _bomb = Bomb(&out);
434 match (output.status.success(), lang_string.compile_fail) {
436 return Err(TestFailure::UnexpectedCompilePass);
440 if !lang_string.error_codes.is_empty() {
441 // We used to check if the output contained "error[{}]: " but since we added the
442 // colored output, we can't anymore because of the color escape characters before
444 lang_string.error_codes.retain(|err| !out.contains(&format!("error[{err}]")));
446 if !lang_string.error_codes.is_empty() {
447 return Err(TestFailure::MissingErrorCodes(lang_string.error_codes));
452 return Err(TestFailure::CompileError);
463 if let Some(tool) = runtool {
464 cmd = Command::new(tool);
465 cmd.args(runtool_args);
466 cmd.arg(output_file);
468 cmd = Command::new(output_file);
470 if let Some(run_directory) = rustdoc_options.test_run_directory {
471 cmd.current_dir(run_directory);
474 let result = if rustdoc_options.nocapture {
475 cmd.status().map(|status| process::Output {
484 Err(e) => return Err(TestFailure::ExecutionError(e)),
486 if lang_string.should_panic && out.status.success() {
487 return Err(TestFailure::UnexpectedRunPass);
488 } else if !lang_string.should_panic && !out.status.success() {
489 return Err(TestFailure::ExecutionFailure(out));
497 /// Transforms a test into code that can be compiled into a Rust binary, and returns the number of
498 /// lines before the test code begins as well as if the output stream supports colors or not.
499 pub(crate) fn make_test(
501 crate_name: Option<&str>,
502 dont_insert_main: bool,
503 opts: &GlobalTestOptions,
505 test_id: Option<&str>,
506 ) -> (String, usize, bool) {
507 let (crate_attrs, everything_else, crates) = partition_source(s, edition);
508 let everything_else = everything_else.trim();
509 let mut line_offset = 0;
510 let mut prog = String::new();
511 let mut supports_color = false;
513 if opts.attrs.is_empty() {
514 // If there aren't any attributes supplied by #![doc(test(attr(...)))], then allow some
515 // lints that are commonly triggered in doctests. The crate-level test attributes are
516 // commonly used to make tests fail in case they trigger warnings, so having this there in
517 // that case may cause some tests to pass when they shouldn't have.
518 prog.push_str("#![allow(unused)]\n");
522 // Next, any attributes that came from the crate root via #![doc(test(attr(...)))].
523 for attr in &opts.attrs {
524 prog.push_str(&format!("#![{attr}]\n"));
528 // Now push any outer attributes from the example, assuming they
529 // are intended to be crate attributes.
530 prog.push_str(&crate_attrs);
531 prog.push_str(&crates);
533 // Uses librustc_ast to parse the doctest and find if there's a main fn and the extern
534 // crate already is included.
535 let result = rustc_driver::catch_fatal_errors(|| {
536 rustc_span::create_session_if_not_set_then(edition, |_| {
537 use rustc_errors::emitter::{Emitter, EmitterWriter};
538 use rustc_errors::Handler;
539 use rustc_parse::parser::ForceCollect;
540 use rustc_span::source_map::FilePathMapping;
542 let filename = FileName::anon_source_code(s);
543 let source = crates + everything_else;
545 // Any errors in parsing should also appear when the doctest is compiled for real, so just
546 // send all the errors that librustc_ast emits directly into a `Sink` instead of stderr.
547 let sm = Lrc::new(SourceMap::new(FilePathMapping::empty()));
548 let fallback_bundle =
549 rustc_errors::fallback_fluent_bundle(rustc_errors::DEFAULT_LOCALE_RESOURCES, false);
550 supports_color = EmitterWriter::stderr(
554 fallback_bundle.clone(),
563 let emitter = EmitterWriter::new(
564 Box::new(io::sink()),
576 // FIXME(misdreavus): pass `-Z treat-err-as-bug` to the doctest parser
577 let handler = Handler::with_emitter(false, None, Box::new(emitter));
578 let sess = ParseSess::with_span_handler(handler, sm);
580 let mut found_main = false;
581 let mut found_extern_crate = crate_name.is_none();
582 let mut found_macro = false;
584 let mut parser = match maybe_new_parser_from_source_str(&sess, filename, source) {
588 return (found_main, found_extern_crate, found_macro);
593 match parser.parse_item(ForceCollect::No) {
596 if let ast::ItemKind::Fn(..) = item.kind {
597 if item.ident.name == sym::main {
603 if !found_extern_crate {
604 if let ast::ItemKind::ExternCrate(original) = item.kind {
605 // This code will never be reached if `crate_name` is none because
606 // `found_extern_crate` is initialized to `true` if it is none.
607 let crate_name = crate_name.unwrap();
610 Some(name) => found_extern_crate = name.as_str() == crate_name,
611 None => found_extern_crate = item.ident.as_str() == crate_name,
617 if let ast::ItemKind::MacCall(..) = item.kind {
622 if found_main && found_extern_crate {
633 // The supplied slice is only used for diagnostics,
634 // which are swallowed here anyway.
635 parser.maybe_consume_incorrect_semicolon(&[]);
638 // Reset errors so that they won't be reported as compiler bugs when dropping the
639 // handler. Any errors in the tests will be reported when the test file is compiled,
640 // Note that we still need to cancel the errors above otherwise `DiagnosticBuilder`
641 // will panic on drop.
642 sess.span_diagnostic.reset_err_count();
644 (found_main, found_extern_crate, found_macro)
647 let Ok((already_has_main, already_has_extern_crate, found_macro)) = result
649 // If the parser panicked due to a fatal error, pass the test code through unchanged.
650 // The error will be reported during compilation.
651 return (s.to_owned(), 0, false);
654 // If a doctest's `fn main` is being masked by a wrapper macro, the parsing loop above won't
655 // see it. In that case, run the old text-based scan to see if they at least have a main
656 // function written inside a macro invocation. See
657 // https://github.com/rust-lang/rust/issues/56898
658 let already_has_main = if found_macro && !already_has_main {
661 let comment = line.find("//");
662 if let Some(comment_begins) = comment { &line[0..comment_begins] } else { line }
664 .any(|code| code.contains("fn main"))
669 // Don't inject `extern crate std` because it's already injected by the
671 if !already_has_extern_crate && !opts.no_crate_inject && crate_name != Some("std") {
672 if let Some(crate_name) = crate_name {
673 // Don't inject `extern crate` if the crate is never used.
674 // NOTE: this is terribly inaccurate because it doesn't actually
675 // parse the source, but only has false positives, not false
677 if s.contains(crate_name) {
678 prog.push_str(&format!("extern crate r#{crate_name};\n"));
684 // FIXME: This code cannot yet handle no_std test cases yet
685 if dont_insert_main || already_has_main || prog.contains("![no_std]") {
686 prog.push_str(everything_else);
688 let returns_result = everything_else.trim_end().ends_with("(())");
689 // Give each doctest main function a unique name.
690 // This is for example needed for the tooling around `-C instrument-coverage`.
691 let inner_fn_name = if let Some(test_id) = test_id {
692 format!("_doctest_main_{test_id}")
696 let inner_attr = if test_id.is_some() { "#[allow(non_snake_case)] " } else { "" };
697 let (main_pre, main_post) = if returns_result {
700 "fn main() {{ {inner_attr}fn {inner_fn_name}() -> Result<(), impl core::fmt::Debug> {{\n",
702 format!("\n}} {inner_fn_name}().unwrap() }}"),
704 } else if test_id.is_some() {
706 format!("fn main() {{ {inner_attr}fn {inner_fn_name}() {{\n",),
707 format!("\n}} {inner_fn_name}() }}"),
710 ("fn main() {\n".into(), "\n}".into())
712 // Note on newlines: We insert a line/newline *before*, and *after*
713 // the doctest and adjust the `line_offset` accordingly.
714 // In the case of `-C instrument-coverage`, this means that the generated
715 // inner `main` function spans from the doctest opening codeblock to the
716 // closing one. For example
717 // /// ``` <- start of the inner main
718 // /// <- code under doctest
719 // /// ``` <- end of the inner main
722 prog.extend([&main_pre, everything_else, &main_post].iter().cloned());
725 debug!("final doctest:\n{prog}");
727 (prog, line_offset, supports_color)
730 fn check_if_attr_is_complete(source: &str, edition: Edition) -> bool {
731 if source.is_empty() {
732 // Empty content so nothing to check in here...
735 rustc_driver::catch_fatal_errors(|| {
736 rustc_span::create_session_if_not_set_then(edition, |_| {
737 use rustc_errors::emitter::EmitterWriter;
738 use rustc_errors::Handler;
739 use rustc_span::source_map::FilePathMapping;
741 let filename = FileName::anon_source_code(source);
742 // Any errors in parsing should also appear when the doctest is compiled for real, so just
743 // send all the errors that librustc_ast emits directly into a `Sink` instead of stderr.
744 let sm = Lrc::new(SourceMap::new(FilePathMapping::empty()));
745 let fallback_bundle =
746 rustc_errors::fallback_fluent_bundle(rustc_errors::DEFAULT_LOCALE_RESOURCES, false);
748 let emitter = EmitterWriter::new(
749 Box::new(io::sink()),
761 let handler = Handler::with_emitter(false, None, Box::new(emitter));
762 let sess = ParseSess::with_span_handler(handler, sm);
764 match maybe_new_parser_from_source_str(&sess, filename, source.to_owned()) {
767 debug!("Cannot build a parser to check mod attr so skipping...");
771 // If a parsing error happened, it's very likely that the attribute is incomplete.
772 if let Err(e) = parser.parse_attribute(InnerAttrPolicy::Permitted) {
776 // We now check if there is an unclosed delimiter for the attribute. To do so, we look at
777 // the `unclosed_delims` and see if the opening square bracket was closed.
782 unclosed.unclosed_span.map(|s| s.lo()).unwrap_or(BytePos(0)) != BytePos(2)
790 fn partition_source(s: &str, edition: Edition) -> (String, String, String) {
791 #[derive(Copy, Clone, PartialEq)]
792 enum PartitionState {
797 let mut state = PartitionState::Attrs;
798 let mut before = String::new();
799 let mut crates = String::new();
800 let mut after = String::new();
802 let mut mod_attr_pending = String::new();
804 for line in s.lines() {
805 let trimline = line.trim();
807 // FIXME(misdreavus): if a doc comment is placed on an extern crate statement, it will be
808 // shunted into "everything else"
810 PartitionState::Attrs => {
811 state = if trimline.starts_with("#![") {
812 if !check_if_attr_is_complete(line, edition) {
813 mod_attr_pending = line.to_owned();
815 mod_attr_pending.clear();
817 PartitionState::Attrs
818 } else if trimline.chars().all(|c| c.is_whitespace())
819 || (trimline.starts_with("//") && !trimline.starts_with("///"))
821 PartitionState::Attrs
822 } else if trimline.starts_with("extern crate")
823 || trimline.starts_with("#[macro_use] extern crate")
825 PartitionState::Crates
827 // First we check if the previous attribute was "complete"...
828 if !mod_attr_pending.is_empty() {
829 // If not, then we append the new line into the pending attribute to check
830 // if this time it's complete...
831 mod_attr_pending.push_str(line);
832 if !trimline.is_empty()
833 && check_if_attr_is_complete(&mod_attr_pending, edition)
835 // If it's complete, then we can clear the pending content.
836 mod_attr_pending.clear();
838 // In any case, this is considered as `PartitionState::Attrs` so it's
839 // prepended before rustdoc's inserts.
840 PartitionState::Attrs
842 PartitionState::Other
846 PartitionState::Crates => {
847 state = if trimline.starts_with("extern crate")
848 || trimline.starts_with("#[macro_use] extern crate")
849 || trimline.chars().all(|c| c.is_whitespace())
850 || (trimline.starts_with("//") && !trimline.starts_with("///"))
852 PartitionState::Crates
854 PartitionState::Other
857 PartitionState::Other => {}
861 PartitionState::Attrs => {
862 before.push_str(line);
865 PartitionState::Crates => {
866 crates.push_str(line);
869 PartitionState::Other => {
870 after.push_str(line);
876 debug!("before:\n{before}");
877 debug!("crates:\n{crates}");
878 debug!("after:\n{after}");
880 (before, after, crates)
883 pub(crate) trait Tester {
884 fn add_test(&mut self, test: String, config: LangString, line: usize);
885 fn get_line(&self) -> usize {
888 fn register_header(&mut self, _name: &str, _level: u32) {}
891 pub(crate) struct Collector {
892 pub(crate) tests: Vec<test::TestDescAndFn>,
894 // The name of the test displayed to the user, separated by `::`.
896 // In tests from Rust source, this is the path to the item
897 // e.g., `["std", "vec", "Vec", "push"]`.
899 // In tests from a markdown file, this is the titles of all headers (h1~h6)
900 // of the sections that contain the code block, e.g., if the markdown file is
913 // the `names` vector of that test will be `["Title", "Subtitle"]`.
916 rustdoc_options: RustdocOptions,
918 enable_per_target_ignores: bool,
920 opts: GlobalTestOptions,
922 source_map: Option<Lrc<SourceMap>>,
923 filename: Option<PathBuf>,
924 visited_tests: FxHashMap<(String, usize), usize>,
925 unused_extern_reports: Arc<Mutex<Vec<UnusedExterns>>>,
926 compiling_test_count: AtomicUsize,
932 rustdoc_options: RustdocOptions,
934 opts: GlobalTestOptions,
935 source_map: Option<Lrc<SourceMap>>,
936 filename: Option<PathBuf>,
937 enable_per_target_ignores: bool,
944 enable_per_target_ignores,
950 visited_tests: FxHashMap::default(),
951 unused_extern_reports: Default::default(),
952 compiling_test_count: AtomicUsize::new(0),
956 fn generate_name(&self, line: usize, filename: &FileName) -> String {
957 let mut item_path = self.names.join("::");
958 item_path.retain(|c| c != ' ');
959 if !item_path.is_empty() {
962 format!("{} - {}(line {})", filename.prefer_local(), item_path, line)
965 pub(crate) fn set_position(&mut self, position: Span) {
966 self.position = position;
969 fn get_filename(&self) -> FileName {
970 if let Some(ref source_map) = self.source_map {
971 let filename = source_map.span_to_filename(self.position);
972 if let FileName::Real(ref filename) = filename {
973 if let Ok(cur_dir) = env::current_dir() {
974 if let Some(local_path) = filename.local_path() {
975 if let Ok(path) = local_path.strip_prefix(&cur_dir) {
976 return path.to_owned().into();
982 } else if let Some(ref filename) = self.filename {
983 filename.clone().into()
985 FileName::Custom("input".to_owned())
990 impl Tester for Collector {
991 fn add_test(&mut self, test: String, config: LangString, line: usize) {
992 let filename = self.get_filename();
993 let name = self.generate_name(line, &filename);
994 let crate_name = self.crate_name.clone();
995 let opts = self.opts.clone();
996 let edition = config.edition.unwrap_or(self.rustdoc_options.edition);
997 let rustdoc_options = self.rustdoc_options.clone();
998 let runtool = self.rustdoc_options.runtool.clone();
999 let runtool_args = self.rustdoc_options.runtool_args.clone();
1000 let target = self.rustdoc_options.target.clone();
1001 let target_str = target.to_string();
1002 let unused_externs = self.unused_extern_reports.clone();
1003 let no_run = config.no_run || rustdoc_options.no_run;
1004 if !config.compile_fail {
1005 self.compiling_test_count.fetch_add(1, Ordering::SeqCst);
1008 let path = match &filename {
1009 FileName::Real(path) => {
1010 if let Some(local_path) = path.local_path() {
1011 local_path.to_path_buf()
1013 // Somehow we got the filename from the metadata of another crate, should never happen
1014 unreachable!("doctest from a different crate");
1017 _ => PathBuf::from(r"doctest.rs"),
1020 // For example `module/file.rs` would become `module_file_rs`
1025 .map(|c| if c.is_ascii_alphanumeric() { c } else { '_' })
1026 .collect::<String>();
1027 let test_id = format!(
1028 "{file}_{line}_{number}",
1032 // Increases the current test number, if this file already
1033 // exists or it creates a new entry with a test number of 0.
1034 self.visited_tests.entry((file.clone(), line)).and_modify(|v| *v += 1).or_insert(0)
1037 let outdir = if let Some(mut path) = rustdoc_options.persist_doctests.clone() {
1038 path.push(&test_id);
1040 if let Err(err) = std::fs::create_dir_all(&path) {
1041 eprintln!("Couldn't create directory for doctest executables: {}", err);
1042 panic::resume_unwind(Box::new(()));
1045 DirState::Perm(path)
1048 TempFileBuilder::new()
1049 .prefix("rustdoctest")
1051 .expect("rustdoc needs a tempdir"),
1055 debug!("creating test {name}: {test}");
1056 self.tests.push(test::TestDescAndFn {
1057 desc: test::TestDesc {
1058 name: test::DynTestName(name),
1059 ignore: match config.ignore {
1060 Ignore::All => true,
1061 Ignore::None => false,
1062 Ignore::Some(ref ignores) => ignores.iter().any(|s| target_str.contains(s)),
1064 ignore_message: None,
1065 // compiler failures are test failures
1066 should_panic: test::ShouldPanic::No,
1067 compile_fail: config.compile_fail,
1069 test_type: test::TestType::DocTest,
1071 testfn: test::DynTestFn(Box::new(move || {
1072 let report_unused_externs = |uext| {
1073 unused_externs.lock().unwrap().push(uext);
1090 report_unused_externs,
1093 if let Err(err) = res {
1095 TestFailure::CompileError => {
1096 eprint!("Couldn't compile the test.");
1098 TestFailure::UnexpectedCompilePass => {
1099 eprint!("Test compiled successfully, but it's marked `compile_fail`.");
1101 TestFailure::UnexpectedRunPass => {
1102 eprint!("Test executable succeeded, but it's marked `should_panic`.");
1104 TestFailure::MissingErrorCodes(codes) => {
1105 eprint!("Some expected error codes were not found: {:?}", codes);
1107 TestFailure::ExecutionError(err) => {
1108 eprint!("Couldn't run the test: {err}");
1109 if err.kind() == io::ErrorKind::PermissionDenied {
1110 eprint!(" - maybe your tempdir is mounted with noexec?");
1113 TestFailure::ExecutionFailure(out) => {
1114 eprintln!("Test executable failed ({reason}).", reason = out.status);
1116 // FIXME(#12309): An unfortunate side-effect of capturing the test
1117 // executable's output is that the relative ordering between the test's
1118 // stdout and stderr is lost. However, this is better than the
1119 // alternative: if the test executable inherited the parent's I/O
1120 // handles the output wouldn't be captured at all, even on success.
1122 // The ordering could be preserved if the test process' stderr was
1123 // redirected to stdout, but that functionality does not exist in the
1124 // standard library, so it may not be portable enough.
1125 let stdout = str::from_utf8(&out.stdout).unwrap_or_default();
1126 let stderr = str::from_utf8(&out.stderr).unwrap_or_default();
1128 if !stdout.is_empty() || !stderr.is_empty() {
1131 if !stdout.is_empty() {
1132 eprintln!("stdout:\n{stdout}");
1135 if !stderr.is_empty() {
1136 eprintln!("stderr:\n{stderr}");
1142 panic::resume_unwind(Box::new(()));
1149 fn get_line(&self) -> usize {
1150 if let Some(ref source_map) = self.source_map {
1151 let line = self.position.lo().to_usize();
1152 let line = source_map.lookup_char_pos(BytePos(line as u32)).line;
1153 if line > 0 { line - 1 } else { line }
1159 fn register_header(&mut self, name: &str, level: u32) {
1160 if self.use_headers {
1161 // We use these headings as test names, so it's good if
1162 // they're valid identifiers.
1167 if (i == 0 && rustc_lexer::is_id_start(c))
1168 || (i != 0 && rustc_lexer::is_id_continue(c))
1175 .collect::<String>();
1177 // Here we try to efficiently assemble the header titles into the
1178 // test name in the form of `h1::h2::h3::h4::h5::h6`.
1180 // Suppose that originally `self.names` contains `[h1, h2, h3]`...
1181 let level = level as usize;
1182 if level <= self.names.len() {
1183 // ... Consider `level == 2`. All headers in the lower levels
1184 // are irrelevant in this new level. So we should reset
1185 // `self.names` to contain headers until <h2>, and replace that
1186 // slot with the new name: `[h1, name]`.
1187 self.names.truncate(level);
1188 self.names[level - 1] = name;
1190 // ... On the other hand, consider `level == 5`. This means we
1191 // need to extend `self.names` to contain five headers. We fill
1192 // in the missing level (<h4>) with `_`. Thus `self.names` will
1193 // become `[h1, h2, h3, "_", name]`.
1194 if level - 1 > self.names.len() {
1195 self.names.resize(level - 1, "_".to_owned());
1197 self.names.push(name);
1203 struct HirCollector<'a, 'hir, 'tcx> {
1205 collector: &'a mut Collector,
1211 impl<'a, 'hir, 'tcx> HirCollector<'a, 'hir, 'tcx> {
1212 fn visit_testable<F: FnOnce(&mut Self)>(
1219 let ast_attrs = self.tcx.hir().attrs(self.tcx.hir().local_def_id_to_hir_id(def_id));
1220 if let Some(ref cfg) = ast_attrs.cfg(self.tcx, &FxHashSet::default()) {
1221 if !cfg.matches(&self.sess.parse_sess, Some(self.tcx.features())) {
1226 let has_name = !name.is_empty();
1228 self.collector.names.push(name);
1231 // The collapse-docs pass won't combine sugared/raw doc attributes, or included files with
1232 // anything else, this will combine them for us.
1233 let attrs = Attributes::from_ast(ast_attrs);
1234 if let Some(doc) = attrs.collapsed_doc_value() {
1235 // Use the outermost invocation, so that doctest names come from where the docs were written.
1236 let span = ast_attrs
1238 .map(|span| span.ctxt().outer_expn().expansion_cause().unwrap_or(span))
1239 .unwrap_or(DUMMY_SP);
1240 self.collector.set_position(span);
1241 markdown::find_testable_code(
1245 self.collector.enable_per_target_ignores,
1246 Some(&crate::html::markdown::ExtraInfo::new(
1249 span_of_attrs(&attrs).unwrap_or(sp),
1257 self.collector.names.pop();
1262 impl<'a, 'hir, 'tcx> intravisit::Visitor<'hir> for HirCollector<'a, 'hir, 'tcx> {
1263 type NestedFilter = nested_filter::All;
1265 fn nested_visit_map(&mut self) -> Self::Map {
1269 fn visit_item(&mut self, item: &'hir hir::Item<'_>) {
1270 let name = match &item.kind {
1271 hir::ItemKind::Impl(impl_) => {
1272 rustc_hir_pretty::id_to_string(&self.map, impl_.self_ty.hir_id)
1274 _ => item.ident.to_string(),
1277 self.visit_testable(name, item.owner_id.def_id, item.span, |this| {
1278 intravisit::walk_item(this, item);
1282 fn visit_trait_item(&mut self, item: &'hir hir::TraitItem<'_>) {
1283 self.visit_testable(item.ident.to_string(), item.owner_id.def_id, item.span, |this| {
1284 intravisit::walk_trait_item(this, item);
1288 fn visit_impl_item(&mut self, item: &'hir hir::ImplItem<'_>) {
1289 self.visit_testable(item.ident.to_string(), item.owner_id.def_id, item.span, |this| {
1290 intravisit::walk_impl_item(this, item);
1294 fn visit_foreign_item(&mut self, item: &'hir hir::ForeignItem<'_>) {
1295 self.visit_testable(item.ident.to_string(), item.owner_id.def_id, item.span, |this| {
1296 intravisit::walk_foreign_item(this, item);
1300 fn visit_variant(&mut self, v: &'hir hir::Variant<'_>) {
1301 self.visit_testable(v.ident.to_string(), v.def_id, v.span, |this| {
1302 intravisit::walk_variant(this, v);
1306 fn visit_field_def(&mut self, f: &'hir hir::FieldDef<'_>) {
1307 self.visit_testable(f.ident.to_string(), f.def_id, f.span, |this| {
1308 intravisit::walk_field_def(this, f);