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.
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.
11 use std::collections::HashMap;
13 use std::ffi::OsString;
14 use std::io::prelude::*;
16 use std::path::{Path, PathBuf};
17 use std::panic::{self, AssertUnwindSafe};
18 use std::process::Command;
21 use std::sync::{Arc, Mutex};
25 use rustc::dep_graph::DepGraph;
27 use rustc::hir::intravisit;
28 use rustc::session::{self, config};
29 use rustc::session::config::{OutputType, OutputTypes, Externs};
30 use rustc::session::search_paths::{SearchPaths, PathKind};
31 use rustc_back::dynamic_lib::DynamicLibrary;
32 use rustc_back::tempdir::TempDir;
33 use rustc_driver::{self, driver, Compilation};
34 use rustc_driver::driver::phase_2_configure_and_expand;
35 use rustc_metadata::cstore::CStore;
36 use rustc_resolve::MakeGlobMap;
38 use rustc_trans::back::link;
40 use syntax::codemap::CodeMap;
41 use syntax::feature_gate::UnstableFeatures;
42 use syntax_pos::{BytePos, DUMMY_SP, Pos, Span};
44 use errors::emitter::ColorConfig;
46 use clean::Attributes;
47 use html::markdown::{self, RenderType};
49 #[derive(Clone, Default)]
50 pub struct TestOptions {
51 pub no_crate_inject: bool,
52 pub attrs: Vec<String>,
55 pub fn run(input: &str,
59 mut test_args: Vec<String>,
60 crate_name: Option<String>,
61 maybe_sysroot: Option<PathBuf>,
62 render_type: RenderType,
63 display_warnings: bool)
65 let input_path = PathBuf::from(input);
66 let input = config::Input::File(input_path.clone());
68 let sessopts = config::Options {
69 maybe_sysroot: maybe_sysroot.clone().or_else(
70 || Some(env::current_exe().unwrap().parent().unwrap().parent().unwrap().to_path_buf())),
71 search_paths: libs.clone(),
72 crate_types: vec![config::CrateTypeDylib],
73 externs: externs.clone(),
74 unstable_features: UnstableFeatures::from_environment(),
75 actually_rustdoc: true,
76 ..config::basic_options().clone()
79 let codemap = Rc::new(CodeMap::new(sessopts.file_path_mapping()));
81 errors::Handler::with_tty_emitter(ColorConfig::Auto, true, false, Some(codemap.clone()));
83 let dep_graph = DepGraph::new(false);
84 let _ignore = dep_graph.in_ignore();
85 let cstore = Rc::new(CStore::new(&dep_graph, box rustc_trans::LlvmMetadataLoader));
86 let mut sess = session::build_session_(
87 sessopts, &dep_graph, Some(input_path.clone()), handler, codemap.clone(), cstore.clone(),
89 rustc_lint::register_builtins(&mut sess.lint_store.borrow_mut(), Some(&sess));
90 sess.parse_sess.config =
91 config::build_configuration(&sess, config::parse_cfgspecs(cfgs.clone()));
93 let krate = panictry!(driver::phase_1_parse_input(&sess, &input));
94 let driver::ExpansionResult { defs, mut hir_forest, .. } = {
95 phase_2_configure_and_expand(
96 &sess, &cstore, krate, None, "rustdoc-test", None, MakeGlobMap::No, |_| Ok(())
97 ).expect("phase_2_configure_and_expand aborted in rustdoc!")
100 let crate_name = crate_name.unwrap_or_else(|| {
101 link::find_crate_name(None, &hir_forest.krate().attrs, &input)
103 let opts = scrape_test_config(hir_forest.krate());
104 let mut collector = Collector::new(crate_name,
116 let dep_graph = DepGraph::new(false);
117 let _ignore = dep_graph.in_ignore();
118 let map = hir::map::map_crate(&mut hir_forest, defs);
119 let krate = map.krate();
120 let mut hir_collector = HirCollector {
121 collector: &mut collector,
124 hir_collector.visit_testable("".to_string(), &krate.attrs, |this| {
125 intravisit::walk_crate(this, krate);
129 test_args.insert(0, "rustdoctest".to_string());
131 testing::test_main(&test_args,
132 collector.tests.into_iter().collect(),
133 testing::Options::new().display_output(display_warnings));
137 // Look for #![doc(test(no_crate_inject))], used by crates in the std facade
138 fn scrape_test_config(krate: &::rustc::hir::Crate) -> TestOptions {
139 use syntax::print::pprust;
141 let mut opts = TestOptions {
142 no_crate_inject: false,
146 let test_attrs: Vec<_> = krate.attrs.iter()
147 .filter(|a| a.check_name("doc"))
148 .flat_map(|a| a.meta_item_list().unwrap_or_else(Vec::new))
149 .filter(|a| a.check_name("test"))
151 let attrs = test_attrs.iter().flat_map(|a| a.meta_item_list().unwrap_or(&[]));
154 if attr.check_name("no_crate_inject") {
155 opts.no_crate_inject = true;
157 if attr.check_name("attr") {
158 if let Some(l) = attr.meta_item_list() {
160 opts.attrs.push(pprust::meta_list_item_to_string(item));
169 fn runtest(test: &str, cratename: &str, cfgs: Vec<String>, libs: SearchPaths,
171 should_panic: bool, no_run: bool, as_test_harness: bool,
172 compile_fail: bool, mut error_codes: Vec<String>, opts: &TestOptions,
173 maybe_sysroot: Option<PathBuf>) {
174 // the test harness wants its own `main` & top level functions, so
175 // never wrap the test in `fn main() { ... }`
176 let test = maketest(test, Some(cratename), as_test_harness, opts);
177 let input = config::Input::Str {
178 name: driver::anon_src(),
179 input: test.to_owned(),
181 let outputs = OutputTypes::new(&[(OutputType::Exe, None)]);
183 let sessopts = config::Options {
184 maybe_sysroot: maybe_sysroot.or_else(
185 || Some(env::current_exe().unwrap().parent().unwrap().parent().unwrap().to_path_buf())),
187 crate_types: vec![config::CrateTypeExecutable],
188 output_types: outputs,
190 cg: config::CodegenOptions {
191 prefer_dynamic: true,
192 .. config::basic_codegen_options()
194 test: as_test_harness,
195 unstable_features: UnstableFeatures::from_environment(),
196 ..config::basic_options().clone()
199 // Shuffle around a few input and output handles here. We're going to pass
200 // an explicit handle into rustc to collect output messages, but we also
201 // want to catch the error message that rustc prints when it fails.
203 // We take our thread-local stderr (likely set by the test runner) and replace
204 // it with a sink that is also passed to rustc itself. When this function
205 // returns the output of the sink is copied onto the output of our own thread.
207 // The basic idea is to not use a default Handler for rustc, and then also
208 // not print things by default to the actual stderr.
209 struct Sink(Arc<Mutex<Vec<u8>>>);
210 impl Write for Sink {
211 fn write(&mut self, data: &[u8]) -> io::Result<usize> {
212 Write::write(&mut *self.0.lock().unwrap(), data)
214 fn flush(&mut self) -> io::Result<()> { Ok(()) }
216 struct Bomb(Arc<Mutex<Vec<u8>>>, Box<Write+Send>);
219 let _ = self.1.write_all(&self.0.lock().unwrap());
222 let data = Arc::new(Mutex::new(Vec::new()));
223 let codemap = Rc::new(CodeMap::new(sessopts.file_path_mapping()));
224 let emitter = errors::emitter::EmitterWriter::new(box Sink(data.clone()),
225 Some(codemap.clone()));
226 let old = io::set_panic(Some(box Sink(data.clone())));
227 let _bomb = Bomb(data.clone(), old.unwrap_or(box io::stdout()));
230 let diagnostic_handler = errors::Handler::with_emitter(true, false, box emitter);
232 let dep_graph = DepGraph::new(false);
233 let cstore = Rc::new(CStore::new(&dep_graph, box rustc_trans::LlvmMetadataLoader));
234 let mut sess = session::build_session_(
235 sessopts, &dep_graph, None, diagnostic_handler, codemap, cstore.clone(),
237 rustc_lint::register_builtins(&mut sess.lint_store.borrow_mut(), Some(&sess));
239 let outdir = Mutex::new(TempDir::new("rustdoctest").ok().expect("rustdoc needs a tempdir"));
240 let libdir = sess.target_filesearch(PathKind::All).get_lib_path();
241 let mut control = driver::CompileController::basic();
242 sess.parse_sess.config =
243 config::build_configuration(&sess, config::parse_cfgspecs(cfgs.clone()));
244 let out = Some(outdir.lock().unwrap().path().to_path_buf());
247 control.after_analysis.stop = Compilation::Stop;
250 let res = panic::catch_unwind(AssertUnwindSafe(|| {
251 driver::compile_input(&sess, &cstore, &input, &out, &None, None, &control)
258 if count > 0 && !compile_fail {
259 sess.fatal("aborting due to previous error(s)")
260 } else if count == 0 && compile_fail {
261 panic!("test compiled while it wasn't supposed to")
263 if count > 0 && error_codes.len() > 0 {
264 let out = String::from_utf8(data.lock().unwrap().to_vec()).unwrap();
265 error_codes.retain(|err| !out.contains(err));
268 Ok(()) if compile_fail => {
269 panic!("test compiled while it wasn't supposed to")
276 panic!("couldn't compile the test");
278 if error_codes.len() > 0 {
279 let out = String::from_utf8(data.lock().unwrap().to_vec()).unwrap();
280 error_codes.retain(|err| !out.contains(err));
285 if error_codes.len() > 0 {
286 panic!("Some expected error codes were not found: {:?}", error_codes);
293 // We're careful to prepend the *target* dylib search path to the child's
294 // environment to ensure that the target loads the right libraries at
295 // runtime. It would be a sad day if the *host* libraries were loaded as a
297 let mut cmd = Command::new(&outdir.lock().unwrap().path().join("rust_out"));
298 let var = DynamicLibrary::envvar();
300 let path = env::var_os(var).unwrap_or(OsString::new());
301 let mut path = env::split_paths(&path).collect::<Vec<_>>();
302 path.insert(0, libdir.clone());
303 env::join_paths(path).unwrap()
305 cmd.env(var, &newpath);
308 Err(e) => panic!("couldn't run the test: {}{}", e,
309 if e.kind() == io::ErrorKind::PermissionDenied {
310 " - maybe your tempdir is mounted with noexec?"
313 if should_panic && out.status.success() {
314 panic!("test executable succeeded when it should have failed");
315 } else if !should_panic && !out.status.success() {
316 panic!("test executable failed:\n{}\n{}\n",
317 str::from_utf8(&out.stdout).unwrap_or(""),
318 str::from_utf8(&out.stderr).unwrap_or(""));
324 pub fn maketest(s: &str, cratename: Option<&str>, dont_insert_main: bool,
325 opts: &TestOptions) -> String {
326 let (crate_attrs, everything_else) = partition_source(s);
328 let mut prog = String::new();
330 // First push any outer attributes from the example, assuming they
331 // are intended to be crate attributes.
332 prog.push_str(&crate_attrs);
334 // Next, any attributes for other aspects such as lints.
335 for attr in &opts.attrs {
336 prog.push_str(&format!("#![{}]\n", attr));
339 // Don't inject `extern crate std` because it's already injected by the
341 if !s.contains("extern crate") && !opts.no_crate_inject && cratename != Some("std") {
342 if let Some(cratename) = cratename {
343 if s.contains(cratename) {
344 prog.push_str(&format!("extern crate {};\n", cratename));
348 if dont_insert_main || s.contains("fn main") {
349 prog.push_str(&everything_else);
351 prog.push_str("fn main() {\n");
352 prog.push_str(&everything_else);
353 prog = prog.trim().into();
354 prog.push_str("\n}");
357 info!("final test program: {}", prog);
362 // FIXME(aburka): use a real parser to deal with multiline attributes
363 fn partition_source(s: &str) -> (String, String) {
364 use std_unicode::str::UnicodeStr;
366 let mut after_header = false;
367 let mut before = String::new();
368 let mut after = String::new();
370 for line in s.lines() {
371 let trimline = line.trim();
372 let header = trimline.is_whitespace() ||
373 trimline.starts_with("#![");
374 if !header || after_header {
376 after.push_str(line);
377 after.push_str("\n");
379 before.push_str(line);
380 before.push_str("\n");
387 pub struct Collector {
388 pub tests: Vec<testing::TestDescAndFn>,
389 // to be removed when hoedown will be definitely gone
390 pub old_tests: HashMap<String, Vec<String>>,
397 current_header: Option<String>,
400 maybe_sysroot: Option<PathBuf>,
402 codemap: Option<Rc<CodeMap>>,
403 filename: Option<String>,
404 // to be removed when hoedown will be removed as well
405 pub render_type: RenderType,
409 pub fn new(cratename: String, cfgs: Vec<String>, libs: SearchPaths, externs: Externs,
410 use_headers: bool, opts: TestOptions, maybe_sysroot: Option<PathBuf>,
411 codemap: Option<Rc<CodeMap>>, filename: Option<String>,
412 render_type: RenderType) -> Collector {
415 old_tests: HashMap::new(),
421 use_headers: use_headers,
422 current_header: None,
423 cratename: cratename,
425 maybe_sysroot: maybe_sysroot,
429 render_type: render_type,
433 fn generate_name(&self, line: usize, filename: &str) -> String {
434 if self.use_headers {
435 if let Some(ref header) = self.current_header {
436 format!("{} - {} (line {})", filename, header, line)
438 format!("{} - (line {})", filename, line)
441 format!("{} - {} (line {})", filename, self.names.join("::"), line)
445 // to be removed once hoedown is gone
446 fn generate_name_beginning(&self, filename: &str) -> String {
447 if self.use_headers {
448 if let Some(ref header) = self.current_header {
449 format!("{} - {} (line", filename, header)
451 format!("{} - (line", filename)
454 format!("{} - {} (line", filename, self.names.join("::"))
458 pub fn add_old_test(&mut self, test: String, filename: String) {
459 let name_beg = self.generate_name_beginning(&filename);
460 let entry = self.old_tests.entry(name_beg)
461 .or_insert(Vec::new());
462 entry.push(test.trim().to_owned());
465 pub fn add_test(&mut self, test: String,
466 should_panic: bool, no_run: bool, should_ignore: bool,
467 as_test_harness: bool, compile_fail: bool, error_codes: Vec<String>,
468 line: usize, filename: String) {
469 let name = self.generate_name(line, &filename);
470 // to be removed when hoedown is removed
471 if self.render_type == RenderType::Pulldown {
472 let name_beg = self.generate_name_beginning(&filename);
473 let mut found = false;
474 let test = test.trim().to_owned();
475 if let Some(entry) = self.old_tests.get_mut(&name_beg) {
476 found = entry.remove_item(&test).is_some();
479 let _ = writeln!(&mut io::stderr(),
480 "WARNING: {} Code block is not currently run as a test, but will \
481 in future versions of rustdoc. Please ensure this code block is \
482 a runnable test, or use the `ignore` directive.",
487 let cfgs = self.cfgs.clone();
488 let libs = self.libs.clone();
489 let externs = self.externs.clone();
490 let cratename = self.cratename.to_string();
491 let opts = self.opts.clone();
492 let maybe_sysroot = self.maybe_sysroot.clone();
493 debug!("Creating test {}: {}", name, test);
494 self.tests.push(testing::TestDescAndFn {
495 desc: testing::TestDesc {
496 name: testing::DynTestName(name),
497 ignore: should_ignore,
498 // compiler failures are test failures
499 should_panic: testing::ShouldPanic::No,
501 testfn: testing::DynTestFn(box move |()| {
502 let panic = io::set_panic(None);
503 let print = io::set_print(None);
505 rustc_driver::in_rustc_thread(move || {
506 io::set_panic(panic);
507 io::set_print(print);
523 Err(err) => panic::resume_unwind(err),
529 pub fn get_line(&self) -> usize {
530 if let Some(ref codemap) = self.codemap {
531 let line = self.position.lo.to_usize();
532 let line = codemap.lookup_char_pos(BytePos(line as u32)).line;
533 if line > 0 { line - 1 } else { line }
539 pub fn set_position(&mut self, position: Span) {
540 self.position = position;
543 pub fn get_filename(&self) -> String {
544 if let Some(ref codemap) = self.codemap {
545 let filename = codemap.span_to_filename(self.position);
546 if let Ok(cur_dir) = env::current_dir() {
547 if let Ok(path) = Path::new(&filename).strip_prefix(&cur_dir) {
548 if let Some(path) = path.to_str() {
549 return path.to_owned();
554 } else if let Some(ref filename) = self.filename {
561 pub fn register_header(&mut self, name: &str, level: u32) {
562 if self.use_headers && level == 1 {
563 // we use these headings as test names, so it's good if
564 // they're valid identifiers.
565 let name = name.chars().enumerate().map(|(i, c)| {
566 if (i == 0 && c.is_xid_start()) ||
567 (i != 0 && c.is_xid_continue()) {
572 }).collect::<String>();
574 // new header => reset count.
576 self.current_header = Some(name);
581 struct HirCollector<'a, 'hir: 'a> {
582 collector: &'a mut Collector,
583 map: &'a hir::map::Map<'hir>
586 impl<'a, 'hir> HirCollector<'a, 'hir> {
587 fn visit_testable<F: FnOnce(&mut Self)>(&mut self,
589 attrs: &[ast::Attribute],
591 let has_name = !name.is_empty();
593 self.collector.names.push(name);
596 let mut attrs = Attributes::from_ast(attrs);
597 attrs.collapse_doc_comments();
598 attrs.unindent_doc_comments();
599 if let Some(doc) = attrs.doc_value() {
600 self.collector.cnt = 0;
601 if self.collector.render_type == RenderType::Pulldown {
602 markdown::old_find_testable_code(doc, self.collector,
603 attrs.span.unwrap_or(DUMMY_SP));
604 markdown::find_testable_code(doc, self.collector,
605 attrs.span.unwrap_or(DUMMY_SP));
607 markdown::old_find_testable_code(doc, self.collector,
608 attrs.span.unwrap_or(DUMMY_SP));
615 self.collector.names.pop();
620 impl<'a, 'hir> intravisit::Visitor<'hir> for HirCollector<'a, 'hir> {
621 fn nested_visit_map<'this>(&'this mut self) -> intravisit::NestedVisitorMap<'this, 'hir> {
622 intravisit::NestedVisitorMap::All(&self.map)
625 fn visit_item(&mut self, item: &'hir hir::Item) {
626 let name = if let hir::ItemImpl(.., ref ty, _) = item.node {
627 self.map.node_to_pretty_string(ty.id)
629 item.name.to_string()
632 self.visit_testable(name, &item.attrs, |this| {
633 intravisit::walk_item(this, item);
637 fn visit_trait_item(&mut self, item: &'hir hir::TraitItem) {
638 self.visit_testable(item.name.to_string(), &item.attrs, |this| {
639 intravisit::walk_trait_item(this, item);
643 fn visit_impl_item(&mut self, item: &'hir hir::ImplItem) {
644 self.visit_testable(item.name.to_string(), &item.attrs, |this| {
645 intravisit::walk_impl_item(this, item);
649 fn visit_foreign_item(&mut self, item: &'hir hir::ForeignItem) {
650 self.visit_testable(item.name.to_string(), &item.attrs, |this| {
651 intravisit::walk_foreign_item(this, item);
655 fn visit_variant(&mut self,
656 v: &'hir hir::Variant,
657 g: &'hir hir::Generics,
658 item_id: ast::NodeId) {
659 self.visit_testable(v.node.name.to_string(), &v.node.attrs, |this| {
660 intravisit::walk_variant(this, v, g, item_id);
664 fn visit_struct_field(&mut self, f: &'hir hir::StructField) {
665 self.visit_testable(f.name.to_string(), &f.attrs, |this| {
666 intravisit::walk_struct_field(this, f);
670 fn visit_macro_def(&mut self, macro_def: &'hir hir::MacroDef) {
671 self.visit_testable(macro_def.name.to_string(), ¯o_def.attrs, |_| ());