Skip to content

Commit 6cc4780

Browse files
borsbors
committed
Auto merge of #5360 - euclio:metadata, r=alexcrichton
include package metadata in `cargo metadata` Fixes #4819. All-in-all a pretty small change. I'm a little concerned about threading the `toml::Value` all the way through however, should I make another type? Also, cloning the metadata value initially is maybe not ideal, since it's technically accessible through the original manifest. I figured this way was cleaner.
2 parents 43872ac + 2efeeda commit 6cc4780

File tree

5 files changed

+102
-16
lines changed

5 files changed

+102
-16
lines changed

‎src/cargo/core/manifest.rs

+8
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ use std::hash::{Hash, Hasher};
66

77
use semver::Version;
88
use serde::ser;
9+
use toml;
910
use url::Url;
1011

1112
use core::{Dependency, PackageId, PackageIdSpec, SourceId, Summary};
@@ -30,6 +31,7 @@ pub struct Manifest {
3031
exclude: Vec<String>,
3132
include: Vec<String>,
3233
metadata: ManifestMetadata,
34+
custom_metadata: Option<toml::Value>,
3335
profiles: Profiles,
3436
publish: Option<Vec<String>>,
3537
publish_lockfile: bool,
@@ -265,6 +267,7 @@ impl Manifest {
265267
include: Vec<String>,
266268
links: Option<String>,
267269
metadata: ManifestMetadata,
270+
custom_metadata: Option<toml::Value>,
268271
profiles: Profiles,
269272
publish: Option<Vec<String>>,
270273
publish_lockfile: bool,
@@ -284,6 +287,7 @@ impl Manifest {
284287
include,
285288
links,
286289
metadata,
290+
custom_metadata,
287291
profiles,
288292
publish,
289293
replace,
@@ -409,6 +413,10 @@ impl Manifest {
409413
pub fn edition(&self) -> Edition {
410414
self.edition
411415
}
416+
417+
pub fn custom_metadata(&self) -> Option<&toml::Value> {
418+
self.custom_metadata.as_ref()
419+
}
412420
}
413421

414422
impl VirtualManifest {

‎src/cargo/core/package.rs

+2
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ struct SerializedPackage<'a> {
4141
targets: &'a [Target],
4242
features: &'a FeatureMap,
4343
manifest_path: &'a str,
44+
metadata: Option<&'a toml::Value>,
4445
}
4546

4647
impl ser::Serialize for Package {
@@ -67,6 +68,7 @@ impl ser::Serialize for Package {
6768
targets: self.manifest.targets(),
6869
features: summary.features(),
6970
manifest_path: &self.manifest_path.display().to_string(),
71+
metadata: self.manifest.custom_metadata(),
7072
}.serialize(s)
7173
}
7274
}

‎src/cargo/util/toml/mod.rs

+2
Original file line numberDiff line numberDiff line change
@@ -810,13 +810,15 @@ impl TomlManifest {
810810
} else {
811811
Edition::Edition2015
812812
};
813+
let custom_metadata = project.metadata.clone();
813814
let mut manifest = Manifest::new(
814815
summary,
815816
targets,
816817
exclude,
817818
include,
818819
project.links.clone(),
819820
metadata,
821+
custom_metadata,
820822
profiles,
821823
publish,
822824
publish_lockfile,

‎tests/testsuite/metadata.rs

+88-15
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
use hamcrest::assert_that;
21
use cargotest::support::registry::Package;
32
use cargotest::support::{basic_bin_manifest, basic_lib_manifest, execs, main_file, project};
3+
use hamcrest::assert_that;
44

55
#[test]
66
fn cargo_metadata_simple() {
@@ -37,7 +37,8 @@ fn cargo_metadata_simple() {
3737
}
3838
],
3939
"features": {},
40-
"manifest_path": "[..]Cargo.toml"
40+
"manifest_path": "[..]Cargo.toml",
41+
"metadata": null
4142
}
4243
],
4344
"workspace_members": ["foo 0.5.0 (path+file:[..]foo)"],
@@ -122,7 +123,8 @@ crate-type = ["lib", "staticlib"]
122123
}
123124
],
124125
"features": {},
125-
"manifest_path": "[..]Cargo.toml"
126+
"manifest_path": "[..]Cargo.toml",
127+
"metadata": null
126128
}
127129
],
128130
"workspace_members": ["foo 0.5.0 (path+file:[..]foo)"],
@@ -197,7 +199,8 @@ optional_feat = []
197199
"default_feat": [],
198200
"optional_feat": []
199201
},
200-
"manifest_path": "[..]Cargo.toml"
202+
"manifest_path": "[..]Cargo.toml",
203+
"metadata": null
201204
}
202205
],
203206
"workspace_members": ["foo 0.5.0 (path+file:[..]foo)"],
@@ -278,7 +281,8 @@ fn cargo_metadata_with_deps_and_version() {
278281
"src_path": "[..]lib.rs"
279282
}
280283
],
281-
"version": "0.0.1"
284+
"version": "0.0.1",
285+
"metadata": null
282286
},
283287
{
284288
"dependencies": [
@@ -314,7 +318,8 @@ fn cargo_metadata_with_deps_and_version() {
314318
"src_path": "[..]lib.rs"
315319
}
316320
],
317-
"version": "0.0.1"
321+
"version": "0.0.1",
322+
"metadata": null
318323
},
319324
{
320325
"dependencies": [
@@ -350,7 +355,8 @@ fn cargo_metadata_with_deps_and_version() {
350355
"src_path": "[..]foo.rs"
351356
}
352357
],
353-
"version": "0.5.0"
358+
"version": "0.5.0",
359+
"metadata": null
354360
}
355361
],
356362
"workspace_members": ["foo 0.5.0 (path+file:[..]foo)"],
@@ -434,7 +440,8 @@ name = "ex"
434440
}
435441
],
436442
"features": {},
437-
"manifest_path": "[..]Cargo.toml"
443+
"manifest_path": "[..]Cargo.toml",
444+
"metadata": null
438445
}
439446
],
440447
"workspace_members": [
@@ -507,7 +514,8 @@ crate-type = ["rlib", "dylib"]
507514
}
508515
],
509516
"features": {},
510-
"manifest_path": "[..]Cargo.toml"
517+
"manifest_path": "[..]Cargo.toml",
518+
"metadata": null
511519
}
512520
],
513521
"workspace_members": [
@@ -571,7 +579,8 @@ fn workspace_metadata() {
571579
}
572580
],
573581
"features": {},
574-
"manifest_path": "[..]bar[/]Cargo.toml"
582+
"manifest_path": "[..]bar[/]Cargo.toml",
583+
"metadata": null
575584
},
576585
{
577586
"name": "baz",
@@ -591,7 +600,8 @@ fn workspace_metadata() {
591600
}
592601
],
593602
"features": {},
594-
"manifest_path": "[..]baz[/]Cargo.toml"
603+
"manifest_path": "[..]baz[/]Cargo.toml",
604+
"metadata": null
595605
}
596606
],
597607
"workspace_members": ["baz 0.5.0 (path+file:[..]baz)", "bar 0.5.0 (path+file:[..]bar)"],
@@ -658,7 +668,8 @@ fn workspace_metadata_no_deps() {
658668
}
659669
],
660670
"features": {},
661-
"manifest_path": "[..]bar[/]Cargo.toml"
671+
"manifest_path": "[..]bar[/]Cargo.toml",
672+
"metadata": null
662673
},
663674
{
664675
"name": "baz",
@@ -678,7 +689,8 @@ fn workspace_metadata_no_deps() {
678689
}
679690
],
680691
"features": {},
681-
"manifest_path": "[..]baz[/]Cargo.toml"
692+
"manifest_path": "[..]baz[/]Cargo.toml",
693+
"metadata": null
682694
}
683695
],
684696
"workspace_members": ["baz 0.5.0 (path+file:[..]baz)", "bar 0.5.0 (path+file:[..]bar)"],
@@ -707,7 +719,7 @@ Caused by:
707719
)
708720
}
709721

