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 package metadata in cargo metadata #5360

Merged
merged 1 commit into from
Apr 16, 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
8 changes: 8 additions & 0 deletions src/cargo/core/manifest.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ use std::hash::{Hash, Hasher};

use semver::Version;
use serde::ser;
use toml;
use url::Url;

use core::{Dependency, PackageId, PackageIdSpec, SourceId, Summary};
Expand All @@ -30,6 +31,7 @@ pub struct Manifest {
exclude: Vec<String>,
include: Vec<String>,
metadata: ManifestMetadata,
custom_metadata: Option<toml::Value>,
profiles: Profiles,
publish: Option<Vec<String>>,
publish_lockfile: bool,
Expand Down Expand Up @@ -265,6 +267,7 @@ impl Manifest {
include: Vec<String>,
links: Option<String>,
metadata: ManifestMetadata,
custom_metadata: Option<toml::Value>,
profiles: Profiles,
publish: Option<Vec<String>>,
publish_lockfile: bool,
Expand All @@ -284,6 +287,7 @@ impl Manifest {
include,
links,
metadata,
custom_metadata,
profiles,
publish,
replace,
Expand Down Expand Up @@ -409,6 +413,10 @@ impl Manifest {
pub fn edition(&self) -> Edition {
self.edition
}

pub fn custom_metadata(&self) -> Option<&toml::Value> {
self.custom_metadata.as_ref()
}
}

impl VirtualManifest {
Expand Down
2 changes: 2 additions & 0 deletions src/cargo/core/package.rs
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ struct SerializedPackage<'a> {
targets: &'a [Target],
features: &'a FeatureMap,
manifest_path: &'a str,
metadata: Option<&'a toml::Value>,
}

impl ser::Serialize for Package {
Expand All @@ -67,6 +68,7 @@ impl ser::Serialize for Package {
targets: self.manifest.targets(),
features: summary.features(),
manifest_path: &self.manifest_path.display().to_string(),
metadata: self.manifest.custom_metadata(),
}.serialize(s)
}
}
Expand Down
2 changes: 2 additions & 0 deletions src/cargo/util/toml/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -810,13 +810,15 @@ impl TomlManifest {
} else {
Edition::Edition2015
};
let custom_metadata = project.metadata.clone();
let mut manifest = Manifest::new(
summary,
targets,
exclude,
include,
project.links.clone(),
metadata,
custom_metadata,
profiles,
publish,
publish_lockfile,
Expand Down
103 changes: 88 additions & 15 deletions tests/testsuite/metadata.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
use hamcrest::assert_that;
use cargotest::support::registry::Package;
use cargotest::support::{basic_bin_manifest, basic_lib_manifest, execs, main_file, project};
use hamcrest::assert_that;

#[test]
fn cargo_metadata_simple() {
Expand Down Expand Up @@ -37,7 +37,8 @@ fn cargo_metadata_simple() {
}
],
"features": {},
"manifest_path": "[..]Cargo.toml"
"manifest_path": "[..]Cargo.toml",
"metadata": null
}
],
"workspace_members": ["foo 0.5.0 (path+file:[..]foo)"],
Expand Down Expand Up @@ -122,7 +123,8 @@ crate-type = ["lib", "staticlib"]
}
],
"features": {},
"manifest_path": "[..]Cargo.toml"
"manifest_path": "[..]Cargo.toml",
"metadata": null
}
],
"workspace_members": ["foo 0.5.0 (path+file:[..]foo)"],
Expand Down Expand Up @@ -197,7 +199,8 @@ optional_feat = []
"default_feat": [],
"optional_feat": []
},
"manifest_path": "[..]Cargo.toml"
"manifest_path": "[..]Cargo.toml",
"metadata": null
}
],
"workspace_members": ["foo 0.5.0 (path+file:[..]foo)"],
Expand Down Expand Up @@ -278,7 +281,8 @@ fn cargo_metadata_with_deps_and_version() {
"src_path": "[..]lib.rs"
}
],
"version": "0.0.1"
"version": "0.0.1",
"metadata": null
},
{
"dependencies": [
Expand Down Expand Up @@ -314,7 +318,8 @@ fn cargo_metadata_with_deps_and_version() {
"src_path": "[..]lib.rs"
}
],
"version": "0.0.1"
"version": "0.0.1",
"metadata": null
},
{
"dependencies": [
Expand Down Expand Up @@ -350,7 +355,8 @@ fn cargo_metadata_with_deps_and_version() {
"src_path": "[..]foo.rs"
}
],
"version": "0.5.0"
"version": "0.5.0",
"metadata": null
}
],
"workspace_members": ["foo 0.5.0 (path+file:[..]foo)"],
Expand Down Expand Up @@ -434,7 +440,8 @@ name = "ex"
}
],
"features": {},
"manifest_path": "[..]Cargo.toml"
"manifest_path": "[..]Cargo.toml",
"metadata": null
}
],
"workspace_members": [
Expand Down Expand Up @@ -507,7 +514,8 @@ crate-type = ["rlib", "dylib"]
}
],
"features": {},
"manifest_path": "[..]Cargo.toml"
"manifest_path": "[..]Cargo.toml",
"metadata": null
}
],
"workspace_members": [
Expand Down Expand Up @@ -571,7 +579,8 @@ fn workspace_metadata() {
}
],
"features": {},
"manifest_path": "[..]bar[/]Cargo.toml"
"manifest_path": "[..]bar[/]Cargo.toml",
"metadata": null
},
{
"name": "baz",
Expand All @@ -591,7 +600,8 @@ fn workspace_metadata() {
}
],
"features": {},
"manifest_path": "[..]baz[/]Cargo.toml"
"manifest_path": "[..]baz[/]Cargo.toml",
"metadata": null
}
],
"workspace_members": ["baz 0.5.0 (path+file:[..]baz)", "bar 0.5.0 (path+file:[..]bar)"],
Expand Down Expand Up @@ -658,7 +668,8 @@ fn workspace_metadata_no_deps() {
}
],
"features": {},
"manifest_path": "[..]bar[/]Cargo.toml"
"manifest_path": "[..]bar[/]Cargo.toml",
"metadata": null
},
{
"name": "baz",
Expand All @@ -678,7 +689,8 @@ fn workspace_metadata_no_deps() {
}
],
"features": {},
"manifest_path": "[..]baz[/]Cargo.toml"
"manifest_path": "[..]baz[/]Cargo.toml",
"metadata": null
}
],
"workspace_members": ["baz 0.5.0 (path+file:[..]baz)", "bar 0.5.0 (path+file:[..]bar)"],
Expand Down Expand Up @@ -707,7 +719,7 @@ Caused by:
)
}

