src/librustdoc/test.rs

   1 use rustc::hir::map::Map;
   2 use rustc::session::{self, config, DiagnosticOutput};
   3 use rustc::util::common::ErrorReported;
   4 use rustc_data_structures::sync::Lrc;
   5 use rustc_feature::UnstableFeatures;
   6 use rustc_hir as hir;
   7 use rustc_hir::intravisit;
   8 use rustc_interface::interface;
   9 use rustc_span::edition::Edition;
  10 use rustc_span::source_map::SourceMap;
  11 use rustc_span::symbol::sym;
  12 use rustc_span::{BytePos, FileName, Pos, Span, DUMMY_SP};
  13 use rustc_target::spec::TargetTriple;
  14 use std::env;
  15 use std::io::{self, Write};
  16 use std::panic;
  17 use std::path::PathBuf;
  18 use std::process::{self, Command, Stdio};
  19 use std::str;
  20 use syntax::ast;
  21 use syntax::with_globals;
  22 use tempfile::Builder as TempFileBuilder;
  23 use testing;
  24
  25 use crate::clean::Attributes;
  26 use crate::config::Options;
  27 use crate::html::markdown::{self, ErrorCodes, Ignore, LangString};
  28
  29 #[derive(Clone, Default)]
  30 pub struct TestOptions {
  31     /// Whether to disable the default `extern crate my_crate;` when creating doctests.
  32     pub no_crate_inject: bool,
  33     /// Whether to emit compilation warnings when compiling doctests. Setting this will suppress
  34     /// the default `#![allow(unused)]`.
  35     pub display_warnings: bool,
  36     /// Additional crate-level attributes to add to doctests.
  37     pub attrs: Vec<String>,
  38 }
  39
  40 pub fn run(options: Options) -> i32 {
  41     let input = config::Input::File(options.input.clone());
  42
  43     let crate_types = if options.proc_macro_crate {
  44         vec![config::CrateType::ProcMacro]
  45     } else {
  46         vec![config::CrateType::Rlib]
  47     };
  48
  49     let sessopts = config::Options {
  50         maybe_sysroot: options.maybe_sysroot.clone(),
  51         search_paths: options.libs.clone(),
  52         crate_types,
  53         cg: options.codegen_options.clone(),
  54         externs: options.externs.clone(),
  55         unstable_features: UnstableFeatures::from_environment(),
  56         lint_cap: Some(::rustc::lint::Level::Allow),
  57         actually_rustdoc: true,
  58         debugging_opts: config::DebuggingOptions { ..config::basic_debugging_options() },
  59         edition: options.edition,
  60         target_triple: options.target.clone(),
  61         ..config::Options::default()
  62     };
  63
  64     let mut cfgs = options.cfgs.clone();
  65     cfgs.push("doc".to_owned());
  66     cfgs.push("doctest".to_owned());
  67     let config = interface::Config {
  68         opts: sessopts,
  69         crate_cfg: interface::parse_cfgspecs(cfgs),
  70         input,
  71         input_path: None,
  72         output_file: None,
  73         output_dir: None,
  74         file_loader: None,
  75         diagnostic_output: DiagnosticOutput::Default,
  76         stderr: None,
  77         crate_name: options.crate_name.clone(),
  78         lint_caps: Default::default(),
  79         register_lints: None,
  80         override_queries: None,
  81         registry: rustc_driver::diagnostics_registry(),
  82     };
  83
  84     let mut test_args = options.test_args.clone();
  85     let display_warnings = options.display_warnings;
  86
  87     let tests = interface::run_compiler(config, |compiler| {
  88         compiler.enter(|queries| {
  89             let lower_to_hir = queries.lower_to_hir()?;
  90
  91             let mut opts = scrape_test_config(lower_to_hir.peek().0.krate());
  92             opts.display_warnings |= options.display_warnings;
  93             let enable_per_target_ignores = options.enable_per_target_ignores;
  94             let mut collector = Collector::new(
  95                 queries.crate_name()?.peek().to_string(),
  96                 options,
  97                 false,
  98                 opts,
  99                 Some(compiler.source_map().clone()),
 100                 None,
 101                 enable_per_target_ignores,
 102             );
 103
 104             let mut global_ctxt = queries.global_ctxt()?.take();
 105
 106             global_ctxt.enter(|tcx| {
 107                 let krate = tcx.hir().krate();
 108                 let mut hir_collector = HirCollector {
 109                     sess: compiler.session(),
 110                     collector: &mut collector,
 111                     map: tcx.hir(),
 112                     codes: ErrorCodes::from(
 113                         compiler.session().opts.unstable_features.is_nightly_build(),
 114                     ),
 115                 };
 116                 hir_collector.visit_testable("".to_string(), &krate.attrs, |this| {
 117                     intravisit::walk_crate(this, krate);
 118                 });
 119             });
 120             compiler.session().abort_if_errors();
 121
 122             let ret: Result<_, ErrorReported> = Ok(collector.tests);
 123             ret
 124         })
 125     });
 126     let tests = match tests {
 127         Ok(tests) => tests,
 128         Err(ErrorReported) => return 1,
 129     };
 130
 131     test_args.insert(0, "rustdoctest".to_string());
 132
 133     testing::test_main(
 134         &test_args,
 135         tests,
 136         Some(testing::Options::new().display_output(display_warnings)),
 137     );
 138
 139     0
 140 }
 141
 142 // Look for `#![doc(test(no_crate_inject))]`, used by crates in the std facade.
 143 fn scrape_test_config(krate: &::rustc_hir::Crate) -> TestOptions {
 144     use syntax::print::pprust;
 145
 146     let mut opts =
 147         TestOptions { no_crate_inject: false, display_warnings: false, attrs: Vec::new() };
 148
 149     let test_attrs: Vec<_> = krate
 150         .attrs
 151         .iter()
 152         .filter(|a| a.check_name(sym::doc))
 153         .flat_map(|a| a.meta_item_list().unwrap_or_else(Vec::new))
 154         .filter(|a| a.check_name(sym::test))
 155         .collect();
 156     let attrs = test_attrs.iter().flat_map(|a| a.meta_item_list().unwrap_or(&[]));
 157
 158     for attr in attrs {
 159         if attr.check_name(sym::no_crate_inject) {
 160             opts.no_crate_inject = true;
 161         }
 162         if attr.check_name(sym::attr) {
 163             if let Some(l) = attr.meta_item_list() {
 164                 for item in l {
 165                     opts.attrs.push(pprust::meta_list_item_to_string(item));
 166                 }
 167             }
 168         }
 169     }
 170
 171     opts
 172 }
 173
 174 /// Documentation test failure modes.
 175 enum TestFailure {
 176     /// The test failed to compile.
 177     CompileError,
 178     /// The test is marked `compile_fail` but compiled successfully.
 179     UnexpectedCompilePass,
 180     /// The test failed to compile (as expected) but the compiler output did not contain all
 181     /// expected error codes.
 182     MissingErrorCodes(Vec<String>),
 183     /// The test binary was unable to be executed.
 184     ExecutionError(io::Error),
 185     /// The test binary exited with a non-zero exit code.
 186     ///
 187     /// This typically means an assertion in the test failed or another form of panic occurred.
 188     ExecutionFailure(process::Output),
 189     /// The test is marked `should_panic` but the test binary executed successfully.
 190     UnexpectedRunPass,
 191 }
 192
 193 fn run_test(
 194     test: &str,
 195     cratename: &str,
 196     filename: &FileName,
 197     line: usize,
 198     options: Options,
 199     should_panic: bool,
 200     no_run: bool,
 201     as_test_harness: bool,
 202     runtool: Option<String>,
 203     runtool_args: Vec<String>,
 204     target: TargetTriple,
 205     compile_fail: bool,
 206     mut error_codes: Vec<String>,
 207     opts: &TestOptions,
 208     edition: Edition,
 209 ) -> Result<(), TestFailure> {
 210     let (test, line_offset) = make_test(test, Some(cratename), as_test_harness, opts, edition);
 211
 212     // FIXME(#44940): if doctests ever support path remapping, then this filename
 213     // needs to be the result of `SourceMap::span_to_unmapped_path`.
 214     let path = match filename {
 215         FileName::Real(path) => path.clone(),
 216         _ => PathBuf::from(r"doctest.rs"),
 217     };
 218
 219     enum DirState {
 220         Temp(tempfile::TempDir),
 221         Perm(PathBuf),
 222     }
 223
 224     impl DirState {
 225         fn path(&self) -> &std::path::Path {
 226             match self {
 227                 DirState::Temp(t) => t.path(),
 228                 DirState::Perm(p) => p.as_path(),
 229             }
 230         }
 231     }
 232
 233     let outdir = if let Some(mut path) = options.persist_doctests {
 234         path.push(format!(
 235             "{}_{}",
 236             filename.to_string().rsplit('/').next().unwrap().replace(".", "_"),
 237             line
 238         ));
 239         std::fs::create_dir_all(&path).expect("Couldn't create directory for doctest executables");
 240
 241         DirState::Perm(path)
 242     } else {
 243         DirState::Temp(
 244             TempFileBuilder::new()
 245                 .prefix("rustdoctest")
 246                 .tempdir()
 247                 .expect("rustdoc needs a tempdir"),
 248         )
 249     };
 250     let output_file = outdir.path().join("rust_out");
 251
 252     let rustc_binary = options
 253         .test_builder
 254         .as_ref()
 255         .map(|v| &**v)
 256         .unwrap_or_else(|| rustc_interface::util::rustc_path().expect("found rustc"));
 257     let mut compiler = Command::new(&rustc_binary);
 258     compiler.arg("--crate-type").arg("bin");
 259     for cfg in &options.cfgs {
 260         compiler.arg("--cfg").arg(&cfg);
 261     }
 262     if let Some(sysroot) = options.maybe_sysroot {
 263         compiler.arg("--sysroot").arg(sysroot);
 264     }
 265     compiler.arg("--edition").arg(&edition.to_string());
 266     compiler.env("UNSTABLE_RUSTDOC_TEST_PATH", path);
 267     compiler.env("UNSTABLE_RUSTDOC_TEST_LINE", format!("{}", line as isize - line_offset as isize));
 268     compiler.arg("-o").arg(&output_file);
 269     if as_test_harness {
 270         compiler.arg("--test");
 271     }
 272     for lib_str in &options.lib_strs {
 273         compiler.arg("-L").arg(&lib_str);
 274     }
 275     for extern_str in &options.extern_strs {
 276         compiler.arg("--extern").arg(&extern_str);
 277     }
 278     compiler.arg("-Ccodegen-units=1");
 279     for codegen_options_str in &options.codegen_options_strs {
 280         compiler.arg("-C").arg(&codegen_options_str);
 281     }
 282     for debugging_option_str in &options.debugging_options_strs {
 283         compiler.arg("-Z").arg(&debugging_option_str);
 284     }
 285     if no_run {
 286         compiler.arg("--emit=metadata");
 287     }
 288     compiler.arg("--target").arg(target.to_string());
 289
 290     compiler.arg("-");
 291     compiler.stdin(Stdio::piped());
 292     compiler.stderr(Stdio::piped());
 293
 294     let mut child = compiler.spawn().expect("Failed to spawn rustc process");
 295     {
 296         let stdin = child.stdin.as_mut().expect("Failed to open stdin");
 297         stdin.write_all(test.as_bytes()).expect("could write out test sources");
 298     }
 299     let output = child.wait_with_output().expect("Failed to read stdout");
 300
 301     struct Bomb<'a>(&'a str);
 302     impl Drop for Bomb<'_> {
 303         fn drop(&mut self) {
 304             eprint!("{}", self.0);
 305         }
 306     }
 307     let out = str::from_utf8(&output.stderr).unwrap();
 308     let _bomb = Bomb(&out);
 309     match (output.status.success(), compile_fail) {
 310         (true, true) => {
 311             return Err(TestFailure::UnexpectedCompilePass);
 312         }
 313         (true, false) => {}
 314         (false, true) => {
 315             if !error_codes.is_empty() {
 316                 error_codes.retain(|err| !out.contains(&format!("error[{}]: ", err)));
 317
 318                 if !error_codes.is_empty() {
 319                     return Err(TestFailure::MissingErrorCodes(error_codes));
 320                 }
 321             }
 322         }
 323         (false, false) => {
 324             return Err(TestFailure::CompileError);
 325         }
 326     }
 327
 328     if no_run {
 329         return Ok(());
 330     }
 331
 332     // Run the code!
 333     let mut cmd;
 334
 335     if let Some(tool) = runtool {
 336         cmd = Command::new(tool);
 337         cmd.arg(output_file);
 338         cmd.args(runtool_args);
 339     } else {
 340         cmd = Command::new(output_file);
 341     }
 342
 343     match cmd.output() {
 344         Err(e) => return Err(TestFailure::ExecutionError(e)),
 345         Ok(out) => {
 346             if should_panic && out.status.success() {
 347                 return Err(TestFailure::UnexpectedRunPass);
 348             } else if !should_panic && !out.status.success() {
 349                 return Err(TestFailure::ExecutionFailure(out));
 350             }
 351         }
 352     }
 353
 354     Ok(())
 355 }
 356
 357 /// Transforms a test into code that can be compiled into a Rust binary, and returns the number of
 358 /// lines before the test code begins.
 359 pub fn make_test(
 360     s: &str,
 361     cratename: Option<&str>,
 362     dont_insert_main: bool,
 363     opts: &TestOptions,
 364     edition: Edition,
 365 ) -> (String, usize) {
 366     let (crate_attrs, everything_else, crates) = partition_source(s);
 367     let everything_else = everything_else.trim();
 368     let mut line_offset = 0;
 369     let mut prog = String::new();
 370
 371     if opts.attrs.is_empty() && !opts.display_warnings {
 372         // If there aren't any attributes supplied by #![doc(test(attr(...)))], then allow some
 373         // lints that are commonly triggered in doctests. The crate-level test attributes are
 374         // commonly used to make tests fail in case they trigger warnings, so having this there in
 375         // that case may cause some tests to pass when they shouldn't have.
 376         prog.push_str("#![allow(unused)]\n");
 377         line_offset += 1;
 378     }
 379
 380     // Next, any attributes that came from the crate root via #![doc(test(attr(...)))].
 381     for attr in &opts.attrs {
 382         prog.push_str(&format!("#![{}]\n", attr));
 383         line_offset += 1;
 384     }
 385
 386     // Now push any outer attributes from the example, assuming they
 387     // are intended to be crate attributes.
 388     prog.push_str(&crate_attrs);
 389     prog.push_str(&crates);
 390
 391     // Uses libsyntax to parse the doctest and find if there's a main fn and the extern
 392     // crate already is included.
 393     let result = rustc_driver::catch_fatal_errors(|| {
 394         with_globals(edition, || {
 395             use rustc_errors::emitter::EmitterWriter;
 396             use rustc_errors::Handler;
 397             use rustc_parse::maybe_new_parser_from_source_str;
 398             use rustc_span::source_map::FilePathMapping;
 399             use syntax::sess::ParseSess;
 400
 401             let filename = FileName::anon_source_code(s);
 402             let source = crates + &everything_else;
 403
 404             // Any errors in parsing should also appear when the doctest is compiled for real, so just
 405             // send all the errors that libsyntax emits directly into a `Sink` instead of stderr.
 406             let cm = Lrc::new(SourceMap::new(FilePathMapping::empty()));
 407             let emitter =
 408                 EmitterWriter::new(box io::sink(), None, false, false, false, None, false);
 409             // FIXME(misdreavus): pass `-Z treat-err-as-bug` to the doctest parser
 410             let handler = Handler::with_emitter(false, None, box emitter);
 411             let sess = ParseSess::with_span_handler(handler, cm);
 412
 413             let mut found_main = false;
 414             let mut found_extern_crate = cratename.is_none();
 415             let mut found_macro = false;
 416
 417             let mut parser = match maybe_new_parser_from_source_str(&sess, filename, source) {
 418                 Ok(p) => p,
 419                 Err(errs) => {
 420                     for mut err in errs {
 421                         err.cancel();
 422                     }
 423
 424                     return (found_main, found_extern_crate, found_macro);
 425                 }
 426             };
 427
 428             loop {
 429                 match parser.parse_item() {
 430                     Ok(Some(item)) => {
 431                         if !found_main {
 432                             if let ast::ItemKind::Fn(..) = item.kind {
 433                                 if item.ident.name == sym::main {
 434                                     found_main = true;
 435                                 }
 436                             }
 437                         }
 438
 439                         if !found_extern_crate {
 440                             if let ast::ItemKind::ExternCrate(original) = item.kind {
 441                                 // This code will never be reached if `cratename` is none because
 442                                 // `found_extern_crate` is initialized to `true` if it is none.
 443                                 let cratename = cratename.unwrap();
 444
 445                                 match original {
 446                                     Some(name) => found_extern_crate = name.as_str() == cratename,
 447                                     None => found_extern_crate = item.ident.as_str() == cratename,
 448                                 }
 449                             }
 450                         }
 451
 452                         if !found_macro {
 453                             if let ast::ItemKind::Mac(..) = item.kind {
 454                                 found_macro = true;
 455                             }
 456                         }
 457
 458                         if found_main && found_extern_crate {
 459                             break;
 460                         }
 461                     }
 462                     Ok(None) => break,
 463                     Err(mut e) => {
 464                         e.cancel();
 465                         break;
 466                     }
 467                 }
 468             }
 469
 470             (found_main, found_extern_crate, found_macro)
 471         })
 472     });
 473     let (already_has_main, already_has_extern_crate, found_macro) = match result {
 474         Ok(result) => result,
 475         Err(ErrorReported) => {
 476             // If the parser panicked due to a fatal error, pass the test code through unchanged.
 477             // The error will be reported during compilation.
 478             return (s.to_owned(), 0);
 479         }
 480     };
 481
 482     // If a doctest's `fn main` is being masked by a wrapper macro, the parsing loop above won't
 483     // see it. In that case, run the old text-based scan to see if they at least have a main
 484     // function written inside a macro invocation. See
 485     // https://github.com/rust-lang/rust/issues/56898
 486     let already_has_main = if found_macro && !already_has_main {
 487         s.lines()
 488             .map(|line| {
 489                 let comment = line.find("//");
 490                 if let Some(comment_begins) = comment { &line[0..comment_begins] } else { line }
 491             })
 492             .any(|code| code.contains("fn main"))
 493     } else {
 494         already_has_main
 495     };
 496
 497     // Don't inject `extern crate std` because it's already injected by the
 498     // compiler.
 499     if !already_has_extern_crate && !opts.no_crate_inject && cratename != Some("std") {
 500         if let Some(cratename) = cratename {
 501             // Make sure its actually used if not included.
 502             if s.contains(cratename) {
 503                 prog.push_str(&format!("extern crate {};\n", cratename));
 504                 line_offset += 1;
 505             }
 506         }
 507     }
 508
 509     // FIXME: This code cannot yet handle no_std test cases yet
 510     if dont_insert_main || already_has_main || prog.contains("![no_std]") {
 511         prog.push_str(everything_else);
 512     } else {
 513         let returns_result = everything_else.trim_end().ends_with("(())");
 514         let (main_pre, main_post) = if returns_result {
 515             (
 516                 "fn main() { fn _inner() -> Result<(), impl core::fmt::Debug> {",
 517                 "}\n_inner().unwrap() }",
 518             )
 519         } else {
 520             ("fn main() {\n", "\n}")
 521         };
 522         prog.extend([main_pre, everything_else, main_post].iter().cloned());
 523         line_offset += 1;
 524     }
 525
 526     debug!("final doctest:\n{}", prog);
 527
 528     (prog, line_offset)
 529 }
 530
 531 // FIXME(aburka): use a real parser to deal with multiline attributes
 532 fn partition_source(s: &str) -> (String, String, String) {
 533     #[derive(Copy, Clone, PartialEq)]
 534     enum PartitionState {
 535         Attrs,
 536         Crates,
 537         Other,
 538     }
 539     let mut state = PartitionState::Attrs;
 540     let mut before = String::new();
 541     let mut crates = String::new();
 542     let mut after = String::new();
 543
 544     for line in s.lines() {
 545         let trimline = line.trim();
 546
 547         // FIXME(misdreavus): if a doc comment is placed on an extern crate statement, it will be
 548         // shunted into "everything else"
 549         match state {
 550             PartitionState::Attrs => {
 551                 state = if trimline.starts_with("#![")
 552                     || trimline.chars().all(|c| c.is_whitespace())
 553                     || (trimline.starts_with("//") && !trimline.starts_with("///"))
 554                 {
 555                     PartitionState::Attrs
 556                 } else if trimline.starts_with("extern crate")
 557                     || trimline.starts_with("#[macro_use] extern crate")
 558                 {
 559                     PartitionState::Crates
 560                 } else {
 561                     PartitionState::Other
 562                 };
 563             }
 564             PartitionState::Crates => {
 565                 state = if trimline.starts_with("extern crate")
 566                     || trimline.starts_with("#[macro_use] extern crate")
 567                     || trimline.chars().all(|c| c.is_whitespace())
 568                     || (trimline.starts_with("//") && !trimline.starts_with("///"))
 569                 {
 570                     PartitionState::Crates
 571                 } else {
 572                     PartitionState::Other
 573                 };
 574             }
 575             PartitionState::Other => {}
 576         }
 577
 578         match state {
 579             PartitionState::Attrs => {
 580                 before.push_str(line);
 581                 before.push_str("\n");
 582             }
 583             PartitionState::Crates => {
 584                 crates.push_str(line);
 585                 crates.push_str("\n");
 586             }
 587             PartitionState::Other => {
 588                 after.push_str(line);
 589                 after.push_str("\n");
 590             }
 591         }
 592     }
 593
 594     debug!("before:\n{}", before);
 595     debug!("crates:\n{}", crates);
 596     debug!("after:\n{}", after);
 597
 598     (before, after, crates)
 599 }
 600
 601 pub trait Tester {
 602     fn add_test(&mut self, test: String, config: LangString, line: usize);
 603     fn get_line(&self) -> usize {
 604         0
 605     }
 606     fn register_header(&mut self, _name: &str, _level: u32) {}
 607 }
 608
 609 pub struct Collector {
 610     pub tests: Vec<testing::TestDescAndFn>,
 611
 612     // The name of the test displayed to the user, separated by `::`.
 613     //
 614     // In tests from Rust source, this is the path to the item
 615     // e.g., `["std", "vec", "Vec", "push"]`.
 616     //
 617     // In tests from a markdown file, this is the titles of all headers (h1~h6)
 618     // of the sections that contain the code block, e.g., if the markdown file is
 619     // written as:
 620     //
 621     // ``````markdown
 622     // # Title
 623     //
 624     // ## Subtitle
 625     //
 626     // ```rust
 627     // assert!(true);
 628     // ```
 629     // ``````
 630     //
 631     // the `names` vector of that test will be `["Title", "Subtitle"]`.
 632     names: Vec<String>,
 633
 634     options: Options,
 635     use_headers: bool,
 636     enable_per_target_ignores: bool,
 637     cratename: String,
 638     opts: TestOptions,
 639     position: Span,
 640     source_map: Option<Lrc<SourceMap>>,
 641     filename: Option<PathBuf>,
 642 }
 643
 644 impl Collector {
 645     pub fn new(
 646         cratename: String,
 647         options: Options,
 648         use_headers: bool,
 649         opts: TestOptions,
 650         source_map: Option<Lrc<SourceMap>>,
 651         filename: Option<PathBuf>,
 652         enable_per_target_ignores: bool,
 653     ) -> Collector {
 654         Collector {
 655             tests: Vec::new(),
 656             names: Vec::new(),
 657             options,
 658             use_headers,
 659             enable_per_target_ignores,
 660             cratename,
 661             opts,
 662             position: DUMMY_SP,
 663             source_map,
 664             filename,
 665         }
 666     }
 667
 668     fn generate_name(&self, line: usize, filename: &FileName) -> String {
 669         format!("{} - {} (line {})", filename, self.names.join("::"), line)
 670     }
 671
 672     pub fn set_position(&mut self, position: Span) {
 673         self.position = position;
 674     }
 675
 676     fn get_filename(&self) -> FileName {
 677         if let Some(ref source_map) = self.source_map {
 678             let filename = source_map.span_to_filename(self.position);
 679             if let FileName::Real(ref filename) = filename {
 680                 if let Ok(cur_dir) = env::current_dir() {
 681                     if let Ok(path) = filename.strip_prefix(&cur_dir) {
 682                         return path.to_owned().into();
 683                     }
 684                 }
 685             }
 686             filename
 687         } else if let Some(ref filename) = self.filename {
 688             filename.clone().into()
 689         } else {
 690             FileName::Custom("input".to_owned())
 691         }
 692     }
 693 }
 694
 695 impl Tester for Collector {
 696     fn add_test(&mut self, test: String, config: LangString, line: usize) {
 697         let filename = self.get_filename();
 698         let name = self.generate_name(line, &filename);
 699         let cratename = self.cratename.to_string();
 700         let opts = self.opts.clone();
 701         let edition = config.edition.unwrap_or(self.options.edition.clone());
 702         let options = self.options.clone();
 703         let runtool = self.options.runtool.clone();
 704         let runtool_args = self.options.runtool_args.clone();
 705         let target = self.options.target.clone();
 706         let target_str = target.to_string();
 707
 708         debug!("creating test {}: {}", name, test);
 709         self.tests.push(testing::TestDescAndFn {
 710             desc: testing::TestDesc {
 711                 name: testing::DynTestName(name),
 712                 ignore: match config.ignore {
 713                     Ignore::All => true,
 714                     Ignore::None => false,
 715                     Ignore::Some(ref ignores) => ignores.iter().any(|s| target_str.contains(s)),
 716                 },
 717                 // compiler failures are test failures
 718                 should_panic: testing::ShouldPanic::No,
 719                 allow_fail: config.allow_fail,
 720                 test_type: testing::TestType::DocTest,
 721             },
 722             testfn: testing::DynTestFn(box move || {
 723                 let res = run_test(
 724                     &test,
 725                     &cratename,
 726                     &filename,
 727                     line,
 728                     options,
 729                     config.should_panic,
 730                     config.no_run,
 731                     config.test_harness,
 732                     runtool,
 733                     runtool_args,
 734                     target,
 735                     config.compile_fail,
 736                     config.error_codes,
 737                     &opts,
 738                     edition,
 739                 );
 740
 741                 if let Err(err) = res {
 742                     match err {
 743                         TestFailure::CompileError => {
 744                             eprint!("Couldn't compile the test.");
 745                         }
 746                         TestFailure::UnexpectedCompilePass => {
 747                             eprint!("Test compiled successfully, but it's marked `compile_fail`.");
 748                         }
 749                         TestFailure::UnexpectedRunPass => {
 750                             eprint!("Test executable succeeded, but it's marked `should_panic`.");
 751                         }
 752                         TestFailure::MissingErrorCodes(codes) => {
 753                             eprint!("Some expected error codes were not found: {:?}", codes);
 754                         }
 755                         TestFailure::ExecutionError(err) => {
 756                             eprint!("Couldn't run the test: {}", err);
 757                             if err.kind() == io::ErrorKind::PermissionDenied {
 758                                 eprint!(" - maybe your tempdir is mounted with noexec?");
 759                             }
 760                         }
 761                         TestFailure::ExecutionFailure(out) => {
 762                             let reason = if let Some(code) = out.status.code() {
 763                                 format!("exit code {}", code)
 764                             } else {
 765                                 String::from("terminated by signal")
 766                             };
 767
 768                             eprintln!("Test executable failed ({}).", reason);
 769
 770                             // FIXME(#12309): An unfortunate side-effect of capturing the test
 771                             // executable's output is that the relative ordering between the test's
 772                             // stdout and stderr is lost. However, this is better than the
 773                             // alternative: if the test executable inherited the parent's I/O
 774                             // handles the output wouldn't be captured at all, even on success.
 775                             //
 776                             // The ordering could be preserved if the test process' stderr was
 777                             // redirected to stdout, but that functionality does not exist in the
 778                             // standard library, so it may not be portable enough.
 779                             let stdout = str::from_utf8(&out.stdout).unwrap_or_default();
 780                             let stderr = str::from_utf8(&out.stderr).unwrap_or_default();
 781
 782                             if !stdout.is_empty() || !stderr.is_empty() {
 783                                 eprintln!();
 784
 785                                 if !stdout.is_empty() {
 786                                     eprintln!("stdout:\n{}", stdout);
 787                                 }
 788
 789                                 if !stderr.is_empty() {
 790                                     eprintln!("stderr:\n{}", stderr);
 791                                 }
 792                             }
 793                         }
 794                     }
 795
 796                     panic::resume_unwind(box ());
 797                 }
 798             }),
 799         });
 800     }
 801
 802     fn get_line(&self) -> usize {
 803         if let Some(ref source_map) = self.source_map {
 804             let line = self.position.lo().to_usize();
 805             let line = source_map.lookup_char_pos(BytePos(line as u32)).line;
 806             if line > 0 { line - 1 } else { line }
 807         } else {
 808             0
 809         }
 810     }
 811
 812     fn register_header(&mut self, name: &str, level: u32) {
 813         if self.use_headers {
 814             // We use these headings as test names, so it's good if
 815             // they're valid identifiers.
 816             let name = name
 817                 .chars()
 818                 .enumerate()
 819                 .map(|(i, c)| {
 820                     if (i == 0 && rustc_lexer::is_id_start(c))
 821                         || (i != 0 && rustc_lexer::is_id_continue(c))
 822                     {
 823                         c
 824                     } else {
 825                         '_'
 826                     }
 827                 })
 828                 .collect::<String>();
 829
 830             // Here we try to efficiently assemble the header titles into the
 831             // test name in the form of `h1::h2::h3::h4::h5::h6`.
 832             //
 833             // Suppose that originally `self.names` contains `[h1, h2, h3]`...
 834             let level = level as usize;
 835             if level <= self.names.len() {
 836                 // ... Consider `level == 2`. All headers in the lower levels
 837                 // are irrelevant in this new level. So we should reset
 838                 // `self.names` to contain headers until <h2>, and replace that
 839                 // slot with the new name: `[h1, name]`.
 840                 self.names.truncate(level);
 841                 self.names[level - 1] = name;
 842             } else {
 843                 // ... On the other hand, consider `level == 5`. This means we
 844                 // need to extend `self.names` to contain five headers. We fill
 845                 // in the missing level (<h4>) with `_`. Thus `self.names` will
 846                 // become `[h1, h2, h3, "_", name]`.
 847                 if level - 1 > self.names.len() {
 848                     self.names.resize(level - 1, "_".to_owned());
 849                 }
 850                 self.names.push(name);
 851             }
 852         }
 853     }
 854 }
 855
 856 struct HirCollector<'a, 'hir> {
 857     sess: &'a session::Session,
 858     collector: &'a mut Collector,
 859     map: &'a Map<'hir>,
 860     codes: ErrorCodes,
 861 }
 862
 863 impl<'a, 'hir> HirCollector<'a, 'hir> {
 864     fn visit_testable<F: FnOnce(&mut Self)>(
 865         &mut self,
 866         name: String,
 867         attrs: &[ast::Attribute],
 868         nested: F,
 869     ) {
 870         let mut attrs = Attributes::from_ast(self.sess.diagnostic(), attrs);
 871         if let Some(ref cfg) = attrs.cfg {
 872             if !cfg.matches(&self.sess.parse_sess, Some(&self.sess.features_untracked())) {
 873                 return;
 874             }
 875         }
 876
 877         let has_name = !name.is_empty();
 878         if has_name {
 879             self.collector.names.push(name);
 880         }
 881
 882         attrs.collapse_doc_comments();
 883         attrs.unindent_doc_comments();
 884         // The collapse-docs pass won't combine sugared/raw doc attributes, or included files with
 885         // anything else, this will combine them for us.
 886         if let Some(doc) = attrs.collapsed_doc_value() {
 887             self.collector.set_position(attrs.span.unwrap_or(DUMMY_SP));
 888             markdown::find_testable_code(
 889                 &doc,
 890                 self.collector,
 891                 self.codes,
 892                 self.collector.enable_per_target_ignores,
 893             );
 894         }
 895
 896         nested(self);
 897
 898         if has_name {
 899             self.collector.names.pop();
 900         }
 901     }
 902 }
 903
 904 impl<'a, 'hir> intravisit::Visitor<'hir> for HirCollector<'a, 'hir> {
 905     type Map = Map<'hir>;
 906
 907     fn nested_visit_map(&mut self) -> intravisit::NestedVisitorMap<'_, Self::Map> {
 908         intravisit::NestedVisitorMap::All(&self.map)
 909     }
 910
 911     fn visit_item(&mut self, item: &'hir hir::Item) {
 912         let name = if let hir::ItemKind::Impl { ref self_ty, .. } = item.kind {
 913             self.map.hir_to_pretty_string(self_ty.hir_id)
 914         } else {
 915             item.ident.to_string()
 916         };
 917
 918         self.visit_testable(name, &item.attrs, |this| {
 919             intravisit::walk_item(this, item);
 920         });
 921     }
 922
 923     fn visit_trait_item(&mut self, item: &'hir hir::TraitItem) {
 924         self.visit_testable(item.ident.to_string(), &item.attrs, |this| {
 925             intravisit::walk_trait_item(this, item);
 926         });
 927     }
 928
 929     fn visit_impl_item(&mut self, item: &'hir hir::ImplItem) {
 930         self.visit_testable(item.ident.to_string(), &item.attrs, |this| {
 931             intravisit::walk_impl_item(this, item);
 932         });
 933     }
 934
 935     fn visit_foreign_item(&mut self, item: &'hir hir::ForeignItem) {
 936         self.visit_testable(item.ident.to_string(), &item.attrs, |this| {
 937             intravisit::walk_foreign_item(this, item);
 938         });
 939     }
 940
 941     fn visit_variant(
 942         &mut self,
 943         v: &'hir hir::Variant,
 944         g: &'hir hir::Generics,
 945         item_id: hir::HirId,
 946     ) {
 947         self.visit_testable(v.ident.to_string(), &v.attrs, |this| {
 948             intravisit::walk_variant(this, v, g, item_id);
 949         });
 950     }
 951
 952     fn visit_struct_field(&mut self, f: &'hir hir::StructField) {
 953         self.visit_testable(f.ident.to_string(), &f.attrs, |this| {
 954             intravisit::walk_struct_field(this, f);
 955         });
 956     }
 957
 958     fn visit_macro_def(&mut self, macro_def: &'hir hir::MacroDef) {
 959         self.visit_testable(macro_def.name.to_string(), &macro_def.attrs, |_| ());
 960     }
 961 }
 962
 963 #[cfg(test)]
 964 mod tests;