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, Session};
18 use rustc_span::edition::Edition;
19 use rustc_span::source_map::SourceMap;
20 use rustc_span::symbol::sym;
21 use rustc_span::{BytePos, FileName, Pos, Span, DUMMY_SP};
22 use rustc_target::spec::TargetTriple;
23 use tempfile::Builder as TempFileBuilder;
26 use std::io::{self, Write};
28 use std::path::PathBuf;
29 use std::process::{self, Command, Stdio};
31 use std::sync::atomic::{AtomicUsize, Ordering};
32 use std::sync::{Arc, Mutex};
34 use crate::clean::{types::AttributesExt, Attributes};
35 use crate::config::Options as RustdocOptions;
36 use crate::html::markdown::{self, ErrorCodes, Ignore, LangString};
37 use crate::lint::init_lints;
38 use crate::passes::span_of_attrs;
40 /// Options that apply to all doctests in a crate or Markdown file (for `rustdoc foo.md`).
41 #[derive(Clone, Default)]
42 pub(crate) struct GlobalTestOptions {
43 /// Whether to disable the default `extern crate my_crate;` when creating doctests.
44 pub(crate) no_crate_inject: bool,
45 /// Additional crate-level attributes to add to doctests.
46 pub(crate) attrs: Vec<String>,
49 pub(crate) fn run(options: RustdocOptions) -> Result<(), ErrorGuaranteed> {
50 let input = config::Input::File(options.input.clone());
52 let invalid_codeblock_attributes_name = crate::lint::INVALID_CODEBLOCK_ATTRIBUTES.name;
54 // See core::create_config for what's going on here.
55 let allowed_lints = vec![
56 invalid_codeblock_attributes_name.to_owned(),
57 lint::builtin::UNKNOWN_LINTS.name.to_owned(),
58 lint::builtin::RENAMED_AND_REMOVED_LINTS.name.to_owned(),
61 let (lint_opts, lint_caps) = init_lints(allowed_lints, options.lint_opts.clone(), |lint| {
62 if lint.name == invalid_codeblock_attributes_name {
65 Some((lint.name_lower(), lint::Allow))
72 if options.proc_macro_crate { vec![CrateType::ProcMacro] } else { vec![CrateType::Rlib] };
74 let sessopts = config::Options {
75 maybe_sysroot: options.maybe_sysroot.clone(),
76 search_paths: options.libs.clone(),
79 lint_cap: Some(options.lint_cap.unwrap_or(lint::Forbid)),
80 cg: options.codegen_options.clone(),
81 externs: options.externs.clone(),
82 unstable_features: options.unstable_features,
83 actually_rustdoc: true,
84 edition: options.edition,
85 target_triple: options.target.clone(),
86 crate_name: options.crate_name.clone(),
87 ..config::Options::default()
90 let mut cfgs = options.cfgs.clone();
91 cfgs.push("doc".to_owned());
92 cfgs.push("doctest".to_owned());
93 let config = interface::Config {
95 crate_cfg: interface::parse_cfgspecs(cfgs),
96 crate_check_cfg: interface::parse_check_cfg(options.check_cfgs.clone()),
103 parse_sess_created: None,
104 register_lints: Some(Box::new(crate::lint::register_lints)),
105 override_queries: None,
106 make_codegen_backend: None,
107 registry: rustc_driver::diagnostics_registry(),
110 let test_args = options.test_args.clone();
111 let nocapture = options.nocapture;
112 let externs = options.externs.clone();
113 let json_unused_externs = options.json_unused_externs;
115 let (tests, unused_extern_reports, compiling_test_count) =
116 interface::run_compiler(config, |compiler| {
117 compiler.enter(|queries| {
118 let mut global_ctxt = queries.global_ctxt()?.take();
120 let collector = global_ctxt.enter(|tcx| {
121 let crate_attrs = tcx.hir().attrs(CRATE_HIR_ID);
123 let opts = scrape_test_config(crate_attrs);
124 let enable_per_target_ignores = options.enable_per_target_ignores;
125 let mut collector = Collector::new(
126 tcx.crate_name(LOCAL_CRATE).to_string(),
130 Some(compiler.session().parse_sess.clone_source_map()),
132 enable_per_target_ignores,
135 let mut hir_collector = HirCollector {
136 sess: compiler.session(),
137 collector: &mut collector,
139 codes: ErrorCodes::from(
140 compiler.session().opts.unstable_features.is_nightly_build(),
144 hir_collector.visit_testable(
147 tcx.hir().span(CRATE_HIR_ID),
148 |this| tcx.hir().walk_toplevel_module(this),
153 if compiler.session().diagnostic().has_errors_or_lint_errors().is_some() {
157 let unused_extern_reports = collector.unused_extern_reports.clone();
158 let compiling_test_count = collector.compiling_test_count.load(Ordering::SeqCst);
159 let ret: Result<_, ErrorGuaranteed> =
160 Ok((collector.tests, unused_extern_reports, compiling_test_count));
165 run_tests(test_args, nocapture, tests);
167 // Collect and warn about unused externs, but only if we've gotten
168 // reports for each doctest
169 if json_unused_externs.is_enabled() {
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
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>>()
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
187 .map(|uexts| uexts.lint_level.as_str())
188 .max_by_key(|v| match *v {
192 // The allow lint level is not expected,
193 // as if allow is specified, no message
195 v => unreachable!("Invalid lint level '{}'", v),
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}");
208 pub(crate) fn run_tests(
209 mut test_args: Vec<String>,
211 mut tests: Vec<test::TestDescAndFn>,
213 test_args.insert(0, "rustdoctest".to_string());
215 test_args.push("--nocapture".to_string());
217 tests.sort_by(|a, b| a.desc.name.as_slice().cmp(&b.desc.name.as_slice()));
218 test::test_main(&test_args, tests, None);
221 // Look for `#![doc(test(no_crate_inject))]`, used by crates in the std facade.
222 fn scrape_test_config(attrs: &[ast::Attribute]) -> GlobalTestOptions {
223 use rustc_ast_pretty::pprust;
225 let mut opts = GlobalTestOptions { no_crate_inject: false, attrs: Vec::new() };
227 let test_attrs: Vec<_> = attrs
229 .filter(|a| a.has_name(sym::doc))
230 .flat_map(|a| a.meta_item_list().unwrap_or_default())
231 .filter(|a| a.has_name(sym::test))
233 let attrs = test_attrs.iter().flat_map(|a| a.meta_item_list().unwrap_or(&[]));
236 if attr.has_name(sym::no_crate_inject) {
237 opts.no_crate_inject = true;
239 if attr.has_name(sym::attr) {
240 if let Some(l) = attr.meta_item_list() {
242 opts.attrs.push(pprust::meta_list_item_to_string(item));
251 /// Documentation test failure modes.
253 /// The test failed to compile.
255 /// The test is marked `compile_fail` but compiled successfully.
256 UnexpectedCompilePass,
257 /// The test failed to compile (as expected) but the compiler output did not contain all
258 /// expected error codes.
259 MissingErrorCodes(Vec<String>),
260 /// The test binary was unable to be executed.
261 ExecutionError(io::Error),
262 /// The test binary exited with a non-zero exit code.
264 /// This typically means an assertion in the test failed or another form of panic occurred.
265 ExecutionFailure(process::Output),
266 /// The test is marked `should_panic` but the test binary executed successfully.
271 Temp(tempfile::TempDir),
276 fn path(&self) -> &std::path::Path {
278 DirState::Temp(t) => t.path(),
279 DirState::Perm(p) => p.as_path(),
284 // NOTE: Keep this in sync with the equivalent structs in rustc
286 // We could unify this struct the one in rustc but they have different
287 // ownership semantics, so doing so would create wasteful allocations.
288 #[derive(serde::Serialize, serde::Deserialize)]
289 struct UnusedExterns {
290 /// Lint level of the unused_crate_dependencies lint
292 /// List of unused externs by their names.
293 unused_extern_names: Vec<String>,
300 rustdoc_options: RustdocOptions,
301 mut lang_string: LangString,
303 runtool: Option<String>,
304 runtool_args: Vec<String>,
305 target: TargetTriple,
306 opts: &GlobalTestOptions,
311 report_unused_externs: impl Fn(UnusedExterns),
312 ) -> Result<(), TestFailure> {
313 let (test, line_offset, supports_color) =
314 make_test(test, Some(crate_name), lang_string.test_harness, opts, edition, Some(test_id));
316 let output_file = outdir.path().join("rust_out");
318 let rustc_binary = rustdoc_options
321 .unwrap_or_else(|| rustc_interface::util::rustc_path().expect("found rustc"));
322 let mut compiler = Command::new(&rustc_binary);
323 compiler.arg("--crate-type").arg("bin");
324 for cfg in &rustdoc_options.cfgs {
325 compiler.arg("--cfg").arg(&cfg);
327 if !rustdoc_options.check_cfgs.is_empty() {
328 compiler.arg("-Z").arg("unstable-options");
329 for check_cfg in &rustdoc_options.check_cfgs {
330 compiler.arg("--check-cfg").arg(&check_cfg);
333 if let Some(sysroot) = rustdoc_options.maybe_sysroot {
334 compiler.arg("--sysroot").arg(sysroot);
336 compiler.arg("--edition").arg(&edition.to_string());
337 compiler.env("UNSTABLE_RUSTDOC_TEST_PATH", path);
338 compiler.env("UNSTABLE_RUSTDOC_TEST_LINE", format!("{}", line as isize - line_offset as isize));
339 compiler.arg("-o").arg(&output_file);
340 if lang_string.test_harness {
341 compiler.arg("--test");
343 if rustdoc_options.json_unused_externs.is_enabled() && !lang_string.compile_fail {
344 compiler.arg("--error-format=json");
345 compiler.arg("--json").arg("unused-externs");
346 compiler.arg("-Z").arg("unstable-options");
347 compiler.arg("-W").arg("unused_crate_dependencies");
349 for lib_str in &rustdoc_options.lib_strs {
350 compiler.arg("-L").arg(&lib_str);
352 for extern_str in &rustdoc_options.extern_strs {
353 compiler.arg("--extern").arg(&extern_str);
355 compiler.arg("-Ccodegen-units=1");
356 for codegen_options_str in &rustdoc_options.codegen_options_strs {
357 compiler.arg("-C").arg(&codegen_options_str);
359 for unstable_option_str in &rustdoc_options.unstable_opts_strs {
360 compiler.arg("-Z").arg(&unstable_option_str);
362 if no_run && !lang_string.compile_fail && rustdoc_options.persist_doctests.is_none() {
363 compiler.arg("--emit=metadata");
365 compiler.arg("--target").arg(match target {
366 TargetTriple::TargetTriple(s) => s,
367 TargetTriple::TargetJson { path_for_rustdoc, .. } => {
368 path_for_rustdoc.to_str().expect("target path must be valid unicode").to_string()
371 if let ErrorOutputType::HumanReadable(kind) = rustdoc_options.error_format {
372 let (short, color_config) = kind.unzip();
375 compiler.arg("--error-format").arg("short");
379 ColorConfig::Never => {
380 compiler.arg("--color").arg("never");
382 ColorConfig::Always => {
383 compiler.arg("--color").arg("always");
385 ColorConfig::Auto => {
386 compiler.arg("--color").arg(if supports_color { "always" } else { "never" });
392 compiler.stdin(Stdio::piped());
393 compiler.stderr(Stdio::piped());
395 let mut child = compiler.spawn().expect("Failed to spawn rustc process");
397 let stdin = child.stdin.as_mut().expect("Failed to open stdin");
398 stdin.write_all(test.as_bytes()).expect("could write out test sources");
400 let output = child.wait_with_output().expect("Failed to read stdout");
402 struct Bomb<'a>(&'a str);
403 impl Drop for Bomb<'_> {
405 eprint!("{}", self.0);
408 let mut out = str::from_utf8(&output.stderr)
412 if let Ok(uext) = serde_json::from_str::<UnusedExterns>(l) {
413 report_unused_externs(uext);
419 .intersperse_with(|| "\n")
420 .collect::<String>();
422 // Add a \n to the end to properly terminate the last line,
423 // but only if there was output to be printed
428 let _bomb = Bomb(&out);
429 match (output.status.success(), lang_string.compile_fail) {
431 return Err(TestFailure::UnexpectedCompilePass);
435 if !lang_string.error_codes.is_empty() {
436 // We used to check if the output contained "error[{}]: " but since we added the
437 // colored output, we can't anymore because of the color escape characters before
439 lang_string.error_codes.retain(|err| !out.contains(&format!("error[{err}]")));
441 if !lang_string.error_codes.is_empty() {
442 return Err(TestFailure::MissingErrorCodes(lang_string.error_codes));
447 return Err(TestFailure::CompileError);
458 if let Some(tool) = runtool {
459 cmd = Command::new(tool);
460 cmd.args(runtool_args);
461 cmd.arg(output_file);
463 cmd = Command::new(output_file);
465 if let Some(run_directory) = rustdoc_options.test_run_directory {
466 cmd.current_dir(run_directory);
469 let result = if rustdoc_options.nocapture {
470 cmd.status().map(|status| process::Output {
479 Err(e) => return Err(TestFailure::ExecutionError(e)),
481 if lang_string.should_panic && out.status.success() {
482 return Err(TestFailure::UnexpectedRunPass);
483 } else if !lang_string.should_panic && !out.status.success() {
484 return Err(TestFailure::ExecutionFailure(out));
492 /// Transforms a test into code that can be compiled into a Rust binary, and returns the number of
493 /// lines before the test code begins as well as if the output stream supports colors or not.
494 pub(crate) fn make_test(
496 crate_name: Option<&str>,
497 dont_insert_main: bool,
498 opts: &GlobalTestOptions,
500 test_id: Option<&str>,
501 ) -> (String, usize, bool) {
502 let (crate_attrs, everything_else, crates) = partition_source(s, edition);
503 let everything_else = everything_else.trim();
504 let mut line_offset = 0;
505 let mut prog = String::new();
506 let mut supports_color = false;
508 if opts.attrs.is_empty() {
509 // If there aren't any attributes supplied by #![doc(test(attr(...)))], then allow some
510 // lints that are commonly triggered in doctests. The crate-level test attributes are
511 // commonly used to make tests fail in case they trigger warnings, so having this there in
512 // that case may cause some tests to pass when they shouldn't have.
513 prog.push_str("#![allow(unused)]\n");
517 // Next, any attributes that came from the crate root via #![doc(test(attr(...)))].
518 for attr in &opts.attrs {
519 prog.push_str(&format!("#![{attr}]\n"));
523 // Now push any outer attributes from the example, assuming they
524 // are intended to be crate attributes.
525 prog.push_str(&crate_attrs);
526 prog.push_str(&crates);
528 // Uses librustc_ast to parse the doctest and find if there's a main fn and the extern
529 // crate already is included.
530 let result = rustc_driver::catch_fatal_errors(|| {
531 rustc_span::create_session_if_not_set_then(edition, |_| {
532 use rustc_errors::emitter::{Emitter, EmitterWriter};
533 use rustc_errors::Handler;
534 use rustc_parse::parser::ForceCollect;
535 use rustc_span::source_map::FilePathMapping;
537 let filename = FileName::anon_source_code(s);
538 let source = crates + everything_else;
540 // Any errors in parsing should also appear when the doctest is compiled for real, so just
541 // send all the errors that librustc_ast emits directly into a `Sink` instead of stderr.
542 let sm = Lrc::new(SourceMap::new(FilePathMapping::empty()));
543 let fallback_bundle =
544 rustc_errors::fallback_fluent_bundle(rustc_errors::DEFAULT_LOCALE_RESOURCES, false);
545 supports_color = EmitterWriter::stderr(
549 fallback_bundle.clone(),
557 let emitter = EmitterWriter::new(
558 Box::new(io::sink()),
569 // FIXME(misdreavus): pass `-Z treat-err-as-bug` to the doctest parser
570 let handler = Handler::with_emitter(false, None, Box::new(emitter));
571 let sess = ParseSess::with_span_handler(handler, sm);
573 let mut found_main = false;
574 let mut found_extern_crate = crate_name.is_none();
575 let mut found_macro = false;
577 let mut parser = match maybe_new_parser_from_source_str(&sess, filename, source) {
581 return (found_main, found_extern_crate, found_macro);
586 match parser.parse_item(ForceCollect::No) {
589 if let ast::ItemKind::Fn(..) = item.kind {
590 if item.ident.name == sym::main {
596 if !found_extern_crate {
597 if let ast::ItemKind::ExternCrate(original) = item.kind {
598 // This code will never be reached if `crate_name` is none because
599 // `found_extern_crate` is initialized to `true` if it is none.
600 let crate_name = crate_name.unwrap();
603 Some(name) => found_extern_crate = name.as_str() == crate_name,
604 None => found_extern_crate = item.ident.as_str() == crate_name,
610 if let ast::ItemKind::MacCall(..) = item.kind {
615 if found_main && found_extern_crate {
626 // The supplied slice is only used for diagnostics,
627 // which are swallowed here anyway.
628 parser.maybe_consume_incorrect_semicolon(&[]);
631 // Reset errors so that they won't be reported as compiler bugs when dropping the
632 // handler. Any errors in the tests will be reported when the test file is compiled,
633 // Note that we still need to cancel the errors above otherwise `DiagnosticBuilder`
634 // will panic on drop.
635 sess.span_diagnostic.reset_err_count();
637 (found_main, found_extern_crate, found_macro)
640 let Ok((already_has_main, already_has_extern_crate, found_macro)) = result
642 // If the parser panicked due to a fatal error, pass the test code through unchanged.
643 // The error will be reported during compilation.
644 return (s.to_owned(), 0, false);
647 // If a doctest's `fn main` is being masked by a wrapper macro, the parsing loop above won't
648 // see it. In that case, run the old text-based scan to see if they at least have a main
649 // function written inside a macro invocation. See
650 // https://github.com/rust-lang/rust/issues/56898
651 let already_has_main = if found_macro && !already_has_main {
654 let comment = line.find("//");
655 if let Some(comment_begins) = comment { &line[0..comment_begins] } else { line }
657 .any(|code| code.contains("fn main"))
662 // Don't inject `extern crate std` because it's already injected by the
664 if !already_has_extern_crate && !opts.no_crate_inject && crate_name != Some("std") {
665 if let Some(crate_name) = crate_name {
666 // Don't inject `extern crate` if the crate is never used.
667 // NOTE: this is terribly inaccurate because it doesn't actually
668 // parse the source, but only has false positives, not false
670 if s.contains(crate_name) {
671 prog.push_str(&format!("extern crate r#{crate_name};\n"));
677 // FIXME: This code cannot yet handle no_std test cases yet
678 if dont_insert_main || already_has_main || prog.contains("![no_std]") {
679 prog.push_str(everything_else);
681 let returns_result = everything_else.trim_end().ends_with("(())");
682 // Give each doctest main function a unique name.
683 // This is for example needed for the tooling around `-C instrument-coverage`.
684 let inner_fn_name = if let Some(test_id) = test_id {
685 format!("_doctest_main_{test_id}")
689 let inner_attr = if test_id.is_some() { "#[allow(non_snake_case)] " } else { "" };
690 let (main_pre, main_post) = if returns_result {
693 "fn main() {{ {inner_attr}fn {inner_fn_name}() -> Result<(), impl core::fmt::Debug> {{\n",
695 format!("\n}} {inner_fn_name}().unwrap() }}"),
697 } else if test_id.is_some() {
699 format!("fn main() {{ {inner_attr}fn {inner_fn_name}() {{\n",),
700 format!("\n}} {inner_fn_name}() }}"),
703 ("fn main() {\n".into(), "\n}".into())
705 // Note on newlines: We insert a line/newline *before*, and *after*
706 // the doctest and adjust the `line_offset` accordingly.
707 // In the case of `-C instrument-coverage`, this means that the generated
708 // inner `main` function spans from the doctest opening codeblock to the
709 // closing one. For example
710 // /// ``` <- start of the inner main
711 // /// <- code under doctest
712 // /// ``` <- end of the inner main
715 prog.extend([&main_pre, everything_else, &main_post].iter().cloned());
718 debug!("final doctest:\n{prog}");
720 (prog, line_offset, supports_color)
723 fn check_if_attr_is_complete(source: &str, edition: Edition) -> bool {
724 if source.is_empty() {
725 // Empty content so nothing to check in here...
728 rustc_driver::catch_fatal_errors(|| {
729 rustc_span::create_session_if_not_set_then(edition, |_| {
730 use rustc_errors::emitter::EmitterWriter;
731 use rustc_errors::Handler;
732 use rustc_span::source_map::FilePathMapping;
734 let filename = FileName::anon_source_code(source);
735 // Any errors in parsing should also appear when the doctest is compiled for real, so just
736 // send all the errors that librustc_ast emits directly into a `Sink` instead of stderr.
737 let sm = Lrc::new(SourceMap::new(FilePathMapping::empty()));
738 let fallback_bundle =
739 rustc_errors::fallback_fluent_bundle(rustc_errors::DEFAULT_LOCALE_RESOURCES, false);
741 let emitter = EmitterWriter::new(
742 Box::new(io::sink()),
753 let handler = Handler::with_emitter(false, None, Box::new(emitter));
754 let sess = ParseSess::with_span_handler(handler, sm);
756 match maybe_new_parser_from_source_str(&sess, filename, source.to_owned()) {
759 debug!("Cannot build a parser to check mod attr so skipping...");
763 // If a parsing error happened, it's very likely that the attribute is incomplete.
764 if let Err(e) = parser.parse_attribute(InnerAttrPolicy::Permitted) {
768 // We now check if there is an unclosed delimiter for the attribute. To do so, we look at
769 // the `unclosed_delims` and see if the opening square bracket was closed.
774 unclosed.unclosed_span.map(|s| s.lo()).unwrap_or(BytePos(0)) != BytePos(2)
782 fn partition_source(s: &str, edition: Edition) -> (String, String, String) {
783 #[derive(Copy, Clone, PartialEq)]
784 enum PartitionState {
789 let mut state = PartitionState::Attrs;
790 let mut before = String::new();
791 let mut crates = String::new();
792 let mut after = String::new();
794 let mut mod_attr_pending = String::new();
796 for line in s.lines() {
797 let trimline = line.trim();
799 // FIXME(misdreavus): if a doc comment is placed on an extern crate statement, it will be
800 // shunted into "everything else"
802 PartitionState::Attrs => {
803 state = if trimline.starts_with("#![") {
804 if !check_if_attr_is_complete(line, edition) {
805 mod_attr_pending = line.to_owned();
807 mod_attr_pending.clear();
809 PartitionState::Attrs
810 } else if trimline.chars().all(|c| c.is_whitespace())
811 || (trimline.starts_with("//") && !trimline.starts_with("///"))
813 PartitionState::Attrs
814 } else if trimline.starts_with("extern crate")
815 || trimline.starts_with("#[macro_use] extern crate")
817 PartitionState::Crates
819 // First we check if the previous attribute was "complete"...
820 if !mod_attr_pending.is_empty() {
821 // If not, then we append the new line into the pending attribute to check
822 // if this time it's complete...
823 mod_attr_pending.push_str(line);
824 if !trimline.is_empty()
825 && check_if_attr_is_complete(&mod_attr_pending, edition)
827 // If it's complete, then we can clear the pending content.
828 mod_attr_pending.clear();
830 // In any case, this is considered as `PartitionState::Attrs` so it's
831 // prepended before rustdoc's inserts.
832 PartitionState::Attrs
834 PartitionState::Other
838 PartitionState::Crates => {
839 state = if trimline.starts_with("extern crate")
840 || trimline.starts_with("#[macro_use] extern crate")
841 || trimline.chars().all(|c| c.is_whitespace())
842 || (trimline.starts_with("//") && !trimline.starts_with("///"))
844 PartitionState::Crates
846 PartitionState::Other
849 PartitionState::Other => {}
853 PartitionState::Attrs => {
854 before.push_str(line);
857 PartitionState::Crates => {
858 crates.push_str(line);
861 PartitionState::Other => {
862 after.push_str(line);
868 debug!("before:\n{before}");
869 debug!("crates:\n{crates}");
870 debug!("after:\n{after}");
872 (before, after, crates)
875 pub(crate) trait Tester {
876 fn add_test(&mut self, test: String, config: LangString, line: usize);
877 fn get_line(&self) -> usize {
880 fn register_header(&mut self, _name: &str, _level: u32) {}
883 pub(crate) struct Collector {
884 pub(crate) tests: Vec<test::TestDescAndFn>,
886 // The name of the test displayed to the user, separated by `::`.
888 // In tests from Rust source, this is the path to the item
889 // e.g., `["std", "vec", "Vec", "push"]`.
891 // In tests from a markdown file, this is the titles of all headers (h1~h6)
892 // of the sections that contain the code block, e.g., if the markdown file is
905 // the `names` vector of that test will be `["Title", "Subtitle"]`.
908 rustdoc_options: RustdocOptions,
910 enable_per_target_ignores: bool,
912 opts: GlobalTestOptions,
914 source_map: Option<Lrc<SourceMap>>,
915 filename: Option<PathBuf>,
916 visited_tests: FxHashMap<(String, usize), usize>,
917 unused_extern_reports: Arc<Mutex<Vec<UnusedExterns>>>,
918 compiling_test_count: AtomicUsize,
924 rustdoc_options: RustdocOptions,
926 opts: GlobalTestOptions,
927 source_map: Option<Lrc<SourceMap>>,
928 filename: Option<PathBuf>,
929 enable_per_target_ignores: bool,
936 enable_per_target_ignores,
942 visited_tests: FxHashMap::default(),
943 unused_extern_reports: Default::default(),
944 compiling_test_count: AtomicUsize::new(0),
948 fn generate_name(&self, line: usize, filename: &FileName) -> String {
949 let mut item_path = self.names.join("::");
950 item_path.retain(|c| c != ' ');
951 if !item_path.is_empty() {
954 format!("{} - {}(line {})", filename.prefer_local(), item_path, line)
957 pub(crate) fn set_position(&mut self, position: Span) {
958 self.position = position;
961 fn get_filename(&self) -> FileName {
962 if let Some(ref source_map) = self.source_map {
963 let filename = source_map.span_to_filename(self.position);
964 if let FileName::Real(ref filename) = filename {
965 if let Ok(cur_dir) = env::current_dir() {
966 if let Some(local_path) = filename.local_path() {
967 if let Ok(path) = local_path.strip_prefix(&cur_dir) {
968 return path.to_owned().into();
974 } else if let Some(ref filename) = self.filename {
975 filename.clone().into()
977 FileName::Custom("input".to_owned())
982 impl Tester for Collector {
983 fn add_test(&mut self, test: String, config: LangString, line: usize) {
984 let filename = self.get_filename();
985 let name = self.generate_name(line, &filename);
986 let crate_name = self.crate_name.clone();
987 let opts = self.opts.clone();
988 let edition = config.edition.unwrap_or(self.rustdoc_options.edition);
989 let rustdoc_options = self.rustdoc_options.clone();
990 let runtool = self.rustdoc_options.runtool.clone();
991 let runtool_args = self.rustdoc_options.runtool_args.clone();
992 let target = self.rustdoc_options.target.clone();
993 let target_str = target.to_string();
994 let unused_externs = self.unused_extern_reports.clone();
995 let no_run = config.no_run || rustdoc_options.no_run;
996 if !config.compile_fail {
997 self.compiling_test_count.fetch_add(1, Ordering::SeqCst);
1000 let path = match &filename {
1001 FileName::Real(path) => {
1002 if let Some(local_path) = path.local_path() {
1003 local_path.to_path_buf()
1005 // Somehow we got the filename from the metadata of another crate, should never happen
1006 unreachable!("doctest from a different crate");
1009 _ => PathBuf::from(r"doctest.rs"),
1012 // For example `module/file.rs` would become `module_file_rs`
1017 .map(|c| if c.is_ascii_alphanumeric() { c } else { '_' })
1018 .collect::<String>();
1019 let test_id = format!(
1020 "{file}_{line}_{number}",
1024 // Increases the current test number, if this file already
1025 // exists or it creates a new entry with a test number of 0.
1026 self.visited_tests.entry((file.clone(), line)).and_modify(|v| *v += 1).or_insert(0)
1029 let outdir = if let Some(mut path) = rustdoc_options.persist_doctests.clone() {
1030 path.push(&test_id);
1032 if let Err(err) = std::fs::create_dir_all(&path) {
1033 eprintln!("Couldn't create directory for doctest executables: {}", err);
1034 panic::resume_unwind(Box::new(()));
1037 DirState::Perm(path)
1040 TempFileBuilder::new()
1041 .prefix("rustdoctest")
1043 .expect("rustdoc needs a tempdir"),
1047 debug!("creating test {name}: {test}");
1048 self.tests.push(test::TestDescAndFn {
1049 desc: test::TestDesc {
1050 name: test::DynTestName(name),
1051 ignore: match config.ignore {
1052 Ignore::All => true,
1053 Ignore::None => false,
1054 Ignore::Some(ref ignores) => ignores.iter().any(|s| target_str.contains(s)),
1056 ignore_message: None,
1057 // compiler failures are test failures
1058 should_panic: test::ShouldPanic::No,
1059 compile_fail: config.compile_fail,
1061 test_type: test::TestType::DocTest,
1063 testfn: test::DynTestFn(Box::new(move || {
1064 let report_unused_externs = |uext| {
1065 unused_externs.lock().unwrap().push(uext);
1082 report_unused_externs,
1085 if let Err(err) = res {
1087 TestFailure::CompileError => {
1088 eprint!("Couldn't compile the test.");
1090 TestFailure::UnexpectedCompilePass => {
1091 eprint!("Test compiled successfully, but it's marked `compile_fail`.");
1093 TestFailure::UnexpectedRunPass => {
1094 eprint!("Test executable succeeded, but it's marked `should_panic`.");
1096 TestFailure::MissingErrorCodes(codes) => {
1097 eprint!("Some expected error codes were not found: {:?}", codes);
1099 TestFailure::ExecutionError(err) => {
1100 eprint!("Couldn't run the test: {err}");
1101 if err.kind() == io::ErrorKind::PermissionDenied {
1102 eprint!(" - maybe your tempdir is mounted with noexec?");
1105 TestFailure::ExecutionFailure(out) => {
1106 eprintln!("Test executable failed ({reason}).", reason = out.status);
1108 // FIXME(#12309): An unfortunate side-effect of capturing the test
1109 // executable's output is that the relative ordering between the test's
1110 // stdout and stderr is lost. However, this is better than the
1111 // alternative: if the test executable inherited the parent's I/O
1112 // handles the output wouldn't be captured at all, even on success.
1114 // The ordering could be preserved if the test process' stderr was
1115 // redirected to stdout, but that functionality does not exist in the
1116 // standard library, so it may not be portable enough.
1117 let stdout = str::from_utf8(&out.stdout).unwrap_or_default();
1118 let stderr = str::from_utf8(&out.stderr).unwrap_or_default();
1120 if !stdout.is_empty() || !stderr.is_empty() {
1123 if !stdout.is_empty() {
1124 eprintln!("stdout:\n{stdout}");
1127 if !stderr.is_empty() {
1128 eprintln!("stderr:\n{stderr}");
1134 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);