Skip to content

Commit

Permalink
Only doctest rlibs
Browse files Browse the repository at this point in the history
This commit fixes two problems in Cargo:

1. Only libraries targets that produce an rlib can be doc tested
2. Only the rlib output can be doc tested

The rationale for this is listed in listed in the comments of the commit.

Closes #1496
  • Loading branch information
alexcrichton committed Apr 10, 2015
1 parent 471c519 commit 0b8d510
Show file tree
Hide file tree
Showing 3 changed files with 81 additions and 8 deletions.
10 changes: 9 additions & 1 deletion src/cargo/core/manifest.rs
Original file line number Diff line number Diff line change
Expand Up @@ -329,10 +329,18 @@ impl Target {
pub fn tested(&self) -> bool { self.tested }
pub fn harness(&self) -> bool { self.harness }
pub fn documented(&self) -> bool { self.doc }
pub fn doctested(&self) -> bool { self.doctest }
pub fn for_host(&self) -> bool { self.for_host }
pub fn benched(&self) -> bool { self.benched }

pub fn doctested(&self) -> bool {
self.doctest && match self.kind {
TargetKind::Lib(ref kinds) => {
kinds.contains(&LibKind::Rlib) || kinds.contains(&LibKind::Lib)
}
_ => false,
}
}

pub fn allows_underscores(&self) -> bool {
self.is_bin() || self.is_example() || self.is_custom_build()
}
Expand Down
15 changes: 14 additions & 1 deletion src/cargo/ops/cargo_test.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
use std::ffi::OsString;
use std::ffi::{OsString, OsStr};
use std::path::Path;

use core::Source;
Expand Down Expand Up @@ -55,6 +55,19 @@ pub fn run_tests(manifest_path: &Path,

for (_, libs) in compile.libraries.iter() {
for &(ref name, ref lib) in libs.iter() {
// Note that we can *only* doctest rlib outputs here. A
// staticlib output cannot be linked by the compiler (it just
// doesn't do that). A dylib output, however, can be linked by
// the compiler, but will always fail. Currently all dylibs are
// built as "static dylibs" where the standard library is
// statically linked into the dylib. The doc tests fail,
// however, for now as they try to link the standard library
// dynamically as well, causing problems. As a result we only
// pass `--extern` for rlib deps and skip out on all other
// artifacts.
if lib.extension() != Some(OsStr::new("rlib")) {
continue
}
let mut arg = OsString::from(name);
arg.push("=");
arg.push(lib);
Expand Down
64 changes: 58 additions & 6 deletions tests/test_cargo_test.rs
Original file line number Diff line number Diff line change
Expand Up @@ -705,12 +705,6 @@ test foo ... ok
test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured
{doctest} foo
running 0 tests
test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured
",
compiling = COMPILING, running = RUNNING,
doctest = DOCTEST,
Expand Down Expand Up @@ -1473,3 +1467,61 @@ test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured
", compiling = COMPILING, running = RUNNING)));
});

test!(dylib_doctest {
let p = project("foo")
.file("Cargo.toml", r#"
[package]
name = "foo"
version = "0.0.1"
authors = []
[lib]
name = "foo"
crate-type = ["rlib", "dylib"]
test = false
"#)
.file("src/lib.rs", r#"
/// ```
/// foo::foo();
/// ```
pub fn foo() {}
"#);

assert_that(p.cargo_process("test"),
execs().with_stdout(format!("\
{compiling} foo v0.0.1 ([..])
{doctest} foo
running 1 test
test foo_0 ... ok
test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured
", compiling = COMPILING, doctest = DOCTEST)));
});

test!(dylib_doctest2 {
// can't doctest dylibs as they're statically linked together
let p = project("foo")
.file("Cargo.toml", r#"
[package]
name = "foo"
version = "0.0.1"
authors = []
[lib]
name = "foo"
crate-type = ["dylib"]
test = false
"#)
.file("src/lib.rs", r#"
/// ```
/// foo::foo();
/// ```
pub fn foo() {}
"#);

assert_that(p.cargo_process("test"),
execs().with_stdout(""));
});

0 comments on commit 0b8d510

Please sign in to comment.