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::new(crate::lint::register_lints)),
103 override_queries: None,
104 make_codegen_backend: None,
105 registry: rustc_driver::diagnostics_registry(),
108 let test_args = options.test_args.clone();
109 let display_warnings = options.display_warnings;
110 let nocapture = options.nocapture;
111 let externs = options.externs.clone();
112 let json_unused_externs = options.json_unused_externs;
114 let res = interface::run_compiler(config, |compiler| {
115 compiler.enter(|queries| {
116 let mut global_ctxt = queries.global_ctxt()?.take();
118 let collector = global_ctxt.enter(|tcx| {
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(
146 tcx.hir().span(CRATE_HIR_ID),
147 |this| tcx.hir().walk_toplevel_module(this),
152 compiler.session().abort_if_errors();
154 let unused_extern_reports = collector.unused_extern_reports.clone();
155 let compiling_test_count = collector.compiling_test_count.load(Ordering::SeqCst);
156 let ret: Result<_, ErrorReported> =
157 Ok((collector.tests, unused_extern_reports, compiling_test_count));
161 let (tests, unused_extern_reports, compiling_test_count) = match res {
163 Err(ErrorReported) => return Err(ErrorReported),
166 run_tests(test_args, nocapture, display_warnings, tests);
168 // Collect and warn about unused externs, but only if we've gotten
169 // reports for each doctest
170 if json_unused_externs {
171 let unused_extern_reports: Vec<_> =
172 std::mem::take(&mut unused_extern_reports.lock().unwrap());
173 if unused_extern_reports.len() == compiling_test_count {
174 let extern_names = externs.iter().map(|(name, _)| name).collect::<FxHashSet<&String>>();
175 let mut unused_extern_names = unused_extern_reports
177 .map(|uexts| uexts.unused_extern_names.iter().collect::<FxHashSet<&String>>())
178 .fold(extern_names, |uextsa, uextsb| {
179 uextsa.intersection(&uextsb).map(|v| *v).collect::<FxHashSet<&String>>()
182 .map(|v| (*v).clone())
183 .collect::<Vec<String>>();
184 unused_extern_names.sort();
185 // Take the most severe lint level
186 let lint_level = unused_extern_reports
188 .map(|uexts| uexts.lint_level.as_str())
189 .max_by_key(|v| match *v {
193 // The allow lint level is not expected,
194 // as if allow is specified, no message
196 v => unreachable!("Invalid lint level '{}'", v),
200 let uext = UnusedExterns { lint_level, unused_extern_names };
201 let unused_extern_json = serde_json::to_string(&uext).unwrap();
202 eprintln!("{}", unused_extern_json);
210 mut test_args: Vec<String>,
212 display_warnings: bool,
213 tests: Vec<test::TestDescAndFn>,
215 test_args.insert(0, "rustdoctest".to_string());
217 test_args.push("--nocapture".to_string());
219 test::test_main(&test_args, tests, Some(test::Options::new().display_output(display_warnings)));
222 // Look for `#![doc(test(no_crate_inject))]`, used by crates in the std facade.
223 fn scrape_test_config(attrs: &[ast::Attribute]) -> TestOptions {
224 use rustc_ast_pretty::pprust;
227 TestOptions { no_crate_inject: false, display_warnings: false, attrs: Vec::new() };
229 let test_attrs: Vec<_> = attrs
231 .filter(|a| a.has_name(sym::doc))
232 .flat_map(|a| a.meta_item_list().unwrap_or_else(Vec::new))
233 .filter(|a| a.has_name(sym::test))
235 let attrs = test_attrs.iter().flat_map(|a| a.meta_item_list().unwrap_or(&[]));
238 if attr.has_name(sym::no_crate_inject) {
239 opts.no_crate_inject = true;
241 if attr.has_name(sym::attr) {
242 if let Some(l) = attr.meta_item_list() {
244 opts.attrs.push(pprust::meta_list_item_to_string(item));
253 /// Documentation test failure modes.
255 /// The test failed to compile.
257 /// The test is marked `compile_fail` but compiled successfully.
258 UnexpectedCompilePass,
259 /// The test failed to compile (as expected) but the compiler output did not contain all
260 /// expected error codes.
261 MissingErrorCodes(Vec<String>),
262 /// The test binary was unable to be executed.
263 ExecutionError(io::Error),
264 /// The test binary exited with a non-zero exit code.
266 /// This typically means an assertion in the test failed or another form of panic occurred.
267 ExecutionFailure(process::Output),
268 /// The test is marked `should_panic` but the test binary executed successfully.
273 Temp(tempfile::TempDir),
278 fn path(&self) -> &std::path::Path {
280 DirState::Temp(t) => t.path(),
281 DirState::Perm(p) => p.as_path(),
286 // NOTE: Keep this in sync with the equivalent structs in rustc
288 // We could unify this struct the one in rustc but they have different
289 // ownership semantics, so doing so would create wasteful allocations.
290 #[derive(serde::Serialize, serde::Deserialize)]
291 struct UnusedExterns {
292 /// Lint level of the unused_crate_dependencies lint
294 /// List of unused externs by their names.
295 unused_extern_names: Vec<String>,
305 as_test_harness: bool,
306 runtool: Option<String>,
307 runtool_args: Vec<String>,
308 target: TargetTriple,
310 mut error_codes: Vec<String>,
316 report_unused_externs: impl Fn(UnusedExterns),
317 ) -> Result<(), TestFailure> {
318 let (test, line_offset, supports_color) =
319 make_test(test, Some(crate_name), as_test_harness, opts, edition, Some(test_id));
321 let output_file = outdir.path().join("rust_out");
323 let rustc_binary = options
326 .unwrap_or_else(|| rustc_interface::util::rustc_path().expect("found rustc"));
327 let mut compiler = Command::new(&rustc_binary);
328 compiler.arg("--crate-type").arg("bin");
329 for cfg in &options.cfgs {
330 compiler.arg("--cfg").arg(&cfg);
332 if let Some(sysroot) = options.maybe_sysroot {
333 compiler.arg("--sysroot").arg(sysroot);
335 compiler.arg("--edition").arg(&edition.to_string());
336 compiler.env("UNSTABLE_RUSTDOC_TEST_PATH", path);
337 compiler.env("UNSTABLE_RUSTDOC_TEST_LINE", format!("{}", line as isize - line_offset as isize));
338 compiler.arg("-o").arg(&output_file);
340 compiler.arg("--test");
342 if options.json_unused_externs && !compile_fail {
343 compiler.arg("--error-format=json");
344 compiler.arg("--json").arg("unused-externs");
345 compiler.arg("-Z").arg("unstable-options");
346 compiler.arg("-W").arg("unused_crate_dependencies");
348 for lib_str in &options.lib_strs {
349 compiler.arg("-L").arg(&lib_str);
351 for extern_str in &options.extern_strs {
352 compiler.arg("--extern").arg(&extern_str);
354 compiler.arg("-Ccodegen-units=1");
355 for codegen_options_str in &options.codegen_options_strs {
356 compiler.arg("-C").arg(&codegen_options_str);
358 for debugging_option_str in &options.debugging_opts_strs {
359 compiler.arg("-Z").arg(&debugging_option_str);
361 if no_run && !compile_fail && options.persist_doctests.is_none() {
362 compiler.arg("--emit=metadata");
364 compiler.arg("--target").arg(match target {
365 TargetTriple::TargetTriple(s) => s,
366 TargetTriple::TargetPath(path) => {
367 path.to_str().expect("target path must be valid unicode").to_string()
370 if let ErrorOutputType::HumanReadable(kind) = options.error_format {
371 let (short, color_config) = kind.unzip();
374 compiler.arg("--error-format").arg("short");
378 ColorConfig::Never => {
379 compiler.arg("--color").arg("never");
381 ColorConfig::Always => {
382 compiler.arg("--color").arg("always");
384 ColorConfig::Auto => {
385 compiler.arg("--color").arg(if supports_color { "always" } else { "never" });
391 compiler.stdin(Stdio::piped());
392 compiler.stderr(Stdio::piped());
394 let mut child = compiler.spawn().expect("Failed to spawn rustc process");
396 let stdin = child.stdin.as_mut().expect("Failed to open stdin");
397 stdin.write_all(test.as_bytes()).expect("could write out test sources");
399 let output = child.wait_with_output().expect("Failed to read stdout");
401 struct Bomb<'a>(&'a str);
402 impl Drop for Bomb<'_> {
404 eprint!("{}", self.0);
407 let mut out_lines = str::from_utf8(&output.stderr)
411 if let Ok(uext) = serde_json::from_str::<UnusedExterns>(l) {
412 report_unused_externs(uext);
418 .collect::<Vec<_>>();
420 // Add a \n to the end to properly terminate the last line,
421 // but only if there was output to be printed
422 if out_lines.len() > 0 {
426 let out = out_lines.join("\n");
427 let _bomb = Bomb(&out);
428 match (output.status.success(), compile_fail) {
430 return Err(TestFailure::UnexpectedCompilePass);
434 if !error_codes.is_empty() {
435 // We used to check if the output contained "error[{}]: " but since we added the
436 // colored output, we can't anymore because of the color escape characters before
438 error_codes.retain(|err| !out.contains(&format!("error[{}]", err)));
440 if !error_codes.is_empty() {
441 return Err(TestFailure::MissingErrorCodes(error_codes));
446 return Err(TestFailure::CompileError);
457 if let Some(tool) = runtool {
458 cmd = Command::new(tool);
459 cmd.args(runtool_args);
460 cmd.arg(output_file);
462 cmd = Command::new(output_file);
464 if let Some(run_directory) = options.test_run_directory {
465 cmd.current_dir(run_directory);
468 let result = if options.nocapture {
469 cmd.status().map(|status| process::Output {
478 Err(e) => return Err(TestFailure::ExecutionError(e)),
480 if should_panic && out.status.success() {
481 return Err(TestFailure::UnexpectedRunPass);
482 } else if !should_panic && !out.status.success() {
483 return Err(TestFailure::ExecutionFailure(out));
491 /// Transforms a test into code that can be compiled into a Rust binary, and returns the number of
492 /// lines before the test code begins as well as if the output stream supports colors or not.
495 crate_name: Option<&str>,
496 dont_insert_main: bool,
499 test_id: Option<&str>,
500 ) -> (String, usize, bool) {
501 let (crate_attrs, everything_else, crates) = partition_source(s);
502 let everything_else = everything_else.trim();
503 let mut line_offset = 0;
504 let mut prog = String::new();
505 let mut supports_color = false;
507 if opts.attrs.is_empty() && !opts.display_warnings {
508 // If there aren't any attributes supplied by #![doc(test(attr(...)))], then allow some
509 // lints that are commonly triggered in doctests. The crate-level test attributes are
510 // commonly used to make tests fail in case they trigger warnings, so having this there in
511 // that case may cause some tests to pass when they shouldn't have.
512 prog.push_str("#![allow(unused)]\n");
516 // Next, any attributes that came from the crate root via #![doc(test(attr(...)))].
517 for attr in &opts.attrs {
518 prog.push_str(&format!("#![{}]\n", attr));
522 // Now push any outer attributes from the example, assuming they
523 // are intended to be crate attributes.
524 prog.push_str(&crate_attrs);
525 prog.push_str(&crates);
527 // Uses librustc_ast to parse the doctest and find if there's a main fn and the extern
528 // crate already is included.
529 let result = rustc_driver::catch_fatal_errors(|| {
530 rustc_span::create_session_if_not_set_then(edition, |_| {
531 use rustc_errors::emitter::{Emitter, EmitterWriter};
532 use rustc_errors::Handler;
533 use rustc_parse::maybe_new_parser_from_source_str;
534 use rustc_parse::parser::ForceCollect;
535 use rustc_session::parse::ParseSess;
536 use rustc_span::source_map::FilePathMapping;
538 let filename = FileName::anon_source_code(s);
539 let source = crates + everything_else;
541 // Any errors in parsing should also appear when the doctest is compiled for real, so just
542 // send all the errors that librustc_ast emits directly into a `Sink` instead of stderr.
543 let sm = Lrc::new(SourceMap::new(FilePathMapping::empty()));
545 EmitterWriter::stderr(ColorConfig::Auto, None, false, false, Some(80), false)
549 EmitterWriter::new(Box::new(io::sink()), None, false, false, false, None, false);
551 // FIXME(misdreavus): pass `-Z treat-err-as-bug` to the doctest parser
552 let handler = Handler::with_emitter(false, None, Box::new(emitter));
553 let sess = ParseSess::with_span_handler(handler, sm);
555 let mut found_main = false;
556 let mut found_extern_crate = crate_name.is_none();
557 let mut found_macro = false;
559 let mut parser = match maybe_new_parser_from_source_str(&sess, filename, source) {
562 for mut err in errs {
566 return (found_main, found_extern_crate, found_macro);
571 match parser.parse_item(ForceCollect::No) {
574 if let ast::ItemKind::Fn(..) = item.kind {
575 if item.ident.name == sym::main {
581 if !found_extern_crate {
582 if let ast::ItemKind::ExternCrate(original) = item.kind {
583 // This code will never be reached if `crate_name` is none because
584 // `found_extern_crate` is initialized to `true` if it is none.
585 let crate_name = crate_name.unwrap();
588 Some(name) => found_extern_crate = name.as_str() == crate_name,
589 None => found_extern_crate = item.ident.as_str() == crate_name,
595 if let ast::ItemKind::MacCall(..) = item.kind {
600 if found_main && found_extern_crate {
612 // Reset errors so that they won't be reported as compiler bugs when dropping the
613 // handler. Any errors in the tests will be reported when the test file is compiled,
614 // Note that we still need to cancel the errors above otherwise `DiagnosticBuilder`
615 // will panic on drop.
616 sess.span_diagnostic.reset_err_count();
618 (found_main, found_extern_crate, found_macro)
621 let (already_has_main, already_has_extern_crate, found_macro) = match result {
622 Ok(result) => result,
623 Err(ErrorReported) => {
624 // If the parser panicked due to a fatal error, pass the test code through unchanged.
625 // The error will be reported during compilation.
626 return (s.to_owned(), 0, false);
630 // If a doctest's `fn main` is being masked by a wrapper macro, the parsing loop above won't
631 // see it. In that case, run the old text-based scan to see if they at least have a main
632 // function written inside a macro invocation. See
633 // https://github.com/rust-lang/rust/issues/56898
634 let already_has_main = if found_macro && !already_has_main {
637 let comment = line.find("//");
638 if let Some(comment_begins) = comment { &line[0..comment_begins] } else { line }
640 .any(|code| code.contains("fn main"))
645 // Don't inject `extern crate std` because it's already injected by the
647 if !already_has_extern_crate && !opts.no_crate_inject && crate_name != Some("std") {
648 if let Some(crate_name) = crate_name {
649 // Don't inject `extern crate` if the crate is never used.
650 // NOTE: this is terribly inaccurate because it doesn't actually
651 // parse the source, but only has false positives, not false
653 if s.contains(crate_name) {
654 prog.push_str(&format!("extern crate r#{};\n", crate_name));
660 // FIXME: This code cannot yet handle no_std test cases yet
661 if dont_insert_main || already_has_main || prog.contains("![no_std]") {
662 prog.push_str(everything_else);
664 let returns_result = everything_else.trim_end().ends_with("(())");
665 // Give each doctest main function a unique name.
666 // This is for example needed for the tooling around `-Z instrument-coverage`.
667 let inner_fn_name = if let Some(test_id) = test_id {
668 format!("_doctest_main_{}", test_id)
672 let inner_attr = if test_id.is_some() { "#[allow(non_snake_case)] " } else { "" };
673 let (main_pre, main_post) = if returns_result {
676 "fn main() {{ {}fn {}() -> Result<(), impl core::fmt::Debug> {{\n",
677 inner_attr, inner_fn_name
679 format!("\n}} {}().unwrap() }}", inner_fn_name),
681 } else if test_id.is_some() {
683 format!("fn main() {{ {}fn {}() {{\n", inner_attr, inner_fn_name),
684 format!("\n}} {}() }}", inner_fn_name),
687 ("fn main() {\n".into(), "\n}".into())
689 // Note on newlines: We insert a line/newline *before*, and *after*
690 // the doctest and adjust the `line_offset` accordingly.
691 // In the case of `-Z instrument-coverage`, this means that the generated
692 // inner `main` function spans from the doctest opening codeblock to the
693 // closing one. For example
694 // /// ``` <- start of the inner main
695 // /// <- code under doctest
696 // /// ``` <- end of the inner main
699 prog.extend([&main_pre, everything_else, &main_post].iter().cloned());
702 debug!("final doctest:\n{}", prog);
704 (prog, line_offset, supports_color)
707 // FIXME(aburka): use a real parser to deal with multiline attributes
708 fn partition_source(s: &str) -> (String, String, String) {
709 #[derive(Copy, Clone, PartialEq)]
710 enum PartitionState {
715 let mut state = PartitionState::Attrs;
716 let mut before = String::new();
717 let mut crates = String::new();
718 let mut after = String::new();
720 for line in s.lines() {
721 let trimline = line.trim();
723 // FIXME(misdreavus): if a doc comment is placed on an extern crate statement, it will be
724 // shunted into "everything else"
726 PartitionState::Attrs => {
727 state = if trimline.starts_with("#![")
728 || trimline.chars().all(|c| c.is_whitespace())
729 || (trimline.starts_with("//") && !trimline.starts_with("///"))
731 PartitionState::Attrs
732 } else if trimline.starts_with("extern crate")
733 || trimline.starts_with("#[macro_use] extern crate")
735 PartitionState::Crates
737 PartitionState::Other
740 PartitionState::Crates => {
741 state = if trimline.starts_with("extern crate")
742 || trimline.starts_with("#[macro_use] extern crate")
743 || trimline.chars().all(|c| c.is_whitespace())
744 || (trimline.starts_with("//") && !trimline.starts_with("///"))
746 PartitionState::Crates
748 PartitionState::Other
751 PartitionState::Other => {}
755 PartitionState::Attrs => {
756 before.push_str(line);
759 PartitionState::Crates => {
760 crates.push_str(line);
763 PartitionState::Other => {
764 after.push_str(line);
770 debug!("before:\n{}", before);
771 debug!("crates:\n{}", crates);
772 debug!("after:\n{}", after);
774 (before, after, crates)
778 fn add_test(&mut self, test: String, config: LangString, line: usize);
779 fn get_line(&self) -> usize {
782 fn register_header(&mut self, _name: &str, _level: u32) {}
785 crate struct Collector {
786 crate tests: Vec<test::TestDescAndFn>,
788 // The name of the test displayed to the user, separated by `::`.
790 // In tests from Rust source, this is the path to the item
791 // e.g., `["std", "vec", "Vec", "push"]`.
793 // In tests from a markdown file, this is the titles of all headers (h1~h6)
794 // of the sections that contain the code block, e.g., if the markdown file is
807 // the `names` vector of that test will be `["Title", "Subtitle"]`.
812 enable_per_target_ignores: bool,
816 source_map: Option<Lrc<SourceMap>>,
817 filename: Option<PathBuf>,
818 visited_tests: FxHashMap<(String, usize), usize>,
819 unused_extern_reports: Arc<Mutex<Vec<UnusedExterns>>>,
820 compiling_test_count: AtomicUsize,
829 source_map: Option<Lrc<SourceMap>>,
830 filename: Option<PathBuf>,
831 enable_per_target_ignores: bool,
838 enable_per_target_ignores,
844 visited_tests: FxHashMap::default(),
845 unused_extern_reports: Default::default(),
846 compiling_test_count: AtomicUsize::new(0),
850 fn generate_name(&self, line: usize, filename: &FileName) -> String {
851 let mut item_path = self.names.join("::");
852 if !item_path.is_empty() {
855 format!("{} - {}(line {})", filename.prefer_local(), item_path, line)
858 crate fn set_position(&mut self, position: Span) {
859 self.position = position;
862 fn get_filename(&self) -> FileName {
863 if let Some(ref source_map) = self.source_map {
864 let filename = source_map.span_to_filename(self.position);
865 if let FileName::Real(ref filename) = filename {
866 if let Ok(cur_dir) = env::current_dir() {
867 if let Some(local_path) = filename.local_path() {
868 if let Ok(path) = local_path.strip_prefix(&cur_dir) {
869 return path.to_owned().into();
875 } else if let Some(ref filename) = self.filename {
876 filename.clone().into()
878 FileName::Custom("input".to_owned())
883 impl Tester for Collector {
884 fn add_test(&mut self, test: String, config: LangString, line: usize) {
885 let filename = self.get_filename();
886 let name = self.generate_name(line, &filename);
887 let crate_name = self.crate_name.to_string();
888 let opts = self.opts.clone();
889 let edition = config.edition.unwrap_or(self.options.edition);
890 let options = self.options.clone();
891 let runtool = self.options.runtool.clone();
892 let runtool_args = self.options.runtool_args.clone();
893 let target = self.options.target.clone();
894 let target_str = target.to_string();
895 let unused_externs = self.unused_extern_reports.clone();
896 let no_run = config.no_run || options.no_run;
897 if !config.compile_fail {
898 self.compiling_test_count.fetch_add(1, Ordering::SeqCst);
901 let path = match &filename {
902 FileName::Real(path) => {
903 if let Some(local_path) = path.local_path() {
904 local_path.to_path_buf()
906 // Somehow we got the filename from the metadata of another crate, should never happen
907 unreachable!("doctest from a different crate");
910 _ => PathBuf::from(r"doctest.rs"),
913 // For example `module/file.rs` would become `module_file_rs`
918 .map(|c| if c.is_ascii_alphanumeric() { c } else { '_' })
919 .collect::<String>();
920 let test_id = format!(
921 "{file}_{line}_{number}",
925 // Increases the current test number, if this file already
926 // exists or it creates a new entry with a test number of 0.
927 self.visited_tests.entry((file.clone(), line)).and_modify(|v| *v += 1).or_insert(0)
930 let outdir = if let Some(mut path) = options.persist_doctests.clone() {
933 std::fs::create_dir_all(&path)
934 .expect("Couldn't create directory for doctest executables");
939 TempFileBuilder::new()
940 .prefix("rustdoctest")
942 .expect("rustdoc needs a tempdir"),
946 debug!("creating test {}: {}", name, test);
947 self.tests.push(test::TestDescAndFn {
948 desc: test::TestDesc {
949 name: test::DynTestName(name),
950 ignore: match config.ignore {
952 Ignore::None => false,
953 Ignore::Some(ref ignores) => ignores.iter().any(|s| target_str.contains(s)),
955 // compiler failures are test failures
956 should_panic: test::ShouldPanic::No,
957 allow_fail: config.allow_fail,
958 compile_fail: config.compile_fail,
960 test_type: test::TestType::DocTest,
962 testfn: test::DynTestFn(Box::new(move || {
963 let report_unused_externs = |uext| {
964 unused_externs.lock().unwrap().push(uext);
984 report_unused_externs,
987 if let Err(err) = res {
989 TestFailure::CompileError => {
990 eprint!("Couldn't compile the test.");
992 TestFailure::UnexpectedCompilePass => {
993 eprint!("Test compiled successfully, but it's marked `compile_fail`.");
995 TestFailure::UnexpectedRunPass => {
996 eprint!("Test executable succeeded, but it's marked `should_panic`.");
998 TestFailure::MissingErrorCodes(codes) => {
999 eprint!("Some expected error codes were not found: {:?}", codes);
1001 TestFailure::ExecutionError(err) => {
1002 eprint!("Couldn't run the test: {}", err);
1003 if err.kind() == io::ErrorKind::PermissionDenied {
1004 eprint!(" - maybe your tempdir is mounted with noexec?");
1007 TestFailure::ExecutionFailure(out) => {
1008 let reason = if let Some(code) = out.status.code() {
1009 format!("exit code {}", code)
1011 String::from("terminated by signal")
1014 eprintln!("Test executable failed ({}).", reason);
1016 // FIXME(#12309): An unfortunate side-effect of capturing the test
1017 // executable's output is that the relative ordering between the test's
1018 // stdout and stderr is lost. However, this is better than the
1019 // alternative: if the test executable inherited the parent's I/O
1020 // handles the output wouldn't be captured at all, even on success.
1022 // The ordering could be preserved if the test process' stderr was
1023 // redirected to stdout, but that functionality does not exist in the
1024 // standard library, so it may not be portable enough.
1025 let stdout = str::from_utf8(&out.stdout).unwrap_or_default();
1026 let stderr = str::from_utf8(&out.stderr).unwrap_or_default();
1028 if !stdout.is_empty() || !stderr.is_empty() {
1031 if !stdout.is_empty() {
1032 eprintln!("stdout:\n{}", stdout);
1035 if !stderr.is_empty() {
1036 eprintln!("stderr:\n{}", stderr);
1042 panic::resume_unwind(Box::new(()));
1048 fn get_line(&self) -> usize {
1049 if let Some(ref source_map) = self.source_map {
1050 let line = self.position.lo().to_usize();
1051 let line = source_map.lookup_char_pos(BytePos(line as u32)).line;
1052 if line > 0 { line - 1 } else { line }
1058 fn register_header(&mut self, name: &str, level: u32) {
1059 if self.use_headers {
1060 // We use these headings as test names, so it's good if
1061 // they're valid identifiers.
1066 if (i == 0 && rustc_lexer::is_id_start(c))
1067 || (i != 0 && rustc_lexer::is_id_continue(c))
1074 .collect::<String>();
1076 // Here we try to efficiently assemble the header titles into the
1077 // test name in the form of `h1::h2::h3::h4::h5::h6`.
1079 // Suppose that originally `self.names` contains `[h1, h2, h3]`...
1080 let level = level as usize;
1081 if level <= self.names.len() {
1082 // ... Consider `level == 2`. All headers in the lower levels
1083 // are irrelevant in this new level. So we should reset
1084 // `self.names` to contain headers until <h2>, and replace that
1085 // slot with the new name: `[h1, name]`.
1086 self.names.truncate(level);
1087 self.names[level - 1] = name;
1089 // ... On the other hand, consider `level == 5`. This means we
1090 // need to extend `self.names` to contain five headers. We fill
1091 // in the missing level (<h4>) with `_`. Thus `self.names` will
1092 // become `[h1, h2, h3, "_", name]`.
1093 if level - 1 > self.names.len() {
1094 self.names.resize(level - 1, "_".to_owned());
1096 self.names.push(name);
1102 struct HirCollector<'a, 'hir, 'tcx> {
1104 collector: &'a mut Collector,
1110 impl<'a, 'hir, 'tcx> HirCollector<'a, 'hir, 'tcx> {
1111 fn visit_testable<F: FnOnce(&mut Self)>(
1118 let ast_attrs = self.tcx.hir().attrs(hir_id);
1119 let mut attrs = Attributes::from_ast(ast_attrs, None);
1121 if let Some(ref cfg) = ast_attrs.cfg(self.sess) {
1122 if !cfg.matches(&self.sess.parse_sess, Some(&self.sess.features_untracked())) {
1127 let has_name = !name.is_empty();
1129 self.collector.names.push(name);
1132 attrs.unindent_doc_comments();
1133 // The collapse-docs pass won't combine sugared/raw doc attributes, or included files with
1134 // anything else, this will combine them for us.
1135 if let Some(doc) = attrs.collapsed_doc_value() {
1136 // Use the outermost invocation, so that doctest names come from where the docs were written.
1137 let span = ast_attrs
1139 .map(|span| span.ctxt().outer_expn().expansion_cause().unwrap_or(span))
1140 .unwrap_or(DUMMY_SP);
1141 self.collector.set_position(span);
1142 markdown::find_testable_code(
1146 self.collector.enable_per_target_ignores,
1147 Some(&crate::html::markdown::ExtraInfo::new(
1150 span_of_attrs(&attrs).unwrap_or(sp),
1158 self.collector.names.pop();
1163 impl<'a, 'hir, 'tcx> intravisit::Visitor<'hir> for HirCollector<'a, 'hir, 'tcx> {
1164 type Map = Map<'hir>;
1166 fn nested_visit_map(&mut self) -> intravisit::NestedVisitorMap<Self::Map> {
1167 intravisit::NestedVisitorMap::All(self.map)
1170 fn visit_item(&mut self, item: &'hir hir::Item<'_>) {
1171 let name = match &item.kind {
1172 hir::ItemKind::Macro(ref macro_def) => {
1173 // FIXME(#88038): Non exported macros have historically not been tested,
1174 // but we really ought to start testing them.
1175 let def_id = item.def_id.to_def_id();
1176 if macro_def.macro_rules && !self.tcx.has_attr(def_id, sym::macro_export) {
1177 intravisit::walk_item(self, item);
1180 item.ident.to_string()
1182 hir::ItemKind::Impl(impl_) => {
1183 rustc_hir_pretty::id_to_string(&self.map, impl_.self_ty.hir_id)
1185 _ => item.ident.to_string(),
1188 self.visit_testable(name, item.hir_id(), item.span, |this| {
1189 intravisit::walk_item(this, item);
1193 fn visit_trait_item(&mut self, item: &'hir hir::TraitItem<'_>) {
1194 self.visit_testable(item.ident.to_string(), item.hir_id(), item.span, |this| {
1195 intravisit::walk_trait_item(this, item);
1199 fn visit_impl_item(&mut self, item: &'hir hir::ImplItem<'_>) {
1200 self.visit_testable(item.ident.to_string(), item.hir_id(), item.span, |this| {
1201 intravisit::walk_impl_item(this, item);
1205 fn visit_foreign_item(&mut self, item: &'hir hir::ForeignItem<'_>) {
1206 self.visit_testable(item.ident.to_string(), item.hir_id(), item.span, |this| {
1207 intravisit::walk_foreign_item(this, item);
1213 v: &'hir hir::Variant<'_>,
1214 g: &'hir hir::Generics<'_>,
1215 item_id: hir::HirId,
1217 self.visit_testable(v.ident.to_string(), v.id, v.span, |this| {
1218 intravisit::walk_variant(this, v, g, item_id);
1222 fn visit_field_def(&mut self, f: &'hir hir::FieldDef<'_>) {
1223 self.visit_testable(f.ident.to_string(), f.hir_id, f.span, |this| {
1224 intravisit::walk_field_def(this, f);