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()),
102 parse_sess_created: None,
103 register_lints: Some(Box::new(crate::lint::register_lints)),
104 override_queries: None,
105 make_codegen_backend: None,
106 registry: rustc_driver::diagnostics_registry(),
109 let test_args = options.test_args.clone();
110 let nocapture = options.nocapture;
111 let externs = options.externs.clone();
112 let json_unused_externs = options.json_unused_externs;
114 let (tests, unused_extern_reports, compiling_test_count) =
115 interface::run_compiler(config, |compiler| {
116 compiler.enter(|queries| {
117 let collector = queries.global_ctxt()?.enter(|tcx| {
118 let crate_attrs = tcx.hir().attrs(CRATE_HIR_ID);
120 let opts = scrape_test_config(crate_attrs);
121 let enable_per_target_ignores = options.enable_per_target_ignores;
122 let mut collector = Collector::new(
123 tcx.crate_name(LOCAL_CRATE).to_string(),
127 Some(compiler.session().parse_sess.clone_source_map()),
129 enable_per_target_ignores,
132 let mut hir_collector = HirCollector {
133 sess: compiler.session(),
134 collector: &mut collector,
136 codes: ErrorCodes::from(
137 compiler.session().opts.unstable_features.is_nightly_build(),
141 hir_collector.visit_testable(
144 tcx.hir().span(CRATE_HIR_ID),
145 |this| tcx.hir().walk_toplevel_module(this),
150 if compiler.session().diagnostic().has_errors_or_lint_errors().is_some() {
154 let unused_extern_reports = collector.unused_extern_reports.clone();
155 let compiling_test_count = collector.compiling_test_count.load(Ordering::SeqCst);
156 Ok((collector.tests, unused_extern_reports, compiling_test_count))
160 run_tests(test_args, nocapture, tests);
162 // Collect and warn about unused externs, but only if we've gotten
163 // reports for each doctest
164 if json_unused_externs.is_enabled() {
165 let unused_extern_reports: Vec<_> =
166 std::mem::take(&mut unused_extern_reports.lock().unwrap());
167 if unused_extern_reports.len() == compiling_test_count {
168 let extern_names = externs.iter().map(|(name, _)| name).collect::<FxHashSet<&String>>();
169 let mut unused_extern_names = unused_extern_reports
171 .map(|uexts| uexts.unused_extern_names.iter().collect::<FxHashSet<&String>>())
172 .fold(extern_names, |uextsa, uextsb| {
173 uextsa.intersection(&uextsb).copied().collect::<FxHashSet<&String>>()
176 .map(|v| (*v).clone())
177 .collect::<Vec<String>>();
178 unused_extern_names.sort();
179 // Take the most severe lint level
180 let lint_level = unused_extern_reports
182 .map(|uexts| uexts.lint_level.as_str())
183 .max_by_key(|v| match *v {
187 // The allow lint level is not expected,
188 // as if allow is specified, no message
190 v => unreachable!("Invalid lint level '{}'", v),
194 let uext = UnusedExterns { lint_level, unused_extern_names };
195 let unused_extern_json = serde_json::to_string(&uext).unwrap();
196 eprintln!("{unused_extern_json}");
203 pub(crate) fn run_tests(
204 mut test_args: Vec<String>,
206 mut tests: Vec<test::TestDescAndFn>,
208 test_args.insert(0, "rustdoctest".to_string());
210 test_args.push("--nocapture".to_string());
212 tests.sort_by(|a, b| a.desc.name.as_slice().cmp(&b.desc.name.as_slice()));
213 test::test_main(&test_args, tests, None);
216 // Look for `#![doc(test(no_crate_inject))]`, used by crates in the std facade.
217 fn scrape_test_config(attrs: &[ast::Attribute]) -> GlobalTestOptions {
218 use rustc_ast_pretty::pprust;
220 let mut opts = GlobalTestOptions { no_crate_inject: false, attrs: Vec::new() };
222 let test_attrs: Vec<_> = attrs
224 .filter(|a| a.has_name(sym::doc))
225 .flat_map(|a| a.meta_item_list().unwrap_or_default())
226 .filter(|a| a.has_name(sym::test))
228 let attrs = test_attrs.iter().flat_map(|a| a.meta_item_list().unwrap_or(&[]));
231 if attr.has_name(sym::no_crate_inject) {
232 opts.no_crate_inject = true;
234 if attr.has_name(sym::attr) {
235 if let Some(l) = attr.meta_item_list() {
237 opts.attrs.push(pprust::meta_list_item_to_string(item));
246 /// Documentation test failure modes.
248 /// The test failed to compile.
250 /// The test is marked `compile_fail` but compiled successfully.
251 UnexpectedCompilePass,
252 /// The test failed to compile (as expected) but the compiler output did not contain all
253 /// expected error codes.
254 MissingErrorCodes(Vec<String>),
255 /// The test binary was unable to be executed.
256 ExecutionError(io::Error),
257 /// The test binary exited with a non-zero exit code.
259 /// This typically means an assertion in the test failed or another form of panic occurred.
260 ExecutionFailure(process::Output),
261 /// The test is marked `should_panic` but the test binary executed successfully.
266 Temp(tempfile::TempDir),
271 fn path(&self) -> &std::path::Path {
273 DirState::Temp(t) => t.path(),
274 DirState::Perm(p) => p.as_path(),
279 // NOTE: Keep this in sync with the equivalent structs in rustc
281 // We could unify this struct the one in rustc but they have different
282 // ownership semantics, so doing so would create wasteful allocations.
283 #[derive(serde::Serialize, serde::Deserialize)]
284 struct UnusedExterns {
285 /// Lint level of the unused_crate_dependencies lint
287 /// List of unused externs by their names.
288 unused_extern_names: Vec<String>,
291 fn add_exe_suffix(input: String, target: &TargetTriple) -> String {
292 let exe_suffix = match target {
293 TargetTriple::TargetTriple(_) => Target::expect_builtin(target).options.exe_suffix,
294 TargetTriple::TargetJson { contents, .. } => {
295 Target::from_json(contents.parse().unwrap()).unwrap().0.options.exe_suffix
305 rustdoc_options: RustdocOptions,
306 mut lang_string: LangString,
308 runtool: Option<String>,
309 runtool_args: Vec<String>,
310 target: TargetTriple,
311 opts: &GlobalTestOptions,
316 report_unused_externs: impl Fn(UnusedExterns),
317 ) -> Result<(), TestFailure> {
318 let (test, line_offset, supports_color) =
319 make_test(test, Some(crate_name), lang_string.test_harness, opts, edition, Some(test_id));
321 // Make sure we emit well-formed executable names for our target.
322 let rust_out = add_exe_suffix("rust_out".to_owned(), &target);
323 let output_file = outdir.path().join(rust_out);
325 let rustc_binary = rustdoc_options
328 .unwrap_or_else(|| rustc_interface::util::rustc_path().expect("found rustc"));
329 let mut compiler = Command::new(&rustc_binary);
330 compiler.arg("--crate-type").arg("bin");
331 for cfg in &rustdoc_options.cfgs {
332 compiler.arg("--cfg").arg(&cfg);
334 if !rustdoc_options.check_cfgs.is_empty() {
335 compiler.arg("-Z").arg("unstable-options");
336 for check_cfg in &rustdoc_options.check_cfgs {
337 compiler.arg("--check-cfg").arg(&check_cfg);
340 if let Some(sysroot) = rustdoc_options.maybe_sysroot {
341 compiler.arg("--sysroot").arg(sysroot);
343 compiler.arg("--edition").arg(&edition.to_string());
344 compiler.env("UNSTABLE_RUSTDOC_TEST_PATH", path);
345 compiler.env("UNSTABLE_RUSTDOC_TEST_LINE", format!("{}", line as isize - line_offset as isize));
346 compiler.arg("-o").arg(&output_file);
347 if lang_string.test_harness {
348 compiler.arg("--test");
350 if rustdoc_options.json_unused_externs.is_enabled() && !lang_string.compile_fail {
351 compiler.arg("--error-format=json");
352 compiler.arg("--json").arg("unused-externs");
353 compiler.arg("-Z").arg("unstable-options");
354 compiler.arg("-W").arg("unused_crate_dependencies");
356 for lib_str in &rustdoc_options.lib_strs {
357 compiler.arg("-L").arg(&lib_str);
359 for extern_str in &rustdoc_options.extern_strs {
360 compiler.arg("--extern").arg(&extern_str);
362 compiler.arg("-Ccodegen-units=1");
363 for codegen_options_str in &rustdoc_options.codegen_options_strs {
364 compiler.arg("-C").arg(&codegen_options_str);
366 for unstable_option_str in &rustdoc_options.unstable_opts_strs {
367 compiler.arg("-Z").arg(&unstable_option_str);
369 if no_run && !lang_string.compile_fail && rustdoc_options.persist_doctests.is_none() {
370 compiler.arg("--emit=metadata");
372 compiler.arg("--target").arg(match target {
373 TargetTriple::TargetTriple(s) => s,
374 TargetTriple::TargetJson { path_for_rustdoc, .. } => {
375 path_for_rustdoc.to_str().expect("target path must be valid unicode").to_string()
378 if let ErrorOutputType::HumanReadable(kind) = rustdoc_options.error_format {
379 let (short, color_config) = kind.unzip();
382 compiler.arg("--error-format").arg("short");
386 ColorConfig::Never => {
387 compiler.arg("--color").arg("never");
389 ColorConfig::Always => {
390 compiler.arg("--color").arg("always");
392 ColorConfig::Auto => {
393 compiler.arg("--color").arg(if supports_color { "always" } else { "never" });
399 compiler.stdin(Stdio::piped());
400 compiler.stderr(Stdio::piped());
402 let mut child = compiler.spawn().expect("Failed to spawn rustc process");
404 let stdin = child.stdin.as_mut().expect("Failed to open stdin");
405 stdin.write_all(test.as_bytes()).expect("could write out test sources");
407 let output = child.wait_with_output().expect("Failed to read stdout");
409 struct Bomb<'a>(&'a str);
410 impl Drop for Bomb<'_> {
412 eprint!("{}", self.0);
415 let mut out = str::from_utf8(&output.stderr)
419 if let Ok(uext) = serde_json::from_str::<UnusedExterns>(l) {
420 report_unused_externs(uext);
426 .intersperse_with(|| "\n")
427 .collect::<String>();
429 // Add a \n to the end to properly terminate the last line,
430 // but only if there was output to be printed
435 let _bomb = Bomb(&out);
436 match (output.status.success(), lang_string.compile_fail) {
438 return Err(TestFailure::UnexpectedCompilePass);
442 if !lang_string.error_codes.is_empty() {
443 // We used to check if the output contained "error[{}]: " but since we added the
444 // colored output, we can't anymore because of the color escape characters before
446 lang_string.error_codes.retain(|err| !out.contains(&format!("error[{err}]")));
448 if !lang_string.error_codes.is_empty() {
449 return Err(TestFailure::MissingErrorCodes(lang_string.error_codes));
454 return Err(TestFailure::CompileError);
465 if let Some(tool) = runtool {
466 cmd = Command::new(tool);
467 cmd.args(runtool_args);
468 cmd.arg(output_file);
470 cmd = Command::new(output_file);
472 if let Some(run_directory) = rustdoc_options.test_run_directory {
473 cmd.current_dir(run_directory);
476 let result = if rustdoc_options.nocapture {
477 cmd.status().map(|status| process::Output {
486 Err(e) => return Err(TestFailure::ExecutionError(e)),
488 if lang_string.should_panic && out.status.success() {
489 return Err(TestFailure::UnexpectedRunPass);
490 } else if !lang_string.should_panic && !out.status.success() {
491 return Err(TestFailure::ExecutionFailure(out));
499 /// Transforms a test into code that can be compiled into a Rust binary, and returns the number of
500 /// lines before the test code begins as well as if the output stream supports colors or not.
501 pub(crate) fn make_test(
503 crate_name: Option<&str>,
504 dont_insert_main: bool,
505 opts: &GlobalTestOptions,
507 test_id: Option<&str>,
508 ) -> (String, usize, bool) {
509 let (crate_attrs, everything_else, crates) = partition_source(s, edition);
510 let everything_else = everything_else.trim();
511 let mut line_offset = 0;
512 let mut prog = String::new();
513 let mut supports_color = false;
515 if opts.attrs.is_empty() {
516 // If there aren't any attributes supplied by #![doc(test(attr(...)))], then allow some
517 // lints that are commonly triggered in doctests. The crate-level test attributes are
518 // commonly used to make tests fail in case they trigger warnings, so having this there in
519 // that case may cause some tests to pass when they shouldn't have.
520 prog.push_str("#![allow(unused)]\n");
524 // Next, any attributes that came from the crate root via #![doc(test(attr(...)))].
525 for attr in &opts.attrs {
526 prog.push_str(&format!("#![{attr}]\n"));
530 // Now push any outer attributes from the example, assuming they
531 // are intended to be crate attributes.
532 prog.push_str(&crate_attrs);
533 prog.push_str(&crates);
535 // Uses librustc_ast to parse the doctest and find if there's a main fn and the extern
536 // crate already is included.
537 let result = rustc_driver::catch_fatal_errors(|| {
538 rustc_span::create_session_if_not_set_then(edition, |_| {
539 use rustc_errors::emitter::{Emitter, EmitterWriter};
540 use rustc_errors::Handler;
541 use rustc_parse::parser::ForceCollect;
542 use rustc_span::source_map::FilePathMapping;
544 let filename = FileName::anon_source_code(s);
545 let source = crates + everything_else;
547 // Any errors in parsing should also appear when the doctest is compiled for real, so just
548 // send all the errors that librustc_ast emits directly into a `Sink` instead of stderr.
549 let sm = Lrc::new(SourceMap::new(FilePathMapping::empty()));
550 let fallback_bundle =
551 rustc_errors::fallback_fluent_bundle(rustc_errors::DEFAULT_LOCALE_RESOURCES, false);
552 supports_color = EmitterWriter::stderr(
556 fallback_bundle.clone(),
565 let emitter = EmitterWriter::new(
566 Box::new(io::sink()),
578 // FIXME(misdreavus): pass `-Z treat-err-as-bug` to the doctest parser
579 let handler = Handler::with_emitter(false, None, Box::new(emitter));
580 let sess = ParseSess::with_span_handler(handler, sm);
582 let mut found_main = false;
583 let mut found_extern_crate = crate_name.is_none();
584 let mut found_macro = false;
586 let mut parser = match maybe_new_parser_from_source_str(&sess, filename, source) {
590 return (found_main, found_extern_crate, found_macro);
595 match parser.parse_item(ForceCollect::No) {
598 if let ast::ItemKind::Fn(..) = item.kind {
599 if item.ident.name == sym::main {
605 if !found_extern_crate {
606 if let ast::ItemKind::ExternCrate(original) = item.kind {
607 // This code will never be reached if `crate_name` is none because
608 // `found_extern_crate` is initialized to `true` if it is none.
609 let crate_name = crate_name.unwrap();
612 Some(name) => found_extern_crate = name.as_str() == crate_name,
613 None => found_extern_crate = item.ident.as_str() == crate_name,
619 if let ast::ItemKind::MacCall(..) = item.kind {
624 if found_main && found_extern_crate {
635 // The supplied slice is only used for diagnostics,
636 // which are swallowed here anyway.
637 parser.maybe_consume_incorrect_semicolon(&[]);
640 // Reset errors so that they won't be reported as compiler bugs when dropping the
641 // handler. Any errors in the tests will be reported when the test file is compiled,
642 // Note that we still need to cancel the errors above otherwise `DiagnosticBuilder`
643 // will panic on drop.
644 sess.span_diagnostic.reset_err_count();
646 (found_main, found_extern_crate, found_macro)
649 let Ok((already_has_main, already_has_extern_crate, found_macro)) = result
651 // If the parser panicked due to a fatal error, pass the test code through unchanged.
652 // The error will be reported during compilation.
653 return (s.to_owned(), 0, false);
656 // If a doctest's `fn main` is being masked by a wrapper macro, the parsing loop above won't
657 // see it. In that case, run the old text-based scan to see if they at least have a main
658 // function written inside a macro invocation. See
659 // https://github.com/rust-lang/rust/issues/56898
660 let already_has_main = if found_macro && !already_has_main {
663 let comment = line.find("//");
664 if let Some(comment_begins) = comment { &line[0..comment_begins] } else { line }
666 .any(|code| code.contains("fn main"))
671 // Don't inject `extern crate std` because it's already injected by the
673 if !already_has_extern_crate && !opts.no_crate_inject && crate_name != Some("std") {
674 if let Some(crate_name) = crate_name {
675 // Don't inject `extern crate` if the crate is never used.
676 // NOTE: this is terribly inaccurate because it doesn't actually
677 // parse the source, but only has false positives, not false
679 if s.contains(crate_name) {
680 prog.push_str(&format!("extern crate r#{crate_name};\n"));
686 // FIXME: This code cannot yet handle no_std test cases yet
687 if dont_insert_main || already_has_main || prog.contains("![no_std]") {
688 prog.push_str(everything_else);
690 let returns_result = everything_else.trim_end().ends_with("(())");
691 // Give each doctest main function a unique name.
692 // This is for example needed for the tooling around `-C instrument-coverage`.
693 let inner_fn_name = if let Some(test_id) = test_id {
694 format!("_doctest_main_{test_id}")
698 let inner_attr = if test_id.is_some() { "#[allow(non_snake_case)] " } else { "" };
699 let (main_pre, main_post) = if returns_result {
702 "fn main() {{ {inner_attr}fn {inner_fn_name}() -> Result<(), impl core::fmt::Debug> {{\n",
704 format!("\n}} {inner_fn_name}().unwrap() }}"),
706 } else if test_id.is_some() {
708 format!("fn main() {{ {inner_attr}fn {inner_fn_name}() {{\n",),
709 format!("\n}} {inner_fn_name}() }}"),
712 ("fn main() {\n".into(), "\n}".into())
714 // Note on newlines: We insert a line/newline *before*, and *after*
715 // the doctest and adjust the `line_offset` accordingly.
716 // In the case of `-C instrument-coverage`, this means that the generated
717 // inner `main` function spans from the doctest opening codeblock to the
718 // closing one. For example
719 // /// ``` <- start of the inner main
720 // /// <- code under doctest
721 // /// ``` <- end of the inner main
724 prog.extend([&main_pre, everything_else, &main_post].iter().cloned());
727 debug!("final doctest:\n{prog}");
729 (prog, line_offset, supports_color)
732 fn check_if_attr_is_complete(source: &str, edition: Edition) -> bool {
733 if source.is_empty() {
734 // Empty content so nothing to check in here...
737 rustc_driver::catch_fatal_errors(|| {
738 rustc_span::create_session_if_not_set_then(edition, |_| {
739 use rustc_errors::emitter::EmitterWriter;
740 use rustc_errors::Handler;
741 use rustc_span::source_map::FilePathMapping;
743 let filename = FileName::anon_source_code(source);
744 // Any errors in parsing should also appear when the doctest is compiled for real, so just
745 // send all the errors that librustc_ast emits directly into a `Sink` instead of stderr.
746 let sm = Lrc::new(SourceMap::new(FilePathMapping::empty()));
747 let fallback_bundle =
748 rustc_errors::fallback_fluent_bundle(rustc_errors::DEFAULT_LOCALE_RESOURCES, false);
750 let emitter = EmitterWriter::new(
751 Box::new(io::sink()),
763 let handler = Handler::with_emitter(false, None, Box::new(emitter));
764 let sess = ParseSess::with_span_handler(handler, sm);
766 match maybe_new_parser_from_source_str(&sess, filename, source.to_owned()) {
769 debug!("Cannot build a parser to check mod attr so skipping...");
773 // If a parsing error happened, it's very likely that the attribute is incomplete.
774 if let Err(e) = parser.parse_attribute(InnerAttrPolicy::Permitted) {
778 // We now check if there is an unclosed delimiter for the attribute. To do so, we look at
779 // the `unclosed_delims` and see if the opening square bracket was closed.
784 unclosed.unclosed_span.map(|s| s.lo()).unwrap_or(BytePos(0)) != BytePos(2)
792 fn partition_source(s: &str, edition: Edition) -> (String, String, String) {
793 #[derive(Copy, Clone, PartialEq)]
794 enum PartitionState {
799 let mut state = PartitionState::Attrs;
800 let mut before = String::new();
801 let mut crates = String::new();
802 let mut after = String::new();
804 let mut mod_attr_pending = String::new();
806 for line in s.lines() {
807 let trimline = line.trim();
809 // FIXME(misdreavus): if a doc comment is placed on an extern crate statement, it will be
810 // shunted into "everything else"
812 PartitionState::Attrs => {
813 state = if trimline.starts_with("#![") {
814 if !check_if_attr_is_complete(line, edition) {
815 mod_attr_pending = line.to_owned();
817 mod_attr_pending.clear();
819 PartitionState::Attrs
820 } else if trimline.chars().all(|c| c.is_whitespace())
821 || (trimline.starts_with("//") && !trimline.starts_with("///"))
823 PartitionState::Attrs
824 } else if trimline.starts_with("extern crate")
825 || trimline.starts_with("#[macro_use] extern crate")
827 PartitionState::Crates
829 // First we check if the previous attribute was "complete"...
830 if !mod_attr_pending.is_empty() {
831 // If not, then we append the new line into the pending attribute to check
832 // if this time it's complete...
833 mod_attr_pending.push_str(line);
834 if !trimline.is_empty()
835 && check_if_attr_is_complete(&mod_attr_pending, edition)
837 // If it's complete, then we can clear the pending content.
838 mod_attr_pending.clear();
840 // In any case, this is considered as `PartitionState::Attrs` so it's
841 // prepended before rustdoc's inserts.
842 PartitionState::Attrs
844 PartitionState::Other
848 PartitionState::Crates => {
849 state = if trimline.starts_with("extern crate")
850 || trimline.starts_with("#[macro_use] extern crate")
851 || trimline.chars().all(|c| c.is_whitespace())
852 || (trimline.starts_with("//") && !trimline.starts_with("///"))
854 PartitionState::Crates
856 PartitionState::Other
859 PartitionState::Other => {}
863 PartitionState::Attrs => {
864 before.push_str(line);
867 PartitionState::Crates => {
868 crates.push_str(line);
871 PartitionState::Other => {
872 after.push_str(line);
878 debug!("before:\n{before}");
879 debug!("crates:\n{crates}");
880 debug!("after:\n{after}");
882 (before, after, crates)
885 pub(crate) trait Tester {
886 fn add_test(&mut self, test: String, config: LangString, line: usize);
887 fn get_line(&self) -> usize {
890 fn register_header(&mut self, _name: &str, _level: u32) {}
893 pub(crate) struct Collector {
894 pub(crate) tests: Vec<test::TestDescAndFn>,
896 // The name of the test displayed to the user, separated by `::`.
898 // In tests from Rust source, this is the path to the item
899 // e.g., `["std", "vec", "Vec", "push"]`.
901 // In tests from a markdown file, this is the titles of all headers (h1~h6)
902 // of the sections that contain the code block, e.g., if the markdown file is
915 // the `names` vector of that test will be `["Title", "Subtitle"]`.
918 rustdoc_options: RustdocOptions,
920 enable_per_target_ignores: bool,
922 opts: GlobalTestOptions,
924 source_map: Option<Lrc<SourceMap>>,
925 filename: Option<PathBuf>,
926 visited_tests: FxHashMap<(String, usize), usize>,
927 unused_extern_reports: Arc<Mutex<Vec<UnusedExterns>>>,
928 compiling_test_count: AtomicUsize,
934 rustdoc_options: RustdocOptions,
936 opts: GlobalTestOptions,
937 source_map: Option<Lrc<SourceMap>>,
938 filename: Option<PathBuf>,
939 enable_per_target_ignores: bool,
946 enable_per_target_ignores,
952 visited_tests: FxHashMap::default(),
953 unused_extern_reports: Default::default(),
954 compiling_test_count: AtomicUsize::new(0),
958 fn generate_name(&self, line: usize, filename: &FileName) -> String {
959 let mut item_path = self.names.join("::");
960 item_path.retain(|c| c != ' ');
961 if !item_path.is_empty() {
964 format!("{} - {}(line {})", filename.prefer_local(), item_path, line)
967 pub(crate) fn set_position(&mut self, position: Span) {
968 self.position = position;
971 fn get_filename(&self) -> FileName {
972 if let Some(ref source_map) = self.source_map {
973 let filename = source_map.span_to_filename(self.position);
974 if let FileName::Real(ref filename) = filename {
975 if let Ok(cur_dir) = env::current_dir() {
976 if let Some(local_path) = filename.local_path() {
977 if let Ok(path) = local_path.strip_prefix(&cur_dir) {
978 return path.to_owned().into();
984 } else if let Some(ref filename) = self.filename {
985 filename.clone().into()
987 FileName::Custom("input".to_owned())
992 impl Tester for Collector {
993 fn add_test(&mut self, test: String, config: LangString, line: usize) {
994 let filename = self.get_filename();
995 let name = self.generate_name(line, &filename);
996 let crate_name = self.crate_name.clone();
997 let opts = self.opts.clone();
998 let edition = config.edition.unwrap_or(self.rustdoc_options.edition);
999 let rustdoc_options = self.rustdoc_options.clone();
1000 let runtool = self.rustdoc_options.runtool.clone();
1001 let runtool_args = self.rustdoc_options.runtool_args.clone();
1002 let target = self.rustdoc_options.target.clone();
1003 let target_str = target.to_string();
1004 let unused_externs = self.unused_extern_reports.clone();
1005 let no_run = config.no_run || rustdoc_options.no_run;
1006 if !config.compile_fail {
1007 self.compiling_test_count.fetch_add(1, Ordering::SeqCst);
1010 let path = match &filename {
1011 FileName::Real(path) => {
1012 if let Some(local_path) = path.local_path() {
1013 local_path.to_path_buf()
1015 // Somehow we got the filename from the metadata of another crate, should never happen
1016 unreachable!("doctest from a different crate");
1019 _ => PathBuf::from(r"doctest.rs"),
1022 // For example `module/file.rs` would become `module_file_rs`
1027 .map(|c| if c.is_ascii_alphanumeric() { c } else { '_' })
1028 .collect::<String>();
1029 let test_id = format!(
1030 "{file}_{line}_{number}",
1034 // Increases the current test number, if this file already
1035 // exists or it creates a new entry with a test number of 0.
1036 self.visited_tests.entry((file.clone(), line)).and_modify(|v| *v += 1).or_insert(0)
1039 let outdir = if let Some(mut path) = rustdoc_options.persist_doctests.clone() {
1040 path.push(&test_id);
1042 if let Err(err) = std::fs::create_dir_all(&path) {
1043 eprintln!("Couldn't create directory for doctest executables: {}", err);
1044 panic::resume_unwind(Box::new(()));
1047 DirState::Perm(path)
1050 TempFileBuilder::new()
1051 .prefix("rustdoctest")
1053 .expect("rustdoc needs a tempdir"),
1057 debug!("creating test {name}: {test}");
1058 self.tests.push(test::TestDescAndFn {
1059 desc: test::TestDesc {
1060 name: test::DynTestName(name),
1061 ignore: match config.ignore {
1062 Ignore::All => true,
1063 Ignore::None => false,
1064 Ignore::Some(ref ignores) => ignores.iter().any(|s| target_str.contains(s)),
1066 ignore_message: None,
1067 // compiler failures are test failures
1068 should_panic: test::ShouldPanic::No,
1069 compile_fail: config.compile_fail,
1071 test_type: test::TestType::DocTest,
1073 testfn: test::DynTestFn(Box::new(move || {
1074 let report_unused_externs = |uext| {
1075 unused_externs.lock().unwrap().push(uext);
1092 report_unused_externs,
1095 if let Err(err) = res {
1097 TestFailure::CompileError => {
1098 eprint!("Couldn't compile the test.");
1100 TestFailure::UnexpectedCompilePass => {
1101 eprint!("Test compiled successfully, but it's marked `compile_fail`.");
1103 TestFailure::UnexpectedRunPass => {
1104 eprint!("Test executable succeeded, but it's marked `should_panic`.");
1106 TestFailure::MissingErrorCodes(codes) => {
1107 eprint!("Some expected error codes were not found: {:?}", codes);
1109 TestFailure::ExecutionError(err) => {
1110 eprint!("Couldn't run the test: {err}");
1111 if err.kind() == io::ErrorKind::PermissionDenied {
1112 eprint!(" - maybe your tempdir is mounted with noexec?");
1115 TestFailure::ExecutionFailure(out) => {
1116 eprintln!("Test executable failed ({reason}).", reason = out.status);
1118 // FIXME(#12309): An unfortunate side-effect of capturing the test
1119 // executable's output is that the relative ordering between the test's
1120 // stdout and stderr is lost. However, this is better than the
1121 // alternative: if the test executable inherited the parent's I/O
1122 // handles the output wouldn't be captured at all, even on success.
1124 // The ordering could be preserved if the test process' stderr was
1125 // redirected to stdout, but that functionality does not exist in the
1126 // standard library, so it may not be portable enough.
1127 let stdout = str::from_utf8(&out.stdout).unwrap_or_default();
1128 let stderr = str::from_utf8(&out.stderr).unwrap_or_default();
1130 if !stdout.is_empty() || !stderr.is_empty() {
1133 if !stdout.is_empty() {
1134 eprintln!("stdout:\n{stdout}");
1137 if !stderr.is_empty() {
1138 eprintln!("stderr:\n{stderr}");
1144 panic::resume_unwind(Box::new(()));
1151 fn get_line(&self) -> usize {
1152 if let Some(ref source_map) = self.source_map {
1153 let line = self.position.lo().to_usize();
1154 let line = source_map.lookup_char_pos(BytePos(line as u32)).line;
1155 if line > 0 { line - 1 } else { line }
1161 fn register_header(&mut self, name: &str, level: u32) {
1162 if self.use_headers {
1163 // We use these headings as test names, so it's good if
1164 // they're valid identifiers.
1169 if (i == 0 && rustc_lexer::is_id_start(c))
1170 || (i != 0 && rustc_lexer::is_id_continue(c))
1177 .collect::<String>();
1179 // Here we try to efficiently assemble the header titles into the
1180 // test name in the form of `h1::h2::h3::h4::h5::h6`.
1182 // Suppose that originally `self.names` contains `[h1, h2, h3]`...
1183 let level = level as usize;
1184 if level <= self.names.len() {
1185 // ... Consider `level == 2`. All headers in the lower levels
1186 // are irrelevant in this new level. So we should reset
1187 // `self.names` to contain headers until <h2>, and replace that
1188 // slot with the new name: `[h1, name]`.
1189 self.names.truncate(level);
1190 self.names[level - 1] = name;
1192 // ... On the other hand, consider `level == 5`. This means we
1193 // need to extend `self.names` to contain five headers. We fill
1194 // in the missing level (<h4>) with `_`. Thus `self.names` will
1195 // become `[h1, h2, h3, "_", name]`.
1196 if level - 1 > self.names.len() {
1197 self.names.resize(level - 1, "_".to_owned());
1199 self.names.push(name);
1205 struct HirCollector<'a, 'hir, 'tcx> {
1207 collector: &'a mut Collector,
1213 impl<'a, 'hir, 'tcx> HirCollector<'a, 'hir, 'tcx> {
1214 fn visit_testable<F: FnOnce(&mut Self)>(
1221 let ast_attrs = self.tcx.hir().attrs(hir_id);
1222 if let Some(ref cfg) = ast_attrs.cfg(self.tcx, &FxHashSet::default()) {
1223 if !cfg.matches(&self.sess.parse_sess, Some(self.tcx.features())) {
1228 let has_name = !name.is_empty();
1230 self.collector.names.push(name);
1233 // The collapse-docs pass won't combine sugared/raw doc attributes, or included files with
1234 // anything else, this will combine them for us.
1235 let attrs = Attributes::from_ast(ast_attrs);
1236 if let Some(doc) = attrs.collapsed_doc_value() {
1237 // Use the outermost invocation, so that doctest names come from where the docs were written.
1238 let span = ast_attrs
1240 .map(|span| span.ctxt().outer_expn().expansion_cause().unwrap_or(span))
1241 .unwrap_or(DUMMY_SP);
1242 self.collector.set_position(span);
1243 markdown::find_testable_code(
1247 self.collector.enable_per_target_ignores,
1248 Some(&crate::html::markdown::ExtraInfo::new(
1251 span_of_attrs(&attrs).unwrap_or(sp),
1259 self.collector.names.pop();
1264 impl<'a, 'hir, 'tcx> intravisit::Visitor<'hir> for HirCollector<'a, 'hir, 'tcx> {
1265 type NestedFilter = nested_filter::All;
1267 fn nested_visit_map(&mut self) -> Self::Map {
1271 fn visit_item(&mut self, item: &'hir hir::Item<'_>) {
1272 let name = match &item.kind {
1273 hir::ItemKind::Impl(impl_) => {
1274 rustc_hir_pretty::id_to_string(&self.map, impl_.self_ty.hir_id)
1276 _ => item.ident.to_string(),
1279 self.visit_testable(name, item.hir_id(), item.span, |this| {
1280 intravisit::walk_item(this, item);
1284 fn visit_trait_item(&mut self, item: &'hir hir::TraitItem<'_>) {
1285 self.visit_testable(item.ident.to_string(), item.hir_id(), item.span, |this| {
1286 intravisit::walk_trait_item(this, item);
1290 fn visit_impl_item(&mut self, item: &'hir hir::ImplItem<'_>) {
1291 self.visit_testable(item.ident.to_string(), item.hir_id(), item.span, |this| {
1292 intravisit::walk_impl_item(this, item);
1296 fn visit_foreign_item(&mut self, item: &'hir hir::ForeignItem<'_>) {
1297 self.visit_testable(item.ident.to_string(), item.hir_id(), item.span, |this| {
1298 intravisit::walk_foreign_item(this, item);
1302 fn visit_variant(&mut self, v: &'hir hir::Variant<'_>) {
1303 self.visit_testable(v.ident.to_string(), v.hir_id, v.span, |this| {
1304 intravisit::walk_variant(this, v);
1308 fn visit_field_def(&mut self, f: &'hir hir::FieldDef<'_>) {
1309 self.visit_testable(f.ident.to_string(), f.hir_id, f.span, |this| {
1310 intravisit::walk_field_def(this, f);