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

Include executable in JSON output. #6363

Merged
merged 6 commits into from
Dec 3, 2018
Merged
Show file tree
Hide file tree
Changes from all 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
10 changes: 10 additions & 0 deletions src/cargo/core/compiler/context/compilation_files.rs
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,16 @@ pub struct OutputFile {
pub flavor: FileFlavor,
}

impl OutputFile {
/// Gets the hardlink if present. Otherwise returns the path.
pub fn bindst(&self) -> &PathBuf {
Copy link
Member

Choose a reason for hiding this comment

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

Perhaps a _ in the middle to separate "bin" and "dst"?

Copy link
Member Author

Choose a reason for hiding this comment

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

I'll follow-up PR.

return match self.hardlink {
Some(ref link_dst) => link_dst,
None => &self.path,
};
}
}

impl<'a, 'cfg: 'a> CompilationFiles<'a, 'cfg> {
pub(super) fn new(
roots: &[Unit<'a>],
Expand Down
22 changes: 18 additions & 4 deletions src/cargo/core/compiler/context/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -163,10 +163,7 @@ impl<'a, 'cfg> Context<'a, 'cfg> {
continue;
}

let bindst = match output.hardlink {
Some(ref link_dst) => link_dst,
None => &output.path,
};
let bindst = output.bindst();

if unit.mode == CompileMode::Test {
self.compilation.tests.push((
Expand Down Expand Up @@ -274,6 +271,23 @@ impl<'a, 'cfg> Context<'a, 'cfg> {
Ok(self.compilation)
}

/// Returns the executable for the specified unit (if any).
pub fn get_executable(&mut self, unit: &Unit<'a>) -> CargoResult<Option<PathBuf>> {
for output in self.outputs(unit)?.iter() {
if output.flavor == FileFlavor::DebugInfo {
continue;
}

let is_binary = unit.target.is_bin() || unit.target.is_bin_example();
let is_test = unit.mode.is_any_test() && !unit.mode.is_check();

if is_binary || is_test {
return Ok(Option::Some(output.bindst().clone()));
}
}
return Ok(None);
}

pub fn prepare_units(
&mut self,
export_dir: Option<PathBuf>,
Expand Down
6 changes: 4 additions & 2 deletions src/cargo/core/compiler/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -409,6 +409,7 @@ fn link_targets<'a, 'cfg>(
.map(|s| s.to_owned())
.collect();
let json_messages = bcx.build_config.json_messages();
let executable = cx.get_executable(unit)?;
let mut target = unit.target.clone();
if let TargetSourcePath::Metabuild = target.src_path() {
// Give it something to serialize.
Expand All @@ -432,11 +433,11 @@ fn link_targets<'a, 'cfg>(
let dst = match output.hardlink.as_ref() {
Some(dst) => dst,
None => {
destinations.push(src.display().to_string());
destinations.push(src.clone());
continue;
}
};
destinations.push(dst.display().to_string());
destinations.push(dst.clone());
hardlink_or_copy(src, dst)?;
if let Some(ref path) = output.export_path {
let export_dir = export_dir.as_ref().unwrap();
Expand All @@ -463,6 +464,7 @@ fn link_targets<'a, 'cfg>(
profile: art_profile,
features,
filenames: destinations,
executable,
fresh,
});
}
Expand Down
5 changes: 4 additions & 1 deletion src/cargo/util/machine_message.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
use std::path::PathBuf;

use serde::ser;
use serde_json::{self, value::RawValue};

Expand Down Expand Up @@ -33,7 +35,8 @@ pub struct Artifact<'a> {
pub target: &'a Target,
pub profile: ArtifactProfile,
pub features: Vec<String>,
pub filenames: Vec<String>,
pub filenames: Vec<PathBuf>,
pub executable: Option<PathBuf>,
dwijnand marked this conversation as resolved.
Show resolved Hide resolved
pub fresh: bool,
}

Expand Down
43 changes: 43 additions & 0 deletions tests/testsuite/bench.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1485,3 +1485,46 @@ fn bench_virtual_manifest_all_implied() {
.with_stdout_contains("test bench_bar ... bench: [..]")
.run();
}

#[test]
fn json_artifact_includes_executable_for_benchmark() {
if !is_nightly() {
return;
}

let p = project()
.file(
"benches/benchmark.rs",
r#"
#![feature(test)]
extern crate test;

use test::Bencher;

#[bench]
fn bench_foo(_: &mut Bencher) -> () { () }
"#,
)
.build();

p.cargo("bench --no-run --message-format=json")
.with_json(r#"
{
"executable": "[..]/foo/target/release/benchmark-[..][EXE]",
"features": [],
"filenames": [ "[..]/foo/target/release/benchmark-[..][EXE]" ],
"fresh": false,
"package_id": "foo 0.0.1 ([..])",
"profile": "{...}",
"reason": "compiler-artifact",
"target": {
"crate_types": [ "bin" ],
"kind": [ "bench" ],
"edition": "2015",
"name": "benchmark",
"src_path": "[..]/foo/benches/benchmark.rs"
}
}
"#)
.run();
}
7 changes: 7 additions & 0 deletions tests/testsuite/build.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3083,6 +3083,7 @@ fn compiler_json_error_format() {
"overflow_checks": true,
"test": false
},
"executable": null,
"features": [],
"filenames": "{...}",
"fresh": false
Expand Down Expand Up @@ -3110,6 +3111,7 @@ fn compiler_json_error_format() {
"overflow_checks": true,
"test": false
},
"executable": null,
"features": [],
"package_id":"bar 0.5.0 ([..])",
"target":{
Expand Down Expand Up @@ -3162,6 +3164,7 @@ fn compiler_json_error_format() {
"overflow_checks": true,
"test": false
},
"executable": "[..]/foo/target/debug/foo[EXE]",
"features": [],
"filenames": "{...}",
"fresh": false
Expand Down Expand Up @@ -3191,6 +3194,7 @@ fn compiler_json_error_format() {
"overflow_checks": true,
"test": false
},
"executable": null,
"features": [],
"filenames": "{...}",
"fresh": true
Expand All @@ -3205,6 +3209,7 @@ fn compiler_json_error_format() {
"overflow_checks": true,
"test": false
},
"executable": null,
"features": [],
"package_id":"bar 0.5.0 ([..])",
"target":{
Expand Down Expand Up @@ -3244,6 +3249,7 @@ fn compiler_json_error_format() {
"overflow_checks": true,
"test": false
},
"executable": "[..]/foo/target/debug/foo[EXE]",
"features": [],
"filenames": "{...}",
"fresh": true
Expand Down Expand Up @@ -3309,6 +3315,7 @@ fn message_format_json_forward_stderr() {
"overflow_checks": false,
"test":false
},
"executable": "{...}",
"features":[],
"filenames": "{...}",
"fresh": false
Expand Down
59 changes: 59 additions & 0 deletions tests/testsuite/test.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3004,6 +3004,7 @@ fn json_artifact_includes_test_flag() {
"overflow_checks": true,
"test": false
},
"executable": null,
"features": [],
"package_id":"foo 0.0.1 ([..])",
"target":{
Expand All @@ -3026,6 +3027,7 @@ fn json_artifact_includes_test_flag() {
"overflow_checks": true,
"test": true
},
"executable": "[..]/foo-[..]",
"features": [],
"package_id":"foo 0.0.1 ([..])",
"target":{
Expand All @@ -3042,6 +3044,63 @@ fn json_artifact_includes_test_flag() {
).run();
}

#[test]
fn json_artifact_includes_executable_for_library_tests() {
let p = project()
.file("src/main.rs", "fn main() { }")
.file("src/lib.rs", r#"#[test] fn lib_test() {}"#)
.build();

p.cargo("test --lib -v --no-run --message-format=json")
.with_json(r#"
{
"executable": "[..]/foo/target/debug/foo-[..][EXE]",
"features": [],
"filenames": "{...}",
"fresh": false,
"package_id": "foo 0.0.1 ([..])",
"profile": "{...}",
"reason": "compiler-artifact",
"target": {
"crate_types": [ "lib" ],
"kind": [ "lib" ],
"edition": "2015",
"name": "foo",
"src_path": "[..]/foo/src/lib.rs"
}
}
"#)
.run();
}

#[test]
fn json_artifact_includes_executable_for_integration_tests() {
let p = project()
.file("tests/integration_test.rs", r#"#[test] fn integration_test() {}"#)
.build();

p.cargo("test -v --no-run --message-format=json --test integration_test")
.with_json(r#"
{
"executable": "[..]/foo/target/debug/integration_test-[..][EXE]",
"features": [],
"filenames": "{...}",
"fresh": false,
"package_id": "foo 0.0.1 ([..])",
"profile": "{...}",
"reason": "compiler-artifact",
"target": {
"crate_types": [ "bin" ],
"kind": [ "test" ],
"edition": "2015",
"name": "integration_test",
"src_path": "[..]/foo/tests/integration_test.rs"
}
}
"#)
.run();
}

#[test]
fn test_build_script_links() {
let p = project()
Expand Down