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::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::ty::TyCtxt;
12 use rustc_session::config::{self, CrateType, ErrorOutputType};
13 use rustc_session::{lint, DiagnosticOutput, Session};
14 use rustc_span::edition::Edition;
15 use rustc_span::source_map::SourceMap;
16 use rustc_span::symbol::sym;
17 use rustc_span::Symbol;
18 use rustc_span::{BytePos, FileName, Pos, Span, DUMMY_SP};
19 use rustc_target::spec::TargetTriple;
20 use tempfile::Builder as TempFileBuilder;
23 use std::io::{self, Write};
25 use std::path::PathBuf;
26 use std::process::{self, Command, Stdio};
28 use std::sync::atomic::{AtomicUsize, Ordering};
29 use std::sync::{Arc, Mutex};
31 use crate::clean::{types::AttributesExt, Attributes};
32 use crate::config::Options;
33 use crate::html::markdown::{self, ErrorCodes, Ignore, LangString};
34 use crate::lint::init_lints;
35 use crate::passes::span_of_attrs;
37 #[derive(Clone, Default)]
38 crate struct TestOptions {
39 /// Whether to disable the default `extern crate my_crate;` when creating doctests.
40 crate no_crate_inject: bool,
41 /// Whether to emit compilation warnings when compiling doctests. Setting this will suppress
42 /// the default `#![allow(unused)]`.
43 crate display_warnings: bool,
44 /// Additional crate-level attributes to add to doctests.
45 crate attrs: Vec<String>,
48 crate fn run(options: Options) -> Result<(), ErrorReported> {
49 let input = config::Input::File(options.input.clone());
51 let invalid_codeblock_attributes_name = crate::lint::INVALID_CODEBLOCK_ATTRIBUTES.name;
53 // See core::create_config for what's going on here.
54 let allowed_lints = vec![
55 invalid_codeblock_attributes_name.to_owned(),
56 lint::builtin::UNKNOWN_LINTS.name.to_owned(),
57 lint::builtin::RENAMED_AND_REMOVED_LINTS.name.to_owned(),
60 let (lint_opts, lint_caps) = init_lints(allowed_lints, options.lint_opts.clone(), |lint| {
61 if lint.name == invalid_codeblock_attributes_name {
64 Some((lint.name_lower(), lint::Allow))
69 if options.proc_macro_crate { vec![CrateType::ProcMacro] } else { vec![CrateType::Rlib] };
71 let sessopts = config::Options {
72 maybe_sysroot: options.maybe_sysroot.clone(),
73 search_paths: options.libs.clone(),
75 lint_opts: if !options.display_warnings { lint_opts } else { vec![] },
76 lint_cap: Some(options.lint_cap.clone().unwrap_or_else(|| lint::Forbid)),
77 cg: options.codegen_options.clone(),
78 externs: options.externs.clone(),
79 unstable_features: options.render_options.unstable_features,
80 actually_rustdoc: true,
81 edition: options.edition,
82 target_triple: options.target.clone(),
83 crate_name: options.crate_name.clone(),
84 ..config::Options::default()
87 let mut cfgs = options.cfgs.clone();
88 cfgs.push("doc".to_owned());
89 cfgs.push("doctest".to_owned());
90 let config = interface::Config {
92 crate_cfg: interface::parse_cfgspecs(cfgs),
98 diagnostic_output: DiagnosticOutput::Default,
101 parse_sess_created: None,
102 register_lints: Some(box crate::lint::register_lints),
103 override_queries: None,
104 make_codegen_backend: None,
105 registry: rustc_driver::diagnostics_registry(),
108 let mut test_args = options.test_args.clone();
109 let display_warnings = options.display_warnings;
110 let externs = options.externs.clone();
111 let json_unused_externs = options.json_unused_externs;
113 let res = interface::run_compiler(config, |compiler| {
114 compiler.enter(|queries| {
115 let mut global_ctxt = queries.global_ctxt()?.take();
117 let collector = global_ctxt.enter(|tcx| {
118 let krate = tcx.hir().krate();
119 let crate_attrs = tcx.hir().attrs(CRATE_HIR_ID);
121 let mut opts = scrape_test_config(crate_attrs);
122 opts.display_warnings |= options.display_warnings;
123 let enable_per_target_ignores = options.enable_per_target_ignores;
124 let mut collector = Collector::new(
125 tcx.crate_name(LOCAL_CRATE),
129 Some(compiler.session().parse_sess.clone_source_map()),
131 enable_per_target_ignores,
134 let mut hir_collector = HirCollector {
135 sess: compiler.session(),
136 collector: &mut collector,
138 codes: ErrorCodes::from(
139 compiler.session().opts.unstable_features.is_nightly_build(),
143 hir_collector.visit_testable(
148 intravisit::walk_crate(this, krate);
154 compiler.session().abort_if_errors();
156 let unused_extern_reports = collector.unused_extern_reports.clone();
157 let compiling_test_count = collector.compiling_test_count.load(Ordering::SeqCst);
158 let ret: Result<_, ErrorReported> =
159 Ok((collector.tests, unused_extern_reports, compiling_test_count));
163 let (tests, unused_extern_reports, compiling_test_count) = match res {
165 Err(ErrorReported) => return Err(ErrorReported),
168 test_args.insert(0, "rustdoctest".to_string());
170 test::test_main(&test_args, tests, Some(test::Options::new().display_output(display_warnings)));
172 // Collect and warn about unused externs, but only if we've gotten
173 // reports for each doctest
174 if json_unused_externs {
175 let unused_extern_reports: Vec<_> =
176 std::mem::take(&mut unused_extern_reports.lock().unwrap());
177 if unused_extern_reports.len() == compiling_test_count {
178 let extern_names = externs.iter().map(|(name, _)| name).collect::<FxHashSet<&String>>();
179 let mut unused_extern_names = unused_extern_reports
181 .map(|uexts| uexts.unused_extern_names.iter().collect::<FxHashSet<&String>>())
182 .fold(extern_names, |uextsa, uextsb| {
183 uextsa.intersection(&uextsb).map(|v| *v).collect::<FxHashSet<&String>>()
186 .map(|v| (*v).clone())
187 .collect::<Vec<String>>();
188 unused_extern_names.sort();
189 // Take the most severe lint level
190 let lint_level = unused_extern_reports
192 .map(|uexts| uexts.lint_level.as_str())
193 .max_by_key(|v| match *v {
197 // The allow lint level is not expected,
198 // as if allow is specified, no message
200 v => unreachable!("Invalid lint level '{}'", v),
204 let uext = UnusedExterns { lint_level, unused_extern_names };
205 let unused_extern_json = serde_json::to_string(&uext).unwrap();
206 eprintln!("{}", unused_extern_json);
213 // Look for `#![doc(test(no_crate_inject))]`, used by crates in the std facade.
214 fn scrape_test_config(attrs: &[ast::Attribute]) -> TestOptions {
215 use rustc_ast_pretty::pprust;
218 TestOptions { no_crate_inject: false, display_warnings: false, attrs: Vec::new() };
220 let test_attrs: Vec<_> = attrs
222 .filter(|a| a.has_name(sym::doc))
223 .flat_map(|a| a.meta_item_list().unwrap_or_else(Vec::new))
224 .filter(|a| a.has_name(sym::test))
226 let attrs = test_attrs.iter().flat_map(|a| a.meta_item_list().unwrap_or(&[]));
229 if attr.has_name(sym::no_crate_inject) {
230 opts.no_crate_inject = true;
232 if attr.has_name(sym::attr) {
233 if let Some(l) = attr.meta_item_list() {
235 opts.attrs.push(pprust::meta_list_item_to_string(item));
244 /// Documentation test failure modes.
246 /// The test failed to compile.
248 /// The test is marked `compile_fail` but compiled successfully.
249 UnexpectedCompilePass,
250 /// The test failed to compile (as expected) but the compiler output did not contain all
251 /// expected error codes.
252 MissingErrorCodes(Vec<String>),
253 /// The test binary was unable to be executed.
254 ExecutionError(io::Error),
255 /// The test binary exited with a non-zero exit code.
257 /// This typically means an assertion in the test failed or another form of panic occurred.
258 ExecutionFailure(process::Output),
259 /// The test is marked `should_panic` but the test binary executed successfully.
264 Temp(tempfile::TempDir),
269 fn path(&self) -> &std::path::Path {
271 DirState::Temp(t) => t.path(),
272 DirState::Perm(p) => p.as_path(),
277 // NOTE: Keep this in sync with the equivalent structs in rustc
279 // We could unify this struct the one in rustc but they have different
280 // ownership semantics, so doing so would create wasteful allocations.
281 #[derive(serde::Serialize, serde::Deserialize)]
282 struct UnusedExterns {
283 /// Lint level of the unused_crate_dependencies lint
285 /// List of unused externs by their names.
286 unused_extern_names: Vec<String>,
296 as_test_harness: bool,
297 runtool: Option<String>,
298 runtool_args: Vec<String>,
299 target: TargetTriple,
301 mut error_codes: Vec<String>,
307 report_unused_externs: impl Fn(UnusedExterns),
308 ) -> Result<(), TestFailure> {
309 let (test, line_offset, supports_color) =
310 make_test(test, Some(crate_name), as_test_harness, opts, edition, Some(test_id));
312 let output_file = outdir.path().join("rust_out");
314 let rustc_binary = options
317 .unwrap_or_else(|| rustc_interface::util::rustc_path().expect("found rustc"));
318 let mut compiler = Command::new(&rustc_binary);
319 compiler.arg("--crate-type").arg("bin");
320 for cfg in &options.cfgs {
321 compiler.arg("--cfg").arg(&cfg);
323 if let Some(sysroot) = options.maybe_sysroot {
324 compiler.arg("--sysroot").arg(sysroot);
326 compiler.arg("--edition").arg(&edition.to_string());
327 compiler.env("UNSTABLE_RUSTDOC_TEST_PATH", path);
328 compiler.env("UNSTABLE_RUSTDOC_TEST_LINE", format!("{}", line as isize - line_offset as isize));
329 compiler.arg("-o").arg(&output_file);
331 compiler.arg("--test");
333 if options.json_unused_externs && !compile_fail {
334 compiler.arg("--error-format=json");
335 compiler.arg("--json").arg("unused-externs");
336 compiler.arg("-Z").arg("unstable-options");
337 compiler.arg("-W").arg("unused_crate_dependencies");
339 for lib_str in &options.lib_strs {
340 compiler.arg("-L").arg(&lib_str);
342 for extern_str in &options.extern_strs {
343 compiler.arg("--extern").arg(&extern_str);
345 compiler.arg("-Ccodegen-units=1");
346 for codegen_options_str in &options.codegen_options_strs {
347 compiler.arg("-C").arg(&codegen_options_str);
349 for debugging_option_str in &options.debugging_opts_strs {
350 compiler.arg("-Z").arg(&debugging_option_str);
352 if no_run && !compile_fail {
353 compiler.arg("--emit=metadata");
355 compiler.arg("--target").arg(match target {
356 TargetTriple::TargetTriple(s) => s,
357 TargetTriple::TargetPath(path) => {
358 path.to_str().expect("target path must be valid unicode").to_string()
361 if let ErrorOutputType::HumanReadable(kind) = options.error_format {
362 let (short, color_config) = kind.unzip();
365 compiler.arg("--error-format").arg("short");
369 ColorConfig::Never => {
370 compiler.arg("--color").arg("never");
372 ColorConfig::Always => {
373 compiler.arg("--color").arg("always");
375 ColorConfig::Auto => {
376 compiler.arg("--color").arg(if supports_color { "always" } else { "never" });
382 compiler.stdin(Stdio::piped());
383 compiler.stderr(Stdio::piped());
385 let mut child = compiler.spawn().expect("Failed to spawn rustc process");
387 let stdin = child.stdin.as_mut().expect("Failed to open stdin");
388 stdin.write_all(test.as_bytes()).expect("could write out test sources");
390 let output = child.wait_with_output().expect("Failed to read stdout");
392 struct Bomb<'a>(&'a str);
393 impl Drop for Bomb<'_> {
395 eprint!("{}", self.0);
398 let mut out_lines = str::from_utf8(&output.stderr)
402 if let Ok(uext) = serde_json::from_str::<UnusedExterns>(l) {
403 report_unused_externs(uext);
409 .collect::<Vec<_>>();
411 // Add a \n to the end to properly terminate the last line,
412 // but only if there was output to be printed
413 if out_lines.len() > 0 {
417 let out = out_lines.join("\n");
418 let _bomb = Bomb(&out);
419 match (output.status.success(), compile_fail) {
421 return Err(TestFailure::UnexpectedCompilePass);
425 if !error_codes.is_empty() {
426 // We used to check if the output contained "error[{}]: " but since we added the
427 // colored output, we can't anymore because of the color escape characters before
429 error_codes.retain(|err| !out.contains(&format!("error[{}]", err)));
431 if !error_codes.is_empty() {
432 return Err(TestFailure::MissingErrorCodes(error_codes));
437 return Err(TestFailure::CompileError);
448 if let Some(tool) = runtool {
449 cmd = Command::new(tool);
450 cmd.args(runtool_args);
451 cmd.arg(output_file);
453 cmd = Command::new(output_file);
455 if let Some(run_directory) = options.test_run_directory {
456 cmd.current_dir(run_directory);
460 Err(e) => return Err(TestFailure::ExecutionError(e)),
462 if should_panic && out.status.success() {
463 return Err(TestFailure::UnexpectedRunPass);
464 } else if !should_panic && !out.status.success() {
465 return Err(TestFailure::ExecutionFailure(out));
473 /// Transforms a test into code that can be compiled into a Rust binary, and returns the number of
474 /// lines before the test code begins as well as if the output stream supports colors or not.
477 crate_name: Option<&str>,
478 dont_insert_main: bool,
481 test_id: Option<&str>,
482 ) -> (String, usize, bool) {
483 let (crate_attrs, everything_else, crates) = partition_source(s);
484 let everything_else = everything_else.trim();
485 let mut line_offset = 0;
486 let mut prog = String::new();
487 let mut supports_color = false;
489 if opts.attrs.is_empty() && !opts.display_warnings {
490 // If there aren't any attributes supplied by #![doc(test(attr(...)))], then allow some
491 // lints that are commonly triggered in doctests. The crate-level test attributes are
492 // commonly used to make tests fail in case they trigger warnings, so having this there in
493 // that case may cause some tests to pass when they shouldn't have.
494 prog.push_str("#![allow(unused)]\n");
498 // Next, any attributes that came from the crate root via #![doc(test(attr(...)))].
499 for attr in &opts.attrs {
500 prog.push_str(&format!("#![{}]\n", attr));
504 // Now push any outer attributes from the example, assuming they
505 // are intended to be crate attributes.
506 prog.push_str(&crate_attrs);
507 prog.push_str(&crates);
509 // Uses librustc_ast to parse the doctest and find if there's a main fn and the extern
510 // crate already is included.
511 let result = rustc_driver::catch_fatal_errors(|| {
512 rustc_span::create_session_if_not_set_then(edition, |_| {
513 use rustc_errors::emitter::{Emitter, EmitterWriter};
514 use rustc_errors::Handler;
515 use rustc_parse::maybe_new_parser_from_source_str;
516 use rustc_parse::parser::ForceCollect;
517 use rustc_session::parse::ParseSess;
518 use rustc_span::source_map::FilePathMapping;
520 let filename = FileName::anon_source_code(s);
521 let source = crates + everything_else;
523 // Any errors in parsing should also appear when the doctest is compiled for real, so just
524 // send all the errors that librustc_ast emits directly into a `Sink` instead of stderr.
525 let sm = Lrc::new(SourceMap::new(FilePathMapping::empty()));
527 EmitterWriter::stderr(ColorConfig::Auto, None, false, false, Some(80), false)
531 EmitterWriter::new(box io::sink(), None, false, false, false, None, false);
533 // FIXME(misdreavus): pass `-Z treat-err-as-bug` to the doctest parser
534 let handler = Handler::with_emitter(false, None, box emitter);
535 let sess = ParseSess::with_span_handler(handler, sm);
537 let mut found_main = false;
538 let mut found_extern_crate = crate_name.is_none();
539 let mut found_macro = false;
541 let mut parser = match maybe_new_parser_from_source_str(&sess, filename, source) {
544 for mut err in errs {
548 return (found_main, found_extern_crate, found_macro);
553 match parser.parse_item(ForceCollect::No) {
556 if let ast::ItemKind::Fn(..) = item.kind {
557 if item.ident.name == sym::main {
563 if !found_extern_crate {
564 if let ast::ItemKind::ExternCrate(original) = item.kind {
565 // This code will never be reached if `crate_name` is none because
566 // `found_extern_crate` is initialized to `true` if it is none.
567 let crate_name = crate_name.unwrap();
570 Some(name) => found_extern_crate = name.as_str() == crate_name,
571 None => found_extern_crate = item.ident.as_str() == crate_name,
577 if let ast::ItemKind::MacCall(..) = item.kind {
582 if found_main && found_extern_crate {
594 // Reset errors so that they won't be reported as compiler bugs when dropping the
595 // handler. Any errors in the tests will be reported when the test file is compiled,
596 // Note that we still need to cancel the errors above otherwise `DiagnosticBuilder`
597 // will panic on drop.
598 sess.span_diagnostic.reset_err_count();
600 (found_main, found_extern_crate, found_macro)
603 let (already_has_main, already_has_extern_crate, found_macro) = match result {
604 Ok(result) => result,
605 Err(ErrorReported) => {
606 // If the parser panicked due to a fatal error, pass the test code through unchanged.
607 // The error will be reported during compilation.
608 return (s.to_owned(), 0, false);
612 // If a doctest's `fn main` is being masked by a wrapper macro, the parsing loop above won't
613 // see it. In that case, run the old text-based scan to see if they at least have a main
614 // function written inside a macro invocation. See
615 // https://github.com/rust-lang/rust/issues/56898
616 let already_has_main = if found_macro && !already_has_main {
619 let comment = line.find("//");
620 if let Some(comment_begins) = comment { &line[0..comment_begins] } else { line }
622 .any(|code| code.contains("fn main"))
627 // Don't inject `extern crate std` because it's already injected by the
629 if !already_has_extern_crate && !opts.no_crate_inject && crate_name != Some("std") {
630 if let Some(crate_name) = crate_name {
631 // Don't inject `extern crate` if the crate is never used.
632 // NOTE: this is terribly inaccurate because it doesn't actually
633 // parse the source, but only has false positives, not false
635 if s.contains(crate_name) {
636 prog.push_str(&format!("extern crate r#{};\n", crate_name));
642 // FIXME: This code cannot yet handle no_std test cases yet
643 if dont_insert_main || already_has_main || prog.contains("![no_std]") {
644 prog.push_str(everything_else);
646 let returns_result = everything_else.trim_end().ends_with("(())");
647 // Give each doctest main function a unique name.
648 // This is for example needed for the tooling around `-Z instrument-coverage`.
649 let inner_fn_name = if let Some(test_id) = test_id {
650 format!("_doctest_main_{}", test_id)
654 let inner_attr = if test_id.is_some() { "#[allow(non_snake_case)] " } else { "" };
655 let (main_pre, main_post) = if returns_result {
658 "fn main() {{ {}fn {}() -> Result<(), impl core::fmt::Debug> {{\n",
659 inner_attr, inner_fn_name
661 format!("\n}} {}().unwrap() }}", inner_fn_name),
663 } else if test_id.is_some() {
665 format!("fn main() {{ {}fn {}() {{\n", inner_attr, inner_fn_name),
666 format!("\n}} {}() }}", inner_fn_name),
669 ("fn main() {\n".into(), "\n}".into())
671 // Note on newlines: We insert a line/newline *before*, and *after*
672 // the doctest and adjust the `line_offset` accordingly.
673 // In the case of `-Z instrument-coverage`, this means that the generated
674 // inner `main` function spans from the doctest opening codeblock to the
675 // closing one. For example
676 // /// ``` <- start of the inner main
677 // /// <- code under doctest
678 // /// ``` <- end of the inner main
681 prog.extend([&main_pre, everything_else, &main_post].iter().cloned());
684 debug!("final doctest:\n{}", prog);
686 (prog, line_offset, supports_color)
689 // FIXME(aburka): use a real parser to deal with multiline attributes
690 fn partition_source(s: &str) -> (String, String, String) {
691 #[derive(Copy, Clone, PartialEq)]
692 enum PartitionState {
697 let mut state = PartitionState::Attrs;
698 let mut before = String::new();
699 let mut crates = String::new();
700 let mut after = String::new();
702 for line in s.lines() {
703 let trimline = line.trim();
705 // FIXME(misdreavus): if a doc comment is placed on an extern crate statement, it will be
706 // shunted into "everything else"
708 PartitionState::Attrs => {
709 state = if trimline.starts_with("#![")
710 || trimline.chars().all(|c| c.is_whitespace())
711 || (trimline.starts_with("//") && !trimline.starts_with("///"))
713 PartitionState::Attrs
714 } else if trimline.starts_with("extern crate")
715 || trimline.starts_with("#[macro_use] extern crate")
717 PartitionState::Crates
719 PartitionState::Other
722 PartitionState::Crates => {
723 state = if trimline.starts_with("extern crate")
724 || trimline.starts_with("#[macro_use] extern crate")
725 || trimline.chars().all(|c| c.is_whitespace())
726 || (trimline.starts_with("//") && !trimline.starts_with("///"))
728 PartitionState::Crates
730 PartitionState::Other
733 PartitionState::Other => {}
737 PartitionState::Attrs => {
738 before.push_str(line);
741 PartitionState::Crates => {
742 crates.push_str(line);
745 PartitionState::Other => {
746 after.push_str(line);
752 debug!("before:\n{}", before);
753 debug!("crates:\n{}", crates);
754 debug!("after:\n{}", after);
756 (before, after, crates)
760 fn add_test(&mut self, test: String, config: LangString, line: usize);
761 fn get_line(&self) -> usize {
764 fn register_header(&mut self, _name: &str, _level: u32) {}
767 crate struct Collector {
768 crate tests: Vec<test::TestDescAndFn>,
770 // The name of the test displayed to the user, separated by `::`.
772 // In tests from Rust source, this is the path to the item
773 // e.g., `["std", "vec", "Vec", "push"]`.
775 // In tests from a markdown file, this is the titles of all headers (h1~h6)
776 // of the sections that contain the code block, e.g., if the markdown file is
789 // the `names` vector of that test will be `["Title", "Subtitle"]`.
794 enable_per_target_ignores: bool,
798 source_map: Option<Lrc<SourceMap>>,
799 filename: Option<PathBuf>,
800 visited_tests: FxHashMap<(String, usize), usize>,
801 unused_extern_reports: Arc<Mutex<Vec<UnusedExterns>>>,
802 compiling_test_count: AtomicUsize,
811 source_map: Option<Lrc<SourceMap>>,
812 filename: Option<PathBuf>,
813 enable_per_target_ignores: bool,
820 enable_per_target_ignores,
826 visited_tests: FxHashMap::default(),
827 unused_extern_reports: Default::default(),
828 compiling_test_count: AtomicUsize::new(0),
832 fn generate_name(&self, line: usize, filename: &FileName) -> String {
833 let mut item_path = self.names.join("::");
834 if !item_path.is_empty() {
837 format!("{} - {}(line {})", filename.prefer_local(), item_path, line)
840 crate fn set_position(&mut self, position: Span) {
841 self.position = position;
844 fn get_filename(&self) -> FileName {
845 if let Some(ref source_map) = self.source_map {
846 let filename = source_map.span_to_filename(self.position);
847 if let FileName::Real(ref filename) = filename {
848 if let Ok(cur_dir) = env::current_dir() {
849 if let Some(local_path) = filename.local_path() {
850 if let Ok(path) = local_path.strip_prefix(&cur_dir) {
851 return path.to_owned().into();
857 } else if let Some(ref filename) = self.filename {
858 filename.clone().into()
860 FileName::Custom("input".to_owned())
865 impl Tester for Collector {
866 fn add_test(&mut self, test: String, config: LangString, line: usize) {
867 let filename = self.get_filename();
868 let name = self.generate_name(line, &filename);
869 let crate_name = self.crate_name.to_string();
870 let opts = self.opts.clone();
871 let edition = config.edition.unwrap_or(self.options.edition);
872 let options = self.options.clone();
873 let runtool = self.options.runtool.clone();
874 let runtool_args = self.options.runtool_args.clone();
875 let target = self.options.target.clone();
876 let target_str = target.to_string();
877 let unused_externs = self.unused_extern_reports.clone();
878 let no_run = config.no_run || options.no_run;
879 if !config.compile_fail {
880 self.compiling_test_count.fetch_add(1, Ordering::SeqCst);
883 let path = match &filename {
884 FileName::Real(path) => {
885 if let Some(local_path) = path.local_path() {
886 local_path.to_path_buf()
888 // Somehow we got the filename from the metadata of another crate, should never happen
889 unreachable!("doctest from a different crate");
892 _ => PathBuf::from(r"doctest.rs"),
895 // For example `module/file.rs` would become `module_file_rs`
900 .map(|c| if c.is_ascii_alphanumeric() { c } else { '_' })
901 .collect::<String>();
902 let test_id = format!(
903 "{file}_{line}_{number}",
907 // Increases the current test number, if this file already
908 // exists or it creates a new entry with a test number of 0.
909 self.visited_tests.entry((file.clone(), line)).and_modify(|v| *v += 1).or_insert(0)
912 let outdir = if let Some(mut path) = options.persist_doctests.clone() {
915 std::fs::create_dir_all(&path)
916 .expect("Couldn't create directory for doctest executables");
921 TempFileBuilder::new()
922 .prefix("rustdoctest")
924 .expect("rustdoc needs a tempdir"),
928 debug!("creating test {}: {}", name, test);
929 self.tests.push(test::TestDescAndFn {
930 desc: test::TestDesc {
931 name: test::DynTestName(name),
932 ignore: match config.ignore {
934 Ignore::None => false,
935 Ignore::Some(ref ignores) => ignores.iter().any(|s| target_str.contains(s)),
937 // compiler failures are test failures
938 should_panic: test::ShouldPanic::No,
939 allow_fail: config.allow_fail,
940 compile_fail: config.compile_fail,
942 test_type: test::TestType::DocTest,
944 testfn: test::DynTestFn(box move || {
945 let report_unused_externs = |uext| {
946 unused_externs.lock().unwrap().push(uext);
966 report_unused_externs,
969 if let Err(err) = res {
971 TestFailure::CompileError => {
972 eprint!("Couldn't compile the test.");
974 TestFailure::UnexpectedCompilePass => {
975 eprint!("Test compiled successfully, but it's marked `compile_fail`.");
977 TestFailure::UnexpectedRunPass => {
978 eprint!("Test executable succeeded, but it's marked `should_panic`.");
980 TestFailure::MissingErrorCodes(codes) => {
981 eprint!("Some expected error codes were not found: {:?}", codes);
983 TestFailure::ExecutionError(err) => {
984 eprint!("Couldn't run the test: {}", err);
985 if err.kind() == io::ErrorKind::PermissionDenied {
986 eprint!(" - maybe your tempdir is mounted with noexec?");
989 TestFailure::ExecutionFailure(out) => {
990 let reason = if let Some(code) = out.status.code() {
991 format!("exit code {}", code)
993 String::from("terminated by signal")
996 eprintln!("Test executable failed ({}).", reason);
998 // FIXME(#12309): An unfortunate side-effect of capturing the test
999 // executable's output is that the relative ordering between the test's
1000 // stdout and stderr is lost. However, this is better than the
1001 // alternative: if the test executable inherited the parent's I/O
1002 // handles the output wouldn't be captured at all, even on success.
1004 // The ordering could be preserved if the test process' stderr was
1005 // redirected to stdout, but that functionality does not exist in the
1006 // standard library, so it may not be portable enough.
1007 let stdout = str::from_utf8(&out.stdout).unwrap_or_default();
1008 let stderr = str::from_utf8(&out.stderr).unwrap_or_default();
1010 if !stdout.is_empty() || !stderr.is_empty() {
1013 if !stdout.is_empty() {
1014 eprintln!("stdout:\n{}", stdout);
1017 if !stderr.is_empty() {
1018 eprintln!("stderr:\n{}", stderr);
1024 panic::resume_unwind(box ());
1030 fn get_line(&self) -> usize {
1031 if let Some(ref source_map) = self.source_map {
1032 let line = self.position.lo().to_usize();
1033 let line = source_map.lookup_char_pos(BytePos(line as u32)).line;
1034 if line > 0 { line - 1 } else { line }
1040 fn register_header(&mut self, name: &str, level: u32) {
1041 if self.use_headers {
1042 // We use these headings as test names, so it's good if
1043 // they're valid identifiers.
1048 if (i == 0 && rustc_lexer::is_id_start(c))
1049 || (i != 0 && rustc_lexer::is_id_continue(c))
1056 .collect::<String>();
1058 // Here we try to efficiently assemble the header titles into the
1059 // test name in the form of `h1::h2::h3::h4::h5::h6`.
1061 // Suppose that originally `self.names` contains `[h1, h2, h3]`...
1062 let level = level as usize;
1063 if level <= self.names.len() {
1064 // ... Consider `level == 2`. All headers in the lower levels
1065 // are irrelevant in this new level. So we should reset
1066 // `self.names` to contain headers until <h2>, and replace that
1067 // slot with the new name: `[h1, name]`.
1068 self.names.truncate(level);
1069 self.names[level - 1] = name;
1071 // ... On the other hand, consider `level == 5`. This means we
1072 // need to extend `self.names` to contain five headers. We fill
1073 // in the missing level (<h4>) with `_`. Thus `self.names` will
1074 // become `[h1, h2, h3, "_", name]`.
1075 if level - 1 > self.names.len() {
1076 self.names.resize(level - 1, "_".to_owned());
1078 self.names.push(name);
1084 struct HirCollector<'a, 'hir, 'tcx> {
1086 collector: &'a mut Collector,
1092 impl<'a, 'hir, 'tcx> HirCollector<'a, 'hir, 'tcx> {
1093 fn visit_testable<F: FnOnce(&mut Self)>(
1100 let ast_attrs = self.tcx.hir().attrs(hir_id);
1101 let mut attrs = Attributes::from_ast(ast_attrs, None);
1103 if let Some(ref cfg) = ast_attrs.cfg(self.sess) {
1104 if !cfg.matches(&self.sess.parse_sess, Some(&self.sess.features_untracked())) {
1109 let has_name = !name.is_empty();
1111 self.collector.names.push(name);
1114 attrs.unindent_doc_comments();
1115 // The collapse-docs pass won't combine sugared/raw doc attributes, or included files with
1116 // anything else, this will combine them for us.
1117 if let Some(doc) = attrs.collapsed_doc_value() {
1118 // Use the outermost invocation, so that doctest names come from where the docs were written.
1119 let span = ast_attrs
1121 .map(|span| span.ctxt().outer_expn().expansion_cause().unwrap_or(span))
1122 .unwrap_or(DUMMY_SP);
1123 self.collector.set_position(span);
1124 markdown::find_testable_code(
1128 self.collector.enable_per_target_ignores,
1129 Some(&crate::html::markdown::ExtraInfo::new(
1132 span_of_attrs(&attrs).unwrap_or(sp),
1140 self.collector.names.pop();
1145 impl<'a, 'hir, 'tcx> intravisit::Visitor<'hir> for HirCollector<'a, 'hir, 'tcx> {
1146 type Map = Map<'hir>;
1148 fn nested_visit_map(&mut self) -> intravisit::NestedVisitorMap<Self::Map> {
1149 intravisit::NestedVisitorMap::All(self.map)
1152 fn visit_item(&mut self, item: &'hir hir::Item<'_>) {
1153 let name = if let hir::ItemKind::Impl(impl_) = &item.kind {
1154 rustc_hir_pretty::id_to_string(&self.map, impl_.self_ty.hir_id)
1156 item.ident.to_string()
1159 self.visit_testable(name, item.hir_id(), item.span, |this| {
1160 intravisit::walk_item(this, item);
1164 fn visit_trait_item(&mut self, item: &'hir hir::TraitItem<'_>) {
1165 self.visit_testable(item.ident.to_string(), item.hir_id(), item.span, |this| {
1166 intravisit::walk_trait_item(this, item);
1170 fn visit_impl_item(&mut self, item: &'hir hir::ImplItem<'_>) {
1171 self.visit_testable(item.ident.to_string(), item.hir_id(), item.span, |this| {
1172 intravisit::walk_impl_item(this, item);
1176 fn visit_foreign_item(&mut self, item: &'hir hir::ForeignItem<'_>) {
1177 self.visit_testable(item.ident.to_string(), item.hir_id(), item.span, |this| {
1178 intravisit::walk_foreign_item(this, item);
1184 v: &'hir hir::Variant<'_>,
1185 g: &'hir hir::Generics<'_>,
1186 item_id: hir::HirId,
1188 self.visit_testable(v.ident.to_string(), v.id, v.span, |this| {
1189 intravisit::walk_variant(this, v, g, item_id);
1193 fn visit_field_def(&mut self, f: &'hir hir::FieldDef<'_>) {
1194 self.visit_testable(f.ident.to_string(), f.hir_id, f.span, |this| {
1195 intravisit::walk_field_def(this, f);
1199 fn visit_macro_def(&mut self, macro_def: &'hir hir::MacroDef<'_>) {
1200 self.visit_testable(
1201 macro_def.ident.to_string(),