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::{Target, 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 collector = queries.global_ctxt()?.enter(|tcx| {
119 let crate_attrs = tcx.hir().attrs(CRATE_HIR_ID);
121 let opts = scrape_test_config(crate_attrs);
122 let enable_per_target_ignores = options.enable_per_target_ignores;
123 let mut collector = Collector::new(
124 tcx.crate_name(LOCAL_CRATE).to_string(),
128 Some(compiler.session().parse_sess.clone_source_map()),
130 enable_per_target_ignores,
133 let mut hir_collector = HirCollector {
134 sess: compiler.session(),
135 collector: &mut collector,
137 codes: ErrorCodes::from(
138 compiler.session().opts.unstable_features.is_nightly_build(),
142 hir_collector.visit_testable(
145 tcx.hir().span(CRATE_HIR_ID),
146 |this| tcx.hir().walk_toplevel_module(this),
151 if compiler.session().diagnostic().has_errors_or_lint_errors().is_some() {
155 let unused_extern_reports = collector.unused_extern_reports.clone();
156 let compiling_test_count = collector.compiling_test_count.load(Ordering::SeqCst);
157 Ok((collector.tests, unused_extern_reports, compiling_test_count))
161 run_tests(test_args, nocapture, tests);
163 // Collect and warn about unused externs, but only if we've gotten
164 // reports for each doctest
165 if json_unused_externs.is_enabled() {
166 let unused_extern_reports: Vec<_> =
167 std::mem::take(&mut unused_extern_reports.lock().unwrap());
168 if unused_extern_reports.len() == compiling_test_count {
169 let extern_names = externs.iter().map(|(name, _)| name).collect::<FxHashSet<&String>>();
170 let mut unused_extern_names = unused_extern_reports
172 .map(|uexts| uexts.unused_extern_names.iter().collect::<FxHashSet<&String>>())
173 .fold(extern_names, |uextsa, uextsb| {
174 uextsa.intersection(&uextsb).copied().collect::<FxHashSet<&String>>()
177 .map(|v| (*v).clone())
178 .collect::<Vec<String>>();
179 unused_extern_names.sort();
180 // Take the most severe lint level
181 let lint_level = unused_extern_reports
183 .map(|uexts| uexts.lint_level.as_str())
184 .max_by_key(|v| match *v {
188 // The allow lint level is not expected,
189 // as if allow is specified, no message
191 v => unreachable!("Invalid lint level '{}'", v),
195 let uext = UnusedExterns { lint_level, unused_extern_names };
196 let unused_extern_json = serde_json::to_string(&uext).unwrap();
197 eprintln!("{unused_extern_json}");
204 pub(crate) fn run_tests(
205 mut test_args: Vec<String>,
207 mut tests: Vec<test::TestDescAndFn>,
209 test_args.insert(0, "rustdoctest".to_string());
211 test_args.push("--nocapture".to_string());
213 tests.sort_by(|a, b| a.desc.name.as_slice().cmp(&b.desc.name.as_slice()));
214 test::test_main(&test_args, tests, None);
217 // Look for `#![doc(test(no_crate_inject))]`, used by crates in the std facade.
218 fn scrape_test_config(attrs: &[ast::Attribute]) -> GlobalTestOptions {
219 use rustc_ast_pretty::pprust;
221 let mut opts = GlobalTestOptions { no_crate_inject: false, attrs: Vec::new() };
223 let test_attrs: Vec<_> = attrs
225 .filter(|a| a.has_name(sym::doc))
226 .flat_map(|a| a.meta_item_list().unwrap_or_default())
227 .filter(|a| a.has_name(sym::test))
229 let attrs = test_attrs.iter().flat_map(|a| a.meta_item_list().unwrap_or(&[]));
232 if attr.has_name(sym::no_crate_inject) {
233 opts.no_crate_inject = true;
235 if attr.has_name(sym::attr) {
236 if let Some(l) = attr.meta_item_list() {
238 opts.attrs.push(pprust::meta_list_item_to_string(item));
247 /// Documentation test failure modes.
249 /// The test failed to compile.
251 /// The test is marked `compile_fail` but compiled successfully.
252 UnexpectedCompilePass,
253 /// The test failed to compile (as expected) but the compiler output did not contain all
254 /// expected error codes.
255 MissingErrorCodes(Vec<String>),
256 /// The test binary was unable to be executed.
257 ExecutionError(io::Error),
258 /// The test binary exited with a non-zero exit code.
260 /// This typically means an assertion in the test failed or another form of panic occurred.
261 ExecutionFailure(process::Output),
262 /// The test is marked `should_panic` but the test binary executed successfully.
267 Temp(tempfile::TempDir),
272 fn path(&self) -> &std::path::Path {
274 DirState::Temp(t) => t.path(),
275 DirState::Perm(p) => p.as_path(),
280 // NOTE: Keep this in sync with the equivalent structs in rustc
282 // We could unify this struct the one in rustc but they have different
283 // ownership semantics, so doing so would create wasteful allocations.
284 #[derive(serde::Serialize, serde::Deserialize)]
285 struct UnusedExterns {
286 /// Lint level of the unused_crate_dependencies lint
288 /// List of unused externs by their names.
289 unused_extern_names: Vec<String>,
292 fn add_exe_suffix(input: String, target: &TargetTriple) -> String {
293 let exe_suffix = match target {
294 TargetTriple::TargetTriple(_) => Target::expect_builtin(target).options.exe_suffix,
295 TargetTriple::TargetJson { contents, .. } => {
296 Target::from_json(contents.parse().unwrap()).unwrap().0.options.exe_suffix
306 rustdoc_options: RustdocOptions,
307 mut lang_string: LangString,
309 runtool: Option<String>,
310 runtool_args: Vec<String>,
311 target: TargetTriple,
312 opts: &GlobalTestOptions,
317 report_unused_externs: impl Fn(UnusedExterns),
318 ) -> Result<(), TestFailure> {
319 let (test, line_offset, supports_color) =
320 make_test(test, Some(crate_name), lang_string.test_harness, opts, edition, Some(test_id));
322 // Make sure we emit well-formed executable names for our target.
323 let rust_out = add_exe_suffix("rust_out".to_owned(), &target);
324 let output_file = outdir.path().join(rust_out);
326 let rustc_binary = rustdoc_options
329 .unwrap_or_else(|| rustc_interface::util::rustc_path().expect("found rustc"));
330 let mut compiler = Command::new(&rustc_binary);
331 compiler.arg("--crate-type").arg("bin");
332 for cfg in &rustdoc_options.cfgs {
333 compiler.arg("--cfg").arg(&cfg);
335 if !rustdoc_options.check_cfgs.is_empty() {
336 compiler.arg("-Z").arg("unstable-options");
337 for check_cfg in &rustdoc_options.check_cfgs {
338 compiler.arg("--check-cfg").arg(&check_cfg);
341 if let Some(sysroot) = rustdoc_options.maybe_sysroot {
342 compiler.arg("--sysroot").arg(sysroot);
344 compiler.arg("--edition").arg(&edition.to_string());
345 compiler.env("UNSTABLE_RUSTDOC_TEST_PATH", path);
346 compiler.env("UNSTABLE_RUSTDOC_TEST_LINE", format!("{}", line as isize - line_offset as isize));
347 compiler.arg("-o").arg(&output_file);
348 if lang_string.test_harness {
349 compiler.arg("--test");
351 if rustdoc_options.json_unused_externs.is_enabled() && !lang_string.compile_fail {
352 compiler.arg("--error-format=json");
353 compiler.arg("--json").arg("unused-externs");
354 compiler.arg("-Z").arg("unstable-options");
355 compiler.arg("-W").arg("unused_crate_dependencies");
357 for lib_str in &rustdoc_options.lib_strs {
358 compiler.arg("-L").arg(&lib_str);
360 for extern_str in &rustdoc_options.extern_strs {
361 compiler.arg("--extern").arg(&extern_str);
363 compiler.arg("-Ccodegen-units=1");
364 for codegen_options_str in &rustdoc_options.codegen_options_strs {
365 compiler.arg("-C").arg(&codegen_options_str);
367 for unstable_option_str in &rustdoc_options.unstable_opts_strs {
368 compiler.arg("-Z").arg(&unstable_option_str);
370 if no_run && !lang_string.compile_fail && rustdoc_options.persist_doctests.is_none() {
371 compiler.arg("--emit=metadata");
373 compiler.arg("--target").arg(match target {
374 TargetTriple::TargetTriple(s) => s,
375 TargetTriple::TargetJson { path_for_rustdoc, .. } => {
376 path_for_rustdoc.to_str().expect("target path must be valid unicode").to_string()
379 if let ErrorOutputType::HumanReadable(kind) = rustdoc_options.error_format {
380 let (short, color_config) = kind.unzip();
383 compiler.arg("--error-format").arg("short");
387 ColorConfig::Never => {
388 compiler.arg("--color").arg("never");
390 ColorConfig::Always => {
391 compiler.arg("--color").arg("always");
393 ColorConfig::Auto => {
394 compiler.arg("--color").arg(if supports_color { "always" } else { "never" });
400 compiler.stdin(Stdio::piped());
401 compiler.stderr(Stdio::piped());
403 let mut child = compiler.spawn().expect("Failed to spawn rustc process");
405 let stdin = child.stdin.as_mut().expect("Failed to open stdin");
406 stdin.write_all(test.as_bytes()).expect("could write out test sources");
408 let output = child.wait_with_output().expect("Failed to read stdout");
410 struct Bomb<'a>(&'a str);
411 impl Drop for Bomb<'_> {
413 eprint!("{}", self.0);
416 let mut out = str::from_utf8(&output.stderr)
420 if let Ok(uext) = serde_json::from_str::<UnusedExterns>(l) {
421 report_unused_externs(uext);
427 .intersperse_with(|| "\n")
428 .collect::<String>();
430 // Add a \n to the end to properly terminate the last line,
431 // but only if there was output to be printed
436 let _bomb = Bomb(&out);
437 match (output.status.success(), lang_string.compile_fail) {
439 return Err(TestFailure::UnexpectedCompilePass);
443 if !lang_string.error_codes.is_empty() {
444 // We used to check if the output contained "error[{}]: " but since we added the
445 // colored output, we can't anymore because of the color escape characters before
447 lang_string.error_codes.retain(|err| !out.contains(&format!("error[{err}]")));
449 if !lang_string.error_codes.is_empty() {
450 return Err(TestFailure::MissingErrorCodes(lang_string.error_codes));
455 return Err(TestFailure::CompileError);
466 if let Some(tool) = runtool {
467 cmd = Command::new(tool);
468 cmd.args(runtool_args);
469 cmd.arg(output_file);
471 cmd = Command::new(output_file);
473 if let Some(run_directory) = rustdoc_options.test_run_directory {
474 cmd.current_dir(run_directory);
477 let result = if rustdoc_options.nocapture {
478 cmd.status().map(|status| process::Output {
487 Err(e) => return Err(TestFailure::ExecutionError(e)),
489 if lang_string.should_panic && out.status.success() {
490 return Err(TestFailure::UnexpectedRunPass);
491 } else if !lang_string.should_panic && !out.status.success() {
492 return Err(TestFailure::ExecutionFailure(out));
500 /// Transforms a test into code that can be compiled into a Rust binary, and returns the number of
501 /// lines before the test code begins as well as if the output stream supports colors or not.
502 pub(crate) fn make_test(
504 crate_name: Option<&str>,
505 dont_insert_main: bool,
506 opts: &GlobalTestOptions,
508 test_id: Option<&str>,
509 ) -> (String, usize, bool) {
510 let (crate_attrs, everything_else, crates) = partition_source(s, edition);
511 let everything_else = everything_else.trim();
512 let mut line_offset = 0;
513 let mut prog = String::new();
514 let mut supports_color = false;
516 if opts.attrs.is_empty() {
517 // If there aren't any attributes supplied by #![doc(test(attr(...)))], then allow some
518 // lints that are commonly triggered in doctests. The crate-level test attributes are
519 // commonly used to make tests fail in case they trigger warnings, so having this there in
520 // that case may cause some tests to pass when they shouldn't have.
521 prog.push_str("#![allow(unused)]\n");
525 // Next, any attributes that came from the crate root via #![doc(test(attr(...)))].
526 for attr in &opts.attrs {
527 prog.push_str(&format!("#![{attr}]\n"));
531 // Now push any outer attributes from the example, assuming they
532 // are intended to be crate attributes.
533 prog.push_str(&crate_attrs);
534 prog.push_str(&crates);
536 // Uses librustc_ast to parse the doctest and find if there's a main fn and the extern
537 // crate already is included.
538 let result = rustc_driver::catch_fatal_errors(|| {
539 rustc_span::create_session_if_not_set_then(edition, |_| {
540 use rustc_errors::emitter::{Emitter, EmitterWriter};
541 use rustc_errors::Handler;
542 use rustc_parse::parser::ForceCollect;
543 use rustc_span::source_map::FilePathMapping;
545 let filename = FileName::anon_source_code(s);
546 let source = crates + everything_else;
548 // Any errors in parsing should also appear when the doctest is compiled for real, so just
549 // send all the errors that librustc_ast emits directly into a `Sink` instead of stderr.
550 let sm = Lrc::new(SourceMap::new(FilePathMapping::empty()));
551 let fallback_bundle =
552 rustc_errors::fallback_fluent_bundle(rustc_errors::DEFAULT_LOCALE_RESOURCES, false);
553 supports_color = EmitterWriter::stderr(
557 fallback_bundle.clone(),
566 let emitter = EmitterWriter::new(
567 Box::new(io::sink()),
579 // FIXME(misdreavus): pass `-Z treat-err-as-bug` to the doctest parser
580 let handler = Handler::with_emitter(false, None, Box::new(emitter));
581 let sess = ParseSess::with_span_handler(handler, sm);
583 let mut found_main = false;
584 let mut found_extern_crate = crate_name.is_none();
585 let mut found_macro = false;
587 let mut parser = match maybe_new_parser_from_source_str(&sess, filename, source) {
591 return (found_main, found_extern_crate, found_macro);
596 match parser.parse_item(ForceCollect::No) {
599 if let ast::ItemKind::Fn(..) = item.kind {
600 if item.ident.name == sym::main {
606 if !found_extern_crate {
607 if let ast::ItemKind::ExternCrate(original) = item.kind {
608 // This code will never be reached if `crate_name` is none because
609 // `found_extern_crate` is initialized to `true` if it is none.
610 let crate_name = crate_name.unwrap();
613 Some(name) => found_extern_crate = name.as_str() == crate_name,
614 None => found_extern_crate = item.ident.as_str() == crate_name,
620 if let ast::ItemKind::MacCall(..) = item.kind {
625 if found_main && found_extern_crate {
636 // The supplied slice is only used for diagnostics,
637 // which are swallowed here anyway.
638 parser.maybe_consume_incorrect_semicolon(&[]);
641 // Reset errors so that they won't be reported as compiler bugs when dropping the
642 // handler. Any errors in the tests will be reported when the test file is compiled,
643 // Note that we still need to cancel the errors above otherwise `DiagnosticBuilder`
644 // will panic on drop.
645 sess.span_diagnostic.reset_err_count();
647 (found_main, found_extern_crate, found_macro)
650 let Ok((already_has_main, already_has_extern_crate, found_macro)) = result
652 // If the parser panicked due to a fatal error, pass the test code through unchanged.
653 // The error will be reported during compilation.
654 return (s.to_owned(), 0, false);
657 // If a doctest's `fn main` is being masked by a wrapper macro, the parsing loop above won't
658 // see it. In that case, run the old text-based scan to see if they at least have a main
659 // function written inside a macro invocation. See
660 // https://github.com/rust-lang/rust/issues/56898
661 let already_has_main = if found_macro && !already_has_main {
664 let comment = line.find("//");
665 if let Some(comment_begins) = comment { &line[0..comment_begins] } else { line }
667 .any(|code| code.contains("fn main"))
672 // Don't inject `extern crate std` because it's already injected by the
674 if !already_has_extern_crate && !opts.no_crate_inject && crate_name != Some("std") {
675 if let Some(crate_name) = crate_name {
676 // Don't inject `extern crate` if the crate is never used.
677 // NOTE: this is terribly inaccurate because it doesn't actually
678 // parse the source, but only has false positives, not false
680 if s.contains(crate_name) {
681 prog.push_str(&format!("extern crate r#{crate_name};\n"));
687 // FIXME: This code cannot yet handle no_std test cases yet
688 if dont_insert_main || already_has_main || prog.contains("![no_std]") {
689 prog.push_str(everything_else);
691 let returns_result = everything_else.trim_end().ends_with("(())");
692 // Give each doctest main function a unique name.
693 // This is for example needed for the tooling around `-C instrument-coverage`.
694 let inner_fn_name = if let Some(test_id) = test_id {
695 format!("_doctest_main_{test_id}")
699 let inner_attr = if test_id.is_some() { "#[allow(non_snake_case)] " } else { "" };
700 let (main_pre, main_post) = if returns_result {
703 "fn main() {{ {inner_attr}fn {inner_fn_name}() -> Result<(), impl core::fmt::Debug> {{\n",
705 format!("\n}} {inner_fn_name}().unwrap() }}"),
707 } else if test_id.is_some() {
709 format!("fn main() {{ {inner_attr}fn {inner_fn_name}() {{\n",),
710 format!("\n}} {inner_fn_name}() }}"),
713 ("fn main() {\n".into(), "\n}".into())
715 // Note on newlines: We insert a line/newline *before*, and *after*
716 // the doctest and adjust the `line_offset` accordingly.
717 // In the case of `-C instrument-coverage`, this means that the generated
718 // inner `main` function spans from the doctest opening codeblock to the
719 // closing one. For example
720 // /// ``` <- start of the inner main
721 // /// <- code under doctest
722 // /// ``` <- end of the inner main
725 prog.extend([&main_pre, everything_else, &main_post].iter().cloned());
728 debug!("final doctest:\n{prog}");
730 (prog, line_offset, supports_color)
733 fn check_if_attr_is_complete(source: &str, edition: Edition) -> bool {
734 if source.is_empty() {
735 // Empty content so nothing to check in here...
738 rustc_driver::catch_fatal_errors(|| {
739 rustc_span::create_session_if_not_set_then(edition, |_| {
740 use rustc_errors::emitter::EmitterWriter;
741 use rustc_errors::Handler;
742 use rustc_span::source_map::FilePathMapping;
744 let filename = FileName::anon_source_code(source);
745 // Any errors in parsing should also appear when the doctest is compiled for real, so just
746 // send all the errors that librustc_ast emits directly into a `Sink` instead of stderr.
747 let sm = Lrc::new(SourceMap::new(FilePathMapping::empty()));
748 let fallback_bundle =
749 rustc_errors::fallback_fluent_bundle(rustc_errors::DEFAULT_LOCALE_RESOURCES, false);
751 let emitter = EmitterWriter::new(
752 Box::new(io::sink()),
764 let handler = Handler::with_emitter(false, None, Box::new(emitter));
765 let sess = ParseSess::with_span_handler(handler, sm);
767 match maybe_new_parser_from_source_str(&sess, filename, source.to_owned()) {
770 debug!("Cannot build a parser to check mod attr so skipping...");
774 // If a parsing error happened, it's very likely that the attribute is incomplete.
775 if let Err(e) = parser.parse_attribute(InnerAttrPolicy::Permitted) {
779 // We now check if there is an unclosed delimiter for the attribute. To do so, we look at
780 // the `unclosed_delims` and see if the opening square bracket was closed.
785 unclosed.unclosed_span.map(|s| s.lo()).unwrap_or(BytePos(0)) != BytePos(2)
793 fn partition_source(s: &str, edition: Edition) -> (String, String, String) {
794 #[derive(Copy, Clone, PartialEq)]
795 enum PartitionState {
800 let mut state = PartitionState::Attrs;
801 let mut before = String::new();
802 let mut crates = String::new();
803 let mut after = String::new();
805 let mut mod_attr_pending = String::new();
807 for line in s.lines() {
808 let trimline = line.trim();
810 // FIXME(misdreavus): if a doc comment is placed on an extern crate statement, it will be
811 // shunted into "everything else"
813 PartitionState::Attrs => {
814 state = if trimline.starts_with("#![") {
815 if !check_if_attr_is_complete(line, edition) {
816 mod_attr_pending = line.to_owned();
818 mod_attr_pending.clear();
820 PartitionState::Attrs
821 } else if trimline.chars().all(|c| c.is_whitespace())
822 || (trimline.starts_with("//") && !trimline.starts_with("///"))
824 PartitionState::Attrs
825 } else if trimline.starts_with("extern crate")
826 || trimline.starts_with("#[macro_use] extern crate")
828 PartitionState::Crates
830 // First we check if the previous attribute was "complete"...
831 if !mod_attr_pending.is_empty() {
832 // If not, then we append the new line into the pending attribute to check
833 // if this time it's complete...
834 mod_attr_pending.push_str(line);
835 if !trimline.is_empty()
836 && check_if_attr_is_complete(&mod_attr_pending, edition)
838 // If it's complete, then we can clear the pending content.
839 mod_attr_pending.clear();
841 // In any case, this is considered as `PartitionState::Attrs` so it's
842 // prepended before rustdoc's inserts.
843 PartitionState::Attrs
845 PartitionState::Other
849 PartitionState::Crates => {
850 state = if trimline.starts_with("extern crate")
851 || trimline.starts_with("#[macro_use] extern crate")
852 || trimline.chars().all(|c| c.is_whitespace())
853 || (trimline.starts_with("//") && !trimline.starts_with("///"))
855 PartitionState::Crates
857 PartitionState::Other
860 PartitionState::Other => {}
864 PartitionState::Attrs => {
865 before.push_str(line);
868 PartitionState::Crates => {
869 crates.push_str(line);
872 PartitionState::Other => {
873 after.push_str(line);
879 debug!("before:\n{before}");
880 debug!("crates:\n{crates}");
881 debug!("after:\n{after}");
883 (before, after, crates)
886 pub(crate) trait Tester {
887 fn add_test(&mut self, test: String, config: LangString, line: usize);
888 fn get_line(&self) -> usize {
891 fn register_header(&mut self, _name: &str, _level: u32) {}
894 pub(crate) struct Collector {
895 pub(crate) tests: Vec<test::TestDescAndFn>,
897 // The name of the test displayed to the user, separated by `::`.
899 // In tests from Rust source, this is the path to the item
900 // e.g., `["std", "vec", "Vec", "push"]`.
902 // In tests from a markdown file, this is the titles of all headers (h1~h6)
903 // of the sections that contain the code block, e.g., if the markdown file is
916 // the `names` vector of that test will be `["Title", "Subtitle"]`.
919 rustdoc_options: RustdocOptions,
921 enable_per_target_ignores: bool,
923 opts: GlobalTestOptions,
925 source_map: Option<Lrc<SourceMap>>,
926 filename: Option<PathBuf>,
927 visited_tests: FxHashMap<(String, usize), usize>,
928 unused_extern_reports: Arc<Mutex<Vec<UnusedExterns>>>,
929 compiling_test_count: AtomicUsize,
935 rustdoc_options: RustdocOptions,
937 opts: GlobalTestOptions,
938 source_map: Option<Lrc<SourceMap>>,
939 filename: Option<PathBuf>,
940 enable_per_target_ignores: bool,
947 enable_per_target_ignores,
953 visited_tests: FxHashMap::default(),
954 unused_extern_reports: Default::default(),
955 compiling_test_count: AtomicUsize::new(0),
959 fn generate_name(&self, line: usize, filename: &FileName) -> String {
960 let mut item_path = self.names.join("::");
961 item_path.retain(|c| c != ' ');
962 if !item_path.is_empty() {
965 format!("{} - {}(line {})", filename.prefer_local(), item_path, line)
968 pub(crate) fn set_position(&mut self, position: Span) {
969 self.position = position;
972 fn get_filename(&self) -> FileName {
973 if let Some(ref source_map) = self.source_map {
974 let filename = source_map.span_to_filename(self.position);
975 if let FileName::Real(ref filename) = filename {
976 if let Ok(cur_dir) = env::current_dir() {
977 if let Some(local_path) = filename.local_path() {
978 if let Ok(path) = local_path.strip_prefix(&cur_dir) {
979 return path.to_owned().into();
985 } else if let Some(ref filename) = self.filename {
986 filename.clone().into()
988 FileName::Custom("input".to_owned())
993 impl Tester for Collector {
994 fn add_test(&mut self, test: String, config: LangString, line: usize) {
995 let filename = self.get_filename();
996 let name = self.generate_name(line, &filename);
997 let crate_name = self.crate_name.clone();
998 let opts = self.opts.clone();
999 let edition = config.edition.unwrap_or(self.rustdoc_options.edition);
1000 let rustdoc_options = self.rustdoc_options.clone();
1001 let runtool = self.rustdoc_options.runtool.clone();
1002 let runtool_args = self.rustdoc_options.runtool_args.clone();
1003 let target = self.rustdoc_options.target.clone();
1004 let target_str = target.to_string();
1005 let unused_externs = self.unused_extern_reports.clone();
1006 let no_run = config.no_run || rustdoc_options.no_run;
1007 if !config.compile_fail {
1008 self.compiling_test_count.fetch_add(1, Ordering::SeqCst);
1011 let path = match &filename {
1012 FileName::Real(path) => {
1013 if let Some(local_path) = path.local_path() {
1014 local_path.to_path_buf()
1016 // Somehow we got the filename from the metadata of another crate, should never happen
1017 unreachable!("doctest from a different crate");
1020 _ => PathBuf::from(r"doctest.rs"),
1023 // For example `module/file.rs` would become `module_file_rs`
1028 .map(|c| if c.is_ascii_alphanumeric() { c } else { '_' })
1029 .collect::<String>();
1030 let test_id = format!(
1031 "{file}_{line}_{number}",
1035 // Increases the current test number, if this file already
1036 // exists or it creates a new entry with a test number of 0.
1037 self.visited_tests.entry((file.clone(), line)).and_modify(|v| *v += 1).or_insert(0)
1040 let outdir = if let Some(mut path) = rustdoc_options.persist_doctests.clone() {
1041 path.push(&test_id);
1043 if let Err(err) = std::fs::create_dir_all(&path) {
1044 eprintln!("Couldn't create directory for doctest executables: {}", err);
1045 panic::resume_unwind(Box::new(()));
1048 DirState::Perm(path)
1051 TempFileBuilder::new()
1052 .prefix("rustdoctest")
1054 .expect("rustdoc needs a tempdir"),
1058 debug!("creating test {name}: {test}");
1059 self.tests.push(test::TestDescAndFn {
1060 desc: test::TestDesc {
1061 name: test::DynTestName(name),
1062 ignore: match config.ignore {
1063 Ignore::All => true,
1064 Ignore::None => false,
1065 Ignore::Some(ref ignores) => ignores.iter().any(|s| target_str.contains(s)),
1067 ignore_message: None,
1068 // compiler failures are test failures
1069 should_panic: test::ShouldPanic::No,
1070 compile_fail: config.compile_fail,
1072 test_type: test::TestType::DocTest,
1074 testfn: test::DynTestFn(Box::new(move || {
1075 let report_unused_externs = |uext| {
1076 unused_externs.lock().unwrap().push(uext);
1093 report_unused_externs,
1096 if let Err(err) = res {
1098 TestFailure::CompileError => {
1099 eprint!("Couldn't compile the test.");
1101 TestFailure::UnexpectedCompilePass => {
1102 eprint!("Test compiled successfully, but it's marked `compile_fail`.");
1104 TestFailure::UnexpectedRunPass => {
1105 eprint!("Test executable succeeded, but it's marked `should_panic`.");
1107 TestFailure::MissingErrorCodes(codes) => {
1108 eprint!("Some expected error codes were not found: {:?}", codes);
1110 TestFailure::ExecutionError(err) => {
1111 eprint!("Couldn't run the test: {err}");
1112 if err.kind() == io::ErrorKind::PermissionDenied {
1113 eprint!(" - maybe your tempdir is mounted with noexec?");
1116 TestFailure::ExecutionFailure(out) => {
1117 eprintln!("Test executable failed ({reason}).", reason = out.status);
1119 // FIXME(#12309): An unfortunate side-effect of capturing the test
1120 // executable's output is that the relative ordering between the test's
1121 // stdout and stderr is lost. However, this is better than the
1122 // alternative: if the test executable inherited the parent's I/O
1123 // handles the output wouldn't be captured at all, even on success.
1125 // The ordering could be preserved if the test process' stderr was
1126 // redirected to stdout, but that functionality does not exist in the
1127 // standard library, so it may not be portable enough.
1128 let stdout = str::from_utf8(&out.stdout).unwrap_or_default();
1129 let stderr = str::from_utf8(&out.stderr).unwrap_or_default();
1131 if !stdout.is_empty() || !stderr.is_empty() {
1134 if !stdout.is_empty() {
1135 eprintln!("stdout:\n{stdout}");
1138 if !stderr.is_empty() {
1139 eprintln!("stderr:\n{stderr}");
1145 panic::resume_unwind(Box::new(()));
1152 fn get_line(&self) -> usize {
1153 if let Some(ref source_map) = self.source_map {
1154 let line = self.position.lo().to_usize();
1155 let line = source_map.lookup_char_pos(BytePos(line as u32)).line;
1156 if line > 0 { line - 1 } else { line }
1162 fn register_header(&mut self, name: &str, level: u32) {
1163 if self.use_headers {
1164 // We use these headings as test names, so it's good if
1165 // they're valid identifiers.
1170 if (i == 0 && rustc_lexer::is_id_start(c))
1171 || (i != 0 && rustc_lexer::is_id_continue(c))
1178 .collect::<String>();
1180 // Here we try to efficiently assemble the header titles into the
1181 // test name in the form of `h1::h2::h3::h4::h5::h6`.
1183 // Suppose that originally `self.names` contains `[h1, h2, h3]`...
1184 let level = level as usize;
1185 if level <= self.names.len() {
1186 // ... Consider `level == 2`. All headers in the lower levels
1187 // are irrelevant in this new level. So we should reset
1188 // `self.names` to contain headers until <h2>, and replace that
1189 // slot with the new name: `[h1, name]`.
1190 self.names.truncate(level);
1191 self.names[level - 1] = name;
1193 // ... On the other hand, consider `level == 5`. This means we
1194 // need to extend `self.names` to contain five headers. We fill
1195 // in the missing level (<h4>) with `_`. Thus `self.names` will
1196 // become `[h1, h2, h3, "_", name]`.
1197 if level - 1 > self.names.len() {
1198 self.names.resize(level - 1, "_".to_owned());
1200 self.names.push(name);
1206 struct HirCollector<'a, 'hir, 'tcx> {
1208 collector: &'a mut Collector,
1214 impl<'a, 'hir, 'tcx> HirCollector<'a, 'hir, 'tcx> {
1215 fn visit_testable<F: FnOnce(&mut Self)>(
1222 let ast_attrs = self.tcx.hir().attrs(hir_id);
1223 if let Some(ref cfg) = ast_attrs.cfg(self.tcx, &FxHashSet::default()) {
1224 if !cfg.matches(&self.sess.parse_sess, Some(self.tcx.features())) {
1229 let has_name = !name.is_empty();
1231 self.collector.names.push(name);
1234 // The collapse-docs pass won't combine sugared/raw doc attributes, or included files with
1235 // anything else, this will combine them for us.
1236 let attrs = Attributes::from_ast(ast_attrs);
1237 if let Some(doc) = attrs.collapsed_doc_value() {
1238 // Use the outermost invocation, so that doctest names come from where the docs were written.
1239 let span = ast_attrs
1241 .map(|span| span.ctxt().outer_expn().expansion_cause().unwrap_or(span))
1242 .unwrap_or(DUMMY_SP);
1243 self.collector.set_position(span);
1244 markdown::find_testable_code(
1248 self.collector.enable_per_target_ignores,
1249 Some(&crate::html::markdown::ExtraInfo::new(
1252 span_of_attrs(&attrs).unwrap_or(sp),
1260 self.collector.names.pop();
1265 impl<'a, 'hir, 'tcx> intravisit::Visitor<'hir> for HirCollector<'a, 'hir, 'tcx> {
1266 type NestedFilter = nested_filter::All;
1268 fn nested_visit_map(&mut self) -> Self::Map {
1272 fn visit_item(&mut self, item: &'hir hir::Item<'_>) {
1273 let name = match &item.kind {
1274 hir::ItemKind::Impl(impl_) => {
1275 rustc_hir_pretty::id_to_string(&self.map, impl_.self_ty.hir_id)
1277 _ => item.ident.to_string(),
1280 self.visit_testable(name, item.hir_id(), item.span, |this| {
1281 intravisit::walk_item(this, item);
1285 fn visit_trait_item(&mut self, item: &'hir hir::TraitItem<'_>) {
1286 self.visit_testable(item.ident.to_string(), item.hir_id(), item.span, |this| {
1287 intravisit::walk_trait_item(this, item);
1291 fn visit_impl_item(&mut self, item: &'hir hir::ImplItem<'_>) {
1292 self.visit_testable(item.ident.to_string(), item.hir_id(), item.span, |this| {
1293 intravisit::walk_impl_item(this, item);
1297 fn visit_foreign_item(&mut self, item: &'hir hir::ForeignItem<'_>) {
1298 self.visit_testable(item.ident.to_string(), item.hir_id(), item.span, |this| {
1299 intravisit::walk_foreign_item(this, item);
1303 fn visit_variant(&mut self, v: &'hir hir::Variant<'_>) {
1304 self.visit_testable(v.ident.to_string(), v.hir_id, v.span, |this| {
1305 intravisit::walk_variant(this, v);
1309 fn visit_field_def(&mut self, f: &'hir hir::FieldDef<'_>) {
1310 self.visit_testable(f.ident.to_string(), f.hir_id, f.span, |this| {
1311 intravisit::walk_field_def(this, f);