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 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 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(
126 tcx.crate_name(LOCAL_CRATE),
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());
171 test_args.push("--nocapture".to_string());
174 test::test_main(&test_args, tests, Some(test::Options::new().display_output(display_warnings)));
176 // Collect and warn about unused externs, but only if we've gotten
177 // reports for each doctest
178 if json_unused_externs {
179 let unused_extern_reports: Vec<_> =
180 std::mem::take(&mut unused_extern_reports.lock().unwrap());
181 if unused_extern_reports.len() == compiling_test_count {
182 let extern_names = externs.iter().map(|(name, _)| name).collect::<FxHashSet<&String>>();
183 let mut unused_extern_names = unused_extern_reports
185 .map(|uexts| uexts.unused_extern_names.iter().collect::<FxHashSet<&String>>())
186 .fold(extern_names, |uextsa, uextsb| {
187 uextsa.intersection(&uextsb).map(|v| *v).collect::<FxHashSet<&String>>()
190 .map(|v| (*v).clone())
191 .collect::<Vec<String>>();
192 unused_extern_names.sort();
193 // Take the most severe lint level
194 let lint_level = unused_extern_reports
196 .map(|uexts| uexts.lint_level.as_str())
197 .max_by_key(|v| match *v {
201 // The allow lint level is not expected,
202 // as if allow is specified, no message
204 v => unreachable!("Invalid lint level '{}'", v),
208 let uext = UnusedExterns { lint_level, unused_extern_names };
209 let unused_extern_json = serde_json::to_string(&uext).unwrap();
210 eprintln!("{}", unused_extern_json);
217 // Look for `#![doc(test(no_crate_inject))]`, used by crates in the std facade.
218 fn scrape_test_config(attrs: &[ast::Attribute]) -> TestOptions {
219 use rustc_ast_pretty::pprust;
222 TestOptions { no_crate_inject: false, display_warnings: false, attrs: Vec::new() };
224 let test_attrs: Vec<_> = attrs
226 .filter(|a| a.has_name(sym::doc))
227 .flat_map(|a| a.meta_item_list().unwrap_or_else(Vec::new))
228 .filter(|a| a.has_name(sym::test))
230 let attrs = test_attrs.iter().flat_map(|a| a.meta_item_list().unwrap_or(&[]));
233 if attr.has_name(sym::no_crate_inject) {
234 opts.no_crate_inject = true;
236 if attr.has_name(sym::attr) {
237 if let Some(l) = attr.meta_item_list() {
239 opts.attrs.push(pprust::meta_list_item_to_string(item));
248 /// Documentation test failure modes.
250 /// The test failed to compile.
252 /// The test is marked `compile_fail` but compiled successfully.
253 UnexpectedCompilePass,
254 /// The test failed to compile (as expected) but the compiler output did not contain all
255 /// expected error codes.
256 MissingErrorCodes(Vec<String>),
257 /// The test binary was unable to be executed.
258 ExecutionError(io::Error),
259 /// The test binary exited with a non-zero exit code.
261 /// This typically means an assertion in the test failed or another form of panic occurred.
262 ExecutionFailure(process::Output),
263 /// The test is marked `should_panic` but the test binary executed successfully.
268 Temp(tempfile::TempDir),
273 fn path(&self) -> &std::path::Path {
275 DirState::Temp(t) => t.path(),
276 DirState::Perm(p) => p.as_path(),
281 // NOTE: Keep this in sync with the equivalent structs in rustc
283 // We could unify this struct the one in rustc but they have different
284 // ownership semantics, so doing so would create wasteful allocations.
285 #[derive(serde::Serialize, serde::Deserialize)]
286 struct UnusedExterns {
287 /// Lint level of the unused_crate_dependencies lint
289 /// List of unused externs by their names.
290 unused_extern_names: Vec<String>,
300 as_test_harness: bool,
301 runtool: Option<String>,
302 runtool_args: Vec<String>,
303 target: TargetTriple,
305 mut error_codes: Vec<String>,
311 report_unused_externs: impl Fn(UnusedExterns),
312 ) -> Result<(), TestFailure> {
313 let (test, line_offset, supports_color) =
314 make_test(test, Some(crate_name), as_test_harness, opts, edition, Some(test_id));
316 let output_file = outdir.path().join("rust_out");
318 let rustc_binary = options
321 .unwrap_or_else(|| rustc_interface::util::rustc_path().expect("found rustc"));
322 let mut compiler = Command::new(&rustc_binary);
323 compiler.arg("--crate-type").arg("bin");
324 for cfg in &options.cfgs {
325 compiler.arg("--cfg").arg(&cfg);
327 if let Some(sysroot) = options.maybe_sysroot {
328 compiler.arg("--sysroot").arg(sysroot);
330 compiler.arg("--edition").arg(&edition.to_string());
331 compiler.env("UNSTABLE_RUSTDOC_TEST_PATH", path);
332 compiler.env("UNSTABLE_RUSTDOC_TEST_LINE", format!("{}", line as isize - line_offset as isize));
333 compiler.arg("-o").arg(&output_file);
335 compiler.arg("--test");
337 if options.json_unused_externs && !compile_fail {
338 compiler.arg("--error-format=json");
339 compiler.arg("--json").arg("unused-externs");
340 compiler.arg("-Z").arg("unstable-options");
341 compiler.arg("-W").arg("unused_crate_dependencies");
343 for lib_str in &options.lib_strs {
344 compiler.arg("-L").arg(&lib_str);
346 for extern_str in &options.extern_strs {
347 compiler.arg("--extern").arg(&extern_str);
349 compiler.arg("-Ccodegen-units=1");
350 for codegen_options_str in &options.codegen_options_strs {
351 compiler.arg("-C").arg(&codegen_options_str);
353 for debugging_option_str in &options.debugging_opts_strs {
354 compiler.arg("-Z").arg(&debugging_option_str);
356 if no_run && !compile_fail {
357 compiler.arg("--emit=metadata");
359 compiler.arg("--target").arg(match target {
360 TargetTriple::TargetTriple(s) => s,
361 TargetTriple::TargetPath(path) => {
362 path.to_str().expect("target path must be valid unicode").to_string()
365 if let ErrorOutputType::HumanReadable(kind) = options.error_format {
366 let (short, color_config) = kind.unzip();
369 compiler.arg("--error-format").arg("short");
373 ColorConfig::Never => {
374 compiler.arg("--color").arg("never");
376 ColorConfig::Always => {
377 compiler.arg("--color").arg("always");
379 ColorConfig::Auto => {
380 compiler.arg("--color").arg(if supports_color { "always" } else { "never" });
386 compiler.stdin(Stdio::piped());
387 compiler.stderr(Stdio::piped());
389 let mut child = compiler.spawn().expect("Failed to spawn rustc process");
391 let stdin = child.stdin.as_mut().expect("Failed to open stdin");
392 stdin.write_all(test.as_bytes()).expect("could write out test sources");
394 let output = child.wait_with_output().expect("Failed to read stdout");
396 struct Bomb<'a>(&'a str);
397 impl Drop for Bomb<'_> {
399 eprint!("{}", self.0);
402 let mut out_lines = str::from_utf8(&output.stderr)
406 if let Ok(uext) = serde_json::from_str::<UnusedExterns>(l) {
407 report_unused_externs(uext);
413 .collect::<Vec<_>>();
415 // Add a \n to the end to properly terminate the last line,
416 // but only if there was output to be printed
417 if out_lines.len() > 0 {
421 let out = out_lines.join("\n");
422 let _bomb = Bomb(&out);
423 match (output.status.success(), compile_fail) {
425 return Err(TestFailure::UnexpectedCompilePass);
429 if !error_codes.is_empty() {
430 // We used to check if the output contained "error[{}]: " but since we added the
431 // colored output, we can't anymore because of the color escape characters before
433 error_codes.retain(|err| !out.contains(&format!("error[{}]", err)));
435 if !error_codes.is_empty() {
436 return Err(TestFailure::MissingErrorCodes(error_codes));
441 return Err(TestFailure::CompileError);
452 if let Some(tool) = runtool {
453 cmd = Command::new(tool);
454 cmd.args(runtool_args);
455 cmd.arg(output_file);
457 cmd = Command::new(output_file);
459 if let Some(run_directory) = options.test_run_directory {
460 cmd.current_dir(run_directory);
464 Err(e) => return Err(TestFailure::ExecutionError(e)),
466 if should_panic && out.status.success() {
467 return Err(TestFailure::UnexpectedRunPass);
468 } else if !should_panic && !out.status.success() {
469 return Err(TestFailure::ExecutionFailure(out));
470 } else if options.nocapture {
471 io::stdout().write_all(&out.stdout).expect("failed to write stdout");
472 io::stderr().write_all(&out.stderr).expect("failed to write stderr");
480 /// Transforms a test into code that can be compiled into a Rust binary, and returns the number of
481 /// lines before the test code begins as well as if the output stream supports colors or not.
484 crate_name: Option<&str>,
485 dont_insert_main: bool,
488 test_id: Option<&str>,
489 ) -> (String, usize, bool) {
490 let (crate_attrs, everything_else, crates) = partition_source(s);
491 let everything_else = everything_else.trim();
492 let mut line_offset = 0;
493 let mut prog = String::new();
494 let mut supports_color = false;
496 if opts.attrs.is_empty() && !opts.display_warnings {
497 // If there aren't any attributes supplied by #![doc(test(attr(...)))], then allow some
498 // lints that are commonly triggered in doctests. The crate-level test attributes are
499 // commonly used to make tests fail in case they trigger warnings, so having this there in
500 // that case may cause some tests to pass when they shouldn't have.
501 prog.push_str("#![allow(unused)]\n");
505 // Next, any attributes that came from the crate root via #![doc(test(attr(...)))].
506 for attr in &opts.attrs {
507 prog.push_str(&format!("#![{}]\n", attr));
511 // Now push any outer attributes from the example, assuming they
512 // are intended to be crate attributes.
513 prog.push_str(&crate_attrs);
514 prog.push_str(&crates);
516 // Uses librustc_ast to parse the doctest and find if there's a main fn and the extern
517 // crate already is included.
518 let result = rustc_driver::catch_fatal_errors(|| {
519 rustc_span::create_session_if_not_set_then(edition, |_| {
520 use rustc_errors::emitter::{Emitter, EmitterWriter};
521 use rustc_errors::Handler;
522 use rustc_parse::maybe_new_parser_from_source_str;
523 use rustc_parse::parser::ForceCollect;
524 use rustc_session::parse::ParseSess;
525 use rustc_span::source_map::FilePathMapping;
527 let filename = FileName::anon_source_code(s);
528 let source = crates + everything_else;
530 // Any errors in parsing should also appear when the doctest is compiled for real, so just
531 // send all the errors that librustc_ast emits directly into a `Sink` instead of stderr.
532 let sm = Lrc::new(SourceMap::new(FilePathMapping::empty()));
534 EmitterWriter::stderr(ColorConfig::Auto, None, false, false, Some(80), false)
538 EmitterWriter::new(box io::sink(), None, false, false, false, None, false);
540 // FIXME(misdreavus): pass `-Z treat-err-as-bug` to the doctest parser
541 let handler = Handler::with_emitter(false, None, box emitter);
542 let sess = ParseSess::with_span_handler(handler, sm);
544 let mut found_main = false;
545 let mut found_extern_crate = crate_name.is_none();
546 let mut found_macro = false;
548 let mut parser = match maybe_new_parser_from_source_str(&sess, filename, source) {
551 for mut err in errs {
555 return (found_main, found_extern_crate, found_macro);
560 match parser.parse_item(ForceCollect::No) {
563 if let ast::ItemKind::Fn(..) = item.kind {
564 if item.ident.name == sym::main {
570 if !found_extern_crate {
571 if let ast::ItemKind::ExternCrate(original) = item.kind {
572 // This code will never be reached if `crate_name` is none because
573 // `found_extern_crate` is initialized to `true` if it is none.
574 let crate_name = crate_name.unwrap();
577 Some(name) => found_extern_crate = name.as_str() == crate_name,
578 None => found_extern_crate = item.ident.as_str() == crate_name,
584 if let ast::ItemKind::MacCall(..) = item.kind {
589 if found_main && found_extern_crate {
601 // Reset errors so that they won't be reported as compiler bugs when dropping the
602 // handler. Any errors in the tests will be reported when the test file is compiled,
603 // Note that we still need to cancel the errors above otherwise `DiagnosticBuilder`
604 // will panic on drop.
605 sess.span_diagnostic.reset_err_count();
607 (found_main, found_extern_crate, found_macro)
610 let (already_has_main, already_has_extern_crate, found_macro) = match result {
611 Ok(result) => result,
612 Err(ErrorReported) => {
613 // If the parser panicked due to a fatal error, pass the test code through unchanged.
614 // The error will be reported during compilation.
615 return (s.to_owned(), 0, false);
619 // If a doctest's `fn main` is being masked by a wrapper macro, the parsing loop above won't
620 // see it. In that case, run the old text-based scan to see if they at least have a main
621 // function written inside a macro invocation. See
622 // https://github.com/rust-lang/rust/issues/56898
623 let already_has_main = if found_macro && !already_has_main {
626 let comment = line.find("//");
627 if let Some(comment_begins) = comment { &line[0..comment_begins] } else { line }
629 .any(|code| code.contains("fn main"))
634 // Don't inject `extern crate std` because it's already injected by the
636 if !already_has_extern_crate && !opts.no_crate_inject && crate_name != Some("std") {
637 if let Some(crate_name) = crate_name {
638 // Don't inject `extern crate` if the crate is never used.
639 // NOTE: this is terribly inaccurate because it doesn't actually
640 // parse the source, but only has false positives, not false
642 if s.contains(crate_name) {
643 prog.push_str(&format!("extern crate r#{};\n", crate_name));
649 // FIXME: This code cannot yet handle no_std test cases yet
650 if dont_insert_main || already_has_main || prog.contains("![no_std]") {
651 prog.push_str(everything_else);
653 let returns_result = everything_else.trim_end().ends_with("(())");
654 // Give each doctest main function a unique name.
655 // This is for example needed for the tooling around `-Z instrument-coverage`.
656 let inner_fn_name = if let Some(test_id) = test_id {
657 format!("_doctest_main_{}", test_id)
661 let inner_attr = if test_id.is_some() { "#[allow(non_snake_case)] " } else { "" };
662 let (main_pre, main_post) = if returns_result {
665 "fn main() {{ {}fn {}() -> Result<(), impl core::fmt::Debug> {{\n",
666 inner_attr, inner_fn_name
668 format!("\n}} {}().unwrap() }}", inner_fn_name),
670 } else if test_id.is_some() {
672 format!("fn main() {{ {}fn {}() {{\n", inner_attr, inner_fn_name),
673 format!("\n}} {}() }}", inner_fn_name),
676 ("fn main() {\n".into(), "\n}".into())
678 // Note on newlines: We insert a line/newline *before*, and *after*
679 // the doctest and adjust the `line_offset` accordingly.
680 // In the case of `-Z instrument-coverage`, this means that the generated
681 // inner `main` function spans from the doctest opening codeblock to the
682 // closing one. For example
683 // /// ``` <- start of the inner main
684 // /// <- code under doctest
685 // /// ``` <- end of the inner main
688 prog.extend([&main_pre, everything_else, &main_post].iter().cloned());
691 debug!("final doctest:\n{}", prog);
693 (prog, line_offset, supports_color)
696 // FIXME(aburka): use a real parser to deal with multiline attributes
697 fn partition_source(s: &str) -> (String, String, String) {
698 #[derive(Copy, Clone, PartialEq)]
699 enum PartitionState {
704 let mut state = PartitionState::Attrs;
705 let mut before = String::new();
706 let mut crates = String::new();
707 let mut after = String::new();
709 for line in s.lines() {
710 let trimline = line.trim();
712 // FIXME(misdreavus): if a doc comment is placed on an extern crate statement, it will be
713 // shunted into "everything else"
715 PartitionState::Attrs => {
716 state = if trimline.starts_with("#![")
717 || trimline.chars().all(|c| c.is_whitespace())
718 || (trimline.starts_with("//") && !trimline.starts_with("///"))
720 PartitionState::Attrs
721 } else if trimline.starts_with("extern crate")
722 || trimline.starts_with("#[macro_use] extern crate")
724 PartitionState::Crates
726 PartitionState::Other
729 PartitionState::Crates => {
730 state = if trimline.starts_with("extern crate")
731 || trimline.starts_with("#[macro_use] extern crate")
732 || trimline.chars().all(|c| c.is_whitespace())
733 || (trimline.starts_with("//") && !trimline.starts_with("///"))
735 PartitionState::Crates
737 PartitionState::Other
740 PartitionState::Other => {}
744 PartitionState::Attrs => {
745 before.push_str(line);
748 PartitionState::Crates => {
749 crates.push_str(line);
752 PartitionState::Other => {
753 after.push_str(line);
759 debug!("before:\n{}", before);
760 debug!("crates:\n{}", crates);
761 debug!("after:\n{}", after);
763 (before, after, crates)
767 fn add_test(&mut self, test: String, config: LangString, line: usize);
768 fn get_line(&self) -> usize {
771 fn register_header(&mut self, _name: &str, _level: u32) {}
774 crate struct Collector {
775 crate tests: Vec<test::TestDescAndFn>,
777 // The name of the test displayed to the user, separated by `::`.
779 // In tests from Rust source, this is the path to the item
780 // e.g., `["std", "vec", "Vec", "push"]`.
782 // In tests from a markdown file, this is the titles of all headers (h1~h6)
783 // of the sections that contain the code block, e.g., if the markdown file is
796 // the `names` vector of that test will be `["Title", "Subtitle"]`.
801 enable_per_target_ignores: bool,
805 source_map: Option<Lrc<SourceMap>>,
806 filename: Option<PathBuf>,
807 visited_tests: FxHashMap<(String, usize), usize>,
808 unused_extern_reports: Arc<Mutex<Vec<UnusedExterns>>>,
809 compiling_test_count: AtomicUsize,
818 source_map: Option<Lrc<SourceMap>>,
819 filename: Option<PathBuf>,
820 enable_per_target_ignores: bool,
827 enable_per_target_ignores,
833 visited_tests: FxHashMap::default(),
834 unused_extern_reports: Default::default(),
835 compiling_test_count: AtomicUsize::new(0),
839 fn generate_name(&self, line: usize, filename: &FileName) -> String {
840 let mut item_path = self.names.join("::");
841 if !item_path.is_empty() {
844 format!("{} - {}(line {})", filename.prefer_local(), item_path, line)
847 crate fn set_position(&mut self, position: Span) {
848 self.position = position;
851 fn get_filename(&self) -> FileName {
852 if let Some(ref source_map) = self.source_map {
853 let filename = source_map.span_to_filename(self.position);
854 if let FileName::Real(ref filename) = filename {
855 if let Ok(cur_dir) = env::current_dir() {
856 if let Some(local_path) = filename.local_path() {
857 if let Ok(path) = local_path.strip_prefix(&cur_dir) {
858 return path.to_owned().into();
864 } else if let Some(ref filename) = self.filename {
865 filename.clone().into()
867 FileName::Custom("input".to_owned())
872 impl Tester for Collector {
873 fn add_test(&mut self, test: String, config: LangString, line: usize) {
874 let filename = self.get_filename();
875 let name = self.generate_name(line, &filename);
876 let crate_name = self.crate_name.to_string();
877 let opts = self.opts.clone();
878 let edition = config.edition.unwrap_or(self.options.edition);
879 let options = self.options.clone();
880 let runtool = self.options.runtool.clone();
881 let runtool_args = self.options.runtool_args.clone();
882 let target = self.options.target.clone();
883 let target_str = target.to_string();
884 let unused_externs = self.unused_extern_reports.clone();
885 let no_run = config.no_run || options.no_run;
886 if !config.compile_fail {
887 self.compiling_test_count.fetch_add(1, Ordering::SeqCst);
890 let path = match &filename {
891 FileName::Real(path) => {
892 if let Some(local_path) = path.local_path() {
893 local_path.to_path_buf()
895 // Somehow we got the filename from the metadata of another crate, should never happen
896 unreachable!("doctest from a different crate");
899 _ => PathBuf::from(r"doctest.rs"),
902 // For example `module/file.rs` would become `module_file_rs`
907 .map(|c| if c.is_ascii_alphanumeric() { c } else { '_' })
908 .collect::<String>();
909 let test_id = format!(
910 "{file}_{line}_{number}",
914 // Increases the current test number, if this file already
915 // exists or it creates a new entry with a test number of 0.
916 self.visited_tests.entry((file.clone(), line)).and_modify(|v| *v += 1).or_insert(0)
919 let outdir = if let Some(mut path) = options.persist_doctests.clone() {
922 std::fs::create_dir_all(&path)
923 .expect("Couldn't create directory for doctest executables");
928 TempFileBuilder::new()
929 .prefix("rustdoctest")
931 .expect("rustdoc needs a tempdir"),
935 debug!("creating test {}: {}", name, test);
936 self.tests.push(test::TestDescAndFn {
937 desc: test::TestDesc {
938 name: test::DynTestName(name),
939 ignore: match config.ignore {
941 Ignore::None => false,
942 Ignore::Some(ref ignores) => ignores.iter().any(|s| target_str.contains(s)),
944 // compiler failures are test failures
945 should_panic: test::ShouldPanic::No,
946 allow_fail: config.allow_fail,
947 compile_fail: config.compile_fail,
949 test_type: test::TestType::DocTest,
951 testfn: test::DynTestFn(box move || {
952 let report_unused_externs = |uext| {
953 unused_externs.lock().unwrap().push(uext);
973 report_unused_externs,
976 if let Err(err) = res {
978 TestFailure::CompileError => {
979 eprint!("Couldn't compile the test.");
981 TestFailure::UnexpectedCompilePass => {
982 eprint!("Test compiled successfully, but it's marked `compile_fail`.");
984 TestFailure::UnexpectedRunPass => {
985 eprint!("Test executable succeeded, but it's marked `should_panic`.");
987 TestFailure::MissingErrorCodes(codes) => {
988 eprint!("Some expected error codes were not found: {:?}", codes);
990 TestFailure::ExecutionError(err) => {
991 eprint!("Couldn't run the test: {}", err);
992 if err.kind() == io::ErrorKind::PermissionDenied {
993 eprint!(" - maybe your tempdir is mounted with noexec?");
996 TestFailure::ExecutionFailure(out) => {
997 let reason = if let Some(code) = out.status.code() {
998 format!("exit code {}", code)
1000 String::from("terminated by signal")
1003 eprintln!("Test executable failed ({}).", reason);
1005 // FIXME(#12309): An unfortunate side-effect of capturing the test
1006 // executable's output is that the relative ordering between the test's
1007 // stdout and stderr is lost. However, this is better than the
1008 // alternative: if the test executable inherited the parent's I/O
1009 // handles the output wouldn't be captured at all, even on success.
1011 // The ordering could be preserved if the test process' stderr was
1012 // redirected to stdout, but that functionality does not exist in the
1013 // standard library, so it may not be portable enough.
1014 let stdout = str::from_utf8(&out.stdout).unwrap_or_default();
1015 let stderr = str::from_utf8(&out.stderr).unwrap_or_default();
1017 if !stdout.is_empty() || !stderr.is_empty() {
1020 if !stdout.is_empty() {
1021 eprintln!("stdout:\n{}", stdout);
1024 if !stderr.is_empty() {
1025 eprintln!("stderr:\n{}", stderr);
1031 panic::resume_unwind(box ());
1037 fn get_line(&self) -> usize {
1038 if let Some(ref source_map) = self.source_map {
1039 let line = self.position.lo().to_usize();
1040 let line = source_map.lookup_char_pos(BytePos(line as u32)).line;
1041 if line > 0 { line - 1 } else { line }
1047 fn register_header(&mut self, name: &str, level: u32) {
1048 if self.use_headers {
1049 // We use these headings as test names, so it's good if
1050 // they're valid identifiers.
1055 if (i == 0 && rustc_lexer::is_id_start(c))
1056 || (i != 0 && rustc_lexer::is_id_continue(c))
1063 .collect::<String>();
1065 // Here we try to efficiently assemble the header titles into the
1066 // test name in the form of `h1::h2::h3::h4::h5::h6`.
1068 // Suppose that originally `self.names` contains `[h1, h2, h3]`...
1069 let level = level as usize;
1070 if level <= self.names.len() {
1071 // ... Consider `level == 2`. All headers in the lower levels
1072 // are irrelevant in this new level. So we should reset
1073 // `self.names` to contain headers until <h2>, and replace that
1074 // slot with the new name: `[h1, name]`.
1075 self.names.truncate(level);
1076 self.names[level - 1] = name;
1078 // ... On the other hand, consider `level == 5`. This means we
1079 // need to extend `self.names` to contain five headers. We fill
1080 // in the missing level (<h4>) with `_`. Thus `self.names` will
1081 // become `[h1, h2, h3, "_", name]`.
1082 if level - 1 > self.names.len() {
1083 self.names.resize(level - 1, "_".to_owned());
1085 self.names.push(name);
1091 struct HirCollector<'a, 'hir, 'tcx> {
1093 collector: &'a mut Collector,
1099 impl<'a, 'hir, 'tcx> HirCollector<'a, 'hir, 'tcx> {
1100 fn visit_testable<F: FnOnce(&mut Self)>(
1107 let ast_attrs = self.tcx.hir().attrs(hir_id);
1108 let mut attrs = Attributes::from_ast(ast_attrs, None);
1110 if let Some(ref cfg) = ast_attrs.cfg(self.sess) {
1111 if !cfg.matches(&self.sess.parse_sess, Some(&self.sess.features_untracked())) {
1116 let has_name = !name.is_empty();
1118 self.collector.names.push(name);
1121 attrs.unindent_doc_comments();
1122 // The collapse-docs pass won't combine sugared/raw doc attributes, or included files with
1123 // anything else, this will combine them for us.
1124 if let Some(doc) = attrs.collapsed_doc_value() {
1125 // Use the outermost invocation, so that doctest names come from where the docs were written.
1126 let span = ast_attrs
1128 .map(|span| span.ctxt().outer_expn().expansion_cause().unwrap_or(span))
1129 .unwrap_or(DUMMY_SP);
1130 self.collector.set_position(span);
1131 markdown::find_testable_code(
1135 self.collector.enable_per_target_ignores,
1136 Some(&crate::html::markdown::ExtraInfo::new(
1139 span_of_attrs(&attrs).unwrap_or(sp),
1147 self.collector.names.pop();
1152 impl<'a, 'hir, 'tcx> intravisit::Visitor<'hir> for HirCollector<'a, 'hir, 'tcx> {
1153 type Map = Map<'hir>;
1155 fn nested_visit_map(&mut self) -> intravisit::NestedVisitorMap<Self::Map> {
1156 intravisit::NestedVisitorMap::All(self.map)
1159 fn visit_item(&mut self, item: &'hir hir::Item<'_>) {
1160 let name = if let hir::ItemKind::Impl(impl_) = &item.kind {
1161 rustc_hir_pretty::id_to_string(&self.map, impl_.self_ty.hir_id)
1163 item.ident.to_string()
1166 self.visit_testable(name, item.hir_id(), item.span, |this| {
1167 intravisit::walk_item(this, item);
1171 fn visit_trait_item(&mut self, item: &'hir hir::TraitItem<'_>) {
1172 self.visit_testable(item.ident.to_string(), item.hir_id(), item.span, |this| {
1173 intravisit::walk_trait_item(this, item);
1177 fn visit_impl_item(&mut self, item: &'hir hir::ImplItem<'_>) {
1178 self.visit_testable(item.ident.to_string(), item.hir_id(), item.span, |this| {
1179 intravisit::walk_impl_item(this, item);
1183 fn visit_foreign_item(&mut self, item: &'hir hir::ForeignItem<'_>) {
1184 self.visit_testable(item.ident.to_string(), item.hir_id(), item.span, |this| {
1185 intravisit::walk_foreign_item(this, item);
1191 v: &'hir hir::Variant<'_>,
1192 g: &'hir hir::Generics<'_>,
1193 item_id: hir::HirId,
1195 self.visit_testable(v.ident.to_string(), v.id, v.span, |this| {
1196 intravisit::walk_variant(this, v, g, item_id);
1200 fn visit_field_def(&mut self, f: &'hir hir::FieldDef<'_>) {
1201 self.visit_testable(f.ident.to_string(), f.hir_id, f.span, |this| {
1202 intravisit::walk_field_def(this, f);
1206 fn visit_macro_def(&mut self, macro_def: &'hir hir::MacroDef<'_>) {
1207 self.visit_testable(
1208 macro_def.ident.to_string(),