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))
71 let crate_types = if options.crate_types.is_empty() {
74 options.crate_types.clone()
77 let sessopts = config::Options {
78 maybe_sysroot: options.maybe_sysroot.clone(),
79 search_paths: options.libs.clone(),
82 lint_cap: Some(options.lint_cap.unwrap_or(lint::Forbid)),
83 cg: options.codegen_options.clone(),
84 externs: options.externs.clone(),
85 unstable_features: options.unstable_features,
86 actually_rustdoc: true,
87 edition: options.edition,
88 target_triple: options.target.clone(),
89 crate_name: options.crate_name.clone(),
90 ..config::Options::default()
93 let mut cfgs = options.cfgs.clone();
94 cfgs.push("doc".to_owned());
95 cfgs.push("doctest".to_owned());
96 let config = interface::Config {
98 crate_cfg: interface::parse_cfgspecs(cfgs),
99 crate_check_cfg: interface::parse_check_cfg(options.check_cfgs.clone()),
106 parse_sess_created: None,
107 register_lints: Some(Box::new(crate::lint::register_lints)),
108 override_queries: None,
109 make_codegen_backend: None,
110 registry: rustc_driver::diagnostics_registry(),
113 let test_args = options.test_args.clone();
114 let nocapture = options.nocapture;
115 let externs = options.externs.clone();
116 let json_unused_externs = options.json_unused_externs;
118 let (tests, unused_extern_reports, compiling_test_count) =
119 interface::run_compiler(config, |compiler| {
120 compiler.enter(|queries| {
121 let mut global_ctxt = queries.global_ctxt()?.take();
123 let collector = global_ctxt.enter(|tcx| {
124 let crate_attrs = tcx.hir().attrs(CRATE_HIR_ID);
126 let opts = scrape_test_config(crate_attrs);
127 let enable_per_target_ignores = options.enable_per_target_ignores;
128 let mut collector = Collector::new(
129 tcx.crate_name(LOCAL_CRATE).to_string(),
133 Some(compiler.session().parse_sess.clone_source_map()),
135 enable_per_target_ignores,
138 let mut hir_collector = HirCollector {
139 sess: compiler.session(),
140 collector: &mut collector,
142 codes: ErrorCodes::from(
143 compiler.session().opts.unstable_features.is_nightly_build(),
147 hir_collector.visit_testable(
150 tcx.hir().span(CRATE_HIR_ID),
151 |this| tcx.hir().walk_toplevel_module(this),
156 if compiler.session().diagnostic().has_errors_or_lint_errors().is_some() {
160 let unused_extern_reports = collector.unused_extern_reports.clone();
161 let compiling_test_count = collector.compiling_test_count.load(Ordering::SeqCst);
162 let ret: Result<_, ErrorGuaranteed> =
163 Ok((collector.tests, unused_extern_reports, compiling_test_count));
168 run_tests(test_args, nocapture, tests);
170 // Collect and warn about unused externs, but only if we've gotten
171 // reports for each doctest
172 if json_unused_externs.is_enabled() {
173 let unused_extern_reports: Vec<_> =
174 std::mem::take(&mut unused_extern_reports.lock().unwrap());
175 if unused_extern_reports.len() == compiling_test_count {
176 let extern_names = externs.iter().map(|(name, _)| name).collect::<FxHashSet<&String>>();
177 let mut unused_extern_names = unused_extern_reports
179 .map(|uexts| uexts.unused_extern_names.iter().collect::<FxHashSet<&String>>())
180 .fold(extern_names, |uextsa, uextsb| {
181 uextsa.intersection(&uextsb).copied().collect::<FxHashSet<&String>>()
184 .map(|v| (*v).clone())
185 .collect::<Vec<String>>();
186 unused_extern_names.sort();
187 // Take the most severe lint level
188 let lint_level = unused_extern_reports
190 .map(|uexts| uexts.lint_level.as_str())
191 .max_by_key(|v| match *v {
195 // The allow lint level is not expected,
196 // as if allow is specified, no message
198 v => unreachable!("Invalid lint level '{}'", v),
202 let uext = UnusedExterns { lint_level, unused_extern_names };
203 let unused_extern_json = serde_json::to_string(&uext).unwrap();
204 eprintln!("{unused_extern_json}");
211 pub(crate) fn run_tests(
212 mut test_args: Vec<String>,
214 mut tests: Vec<test::TestDescAndFn>,
216 test_args.insert(0, "rustdoctest".to_string());
218 test_args.push("--nocapture".to_string());
220 tests.sort_by(|a, b| a.desc.name.as_slice().cmp(&b.desc.name.as_slice()));
221 test::test_main(&test_args, tests, None);
224 // Look for `#![doc(test(no_crate_inject))]`, used by crates in the std facade.
225 fn scrape_test_config(attrs: &[ast::Attribute]) -> GlobalTestOptions {
226 use rustc_ast_pretty::pprust;
228 let mut opts = GlobalTestOptions { no_crate_inject: false, attrs: Vec::new() };
230 let test_attrs: Vec<_> = attrs
232 .filter(|a| a.has_name(sym::doc))
233 .flat_map(|a| a.meta_item_list().unwrap_or_default())
234 .filter(|a| a.has_name(sym::test))
236 let attrs = test_attrs.iter().flat_map(|a| a.meta_item_list().unwrap_or(&[]));
239 if attr.has_name(sym::no_crate_inject) {
240 opts.no_crate_inject = true;
242 if attr.has_name(sym::attr) {
243 if let Some(l) = attr.meta_item_list() {
245 opts.attrs.push(pprust::meta_list_item_to_string(item));
254 /// Documentation test failure modes.
256 /// The test failed to compile.
258 /// The test is marked `compile_fail` but compiled successfully.
259 UnexpectedCompilePass,
260 /// The test failed to compile (as expected) but the compiler output did not contain all
261 /// expected error codes.
262 MissingErrorCodes(Vec<String>),
263 /// The test binary was unable to be executed.
264 ExecutionError(io::Error),
265 /// The test binary exited with a non-zero exit code.
267 /// This typically means an assertion in the test failed or another form of panic occurred.
268 ExecutionFailure(process::Output),
269 /// The test is marked `should_panic` but the test binary executed successfully.
274 Temp(tempfile::TempDir),
279 fn path(&self) -> &std::path::Path {
281 DirState::Temp(t) => t.path(),
282 DirState::Perm(p) => p.as_path(),
287 // NOTE: Keep this in sync with the equivalent structs in rustc
289 // We could unify this struct the one in rustc but they have different
290 // ownership semantics, so doing so would create wasteful allocations.
291 #[derive(serde::Serialize, serde::Deserialize)]
292 struct UnusedExterns {
293 /// Lint level of the unused_crate_dependencies lint
295 /// List of unused externs by their names.
296 unused_extern_names: Vec<String>,
299 fn add_exe_suffix(input: String, target: &TargetTriple) -> String {
300 let exe_suffix = match target {
301 TargetTriple::TargetTriple(_) => Target::expect_builtin(target).options.exe_suffix,
302 TargetTriple::TargetJson { contents, .. } => {
303 Target::from_json(contents.parse().unwrap()).unwrap().0.options.exe_suffix
313 rustdoc_options: RustdocOptions,
314 mut lang_string: LangString,
316 runtool: Option<String>,
317 runtool_args: Vec<String>,
318 target: TargetTriple,
319 opts: &GlobalTestOptions,
324 report_unused_externs: impl Fn(UnusedExterns),
325 ) -> Result<(), TestFailure> {
326 let (test, line_offset, supports_color) =
327 make_test(test, Some(crate_name), lang_string.test_harness, opts, edition, Some(test_id));
329 // Make sure we emit well-formed executable names for our target.
330 let rust_out = add_exe_suffix("rust_out".to_owned(), &target);
331 let output_file = outdir.path().join(rust_out);
333 let rustc_binary = rustdoc_options
336 .unwrap_or_else(|| rustc_interface::util::rustc_path().expect("found rustc"));
337 let mut compiler = Command::new(&rustc_binary);
338 compiler.arg("--crate-type").arg("bin");
339 for cfg in &rustdoc_options.cfgs {
340 compiler.arg("--cfg").arg(&cfg);
342 if !rustdoc_options.check_cfgs.is_empty() {
343 compiler.arg("-Z").arg("unstable-options");
344 for check_cfg in &rustdoc_options.check_cfgs {
345 compiler.arg("--check-cfg").arg(&check_cfg);
348 if let Some(sysroot) = rustdoc_options.maybe_sysroot {
349 compiler.arg("--sysroot").arg(sysroot);
351 compiler.arg("--edition").arg(&edition.to_string());
352 compiler.env("UNSTABLE_RUSTDOC_TEST_PATH", path);
353 compiler.env("UNSTABLE_RUSTDOC_TEST_LINE", format!("{}", line as isize - line_offset as isize));
354 compiler.arg("-o").arg(&output_file);
355 if lang_string.test_harness {
356 compiler.arg("--test");
358 if rustdoc_options.json_unused_externs.is_enabled() && !lang_string.compile_fail {
359 compiler.arg("--error-format=json");
360 compiler.arg("--json").arg("unused-externs");
361 compiler.arg("-Z").arg("unstable-options");
362 compiler.arg("-W").arg("unused_crate_dependencies");
364 for lib_str in &rustdoc_options.lib_strs {
365 compiler.arg("-L").arg(&lib_str);
367 for extern_str in &rustdoc_options.extern_strs {
368 compiler.arg("--extern").arg(&extern_str);
370 compiler.arg("-Ccodegen-units=1");
371 for codegen_options_str in &rustdoc_options.codegen_options_strs {
372 compiler.arg("-C").arg(&codegen_options_str);
374 for unstable_option_str in &rustdoc_options.unstable_opts_strs {
375 compiler.arg("-Z").arg(&unstable_option_str);
377 if no_run && !lang_string.compile_fail && rustdoc_options.persist_doctests.is_none() {
378 compiler.arg("--emit=metadata");
380 compiler.arg("--target").arg(match target {
381 TargetTriple::TargetTriple(s) => s,
382 TargetTriple::TargetJson { path_for_rustdoc, .. } => {
383 path_for_rustdoc.to_str().expect("target path must be valid unicode").to_string()
386 if let ErrorOutputType::HumanReadable(kind) = rustdoc_options.error_format {
387 let (short, color_config) = kind.unzip();
390 compiler.arg("--error-format").arg("short");
394 ColorConfig::Never => {
395 compiler.arg("--color").arg("never");
397 ColorConfig::Always => {
398 compiler.arg("--color").arg("always");
400 ColorConfig::Auto => {
401 compiler.arg("--color").arg(if supports_color { "always" } else { "never" });
407 compiler.stdin(Stdio::piped());
408 compiler.stderr(Stdio::piped());
410 let mut child = compiler.spawn().expect("Failed to spawn rustc process");
412 let stdin = child.stdin.as_mut().expect("Failed to open stdin");
413 stdin.write_all(test.as_bytes()).expect("could write out test sources");
415 let output = child.wait_with_output().expect("Failed to read stdout");
417 struct Bomb<'a>(&'a str);
418 impl Drop for Bomb<'_> {
420 eprint!("{}", self.0);
423 let mut out = str::from_utf8(&output.stderr)
427 if let Ok(uext) = serde_json::from_str::<UnusedExterns>(l) {
428 report_unused_externs(uext);
434 .intersperse_with(|| "\n")
435 .collect::<String>();
437 // Add a \n to the end to properly terminate the last line,
438 // but only if there was output to be printed
443 let _bomb = Bomb(&out);
444 match (output.status.success(), lang_string.compile_fail) {
446 return Err(TestFailure::UnexpectedCompilePass);
450 if !lang_string.error_codes.is_empty() {
451 // We used to check if the output contained "error[{}]: " but since we added the
452 // colored output, we can't anymore because of the color escape characters before
454 lang_string.error_codes.retain(|err| !out.contains(&format!("error[{err}]")));
456 if !lang_string.error_codes.is_empty() {
457 return Err(TestFailure::MissingErrorCodes(lang_string.error_codes));
462 return Err(TestFailure::CompileError);
473 if let Some(tool) = runtool {
474 cmd = Command::new(tool);
475 cmd.args(runtool_args);
476 cmd.arg(output_file);
478 cmd = Command::new(output_file);
480 if let Some(run_directory) = rustdoc_options.test_run_directory {
481 cmd.current_dir(run_directory);
484 let result = if rustdoc_options.nocapture {
485 cmd.status().map(|status| process::Output {
494 Err(e) => return Err(TestFailure::ExecutionError(e)),
496 if lang_string.should_panic && out.status.success() {
497 return Err(TestFailure::UnexpectedRunPass);
498 } else if !lang_string.should_panic && !out.status.success() {
499 return Err(TestFailure::ExecutionFailure(out));
507 /// Transforms a test into code that can be compiled into a Rust binary, and returns the number of
508 /// lines before the test code begins as well as if the output stream supports colors or not.
509 pub(crate) fn make_test(
511 crate_name: Option<&str>,
512 dont_insert_main: bool,
513 opts: &GlobalTestOptions,
515 test_id: Option<&str>,
516 ) -> (String, usize, bool) {
517 let (crate_attrs, everything_else, crates) = partition_source(s, edition);
518 let everything_else = everything_else.trim();
519 let mut line_offset = 0;
520 let mut prog = String::new();
521 let mut supports_color = false;
523 if opts.attrs.is_empty() {
524 // If there aren't any attributes supplied by #![doc(test(attr(...)))], then allow some
525 // lints that are commonly triggered in doctests. The crate-level test attributes are
526 // commonly used to make tests fail in case they trigger warnings, so having this there in
527 // that case may cause some tests to pass when they shouldn't have.
528 prog.push_str("#![allow(unused)]\n");
532 // Next, any attributes that came from the crate root via #![doc(test(attr(...)))].
533 for attr in &opts.attrs {
534 prog.push_str(&format!("#![{attr}]\n"));
538 // Now push any outer attributes from the example, assuming they
539 // are intended to be crate attributes.
540 prog.push_str(&crate_attrs);
541 prog.push_str(&crates);
543 // Uses librustc_ast to parse the doctest and find if there's a main fn and the extern
544 // crate already is included.
545 let result = rustc_driver::catch_fatal_errors(|| {
546 rustc_span::create_session_if_not_set_then(edition, |_| {
547 use rustc_errors::emitter::{Emitter, EmitterWriter};
548 use rustc_errors::Handler;
549 use rustc_parse::parser::ForceCollect;
550 use rustc_span::source_map::FilePathMapping;
552 let filename = FileName::anon_source_code(s);
553 let source = crates + everything_else;
555 // Any errors in parsing should also appear when the doctest is compiled for real, so just
556 // send all the errors that librustc_ast emits directly into a `Sink` instead of stderr.
557 let sm = Lrc::new(SourceMap::new(FilePathMapping::empty()));
558 let fallback_bundle =
559 rustc_errors::fallback_fluent_bundle(rustc_errors::DEFAULT_LOCALE_RESOURCES, false);
560 supports_color = EmitterWriter::stderr(
564 fallback_bundle.clone(),
573 let emitter = EmitterWriter::new(
574 Box::new(io::sink()),
586 // FIXME(misdreavus): pass `-Z treat-err-as-bug` to the doctest parser
587 let handler = Handler::with_emitter(false, None, Box::new(emitter));
588 let sess = ParseSess::with_span_handler(handler, sm);
590 let mut found_main = false;
591 let mut found_extern_crate = crate_name.is_none();
592 let mut found_macro = false;
594 let mut parser = match maybe_new_parser_from_source_str(&sess, filename, source) {
598 return (found_main, found_extern_crate, found_macro);
603 match parser.parse_item(ForceCollect::No) {
606 if let ast::ItemKind::Fn(..) = item.kind {
607 if item.ident.name == sym::main {
613 if !found_extern_crate {
614 if let ast::ItemKind::ExternCrate(original) = item.kind {
615 // This code will never be reached if `crate_name` is none because
616 // `found_extern_crate` is initialized to `true` if it is none.
617 let crate_name = crate_name.unwrap();
620 Some(name) => found_extern_crate = name.as_str() == crate_name,
621 None => found_extern_crate = item.ident.as_str() == crate_name,
627 if let ast::ItemKind::MacCall(..) = item.kind {
632 if found_main && found_extern_crate {
643 // The supplied slice is only used for diagnostics,
644 // which are swallowed here anyway.
645 parser.maybe_consume_incorrect_semicolon(&[]);
648 // Reset errors so that they won't be reported as compiler bugs when dropping the
649 // handler. Any errors in the tests will be reported when the test file is compiled,
650 // Note that we still need to cancel the errors above otherwise `DiagnosticBuilder`
651 // will panic on drop.
652 sess.span_diagnostic.reset_err_count();
654 (found_main, found_extern_crate, found_macro)
657 let Ok((already_has_main, already_has_extern_crate, found_macro)) = result
659 // If the parser panicked due to a fatal error, pass the test code through unchanged.
660 // The error will be reported during compilation.
661 return (s.to_owned(), 0, false);
664 // If a doctest's `fn main` is being masked by a wrapper macro, the parsing loop above won't
665 // see it. In that case, run the old text-based scan to see if they at least have a main
666 // function written inside a macro invocation. See
667 // https://github.com/rust-lang/rust/issues/56898
668 let already_has_main = if found_macro && !already_has_main {
671 let comment = line.find("//");
672 if let Some(comment_begins) = comment { &line[0..comment_begins] } else { line }
674 .any(|code| code.contains("fn main"))
679 // Don't inject `extern crate std` because it's already injected by the
681 if !already_has_extern_crate && !opts.no_crate_inject && crate_name != Some("std") {
682 if let Some(crate_name) = crate_name {
683 // Don't inject `extern crate` if the crate is never used.
684 // NOTE: this is terribly inaccurate because it doesn't actually
685 // parse the source, but only has false positives, not false
687 if s.contains(crate_name) {
688 prog.push_str(&format!("extern crate r#{crate_name};\n"));
694 // FIXME: This code cannot yet handle no_std test cases yet
695 if dont_insert_main || already_has_main || prog.contains("![no_std]") {
696 prog.push_str(everything_else);
698 let returns_result = everything_else.trim_end().ends_with("(())");
699 // Give each doctest main function a unique name.
700 // This is for example needed for the tooling around `-C instrument-coverage`.
701 let inner_fn_name = if let Some(test_id) = test_id {
702 format!("_doctest_main_{test_id}")
706 let inner_attr = if test_id.is_some() { "#[allow(non_snake_case)] " } else { "" };
707 let (main_pre, main_post) = if returns_result {
710 "fn main() {{ {inner_attr}fn {inner_fn_name}() -> Result<(), impl core::fmt::Debug> {{\n",
712 format!("\n}} {inner_fn_name}().unwrap() }}"),
714 } else if test_id.is_some() {
716 format!("fn main() {{ {inner_attr}fn {inner_fn_name}() {{\n",),
717 format!("\n}} {inner_fn_name}() }}"),
720 ("fn main() {\n".into(), "\n}".into())
722 // Note on newlines: We insert a line/newline *before*, and *after*
723 // the doctest and adjust the `line_offset` accordingly.
724 // In the case of `-C instrument-coverage`, this means that the generated
725 // inner `main` function spans from the doctest opening codeblock to the
726 // closing one. For example
727 // /// ``` <- start of the inner main
728 // /// <- code under doctest
729 // /// ``` <- end of the inner main
732 prog.extend([&main_pre, everything_else, &main_post].iter().cloned());
735 debug!("final doctest:\n{prog}");
737 (prog, line_offset, supports_color)
740 fn check_if_attr_is_complete(source: &str, edition: Edition) -> bool {
741 if source.is_empty() {
742 // Empty content so nothing to check in here...
745 rustc_driver::catch_fatal_errors(|| {
746 rustc_span::create_session_if_not_set_then(edition, |_| {
747 use rustc_errors::emitter::EmitterWriter;
748 use rustc_errors::Handler;
749 use rustc_span::source_map::FilePathMapping;
751 let filename = FileName::anon_source_code(source);
752 // Any errors in parsing should also appear when the doctest is compiled for real, so just
753 // send all the errors that librustc_ast emits directly into a `Sink` instead of stderr.
754 let sm = Lrc::new(SourceMap::new(FilePathMapping::empty()));
755 let fallback_bundle =
756 rustc_errors::fallback_fluent_bundle(rustc_errors::DEFAULT_LOCALE_RESOURCES, false);
758 let emitter = EmitterWriter::new(
759 Box::new(io::sink()),
771 let handler = Handler::with_emitter(false, None, Box::new(emitter));
772 let sess = ParseSess::with_span_handler(handler, sm);
774 match maybe_new_parser_from_source_str(&sess, filename, source.to_owned()) {
777 debug!("Cannot build a parser to check mod attr so skipping...");
781 // If a parsing error happened, it's very likely that the attribute is incomplete.
782 if let Err(e) = parser.parse_attribute(InnerAttrPolicy::Permitted) {
786 // We now check if there is an unclosed delimiter for the attribute. To do so, we look at
787 // the `unclosed_delims` and see if the opening square bracket was closed.
792 unclosed.unclosed_span.map(|s| s.lo()).unwrap_or(BytePos(0)) != BytePos(2)
800 fn partition_source(s: &str, edition: Edition) -> (String, String, String) {
801 #[derive(Copy, Clone, PartialEq)]
802 enum PartitionState {
807 let mut state = PartitionState::Attrs;
808 let mut before = String::new();
809 let mut crates = String::new();
810 let mut after = String::new();
812 let mut mod_attr_pending = String::new();
814 for line in s.lines() {
815 let trimline = line.trim();
817 // FIXME(misdreavus): if a doc comment is placed on an extern crate statement, it will be
818 // shunted into "everything else"
820 PartitionState::Attrs => {
821 state = if trimline.starts_with("#![") {
822 if !check_if_attr_is_complete(line, edition) {
823 mod_attr_pending = line.to_owned();
825 mod_attr_pending.clear();
827 PartitionState::Attrs
828 } else if trimline.chars().all(|c| c.is_whitespace())
829 || (trimline.starts_with("//") && !trimline.starts_with("///"))
831 PartitionState::Attrs
832 } else if trimline.starts_with("extern crate")
833 || trimline.starts_with("#[macro_use] extern crate")
835 PartitionState::Crates
837 // First we check if the previous attribute was "complete"...
838 if !mod_attr_pending.is_empty() {
839 // If not, then we append the new line into the pending attribute to check
840 // if this time it's complete...
841 mod_attr_pending.push_str(line);
842 if !trimline.is_empty()
843 && check_if_attr_is_complete(&mod_attr_pending, edition)
845 // If it's complete, then we can clear the pending content.
846 mod_attr_pending.clear();
848 // In any case, this is considered as `PartitionState::Attrs` so it's
849 // prepended before rustdoc's inserts.
850 PartitionState::Attrs
852 PartitionState::Other
856 PartitionState::Crates => {
857 state = if trimline.starts_with("extern crate")
858 || trimline.starts_with("#[macro_use] extern crate")
859 || trimline.chars().all(|c| c.is_whitespace())
860 || (trimline.starts_with("//") && !trimline.starts_with("///"))
862 PartitionState::Crates
864 PartitionState::Other
867 PartitionState::Other => {}
871 PartitionState::Attrs => {
872 before.push_str(line);
875 PartitionState::Crates => {
876 crates.push_str(line);
879 PartitionState::Other => {
880 after.push_str(line);
886 debug!("before:\n{before}");
887 debug!("crates:\n{crates}");
888 debug!("after:\n{after}");
890 (before, after, crates)
893 pub(crate) trait Tester {
894 fn add_test(&mut self, test: String, config: LangString, line: usize);
895 fn get_line(&self) -> usize {
898 fn register_header(&mut self, _name: &str, _level: u32) {}
901 pub(crate) struct Collector {
902 pub(crate) tests: Vec<test::TestDescAndFn>,
904 // The name of the test displayed to the user, separated by `::`.
906 // In tests from Rust source, this is the path to the item
907 // e.g., `["std", "vec", "Vec", "push"]`.
909 // In tests from a markdown file, this is the titles of all headers (h1~h6)
910 // of the sections that contain the code block, e.g., if the markdown file is
923 // the `names` vector of that test will be `["Title", "Subtitle"]`.
926 rustdoc_options: RustdocOptions,
928 enable_per_target_ignores: bool,
930 opts: GlobalTestOptions,
932 source_map: Option<Lrc<SourceMap>>,
933 filename: Option<PathBuf>,
934 visited_tests: FxHashMap<(String, usize), usize>,
935 unused_extern_reports: Arc<Mutex<Vec<UnusedExterns>>>,
936 compiling_test_count: AtomicUsize,
942 rustdoc_options: RustdocOptions,
944 opts: GlobalTestOptions,
945 source_map: Option<Lrc<SourceMap>>,
946 filename: Option<PathBuf>,
947 enable_per_target_ignores: bool,
954 enable_per_target_ignores,
960 visited_tests: FxHashMap::default(),
961 unused_extern_reports: Default::default(),
962 compiling_test_count: AtomicUsize::new(0),
966 fn generate_name(&self, line: usize, filename: &FileName) -> String {
967 let mut item_path = self.names.join("::");
968 item_path.retain(|c| c != ' ');
969 if !item_path.is_empty() {
972 format!("{} - {}(line {})", filename.prefer_local(), item_path, line)
975 pub(crate) fn set_position(&mut self, position: Span) {
976 self.position = position;
979 fn get_filename(&self) -> FileName {
980 if let Some(ref source_map) = self.source_map {
981 let filename = source_map.span_to_filename(self.position);
982 if let FileName::Real(ref filename) = filename {
983 if let Ok(cur_dir) = env::current_dir() {
984 if let Some(local_path) = filename.local_path() {
985 if let Ok(path) = local_path.strip_prefix(&cur_dir) {
986 return path.to_owned().into();
992 } else if let Some(ref filename) = self.filename {
993 filename.clone().into()
995 FileName::Custom("input".to_owned())
1000 impl Tester for Collector {
1001 fn add_test(&mut self, test: String, config: LangString, line: usize) {
1002 let filename = self.get_filename();
1003 let name = self.generate_name(line, &filename);
1004 let crate_name = self.crate_name.clone();
1005 let opts = self.opts.clone();
1006 let edition = config.edition.unwrap_or(self.rustdoc_options.edition);
1007 let rustdoc_options = self.rustdoc_options.clone();
1008 let runtool = self.rustdoc_options.runtool.clone();
1009 let runtool_args = self.rustdoc_options.runtool_args.clone();
1010 let target = self.rustdoc_options.target.clone();
1011 let target_str = target.to_string();
1012 let unused_externs = self.unused_extern_reports.clone();
1013 let no_run = config.no_run || rustdoc_options.no_run;
1014 if !config.compile_fail {
1015 self.compiling_test_count.fetch_add(1, Ordering::SeqCst);
1018 let path = match &filename {
1019 FileName::Real(path) => {
1020 if let Some(local_path) = path.local_path() {
1021 local_path.to_path_buf()
1023 // Somehow we got the filename from the metadata of another crate, should never happen
1024 unreachable!("doctest from a different crate");
1027 _ => PathBuf::from(r"doctest.rs"),
1030 // For example `module/file.rs` would become `module_file_rs`
1035 .map(|c| if c.is_ascii_alphanumeric() { c } else { '_' })
1036 .collect::<String>();
1037 let test_id = format!(
1038 "{file}_{line}_{number}",
1042 // Increases the current test number, if this file already
1043 // exists or it creates a new entry with a test number of 0.
1044 self.visited_tests.entry((file.clone(), line)).and_modify(|v| *v += 1).or_insert(0)
1047 let outdir = if let Some(mut path) = rustdoc_options.persist_doctests.clone() {
1048 path.push(&test_id);
1050 if let Err(err) = std::fs::create_dir_all(&path) {
1051 eprintln!("Couldn't create directory for doctest executables: {}", err);
1052 panic::resume_unwind(Box::new(()));
1055 DirState::Perm(path)
1058 TempFileBuilder::new()
1059 .prefix("rustdoctest")
1061 .expect("rustdoc needs a tempdir"),
1065 debug!("creating test {name}: {test}");
1066 self.tests.push(test::TestDescAndFn {
1067 desc: test::TestDesc {
1068 name: test::DynTestName(name),
1069 ignore: match config.ignore {
1070 Ignore::All => true,
1071 Ignore::None => false,
1072 Ignore::Some(ref ignores) => ignores.iter().any(|s| target_str.contains(s)),
1074 ignore_message: None,
1075 // compiler failures are test failures
1076 should_panic: test::ShouldPanic::No,
1077 compile_fail: config.compile_fail,
1079 test_type: test::TestType::DocTest,
1081 testfn: test::DynTestFn(Box::new(move || {
1082 let report_unused_externs = |uext| {
1083 unused_externs.lock().unwrap().push(uext);
1100 report_unused_externs,
1103 if let Err(err) = res {
1105 TestFailure::CompileError => {
1106 eprint!("Couldn't compile the test.");
1108 TestFailure::UnexpectedCompilePass => {
1109 eprint!("Test compiled successfully, but it's marked `compile_fail`.");
1111 TestFailure::UnexpectedRunPass => {
1112 eprint!("Test executable succeeded, but it's marked `should_panic`.");
1114 TestFailure::MissingErrorCodes(codes) => {
1115 eprint!("Some expected error codes were not found: {:?}", codes);
1117 TestFailure::ExecutionError(err) => {
1118 eprint!("Couldn't run the test: {err}");
1119 if err.kind() == io::ErrorKind::PermissionDenied {
1120 eprint!(" - maybe your tempdir is mounted with noexec?");
1123 TestFailure::ExecutionFailure(out) => {
1124 eprintln!("Test executable failed ({reason}).", reason = out.status);
1126 // FIXME(#12309): An unfortunate side-effect of capturing the test
1127 // executable's output is that the relative ordering between the test's
1128 // stdout and stderr is lost. However, this is better than the
1129 // alternative: if the test executable inherited the parent's I/O
1130 // handles the output wouldn't be captured at all, even on success.
1132 // The ordering could be preserved if the test process' stderr was
1133 // redirected to stdout, but that functionality does not exist in the
1134 // standard library, so it may not be portable enough.
1135 let stdout = str::from_utf8(&out.stdout).unwrap_or_default();
1136 let stderr = str::from_utf8(&out.stderr).unwrap_or_default();
1138 if !stdout.is_empty() || !stderr.is_empty() {
1141 if !stdout.is_empty() {
1142 eprintln!("stdout:\n{stdout}");
1145 if !stderr.is_empty() {
1146 eprintln!("stderr:\n{stderr}");
1152 panic::resume_unwind(Box::new(()));
1159 fn get_line(&self) -> usize {
1160 if let Some(ref source_map) = self.source_map {
1161 let line = self.position.lo().to_usize();
1162 let line = source_map.lookup_char_pos(BytePos(line as u32)).line;
1163 if line > 0 { line - 1 } else { line }
1169 fn register_header(&mut self, name: &str, level: u32) {
1170 if self.use_headers {
1171 // We use these headings as test names, so it's good if
1172 // they're valid identifiers.
1177 if (i == 0 && rustc_lexer::is_id_start(c))
1178 || (i != 0 && rustc_lexer::is_id_continue(c))
1185 .collect::<String>();
1187 // Here we try to efficiently assemble the header titles into the
1188 // test name in the form of `h1::h2::h3::h4::h5::h6`.
1190 // Suppose that originally `self.names` contains `[h1, h2, h3]`...
1191 let level = level as usize;
1192 if level <= self.names.len() {
1193 // ... Consider `level == 2`. All headers in the lower levels
1194 // are irrelevant in this new level. So we should reset
1195 // `self.names` to contain headers until <h2>, and replace that
1196 // slot with the new name: `[h1, name]`.
1197 self.names.truncate(level);
1198 self.names[level - 1] = name;
1200 // ... On the other hand, consider `level == 5`. This means we
1201 // need to extend `self.names` to contain five headers. We fill
1202 // in the missing level (<h4>) with `_`. Thus `self.names` will
1203 // become `[h1, h2, h3, "_", name]`.
1204 if level - 1 > self.names.len() {
1205 self.names.resize(level - 1, "_".to_owned());
1207 self.names.push(name);
1213 struct HirCollector<'a, 'hir, 'tcx> {
1215 collector: &'a mut Collector,
1221 impl<'a, 'hir, 'tcx> HirCollector<'a, 'hir, 'tcx> {
1222 fn visit_testable<F: FnOnce(&mut Self)>(
1229 let ast_attrs = self.tcx.hir().attrs(hir_id);
1230 if let Some(ref cfg) = ast_attrs.cfg(self.tcx, &FxHashSet::default()) {
1231 if !cfg.matches(&self.sess.parse_sess, Some(self.sess.features_untracked())) {
1236 let has_name = !name.is_empty();
1238 self.collector.names.push(name);
1241 // The collapse-docs pass won't combine sugared/raw doc attributes, or included files with
1242 // anything else, this will combine them for us.
1243 let attrs = Attributes::from_ast(ast_attrs);
1244 if let Some(doc) = attrs.collapsed_doc_value() {
1245 // Use the outermost invocation, so that doctest names come from where the docs were written.
1246 let span = ast_attrs
1248 .map(|span| span.ctxt().outer_expn().expansion_cause().unwrap_or(span))
1249 .unwrap_or(DUMMY_SP);
1250 self.collector.set_position(span);
1251 markdown::find_testable_code(
1255 self.collector.enable_per_target_ignores,
1256 Some(&crate::html::markdown::ExtraInfo::new(
1259 span_of_attrs(&attrs).unwrap_or(sp),
1267 self.collector.names.pop();
1272 impl<'a, 'hir, 'tcx> intravisit::Visitor<'hir> for HirCollector<'a, 'hir, 'tcx> {
1273 type NestedFilter = nested_filter::All;
1275 fn nested_visit_map(&mut self) -> Self::Map {
1279 fn visit_item(&mut self, item: &'hir hir::Item<'_>) {
1280 let name = match &item.kind {
1281 hir::ItemKind::Impl(impl_) => {
1282 rustc_hir_pretty::id_to_string(&self.map, impl_.self_ty.hir_id)
1284 _ => item.ident.to_string(),
1287 self.visit_testable(name, item.hir_id(), item.span, |this| {
1288 intravisit::walk_item(this, item);
1292 fn visit_trait_item(&mut self, item: &'hir hir::TraitItem<'_>) {
1293 self.visit_testable(item.ident.to_string(), item.hir_id(), item.span, |this| {
1294 intravisit::walk_trait_item(this, item);
1298 fn visit_impl_item(&mut self, item: &'hir hir::ImplItem<'_>) {
1299 self.visit_testable(item.ident.to_string(), item.hir_id(), item.span, |this| {
1300 intravisit::walk_impl_item(this, item);
1304 fn visit_foreign_item(&mut self, item: &'hir hir::ForeignItem<'_>) {
1305 self.visit_testable(item.ident.to_string(), item.hir_id(), item.span, |this| {
1306 intravisit::walk_foreign_item(this, item);
1310 fn visit_variant(&mut self, v: &'hir hir::Variant<'_>) {
1311 self.visit_testable(v.ident.to_string(), v.hir_id, v.span, |this| {
1312 intravisit::walk_variant(this, v);
1316 fn visit_field_def(&mut self, f: &'hir hir::FieldDef<'_>) {
1317 self.visit_testable(f.ident.to_string(), f.hir_id, f.span, |this| {
1318 intravisit::walk_field_def(this, f);