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};
  41 use errors;
  42 use errors::emitter::ColorConfig;
  43
  44 use clean::Attributes;
  45 use html::markdown::{self, ErrorCodes, 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::CrateType::Dylib],
  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::Options::default()
  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                 codes: ErrorCodes::from(sess.opts.unstable_features.is_nightly_build()),
 150             };
 151             hir_collector.visit_testable("".to_string(), &krate.attrs, |this| {
 152                 intravisit::walk_crate(this, krate);
 153             });
 154         }
 155
 156         test_args.insert(0, "rustdoctest".to_string());
 157
 158         testing::test_main(&test_args,
 159                         collector.tests.into_iter().collect(),
 160                         testing::Options::new().display_output(display_warnings));
 161         0
 162     })
 163 }
 164
 165 // Look for #![doc(test(no_crate_inject))], used by crates in the std facade
 166 fn scrape_test_config(krate: &::rustc::hir::Crate) -> TestOptions {
 167     use syntax::print::pprust;
 168
 169     let mut opts = TestOptions {
 170         no_crate_inject: false,
 171         display_warnings: false,
 172         attrs: Vec::new(),
 173     };
 174
 175     let test_attrs: Vec<_> = krate.attrs.iter()
 176         .filter(|a| a.check_name("doc"))
 177         .flat_map(|a| a.meta_item_list().unwrap_or_else(Vec::new))
 178         .filter(|a| a.check_name("test"))
 179         .collect();
 180     let attrs = test_attrs.iter().flat_map(|a| a.meta_item_list().unwrap_or(&[]));
 181
 182     for attr in attrs {
 183         if attr.check_name("no_crate_inject") {
 184             opts.no_crate_inject = true;
 185         }
 186         if attr.check_name("attr") {
 187             if let Some(l) = attr.meta_item_list() {
 188                 for item in l {
 189                     opts.attrs.push(pprust::meta_list_item_to_string(item));
 190                 }
 191             }
 192         }
 193     }
 194
 195     opts
 196 }
 197
 198 fn run_test(test: &str, cratename: &str, filename: &FileName, line: usize,
 199             cfgs: Vec<String>, libs: SearchPaths,
 200             cg: CodegenOptions, externs: Externs,
 201             should_panic: bool, no_run: bool, as_test_harness: bool,
 202             compile_fail: bool, mut error_codes: Vec<String>, opts: &TestOptions,
 203             maybe_sysroot: Option<PathBuf>, linker: Option<PathBuf>, edition: Edition) {
 204     // the test harness wants its own `main` & top level functions, so
 205     // never wrap the test in `fn main() { ... }`
 206     let (test, line_offset) = make_test(test, Some(cratename), as_test_harness, opts);
 207     // FIXME(#44940): if doctests ever support path remapping, then this filename
 208     // needs to be the result of CodeMap::span_to_unmapped_path
 209     let input = config::Input::Str {
 210         name: filename.to_owned(),
 211         input: test.to_owned(),
 212     };
 213     let outputs = OutputTypes::new(&[(OutputType::Exe, None)]);
 214
 215     let sessopts = config::Options {
 216         maybe_sysroot: maybe_sysroot.or_else(
 217             || Some(env::current_exe().unwrap().parent().unwrap().parent().unwrap().to_path_buf())),
 218         search_paths: libs,
 219         crate_types: vec![config::CrateType::Executable],
 220         output_types: outputs,
 221         externs,
 222         cg: config::CodegenOptions {
 223             prefer_dynamic: true,
 224             linker,
 225             ..cg
 226         },
 227         test: as_test_harness,
 228         unstable_features: UnstableFeatures::from_environment(),
 229         debugging_opts: config::DebuggingOptions {
 230             ..config::basic_debugging_options()
 231         },
 232         edition,
 233         ..config::Options::default()
 234     };
 235
 236     // Shuffle around a few input and output handles here. We're going to pass
 237     // an explicit handle into rustc to collect output messages, but we also
 238     // want to catch the error message that rustc prints when it fails.
 239     //
 240     // We take our thread-local stderr (likely set by the test runner) and replace
 241     // it with a sink that is also passed to rustc itself. When this function
 242     // returns the output of the sink is copied onto the output of our own thread.
 243     //
 244     // The basic idea is to not use a default Handler for rustc, and then also
 245     // not print things by default to the actual stderr.
 246     struct Sink(Arc<Mutex<Vec<u8>>>);
 247     impl Write for Sink {
 248         fn write(&mut self, data: &[u8]) -> io::Result<usize> {
 249             Write::write(&mut *self.0.lock().unwrap(), data)
 250         }
 251         fn flush(&mut self) -> io::Result<()> { Ok(()) }
 252     }
 253     struct Bomb(Arc<Mutex<Vec<u8>>>, Box<dyn Write+Send>);
 254     impl Drop for Bomb {
 255         fn drop(&mut self) {
 256             let _ = self.1.write_all(&self.0.lock().unwrap());
 257         }
 258     }
 259     let data = Arc::new(Mutex::new(Vec::new()));
 260
 261     let old = io::set_panic(Some(box Sink(data.clone())));
 262     let _bomb = Bomb(data.clone(), old.unwrap_or(box io::stdout()));
 263
 264     let (libdir, outdir, compile_result) = driver::spawn_thread_pool(sessopts, |sessopts| {
 265         let codemap = Lrc::new(CodeMap::new_doctest(
 266             sessopts.file_path_mapping(), filename.clone(), line as isize - line_offset as isize
 267         ));
 268         let emitter = errors::emitter::EmitterWriter::new(box Sink(data.clone()),
 269                                                         Some(codemap.clone()),
 270                                                         false,
 271                                                         false);
 272
 273         // Compile the code
 274         let diagnostic_handler = errors::Handler::with_emitter(true, false, box emitter);
 275
 276         let mut sess = session::build_session_(
 277             sessopts, None, diagnostic_handler, codemap,
 278         );
 279         let codegen_backend = rustc_driver::get_codegen_backend(&sess);
 280         let cstore = CStore::new(codegen_backend.metadata_loader());
 281         rustc_lint::register_builtins(&mut sess.lint_store.borrow_mut(), Some(&sess));
 282
 283         let outdir = Mutex::new(
 284             TempFileBuilder::new().prefix("rustdoctest").tempdir().expect("rustdoc needs a tempdir")
 285         );
 286         let libdir = sess.target_filesearch(PathKind::All).get_lib_path();
 287         let mut control = driver::CompileController::basic();
 288
 289         let mut cfg = config::build_configuration(&sess, config::parse_cfgspecs(cfgs.clone()));
 290         target_features::add_configuration(&mut cfg, &sess, &*codegen_backend);
 291         sess.parse_sess.config = cfg;
 292
 293         let out = Some(outdir.lock().unwrap().path().to_path_buf());
 294
 295         if no_run {
 296             control.after_analysis.stop = Compilation::Stop;
 297         }
 298
 299         let res = panic::catch_unwind(AssertUnwindSafe(|| {
 300             driver::compile_input(
 301                 codegen_backend,
 302                 &sess,
 303                 &cstore,
 304                 &None,
 305                 &input,
 306                 &out,
 307                 &None,
 308                 None,
 309                 &control
 310             )
 311         }));
 312
 313         let compile_result = match res {
 314             Ok(Ok(())) | Ok(Err(CompileIncomplete::Stopped)) => Ok(()),
 315             Err(_) | Ok(Err(CompileIncomplete::Errored(_))) => Err(())
 316         };
 317
 318         (libdir, outdir, compile_result)
 319     });
 320
 321     match (compile_result, compile_fail) {
 322         (Ok(()), true) => {
 323             panic!("test compiled while it wasn't supposed to")
 324         }
 325         (Ok(()), false) => {}
 326         (Err(()), true) => {
 327             if error_codes.len() > 0 {
 328                 let out = String::from_utf8(data.lock().unwrap().to_vec()).unwrap();
 329                 error_codes.retain(|err| !out.contains(err));
 330             }
 331         }
 332         (Err(()), false) => {
 333             panic!("couldn't compile the test")
 334         }
 335     }
 336
 337     if error_codes.len() > 0 {
 338         panic!("Some expected error codes were not found: {:?}", error_codes);
 339     }
 340
 341     if no_run { return }
 342
 343     // Run the code!
 344     //
 345     // We're careful to prepend the *target* dylib search path to the child's
 346     // environment to ensure that the target loads the right libraries at
 347     // runtime. It would be a sad day if the *host* libraries were loaded as a
 348     // mistake.
 349     let mut cmd = Command::new(&outdir.lock().unwrap().path().join("rust_out"));
 350     let var = DynamicLibrary::envvar();
 351     let newpath = {
 352         let path = env::var_os(var).unwrap_or(OsString::new());
 353         let mut path = env::split_paths(&path).collect::<Vec<_>>();
 354         path.insert(0, libdir.clone());
 355         env::join_paths(path).unwrap()
 356     };
 357     cmd.env(var, &newpath);
 358
 359     match cmd.output() {
 360         Err(e) => panic!("couldn't run the test: {}{}", e,
 361                         if e.kind() == io::ErrorKind::PermissionDenied {
 362                             " - maybe your tempdir is mounted with noexec?"
 363                         } else { "" }),
 364         Ok(out) => {
 365             if should_panic && out.status.success() {
 366                 panic!("test executable succeeded when it should have failed");
 367             } else if !should_panic && !out.status.success() {
 368                 panic!("test executable failed:\n{}\n{}\n",
 369                        str::from_utf8(&out.stdout).unwrap_or(""),
 370                        str::from_utf8(&out.stderr).unwrap_or(""));
 371             }
 372         }
 373     }
 374 }
 375
 376 /// Makes the test file. Also returns the number of lines before the code begins
 377 pub fn make_test(s: &str,
 378                  cratename: Option<&str>,
 379                  dont_insert_main: bool,
 380                  opts: &TestOptions)
 381                  -> (String, usize) {
 382     let (crate_attrs, everything_else) = partition_source(s);
 383     let everything_else = everything_else.trim();
 384     let mut line_offset = 0;
 385     let mut prog = String::new();
 386
 387     if opts.attrs.is_empty() && !opts.display_warnings {
 388         // If there aren't any attributes supplied by #![doc(test(attr(...)))], then allow some
 389         // lints that are commonly triggered in doctests. The crate-level test attributes are
 390         // commonly used to make tests fail in case they trigger warnings, so having this there in
 391         // that case may cause some tests to pass when they shouldn't have.
 392         prog.push_str("#![allow(unused)]\n");
 393         line_offset += 1;
 394     }
 395
 396     // Next, any attributes that came from the crate root via #![doc(test(attr(...)))].
 397     for attr in &opts.attrs {
 398         prog.push_str(&format!("#![{}]\n", attr));
 399         line_offset += 1;
 400     }
 401
 402     // Now push any outer attributes from the example, assuming they
 403     // are intended to be crate attributes.
 404     prog.push_str(&crate_attrs);
 405
 406     // Don't inject `extern crate std` because it's already injected by the
 407     // compiler.
 408     if !s.contains("extern crate") && !opts.no_crate_inject && cratename != Some("std") {
 409         if let Some(cratename) = cratename {
 410             if s.contains(cratename) {
 411                 prog.push_str(&format!("extern crate {};\n", cratename));
 412                 line_offset += 1;
 413             }
 414         }
 415     }
 416
 417     // FIXME (#21299): prefer libsyntax or some other actual parser over this
 418     // best-effort ad hoc approach
 419     let already_has_main = s.lines()
 420         .map(|line| {
 421             let comment = line.find("//");
 422             if let Some(comment_begins) = comment {
 423                 &line[0..comment_begins]
 424             } else {
 425                 line
 426             }
 427         })
 428         .any(|code| code.contains("fn main"));
 429
 430     if dont_insert_main || already_has_main {
 431         prog.push_str(everything_else);
 432     } else {
 433         prog.push_str("fn main() {\n");
 434         line_offset += 1;
 435         prog.push_str(everything_else);
 436         prog.push_str("\n}");
 437     }
 438
 439     info!("final test program: {}", prog);
 440
 441     (prog, line_offset)
 442 }
 443
 444 // FIXME(aburka): use a real parser to deal with multiline attributes
 445 fn partition_source(s: &str) -> (String, String) {
 446     let mut after_header = false;
 447     let mut before = String::new();
 448     let mut after = String::new();
 449
 450     for line in s.lines() {
 451         let trimline = line.trim();
 452         let header = trimline.chars().all(|c| c.is_whitespace()) ||
 453             trimline.starts_with("#![") ||
 454             trimline.starts_with("#[macro_use] extern crate") ||
 455             trimline.starts_with("extern crate");
 456         if !header || after_header {
 457             after_header = true;
 458             after.push_str(line);
 459             after.push_str("\n");
 460         } else {
 461             before.push_str(line);
 462             before.push_str("\n");
 463         }
 464     }
 465
 466     (before, after)
 467 }
 468
 469 pub struct Collector {
 470     pub tests: Vec<testing::TestDescAndFn>,
 471
 472     // The name of the test displayed to the user, separated by `::`.
 473     //
 474     // In tests from Rust source, this is the path to the item
 475     // e.g. `["std", "vec", "Vec", "push"]`.
 476     //
 477     // In tests from a markdown file, this is the titles of all headers (h1~h6)
 478     // of the sections that contain the code block, e.g. if the markdown file is
 479     // written as:
 480     //
 481     // ``````markdown
 482     // # Title
 483     //
 484     // ## Subtitle
 485     //
 486     // ```rust
 487     // assert!(true);
 488     // ```
 489     // ``````
 490     //
 491     // the `names` vector of that test will be `["Title", "Subtitle"]`.
 492     names: Vec<String>,
 493
 494     cfgs: Vec<String>,
 495     libs: SearchPaths,
 496     cg: CodegenOptions,
 497     externs: Externs,
 498     use_headers: bool,
 499     cratename: String,
 500     opts: TestOptions,
 501     maybe_sysroot: Option<PathBuf>,
 502     position: Span,
 503     codemap: Option<Lrc<CodeMap>>,
 504     filename: Option<PathBuf>,
 505     linker: Option<PathBuf>,
 506     edition: Edition,
 507 }
 508
 509 impl Collector {
 510     pub fn new(cratename: String, cfgs: Vec<String>, libs: SearchPaths, cg: CodegenOptions,
 511                externs: Externs, use_headers: bool, opts: TestOptions,
 512                maybe_sysroot: Option<PathBuf>, codemap: Option<Lrc<CodeMap>>,
 513                filename: Option<PathBuf>, linker: Option<PathBuf>, edition: Edition) -> Collector {
 514         Collector {
 515             tests: Vec::new(),
 516             names: Vec::new(),
 517             cfgs,
 518             libs,
 519             cg,
 520             externs,
 521             use_headers,
 522             cratename,
 523             opts,
 524             maybe_sysroot,
 525             position: DUMMY_SP,
 526             codemap,
 527             filename,
 528             linker,
 529             edition,
 530         }
 531     }
 532
 533     fn generate_name(&self, line: usize, filename: &FileName) -> String {
 534         format!("{} - {} (line {})", filename, self.names.join("::"), line)
 535     }
 536
 537     pub fn add_test(&mut self, test: String, config: LangString, line: usize) {
 538         let filename = self.get_filename();
 539         let name = self.generate_name(line, &filename);
 540         let cfgs = self.cfgs.clone();
 541         let libs = self.libs.clone();
 542         let cg = self.cg.clone();
 543         let externs = self.externs.clone();
 544         let cratename = self.cratename.to_string();
 545         let opts = self.opts.clone();
 546         let maybe_sysroot = self.maybe_sysroot.clone();
 547         let linker = self.linker.clone();
 548         let edition = self.edition;
 549         debug!("Creating test {}: {}", name, test);
 550         self.tests.push(testing::TestDescAndFn {
 551             desc: testing::TestDesc {
 552                 name: testing::DynTestName(name.clone()),
 553                 ignore: config.ignore,
 554                 // compiler failures are test failures
 555                 should_panic: testing::ShouldPanic::No,
 556                 allow_fail: config.allow_fail,
 557             },
 558             testfn: testing::DynTestFn(box move || {
 559                 let panic = io::set_panic(None);
 560                 let print = io::set_print(None);
 561                 match {
 562                     rustc_driver::in_named_rustc_thread(name, move || with_globals(move || {
 563                         io::set_panic(panic);
 564                         io::set_print(print);
 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     codes: ErrorCodes,
 667 }
 668
 669 impl<'a, 'hir> HirCollector<'a, 'hir> {
 670     fn visit_testable<F: FnOnce(&mut Self)>(&mut self,
 671                                             name: String,
 672                                             attrs: &[ast::Attribute],
 673                                             nested: F) {
 674         let mut attrs = Attributes::from_ast(self.sess.diagnostic(), attrs);
 675         if let Some(ref cfg) = attrs.cfg {
 676             if !cfg.matches(&self.sess.parse_sess, Some(&self.sess.features_untracked())) {
 677                 return;
 678             }
 679         }
 680
 681         let has_name = !name.is_empty();
 682         if has_name {
 683             self.collector.names.push(name);
 684         }
 685
 686         attrs.collapse_doc_comments();
 687         attrs.unindent_doc_comments();
 688         // the collapse-docs pass won't combine sugared/raw doc attributes, or included files with
 689         // anything else, this will combine them for us
 690         if let Some(doc) = attrs.collapsed_doc_value() {
 691             self.collector.set_position(attrs.span.unwrap_or(DUMMY_SP));
 692             let res = markdown::find_testable_code(&doc, self.collector, self.codes);
 693             if let Err(err) = res {
 694                 self.sess.diagnostic().span_warn(attrs.span.unwrap_or(DUMMY_SP),
 695                     &err.to_string());
 696             }
 697         }
 698
 699         nested(self);
 700
 701         if has_name {
 702             self.collector.names.pop();
 703         }
 704     }
 705 }
 706
 707 impl<'a, 'hir> intravisit::Visitor<'hir> for HirCollector<'a, 'hir> {
 708     fn nested_visit_map<'this>(&'this mut self) -> intravisit::NestedVisitorMap<'this, 'hir> {
 709         intravisit::NestedVisitorMap::All(&self.map)
 710     }
 711
 712     fn visit_item(&mut self, item: &'hir hir::Item) {
 713         let name = if let hir::ItemKind::Impl(.., ref ty, _) = item.node {
 714             self.map.node_to_pretty_string(ty.id)
 715         } else {
 716             item.name.to_string()
 717         };
 718
 719         self.visit_testable(name, &item.attrs, |this| {
 720             intravisit::walk_item(this, item);
 721         });
 722     }
 723
 724     fn visit_trait_item(&mut self, item: &'hir hir::TraitItem) {
 725         self.visit_testable(item.ident.to_string(), &item.attrs, |this| {
 726             intravisit::walk_trait_item(this, item);
 727         });
 728     }
 729
 730     fn visit_impl_item(&mut self, item: &'hir hir::ImplItem) {
 731         self.visit_testable(item.ident.to_string(), &item.attrs, |this| {
 732             intravisit::walk_impl_item(this, item);
 733         });
 734     }
 735
 736     fn visit_foreign_item(&mut self, item: &'hir hir::ForeignItem) {
 737         self.visit_testable(item.name.to_string(), &item.attrs, |this| {
 738             intravisit::walk_foreign_item(this, item);
 739         });
 740     }
 741
 742     fn visit_variant(&mut self,
 743                      v: &'hir hir::Variant,
 744                      g: &'hir hir::Generics,
 745                      item_id: ast::NodeId) {
 746         self.visit_testable(v.node.name.to_string(), &v.node.attrs, |this| {
 747             intravisit::walk_variant(this, v, g, item_id);
 748         });
 749     }
 750
 751     fn visit_struct_field(&mut self, f: &'hir hir::StructField) {
 752         self.visit_testable(f.ident.to_string(), &f.attrs, |this| {
 753             intravisit::walk_struct_field(this, f);
 754         });
 755     }
 756
 757     fn visit_macro_def(&mut self, macro_def: &'hir hir::MacroDef) {
 758         self.visit_testable(macro_def.name.to_string(), &macro_def.attrs, |_| ());
 759     }
 760 }
 761
 762 #[cfg(test)]
 763 mod tests {
 764     use super::{TestOptions, make_test};
 765
 766     #[test]
 767     fn make_test_basic() {
 768         //basic use: wraps with `fn main`, adds `#![allow(unused)]`
 769         let opts = TestOptions::default();
 770         let input =
 771 "assert_eq!(2+2, 4);";
 772         let expected =
 773 "#![allow(unused)]
 774 fn main() {
 775 assert_eq!(2+2, 4);
 776 }".to_string();
 777         let output = make_test(input, None, false, &opts);
 778         assert_eq!(output, (expected.clone(), 2));
 779     }
 780
 781     #[test]
 782     fn make_test_crate_name_no_use() {
 783         //if you give a crate name but *don't* use it within the test, it won't bother inserting
 784         //the `extern crate` statement
 785         let opts = TestOptions::default();
 786         let input =
 787 "assert_eq!(2+2, 4);";
 788         let expected =
 789 "#![allow(unused)]
 790 fn main() {
 791 assert_eq!(2+2, 4);
 792 }".to_string();
 793         let output = make_test(input, Some("asdf"), false, &opts);
 794         assert_eq!(output, (expected, 2));
 795     }
 796
 797     #[test]
 798     fn make_test_crate_name() {
 799         //if you give a crate name and use it within the test, it will insert an `extern crate`
 800         //statement before `fn main`
 801         let opts = TestOptions::default();
 802         let input =
 803 "use asdf::qwop;
 804 assert_eq!(2+2, 4);";
 805         let expected =
 806 "#![allow(unused)]
 807 extern crate asdf;
 808 fn main() {
 809 use asdf::qwop;
 810 assert_eq!(2+2, 4);
 811 }".to_string();
 812         let output = make_test(input, Some("asdf"), false, &opts);
 813         assert_eq!(output, (expected, 3));
 814     }
 815
 816     #[test]
 817     fn make_test_no_crate_inject() {
 818         //even if you do use the crate within the test, setting `opts.no_crate_inject` will skip
 819         //adding it anyway
 820         let opts = TestOptions {
 821             no_crate_inject: true,
 822             display_warnings: false,
 823             attrs: vec![],
 824         };
 825         let input =
 826 "use asdf::qwop;
 827 assert_eq!(2+2, 4);";
 828         let expected =
 829 "#![allow(unused)]
 830 fn main() {
 831 use asdf::qwop;
 832 assert_eq!(2+2, 4);
 833 }".to_string();
 834         let output = make_test(input, Some("asdf"), false, &opts);
 835         assert_eq!(output, (expected, 2));
 836     }
 837
 838     #[test]
 839     fn make_test_ignore_std() {
 840         //even if you include a crate name, and use it in the doctest, we still won't include an
 841         //`extern crate` statement if the crate is "std" - that's included already by the compiler!
 842         let opts = TestOptions::default();
 843         let input =
 844 "use std::*;
 845 assert_eq!(2+2, 4);";
 846         let expected =
 847 "#![allow(unused)]
 848 fn main() {
 849 use std::*;
 850 assert_eq!(2+2, 4);
 851 }".to_string();
 852         let output = make_test(input, Some("std"), false, &opts);
 853         assert_eq!(output, (expected, 2));
 854     }
 855
 856     #[test]
 857     fn make_test_manual_extern_crate() {
 858         //when you manually include an `extern crate` statement in your doctest, make_test assumes
 859         //you've included one for your own crate too
 860         let opts = TestOptions::default();
 861         let input =
 862 "extern crate asdf;
 863 use asdf::qwop;
 864 assert_eq!(2+2, 4);";
 865         let expected =
 866 "#![allow(unused)]
 867 extern crate asdf;
 868 fn main() {
 869 use asdf::qwop;
 870 assert_eq!(2+2, 4);
 871 }".to_string();
 872         let output = make_test(input, Some("asdf"), false, &opts);
 873         assert_eq!(output, (expected, 2));
 874     }
 875
 876     #[test]
 877     fn make_test_manual_extern_crate_with_macro_use() {
 878         let opts = TestOptions::default();
 879         let input =
 880 "#[macro_use] extern crate asdf;
 881 use asdf::qwop;
 882 assert_eq!(2+2, 4);";
 883         let expected =
 884 "#![allow(unused)]
 885 #[macro_use] extern crate asdf;
 886 fn main() {
 887 use asdf::qwop;
 888 assert_eq!(2+2, 4);
 889 }".to_string();
 890         let output = make_test(input, Some("asdf"), false, &opts);
 891         assert_eq!(output, (expected, 2));
 892     }
 893
 894     #[test]
 895     fn make_test_opts_attrs() {
 896         //if you supplied some doctest attributes with #![doc(test(attr(...)))], it will use those
 897         //instead of the stock #![allow(unused)]
 898         let mut opts = TestOptions::default();
 899         opts.attrs.push("feature(sick_rad)".to_string());
 900         let input =
 901 "use asdf::qwop;
 902 assert_eq!(2+2, 4);";
 903         let expected =
 904 "#![feature(sick_rad)]
 905 extern crate asdf;
 906 fn main() {
 907 use asdf::qwop;
 908 assert_eq!(2+2, 4);
 909 }".to_string();
 910         let output = make_test(input, Some("asdf"), false, &opts);
 911         assert_eq!(output, (expected, 3));
 912
 913         //adding more will also bump the returned line offset
 914         opts.attrs.push("feature(hella_dope)".to_string());
 915         let expected =
 916 "#![feature(sick_rad)]
 917 #![feature(hella_dope)]
 918 extern crate asdf;
 919 fn main() {
 920 use asdf::qwop;
 921 assert_eq!(2+2, 4);
 922 }".to_string();
 923         let output = make_test(input, Some("asdf"), false, &opts);
 924         assert_eq!(output, (expected, 4));
 925     }
 926
 927     #[test]
 928     fn make_test_crate_attrs() {
 929         //including inner attributes in your doctest will apply them to the whole "crate", pasting
 930         //them outside the generated main function
 931         let opts = TestOptions::default();
 932         let input =
 933 "#![feature(sick_rad)]
 934 assert_eq!(2+2, 4);";
 935         let expected =
 936 "#![allow(unused)]
 937 #![feature(sick_rad)]
 938 fn main() {
 939 assert_eq!(2+2, 4);
 940 }".to_string();
 941         let output = make_test(input, None, false, &opts);
 942         assert_eq!(output, (expected, 2));
 943     }
 944
 945     #[test]
 946     fn make_test_with_main() {
 947         //including your own `fn main` wrapper lets the test use it verbatim
 948         let opts = TestOptions::default();
 949         let input =
 950 "fn main() {
 951     assert_eq!(2+2, 4);
 952 }";
 953         let expected =
 954 "#![allow(unused)]
 955 fn main() {
 956     assert_eq!(2+2, 4);
 957 }".to_string();
 958         let output = make_test(input, None, false, &opts);
 959         assert_eq!(output, (expected, 1));
 960     }
 961
 962     #[test]
 963     fn make_test_fake_main() {
 964         //...but putting it in a comment will still provide a wrapper
 965         let opts = TestOptions::default();
 966         let input =
 967 "//Ceci n'est pas une `fn main`
 968 assert_eq!(2+2, 4);";
 969         let expected =
 970 "#![allow(unused)]
 971 fn main() {
 972 //Ceci n'est pas une `fn main`
 973 assert_eq!(2+2, 4);
 974 }".to_string();
 975         let output = make_test(input, None, false, &opts);
 976         assert_eq!(output, (expected.clone(), 2));
 977     }
 978
 979     #[test]
 980     fn make_test_dont_insert_main() {
 981         //even with that, if you set `dont_insert_main`, it won't create the `fn main` wrapper
 982         let opts = TestOptions::default();
 983         let input =
 984 "//Ceci n'est pas une `fn main`
 985 assert_eq!(2+2, 4);";
 986         let expected =
 987 "#![allow(unused)]
 988 //Ceci n'est pas une `fn main`
 989 assert_eq!(2+2, 4);".to_string();
 990         let output = make_test(input, None, true, &opts);
 991         assert_eq!(output, (expected.clone(), 1));
 992     }
 993
 994     #[test]
 995     fn make_test_display_warnings() {
 996         //if the user is asking to display doctest warnings, suppress the default allow(unused)
 997         let mut opts = TestOptions::default();
 998         opts.display_warnings = true;
 999         let input =
1000 "assert_eq!(2+2, 4);";
1001         let expected =
1002 "fn main() {
1003 assert_eq!(2+2, 4);
1004 }".to_string();
1005         let output = make_test(input, None, false, &opts);
1006         assert_eq!(output, (expected.clone(), 1));
1007     }
1008 }