2 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
3 use rustc_data_structures::sync::Lrc;
4 use rustc_errors::{ColorConfig, ErrorReported};
6 use rustc_hir::intravisit;
7 use rustc_hir::{HirId, CRATE_HIR_ID};
8 use rustc_interface::interface;
9 use rustc_middle::hir::map::Map;
10 use rustc_middle::ty::TyCtxt;
11 use rustc_session::config::{self, CrateType, ErrorOutputType};
12 use rustc_session::{lint, DiagnosticOutput, Session};
13 use rustc_span::edition::Edition;
14 use rustc_span::source_map::SourceMap;
15 use rustc_span::symbol::sym;
16 use rustc_span::{BytePos, FileName, Pos, Span, DUMMY_SP};
17 use rustc_target::spec::TargetTriple;
18 use tempfile::Builder as TempFileBuilder;
21 use std::io::{self, Write};
23 use std::path::PathBuf;
24 use std::process::{self, Command, Stdio};
26 use std::sync::atomic::{AtomicUsize, Ordering};
27 use std::sync::{Arc, Mutex};
29 use crate::clean::Attributes;
30 use crate::config::Options;
31 use crate::html::markdown::{self, ErrorCodes, Ignore, LangString};
32 use crate::lint::init_lints;
33 use crate::passes::span_of_attrs;
35 #[derive(Clone, Default)]
36 crate struct TestOptions {
37 /// Whether to disable the default `extern crate my_crate;` when creating doctests.
38 crate no_crate_inject: bool,
39 /// Whether to emit compilation warnings when compiling doctests. Setting this will suppress
40 /// the default `#![allow(unused)]`.
41 crate display_warnings: bool,
42 /// Additional crate-level attributes to add to doctests.
43 crate attrs: Vec<String>,
46 crate fn run(options: Options) -> Result<(), ErrorReported> {
47 let input = config::Input::File(options.input.clone());
49 let invalid_codeblock_attributes_name = crate::lint::INVALID_CODEBLOCK_ATTRIBUTES.name;
51 // See core::create_config for what's going on here.
52 let allowed_lints = vec![
53 invalid_codeblock_attributes_name.to_owned(),
54 lint::builtin::UNKNOWN_LINTS.name.to_owned(),
55 lint::builtin::RENAMED_AND_REMOVED_LINTS.name.to_owned(),
58 let (lint_opts, lint_caps) = init_lints(allowed_lints, options.lint_opts.clone(), |lint| {
59 if lint.name == invalid_codeblock_attributes_name {
62 Some((lint.name_lower(), lint::Allow))
67 if options.proc_macro_crate { vec![CrateType::ProcMacro] } else { vec![CrateType::Rlib] };
69 let sessopts = config::Options {
70 maybe_sysroot: options.maybe_sysroot.clone(),
71 search_paths: options.libs.clone(),
73 lint_opts: if !options.display_warnings { lint_opts } else { vec![] },
74 lint_cap: Some(options.lint_cap.clone().unwrap_or_else(|| lint::Forbid)),
75 cg: options.codegen_options.clone(),
76 externs: options.externs.clone(),
77 unstable_features: options.render_options.unstable_features,
78 actually_rustdoc: true,
79 debugging_opts: config::DebuggingOptions { ..config::basic_debugging_options() },
80 edition: options.edition,
81 target_triple: options.target.clone(),
82 crate_name: options.crate_name.clone(),
83 ..config::Options::default()
86 let mut cfgs = options.cfgs.clone();
87 cfgs.push("doc".to_owned());
88 cfgs.push("doctest".to_owned());
89 let config = interface::Config {
91 crate_cfg: interface::parse_cfgspecs(cfgs),
97 diagnostic_output: DiagnosticOutput::Default,
100 parse_sess_created: None,
101 register_lints: Some(box crate::lint::register_lints),
102 override_queries: None,
103 make_codegen_backend: None,
104 registry: rustc_driver::diagnostics_registry(),
107 let mut test_args = options.test_args.clone();
108 let display_warnings = options.display_warnings;
109 let externs = options.externs.clone();
110 let json_unused_externs = options.json_unused_externs;
112 let res = interface::run_compiler(config, |compiler| {
113 compiler.enter(|queries| {
114 let _lower_to_hir = queries.lower_to_hir()?;
116 let crate_name = queries.crate_name()?.peek().to_string();
117 let mut global_ctxt = queries.global_ctxt()?.take();
119 let collector = global_ctxt.enter(|tcx| {
120 let krate = tcx.hir().krate();
121 let crate_attrs = tcx.hir().attrs(CRATE_HIR_ID);
123 let mut opts = scrape_test_config(crate_attrs);
124 opts.display_warnings |= options.display_warnings;
125 let enable_per_target_ignores = options.enable_per_target_ignores;
126 let mut collector = Collector::new(
131 Some(compiler.session().parse_sess.clone_source_map()),
133 enable_per_target_ignores,
136 let mut hir_collector = HirCollector {
137 sess: compiler.session(),
138 collector: &mut collector,
140 codes: ErrorCodes::from(
141 compiler.session().opts.unstable_features.is_nightly_build(),
145 hir_collector.visit_testable(
150 intravisit::walk_crate(this, krate);
156 compiler.session().abort_if_errors();
158 let unused_extern_reports = collector.unused_extern_reports.clone();
159 let compiling_test_count = collector.compiling_test_count.load(Ordering::SeqCst);
160 let ret: Result<_, ErrorReported> =
161 Ok((collector.tests, unused_extern_reports, compiling_test_count));
165 let (tests, unused_extern_reports, compiling_test_count) = match res {
167 Err(ErrorReported) => return Err(ErrorReported),
170 test_args.insert(0, "rustdoctest".to_string());
175 Some(testing::Options::new().display_output(display_warnings)),
178 // Collect and warn about unused externs, but only if we've gotten
179 // reports for each doctest
180 if json_unused_externs {
181 let unused_extern_reports: Vec<_> =
182 std::mem::take(&mut unused_extern_reports.lock().unwrap());
183 if unused_extern_reports.len() == compiling_test_count {
184 let extern_names = externs.iter().map(|(name, _)| name).collect::<FxHashSet<&String>>();
185 let mut unused_extern_names = unused_extern_reports
187 .map(|uexts| uexts.unused_extern_names.iter().collect::<FxHashSet<&String>>())
188 .fold(extern_names, |uextsa, uextsb| {
189 uextsa.intersection(&uextsb).map(|v| *v).collect::<FxHashSet<&String>>()
192 .map(|v| (*v).clone())
193 .collect::<Vec<String>>();
194 unused_extern_names.sort();
195 // Take the most severe lint level
196 let lint_level = unused_extern_reports
198 .map(|uexts| uexts.lint_level.as_str())
199 .max_by_key(|v| match *v {
203 // The allow lint level is not expected,
204 // as if allow is specified, no message
206 v => unreachable!("Invalid lint level '{}'", v),
210 let uext = UnusedExterns { lint_level, unused_extern_names };
211 let unused_extern_json = serde_json::to_string(&uext).unwrap();
212 eprintln!("{}", unused_extern_json);
219 // Look for `#![doc(test(no_crate_inject))]`, used by crates in the std facade.
220 fn scrape_test_config(attrs: &[ast::Attribute]) -> TestOptions {
221 use rustc_ast_pretty::pprust;
224 TestOptions { no_crate_inject: false, display_warnings: false, attrs: Vec::new() };
226 let test_attrs: Vec<_> = attrs
228 .filter(|a| a.has_name(sym::doc))
229 .flat_map(|a| a.meta_item_list().unwrap_or_else(Vec::new))
230 .filter(|a| a.has_name(sym::test))
232 let attrs = test_attrs.iter().flat_map(|a| a.meta_item_list().unwrap_or(&[]));
235 if attr.has_name(sym::no_crate_inject) {
236 opts.no_crate_inject = true;
238 if attr.has_name(sym::attr) {
239 if let Some(l) = attr.meta_item_list() {
241 opts.attrs.push(pprust::meta_list_item_to_string(item));
250 /// Documentation test failure modes.
252 /// The test failed to compile.
254 /// The test is marked `compile_fail` but compiled successfully.
255 UnexpectedCompilePass,
256 /// The test failed to compile (as expected) but the compiler output did not contain all
257 /// expected error codes.
258 MissingErrorCodes(Vec<String>),
259 /// The test binary was unable to be executed.
260 ExecutionError(io::Error),
261 /// The test binary exited with a non-zero exit code.
263 /// This typically means an assertion in the test failed or another form of panic occurred.
264 ExecutionFailure(process::Output),
265 /// The test is marked `should_panic` but the test binary executed successfully.
270 Temp(tempfile::TempDir),
275 fn path(&self) -> &std::path::Path {
277 DirState::Temp(t) => t.path(),
278 DirState::Perm(p) => p.as_path(),
283 // NOTE: Keep this in sync with the equivalent structs in rustc
285 // We could unify this struct the one in rustc but they have different
286 // ownership semantics, so doing so would create wasteful allocations.
287 #[derive(serde::Serialize, serde::Deserialize)]
288 struct UnusedExterns {
289 /// Lint level of the unused_crate_dependencies lint
291 /// List of unused externs by their names.
292 unused_extern_names: Vec<String>,
302 as_test_harness: bool,
303 runtool: Option<String>,
304 runtool_args: Vec<String>,
305 target: TargetTriple,
307 mut error_codes: Vec<String>,
313 report_unused_externs: impl Fn(UnusedExterns),
314 ) -> Result<(), TestFailure> {
315 let (test, line_offset, supports_color) =
316 make_test(test, Some(cratename), as_test_harness, opts, edition, Some(test_id));
318 let output_file = outdir.path().join("rust_out");
320 let rustc_binary = options
323 .unwrap_or_else(|| rustc_interface::util::rustc_path().expect("found rustc"));
324 let mut compiler = Command::new(&rustc_binary);
325 compiler.arg("--crate-type").arg("bin");
326 for cfg in &options.cfgs {
327 compiler.arg("--cfg").arg(&cfg);
329 if let Some(sysroot) = options.maybe_sysroot {
330 compiler.arg("--sysroot").arg(sysroot);
332 compiler.arg("--edition").arg(&edition.to_string());
333 compiler.env("UNSTABLE_RUSTDOC_TEST_PATH", path);
334 compiler.env("UNSTABLE_RUSTDOC_TEST_LINE", format!("{}", line as isize - line_offset as isize));
335 compiler.arg("-o").arg(&output_file);
337 compiler.arg("--test");
339 if options.json_unused_externs && !compile_fail {
340 compiler.arg("--error-format=json");
341 compiler.arg("--json").arg("unused-externs");
342 compiler.arg("-Z").arg("unstable-options");
343 compiler.arg("-W").arg("unused_crate_dependencies");
345 for lib_str in &options.lib_strs {
346 compiler.arg("-L").arg(&lib_str);
348 for extern_str in &options.extern_strs {
349 compiler.arg("--extern").arg(&extern_str);
351 compiler.arg("-Ccodegen-units=1");
352 for codegen_options_str in &options.codegen_options_strs {
353 compiler.arg("-C").arg(&codegen_options_str);
355 for debugging_option_str in &options.debugging_opts_strs {
356 compiler.arg("-Z").arg(&debugging_option_str);
358 if no_run && !compile_fail {
359 compiler.arg("--emit=metadata");
361 compiler.arg("--target").arg(match target {
362 TargetTriple::TargetTriple(s) => s,
363 TargetTriple::TargetPath(path) => {
364 path.to_str().expect("target path must be valid unicode").to_string()
367 if let ErrorOutputType::HumanReadable(kind) = options.error_format {
368 let (short, color_config) = kind.unzip();
371 compiler.arg("--error-format").arg("short");
375 ColorConfig::Never => {
376 compiler.arg("--color").arg("never");
378 ColorConfig::Always => {
379 compiler.arg("--color").arg("always");
381 ColorConfig::Auto => {
382 compiler.arg("--color").arg(if supports_color { "always" } else { "never" });
388 compiler.stdin(Stdio::piped());
389 compiler.stderr(Stdio::piped());
391 let mut child = compiler.spawn().expect("Failed to spawn rustc process");
393 let stdin = child.stdin.as_mut().expect("Failed to open stdin");
394 stdin.write_all(test.as_bytes()).expect("could write out test sources");
396 let output = child.wait_with_output().expect("Failed to read stdout");
398 struct Bomb<'a>(&'a str);
399 impl Drop for Bomb<'_> {
401 eprint!("{}", self.0);
404 let mut out_lines = str::from_utf8(&output.stderr)
408 if let Ok(uext) = serde_json::from_str::<UnusedExterns>(l) {
409 report_unused_externs(uext);
415 .collect::<Vec<_>>();
417 // Add a \n to the end to properly terminate the last line,
418 // but only if there was output to be printed
419 if out_lines.len() > 0 {
423 let out = out_lines.join("\n");
424 let _bomb = Bomb(&out);
425 match (output.status.success(), compile_fail) {
427 return Err(TestFailure::UnexpectedCompilePass);
431 if !error_codes.is_empty() {
432 // We used to check if the output contained "error[{}]: " but since we added the
433 // colored output, we can't anymore because of the color escape characters before
435 error_codes.retain(|err| !out.contains(&format!("error[{}]", err)));
437 if !error_codes.is_empty() {
438 return Err(TestFailure::MissingErrorCodes(error_codes));
443 return Err(TestFailure::CompileError);
454 if let Some(tool) = runtool {
455 cmd = Command::new(tool);
456 cmd.args(runtool_args);
457 cmd.arg(output_file);
459 cmd = Command::new(output_file);
461 if let Some(run_directory) = options.test_run_directory {
462 cmd.current_dir(run_directory);
466 Err(e) => return Err(TestFailure::ExecutionError(e)),
468 if should_panic && out.status.success() {
469 return Err(TestFailure::UnexpectedRunPass);
470 } else if !should_panic && !out.status.success() {
471 return Err(TestFailure::ExecutionFailure(out));
479 /// Transforms a test into code that can be compiled into a Rust binary, and returns the number of
480 /// lines before the test code begins as well as if the output stream supports colors or not.
483 cratename: Option<&str>,
484 dont_insert_main: bool,
487 test_id: Option<&str>,
488 ) -> (String, usize, bool) {
489 let (crate_attrs, everything_else, crates) = partition_source(s);
490 let everything_else = everything_else.trim();
491 let mut line_offset = 0;
492 let mut prog = String::new();
493 let mut supports_color = false;
495 if opts.attrs.is_empty() && !opts.display_warnings {
496 // If there aren't any attributes supplied by #![doc(test(attr(...)))], then allow some
497 // lints that are commonly triggered in doctests. The crate-level test attributes are
498 // commonly used to make tests fail in case they trigger warnings, so having this there in
499 // that case may cause some tests to pass when they shouldn't have.
500 prog.push_str("#![allow(unused)]\n");
504 // Next, any attributes that came from the crate root via #![doc(test(attr(...)))].
505 for attr in &opts.attrs {
506 prog.push_str(&format!("#![{}]\n", attr));
510 // Now push any outer attributes from the example, assuming they
511 // are intended to be crate attributes.
512 prog.push_str(&crate_attrs);
513 prog.push_str(&crates);
515 // Uses librustc_ast to parse the doctest and find if there's a main fn and the extern
516 // crate already is included.
517 let result = rustc_driver::catch_fatal_errors(|| {
518 rustc_span::with_session_globals(edition, || {
519 use rustc_errors::emitter::{Emitter, EmitterWriter};
520 use rustc_errors::Handler;
521 use rustc_parse::maybe_new_parser_from_source_str;
522 use rustc_parse::parser::ForceCollect;
523 use rustc_session::parse::ParseSess;
524 use rustc_span::source_map::FilePathMapping;
526 let filename = FileName::anon_source_code(s);
527 let source = crates + everything_else;
529 // Any errors in parsing should also appear when the doctest is compiled for real, so just
530 // send all the errors that librustc_ast emits directly into a `Sink` instead of stderr.
531 let sm = Lrc::new(SourceMap::new(FilePathMapping::empty()));
533 EmitterWriter::stderr(ColorConfig::Auto, None, false, false, Some(80), false)
537 EmitterWriter::new(box io::sink(), None, false, false, false, None, false);
539 // FIXME(misdreavus): pass `-Z treat-err-as-bug` to the doctest parser
540 let handler = Handler::with_emitter(false, None, box emitter);
541 let sess = ParseSess::with_span_handler(handler, sm);
543 let mut found_main = false;
544 let mut found_extern_crate = cratename.is_none();
545 let mut found_macro = false;
547 let mut parser = match maybe_new_parser_from_source_str(&sess, filename, source) {
550 for mut err in errs {
554 return (found_main, found_extern_crate, found_macro);
559 match parser.parse_item(ForceCollect::No) {
562 if let ast::ItemKind::Fn(..) = item.kind {
563 if item.ident.name == sym::main {
569 if !found_extern_crate {
570 if let ast::ItemKind::ExternCrate(original) = item.kind {
571 // This code will never be reached if `cratename` is none because
572 // `found_extern_crate` is initialized to `true` if it is none.
573 let cratename = cratename.unwrap();
576 Some(name) => found_extern_crate = name.as_str() == cratename,
577 None => found_extern_crate = item.ident.as_str() == cratename,
583 if let ast::ItemKind::MacCall(..) = item.kind {
588 if found_main && found_extern_crate {
600 // Reset errors so that they won't be reported as compiler bugs when dropping the
601 // handler. Any errors in the tests will be reported when the test file is compiled,
602 // Note that we still need to cancel the errors above otherwise `DiagnosticBuilder`
603 // will panic on drop.
604 sess.span_diagnostic.reset_err_count();
606 (found_main, found_extern_crate, found_macro)
609 let (already_has_main, already_has_extern_crate, found_macro) = match result {
610 Ok(result) => result,
611 Err(ErrorReported) => {
612 // If the parser panicked due to a fatal error, pass the test code through unchanged.
613 // The error will be reported during compilation.
614 return (s.to_owned(), 0, false);
618 // If a doctest's `fn main` is being masked by a wrapper macro, the parsing loop above won't
619 // see it. In that case, run the old text-based scan to see if they at least have a main
620 // function written inside a macro invocation. See
621 // https://github.com/rust-lang/rust/issues/56898
622 let already_has_main = if found_macro && !already_has_main {
625 let comment = line.find("//");
626 if let Some(comment_begins) = comment { &line[0..comment_begins] } else { line }
628 .any(|code| code.contains("fn main"))
633 // Don't inject `extern crate std` because it's already injected by the
635 if !already_has_extern_crate && !opts.no_crate_inject && cratename != Some("std") {
636 if let Some(cratename) = cratename {
637 // Don't inject `extern crate` if the crate is never used.
638 // NOTE: this is terribly inaccurate because it doesn't actually
639 // parse the source, but only has false positives, not false
641 if s.contains(cratename) {
642 prog.push_str(&format!("extern crate r#{};\n", cratename));
648 // FIXME: This code cannot yet handle no_std test cases yet
649 if dont_insert_main || already_has_main || prog.contains("![no_std]") {
650 prog.push_str(everything_else);
652 let returns_result = everything_else.trim_end().ends_with("(())");
653 // Give each doctest main function a unique name.
654 // This is for example needed for the tooling around `-Z instrument-coverage`.
655 let inner_fn_name = if let Some(test_id) = test_id {
656 format!("_doctest_main_{}", test_id)
660 let inner_attr = if test_id.is_some() { "#[allow(non_snake_case)] " } else { "" };
661 let (main_pre, main_post) = if returns_result {
664 "fn main() {{ {}fn {}() -> Result<(), impl core::fmt::Debug> {{\n",
665 inner_attr, inner_fn_name
667 format!("\n}} {}().unwrap() }}", inner_fn_name),
669 } else if test_id.is_some() {
671 format!("fn main() {{ {}fn {}() {{\n", inner_attr, inner_fn_name),
672 format!("\n}} {}() }}", inner_fn_name),
675 ("fn main() {\n".into(), "\n}".into())
677 // Note on newlines: We insert a line/newline *before*, and *after*
678 // the doctest and adjust the `line_offset` accordingly.
679 // In the case of `-Z instrument-coverage`, this means that the generated
680 // inner `main` function spans from the doctest opening codeblock to the
681 // closing one. For example
682 // /// ``` <- start of the inner main
683 // /// <- code under doctest
684 // /// ``` <- end of the inner main
687 prog.extend([&main_pre, everything_else, &main_post].iter().cloned());
690 debug!("final doctest:\n{}", prog);
692 (prog, line_offset, supports_color)
695 // FIXME(aburka): use a real parser to deal with multiline attributes
696 fn partition_source(s: &str) -> (String, String, String) {
697 #[derive(Copy, Clone, PartialEq)]
698 enum PartitionState {
703 let mut state = PartitionState::Attrs;
704 let mut before = String::new();
705 let mut crates = String::new();
706 let mut after = String::new();
708 for line in s.lines() {
709 let trimline = line.trim();
711 // FIXME(misdreavus): if a doc comment is placed on an extern crate statement, it will be
712 // shunted into "everything else"
714 PartitionState::Attrs => {
715 state = if trimline.starts_with("#![")
716 || trimline.chars().all(|c| c.is_whitespace())
717 || (trimline.starts_with("//") && !trimline.starts_with("///"))
719 PartitionState::Attrs
720 } else if trimline.starts_with("extern crate")
721 || trimline.starts_with("#[macro_use] extern crate")
723 PartitionState::Crates
725 PartitionState::Other
728 PartitionState::Crates => {
729 state = if trimline.starts_with("extern crate")
730 || trimline.starts_with("#[macro_use] extern crate")
731 || trimline.chars().all(|c| c.is_whitespace())
732 || (trimline.starts_with("//") && !trimline.starts_with("///"))
734 PartitionState::Crates
736 PartitionState::Other
739 PartitionState::Other => {}
743 PartitionState::Attrs => {
744 before.push_str(line);
747 PartitionState::Crates => {
748 crates.push_str(line);
751 PartitionState::Other => {
752 after.push_str(line);
758 debug!("before:\n{}", before);
759 debug!("crates:\n{}", crates);
760 debug!("after:\n{}", after);
762 (before, after, crates)
766 fn add_test(&mut self, test: String, config: LangString, line: usize);
767 fn get_line(&self) -> usize {
770 fn register_header(&mut self, _name: &str, _level: u32) {}
773 crate struct Collector {
774 crate tests: Vec<testing::TestDescAndFn>,
776 // The name of the test displayed to the user, separated by `::`.
778 // In tests from Rust source, this is the path to the item
779 // e.g., `["std", "vec", "Vec", "push"]`.
781 // In tests from a markdown file, this is the titles of all headers (h1~h6)
782 // of the sections that contain the code block, e.g., if the markdown file is
795 // the `names` vector of that test will be `["Title", "Subtitle"]`.
800 enable_per_target_ignores: bool,
804 source_map: Option<Lrc<SourceMap>>,
805 filename: Option<PathBuf>,
806 visited_tests: FxHashMap<(String, usize), usize>,
807 unused_extern_reports: Arc<Mutex<Vec<UnusedExterns>>>,
808 compiling_test_count: AtomicUsize,
817 source_map: Option<Lrc<SourceMap>>,
818 filename: Option<PathBuf>,
819 enable_per_target_ignores: bool,
826 enable_per_target_ignores,
832 visited_tests: FxHashMap::default(),
833 unused_extern_reports: Default::default(),
834 compiling_test_count: AtomicUsize::new(0),
838 fn generate_name(&self, line: usize, filename: &FileName) -> String {
839 let mut item_path = self.names.join("::");
840 if !item_path.is_empty() {
843 format!("{} - {}(line {})", filename, item_path, line)
846 crate fn set_position(&mut self, position: Span) {
847 self.position = position;
850 fn get_filename(&self) -> FileName {
851 if let Some(ref source_map) = self.source_map {
852 let filename = source_map.span_to_filename(self.position);
853 if let FileName::Real(ref filename) = filename {
854 if let Ok(cur_dir) = env::current_dir() {
855 if let Ok(path) = filename.local_path().strip_prefix(&cur_dir) {
856 return path.to_owned().into();
861 } else if let Some(ref filename) = self.filename {
862 filename.clone().into()
864 FileName::Custom("input".to_owned())
869 impl Tester for Collector {
870 fn add_test(&mut self, test: String, config: LangString, line: usize) {
871 let filename = self.get_filename();
872 let name = self.generate_name(line, &filename);
873 let cratename = self.cratename.to_string();
874 let opts = self.opts.clone();
875 let edition = config.edition.unwrap_or(self.options.edition);
876 let options = self.options.clone();
877 let runtool = self.options.runtool.clone();
878 let runtool_args = self.options.runtool_args.clone();
879 let target = self.options.target.clone();
880 let target_str = target.to_string();
881 let unused_externs = self.unused_extern_reports.clone();
882 if !config.compile_fail {
883 self.compiling_test_count.fetch_add(1, Ordering::SeqCst);
886 // FIXME(#44940): if doctests ever support path remapping, then this filename
887 // needs to be the result of `SourceMap::span_to_unmapped_path`.
888 let path = match &filename {
889 FileName::Real(path) => path.local_path().to_path_buf(),
890 _ => PathBuf::from(r"doctest.rs"),
893 // For example `module/file.rs` would become `module_file_rs`
897 .map(|c| if c.is_ascii_alphanumeric() { c } else { '_' })
898 .collect::<String>();
899 let test_id = format!(
900 "{file}_{line}_{number}",
904 // Increases the current test number, if this file already
905 // exists or it creates a new entry with a test number of 0.
906 self.visited_tests.entry((file.clone(), line)).and_modify(|v| *v += 1).or_insert(0)
909 let outdir = if let Some(mut path) = options.persist_doctests.clone() {
912 std::fs::create_dir_all(&path)
913 .expect("Couldn't create directory for doctest executables");
918 TempFileBuilder::new()
919 .prefix("rustdoctest")
921 .expect("rustdoc needs a tempdir"),
925 debug!("creating test {}: {}", name, test);
926 self.tests.push(testing::TestDescAndFn {
927 desc: testing::TestDesc {
928 name: testing::DynTestName(name),
929 ignore: match config.ignore {
931 Ignore::None => false,
932 Ignore::Some(ref ignores) => ignores.iter().any(|s| target_str.contains(s)),
934 // compiler failures are test failures
935 should_panic: testing::ShouldPanic::No,
936 allow_fail: config.allow_fail,
937 test_type: testing::TestType::DocTest,
939 testfn: testing::DynTestFn(box move || {
940 let report_unused_externs = |uext| {
941 unused_externs.lock().unwrap().push(uext);
961 report_unused_externs,
964 if let Err(err) = res {
966 TestFailure::CompileError => {
967 eprint!("Couldn't compile the test.");
969 TestFailure::UnexpectedCompilePass => {
970 eprint!("Test compiled successfully, but it's marked `compile_fail`.");
972 TestFailure::UnexpectedRunPass => {
973 eprint!("Test executable succeeded, but it's marked `should_panic`.");
975 TestFailure::MissingErrorCodes(codes) => {
976 eprint!("Some expected error codes were not found: {:?}", codes);
978 TestFailure::ExecutionError(err) => {
979 eprint!("Couldn't run the test: {}", err);
980 if err.kind() == io::ErrorKind::PermissionDenied {
981 eprint!(" - maybe your tempdir is mounted with noexec?");
984 TestFailure::ExecutionFailure(out) => {
985 let reason = if let Some(code) = out.status.code() {
986 format!("exit code {}", code)
988 String::from("terminated by signal")
991 eprintln!("Test executable failed ({}).", reason);
993 // FIXME(#12309): An unfortunate side-effect of capturing the test
994 // executable's output is that the relative ordering between the test's
995 // stdout and stderr is lost. However, this is better than the
996 // alternative: if the test executable inherited the parent's I/O
997 // handles the output wouldn't be captured at all, even on success.
999 // The ordering could be preserved if the test process' stderr was
1000 // redirected to stdout, but that functionality does not exist in the
1001 // standard library, so it may not be portable enough.
1002 let stdout = str::from_utf8(&out.stdout).unwrap_or_default();
1003 let stderr = str::from_utf8(&out.stderr).unwrap_or_default();
1005 if !stdout.is_empty() || !stderr.is_empty() {
1008 if !stdout.is_empty() {
1009 eprintln!("stdout:\n{}", stdout);
1012 if !stderr.is_empty() {
1013 eprintln!("stderr:\n{}", stderr);
1019 panic::resume_unwind(box ());
1025 fn get_line(&self) -> usize {
1026 if let Some(ref source_map) = self.source_map {
1027 let line = self.position.lo().to_usize();
1028 let line = source_map.lookup_char_pos(BytePos(line as u32)).line;
1029 if line > 0 { line - 1 } else { line }
1035 fn register_header(&mut self, name: &str, level: u32) {
1036 if self.use_headers {
1037 // We use these headings as test names, so it's good if
1038 // they're valid identifiers.
1043 if (i == 0 && rustc_lexer::is_id_start(c))
1044 || (i != 0 && rustc_lexer::is_id_continue(c))
1051 .collect::<String>();
1053 // Here we try to efficiently assemble the header titles into the
1054 // test name in the form of `h1::h2::h3::h4::h5::h6`.
1056 // Suppose that originally `self.names` contains `[h1, h2, h3]`...
1057 let level = level as usize;
1058 if level <= self.names.len() {
1059 // ... Consider `level == 2`. All headers in the lower levels
1060 // are irrelevant in this new level. So we should reset
1061 // `self.names` to contain headers until <h2>, and replace that
1062 // slot with the new name: `[h1, name]`.
1063 self.names.truncate(level);
1064 self.names[level - 1] = name;
1066 // ... On the other hand, consider `level == 5`. This means we
1067 // need to extend `self.names` to contain five headers. We fill
1068 // in the missing level (<h4>) with `_`. Thus `self.names` will
1069 // become `[h1, h2, h3, "_", name]`.
1070 if level - 1 > self.names.len() {
1071 self.names.resize(level - 1, "_".to_owned());
1073 self.names.push(name);
1079 struct HirCollector<'a, 'hir, 'tcx> {
1081 collector: &'a mut Collector,
1087 impl<'a, 'hir, 'tcx> HirCollector<'a, 'hir, 'tcx> {
1088 fn visit_testable<F: FnOnce(&mut Self)>(
1095 let attrs = self.tcx.hir().attrs(hir_id);
1096 let mut attrs = Attributes::from_ast(self.sess.diagnostic(), attrs, None);
1097 if let Some(ref cfg) = attrs.cfg {
1098 if !cfg.matches(&self.sess.parse_sess, Some(&self.sess.features_untracked())) {
1103 let has_name = !name.is_empty();
1105 self.collector.names.push(name);
1108 attrs.unindent_doc_comments();
1109 // The collapse-docs pass won't combine sugared/raw doc attributes, or included files with
1110 // anything else, this will combine them for us.
1111 if let Some(doc) = attrs.collapsed_doc_value() {
1112 // Use the outermost invocation, so that doctest names come from where the docs were written.
1115 .map(|span| span.ctxt().outer_expn().expansion_cause().unwrap_or(span))
1116 .unwrap_or(DUMMY_SP);
1117 self.collector.set_position(span);
1118 markdown::find_testable_code(
1122 self.collector.enable_per_target_ignores,
1123 Some(&crate::html::markdown::ExtraInfo::new(
1126 span_of_attrs(&attrs).unwrap_or(sp),
1134 self.collector.names.pop();
1139 impl<'a, 'hir, 'tcx> intravisit::Visitor<'hir> for HirCollector<'a, 'hir, 'tcx> {
1140 type Map = Map<'hir>;
1142 fn nested_visit_map(&mut self) -> intravisit::NestedVisitorMap<Self::Map> {
1143 intravisit::NestedVisitorMap::All(self.map)
1146 fn visit_item(&mut self, item: &'hir hir::Item<'_>) {
1147 let name = if let hir::ItemKind::Impl(impl_) = &item.kind {
1148 rustc_hir_pretty::id_to_string(&self.map, impl_.self_ty.hir_id)
1150 item.ident.to_string()
1153 self.visit_testable(name, item.hir_id(), item.span, |this| {
1154 intravisit::walk_item(this, item);
1158 fn visit_trait_item(&mut self, item: &'hir hir::TraitItem<'_>) {
1159 self.visit_testable(item.ident.to_string(), item.hir_id(), item.span, |this| {
1160 intravisit::walk_trait_item(this, item);
1164 fn visit_impl_item(&mut self, item: &'hir hir::ImplItem<'_>) {
1165 self.visit_testable(item.ident.to_string(), item.hir_id(), item.span, |this| {
1166 intravisit::walk_impl_item(this, item);
1170 fn visit_foreign_item(&mut self, item: &'hir hir::ForeignItem<'_>) {
1171 self.visit_testable(item.ident.to_string(), item.hir_id(), item.span, |this| {
1172 intravisit::walk_foreign_item(this, item);
1178 v: &'hir hir::Variant<'_>,
1179 g: &'hir hir::Generics<'_>,
1180 item_id: hir::HirId,
1182 self.visit_testable(v.ident.to_string(), v.id, v.span, |this| {
1183 intravisit::walk_variant(this, v, g, item_id);
1187 fn visit_field_def(&mut self, f: &'hir hir::FieldDef<'_>) {
1188 self.visit_testable(f.ident.to_string(), f.hir_id, f.span, |this| {
1189 intravisit::walk_field_def(this, f);
1193 fn visit_macro_def(&mut self, macro_def: &'hir hir::MacroDef<'_>) {
1194 self.visit_testable(
1195 macro_def.ident.to_string(),