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::{types::AttributesExt, 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 edition: options.edition,
80 target_triple: options.target.clone(),
81 crate_name: options.crate_name.clone(),
82 ..config::Options::default()
85 let mut cfgs = options.cfgs.clone();
86 cfgs.push("doc".to_owned());
87 cfgs.push("doctest".to_owned());
88 let config = interface::Config {
90 crate_cfg: interface::parse_cfgspecs(cfgs),
96 diagnostic_output: DiagnosticOutput::Default,
99 parse_sess_created: None,
100 register_lints: Some(box crate::lint::register_lints),
101 override_queries: None,
102 make_codegen_backend: None,
103 registry: rustc_driver::diagnostics_registry(),
106 let mut test_args = options.test_args.clone();
107 let display_warnings = options.display_warnings;
108 let externs = options.externs.clone();
109 let json_unused_externs = options.json_unused_externs;
111 let res = interface::run_compiler(config, |compiler| {
112 compiler.enter(|queries| {
113 let _lower_to_hir = queries.lower_to_hir()?;
115 let crate_name = queries.crate_name()?.peek().to_string();
116 let mut global_ctxt = queries.global_ctxt()?.take();
118 let collector = global_ctxt.enter(|tcx| {
119 let krate = tcx.hir().krate();
120 let crate_attrs = tcx.hir().attrs(CRATE_HIR_ID);
122 let mut opts = scrape_test_config(crate_attrs);
123 opts.display_warnings |= options.display_warnings;
124 let enable_per_target_ignores = options.enable_per_target_ignores;
125 let mut collector = Collector::new(
130 Some(compiler.session().parse_sess.clone_source_map()),
132 enable_per_target_ignores,
135 let mut hir_collector = HirCollector {
136 sess: compiler.session(),
137 collector: &mut collector,
139 codes: ErrorCodes::from(
140 compiler.session().opts.unstable_features.is_nightly_build(),
144 hir_collector.visit_testable(
149 intravisit::walk_crate(this, krate);
155 compiler.session().abort_if_errors();
157 let unused_extern_reports = collector.unused_extern_reports.clone();
158 let compiling_test_count = collector.compiling_test_count.load(Ordering::SeqCst);
159 let ret: Result<_, ErrorReported> =
160 Ok((collector.tests, unused_extern_reports, compiling_test_count));
164 let (tests, unused_extern_reports, compiling_test_count) = match res {
166 Err(ErrorReported) => return Err(ErrorReported),
169 test_args.insert(0, "rustdoctest".to_string());
174 Some(testing::Options::new().display_output(display_warnings)),
177 // Collect and warn about unused externs, but only if we've gotten
178 // reports for each doctest
179 if json_unused_externs {
180 let unused_extern_reports: Vec<_> =
181 std::mem::take(&mut unused_extern_reports.lock().unwrap());
182 if unused_extern_reports.len() == compiling_test_count {
183 let extern_names = externs.iter().map(|(name, _)| name).collect::<FxHashSet<&String>>();
184 let mut unused_extern_names = unused_extern_reports
186 .map(|uexts| uexts.unused_extern_names.iter().collect::<FxHashSet<&String>>())
187 .fold(extern_names, |uextsa, uextsb| {
188 uextsa.intersection(&uextsb).map(|v| *v).collect::<FxHashSet<&String>>()
191 .map(|v| (*v).clone())
192 .collect::<Vec<String>>();
193 unused_extern_names.sort();
194 // Take the most severe lint level
195 let lint_level = unused_extern_reports
197 .map(|uexts| uexts.lint_level.as_str())
198 .max_by_key(|v| match *v {
202 // The allow lint level is not expected,
203 // as if allow is specified, no message
205 v => unreachable!("Invalid lint level '{}'", v),
209 let uext = UnusedExterns { lint_level, unused_extern_names };
210 let unused_extern_json = serde_json::to_string(&uext).unwrap();
211 eprintln!("{}", unused_extern_json);
218 // Look for `#![doc(test(no_crate_inject))]`, used by crates in the std facade.
219 fn scrape_test_config(attrs: &[ast::Attribute]) -> TestOptions {
220 use rustc_ast_pretty::pprust;
223 TestOptions { no_crate_inject: false, display_warnings: false, attrs: Vec::new() };
225 let test_attrs: Vec<_> = attrs
227 .filter(|a| a.has_name(sym::doc))
228 .flat_map(|a| a.meta_item_list().unwrap_or_else(Vec::new))
229 .filter(|a| a.has_name(sym::test))
231 let attrs = test_attrs.iter().flat_map(|a| a.meta_item_list().unwrap_or(&[]));
234 if attr.has_name(sym::no_crate_inject) {
235 opts.no_crate_inject = true;
237 if attr.has_name(sym::attr) {
238 if let Some(l) = attr.meta_item_list() {
240 opts.attrs.push(pprust::meta_list_item_to_string(item));
249 /// Documentation test failure modes.
251 /// The test failed to compile.
253 /// The test is marked `compile_fail` but compiled successfully.
254 UnexpectedCompilePass,
255 /// The test failed to compile (as expected) but the compiler output did not contain all
256 /// expected error codes.
257 MissingErrorCodes(Vec<String>),
258 /// The test binary was unable to be executed.
259 ExecutionError(io::Error),
260 /// The test binary exited with a non-zero exit code.
262 /// This typically means an assertion in the test failed or another form of panic occurred.
263 ExecutionFailure(process::Output),
264 /// The test is marked `should_panic` but the test binary executed successfully.
269 Temp(tempfile::TempDir),
274 fn path(&self) -> &std::path::Path {
276 DirState::Temp(t) => t.path(),
277 DirState::Perm(p) => p.as_path(),
282 // NOTE: Keep this in sync with the equivalent structs in rustc
284 // We could unify this struct the one in rustc but they have different
285 // ownership semantics, so doing so would create wasteful allocations.
286 #[derive(serde::Serialize, serde::Deserialize)]
287 struct UnusedExterns {
288 /// Lint level of the unused_crate_dependencies lint
290 /// List of unused externs by their names.
291 unused_extern_names: Vec<String>,
301 as_test_harness: bool,
302 runtool: Option<String>,
303 runtool_args: Vec<String>,
304 target: TargetTriple,
306 mut error_codes: Vec<String>,
312 report_unused_externs: impl Fn(UnusedExterns),
313 ) -> Result<(), TestFailure> {
314 let (test, line_offset, supports_color) =
315 make_test(test, Some(cratename), as_test_harness, opts, edition, Some(test_id));
317 let output_file = outdir.path().join("rust_out");
319 let rustc_binary = options
322 .unwrap_or_else(|| rustc_interface::util::rustc_path().expect("found rustc"));
323 let mut compiler = Command::new(&rustc_binary);
324 compiler.arg("--crate-type").arg("bin");
325 for cfg in &options.cfgs {
326 compiler.arg("--cfg").arg(&cfg);
328 if let Some(sysroot) = options.maybe_sysroot {
329 compiler.arg("--sysroot").arg(sysroot);
331 compiler.arg("--edition").arg(&edition.to_string());
332 compiler.env("UNSTABLE_RUSTDOC_TEST_PATH", path);
333 compiler.env("UNSTABLE_RUSTDOC_TEST_LINE", format!("{}", line as isize - line_offset as isize));
334 compiler.arg("-o").arg(&output_file);
336 compiler.arg("--test");
338 if options.json_unused_externs && !compile_fail {
339 compiler.arg("--error-format=json");
340 compiler.arg("--json").arg("unused-externs");
341 compiler.arg("-Z").arg("unstable-options");
342 compiler.arg("-W").arg("unused_crate_dependencies");
344 for lib_str in &options.lib_strs {
345 compiler.arg("-L").arg(&lib_str);
347 for extern_str in &options.extern_strs {
348 compiler.arg("--extern").arg(&extern_str);
350 compiler.arg("-Ccodegen-units=1");
351 for codegen_options_str in &options.codegen_options_strs {
352 compiler.arg("-C").arg(&codegen_options_str);
354 for debugging_option_str in &options.debugging_opts_strs {
355 compiler.arg("-Z").arg(&debugging_option_str);
357 if no_run && !compile_fail {
358 compiler.arg("--emit=metadata");
360 compiler.arg("--target").arg(match target {
361 TargetTriple::TargetTriple(s) => s,
362 TargetTriple::TargetPath(path) => {
363 path.to_str().expect("target path must be valid unicode").to_string()
366 if let ErrorOutputType::HumanReadable(kind) = options.error_format {
367 let (short, color_config) = kind.unzip();
370 compiler.arg("--error-format").arg("short");
374 ColorConfig::Never => {
375 compiler.arg("--color").arg("never");
377 ColorConfig::Always => {
378 compiler.arg("--color").arg("always");
380 ColorConfig::Auto => {
381 compiler.arg("--color").arg(if supports_color { "always" } else { "never" });
387 compiler.stdin(Stdio::piped());
388 compiler.stderr(Stdio::piped());
390 let mut child = compiler.spawn().expect("Failed to spawn rustc process");
392 let stdin = child.stdin.as_mut().expect("Failed to open stdin");
393 stdin.write_all(test.as_bytes()).expect("could write out test sources");
395 let output = child.wait_with_output().expect("Failed to read stdout");
397 struct Bomb<'a>(&'a str);
398 impl Drop for Bomb<'_> {
400 eprint!("{}", self.0);
403 let mut out_lines = str::from_utf8(&output.stderr)
407 if let Ok(uext) = serde_json::from_str::<UnusedExterns>(l) {
408 report_unused_externs(uext);
414 .collect::<Vec<_>>();
416 // Add a \n to the end to properly terminate the last line,
417 // but only if there was output to be printed
418 if out_lines.len() > 0 {
422 let out = out_lines.join("\n");
423 let _bomb = Bomb(&out);
424 match (output.status.success(), compile_fail) {
426 return Err(TestFailure::UnexpectedCompilePass);
430 if !error_codes.is_empty() {
431 // We used to check if the output contained "error[{}]: " but since we added the
432 // colored output, we can't anymore because of the color escape characters before
434 error_codes.retain(|err| !out.contains(&format!("error[{}]", err)));
436 if !error_codes.is_empty() {
437 return Err(TestFailure::MissingErrorCodes(error_codes));
442 return Err(TestFailure::CompileError);
453 if let Some(tool) = runtool {
454 cmd = Command::new(tool);
455 cmd.args(runtool_args);
456 cmd.arg(output_file);
458 cmd = Command::new(output_file);
460 if let Some(run_directory) = options.test_run_directory {
461 cmd.current_dir(run_directory);
465 Err(e) => return Err(TestFailure::ExecutionError(e)),
467 if should_panic && out.status.success() {
468 return Err(TestFailure::UnexpectedRunPass);
469 } else if !should_panic && !out.status.success() {
470 return Err(TestFailure::ExecutionFailure(out));
478 /// Transforms a test into code that can be compiled into a Rust binary, and returns the number of
479 /// lines before the test code begins as well as if the output stream supports colors or not.
482 cratename: Option<&str>,
483 dont_insert_main: bool,
486 test_id: Option<&str>,
487 ) -> (String, usize, bool) {
488 let (crate_attrs, everything_else, crates) = partition_source(s);
489 let everything_else = everything_else.trim();
490 let mut line_offset = 0;
491 let mut prog = String::new();
492 let mut supports_color = false;
494 if opts.attrs.is_empty() && !opts.display_warnings {
495 // If there aren't any attributes supplied by #![doc(test(attr(...)))], then allow some
496 // lints that are commonly triggered in doctests. The crate-level test attributes are
497 // commonly used to make tests fail in case they trigger warnings, so having this there in
498 // that case may cause some tests to pass when they shouldn't have.
499 prog.push_str("#![allow(unused)]\n");
503 // Next, any attributes that came from the crate root via #![doc(test(attr(...)))].
504 for attr in &opts.attrs {
505 prog.push_str(&format!("#![{}]\n", attr));
509 // Now push any outer attributes from the example, assuming they
510 // are intended to be crate attributes.
511 prog.push_str(&crate_attrs);
512 prog.push_str(&crates);
514 // Uses librustc_ast to parse the doctest and find if there's a main fn and the extern
515 // crate already is included.
516 let result = rustc_driver::catch_fatal_errors(|| {
517 rustc_span::with_session_globals(edition, || {
518 use rustc_errors::emitter::{Emitter, EmitterWriter};
519 use rustc_errors::Handler;
520 use rustc_parse::maybe_new_parser_from_source_str;
521 use rustc_parse::parser::ForceCollect;
522 use rustc_session::parse::ParseSess;
523 use rustc_span::source_map::FilePathMapping;
525 let filename = FileName::anon_source_code(s);
526 let source = crates + everything_else;
528 // Any errors in parsing should also appear when the doctest is compiled for real, so just
529 // send all the errors that librustc_ast emits directly into a `Sink` instead of stderr.
530 let sm = Lrc::new(SourceMap::new(FilePathMapping::empty()));
532 EmitterWriter::stderr(ColorConfig::Auto, None, false, false, Some(80), false)
536 EmitterWriter::new(box io::sink(), None, false, false, false, None, false);
538 // FIXME(misdreavus): pass `-Z treat-err-as-bug` to the doctest parser
539 let handler = Handler::with_emitter(false, None, box emitter);
540 let sess = ParseSess::with_span_handler(handler, sm);
542 let mut found_main = false;
543 let mut found_extern_crate = cratename.is_none();
544 let mut found_macro = false;
546 let mut parser = match maybe_new_parser_from_source_str(&sess, filename, source) {
549 for mut err in errs {
553 return (found_main, found_extern_crate, found_macro);
558 match parser.parse_item(ForceCollect::No) {
561 if let ast::ItemKind::Fn(..) = item.kind {
562 if item.ident.name == sym::main {
568 if !found_extern_crate {
569 if let ast::ItemKind::ExternCrate(original) = item.kind {
570 // This code will never be reached if `cratename` is none because
571 // `found_extern_crate` is initialized to `true` if it is none.
572 let cratename = cratename.unwrap();
575 Some(name) => found_extern_crate = name.as_str() == cratename,
576 None => found_extern_crate = item.ident.as_str() == cratename,
582 if let ast::ItemKind::MacCall(..) = item.kind {
587 if found_main && found_extern_crate {
599 // Reset errors so that they won't be reported as compiler bugs when dropping the
600 // handler. Any errors in the tests will be reported when the test file is compiled,
601 // Note that we still need to cancel the errors above otherwise `DiagnosticBuilder`
602 // will panic on drop.
603 sess.span_diagnostic.reset_err_count();
605 (found_main, found_extern_crate, found_macro)
608 let (already_has_main, already_has_extern_crate, found_macro) = match result {
609 Ok(result) => result,
610 Err(ErrorReported) => {
611 // If the parser panicked due to a fatal error, pass the test code through unchanged.
612 // The error will be reported during compilation.
613 return (s.to_owned(), 0, false);
617 // If a doctest's `fn main` is being masked by a wrapper macro, the parsing loop above won't
618 // see it. In that case, run the old text-based scan to see if they at least have a main
619 // function written inside a macro invocation. See
620 // https://github.com/rust-lang/rust/issues/56898
621 let already_has_main = if found_macro && !already_has_main {
624 let comment = line.find("//");
625 if let Some(comment_begins) = comment { &line[0..comment_begins] } else { line }
627 .any(|code| code.contains("fn main"))
632 // Don't inject `extern crate std` because it's already injected by the
634 if !already_has_extern_crate && !opts.no_crate_inject && cratename != Some("std") {
635 if let Some(cratename) = cratename {
636 // Don't inject `extern crate` if the crate is never used.
637 // NOTE: this is terribly inaccurate because it doesn't actually
638 // parse the source, but only has false positives, not false
640 if s.contains(cratename) {
641 prog.push_str(&format!("extern crate r#{};\n", cratename));
647 // FIXME: This code cannot yet handle no_std test cases yet
648 if dont_insert_main || already_has_main || prog.contains("![no_std]") {
649 prog.push_str(everything_else);
651 let returns_result = everything_else.trim_end().ends_with("(())");
652 // Give each doctest main function a unique name.
653 // This is for example needed for the tooling around `-Z instrument-coverage`.
654 let inner_fn_name = if let Some(test_id) = test_id {
655 format!("_doctest_main_{}", test_id)
659 let inner_attr = if test_id.is_some() { "#[allow(non_snake_case)] " } else { "" };
660 let (main_pre, main_post) = if returns_result {
663 "fn main() {{ {}fn {}() -> Result<(), impl core::fmt::Debug> {{\n",
664 inner_attr, inner_fn_name
666 format!("\n}} {}().unwrap() }}", inner_fn_name),
668 } else if test_id.is_some() {
670 format!("fn main() {{ {}fn {}() {{\n", inner_attr, inner_fn_name),
671 format!("\n}} {}() }}", inner_fn_name),
674 ("fn main() {\n".into(), "\n}".into())
676 // Note on newlines: We insert a line/newline *before*, and *after*
677 // the doctest and adjust the `line_offset` accordingly.
678 // In the case of `-Z instrument-coverage`, this means that the generated
679 // inner `main` function spans from the doctest opening codeblock to the
680 // closing one. For example
681 // /// ``` <- start of the inner main
682 // /// <- code under doctest
683 // /// ``` <- end of the inner main
686 prog.extend([&main_pre, everything_else, &main_post].iter().cloned());
689 debug!("final doctest:\n{}", prog);
691 (prog, line_offset, supports_color)
694 // FIXME(aburka): use a real parser to deal with multiline attributes
695 fn partition_source(s: &str) -> (String, String, String) {
696 #[derive(Copy, Clone, PartialEq)]
697 enum PartitionState {
702 let mut state = PartitionState::Attrs;
703 let mut before = String::new();
704 let mut crates = String::new();
705 let mut after = String::new();
707 for line in s.lines() {
708 let trimline = line.trim();
710 // FIXME(misdreavus): if a doc comment is placed on an extern crate statement, it will be
711 // shunted into "everything else"
713 PartitionState::Attrs => {
714 state = if trimline.starts_with("#![")
715 || trimline.chars().all(|c| c.is_whitespace())
716 || (trimline.starts_with("//") && !trimline.starts_with("///"))
718 PartitionState::Attrs
719 } else if trimline.starts_with("extern crate")
720 || trimline.starts_with("#[macro_use] extern crate")
722 PartitionState::Crates
724 PartitionState::Other
727 PartitionState::Crates => {
728 state = if trimline.starts_with("extern crate")
729 || trimline.starts_with("#[macro_use] extern crate")
730 || trimline.chars().all(|c| c.is_whitespace())
731 || (trimline.starts_with("//") && !trimline.starts_with("///"))
733 PartitionState::Crates
735 PartitionState::Other
738 PartitionState::Other => {}
742 PartitionState::Attrs => {
743 before.push_str(line);
746 PartitionState::Crates => {
747 crates.push_str(line);
750 PartitionState::Other => {
751 after.push_str(line);
757 debug!("before:\n{}", before);
758 debug!("crates:\n{}", crates);
759 debug!("after:\n{}", after);
761 (before, after, crates)
765 fn add_test(&mut self, test: String, config: LangString, line: usize);
766 fn get_line(&self) -> usize {
769 fn register_header(&mut self, _name: &str, _level: u32) {}
772 crate struct Collector {
773 crate tests: Vec<testing::TestDescAndFn>,
775 // The name of the test displayed to the user, separated by `::`.
777 // In tests from Rust source, this is the path to the item
778 // e.g., `["std", "vec", "Vec", "push"]`.
780 // In tests from a markdown file, this is the titles of all headers (h1~h6)
781 // of the sections that contain the code block, e.g., if the markdown file is
794 // the `names` vector of that test will be `["Title", "Subtitle"]`.
799 enable_per_target_ignores: bool,
803 source_map: Option<Lrc<SourceMap>>,
804 filename: Option<PathBuf>,
805 visited_tests: FxHashMap<(String, usize), usize>,
806 unused_extern_reports: Arc<Mutex<Vec<UnusedExterns>>>,
807 compiling_test_count: AtomicUsize,
816 source_map: Option<Lrc<SourceMap>>,
817 filename: Option<PathBuf>,
818 enable_per_target_ignores: bool,
825 enable_per_target_ignores,
831 visited_tests: FxHashMap::default(),
832 unused_extern_reports: Default::default(),
833 compiling_test_count: AtomicUsize::new(0),
837 fn generate_name(&self, line: usize, filename: &FileName) -> String {
838 let mut item_path = self.names.join("::");
839 if !item_path.is_empty() {
842 format!("{} - {}(line {})", filename.prefer_local(), item_path, line)
845 crate fn set_position(&mut self, position: Span) {
846 self.position = position;
849 fn get_filename(&self) -> FileName {
850 if let Some(ref source_map) = self.source_map {
851 let filename = source_map.span_to_filename(self.position);
852 if let FileName::Real(ref filename) = filename {
853 if let Ok(cur_dir) = env::current_dir() {
854 if let Some(local_path) = filename.local_path() {
855 if let Ok(path) = local_path.strip_prefix(&cur_dir) {
856 return path.to_owned().into();
862 } else if let Some(ref filename) = self.filename {
863 filename.clone().into()
865 FileName::Custom("input".to_owned())
870 impl Tester for Collector {
871 fn add_test(&mut self, test: String, config: LangString, line: usize) {
872 let filename = self.get_filename();
873 let name = self.generate_name(line, &filename);
874 let cratename = self.cratename.to_string();
875 let opts = self.opts.clone();
876 let edition = config.edition.unwrap_or(self.options.edition);
877 let options = self.options.clone();
878 let runtool = self.options.runtool.clone();
879 let runtool_args = self.options.runtool_args.clone();
880 let target = self.options.target.clone();
881 let target_str = target.to_string();
882 let unused_externs = self.unused_extern_reports.clone();
883 if !config.compile_fail {
884 self.compiling_test_count.fetch_add(1, Ordering::SeqCst);
887 let path = match &filename {
888 FileName::Real(path) => {
889 if let Some(local_path) = path.local_path() {
890 local_path.to_path_buf()
892 // Somehow we got the filename from the metadata of another crate, should never happen
893 unreachable!("doctest from a different crate");
896 _ => PathBuf::from(r"doctest.rs"),
899 // For example `module/file.rs` would become `module_file_rs`
904 .map(|c| if c.is_ascii_alphanumeric() { c } else { '_' })
905 .collect::<String>();
906 let test_id = format!(
907 "{file}_{line}_{number}",
911 // Increases the current test number, if this file already
912 // exists or it creates a new entry with a test number of 0.
913 self.visited_tests.entry((file.clone(), line)).and_modify(|v| *v += 1).or_insert(0)
916 let outdir = if let Some(mut path) = options.persist_doctests.clone() {
919 std::fs::create_dir_all(&path)
920 .expect("Couldn't create directory for doctest executables");
925 TempFileBuilder::new()
926 .prefix("rustdoctest")
928 .expect("rustdoc needs a tempdir"),
932 debug!("creating test {}: {}", name, test);
933 self.tests.push(testing::TestDescAndFn {
934 desc: testing::TestDesc {
935 name: testing::DynTestName(name),
936 ignore: match config.ignore {
938 Ignore::None => false,
939 Ignore::Some(ref ignores) => ignores.iter().any(|s| target_str.contains(s)),
941 // compiler failures are test failures
942 should_panic: testing::ShouldPanic::No,
943 allow_fail: config.allow_fail,
944 test_type: testing::TestType::DocTest,
946 testfn: testing::DynTestFn(box move || {
947 let report_unused_externs = |uext| {
948 unused_externs.lock().unwrap().push(uext);
950 let no_run = config.no_run || options.no_run;
969 report_unused_externs,
972 if let Err(err) = res {
974 TestFailure::CompileError => {
975 eprint!("Couldn't compile the test.");
977 TestFailure::UnexpectedCompilePass => {
978 eprint!("Test compiled successfully, but it's marked `compile_fail`.");
980 TestFailure::UnexpectedRunPass => {
981 eprint!("Test executable succeeded, but it's marked `should_panic`.");
983 TestFailure::MissingErrorCodes(codes) => {
984 eprint!("Some expected error codes were not found: {:?}", codes);
986 TestFailure::ExecutionError(err) => {
987 eprint!("Couldn't run the test: {}", err);
988 if err.kind() == io::ErrorKind::PermissionDenied {
989 eprint!(" - maybe your tempdir is mounted with noexec?");
992 TestFailure::ExecutionFailure(out) => {
993 let reason = if let Some(code) = out.status.code() {
994 format!("exit code {}", code)
996 String::from("terminated by signal")
999 eprintln!("Test executable failed ({}).", reason);
1001 // FIXME(#12309): An unfortunate side-effect of capturing the test
1002 // executable's output is that the relative ordering between the test's
1003 // stdout and stderr is lost. However, this is better than the
1004 // alternative: if the test executable inherited the parent's I/O
1005 // handles the output wouldn't be captured at all, even on success.
1007 // The ordering could be preserved if the test process' stderr was
1008 // redirected to stdout, but that functionality does not exist in the
1009 // standard library, so it may not be portable enough.
1010 let stdout = str::from_utf8(&out.stdout).unwrap_or_default();
1011 let stderr = str::from_utf8(&out.stderr).unwrap_or_default();
1013 if !stdout.is_empty() || !stderr.is_empty() {
1016 if !stdout.is_empty() {
1017 eprintln!("stdout:\n{}", stdout);
1020 if !stderr.is_empty() {
1021 eprintln!("stderr:\n{}", stderr);
1027 panic::resume_unwind(box ());
1033 fn get_line(&self) -> usize {
1034 if let Some(ref source_map) = self.source_map {
1035 let line = self.position.lo().to_usize();
1036 let line = source_map.lookup_char_pos(BytePos(line as u32)).line;
1037 if line > 0 { line - 1 } else { line }
1043 fn register_header(&mut self, name: &str, level: u32) {
1044 if self.use_headers {
1045 // We use these headings as test names, so it's good if
1046 // they're valid identifiers.
1051 if (i == 0 && rustc_lexer::is_id_start(c))
1052 || (i != 0 && rustc_lexer::is_id_continue(c))
1059 .collect::<String>();
1061 // Here we try to efficiently assemble the header titles into the
1062 // test name in the form of `h1::h2::h3::h4::h5::h6`.
1064 // Suppose that originally `self.names` contains `[h1, h2, h3]`...
1065 let level = level as usize;
1066 if level <= self.names.len() {
1067 // ... Consider `level == 2`. All headers in the lower levels
1068 // are irrelevant in this new level. So we should reset
1069 // `self.names` to contain headers until <h2>, and replace that
1070 // slot with the new name: `[h1, name]`.
1071 self.names.truncate(level);
1072 self.names[level - 1] = name;
1074 // ... On the other hand, consider `level == 5`. This means we
1075 // need to extend `self.names` to contain five headers. We fill
1076 // in the missing level (<h4>) with `_`. Thus `self.names` will
1077 // become `[h1, h2, h3, "_", name]`.
1078 if level - 1 > self.names.len() {
1079 self.names.resize(level - 1, "_".to_owned());
1081 self.names.push(name);
1087 struct HirCollector<'a, 'hir, 'tcx> {
1089 collector: &'a mut Collector,
1095 impl<'a, 'hir, 'tcx> HirCollector<'a, 'hir, 'tcx> {
1096 fn visit_testable<F: FnOnce(&mut Self)>(
1103 let ast_attrs = self.tcx.hir().attrs(hir_id);
1104 let mut attrs = Attributes::from_ast(ast_attrs, None);
1106 if let Some(ref cfg) = ast_attrs.cfg(self.sess) {
1107 if !cfg.matches(&self.sess.parse_sess, Some(&self.sess.features_untracked())) {
1112 let has_name = !name.is_empty();
1114 self.collector.names.push(name);
1117 attrs.unindent_doc_comments();
1118 // The collapse-docs pass won't combine sugared/raw doc attributes, or included files with
1119 // anything else, this will combine them for us.
1120 if let Some(doc) = attrs.collapsed_doc_value() {
1121 // Use the outermost invocation, so that doctest names come from where the docs were written.
1122 let span = ast_attrs
1124 .map(|span| span.ctxt().outer_expn().expansion_cause().unwrap_or(span))
1125 .unwrap_or(DUMMY_SP);
1126 self.collector.set_position(span);
1127 markdown::find_testable_code(
1131 self.collector.enable_per_target_ignores,
1132 Some(&crate::html::markdown::ExtraInfo::new(
1135 span_of_attrs(&attrs).unwrap_or(sp),
1143 self.collector.names.pop();
1148 impl<'a, 'hir, 'tcx> intravisit::Visitor<'hir> for HirCollector<'a, 'hir, 'tcx> {
1149 type Map = Map<'hir>;
1151 fn nested_visit_map(&mut self) -> intravisit::NestedVisitorMap<Self::Map> {
1152 intravisit::NestedVisitorMap::All(self.map)
1155 fn visit_item(&mut self, item: &'hir hir::Item<'_>) {
1156 let name = if let hir::ItemKind::Impl(impl_) = &item.kind {
1157 rustc_hir_pretty::id_to_string(&self.map, impl_.self_ty.hir_id)
1159 item.ident.to_string()
1162 self.visit_testable(name, item.hir_id(), item.span, |this| {
1163 intravisit::walk_item(this, item);
1167 fn visit_trait_item(&mut self, item: &'hir hir::TraitItem<'_>) {
1168 self.visit_testable(item.ident.to_string(), item.hir_id(), item.span, |this| {
1169 intravisit::walk_trait_item(this, item);
1173 fn visit_impl_item(&mut self, item: &'hir hir::ImplItem<'_>) {
1174 self.visit_testable(item.ident.to_string(), item.hir_id(), item.span, |this| {
1175 intravisit::walk_impl_item(this, item);
1179 fn visit_foreign_item(&mut self, item: &'hir hir::ForeignItem<'_>) {
1180 self.visit_testable(item.ident.to_string(), item.hir_id(), item.span, |this| {
1181 intravisit::walk_foreign_item(this, item);
1187 v: &'hir hir::Variant<'_>,
1188 g: &'hir hir::Generics<'_>,
1189 item_id: hir::HirId,
1191 self.visit_testable(v.ident.to_string(), v.id, v.span, |this| {
1192 intravisit::walk_variant(this, v, g, item_id);
1196 fn visit_field_def(&mut self, f: &'hir hir::FieldDef<'_>) {
1197 self.visit_testable(f.ident.to_string(), f.hir_id, f.span, |this| {
1198 intravisit::walk_field_def(this, f);
1202 fn visit_macro_def(&mut self, macro_def: &'hir hir::MacroDef<'_>) {
1203 self.visit_testable(
1204 macro_def.ident.to_string(),