2 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
3 use rustc_data_structures::sync::Lrc;
4 use rustc_errors::{ColorConfig, ErrorGuaranteed, FatalError};
6 use rustc_hir::def_id::LOCAL_CRATE;
7 use rustc_hir::intravisit;
8 use rustc_hir::{HirId, CRATE_HIR_ID};
9 use rustc_interface::interface;
10 use rustc_middle::hir::map::Map;
11 use rustc_middle::hir::nested_filter;
12 use rustc_middle::ty::TyCtxt;
13 use rustc_parse::maybe_new_parser_from_source_str;
14 use rustc_parse::parser::attr::InnerAttrPolicy;
15 use rustc_session::config::{self, CrateType, ErrorOutputType};
16 use rustc_session::parse::ParseSess;
17 use rustc_session::{lint, DiagnosticOutput, Session};
18 use rustc_span::edition::Edition;
19 use rustc_span::source_map::SourceMap;
20 use rustc_span::symbol::sym;
21 use rustc_span::Symbol;
22 use rustc_span::{BytePos, FileName, Pos, Span, DUMMY_SP};
23 use rustc_target::spec::TargetTriple;
24 use tempfile::Builder as TempFileBuilder;
27 use std::io::{self, Write};
29 use std::path::PathBuf;
30 use std::process::{self, Command, Stdio};
32 use std::sync::atomic::{AtomicUsize, Ordering};
33 use std::sync::{Arc, Mutex};
35 use crate::clean::{types::AttributesExt, Attributes};
36 use crate::config::Options as RustdocOptions;
37 use crate::html::markdown::{self, ErrorCodes, Ignore, LangString};
38 use crate::lint::init_lints;
39 use crate::passes::span_of_attrs;
41 /// Options that apply to all doctests in a crate or Markdown file (for `rustdoc foo.md`).
42 #[derive(Clone, Default)]
43 crate struct GlobalTestOptions {
44 /// Whether to disable the default `extern crate my_crate;` when creating doctests.
45 crate no_crate_inject: bool,
46 /// Additional crate-level attributes to add to doctests.
47 crate attrs: Vec<String>,
50 crate fn run(options: RustdocOptions) -> Result<(), ErrorGuaranteed> {
51 let input = config::Input::File(options.input.clone());
53 let invalid_codeblock_attributes_name = crate::lint::INVALID_CODEBLOCK_ATTRIBUTES.name;
55 // See core::create_config for what's going on here.
56 let allowed_lints = vec![
57 invalid_codeblock_attributes_name.to_owned(),
58 lint::builtin::UNKNOWN_LINTS.name.to_owned(),
59 lint::builtin::RENAMED_AND_REMOVED_LINTS.name.to_owned(),
62 let (lint_opts, lint_caps) = init_lints(allowed_lints, options.lint_opts.clone(), |lint| {
63 if lint.name == invalid_codeblock_attributes_name {
66 Some((lint.name_lower(), lint::Allow))
73 if options.proc_macro_crate { vec![CrateType::ProcMacro] } else { vec![CrateType::Rlib] };
75 let sessopts = config::Options {
76 maybe_sysroot: options.maybe_sysroot.clone(),
77 search_paths: options.libs.clone(),
80 lint_cap: Some(options.lint_cap.unwrap_or(lint::Forbid)),
81 cg: options.codegen_options.clone(),
82 externs: options.externs.clone(),
83 unstable_features: options.render_options.unstable_features,
84 actually_rustdoc: true,
85 edition: options.edition,
86 target_triple: options.target.clone(),
87 crate_name: options.crate_name.clone(),
88 ..config::Options::default()
91 let mut cfgs = options.cfgs.clone();
92 cfgs.push("doc".to_owned());
93 cfgs.push("doctest".to_owned());
94 let config = interface::Config {
96 crate_cfg: interface::parse_cfgspecs(cfgs),
97 crate_check_cfg: interface::parse_check_cfg(options.check_cfgs.clone()),
103 diagnostic_output: DiagnosticOutput::Default,
105 parse_sess_created: None,
106 register_lints: Some(box crate::lint::register_lints),
107 override_queries: None,
108 make_codegen_backend: None,
109 registry: rustc_driver::diagnostics_registry(),
112 let test_args = options.test_args.clone();
113 let nocapture = options.nocapture;
114 let externs = options.externs.clone();
115 let json_unused_externs = options.json_unused_externs;
117 let (tests, unused_extern_reports, compiling_test_count) =
118 interface::run_compiler(config, |compiler| {
119 compiler.enter(|queries| {
120 let mut global_ctxt = queries.global_ctxt()?.take();
122 let collector = global_ctxt.enter(|tcx| {
123 let crate_attrs = tcx.hir().attrs(CRATE_HIR_ID);
125 let opts = scrape_test_config(crate_attrs);
126 let enable_per_target_ignores = options.enable_per_target_ignores;
127 let mut collector = Collector::new(
128 tcx.crate_name(LOCAL_CRATE),
132 Some(compiler.session().parse_sess.clone_source_map()),
134 enable_per_target_ignores,
137 let mut hir_collector = HirCollector {
138 sess: compiler.session(),
139 collector: &mut collector,
141 codes: ErrorCodes::from(
142 compiler.session().opts.unstable_features.is_nightly_build(),
146 hir_collector.visit_testable(
149 tcx.hir().span(CRATE_HIR_ID),
150 |this| tcx.hir().walk_toplevel_module(this),
155 if compiler.session().diagnostic().has_errors_or_lint_errors().is_some() {
159 let unused_extern_reports = collector.unused_extern_reports.clone();
160 let compiling_test_count = collector.compiling_test_count.load(Ordering::SeqCst);
161 let ret: Result<_, ErrorGuaranteed> =
162 Ok((collector.tests, unused_extern_reports, compiling_test_count));
167 run_tests(test_args, nocapture, tests);
169 // Collect and warn about unused externs, but only if we've gotten
170 // reports for each doctest
171 if json_unused_externs.is_enabled() {
172 let unused_extern_reports: Vec<_> =
173 std::mem::take(&mut unused_extern_reports.lock().unwrap());
174 if unused_extern_reports.len() == compiling_test_count {
175 let extern_names = externs.iter().map(|(name, _)| name).collect::<FxHashSet<&String>>();
176 let mut unused_extern_names = unused_extern_reports
178 .map(|uexts| uexts.unused_extern_names.iter().collect::<FxHashSet<&String>>())
179 .fold(extern_names, |uextsa, uextsb| {
180 uextsa.intersection(&uextsb).copied().collect::<FxHashSet<&String>>()
183 .map(|v| (*v).clone())
184 .collect::<Vec<String>>();
185 unused_extern_names.sort();
186 // Take the most severe lint level
187 let lint_level = unused_extern_reports
189 .map(|uexts| uexts.lint_level.as_str())
190 .max_by_key(|v| match *v {
194 // The allow lint level is not expected,
195 // as if allow is specified, no message
197 v => unreachable!("Invalid lint level '{}'", v),
201 let uext = UnusedExterns { lint_level, unused_extern_names };
202 let unused_extern_json = serde_json::to_string(&uext).unwrap();
203 eprintln!("{unused_extern_json}");
210 crate fn run_tests(mut test_args: Vec<String>, nocapture: bool, tests: Vec<test::TestDescAndFn>) {
211 test_args.insert(0, "rustdoctest".to_string());
213 test_args.push("--nocapture".to_string());
215 test::test_main(&test_args, tests, None);
218 // Look for `#![doc(test(no_crate_inject))]`, used by crates in the std facade.
219 fn scrape_test_config(attrs: &[ast::Attribute]) -> GlobalTestOptions {
220 use rustc_ast_pretty::pprust;
222 let mut opts = GlobalTestOptions { no_crate_inject: false, attrs: Vec::new() };
224 let test_attrs: Vec<_> = attrs
226 .filter(|a| a.has_name(sym::doc))
227 .flat_map(|a| a.meta_item_list().unwrap_or_else(Vec::new))
228 .filter(|a| a.has_name(sym::test))
230 let attrs = test_attrs.iter().flat_map(|a| a.meta_item_list().unwrap_or(&[]));
233 if attr.has_name(sym::no_crate_inject) {
234 opts.no_crate_inject = true;
236 if attr.has_name(sym::attr) {
237 if let Some(l) = attr.meta_item_list() {
239 opts.attrs.push(pprust::meta_list_item_to_string(item));
248 /// Documentation test failure modes.
250 /// The test failed to compile.
252 /// The test is marked `compile_fail` but compiled successfully.
253 UnexpectedCompilePass,
254 /// The test failed to compile (as expected) but the compiler output did not contain all
255 /// expected error codes.
256 MissingErrorCodes(Vec<String>),
257 /// The test binary was unable to be executed.
258 ExecutionError(io::Error),
259 /// The test binary exited with a non-zero exit code.
261 /// This typically means an assertion in the test failed or another form of panic occurred.
262 ExecutionFailure(process::Output),
263 /// The test is marked `should_panic` but the test binary executed successfully.
268 Temp(tempfile::TempDir),
273 fn path(&self) -> &std::path::Path {
275 DirState::Temp(t) => t.path(),
276 DirState::Perm(p) => p.as_path(),
281 // NOTE: Keep this in sync with the equivalent structs in rustc
283 // We could unify this struct the one in rustc but they have different
284 // ownership semantics, so doing so would create wasteful allocations.
285 #[derive(serde::Serialize, serde::Deserialize)]
286 struct UnusedExterns {
287 /// Lint level of the unused_crate_dependencies lint
289 /// List of unused externs by their names.
290 unused_extern_names: Vec<String>,
297 rustdoc_options: RustdocOptions,
298 mut lang_string: LangString,
300 runtool: Option<String>,
301 runtool_args: Vec<String>,
302 target: TargetTriple,
303 opts: &GlobalTestOptions,
308 report_unused_externs: impl Fn(UnusedExterns),
309 ) -> Result<(), TestFailure> {
310 let (test, line_offset, supports_color) =
311 make_test(test, Some(crate_name), lang_string.test_harness, opts, edition, Some(test_id));
313 let output_file = outdir.path().join("rust_out");
315 let rustc_binary = rustdoc_options
318 .unwrap_or_else(|| rustc_interface::util::rustc_path().expect("found rustc"));
319 let mut compiler = Command::new(&rustc_binary);
320 compiler.arg("--crate-type").arg("bin");
321 for cfg in &rustdoc_options.cfgs {
322 compiler.arg("--cfg").arg(&cfg);
324 if !rustdoc_options.check_cfgs.is_empty() {
325 compiler.arg("-Z").arg("unstable-options");
326 for check_cfg in &rustdoc_options.check_cfgs {
327 compiler.arg("--check-cfg").arg(&check_cfg);
330 if let Some(sysroot) = rustdoc_options.maybe_sysroot {
331 compiler.arg("--sysroot").arg(sysroot);
333 compiler.arg("--edition").arg(&edition.to_string());
334 compiler.env("UNSTABLE_RUSTDOC_TEST_PATH", path);
335 compiler.env("UNSTABLE_RUSTDOC_TEST_LINE", format!("{}", line as isize - line_offset as isize));
336 compiler.arg("-o").arg(&output_file);
337 if lang_string.test_harness {
338 compiler.arg("--test");
340 if rustdoc_options.json_unused_externs.is_enabled() && !lang_string.compile_fail {
341 compiler.arg("--error-format=json");
342 compiler.arg("--json").arg("unused-externs");
343 compiler.arg("-Z").arg("unstable-options");
344 compiler.arg("-W").arg("unused_crate_dependencies");
346 for lib_str in &rustdoc_options.lib_strs {
347 compiler.arg("-L").arg(&lib_str);
349 for extern_str in &rustdoc_options.extern_strs {
350 compiler.arg("--extern").arg(&extern_str);
352 compiler.arg("-Ccodegen-units=1");
353 for codegen_options_str in &rustdoc_options.codegen_options_strs {
354 compiler.arg("-C").arg(&codegen_options_str);
356 for debugging_option_str in &rustdoc_options.debugging_opts_strs {
357 compiler.arg("-Z").arg(&debugging_option_str);
359 if no_run && !lang_string.compile_fail && rustdoc_options.persist_doctests.is_none() {
360 compiler.arg("--emit=metadata");
362 compiler.arg("--target").arg(match target {
363 TargetTriple::TargetTriple(s) => s,
364 TargetTriple::TargetPath(path) => {
365 path.to_str().expect("target path must be valid unicode").to_string()
368 if let ErrorOutputType::HumanReadable(kind) = rustdoc_options.error_format {
369 let (short, color_config) = kind.unzip();
372 compiler.arg("--error-format").arg("short");
376 ColorConfig::Never => {
377 compiler.arg("--color").arg("never");
379 ColorConfig::Always => {
380 compiler.arg("--color").arg("always");
382 ColorConfig::Auto => {
383 compiler.arg("--color").arg(if supports_color { "always" } else { "never" });
389 compiler.stdin(Stdio::piped());
390 compiler.stderr(Stdio::piped());
392 let mut child = compiler.spawn().expect("Failed to spawn rustc process");
394 let stdin = child.stdin.as_mut().expect("Failed to open stdin");
395 stdin.write_all(test.as_bytes()).expect("could write out test sources");
397 let output = child.wait_with_output().expect("Failed to read stdout");
399 struct Bomb<'a>(&'a str);
400 impl Drop for Bomb<'_> {
402 eprint!("{}", self.0);
405 let mut out = str::from_utf8(&output.stderr)
409 if let Ok(uext) = serde_json::from_str::<UnusedExterns>(l) {
410 report_unused_externs(uext);
416 .intersperse_with(|| "\n")
417 .collect::<String>();
419 // Add a \n to the end to properly terminate the last line,
420 // but only if there was output to be printed
425 let _bomb = Bomb(&out);
426 match (output.status.success(), lang_string.compile_fail) {
428 return Err(TestFailure::UnexpectedCompilePass);
432 if !lang_string.error_codes.is_empty() {
433 // We used to check if the output contained "error[{}]: " but since we added the
434 // colored output, we can't anymore because of the color escape characters before
436 lang_string.error_codes.retain(|err| !out.contains(&format!("error[{err}]")));
438 if !lang_string.error_codes.is_empty() {
439 return Err(TestFailure::MissingErrorCodes(lang_string.error_codes));
444 return Err(TestFailure::CompileError);
455 if let Some(tool) = runtool {
456 cmd = Command::new(tool);
457 cmd.args(runtool_args);
458 cmd.arg(output_file);
460 cmd = Command::new(output_file);
462 if let Some(run_directory) = rustdoc_options.test_run_directory {
463 cmd.current_dir(run_directory);
466 let result = if rustdoc_options.nocapture {
467 cmd.status().map(|status| process::Output {
476 Err(e) => return Err(TestFailure::ExecutionError(e)),
478 if lang_string.should_panic && out.status.success() {
479 return Err(TestFailure::UnexpectedRunPass);
480 } else if !lang_string.should_panic && !out.status.success() {
481 return Err(TestFailure::ExecutionFailure(out));
489 /// Transforms a test into code that can be compiled into a Rust binary, and returns the number of
490 /// lines before the test code begins as well as if the output stream supports colors or not.
493 crate_name: Option<&str>,
494 dont_insert_main: bool,
495 opts: &GlobalTestOptions,
497 test_id: Option<&str>,
498 ) -> (String, usize, bool) {
499 let (crate_attrs, everything_else, crates) = partition_source(s, edition);
500 let everything_else = everything_else.trim();
501 let mut line_offset = 0;
502 let mut prog = String::new();
503 let mut supports_color = false;
505 if opts.attrs.is_empty() {
506 // If there aren't any attributes supplied by #![doc(test(attr(...)))], then allow some
507 // lints that are commonly triggered in doctests. The crate-level test attributes are
508 // commonly used to make tests fail in case they trigger warnings, so having this there in
509 // that case may cause some tests to pass when they shouldn't have.
510 prog.push_str("#![allow(unused)]\n");
514 // Next, any attributes that came from the crate root via #![doc(test(attr(...)))].
515 for attr in &opts.attrs {
516 prog.push_str(&format!("#![{attr}]\n"));
520 // Now push any outer attributes from the example, assuming they
521 // are intended to be crate attributes.
522 prog.push_str(&crate_attrs);
523 prog.push_str(&crates);
525 // Uses librustc_ast to parse the doctest and find if there's a main fn and the extern
526 // crate already is included.
527 let result = rustc_driver::catch_fatal_errors(|| {
528 rustc_span::create_session_if_not_set_then(edition, |_| {
529 use rustc_errors::emitter::{Emitter, EmitterWriter};
530 use rustc_errors::Handler;
531 use rustc_parse::parser::ForceCollect;
532 use rustc_span::source_map::FilePathMapping;
534 let filename = FileName::anon_source_code(s);
535 let source = crates + everything_else;
537 // Any errors in parsing should also appear when the doctest is compiled for real, so just
538 // send all the errors that librustc_ast emits directly into a `Sink` instead of stderr.
539 let sm = Lrc::new(SourceMap::new(FilePathMapping::empty()));
540 let fallback_bundle =
541 rustc_errors::fallback_fluent_bundle(rustc_errors::DEFAULT_LOCALE_RESOURCES, false);
542 supports_color = EmitterWriter::stderr(
546 fallback_bundle.clone(),
554 let emitter = EmitterWriter::new(
566 // FIXME(misdreavus): pass `-Z treat-err-as-bug` to the doctest parser
567 let handler = Handler::with_emitter(false, None, box emitter);
568 let sess = ParseSess::with_span_handler(handler, sm);
570 let mut found_main = false;
571 let mut found_extern_crate = crate_name.is_none();
572 let mut found_macro = false;
574 let mut parser = match maybe_new_parser_from_source_str(&sess, filename, source) {
578 return (found_main, found_extern_crate, found_macro);
583 match parser.parse_item(ForceCollect::No) {
586 if let ast::ItemKind::Fn(..) = item.kind {
587 if item.ident.name == sym::main {
593 if !found_extern_crate {
594 if let ast::ItemKind::ExternCrate(original) = item.kind {
595 // This code will never be reached if `crate_name` is none because
596 // `found_extern_crate` is initialized to `true` if it is none.
597 let crate_name = crate_name.unwrap();
600 Some(name) => found_extern_crate = name.as_str() == crate_name,
601 None => found_extern_crate = item.ident.as_str() == crate_name,
607 if let ast::ItemKind::MacCall(..) = item.kind {
612 if found_main && found_extern_crate {
623 // The supplied slice is only used for diagnostics,
624 // which are swallowed here anyway.
625 parser.maybe_consume_incorrect_semicolon(&[]);
628 // Reset errors so that they won't be reported as compiler bugs when dropping the
629 // handler. Any errors in the tests will be reported when the test file is compiled,
630 // Note that we still need to cancel the errors above otherwise `DiagnosticBuilder`
631 // will panic on drop.
632 sess.span_diagnostic.reset_err_count();
634 (found_main, found_extern_crate, found_macro)
637 let Ok((already_has_main, already_has_extern_crate, found_macro)) = result
639 // If the parser panicked due to a fatal error, pass the test code through unchanged.
640 // The error will be reported during compilation.
641 return (s.to_owned(), 0, false);
644 // If a doctest's `fn main` is being masked by a wrapper macro, the parsing loop above won't
645 // see it. In that case, run the old text-based scan to see if they at least have a main
646 // function written inside a macro invocation. See
647 // https://github.com/rust-lang/rust/issues/56898
648 let already_has_main = if found_macro && !already_has_main {
651 let comment = line.find("//");
652 if let Some(comment_begins) = comment { &line[0..comment_begins] } else { line }
654 .any(|code| code.contains("fn main"))
659 // Don't inject `extern crate std` because it's already injected by the
661 if !already_has_extern_crate && !opts.no_crate_inject && crate_name != Some("std") {
662 if let Some(crate_name) = crate_name {
663 // Don't inject `extern crate` if the crate is never used.
664 // NOTE: this is terribly inaccurate because it doesn't actually
665 // parse the source, but only has false positives, not false
667 if s.contains(crate_name) {
668 prog.push_str(&format!("extern crate r#{crate_name};\n"));
674 // FIXME: This code cannot yet handle no_std test cases yet
675 if dont_insert_main || already_has_main || prog.contains("![no_std]") {
676 prog.push_str(everything_else);
678 let returns_result = everything_else.trim_end().ends_with("(())");
679 // Give each doctest main function a unique name.
680 // This is for example needed for the tooling around `-C instrument-coverage`.
681 let inner_fn_name = if let Some(test_id) = test_id {
682 format!("_doctest_main_{test_id}")
686 let inner_attr = if test_id.is_some() { "#[allow(non_snake_case)] " } else { "" };
687 let (main_pre, main_post) = if returns_result {
690 "fn main() {{ {inner_attr}fn {inner_fn_name}() -> Result<(), impl core::fmt::Debug> {{\n",
692 format!("\n}} {inner_fn_name}().unwrap() }}"),
694 } else if test_id.is_some() {
696 format!("fn main() {{ {inner_attr}fn {inner_fn_name}() {{\n",),
697 format!("\n}} {inner_fn_name}() }}"),
700 ("fn main() {\n".into(), "\n}".into())
702 // Note on newlines: We insert a line/newline *before*, and *after*
703 // the doctest and adjust the `line_offset` accordingly.
704 // In the case of `-C instrument-coverage`, this means that the generated
705 // inner `main` function spans from the doctest opening codeblock to the
706 // closing one. For example
707 // /// ``` <- start of the inner main
708 // /// <- code under doctest
709 // /// ``` <- end of the inner main
712 prog.extend([&main_pre, everything_else, &main_post].iter().cloned());
715 debug!("final doctest:\n{prog}");
717 (prog, line_offset, supports_color)
720 fn check_if_attr_is_complete(source: &str, edition: Edition) -> bool {
721 if source.is_empty() {
722 // Empty content so nothing to check in here...
725 rustc_span::create_session_if_not_set_then(edition, |_| {
726 let filename = FileName::anon_source_code(source);
727 let sess = ParseSess::with_silent_emitter(None);
728 let mut parser = match maybe_new_parser_from_source_str(&sess, filename, source.to_owned())
732 debug!("Cannot build a parser to check mod attr so skipping...");
736 // If a parsing error happened, it's very likely that the attribute is incomplete.
737 if !parser.parse_attribute(InnerAttrPolicy::Permitted).is_ok() {
740 // We now check if there is an unclosed delimiter for the attribute. To do so, we look at
741 // the `unclosed_delims` and see if the opening square bracket was closed.
746 unclosed.unclosed_span.map(|s| s.lo()).unwrap_or(BytePos(0)) != BytePos(2)
752 fn partition_source(s: &str, edition: Edition) -> (String, String, String) {
753 #[derive(Copy, Clone, PartialEq)]
754 enum PartitionState {
759 let mut state = PartitionState::Attrs;
760 let mut before = String::new();
761 let mut crates = String::new();
762 let mut after = String::new();
764 let mut mod_attr_pending = String::new();
766 for line in s.lines() {
767 let trimline = line.trim();
769 // FIXME(misdreavus): if a doc comment is placed on an extern crate statement, it will be
770 // shunted into "everything else"
772 PartitionState::Attrs => {
773 state = if trimline.starts_with("#![") {
774 if !check_if_attr_is_complete(line, edition) {
775 mod_attr_pending = line.to_owned();
777 mod_attr_pending.clear();
779 PartitionState::Attrs
780 } else if trimline.chars().all(|c| c.is_whitespace())
781 || (trimline.starts_with("//") && !trimline.starts_with("///"))
783 PartitionState::Attrs
784 } else if trimline.starts_with("extern crate")
785 || trimline.starts_with("#[macro_use] extern crate")
787 PartitionState::Crates
789 // First we check if the previous attribute was "complete"...
790 if !mod_attr_pending.is_empty() {
791 // If not, then we append the new line into the pending attribute to check
792 // if this time it's complete...
793 mod_attr_pending.push_str(line);
794 if !trimline.is_empty() && check_if_attr_is_complete(line, edition) {
795 // If it's complete, then we can clear the pending content.
796 mod_attr_pending.clear();
798 // In any case, this is considered as `PartitionState::Attrs` so it's
799 // prepended before rustdoc's inserts.
800 PartitionState::Attrs
802 PartitionState::Other
806 PartitionState::Crates => {
807 state = if trimline.starts_with("extern crate")
808 || trimline.starts_with("#[macro_use] extern crate")
809 || trimline.chars().all(|c| c.is_whitespace())
810 || (trimline.starts_with("//") && !trimline.starts_with("///"))
812 PartitionState::Crates
814 PartitionState::Other
817 PartitionState::Other => {}
821 PartitionState::Attrs => {
822 before.push_str(line);
825 PartitionState::Crates => {
826 crates.push_str(line);
829 PartitionState::Other => {
830 after.push_str(line);
836 debug!("before:\n{before}");
837 debug!("crates:\n{crates}");
838 debug!("after:\n{after}");
840 (before, after, crates)
844 fn add_test(&mut self, test: String, config: LangString, line: usize);
845 fn get_line(&self) -> usize {
848 fn register_header(&mut self, _name: &str, _level: u32) {}
851 crate struct Collector {
852 crate tests: Vec<test::TestDescAndFn>,
854 // The name of the test displayed to the user, separated by `::`.
856 // In tests from Rust source, this is the path to the item
857 // e.g., `["std", "vec", "Vec", "push"]`.
859 // In tests from a markdown file, this is the titles of all headers (h1~h6)
860 // of the sections that contain the code block, e.g., if the markdown file is
873 // the `names` vector of that test will be `["Title", "Subtitle"]`.
876 rustdoc_options: RustdocOptions,
878 enable_per_target_ignores: bool,
880 opts: GlobalTestOptions,
882 source_map: Option<Lrc<SourceMap>>,
883 filename: Option<PathBuf>,
884 visited_tests: FxHashMap<(String, usize), usize>,
885 unused_extern_reports: Arc<Mutex<Vec<UnusedExterns>>>,
886 compiling_test_count: AtomicUsize,
892 rustdoc_options: RustdocOptions,
894 opts: GlobalTestOptions,
895 source_map: Option<Lrc<SourceMap>>,
896 filename: Option<PathBuf>,
897 enable_per_target_ignores: bool,
904 enable_per_target_ignores,
910 visited_tests: FxHashMap::default(),
911 unused_extern_reports: Default::default(),
912 compiling_test_count: AtomicUsize::new(0),
916 fn generate_name(&self, line: usize, filename: &FileName) -> String {
917 let mut item_path = self.names.join("::");
918 item_path.retain(|c| c != ' ');
919 if !item_path.is_empty() {
922 format!("{} - {}(line {})", filename.prefer_local(), item_path, line)
925 crate fn set_position(&mut self, position: Span) {
926 self.position = position;
929 fn get_filename(&self) -> FileName {
930 if let Some(ref source_map) = self.source_map {
931 let filename = source_map.span_to_filename(self.position);
932 if let FileName::Real(ref filename) = filename {
933 if let Ok(cur_dir) = env::current_dir() {
934 if let Some(local_path) = filename.local_path() {
935 if let Ok(path) = local_path.strip_prefix(&cur_dir) {
936 return path.to_owned().into();
942 } else if let Some(ref filename) = self.filename {
943 filename.clone().into()
945 FileName::Custom("input".to_owned())
950 impl Tester for Collector {
951 fn add_test(&mut self, test: String, config: LangString, line: usize) {
952 let filename = self.get_filename();
953 let name = self.generate_name(line, &filename);
954 let crate_name = self.crate_name.to_string();
955 let opts = self.opts.clone();
956 let edition = config.edition.unwrap_or(self.rustdoc_options.edition);
957 let rustdoc_options = self.rustdoc_options.clone();
958 let runtool = self.rustdoc_options.runtool.clone();
959 let runtool_args = self.rustdoc_options.runtool_args.clone();
960 let target = self.rustdoc_options.target.clone();
961 let target_str = target.to_string();
962 let unused_externs = self.unused_extern_reports.clone();
963 let no_run = config.no_run || rustdoc_options.no_run;
964 if !config.compile_fail {
965 self.compiling_test_count.fetch_add(1, Ordering::SeqCst);
968 let path = match &filename {
969 FileName::Real(path) => {
970 if let Some(local_path) = path.local_path() {
971 local_path.to_path_buf()
973 // Somehow we got the filename from the metadata of another crate, should never happen
974 unreachable!("doctest from a different crate");
977 _ => PathBuf::from(r"doctest.rs"),
980 // For example `module/file.rs` would become `module_file_rs`
985 .map(|c| if c.is_ascii_alphanumeric() { c } else { '_' })
986 .collect::<String>();
987 let test_id = format!(
988 "{file}_{line}_{number}",
992 // Increases the current test number, if this file already
993 // exists or it creates a new entry with a test number of 0.
994 self.visited_tests.entry((file.clone(), line)).and_modify(|v| *v += 1).or_insert(0)
997 let outdir = if let Some(mut path) = rustdoc_options.persist_doctests.clone() {
1000 std::fs::create_dir_all(&path)
1001 .expect("Couldn't create directory for doctest executables");
1003 DirState::Perm(path)
1006 TempFileBuilder::new()
1007 .prefix("rustdoctest")
1009 .expect("rustdoc needs a tempdir"),
1013 debug!("creating test {name}: {test}");
1014 self.tests.push(test::TestDescAndFn {
1015 desc: test::TestDesc {
1016 name: test::DynTestName(name),
1017 ignore: match config.ignore {
1018 Ignore::All => true,
1019 Ignore::None => false,
1020 Ignore::Some(ref ignores) => ignores.iter().any(|s| target_str.contains(s)),
1022 ignore_message: None,
1023 // compiler failures are test failures
1024 should_panic: test::ShouldPanic::No,
1025 compile_fail: config.compile_fail,
1027 test_type: test::TestType::DocTest,
1029 testfn: test::DynTestFn(box move || {
1030 let report_unused_externs = |uext| {
1031 unused_externs.lock().unwrap().push(uext);
1048 report_unused_externs,
1051 if let Err(err) = res {
1053 TestFailure::CompileError => {
1054 eprint!("Couldn't compile the test.");
1056 TestFailure::UnexpectedCompilePass => {
1057 eprint!("Test compiled successfully, but it's marked `compile_fail`.");
1059 TestFailure::UnexpectedRunPass => {
1060 eprint!("Test executable succeeded, but it's marked `should_panic`.");
1062 TestFailure::MissingErrorCodes(codes) => {
1063 eprint!("Some expected error codes were not found: {:?}", codes);
1065 TestFailure::ExecutionError(err) => {
1066 eprint!("Couldn't run the test: {err}");
1067 if err.kind() == io::ErrorKind::PermissionDenied {
1068 eprint!(" - maybe your tempdir is mounted with noexec?");
1071 TestFailure::ExecutionFailure(out) => {
1072 eprintln!("Test executable failed ({reason}).", reason = out.status);
1074 // FIXME(#12309): An unfortunate side-effect of capturing the test
1075 // executable's output is that the relative ordering between the test's
1076 // stdout and stderr is lost. However, this is better than the
1077 // alternative: if the test executable inherited the parent's I/O
1078 // handles the output wouldn't be captured at all, even on success.
1080 // The ordering could be preserved if the test process' stderr was
1081 // redirected to stdout, but that functionality does not exist in the
1082 // standard library, so it may not be portable enough.
1083 let stdout = str::from_utf8(&out.stdout).unwrap_or_default();
1084 let stderr = str::from_utf8(&out.stderr).unwrap_or_default();
1086 if !stdout.is_empty() || !stderr.is_empty() {
1089 if !stdout.is_empty() {
1090 eprintln!("stdout:\n{stdout}");
1093 if !stderr.is_empty() {
1094 eprintln!("stderr:\n{stderr}");
1100 panic::resume_unwind(box ());
1106 fn get_line(&self) -> usize {
1107 if let Some(ref source_map) = self.source_map {
1108 let line = self.position.lo().to_usize();
1109 let line = source_map.lookup_char_pos(BytePos(line as u32)).line;
1110 if line > 0 { line - 1 } else { line }
1116 fn register_header(&mut self, name: &str, level: u32) {
1117 if self.use_headers {
1118 // We use these headings as test names, so it's good if
1119 // they're valid identifiers.
1124 if (i == 0 && rustc_lexer::is_id_start(c))
1125 || (i != 0 && rustc_lexer::is_id_continue(c))
1132 .collect::<String>();
1134 // Here we try to efficiently assemble the header titles into the
1135 // test name in the form of `h1::h2::h3::h4::h5::h6`.
1137 // Suppose that originally `self.names` contains `[h1, h2, h3]`...
1138 let level = level as usize;
1139 if level <= self.names.len() {
1140 // ... Consider `level == 2`. All headers in the lower levels
1141 // are irrelevant in this new level. So we should reset
1142 // `self.names` to contain headers until <h2>, and replace that
1143 // slot with the new name: `[h1, name]`.
1144 self.names.truncate(level);
1145 self.names[level - 1] = name;
1147 // ... On the other hand, consider `level == 5`. This means we
1148 // need to extend `self.names` to contain five headers. We fill
1149 // in the missing level (<h4>) with `_`. Thus `self.names` will
1150 // become `[h1, h2, h3, "_", name]`.
1151 if level - 1 > self.names.len() {
1152 self.names.resize(level - 1, "_".to_owned());
1154 self.names.push(name);
1160 struct HirCollector<'a, 'hir, 'tcx> {
1162 collector: &'a mut Collector,
1168 impl<'a, 'hir, 'tcx> HirCollector<'a, 'hir, 'tcx> {
1169 fn visit_testable<F: FnOnce(&mut Self)>(
1176 let ast_attrs = self.tcx.hir().attrs(hir_id);
1177 if let Some(ref cfg) = ast_attrs.cfg(self.tcx, &FxHashSet::default()) {
1178 if !cfg.matches(&self.sess.parse_sess, Some(self.sess.features_untracked())) {
1183 let has_name = !name.is_empty();
1185 self.collector.names.push(name);
1188 // The collapse-docs pass won't combine sugared/raw doc attributes, or included files with
1189 // anything else, this will combine them for us.
1190 let attrs = Attributes::from_ast(ast_attrs, None);
1191 if let Some(doc) = attrs.collapsed_doc_value() {
1192 // Use the outermost invocation, so that doctest names come from where the docs were written.
1193 let span = ast_attrs
1195 .map(|span| span.ctxt().outer_expn().expansion_cause().unwrap_or(span))
1196 .unwrap_or(DUMMY_SP);
1197 self.collector.set_position(span);
1198 markdown::find_testable_code(
1202 self.collector.enable_per_target_ignores,
1203 Some(&crate::html::markdown::ExtraInfo::new(
1206 span_of_attrs(&attrs).unwrap_or(sp),
1214 self.collector.names.pop();
1219 impl<'a, 'hir, 'tcx> intravisit::Visitor<'hir> for HirCollector<'a, 'hir, 'tcx> {
1220 type NestedFilter = nested_filter::All;
1222 fn nested_visit_map(&mut self) -> Self::Map {
1226 fn visit_item(&mut self, item: &'hir hir::Item<'_>) {
1227 let name = match &item.kind {
1228 hir::ItemKind::Macro(ref macro_def, _) => {
1229 // FIXME(#88038): Non exported macros have historically not been tested,
1230 // but we really ought to start testing them.
1231 let def_id = item.def_id.to_def_id();
1232 if macro_def.macro_rules && !self.tcx.has_attr(def_id, sym::macro_export) {
1233 intravisit::walk_item(self, item);
1236 item.ident.to_string()
1238 hir::ItemKind::Impl(impl_) => {
1239 rustc_hir_pretty::id_to_string(&self.map, impl_.self_ty.hir_id)
1241 _ => item.ident.to_string(),
1244 self.visit_testable(name, item.hir_id(), item.span, |this| {
1245 intravisit::walk_item(this, item);
1249 fn visit_trait_item(&mut self, item: &'hir hir::TraitItem<'_>) {
1250 self.visit_testable(item.ident.to_string(), item.hir_id(), item.span, |this| {
1251 intravisit::walk_trait_item(this, item);
1255 fn visit_impl_item(&mut self, item: &'hir hir::ImplItem<'_>) {
1256 self.visit_testable(item.ident.to_string(), item.hir_id(), item.span, |this| {
1257 intravisit::walk_impl_item(this, item);
1261 fn visit_foreign_item(&mut self, item: &'hir hir::ForeignItem<'_>) {
1262 self.visit_testable(item.ident.to_string(), item.hir_id(), item.span, |this| {
1263 intravisit::walk_foreign_item(this, item);
1269 v: &'hir hir::Variant<'_>,
1270 g: &'hir hir::Generics<'_>,
1271 item_id: hir::HirId,
1273 self.visit_testable(v.ident.to_string(), v.id, v.span, |this| {
1274 intravisit::walk_variant(this, v, g, item_id);
1278 fn visit_field_def(&mut self, f: &'hir hir::FieldDef<'_>) {
1279 self.visit_testable(f.ident.to_string(), f.hir_id, f.span, |this| {
1280 intravisit::walk_field_def(this, f);