710-
const MANIFEST_OUTPUT: &'static str = r#"
722+
const MANIFEST_OUTPUT: &str = r#"
711723
{
712724
"packages": [{
713725
"name":"foo",
@@ -725,7 +737,8 @@ const MANIFEST_OUTPUT: &'static str = r#"
725737
"src_path":"[..][/]foo[/]src[/]foo.rs"
726738
}],
727739
"features":{},
728-
"manifest_path":"[..]Cargo.toml"
740+
"manifest_path":"[..]Cargo.toml",
741+
"metadata": null
729742
}],
730743
"workspace_members": [ "foo 0.5.0 (path+file:[..]foo)" ],
731744
"resolve": null,
@@ -867,3 +880,63 @@ fn multiple_features() {
867880
execs().with_status(0),
868881
);
869882
}
883+
884+
#[test]
885+
fn package_metadata() {
886+
let p = project("foo")
887+
.file(
888+
"Cargo.toml",
889+
r#"
890+
[package]
891+
name = "foo"
892+
version = "0.1.0"
893+
authors = []
894+
895+
[package.metadata.bar]
896+
baz = "quux"
897+
"#,
898+
)
899+
.file("src/lib.rs", "")
900+
.build();
901+
902+
assert_that(
903+
p.cargo("metadata").arg("--no-deps"),
904+
execs().with_json(
905+
r#"
906+
{
907+
"packages": [
908+
{
909+
"name": "foo",
910+
"version": "0.1.0",
911+
"id": "foo[..]",
912+
"source": null,
913+
"dependencies": [],
914+
"license": null,
915+
"license_file": null,
916+
"description": null,
917+
"targets": [
918+
{
919+
"kind": [ "lib" ],
920+
"crate_types": [ "lib" ],
921+
"name": "foo",
922+
"src_path": "[..]foo[/]src[/]lib.rs"
923+
}
924+
],
925+
"features": {},
926+
"manifest_path": "[..]foo[/]Cargo.toml",
927+
"metadata": {
928+
"bar": {
929+
"baz": "quux"
930+
}
931+
}
932+
}
933+
],
934+
"workspace_members": ["foo[..]"],
935+
"resolve": null,
936+
"target_directory": "[..]foo[/]target",
937+
"version": 1,
938+
"workspace_root": "[..][/]foo"
939+
}"#,
940+
),
941+
);
942+
}

‎tests/testsuite/read_manifest.rs

+2-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ static MANIFEST_OUTPUT: &'static str = r#"
1818
"src_path":"[..][/]foo[/]src[/]foo.rs"
1919
}],
2020
"features":{},
21-
"manifest_path":"[..]Cargo.toml"
21+
"manifest_path":"[..]Cargo.toml",
22+
"metadata": null
2223
}"#;
2324

2425
#[test]

0 commit comments

Comments
 (0)