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_doctest_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_doctest_warnings { lint_opts } else { vec![] },
76 lint_cap: Some(options.lint_cap.unwrap_or(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 test_args = options.test_args.clone();
109 let display_doctest_warnings = options.display_doctest_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_doctest_warnings |= options.display_doctest_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_doctest_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).copied().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_doctest_warnings: bool,
213 tests: Vec<test::TestDescAndFn>,
215 test_args.insert(0, "rustdoctest".to_string());
217 test_args.push("--nocapture".to_string());
222 Some(test::Options::new().display_output(display_doctest_warnings)),
226 // Look for `#![doc(test(no_crate_inject))]`, used by crates in the std facade.
227 fn scrape_test_config(attrs: &[ast::Attribute]) -> TestOptions {
228 use rustc_ast_pretty::pprust;
231 TestOptions { no_crate_inject: false, display_doctest_warnings: false, attrs: Vec::new() };
233 let test_attrs: Vec<_> = attrs
235 .filter(|a| a.has_name(sym::doc))
236 .flat_map(|a| a.meta_item_list().unwrap_or_else(Vec::new))
237 .filter(|a| a.has_name(sym::test))
239 let attrs = test_attrs.iter().flat_map(|a| a.meta_item_list().unwrap_or(&[]));
242 if attr.has_name(sym::no_crate_inject) {
243 opts.no_crate_inject = true;
245 if attr.has_name(sym::attr) {
246 if let Some(l) = attr.meta_item_list() {
248 opts.attrs.push(pprust::meta_list_item_to_string(item));
257 /// Documentation test failure modes.
259 /// The test failed to compile.
261 /// The test is marked `compile_fail` but compiled successfully.
262 UnexpectedCompilePass,
263 /// The test failed to compile (as expected) but the compiler output did not contain all
264 /// expected error codes.
265 MissingErrorCodes(Vec<String>),
266 /// The test binary was unable to be executed.
267 ExecutionError(io::Error),
268 /// The test binary exited with a non-zero exit code.
270 /// This typically means an assertion in the test failed or another form of panic occurred.
271 ExecutionFailure(process::Output),
272 /// The test is marked `should_panic` but the test binary executed successfully.
277 Temp(tempfile::TempDir),
282 fn path(&self) -> &std::path::Path {
284 DirState::Temp(t) => t.path(),
285 DirState::Perm(p) => p.as_path(),
290 // NOTE: Keep this in sync with the equivalent structs in rustc
292 // We could unify this struct the one in rustc but they have different
293 // ownership semantics, so doing so would create wasteful allocations.
294 #[derive(serde::Serialize, serde::Deserialize)]
295 struct UnusedExterns {
296 /// Lint level of the unused_crate_dependencies lint
298 /// List of unused externs by their names.
299 unused_extern_names: Vec<String>,
309 as_test_harness: bool,
310 runtool: Option<String>,
311 runtool_args: Vec<String>,
312 target: TargetTriple,
314 mut error_codes: Vec<String>,
320 report_unused_externs: impl Fn(UnusedExterns),
321 ) -> Result<(), TestFailure> {
322 let (test, line_offset, supports_color) =
323 make_test(test, Some(crate_name), as_test_harness, opts, edition, Some(test_id));
325 let output_file = outdir.path().join("rust_out");
327 let rustc_binary = options
330 .unwrap_or_else(|| rustc_interface::util::rustc_path().expect("found rustc"));
331 let mut compiler = Command::new(&rustc_binary);
332 compiler.arg("--crate-type").arg("bin");
333 for cfg in &options.cfgs {
334 compiler.arg("--cfg").arg(&cfg);
336 if let Some(sysroot) = options.maybe_sysroot {
337 compiler.arg("--sysroot").arg(sysroot);
339 compiler.arg("--edition").arg(&edition.to_string());
340 compiler.env("UNSTABLE_RUSTDOC_TEST_PATH", path);
341 compiler.env("UNSTABLE_RUSTDOC_TEST_LINE", format!("{}", line as isize - line_offset as isize));
342 compiler.arg("-o").arg(&output_file);
344 compiler.arg("--test");
346 if options.json_unused_externs && !compile_fail {
347 compiler.arg("--error-format=json");
348 compiler.arg("--json").arg("unused-externs");
349 compiler.arg("-Z").arg("unstable-options");
350 compiler.arg("-W").arg("unused_crate_dependencies");
352 for lib_str in &options.lib_strs {
353 compiler.arg("-L").arg(&lib_str);
355 for extern_str in &options.extern_strs {
356 compiler.arg("--extern").arg(&extern_str);
358 compiler.arg("-Ccodegen-units=1");
359 for codegen_options_str in &options.codegen_options_strs {
360 compiler.arg("-C").arg(&codegen_options_str);
362 for debugging_option_str in &options.debugging_opts_strs {
363 compiler.arg("-Z").arg(&debugging_option_str);
365 if no_run && !compile_fail && options.persist_doctests.is_none() {
366 compiler.arg("--emit=metadata");
368 compiler.arg("--target").arg(match target {
369 TargetTriple::TargetTriple(s) => s,
370 TargetTriple::TargetPath(path) => {
371 path.to_str().expect("target path must be valid unicode").to_string()
374 if let ErrorOutputType::HumanReadable(kind) = options.error_format {
375 let (short, color_config) = kind.unzip();
378 compiler.arg("--error-format").arg("short");
382 ColorConfig::Never => {
383 compiler.arg("--color").arg("never");
385 ColorConfig::Always => {
386 compiler.arg("--color").arg("always");
388 ColorConfig::Auto => {
389 compiler.arg("--color").arg(if supports_color { "always" } else { "never" });
395 compiler.stdin(Stdio::piped());
396 compiler.stderr(Stdio::piped());
398 let mut child = compiler.spawn().expect("Failed to spawn rustc process");
400 let stdin = child.stdin.as_mut().expect("Failed to open stdin");
401 stdin.write_all(test.as_bytes()).expect("could write out test sources");
403 let output = child.wait_with_output().expect("Failed to read stdout");
405 struct Bomb<'a>(&'a str);
406 impl Drop for Bomb<'_> {
408 eprint!("{}", self.0);
411 let mut out_lines = str::from_utf8(&output.stderr)
415 if let Ok(uext) = serde_json::from_str::<UnusedExterns>(l) {
416 report_unused_externs(uext);
422 .collect::<Vec<_>>();
424 // Add a \n to the end to properly terminate the last line,
425 // but only if there was output to be printed
426 if !out_lines.is_empty() {
430 let out = out_lines.join("\n");
431 let _bomb = Bomb(&out);
432 match (output.status.success(), compile_fail) {
434 return Err(TestFailure::UnexpectedCompilePass);
438 if !error_codes.is_empty() {
439 // We used to check if the output contained "error[{}]: " but since we added the
440 // colored output, we can't anymore because of the color escape characters before
442 error_codes.retain(|err| !out.contains(&format!("error[{}]", err)));
444 if !error_codes.is_empty() {
445 return Err(TestFailure::MissingErrorCodes(error_codes));
450 return Err(TestFailure::CompileError);
461 if let Some(tool) = runtool {
462 cmd = Command::new(tool);
463 cmd.args(runtool_args);
464 cmd.arg(output_file);
466 cmd = Command::new(output_file);
468 if let Some(run_directory) = options.test_run_directory {
469 cmd.current_dir(run_directory);
472 let result = if options.nocapture {
473 cmd.status().map(|status| process::Output {
482 Err(e) => return Err(TestFailure::ExecutionError(e)),
484 if should_panic && out.status.success() {
485 return Err(TestFailure::UnexpectedRunPass);
486 } else if !should_panic && !out.status.success() {
487 return Err(TestFailure::ExecutionFailure(out));
495 /// Transforms a test into code that can be compiled into a Rust binary, and returns the number of
496 /// lines before the test code begins as well as if the output stream supports colors or not.
499 crate_name: Option<&str>,
500 dont_insert_main: bool,
503 test_id: Option<&str>,
504 ) -> (String, usize, bool) {
505 let (crate_attrs, everything_else, crates) = partition_source(s);
506 let everything_else = everything_else.trim();
507 let mut line_offset = 0;
508 let mut prog = String::new();
509 let mut supports_color = false;
511 if opts.attrs.is_empty() && !opts.display_doctest_warnings {
512 // If there aren't any attributes supplied by #![doc(test(attr(...)))], then allow some
513 // lints that are commonly triggered in doctests. The crate-level test attributes are
514 // commonly used to make tests fail in case they trigger warnings, so having this there in
515 // that case may cause some tests to pass when they shouldn't have.
516 prog.push_str("#![allow(unused)]\n");
520 // Next, any attributes that came from the crate root via #![doc(test(attr(...)))].
521 for attr in &opts.attrs {
522 prog.push_str(&format!("#![{}]\n", attr));
526 // Now push any outer attributes from the example, assuming they
527 // are intended to be crate attributes.
528 prog.push_str(&crate_attrs);
529 prog.push_str(&crates);
531 // Uses librustc_ast to parse the doctest and find if there's a main fn and the extern
532 // crate already is included.
533 let result = rustc_driver::catch_fatal_errors(|| {
534 rustc_span::create_session_if_not_set_then(edition, |_| {
535 use rustc_errors::emitter::{Emitter, EmitterWriter};
536 use rustc_errors::Handler;
537 use rustc_parse::maybe_new_parser_from_source_str;
538 use rustc_parse::parser::ForceCollect;
539 use rustc_session::parse::ParseSess;
540 use rustc_span::source_map::FilePathMapping;
542 let filename = FileName::anon_source_code(s);
543 let source = crates + everything_else;
545 // Any errors in parsing should also appear when the doctest is compiled for real, so just
546 // send all the errors that librustc_ast emits directly into a `Sink` instead of stderr.
547 let sm = Lrc::new(SourceMap::new(FilePathMapping::empty()));
549 EmitterWriter::stderr(ColorConfig::Auto, None, false, false, Some(80), false)
553 EmitterWriter::new(box io::sink(), None, false, false, false, None, false);
555 // FIXME(misdreavus): pass `-Z treat-err-as-bug` to the doctest parser
556 let handler = Handler::with_emitter(false, None, box emitter);
557 let sess = ParseSess::with_span_handler(handler, sm);
559 let mut found_main = false;
560 let mut found_extern_crate = crate_name.is_none();
561 let mut found_macro = false;
563 let mut parser = match maybe_new_parser_from_source_str(&sess, filename, source) {
566 for mut err in errs {
570 return (found_main, found_extern_crate, found_macro);
575 match parser.parse_item(ForceCollect::No) {
578 if let ast::ItemKind::Fn(..) = item.kind {
579 if item.ident.name == sym::main {
585 if !found_extern_crate {
586 if let ast::ItemKind::ExternCrate(original) = item.kind {
587 // This code will never be reached if `crate_name` is none because
588 // `found_extern_crate` is initialized to `true` if it is none.
589 let crate_name = crate_name.unwrap();
592 Some(name) => found_extern_crate = name.as_str() == crate_name,
593 None => found_extern_crate = item.ident.as_str() == crate_name,
599 if let ast::ItemKind::MacCall(..) = item.kind {
604 if found_main && found_extern_crate {
616 // Reset errors so that they won't be reported as compiler bugs when dropping the
617 // handler. Any errors in the tests will be reported when the test file is compiled,
618 // Note that we still need to cancel the errors above otherwise `DiagnosticBuilder`
619 // will panic on drop.
620 sess.span_diagnostic.reset_err_count();
622 (found_main, found_extern_crate, found_macro)
625 let (already_has_main, already_has_extern_crate, found_macro) = match result {
626 Ok(result) => result,
627 Err(ErrorReported) => {
628 // If the parser panicked due to a fatal error, pass the test code through unchanged.
629 // The error will be reported during compilation.
630 return (s.to_owned(), 0, false);
634 // If a doctest's `fn main` is being masked by a wrapper macro, the parsing loop above won't
635 // see it. In that case, run the old text-based scan to see if they at least have a main
636 // function written inside a macro invocation. See
637 // https://github.com/rust-lang/rust/issues/56898
638 let already_has_main = if found_macro && !already_has_main {
641 let comment = line.find("//");
642 if let Some(comment_begins) = comment { &line[0..comment_begins] } else { line }
644 .any(|code| code.contains("fn main"))
649 // Don't inject `extern crate std` because it's already injected by the
651 if !already_has_extern_crate && !opts.no_crate_inject && crate_name != Some("std") {
652 if let Some(crate_name) = crate_name {
653 // Don't inject `extern crate` if the crate is never used.
654 // NOTE: this is terribly inaccurate because it doesn't actually
655 // parse the source, but only has false positives, not false
657 if s.contains(crate_name) {
658 prog.push_str(&format!("extern crate r#{};\n", crate_name));
664 // FIXME: This code cannot yet handle no_std test cases yet
665 if dont_insert_main || already_has_main || prog.contains("![no_std]") {
666 prog.push_str(everything_else);
668 let returns_result = everything_else.trim_end().ends_with("(())");
669 // Give each doctest main function a unique name.
670 // This is for example needed for the tooling around `-Z instrument-coverage`.
671 let inner_fn_name = if let Some(test_id) = test_id {
672 format!("_doctest_main_{}", test_id)
676 let inner_attr = if test_id.is_some() { "#[allow(non_snake_case)] " } else { "" };
677 let (main_pre, main_post) = if returns_result {
680 "fn main() {{ {}fn {}() -> Result<(), impl core::fmt::Debug> {{\n",
681 inner_attr, inner_fn_name
683 format!("\n}} {}().unwrap() }}", inner_fn_name),
685 } else if test_id.is_some() {
687 format!("fn main() {{ {}fn {}() {{\n", inner_attr, inner_fn_name),
688 format!("\n}} {}() }}", inner_fn_name),
691 ("fn main() {\n".into(), "\n}".into())
693 // Note on newlines: We insert a line/newline *before*, and *after*
694 // the doctest and adjust the `line_offset` accordingly.
695 // In the case of `-Z instrument-coverage`, this means that the generated
696 // inner `main` function spans from the doctest opening codeblock to the
697 // closing one. For example
698 // /// ``` <- start of the inner main
699 // /// <- code under doctest
700 // /// ``` <- end of the inner main
703 prog.extend([&main_pre, everything_else, &main_post].iter().cloned());
706 debug!("final doctest:\n{}", prog);
708 (prog, line_offset, supports_color)
711 // FIXME(aburka): use a real parser to deal with multiline attributes
712 fn partition_source(s: &str) -> (String, String, String) {
713 #[derive(Copy, Clone, PartialEq)]
714 enum PartitionState {
719 let mut state = PartitionState::Attrs;
720 let mut before = String::new();
721 let mut crates = String::new();
722 let mut after = String::new();
724 for line in s.lines() {
725 let trimline = line.trim();
727 // FIXME(misdreavus): if a doc comment is placed on an extern crate statement, it will be
728 // shunted into "everything else"
730 PartitionState::Attrs => {
731 state = if trimline.starts_with("#![")
732 || trimline.chars().all(|c| c.is_whitespace())
733 || (trimline.starts_with("//") && !trimline.starts_with("///"))
735 PartitionState::Attrs
736 } else if trimline.starts_with("extern crate")
737 || trimline.starts_with("#[macro_use] extern crate")
739 PartitionState::Crates
741 PartitionState::Other
744 PartitionState::Crates => {
745 state = if trimline.starts_with("extern crate")
746 || trimline.starts_with("#[macro_use] extern crate")
747 || trimline.chars().all(|c| c.is_whitespace())
748 || (trimline.starts_with("//") && !trimline.starts_with("///"))
750 PartitionState::Crates
752 PartitionState::Other
755 PartitionState::Other => {}
759 PartitionState::Attrs => {
760 before.push_str(line);
763 PartitionState::Crates => {
764 crates.push_str(line);
767 PartitionState::Other => {
768 after.push_str(line);
774 debug!("before:\n{}", before);
775 debug!("crates:\n{}", crates);
776 debug!("after:\n{}", after);
778 (before, after, crates)
782 fn add_test(&mut self, test: String, config: LangString, line: usize);
783 fn get_line(&self) -> usize {
786 fn register_header(&mut self, _name: &str, _level: u32) {}
789 crate struct Collector {
790 crate tests: Vec<test::TestDescAndFn>,
792 // The name of the test displayed to the user, separated by `::`.
794 // In tests from Rust source, this is the path to the item
795 // e.g., `["std", "vec", "Vec", "push"]`.
797 // In tests from a markdown file, this is the titles of all headers (h1~h6)
798 // of the sections that contain the code block, e.g., if the markdown file is
811 // the `names` vector of that test will be `["Title", "Subtitle"]`.
816 enable_per_target_ignores: bool,
820 source_map: Option<Lrc<SourceMap>>,
821 filename: Option<PathBuf>,
822 visited_tests: FxHashMap<(String, usize), usize>,
823 unused_extern_reports: Arc<Mutex<Vec<UnusedExterns>>>,
824 compiling_test_count: AtomicUsize,
833 source_map: Option<Lrc<SourceMap>>,
834 filename: Option<PathBuf>,
835 enable_per_target_ignores: bool,
842 enable_per_target_ignores,
848 visited_tests: FxHashMap::default(),
849 unused_extern_reports: Default::default(),
850 compiling_test_count: AtomicUsize::new(0),
854 fn generate_name(&self, line: usize, filename: &FileName) -> String {
855 let mut item_path = self.names.join("::");
856 item_path.retain(|c| c != ' ');
857 if !item_path.is_empty() {
860 format!("{} - {}(line {})", filename.prefer_local(), item_path, line)
863 crate fn set_position(&mut self, position: Span) {
864 self.position = position;
867 fn get_filename(&self) -> FileName {
868 if let Some(ref source_map) = self.source_map {
869 let filename = source_map.span_to_filename(self.position);
870 if let FileName::Real(ref filename) = filename {
871 if let Ok(cur_dir) = env::current_dir() {
872 if let Some(local_path) = filename.local_path() {
873 if let Ok(path) = local_path.strip_prefix(&cur_dir) {
874 return path.to_owned().into();
880 } else if let Some(ref filename) = self.filename {
881 filename.clone().into()
883 FileName::Custom("input".to_owned())
888 impl Tester for Collector {
889 fn add_test(&mut self, test: String, config: LangString, line: usize) {
890 let filename = self.get_filename();
891 let name = self.generate_name(line, &filename);
892 let crate_name = self.crate_name.to_string();
893 let opts = self.opts.clone();
894 let edition = config.edition.unwrap_or(self.options.edition);
895 let options = self.options.clone();
896 let runtool = self.options.runtool.clone();
897 let runtool_args = self.options.runtool_args.clone();
898 let target = self.options.target.clone();
899 let target_str = target.to_string();
900 let unused_externs = self.unused_extern_reports.clone();
901 let no_run = config.no_run || options.no_run;
902 if !config.compile_fail {
903 self.compiling_test_count.fetch_add(1, Ordering::SeqCst);
906 let path = match &filename {
907 FileName::Real(path) => {
908 if let Some(local_path) = path.local_path() {
909 local_path.to_path_buf()
911 // Somehow we got the filename from the metadata of another crate, should never happen
912 unreachable!("doctest from a different crate");
915 _ => PathBuf::from(r"doctest.rs"),
918 // For example `module/file.rs` would become `module_file_rs`
923 .map(|c| if c.is_ascii_alphanumeric() { c } else { '_' })
924 .collect::<String>();
925 let test_id = format!(
926 "{file}_{line}_{number}",
930 // Increases the current test number, if this file already
931 // exists or it creates a new entry with a test number of 0.
932 self.visited_tests.entry((file.clone(), line)).and_modify(|v| *v += 1).or_insert(0)
935 let outdir = if let Some(mut path) = options.persist_doctests.clone() {
938 std::fs::create_dir_all(&path)
939 .expect("Couldn't create directory for doctest executables");
944 TempFileBuilder::new()
945 .prefix("rustdoctest")
947 .expect("rustdoc needs a tempdir"),
951 debug!("creating test {}: {}", name, test);
952 self.tests.push(test::TestDescAndFn {
953 desc: test::TestDesc {
954 name: test::DynTestName(name),
955 ignore: match config.ignore {
957 Ignore::None => false,
958 Ignore::Some(ref ignores) => ignores.iter().any(|s| target_str.contains(s)),
960 // compiler failures are test failures
961 should_panic: test::ShouldPanic::No,
962 allow_fail: config.allow_fail,
963 compile_fail: config.compile_fail,
965 test_type: test::TestType::DocTest,
967 testfn: test::DynTestFn(box move || {
968 let report_unused_externs = |uext| {
969 unused_externs.lock().unwrap().push(uext);
989 report_unused_externs,
992 if let Err(err) = res {
994 TestFailure::CompileError => {
995 eprint!("Couldn't compile the test.");
997 TestFailure::UnexpectedCompilePass => {
998 eprint!("Test compiled successfully, but it's marked `compile_fail`.");
1000 TestFailure::UnexpectedRunPass => {
1001 eprint!("Test executable succeeded, but it's marked `should_panic`.");
1003 TestFailure::MissingErrorCodes(codes) => {
1004 eprint!("Some expected error codes were not found: {:?}", codes);
1006 TestFailure::ExecutionError(err) => {
1007 eprint!("Couldn't run the test: {}", err);
1008 if err.kind() == io::ErrorKind::PermissionDenied {
1009 eprint!(" - maybe your tempdir is mounted with noexec?");
1012 TestFailure::ExecutionFailure(out) => {
1013 let reason = if let Some(code) = out.status.code() {
1014 format!("exit code {}", code)
1016 String::from("terminated by signal")
1019 eprintln!("Test executable failed ({}).", reason);
1021 // FIXME(#12309): An unfortunate side-effect of capturing the test
1022 // executable's output is that the relative ordering between the test's
1023 // stdout and stderr is lost. However, this is better than the
1024 // alternative: if the test executable inherited the parent's I/O
1025 // handles the output wouldn't be captured at all, even on success.
1027 // The ordering could be preserved if the test process' stderr was
1028 // redirected to stdout, but that functionality does not exist in the
1029 // standard library, so it may not be portable enough.
1030 let stdout = str::from_utf8(&out.stdout).unwrap_or_default();
1031 let stderr = str::from_utf8(&out.stderr).unwrap_or_default();
1033 if !stdout.is_empty() || !stderr.is_empty() {
1036 if !stdout.is_empty() {
1037 eprintln!("stdout:\n{}", stdout);
1040 if !stderr.is_empty() {
1041 eprintln!("stderr:\n{}", stderr);
1047 panic::resume_unwind(box ());
1053 fn get_line(&self) -> usize {
1054 if let Some(ref source_map) = self.source_map {
1055 let line = self.position.lo().to_usize();
1056 let line = source_map.lookup_char_pos(BytePos(line as u32)).line;
1057 if line > 0 { line - 1 } else { line }
1063 fn register_header(&mut self, name: &str, level: u32) {
1064 if self.use_headers {
1065 // We use these headings as test names, so it's good if
1066 // they're valid identifiers.
1071 if (i == 0 && rustc_lexer::is_id_start(c))
1072 || (i != 0 && rustc_lexer::is_id_continue(c))
1079 .collect::<String>();
1081 // Here we try to efficiently assemble the header titles into the
1082 // test name in the form of `h1::h2::h3::h4::h5::h6`.
1084 // Suppose that originally `self.names` contains `[h1, h2, h3]`...
1085 let level = level as usize;
1086 if level <= self.names.len() {
1087 // ... Consider `level == 2`. All headers in the lower levels
1088 // are irrelevant in this new level. So we should reset
1089 // `self.names` to contain headers until <h2>, and replace that
1090 // slot with the new name: `[h1, name]`.
1091 self.names.truncate(level);
1092 self.names[level - 1] = name;
1094 // ... On the other hand, consider `level == 5`. This means we
1095 // need to extend `self.names` to contain five headers. We fill
1096 // in the missing level (<h4>) with `_`. Thus `self.names` will
1097 // become `[h1, h2, h3, "_", name]`.
1098 if level - 1 > self.names.len() {
1099 self.names.resize(level - 1, "_".to_owned());
1101 self.names.push(name);
1107 struct HirCollector<'a, 'hir, 'tcx> {
1109 collector: &'a mut Collector,
1115 impl<'a, 'hir, 'tcx> HirCollector<'a, 'hir, 'tcx> {
1116 fn visit_testable<F: FnOnce(&mut Self)>(
1123 let ast_attrs = self.tcx.hir().attrs(hir_id);
1124 let mut attrs = Attributes::from_ast(ast_attrs, None);
1126 if let Some(ref cfg) = ast_attrs.cfg(self.tcx, &FxHashSet::default()) {
1127 if !cfg.matches(&self.sess.parse_sess, Some(self.sess.features_untracked())) {
1132 let has_name = !name.is_empty();
1134 self.collector.names.push(name);
1137 attrs.unindent_doc_comments();
1138 // The collapse-docs pass won't combine sugared/raw doc attributes, or included files with
1139 // anything else, this will combine them for us.
1140 if let Some(doc) = attrs.collapsed_doc_value() {
1141 // Use the outermost invocation, so that doctest names come from where the docs were written.
1142 let span = ast_attrs
1144 .map(|span| span.ctxt().outer_expn().expansion_cause().unwrap_or(span))
1145 .unwrap_or(DUMMY_SP);
1146 self.collector.set_position(span);
1147 markdown::find_testable_code(
1151 self.collector.enable_per_target_ignores,
1152 Some(&crate::html::markdown::ExtraInfo::new(
1155 span_of_attrs(&attrs).unwrap_or(sp),
1163 self.collector.names.pop();
1168 impl<'a, 'hir, 'tcx> intravisit::Visitor<'hir> for HirCollector<'a, 'hir, 'tcx> {
1169 type Map = Map<'hir>;
1171 fn nested_visit_map(&mut self) -> intravisit::NestedVisitorMap<Self::Map> {
1172 intravisit::NestedVisitorMap::All(self.map)
1175 fn visit_item(&mut self, item: &'hir hir::Item<'_>) {
1176 let name = match &item.kind {
1177 hir::ItemKind::Macro(ref macro_def) => {
1178 // FIXME(#88038): Non exported macros have historically not been tested,
1179 // but we really ought to start testing them.
1180 let def_id = item.def_id.to_def_id();
1181 if macro_def.macro_rules && !self.tcx.has_attr(def_id, sym::macro_export) {
1182 intravisit::walk_item(self, item);
1185 item.ident.to_string()
1187 hir::ItemKind::Impl(impl_) => {
1188 rustc_hir_pretty::id_to_string(&self.map, impl_.self_ty.hir_id)
1190 _ => item.ident.to_string(),
1193 self.visit_testable(name, item.hir_id(), item.span, |this| {
1194 intravisit::walk_item(this, item);
1198 fn visit_trait_item(&mut self, item: &'hir hir::TraitItem<'_>) {
1199 self.visit_testable(item.ident.to_string(), item.hir_id(), item.span, |this| {
1200 intravisit::walk_trait_item(this, item);
1204 fn visit_impl_item(&mut self, item: &'hir hir::ImplItem<'_>) {
1205 self.visit_testable(item.ident.to_string(), item.hir_id(), item.span, |this| {
1206 intravisit::walk_impl_item(this, item);
1210 fn visit_foreign_item(&mut self, item: &'hir hir::ForeignItem<'_>) {
1211 self.visit_testable(item.ident.to_string(), item.hir_id(), item.span, |this| {
1212 intravisit::walk_foreign_item(this, item);
1218 v: &'hir hir::Variant<'_>,
1219 g: &'hir hir::Generics<'_>,
1220 item_id: hir::HirId,
1222 self.visit_testable(v.ident.to_string(), v.id, v.span, |this| {
1223 intravisit::walk_variant(this, v, g, item_id);
1227 fn visit_field_def(&mut self, f: &'hir hir::FieldDef<'_>) {
1228 self.visit_testable(f.ident.to_string(), f.hir_id, f.span, |this| {
1229 intravisit::walk_field_def(this, f);