Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FIX: Call rustdoc test with the correct cfg flags of a package. #3242

Merged
merged 4 commits into from
Nov 2, 2016
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/cargo/ops/cargo_rustc/compilation.rs
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ pub struct Compilation<'cfg> {

pub to_doc_test: Vec<Package>,

/// Features enabled during this compilation.
pub cfgs: HashSet<String>,
/// Features per package enabled during this compilation.
pub cfgs: HashMap<PackageId, HashSet<String>>,

pub target: String,

Expand All @@ -63,7 +63,7 @@ impl<'cfg> Compilation<'cfg> {
binaries: Vec::new(),
extra_env: HashMap::new(),
to_doc_test: Vec::new(),
cfgs: HashSet::new(),
cfgs: HashMap::new(),
config: config,
target: String::new(),
}
Expand Down
21 changes: 10 additions & 11 deletions src/cargo/ops/cargo_rustc/mod.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
use std::collections::HashMap;
use std::collections::{HashMap, HashSet};
use std::env;
use std::ffi::{OsStr, OsString};
use std::fs;
Expand Down Expand Up @@ -81,7 +81,6 @@ pub fn compile_targets<'a, 'cfg: 'a>(ws: &Workspace<'cfg>,
})
}).collect::<Vec<_>>();

let root = try!(ws.current());
let mut cx = try!(Context::new(ws, resolve, packages, config,
build_config, profiles));

Expand Down Expand Up @@ -142,19 +141,19 @@ pub fn compile_targets<'a, 'cfg: 'a>(ws: &Workspace<'cfg>,
cx.compilation.libraries.insert(pkgid.clone(), v);
}
}
}

let root_pkg = root.package_id();
if let Some(feats) = cx.resolve.features(root_pkg) {
cx.compilation.cfgs.extend(feats.iter().map(|feat| {
format!("feature=\"{}\"", feat)
}));
if let Some(feats) = cx.resolve.features(&unit.pkg.package_id()) {
cx.compilation.cfgs.entry(unit.pkg.package_id().clone())
.or_insert(HashSet::new())
.extend(feats.iter().map(|feat| format!("feature=\"{}\"", feat)));
}
}

for (&(ref pkg, _), output) in cx.build_state.outputs.lock().unwrap().iter() {
if pkg == root_pkg {
cx.compilation.cfgs.extend(output.cfgs.iter().cloned());
}
cx.compilation.cfgs.entry(pkg.clone())
.or_insert(HashSet::new())
.extend(output.cfgs.iter().cloned());

for dir in output.library_paths.iter() {
cx.compilation.native_dirs.insert(dir.clone());
}
Expand Down
6 changes: 4 additions & 2 deletions src/cargo/ops/cargo_test.rs
Original file line number Diff line number Diff line change
Expand Up @@ -145,8 +145,10 @@ fn run_doc_tests(options: &TestOptions,
p.arg("--test-args").arg(&test_args.join(" "));
}

for cfg in compilation.cfgs.iter() {
p.arg("--cfg").arg(cfg);
if let Some(cfgs) = compilation.cfgs.get(&package.package_id()) {
for cfg in cfgs.iter() {
p.arg("--cfg").arg(cfg);
}
}

for (_, libs) in compilation.libraries.iter() {
Expand Down
70 changes: 70 additions & 0 deletions tests/test.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2262,3 +2262,73 @@ fn panic_abort_multiple() {
.arg("-p").arg("a"),
execs().with_status(0));
}

#[test]
fn pass_correct_cfgs_flags_to_rustdoc() {
let p = project("foo")
.file("Cargo.toml", r#"
[package]
name = "foo"
version = "0.1.0"
authors = []

[features]
default = ["a/default"]
nightly = ["a/nightly"]

[dependencies.a]
path = "libs/a"
default-features = false
"#)
.file("src/lib.rs", r#"
#[cfg(test)]
mod tests {
#[test]
fn it_works() {
assert!(true);
}
}
"#)
.file("libs/a/Cargo.toml", r#"
[package]
name = "a"
version = "0.1.0"
authors = []

[features]
default = ["serde_codegen"]
nightly = ["serde_derive"]

[dependencies]
serde_derive = { version = "0.8", optional = true }

[build-dependencies]
serde_codegen = { version = "0.8", optional = true }
"#)
.file("libs/a/src/lib.rs", r#"
#[cfg(feature = "serde_derive")]
const MSG: &'static str = "This is safe";

#[cfg(feature = "serde_codegen")]
const MSG: &'static str = "This is risky";

pub fn get() -> &'static str {
MSG
}
"#);

assert_that(p.cargo_process("test")
.arg("--package").arg("a")
.arg("--verbose"),
execs().with_status(0)
.with_stderr_contains("\
[DOCTEST] a
[RUNNING] `rustdoc --test [..]--cfg feature=\\\"serde_codegen\\\"[..]`"));
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah yeah the escaping here is subtly different on Windows (different shell), so it's fine to just match the word serde_codegen being passed here

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@alexcrichton sounds good. I'll change it.


assert_that(p.cargo_process("test")
.arg("--verbose"),
execs().with_status(0)
.with_stderr_contains("\
[DOCTEST] foo
[RUNNING] `rustdoc --test [..]--cfg feature=\\\"a\\\"[..]`"));
}