src/librustdoc/test.rs

   1 // Copyright 2013-2014 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 use std::env;
  12 use std::ffi::OsString;
  13 use std::io::prelude::*;
  14 use std::io;
  15 use std::path::{Path, PathBuf};
  16 use std::panic::{self, AssertUnwindSafe};
  17 use std::process::Command;
  18 use std::str;
  19 use rustc_data_structures::sync::Lrc;
  20 use std::sync::{Arc, Mutex};
  21
  22 use testing;
  23 use rustc_lint;
  24 use rustc::hir;
  25 use rustc::hir::intravisit;
  26 use rustc::session::{self, CompileIncomplete, config};
  27 use rustc::session::config::{OutputType, OutputTypes, Externs, CodegenOptions};
  28 use rustc::session::search_paths::{SearchPaths, PathKind};
  29 use rustc_metadata::dynamic_lib::DynamicLibrary;
  30 use tempfile::Builder as TempFileBuilder;
  31 use rustc_driver::{self, driver, target_features, Compilation};
  32 use rustc_driver::driver::phase_2_configure_and_expand;
  33 use rustc_metadata::cstore::CStore;
  34 use rustc_resolve::MakeGlobMap;
  35 use syntax::ast;
  36 use syntax::codemap::CodeMap;
  37 use syntax::edition::Edition;
  38 use syntax::feature_gate::UnstableFeatures;
  39 use syntax::with_globals;
  40 use syntax_pos::{BytePos, DUMMY_SP, Pos, Span, FileName, hygiene};
  41 use errors;
  42 use errors::emitter::ColorConfig;
  43
  44 use clean::Attributes;
  45 use html::markdown::{self, LangString};
  46
  47 #[derive(Clone, Default)]
  48 pub struct TestOptions {
  49     /// Whether to disable the default `extern crate my_crate;` when creating doctests.
  50     pub no_crate_inject: bool,
  51     /// Whether to emit compilation warnings when compiling doctests. Setting this will suppress
  52     /// the default `#![allow(unused)]`.
  53     pub display_warnings: bool,
  54     /// Additional crate-level attributes to add to doctests.
  55     pub attrs: Vec<String>,
  56 }
  57
  58 pub fn run(input_path: &Path,
  59            cfgs: Vec<String>,
  60            libs: SearchPaths,
  61            externs: Externs,
  62            mut test_args: Vec<String>,
  63            crate_name: Option<String>,
  64            maybe_sysroot: Option<PathBuf>,
  65            display_warnings: bool,
  66            linker: Option<PathBuf>,
  67            edition: Edition,
  68            cg: CodegenOptions)
  69            -> isize {
  70     let input = config::Input::File(input_path.to_owned());
  71
  72     let sessopts = config::Options {
  73         maybe_sysroot: maybe_sysroot.clone().or_else(
  74             || Some(env::current_exe().unwrap().parent().unwrap().parent().unwrap().to_path_buf())),
  75         search_paths: libs.clone(),
  76         crate_types: vec![config::CrateTypeDylib],
  77         cg: cg.clone(),
  78         externs: externs.clone(),
  79         unstable_features: UnstableFeatures::from_environment(),
  80         lint_cap: Some(::rustc::lint::Level::Allow),
  81         actually_rustdoc: true,
  82         debugging_opts: config::DebuggingOptions {
  83             ..config::basic_debugging_options()
  84         },
  85         edition,
  86         ..config::basic_options().clone()
  87     };
  88     driver::spawn_thread_pool(sessopts, |sessopts| {
  89         let codemap = Lrc::new(CodeMap::new(sessopts.file_path_mapping()));
  90         let handler =
  91             errors::Handler::with_tty_emitter(ColorConfig::Auto,
  92                                             true, false,
  93                                             Some(codemap.clone()));
  94
  95         let mut sess = session::build_session_(
  96             sessopts, Some(input_path.to_owned()), handler, codemap.clone(),
  97         );
  98         let codegen_backend = rustc_driver::get_codegen_backend(&sess);
  99         let cstore = CStore::new(codegen_backend.metadata_loader());
 100         rustc_lint::register_builtins(&mut sess.lint_store.borrow_mut(), Some(&sess));
 101
 102         let mut cfg = config::build_configuration(&sess, config::parse_cfgspecs(cfgs.clone()));
 103         target_features::add_configuration(&mut cfg, &sess, &*codegen_backend);
 104         sess.parse_sess.config = cfg;
 105
 106         let krate = panictry!(driver::phase_1_parse_input(&driver::CompileController::basic(),
 107                                                         &sess,
 108                                                         &input));
 109         let driver::ExpansionResult { defs, mut hir_forest, .. } = {
 110             phase_2_configure_and_expand(
 111                 &sess,
 112                 &cstore,
 113                 krate,
 114                 None,
 115                 "rustdoc-test",
 116                 None,
 117                 MakeGlobMap::No,
 118                 |_| Ok(()),
 119             ).expect("phase_2_configure_and_expand aborted in rustdoc!")
 120         };
 121
 122         let crate_name = crate_name.unwrap_or_else(|| {
 123             ::rustc_codegen_utils::link::find_crate_name(None, &hir_forest.krate().attrs, &input)
 124         });
 125         let mut opts = scrape_test_config(hir_forest.krate());
 126         opts.display_warnings |= display_warnings;
 127         let mut collector = Collector::new(
 128             crate_name,
 129             cfgs,
 130             libs,
 131             cg,
 132             externs,
 133             false,
 134             opts,
 135             maybe_sysroot,
 136             Some(codemap),
 137              None,
 138             linker,
 139             edition
 140         );
 141
 142         {
 143             let map = hir::map::map_crate(&sess, &cstore, &mut hir_forest, &defs);
 144             let krate = map.krate();
 145             let mut hir_collector = HirCollector {
 146                 sess: &sess,
 147                 collector: &mut collector,
 148                 map: &map
 149             };
 150             hir_collector.visit_testable("".to_string(), &krate.attrs, |this| {
 151                 intravisit::walk_crate(this, krate);
 152             });
 153         }
 154
 155         test_args.insert(0, "rustdoctest".to_string());
 156
 157         testing::test_main(&test_args,
 158                         collector.tests.into_iter().collect(),
 159                         testing::Options::new().display_output(display_warnings));
 160         0
 161     })
 162 }
 163
 164 // Look for #![doc(test(no_crate_inject))], used by crates in the std facade
 165 fn scrape_test_config(krate: &::rustc::hir::Crate) -> TestOptions {
 166     use syntax::print::pprust;
 167
 168     let mut opts = TestOptions {
 169         no_crate_inject: false,
 170         display_warnings: false,
 171         attrs: Vec::new(),
 172     };
 173
 174     let test_attrs: Vec<_> = krate.attrs.iter()
 175         .filter(|a| a.check_name("doc"))
 176         .flat_map(|a| a.meta_item_list().unwrap_or_else(Vec::new))
 177         .filter(|a| a.check_name("test"))
 178         .collect();
 179     let attrs = test_attrs.iter().flat_map(|a| a.meta_item_list().unwrap_or(&[]));
 180
 181     for attr in attrs {
 182         if attr.check_name("no_crate_inject") {
 183             opts.no_crate_inject = true;
 184         }
 185         if attr.check_name("attr") {
 186             if let Some(l) = attr.meta_item_list() {
 187                 for item in l {
 188                     opts.attrs.push(pprust::meta_list_item_to_string(item));
 189                 }
 190             }
 191         }
 192     }
 193
 194     opts
 195 }
 196
 197 fn run_test(test: &str, cratename: &str, filename: &FileName, line: usize,
 198             cfgs: Vec<String>, libs: SearchPaths,
 199             cg: CodegenOptions, externs: Externs,
 200             should_panic: bool, no_run: bool, as_test_harness: bool,
 201             compile_fail: bool, mut error_codes: Vec<String>, opts: &TestOptions,
 202             maybe_sysroot: Option<PathBuf>, linker: Option<PathBuf>, edition: Edition) {
 203     // the test harness wants its own `main` & top level functions, so
 204     // never wrap the test in `fn main() { ... }`
 205     let (test, line_offset) = make_test(test, Some(cratename), as_test_harness, opts);
 206     // FIXME(#44940): if doctests ever support path remapping, then this filename
 207     // needs to be the result of CodeMap::span_to_unmapped_path
 208     let input = config::Input::Str {
 209         name: filename.to_owned(),
 210         input: test.to_owned(),
 211     };
 212     let outputs = OutputTypes::new(&[(OutputType::Exe, None)]);
 213
 214     let sessopts = config::Options {
 215         maybe_sysroot: maybe_sysroot.or_else(
 216             || Some(env::current_exe().unwrap().parent().unwrap().parent().unwrap().to_path_buf())),
 217         search_paths: libs,
 218         crate_types: vec![config::CrateTypeExecutable],
 219         output_types: outputs,
 220         externs,
 221         cg: config::CodegenOptions {
 222             prefer_dynamic: true,
 223             linker,
 224             ..cg
 225         },
 226         test: as_test_harness,
 227         unstable_features: UnstableFeatures::from_environment(),
 228         debugging_opts: config::DebuggingOptions {
 229             ..config::basic_debugging_options()
 230         },
 231         edition,
 232         ..config::basic_options().clone()
 233     };
 234
 235     // Shuffle around a few input and output handles here. We're going to pass
 236     // an explicit handle into rustc to collect output messages, but we also
 237     // want to catch the error message that rustc prints when it fails.
 238     //
 239     // We take our thread-local stderr (likely set by the test runner) and replace
 240     // it with a sink that is also passed to rustc itself. When this function
 241     // returns the output of the sink is copied onto the output of our own thread.
 242     //
 243     // The basic idea is to not use a default Handler for rustc, and then also
 244     // not print things by default to the actual stderr.
 245     struct Sink(Arc<Mutex<Vec<u8>>>);
 246     impl Write for Sink {
 247         fn write(&mut self, data: &[u8]) -> io::Result<usize> {
 248             Write::write(&mut *self.0.lock().unwrap(), data)
 249         }
 250         fn flush(&mut self) -> io::Result<()> { Ok(()) }
 251     }
 252     struct Bomb(Arc<Mutex<Vec<u8>>>, Box<dyn Write+Send>);
 253     impl Drop for Bomb {
 254         fn drop(&mut self) {
 255             let _ = self.1.write_all(&self.0.lock().unwrap());
 256         }
 257     }
 258     let data = Arc::new(Mutex::new(Vec::new()));
 259
 260     let old = io::set_panic(Some(box Sink(data.clone())));
 261     let _bomb = Bomb(data.clone(), old.unwrap_or(box io::stdout()));
 262
 263     let (libdir, outdir, compile_result) = driver::spawn_thread_pool(sessopts, |sessopts| {
 264         let codemap = Lrc::new(CodeMap::new_doctest(
 265             sessopts.file_path_mapping(), filename.clone(), line as isize - line_offset as isize
 266         ));
 267         let emitter = errors::emitter::EmitterWriter::new(box Sink(data.clone()),
 268                                                         Some(codemap.clone()),
 269                                                         false,
 270                                                         false);
 271
 272         // Compile the code
 273         let diagnostic_handler = errors::Handler::with_emitter(true, false, box emitter);
 274
 275         let mut sess = session::build_session_(
 276             sessopts, None, diagnostic_handler, codemap,
 277         );
 278         let codegen_backend = rustc_driver::get_codegen_backend(&sess);
 279         let cstore = CStore::new(codegen_backend.metadata_loader());
 280         rustc_lint::register_builtins(&mut sess.lint_store.borrow_mut(), Some(&sess));
 281
 282         let outdir = Mutex::new(
 283             TempFileBuilder::new().prefix("rustdoctest").tempdir().expect("rustdoc needs a tempdir")
 284         );
 285         let libdir = sess.target_filesearch(PathKind::All).get_lib_path();
 286         let mut control = driver::CompileController::basic();
 287
 288         let mut cfg = config::build_configuration(&sess, config::parse_cfgspecs(cfgs.clone()));
 289         target_features::add_configuration(&mut cfg, &sess, &*codegen_backend);
 290         sess.parse_sess.config = cfg;
 291
 292         let out = Some(outdir.lock().unwrap().path().to_path_buf());
 293
 294         if no_run {
 295             control.after_analysis.stop = Compilation::Stop;
 296         }
 297
 298         let res = panic::catch_unwind(AssertUnwindSafe(|| {
 299             driver::compile_input(
 300                 codegen_backend,
 301                 &sess,
 302                 &cstore,
 303                 &None,
 304                 &input,
 305                 &out,
 306                 &None,
 307                 None,
 308                 &control
 309             )
 310         }));
 311
 312         let compile_result = match res {
 313             Ok(Ok(())) | Ok(Err(CompileIncomplete::Stopped)) => Ok(()),
 314             Err(_) | Ok(Err(CompileIncomplete::Errored(_))) => Err(())
 315         };
 316
 317         (libdir, outdir, compile_result)
 318     });
 319
 320     match (compile_result, compile_fail) {
 321         (Ok(()), true) => {
 322             panic!("test compiled while it wasn't supposed to")
 323         }
 324         (Ok(()), false) => {}
 325         (Err(()), true) => {
 326             if error_codes.len() > 0 {
 327                 let out = String::from_utf8(data.lock().unwrap().to_vec()).unwrap();
 328                 error_codes.retain(|err| !out.contains(err));
 329             }
 330         }
 331         (Err(()), false) => {
 332             panic!("couldn't compile the test")
 333         }
 334     }
 335
 336     if error_codes.len() > 0 {
 337         panic!("Some expected error codes were not found: {:?}", error_codes);
 338     }
 339
 340     if no_run { return }
 341
 342     // Run the code!
 343     //
 344     // We're careful to prepend the *target* dylib search path to the child's
 345     // environment to ensure that the target loads the right libraries at
 346     // runtime. It would be a sad day if the *host* libraries were loaded as a
 347     // mistake.
 348     let mut cmd = Command::new(&outdir.lock().unwrap().path().join("rust_out"));
 349     let var = DynamicLibrary::envvar();
 350     let newpath = {
 351         let path = env::var_os(var).unwrap_or(OsString::new());
 352         let mut path = env::split_paths(&path).collect::<Vec<_>>();
 353         path.insert(0, libdir.clone());
 354         env::join_paths(path).unwrap()
 355     };
 356     cmd.env(var, &newpath);
 357
 358     match cmd.output() {
 359         Err(e) => panic!("couldn't run the test: {}{}", e,
 360                         if e.kind() == io::ErrorKind::PermissionDenied {
 361                             " - maybe your tempdir is mounted with noexec?"
 362                         } else { "" }),
 363         Ok(out) => {
 364             if should_panic && out.status.success() {
 365                 panic!("test executable succeeded when it should have failed");
 366             } else if !should_panic && !out.status.success() {
 367                 panic!("test executable failed:\n{}\n{}\n",
 368                        str::from_utf8(&out.stdout).unwrap_or(""),
 369                        str::from_utf8(&out.stderr).unwrap_or(""));
 370             }
 371         }
 372     }
 373 }
 374
 375 /// Makes the test file. Also returns the number of lines before the code begins
 376 pub fn make_test(s: &str,
 377                  cratename: Option<&str>,
 378                  dont_insert_main: bool,
 379                  opts: &TestOptions)
 380                  -> (String, usize) {
 381     let (crate_attrs, everything_else) = partition_source(s);
 382     let everything_else = everything_else.trim();
 383     let mut line_offset = 0;
 384     let mut prog = String::new();
 385
 386     if opts.attrs.is_empty() && !opts.display_warnings {
 387         // If there aren't any attributes supplied by #![doc(test(attr(...)))], then allow some
 388         // lints that are commonly triggered in doctests. The crate-level test attributes are
 389         // commonly used to make tests fail in case they trigger warnings, so having this there in
 390         // that case may cause some tests to pass when they shouldn't have.
 391         prog.push_str("#![allow(unused)]\n");
 392         line_offset += 1;
 393     }
 394
 395     // Next, any attributes that came from the crate root via #![doc(test(attr(...)))].
 396     for attr in &opts.attrs {
 397         prog.push_str(&format!("#![{}]\n", attr));
 398         line_offset += 1;
 399     }
 400
 401     // Now push any outer attributes from the example, assuming they
 402     // are intended to be crate attributes.
 403     prog.push_str(&crate_attrs);
 404
 405     // Don't inject `extern crate std` because it's already injected by the
 406     // compiler.
 407     if !s.contains("extern crate") && !opts.no_crate_inject && cratename != Some("std") {
 408         if let Some(cratename) = cratename {
 409             if s.contains(cratename) {
 410                 prog.push_str(&format!("extern crate {};\n", cratename));
 411                 line_offset += 1;
 412             }
 413         }
 414     }
 415
 416     // FIXME (#21299): prefer libsyntax or some other actual parser over this
 417     // best-effort ad hoc approach
 418     let already_has_main = s.lines()
 419         .map(|line| {
 420             let comment = line.find("//");
 421             if let Some(comment_begins) = comment {
 422                 &line[0..comment_begins]
 423             } else {
 424                 line
 425             }
 426         })
 427         .any(|code| code.contains("fn main"));
 428
 429     if dont_insert_main || already_has_main {
 430         prog.push_str(everything_else);
 431     } else {
 432         prog.push_str("fn main() {\n");
 433         line_offset += 1;
 434         prog.push_str(everything_else);
 435         prog.push_str("\n}");
 436     }
 437
 438     info!("final test program: {}", prog);
 439
 440     (prog, line_offset)
 441 }
 442
 443 // FIXME(aburka): use a real parser to deal with multiline attributes
 444 fn partition_source(s: &str) -> (String, String) {
 445     let mut after_header = false;
 446     let mut before = String::new();
 447     let mut after = String::new();
 448
 449     for line in s.lines() {
 450         let trimline = line.trim();
 451         let header = trimline.chars().all(|c| c.is_whitespace()) ||
 452             trimline.starts_with("#![") ||
 453             trimline.starts_with("#[macro_use] extern crate") ||
 454             trimline.starts_with("extern crate");
 455         if !header || after_header {
 456             after_header = true;
 457             after.push_str(line);
 458             after.push_str("\n");
 459         } else {
 460             before.push_str(line);
 461             before.push_str("\n");
 462         }
 463     }
 464
 465     (before, after)
 466 }
 467
 468 pub struct Collector {
 469     pub tests: Vec<testing::TestDescAndFn>,
 470
 471     // The name of the test displayed to the user, separated by `::`.
 472     //
 473     // In tests from Rust source, this is the path to the item
 474     // e.g. `["std", "vec", "Vec", "push"]`.
 475     //
 476     // In tests from a markdown file, this is the titles of all headers (h1~h6)
 477     // of the sections that contain the code block, e.g. if the markdown file is
 478     // written as:
 479     //
 480     // ``````markdown
 481     // # Title
 482     //
 483     // ## Subtitle
 484     //
 485     // ```rust
 486     // assert!(true);
 487     // ```
 488     // ``````
 489     //
 490     // the `names` vector of that test will be `["Title", "Subtitle"]`.
 491     names: Vec<String>,
 492
 493     cfgs: Vec<String>,
 494     libs: SearchPaths,
 495     cg: CodegenOptions,
 496     externs: Externs,
 497     use_headers: bool,
 498     cratename: String,
 499     opts: TestOptions,
 500     maybe_sysroot: Option<PathBuf>,
 501     position: Span,
 502     codemap: Option<Lrc<CodeMap>>,
 503     filename: Option<PathBuf>,
 504     linker: Option<PathBuf>,
 505     edition: Edition,
 506 }
 507
 508 impl Collector {
 509     pub fn new(cratename: String, cfgs: Vec<String>, libs: SearchPaths, cg: CodegenOptions,
 510                externs: Externs, use_headers: bool, opts: TestOptions,
 511                maybe_sysroot: Option<PathBuf>, codemap: Option<Lrc<CodeMap>>,
 512                filename: Option<PathBuf>, linker: Option<PathBuf>, edition: Edition) -> Collector {
 513         Collector {
 514             tests: Vec::new(),
 515             names: Vec::new(),
 516             cfgs,
 517             libs,
 518             cg,
 519             externs,
 520             use_headers,
 521             cratename,
 522             opts,
 523             maybe_sysroot,
 524             position: DUMMY_SP,
 525             codemap,
 526             filename,
 527             linker,
 528             edition,
 529         }
 530     }
 531
 532     fn generate_name(&self, line: usize, filename: &FileName) -> String {
 533         format!("{} - {} (line {})", filename, self.names.join("::"), line)
 534     }
 535
 536     pub fn add_test(&mut self, test: String, config: LangString, line: usize) {
 537         let filename = self.get_filename();
 538         let name = self.generate_name(line, &filename);
 539         let cfgs = self.cfgs.clone();
 540         let libs = self.libs.clone();
 541         let cg = self.cg.clone();
 542         let externs = self.externs.clone();
 543         let cratename = self.cratename.to_string();
 544         let opts = self.opts.clone();
 545         let maybe_sysroot = self.maybe_sysroot.clone();
 546         let linker = self.linker.clone();
 547         let edition = self.edition;
 548         debug!("Creating test {}: {}", name, test);
 549         self.tests.push(testing::TestDescAndFn {
 550             desc: testing::TestDesc {
 551                 name: testing::DynTestName(name.clone()),
 552                 ignore: config.ignore,
 553                 // compiler failures are test failures
 554                 should_panic: testing::ShouldPanic::No,
 555                 allow_fail: config.allow_fail,
 556             },
 557             testfn: testing::DynTestFn(box move || {
 558                 let panic = io::set_panic(None);
 559                 let print = io::set_print(None);
 560                 match {
 561                     rustc_driver::in_named_rustc_thread(name, move || with_globals(move || {
 562                         io::set_panic(panic);
 563                         io::set_print(print);
 564                         hygiene::set_default_edition(edition);
 565                         run_test(&test,
 566                                  &cratename,
 567                                  &filename,
 568                                  line,
 569                                  cfgs,
 570                                  libs,
 571                                  cg,
 572                                  externs,
 573                                  config.should_panic,
 574                                  config.no_run,
 575                                  config.test_harness,
 576                                  config.compile_fail,
 577                                  config.error_codes,
 578                                  &opts,
 579                                  maybe_sysroot,
 580                                  linker,
 581                                  edition)
 582                     }))
 583                 } {
 584                     Ok(()) => (),
 585                     Err(err) => panic::resume_unwind(err),
 586                 }
 587             }),
 588         });
 589     }
 590
 591     pub fn get_line(&self) -> usize {
 592         if let Some(ref codemap) = self.codemap {
 593             let line = self.position.lo().to_usize();
 594             let line = codemap.lookup_char_pos(BytePos(line as u32)).line;
 595             if line > 0 { line - 1 } else { line }
 596         } else {
 597             0
 598         }
 599     }
 600
 601     pub fn set_position(&mut self, position: Span) {
 602         self.position = position;
 603     }
 604
 605     fn get_filename(&self) -> FileName {
 606         if let Some(ref codemap) = self.codemap {
 607             let filename = codemap.span_to_filename(self.position);
 608             if let FileName::Real(ref filename) = filename {
 609                 if let Ok(cur_dir) = env::current_dir() {
 610                     if let Ok(path) = filename.strip_prefix(&cur_dir) {
 611                         return path.to_owned().into();
 612                     }
 613                 }
 614             }
 615             filename
 616         } else if let Some(ref filename) = self.filename {
 617             filename.clone().into()
 618         } else {
 619             FileName::Custom("input".to_owned())
 620         }
 621     }
 622
 623     pub fn register_header(&mut self, name: &str, level: u32) {
 624         if self.use_headers {
 625             // we use these headings as test names, so it's good if
 626             // they're valid identifiers.
 627             let name = name.chars().enumerate().map(|(i, c)| {
 628                     if (i == 0 && c.is_xid_start()) ||
 629                         (i != 0 && c.is_xid_continue()) {
 630                         c
 631                     } else {
 632                         '_'
 633                     }
 634                 }).collect::<String>();
 635
 636             // Here we try to efficiently assemble the header titles into the
 637             // test name in the form of `h1::h2::h3::h4::h5::h6`.
 638             //
 639             // Suppose originally `self.names` contains `[h1, h2, h3]`...
 640             let level = level as usize;
 641             if level <= self.names.len() {
 642                 // ... Consider `level == 2`. All headers in the lower levels
 643                 // are irrelevant in this new level. So we should reset
 644                 // `self.names` to contain headers until <h2>, and replace that
 645                 // slot with the new name: `[h1, name]`.
 646                 self.names.truncate(level);
 647                 self.names[level - 1] = name;
 648             } else {
 649                 // ... On the other hand, consider `level == 5`. This means we
 650                 // need to extend `self.names` to contain five headers. We fill
 651                 // in the missing level (<h4>) with `_`. Thus `self.names` will
 652                 // become `[h1, h2, h3, "_", name]`.
 653                 if level - 1 > self.names.len() {
 654                     self.names.resize(level - 1, "_".to_owned());
 655                 }
 656                 self.names.push(name);
 657             }
 658         }
 659     }
 660 }
 661
 662 struct HirCollector<'a, 'hir: 'a> {
 663     sess: &'a session::Session,
 664     collector: &'a mut Collector,
 665     map: &'a hir::map::Map<'hir>
 666 }
 667
 668 impl<'a, 'hir> HirCollector<'a, 'hir> {
 669     fn visit_testable<F: FnOnce(&mut Self)>(&mut self,
 670                                             name: String,
 671                                             attrs: &[ast::Attribute],
 672                                             nested: F) {
 673         let mut attrs = Attributes::from_ast(self.sess.diagnostic(), attrs);
 674         if let Some(ref cfg) = attrs.cfg {
 675             if !cfg.matches(&self.sess.parse_sess, Some(&self.sess.features_untracked())) {
 676                 return;
 677             }
 678         }
 679
 680         let has_name = !name.is_empty();
 681         if has_name {
 682             self.collector.names.push(name);
 683         }
 684
 685         attrs.collapse_doc_comments();
 686         attrs.unindent_doc_comments();
 687         // the collapse-docs pass won't combine sugared/raw doc attributes, or included files with
 688         // anything else, this will combine them for us
 689         if let Some(doc) = attrs.collapsed_doc_value() {
 690             markdown::find_testable_code(&doc,
 691                                          self.collector,
 692                                          attrs.span.unwrap_or(DUMMY_SP),
 693                                          self.sess.diagnostic());
 694         }
 695
 696         nested(self);
 697
 698         if has_name {
 699             self.collector.names.pop();
 700         }
 701     }
 702 }
 703
 704 impl<'a, 'hir> intravisit::Visitor<'hir> for HirCollector<'a, 'hir> {
 705     fn nested_visit_map<'this>(&'this mut self) -> intravisit::NestedVisitorMap<'this, 'hir> {
 706         intravisit::NestedVisitorMap::All(&self.map)
 707     }
 708
 709     fn visit_item(&mut self, item: &'hir hir::Item) {
 710         let name = if let hir::ItemKind::Impl(.., ref ty, _) = item.node {
 711             self.map.node_to_pretty_string(ty.id)
 712         } else {
 713             item.name.to_string()
 714         };
 715
 716         self.visit_testable(name, &item.attrs, |this| {
 717             intravisit::walk_item(this, item);
 718         });
 719     }
 720
 721     fn visit_trait_item(&mut self, item: &'hir hir::TraitItem) {
 722         self.visit_testable(item.ident.to_string(), &item.attrs, |this| {
 723             intravisit::walk_trait_item(this, item);
 724         });
 725     }
 726
 727     fn visit_impl_item(&mut self, item: &'hir hir::ImplItem) {
 728         self.visit_testable(item.ident.to_string(), &item.attrs, |this| {
 729             intravisit::walk_impl_item(this, item);
 730         });
 731     }
 732
 733     fn visit_foreign_item(&mut self, item: &'hir hir::ForeignItem) {
 734         self.visit_testable(item.name.to_string(), &item.attrs, |this| {
 735             intravisit::walk_foreign_item(this, item);
 736         });
 737     }
 738
 739     fn visit_variant(&mut self,
 740                      v: &'hir hir::Variant,
 741                      g: &'hir hir::Generics,
 742                      item_id: ast::NodeId) {
 743         self.visit_testable(v.node.name.to_string(), &v.node.attrs, |this| {
 744             intravisit::walk_variant(this, v, g, item_id);
 745         });
 746     }
 747
 748     fn visit_struct_field(&mut self, f: &'hir hir::StructField) {
 749         self.visit_testable(f.ident.to_string(), &f.attrs, |this| {
 750             intravisit::walk_struct_field(this, f);
 751         });
 752     }
 753
 754     fn visit_macro_def(&mut self, macro_def: &'hir hir::MacroDef) {
 755         self.visit_testable(macro_def.name.to_string(), &macro_def.attrs, |_| ());
 756     }
 757 }
 758
 759 #[cfg(test)]
 760 mod tests {
 761     use super::{TestOptions, make_test};
 762
 763     #[test]
 764     fn make_test_basic() {
 765         //basic use: wraps with `fn main`, adds `#![allow(unused)]`
 766         let opts = TestOptions::default();
 767         let input =
 768 "assert_eq!(2+2, 4);";
 769         let expected =
 770 "#![allow(unused)]
 771 fn main() {
 772 assert_eq!(2+2, 4);
 773 }".to_string();
 774         let output = make_test(input, None, false, &opts);
 775         assert_eq!(output, (expected.clone(), 2));
 776     }
 777
 778     #[test]
 779     fn make_test_crate_name_no_use() {
 780         //if you give a crate name but *don't* use it within the test, it won't bother inserting
 781         //the `extern crate` statement
 782         let opts = TestOptions::default();
 783         let input =
 784 "assert_eq!(2+2, 4);";
 785         let expected =
 786 "#![allow(unused)]
 787 fn main() {
 788 assert_eq!(2+2, 4);
 789 }".to_string();
 790         let output = make_test(input, Some("asdf"), false, &opts);
 791         assert_eq!(output, (expected, 2));
 792     }
 793
 794     #[test]
 795     fn make_test_crate_name() {
 796         //if you give a crate name and use it within the test, it will insert an `extern crate`
 797         //statement before `fn main`
 798         let opts = TestOptions::default();
 799         let input =
 800 "use asdf::qwop;
 801 assert_eq!(2+2, 4);";
 802         let expected =
 803 "#![allow(unused)]
 804 extern crate asdf;
 805 fn main() {
 806 use asdf::qwop;
 807 assert_eq!(2+2, 4);
 808 }".to_string();
 809         let output = make_test(input, Some("asdf"), false, &opts);
 810         assert_eq!(output, (expected, 3));
 811     }
 812
 813     #[test]
 814     fn make_test_no_crate_inject() {
 815         //even if you do use the crate within the test, setting `opts.no_crate_inject` will skip
 816         //adding it anyway
 817         let opts = TestOptions {
 818             no_crate_inject: true,
 819             display_warnings: false,
 820             attrs: vec![],
 821         };
 822         let input =
 823 "use asdf::qwop;
 824 assert_eq!(2+2, 4);";
 825         let expected =
 826 "#![allow(unused)]
 827 fn main() {
 828 use asdf::qwop;
 829 assert_eq!(2+2, 4);
 830 }".to_string();
 831         let output = make_test(input, Some("asdf"), false, &opts);
 832         assert_eq!(output, (expected, 2));
 833     }
 834
 835     #[test]
 836     fn make_test_ignore_std() {
 837         //even if you include a crate name, and use it in the doctest, we still won't include an
 838         //`extern crate` statement if the crate is "std" - that's included already by the compiler!
 839         let opts = TestOptions::default();
 840         let input =
 841 "use std::*;
 842 assert_eq!(2+2, 4);";
 843         let expected =
 844 "#![allow(unused)]
 845 fn main() {
 846 use std::*;
 847 assert_eq!(2+2, 4);
 848 }".to_string();
 849         let output = make_test(input, Some("std"), false, &opts);
 850         assert_eq!(output, (expected, 2));
 851     }
 852
 853     #[test]
 854     fn make_test_manual_extern_crate() {
 855         //when you manually include an `extern crate` statement in your doctest, make_test assumes
 856         //you've included one for your own crate too
 857         let opts = TestOptions::default();
 858         let input =
 859 "extern crate asdf;
 860 use asdf::qwop;
 861 assert_eq!(2+2, 4);";
 862         let expected =
 863 "#![allow(unused)]
 864 extern crate asdf;
 865 fn main() {
 866 use asdf::qwop;
 867 assert_eq!(2+2, 4);
 868 }".to_string();
 869         let output = make_test(input, Some("asdf"), false, &opts);
 870         assert_eq!(output, (expected, 2));
 871     }
 872
 873     #[test]
 874     fn make_test_manual_extern_crate_with_macro_use() {
 875         let opts = TestOptions::default();
 876         let input =
 877 "#[macro_use] extern crate asdf;
 878 use asdf::qwop;
 879 assert_eq!(2+2, 4);";
 880         let expected =
 881 "#![allow(unused)]
 882 #[macro_use] extern crate asdf;
 883 fn main() {
 884 use asdf::qwop;
 885 assert_eq!(2+2, 4);
 886 }".to_string();
 887         let output = make_test(input, Some("asdf"), false, &opts);
 888         assert_eq!(output, (expected, 2));
 889     }
 890
 891     #[test]
 892     fn make_test_opts_attrs() {
 893         //if you supplied some doctest attributes with #![doc(test(attr(...)))], it will use those
 894         //instead of the stock #![allow(unused)]
 895         let mut opts = TestOptions::default();
 896         opts.attrs.push("feature(sick_rad)".to_string());
 897         let input =
 898 "use asdf::qwop;
 899 assert_eq!(2+2, 4);";
 900         let expected =
 901 "#![feature(sick_rad)]
 902 extern crate asdf;
 903 fn main() {
 904 use asdf::qwop;
 905 assert_eq!(2+2, 4);
 906 }".to_string();
 907         let output = make_test(input, Some("asdf"), false, &opts);
 908         assert_eq!(output, (expected, 3));
 909
 910         //adding more will also bump the returned line offset
 911         opts.attrs.push("feature(hella_dope)".to_string());
 912         let expected =
 913 "#![feature(sick_rad)]
 914 #![feature(hella_dope)]
 915 extern crate asdf;
 916 fn main() {
 917 use asdf::qwop;
 918 assert_eq!(2+2, 4);
 919 }".to_string();
 920         let output = make_test(input, Some("asdf"), false, &opts);
 921         assert_eq!(output, (expected, 4));
 922     }
 923
 924     #[test]
 925     fn make_test_crate_attrs() {
 926         //including inner attributes in your doctest will apply them to the whole "crate", pasting
 927         //them outside the generated main function
 928         let opts = TestOptions::default();
 929         let input =
 930 "#![feature(sick_rad)]
 931 assert_eq!(2+2, 4);";
 932         let expected =
 933 "#![allow(unused)]
 934 #![feature(sick_rad)]
 935 fn main() {
 936 assert_eq!(2+2, 4);
 937 }".to_string();
 938         let output = make_test(input, None, false, &opts);
 939         assert_eq!(output, (expected, 2));
 940     }
 941
 942     #[test]
 943     fn make_test_with_main() {
 944         //including your own `fn main` wrapper lets the test use it verbatim
 945         let opts = TestOptions::default();
 946         let input =
 947 "fn main() {
 948     assert_eq!(2+2, 4);
 949 }";
 950         let expected =
 951 "#![allow(unused)]
 952 fn main() {
 953     assert_eq!(2+2, 4);
 954 }".to_string();
 955         let output = make_test(input, None, false, &opts);
 956         assert_eq!(output, (expected, 1));
 957     }
 958
 959     #[test]
 960     fn make_test_fake_main() {
 961         //...but putting it in a comment will still provide a wrapper
 962         let opts = TestOptions::default();
 963         let input =
 964 "//Ceci n'est pas une `fn main`
 965 assert_eq!(2+2, 4);";
 966         let expected =
 967 "#![allow(unused)]
 968 fn main() {
 969 //Ceci n'est pas une `fn main`
 970 assert_eq!(2+2, 4);
 971 }".to_string();
 972         let output = make_test(input, None, false, &opts);
 973         assert_eq!(output, (expected.clone(), 2));
 974     }
 975
 976     #[test]
 977     fn make_test_dont_insert_main() {
 978         //even with that, if you set `dont_insert_main`, it won't create the `fn main` wrapper
 979         let opts = TestOptions::default();
 980         let input =
 981 "//Ceci n'est pas une `fn main`
 982 assert_eq!(2+2, 4);";
 983         let expected =
 984 "#![allow(unused)]
 985 //Ceci n'est pas une `fn main`
 986 assert_eq!(2+2, 4);".to_string();
 987         let output = make_test(input, None, true, &opts);
 988         assert_eq!(output, (expected.clone(), 1));
 989     }
 990
 991     #[test]
 992     fn make_test_display_warnings() {
 993         //if the user is asking to display doctest warnings, suppress the default allow(unused)
 994         let mut opts = TestOptions::default();
 995         opts.display_warnings = true;
 996         let input =
 997 "assert_eq!(2+2, 4);";
 998         let expected =
 999 "fn main() {
1000 assert_eq!(2+2, 4);
1001 }".to_string();
1002         let output = make_test(input, None, false, &opts);
1003         assert_eq!(output, (expected.clone(), 1));
1004     }
1005 }