2 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
3 use rustc_data_structures::sync::Lrc;
4 use rustc_errors::{ColorConfig, ErrorReported, FatalError};
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 as RustdocOptions;
33 use crate::html::markdown::{self, ErrorCodes, Ignore, LangString};
34 use crate::lint::init_lints;
35 use crate::passes::span_of_attrs;
37 /// Options that apply to all doctests in a crate or Markdown file (for `rustdoc foo.md`).
38 #[derive(Clone, Default)]
39 crate struct GlobalTestOptions {
40 /// Whether to disable the default `extern crate my_crate;` when creating doctests.
41 crate no_crate_inject: bool,
42 /// Additional crate-level attributes to add to doctests.
43 crate attrs: Vec<String>,
46 crate fn run(options: RustdocOptions) -> Result<(), ErrorReported> {
47 let input = config::Input::File(options.input.clone());
49 let invalid_codeblock_attributes_name = crate::lint::INVALID_CODEBLOCK_ATTRIBUTES.name;
51 // See core::create_config for what's going on here.
52 let allowed_lints = vec![
53 invalid_codeblock_attributes_name.to_owned(),
54 lint::builtin::UNKNOWN_LINTS.name.to_owned(),
55 lint::builtin::RENAMED_AND_REMOVED_LINTS.name.to_owned(),
58 let (lint_opts, lint_caps) = init_lints(allowed_lints, options.lint_opts.clone(), |lint| {
59 if lint.name == invalid_codeblock_attributes_name {
62 Some((lint.name_lower(), lint::Allow))
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(),
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 nocapture = options.nocapture;
110 let externs = options.externs.clone();
111 let json_unused_externs = options.json_unused_externs;
113 let res = interface::run_compiler(config, |compiler| {
114 compiler.enter(|queries| {
115 let mut global_ctxt = queries.global_ctxt()?.take();
117 let collector = global_ctxt.enter(|tcx| {
118 let crate_attrs = tcx.hir().attrs(CRATE_HIR_ID);
120 let opts = scrape_test_config(crate_attrs);
121 let enable_per_target_ignores = options.enable_per_target_ignores;
122 let mut collector = Collector::new(
123 tcx.crate_name(LOCAL_CRATE),
127 Some(compiler.session().parse_sess.clone_source_map()),
129 enable_per_target_ignores,
132 let mut hir_collector = HirCollector {
133 sess: compiler.session(),
134 collector: &mut collector,
136 codes: ErrorCodes::from(
137 compiler.session().opts.unstable_features.is_nightly_build(),
141 hir_collector.visit_testable(
144 tcx.hir().span(CRATE_HIR_ID),
145 |this| tcx.hir().walk_toplevel_module(this),
150 if compiler.session().diagnostic().has_errors_or_lint_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, 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);
209 crate fn run_tests(mut test_args: Vec<String>, nocapture: bool, tests: Vec<test::TestDescAndFn>) {
210 test_args.insert(0, "rustdoctest".to_string());
212 test_args.push("--nocapture".to_string());
214 test::test_main(&test_args, tests, None);
217 // Look for `#![doc(test(no_crate_inject))]`, used by crates in the std facade.
218 fn scrape_test_config(attrs: &[ast::Attribute]) -> GlobalTestOptions {
219 use rustc_ast_pretty::pprust;
221 let mut opts = GlobalTestOptions { no_crate_inject: false, attrs: Vec::new() };
223 let test_attrs: Vec<_> = attrs
225 .filter(|a| a.has_name(sym::doc))
226 .flat_map(|a| a.meta_item_list().unwrap_or_else(Vec::new))
227 .filter(|a| a.has_name(sym::test))
229 let attrs = test_attrs.iter().flat_map(|a| a.meta_item_list().unwrap_or(&[]));
232 if attr.has_name(sym::no_crate_inject) {
233 opts.no_crate_inject = true;
235 if attr.has_name(sym::attr) {
236 if let Some(l) = attr.meta_item_list() {
238 opts.attrs.push(pprust::meta_list_item_to_string(item));
247 /// Documentation test failure modes.
249 /// The test failed to compile.
251 /// The test is marked `compile_fail` but compiled successfully.
252 UnexpectedCompilePass,
253 /// The test failed to compile (as expected) but the compiler output did not contain all
254 /// expected error codes.
255 MissingErrorCodes(Vec<String>),
256 /// The test binary was unable to be executed.
257 ExecutionError(io::Error),
258 /// The test binary exited with a non-zero exit code.
260 /// This typically means an assertion in the test failed or another form of panic occurred.
261 ExecutionFailure(process::Output),
262 /// The test is marked `should_panic` but the test binary executed successfully.
267 Temp(tempfile::TempDir),
272 fn path(&self) -> &std::path::Path {
274 DirState::Temp(t) => t.path(),
275 DirState::Perm(p) => p.as_path(),
280 // NOTE: Keep this in sync with the equivalent structs in rustc
282 // We could unify this struct the one in rustc but they have different
283 // ownership semantics, so doing so would create wasteful allocations.
284 #[derive(serde::Serialize, serde::Deserialize)]
285 struct UnusedExterns {
286 /// Lint level of the unused_crate_dependencies lint
288 /// List of unused externs by their names.
289 unused_extern_names: Vec<String>,
296 rustdoc_options: RustdocOptions,
297 mut lang_string: LangString,
299 runtool: Option<String>,
300 runtool_args: Vec<String>,
301 target: TargetTriple,
302 opts: &GlobalTestOptions,
307 report_unused_externs: impl Fn(UnusedExterns),
308 ) -> Result<(), TestFailure> {
309 let (test, line_offset, supports_color) =
310 make_test(test, Some(crate_name), lang_string.test_harness, opts, edition, Some(test_id));
312 let output_file = outdir.path().join("rust_out");
314 let rustc_binary = rustdoc_options
317 .unwrap_or_else(|| rustc_interface::util::rustc_path().expect("found rustc"));
318 let mut compiler = Command::new(&rustc_binary);
319 compiler.arg("--crate-type").arg("bin");
320 for cfg in &rustdoc_options.cfgs {
321 compiler.arg("--cfg").arg(&cfg);
323 if let Some(sysroot) = rustdoc_options.maybe_sysroot {
324 compiler.arg("--sysroot").arg(sysroot);
326 compiler.arg("--edition").arg(&edition.to_string());
327 compiler.env("UNSTABLE_RUSTDOC_TEST_PATH", path);
328 compiler.env("UNSTABLE_RUSTDOC_TEST_LINE", format!("{}", line as isize - line_offset as isize));
329 compiler.arg("-o").arg(&output_file);
330 if lang_string.test_harness {
331 compiler.arg("--test");
333 if rustdoc_options.json_unused_externs && !lang_string.compile_fail {
334 compiler.arg("--error-format=json");
335 compiler.arg("--json").arg("unused-externs");
336 compiler.arg("-Z").arg("unstable-options");
337 compiler.arg("-W").arg("unused_crate_dependencies");
339 for lib_str in &rustdoc_options.lib_strs {
340 compiler.arg("-L").arg(&lib_str);
342 for extern_str in &rustdoc_options.extern_strs {
343 compiler.arg("--extern").arg(&extern_str);
345 compiler.arg("-Ccodegen-units=1");
346 for codegen_options_str in &rustdoc_options.codegen_options_strs {
347 compiler.arg("-C").arg(&codegen_options_str);
349 for debugging_option_str in &rustdoc_options.debugging_opts_strs {
350 compiler.arg("-Z").arg(&debugging_option_str);
352 if no_run && !lang_string.compile_fail && rustdoc_options.persist_doctests.is_none() {
353 compiler.arg("--emit=metadata");
355 compiler.arg("--target").arg(match target {
356 TargetTriple::TargetTriple(s) => s,
357 TargetTriple::TargetPath(path) => {
358 path.to_str().expect("target path must be valid unicode").to_string()
361 if let ErrorOutputType::HumanReadable(kind) = rustdoc_options.error_format {
362 let (short, color_config) = kind.unzip();
365 compiler.arg("--error-format").arg("short");
369 ColorConfig::Never => {
370 compiler.arg("--color").arg("never");
372 ColorConfig::Always => {
373 compiler.arg("--color").arg("always");
375 ColorConfig::Auto => {
376 compiler.arg("--color").arg(if supports_color { "always" } else { "never" });
382 compiler.stdin(Stdio::piped());
383 compiler.stderr(Stdio::piped());
385 let mut child = compiler.spawn().expect("Failed to spawn rustc process");
387 let stdin = child.stdin.as_mut().expect("Failed to open stdin");
388 stdin.write_all(test.as_bytes()).expect("could write out test sources");
390 let output = child.wait_with_output().expect("Failed to read stdout");
392 struct Bomb<'a>(&'a str);
393 impl Drop for Bomb<'_> {
395 eprint!("{}", self.0);
398 let mut out_lines = str::from_utf8(&output.stderr)
402 if let Ok(uext) = serde_json::from_str::<UnusedExterns>(l) {
403 report_unused_externs(uext);
409 .collect::<Vec<_>>();
411 // Add a \n to the end to properly terminate the last line,
412 // but only if there was output to be printed
413 if !out_lines.is_empty() {
417 let out = out_lines.join("\n");
418 let _bomb = Bomb(&out);
419 match (output.status.success(), lang_string.compile_fail) {
421 return Err(TestFailure::UnexpectedCompilePass);
425 if !lang_string.error_codes.is_empty() {
426 // We used to check if the output contained "error[{}]: " but since we added the
427 // colored output, we can't anymore because of the color escape characters before
429 lang_string.error_codes.retain(|err| !out.contains(&format!("error[{}]", err)));
431 if !lang_string.error_codes.is_empty() {
432 return Err(TestFailure::MissingErrorCodes(lang_string.error_codes));
437 return Err(TestFailure::CompileError);
448 if let Some(tool) = runtool {
449 cmd = Command::new(tool);
450 cmd.args(runtool_args);
451 cmd.arg(output_file);
453 cmd = Command::new(output_file);
455 if let Some(run_directory) = rustdoc_options.test_run_directory {
456 cmd.current_dir(run_directory);
459 let result = if rustdoc_options.nocapture {
460 cmd.status().map(|status| process::Output {
469 Err(e) => return Err(TestFailure::ExecutionError(e)),
471 if lang_string.should_panic && out.status.success() {
472 return Err(TestFailure::UnexpectedRunPass);
473 } else if !lang_string.should_panic && !out.status.success() {
474 return Err(TestFailure::ExecutionFailure(out));
482 /// Transforms a test into code that can be compiled into a Rust binary, and returns the number of
483 /// lines before the test code begins as well as if the output stream supports colors or not.
486 crate_name: Option<&str>,
487 dont_insert_main: bool,
488 opts: &GlobalTestOptions,
490 test_id: Option<&str>,
491 ) -> (String, usize, bool) {
492 let (crate_attrs, everything_else, crates) = partition_source(s);
493 let everything_else = everything_else.trim();
494 let mut line_offset = 0;
495 let mut prog = String::new();
496 let mut supports_color = false;
498 if opts.attrs.is_empty() {
499 // If there aren't any attributes supplied by #![doc(test(attr(...)))], then allow some
500 // lints that are commonly triggered in doctests. The crate-level test attributes are
501 // commonly used to make tests fail in case they trigger warnings, so having this there in
502 // that case may cause some tests to pass when they shouldn't have.
503 prog.push_str("#![allow(unused)]\n");
507 // Next, any attributes that came from the crate root via #![doc(test(attr(...)))].
508 for attr in &opts.attrs {
509 prog.push_str(&format!("#![{}]\n", attr));
513 // Now push any outer attributes from the example, assuming they
514 // are intended to be crate attributes.
515 prog.push_str(&crate_attrs);
516 prog.push_str(&crates);
518 // Uses librustc_ast to parse the doctest and find if there's a main fn and the extern
519 // crate already is included.
520 let result = rustc_driver::catch_fatal_errors(|| {
521 rustc_span::create_session_if_not_set_then(edition, |_| {
522 use rustc_errors::emitter::{Emitter, EmitterWriter};
523 use rustc_errors::Handler;
524 use rustc_parse::maybe_new_parser_from_source_str;
525 use rustc_parse::parser::ForceCollect;
526 use rustc_session::parse::ParseSess;
527 use rustc_span::source_map::FilePathMapping;
529 let filename = FileName::anon_source_code(s);
530 let source = crates + everything_else;
532 // Any errors in parsing should also appear when the doctest is compiled for real, so just
533 // send all the errors that librustc_ast emits directly into a `Sink` instead of stderr.
534 let sm = Lrc::new(SourceMap::new(FilePathMapping::empty()));
536 EmitterWriter::stderr(ColorConfig::Auto, None, false, false, Some(80), false)
540 EmitterWriter::new(box io::sink(), None, false, false, false, None, false);
542 // FIXME(misdreavus): pass `-Z treat-err-as-bug` to the doctest parser
543 let handler = Handler::with_emitter(false, None, box emitter);
544 let sess = ParseSess::with_span_handler(handler, sm);
546 let mut found_main = false;
547 let mut found_extern_crate = crate_name.is_none();
548 let mut found_macro = false;
550 let mut parser = match maybe_new_parser_from_source_str(&sess, filename, source) {
553 for mut err in errs {
557 return (found_main, found_extern_crate, found_macro);
562 match parser.parse_item(ForceCollect::No) {
565 if let ast::ItemKind::Fn(..) = item.kind {
566 if item.ident.name == sym::main {
572 if !found_extern_crate {
573 if let ast::ItemKind::ExternCrate(original) = item.kind {
574 // This code will never be reached if `crate_name` is none because
575 // `found_extern_crate` is initialized to `true` if it is none.
576 let crate_name = crate_name.unwrap();
579 Some(name) => found_extern_crate = name.as_str() == crate_name,
580 None => found_extern_crate = item.ident.as_str() == crate_name,
586 if let ast::ItemKind::MacCall(..) = item.kind {
591 if found_main && found_extern_crate {
602 // The supplied slice is only used for diagnostics,
603 // which are swallowed here anyway.
604 parser.maybe_consume_incorrect_semicolon(&[]);
607 // Reset errors so that they won't be reported as compiler bugs when dropping the
608 // handler. Any errors in the tests will be reported when the test file is compiled,
609 // Note that we still need to cancel the errors above otherwise `DiagnosticBuilder`
610 // will panic on drop.
611 sess.span_diagnostic.reset_err_count();
613 (found_main, found_extern_crate, found_macro)
616 let (already_has_main, already_has_extern_crate, found_macro) = match result {
617 Ok(result) => result,
618 Err(ErrorReported) => {
619 // If the parser panicked due to a fatal error, pass the test code through unchanged.
620 // The error will be reported during compilation.
621 return (s.to_owned(), 0, false);
625 // If a doctest's `fn main` is being masked by a wrapper macro, the parsing loop above won't
626 // see it. In that case, run the old text-based scan to see if they at least have a main
627 // function written inside a macro invocation. See
628 // https://github.com/rust-lang/rust/issues/56898
629 let already_has_main = if found_macro && !already_has_main {
632 let comment = line.find("//");
633 if let Some(comment_begins) = comment { &line[0..comment_begins] } else { line }
635 .any(|code| code.contains("fn main"))
640 // Don't inject `extern crate std` because it's already injected by the
642 if !already_has_extern_crate && !opts.no_crate_inject && crate_name != Some("std") {
643 if let Some(crate_name) = crate_name {
644 // Don't inject `extern crate` if the crate is never used.
645 // NOTE: this is terribly inaccurate because it doesn't actually
646 // parse the source, but only has false positives, not false
648 if s.contains(crate_name) {
649 prog.push_str(&format!("extern crate r#{};\n", crate_name));
655 // FIXME: This code cannot yet handle no_std test cases yet
656 if dont_insert_main || already_has_main || prog.contains("![no_std]") {
657 prog.push_str(everything_else);
659 let returns_result = everything_else.trim_end().ends_with("(())");
660 // Give each doctest main function a unique name.
661 // This is for example needed for the tooling around `-Z instrument-coverage`.
662 let inner_fn_name = if let Some(test_id) = test_id {
663 format!("_doctest_main_{}", test_id)
667 let inner_attr = if test_id.is_some() { "#[allow(non_snake_case)] " } else { "" };
668 let (main_pre, main_post) = if returns_result {
671 "fn main() {{ {}fn {}() -> Result<(), impl core::fmt::Debug> {{\n",
672 inner_attr, inner_fn_name
674 format!("\n}} {}().unwrap() }}", inner_fn_name),
676 } else if test_id.is_some() {
678 format!("fn main() {{ {}fn {}() {{\n", inner_attr, inner_fn_name),
679 format!("\n}} {}() }}", inner_fn_name),
682 ("fn main() {\n".into(), "\n}".into())
684 // Note on newlines: We insert a line/newline *before*, and *after*
685 // the doctest and adjust the `line_offset` accordingly.
686 // In the case of `-Z instrument-coverage`, this means that the generated
687 // inner `main` function spans from the doctest opening codeblock to the
688 // closing one. For example
689 // /// ``` <- start of the inner main
690 // /// <- code under doctest
691 // /// ``` <- end of the inner main
694 prog.extend([&main_pre, everything_else, &main_post].iter().cloned());
697 debug!("final doctest:\n{}", prog);
699 (prog, line_offset, supports_color)
702 // FIXME(aburka): use a real parser to deal with multiline attributes
703 fn partition_source(s: &str) -> (String, String, String) {
704 #[derive(Copy, Clone, PartialEq)]
705 enum PartitionState {
710 let mut state = PartitionState::Attrs;
711 let mut before = String::new();
712 let mut crates = String::new();
713 let mut after = String::new();
715 for line in s.lines() {
716 let trimline = line.trim();
718 // FIXME(misdreavus): if a doc comment is placed on an extern crate statement, it will be
719 // shunted into "everything else"
721 PartitionState::Attrs => {
722 state = if trimline.starts_with("#![")
723 || trimline.chars().all(|c| c.is_whitespace())
724 || (trimline.starts_with("//") && !trimline.starts_with("///"))
726 PartitionState::Attrs
727 } else if trimline.starts_with("extern crate")
728 || trimline.starts_with("#[macro_use] extern crate")
730 PartitionState::Crates
732 PartitionState::Other
735 PartitionState::Crates => {
736 state = if trimline.starts_with("extern crate")
737 || trimline.starts_with("#[macro_use] extern crate")
738 || trimline.chars().all(|c| c.is_whitespace())
739 || (trimline.starts_with("//") && !trimline.starts_with("///"))
741 PartitionState::Crates
743 PartitionState::Other
746 PartitionState::Other => {}
750 PartitionState::Attrs => {
751 before.push_str(line);
754 PartitionState::Crates => {
755 crates.push_str(line);
758 PartitionState::Other => {
759 after.push_str(line);
765 debug!("before:\n{}", before);
766 debug!("crates:\n{}", crates);
767 debug!("after:\n{}", after);
769 (before, after, crates)
773 fn add_test(&mut self, test: String, config: LangString, line: usize);
774 fn get_line(&self) -> usize {
777 fn register_header(&mut self, _name: &str, _level: u32) {}
780 crate struct Collector {
781 crate tests: Vec<test::TestDescAndFn>,
783 // The name of the test displayed to the user, separated by `::`.
785 // In tests from Rust source, this is the path to the item
786 // e.g., `["std", "vec", "Vec", "push"]`.
788 // In tests from a markdown file, this is the titles of all headers (h1~h6)
789 // of the sections that contain the code block, e.g., if the markdown file is
802 // the `names` vector of that test will be `["Title", "Subtitle"]`.
805 rustdoc_options: RustdocOptions,
807 enable_per_target_ignores: bool,
809 opts: GlobalTestOptions,
811 source_map: Option<Lrc<SourceMap>>,
812 filename: Option<PathBuf>,
813 visited_tests: FxHashMap<(String, usize), usize>,
814 unused_extern_reports: Arc<Mutex<Vec<UnusedExterns>>>,
815 compiling_test_count: AtomicUsize,
821 rustdoc_options: RustdocOptions,
823 opts: GlobalTestOptions,
824 source_map: Option<Lrc<SourceMap>>,
825 filename: Option<PathBuf>,
826 enable_per_target_ignores: bool,
833 enable_per_target_ignores,
839 visited_tests: FxHashMap::default(),
840 unused_extern_reports: Default::default(),
841 compiling_test_count: AtomicUsize::new(0),
845 fn generate_name(&self, line: usize, filename: &FileName) -> String {
846 let mut item_path = self.names.join("::");
847 item_path.retain(|c| c != ' ');
848 if !item_path.is_empty() {
851 format!("{} - {}(line {})", filename.prefer_local(), item_path, line)
854 crate fn set_position(&mut self, position: Span) {
855 self.position = position;
858 fn get_filename(&self) -> FileName {
859 if let Some(ref source_map) = self.source_map {
860 let filename = source_map.span_to_filename(self.position);
861 if let FileName::Real(ref filename) = filename {
862 if let Ok(cur_dir) = env::current_dir() {
863 if let Some(local_path) = filename.local_path() {
864 if let Ok(path) = local_path.strip_prefix(&cur_dir) {
865 return path.to_owned().into();
871 } else if let Some(ref filename) = self.filename {
872 filename.clone().into()
874 FileName::Custom("input".to_owned())
879 impl Tester for Collector {
880 fn add_test(&mut self, test: String, config: LangString, line: usize) {
881 let filename = self.get_filename();
882 let name = self.generate_name(line, &filename);
883 let crate_name = self.crate_name.to_string();
884 let opts = self.opts.clone();
885 let edition = config.edition.unwrap_or(self.rustdoc_options.edition);
886 let rustdoc_options = self.rustdoc_options.clone();
887 let runtool = self.rustdoc_options.runtool.clone();
888 let runtool_args = self.rustdoc_options.runtool_args.clone();
889 let target = self.rustdoc_options.target.clone();
890 let target_str = target.to_string();
891 let unused_externs = self.unused_extern_reports.clone();
892 let no_run = config.no_run || rustdoc_options.no_run;
893 if !config.compile_fail {
894 self.compiling_test_count.fetch_add(1, Ordering::SeqCst);
897 let path = match &filename {
898 FileName::Real(path) => {
899 if let Some(local_path) = path.local_path() {
900 local_path.to_path_buf()
902 // Somehow we got the filename from the metadata of another crate, should never happen
903 unreachable!("doctest from a different crate");
906 _ => PathBuf::from(r"doctest.rs"),
909 // For example `module/file.rs` would become `module_file_rs`
914 .map(|c| if c.is_ascii_alphanumeric() { c } else { '_' })
915 .collect::<String>();
916 let test_id = format!(
917 "{file}_{line}_{number}",
921 // Increases the current test number, if this file already
922 // exists or it creates a new entry with a test number of 0.
923 self.visited_tests.entry((file.clone(), line)).and_modify(|v| *v += 1).or_insert(0)
926 let outdir = if let Some(mut path) = rustdoc_options.persist_doctests.clone() {
929 std::fs::create_dir_all(&path)
930 .expect("Couldn't create directory for doctest executables");
935 TempFileBuilder::new()
936 .prefix("rustdoctest")
938 .expect("rustdoc needs a tempdir"),
942 debug!("creating test {}: {}", name, test);
943 self.tests.push(test::TestDescAndFn {
944 desc: test::TestDesc {
945 name: test::DynTestName(name),
946 ignore: match config.ignore {
948 Ignore::None => false,
949 Ignore::Some(ref ignores) => ignores.iter().any(|s| target_str.contains(s)),
951 // compiler failures are test failures
952 should_panic: test::ShouldPanic::No,
953 allow_fail: config.allow_fail,
954 compile_fail: config.compile_fail,
956 test_type: test::TestType::DocTest,
958 testfn: test::DynTestFn(box move || {
959 let report_unused_externs = |uext| {
960 unused_externs.lock().unwrap().push(uext);
977 report_unused_externs,
980 if let Err(err) = res {
982 TestFailure::CompileError => {
983 eprint!("Couldn't compile the test.");
985 TestFailure::UnexpectedCompilePass => {
986 eprint!("Test compiled successfully, but it's marked `compile_fail`.");
988 TestFailure::UnexpectedRunPass => {
989 eprint!("Test executable succeeded, but it's marked `should_panic`.");
991 TestFailure::MissingErrorCodes(codes) => {
992 eprint!("Some expected error codes were not found: {:?}", codes);
994 TestFailure::ExecutionError(err) => {
995 eprint!("Couldn't run the test: {}", err);
996 if err.kind() == io::ErrorKind::PermissionDenied {
997 eprint!(" - maybe your tempdir is mounted with noexec?");
1000 TestFailure::ExecutionFailure(out) => {
1001 let reason = if let Some(code) = out.status.code() {
1002 format!("exit code {}", code)
1004 String::from("terminated by signal")
1007 eprintln!("Test executable failed ({}).", reason);
1009 // FIXME(#12309): An unfortunate side-effect of capturing the test
1010 // executable's output is that the relative ordering between the test's
1011 // stdout and stderr is lost. However, this is better than the
1012 // alternative: if the test executable inherited the parent's I/O
1013 // handles the output wouldn't be captured at all, even on success.
1015 // The ordering could be preserved if the test process' stderr was
1016 // redirected to stdout, but that functionality does not exist in the
1017 // standard library, so it may not be portable enough.
1018 let stdout = str::from_utf8(&out.stdout).unwrap_or_default();
1019 let stderr = str::from_utf8(&out.stderr).unwrap_or_default();
1021 if !stdout.is_empty() || !stderr.is_empty() {
1024 if !stdout.is_empty() {
1025 eprintln!("stdout:\n{}", stdout);
1028 if !stderr.is_empty() {
1029 eprintln!("stderr:\n{}", stderr);
1035 panic::resume_unwind(box ());
1041 fn get_line(&self) -> usize {
1042 if let Some(ref source_map) = self.source_map {
1043 let line = self.position.lo().to_usize();
1044 let line = source_map.lookup_char_pos(BytePos(line as u32)).line;
1045 if line > 0 { line - 1 } else { line }
1051 fn register_header(&mut self, name: &str, level: u32) {
1052 if self.use_headers {
1053 // We use these headings as test names, so it's good if
1054 // they're valid identifiers.
1059 if (i == 0 && rustc_lexer::is_id_start(c))
1060 || (i != 0 && rustc_lexer::is_id_continue(c))
1067 .collect::<String>();
1069 // Here we try to efficiently assemble the header titles into the
1070 // test name in the form of `h1::h2::h3::h4::h5::h6`.
1072 // Suppose that originally `self.names` contains `[h1, h2, h3]`...
1073 let level = level as usize;
1074 if level <= self.names.len() {
1075 // ... Consider `level == 2`. All headers in the lower levels
1076 // are irrelevant in this new level. So we should reset
1077 // `self.names` to contain headers until <h2>, and replace that
1078 // slot with the new name: `[h1, name]`.
1079 self.names.truncate(level);
1080 self.names[level - 1] = name;
1082 // ... On the other hand, consider `level == 5`. This means we
1083 // need to extend `self.names` to contain five headers. We fill
1084 // in the missing level (<h4>) with `_`. Thus `self.names` will
1085 // become `[h1, h2, h3, "_", name]`.
1086 if level - 1 > self.names.len() {
1087 self.names.resize(level - 1, "_".to_owned());
1089 self.names.push(name);
1095 struct HirCollector<'a, 'hir, 'tcx> {
1097 collector: &'a mut Collector,
1103 impl<'a, 'hir, 'tcx> HirCollector<'a, 'hir, 'tcx> {
1104 fn visit_testable<F: FnOnce(&mut Self)>(
1111 let ast_attrs = self.tcx.hir().attrs(hir_id);
1112 let mut attrs = Attributes::from_ast(ast_attrs, None);
1114 if let Some(ref cfg) = ast_attrs.cfg(self.tcx, &FxHashSet::default()) {
1115 if !cfg.matches(&self.sess.parse_sess, Some(self.sess.features_untracked())) {
1120 let has_name = !name.is_empty();
1122 self.collector.names.push(name);
1125 attrs.unindent_doc_comments();
1126 // The collapse-docs pass won't combine sugared/raw doc attributes, or included files with
1127 // anything else, this will combine them for us.
1128 if let Some(doc) = attrs.collapsed_doc_value() {
1129 // Use the outermost invocation, so that doctest names come from where the docs were written.
1130 let span = ast_attrs
1132 .map(|span| span.ctxt().outer_expn().expansion_cause().unwrap_or(span))
1133 .unwrap_or(DUMMY_SP);
1134 self.collector.set_position(span);
1135 markdown::find_testable_code(
1139 self.collector.enable_per_target_ignores,
1140 Some(&crate::html::markdown::ExtraInfo::new(
1143 span_of_attrs(&attrs).unwrap_or(sp),
1151 self.collector.names.pop();
1156 impl<'a, 'hir, 'tcx> intravisit::Visitor<'hir> for HirCollector<'a, 'hir, 'tcx> {
1157 type Map = Map<'hir>;
1159 fn nested_visit_map(&mut self) -> intravisit::NestedVisitorMap<Self::Map> {
1160 intravisit::NestedVisitorMap::All(self.map)
1163 fn visit_item(&mut self, item: &'hir hir::Item<'_>) {
1164 let name = match &item.kind {
1165 hir::ItemKind::Macro(ref macro_def) => {
1166 // FIXME(#88038): Non exported macros have historically not been tested,
1167 // but we really ought to start testing them.
1168 let def_id = item.def_id.to_def_id();
1169 if macro_def.macro_rules && !self.tcx.has_attr(def_id, sym::macro_export) {
1170 intravisit::walk_item(self, item);
1173 item.ident.to_string()
1175 hir::ItemKind::Impl(impl_) => {
1176 rustc_hir_pretty::id_to_string(&self.map, impl_.self_ty.hir_id)
1178 _ => item.ident.to_string(),
1181 self.visit_testable(name, item.hir_id(), item.span, |this| {
1182 intravisit::walk_item(this, item);
1186 fn visit_trait_item(&mut self, item: &'hir hir::TraitItem<'_>) {
1187 self.visit_testable(item.ident.to_string(), item.hir_id(), item.span, |this| {
1188 intravisit::walk_trait_item(this, item);
1192 fn visit_impl_item(&mut self, item: &'hir hir::ImplItem<'_>) {
1193 self.visit_testable(item.ident.to_string(), item.hir_id(), item.span, |this| {
1194 intravisit::walk_impl_item(this, item);
1198 fn visit_foreign_item(&mut self, item: &'hir hir::ForeignItem<'_>) {
1199 self.visit_testable(item.ident.to_string(), item.hir_id(), item.span, |this| {
1200 intravisit::walk_foreign_item(this, item);
1206 v: &'hir hir::Variant<'_>,
1207 g: &'hir hir::Generics<'_>,
1208 item_id: hir::HirId,
1210 self.visit_testable(v.ident.to_string(), v.id, v.span, |this| {
1211 intravisit::walk_variant(this, v, g, item_id);
1215 fn visit_field_def(&mut self, f: &'hir hir::FieldDef<'_>) {
1216 self.visit_testable(f.ident.to_string(), f.hir_id, f.span, |this| {
1217 intravisit::walk_field_def(this, f);