const MANIFEST_OUTPUT: &'static str = r#"
const MANIFEST_OUTPUT: &str = r#"
{
"packages": [{
"name":"foo",
Expand All @@ -725,7 +737,8 @@ const MANIFEST_OUTPUT: &'static str = r#"
"src_path":"[..][/]foo[/]src[/]foo.rs"
}],
"features":{},
"manifest_path":"[..]Cargo.toml"
"manifest_path":"[..]Cargo.toml",
"metadata": null
}],
"workspace_members": [ "foo 0.5.0 (path+file:[..]foo)" ],
"resolve": null,
Expand Down Expand Up @@ -867,3 +880,63 @@ fn multiple_features() {
execs().with_status(0),
);
}

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

[package.metadata.bar]
baz = "quux"
"#,
)
.file("src/lib.rs", "")
.build();

assert_that(
p.cargo("metadata").arg("--no-deps"),
execs().with_json(
r#"
{
"packages": [
{
"name": "foo",
"version": "0.1.0",
"id": "foo[..]",
"source": null,
"dependencies": [],
"license": null,
"license_file": null,
"description": null,
"targets": [
{
"kind": [ "lib" ],
"crate_types": [ "lib" ],
"name": "foo",
"src_path": "[..]foo[/]src[/]lib.rs"
}
],
"features": {},
"manifest_path": "[..]foo[/]Cargo.toml",
"metadata": {
"bar": {
"baz": "quux"
}
}
}
],
"workspace_members": ["foo[..]"],
"resolve": null,
"target_directory": "[..]foo[/]target",
"version": 1,
"workspace_root": "[..][/]foo"
}"#,
),
);
}
3 changes: 2 additions & 1 deletion tests/testsuite/read_manifest.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ static MANIFEST_OUTPUT: &'static str = r#"
"src_path":"[..][/]foo[/]src[/]foo.rs"
}],
"features":{},
"manifest_path":"[..]Cargo.toml"
"manifest_path":"[..]Cargo.toml",
"metadata": null
}"#;

#[test]
Expand Down