[guppy] add Workspace::target_directory and Workspace::metadata_table

guppy/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [0.14.1] - 2022-03-18
+
+### Added
+
+- `Workspace::target_directory` returns the target directory provided in the Cargo metadata.
+- `Workspace::metadata_table` returns the freeform `workspace.metadata` table.
+
 ## [0.14.0] - 2022-03-14
 
 ### Added
@@ -493,6 +500,7 @@ lazy_static = "0.2"
 ### Added
 - Initial release.
 
+[0.14.1]: https://github.com/facebookincubator/cargo-guppy/releases/tag/guppy-0.14.1
 [0.14.0]: https://github.com/facebookincubator/cargo-guppy/releases/tag/guppy-0.14.0
 [0.13.0]: https://github.com/facebookincubator/cargo-guppy/releases/tag/guppy-0.13.0
 [0.12.6]: https://github.com/facebookincubator/cargo-guppy/releases/tag/guppy-0.12.6

guppy/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "guppy"
-version = "0.14.0"
+version = "0.14.1"
 description = "Track and query Cargo dependency graphs."
 documentation = "https://docs.rs/guppy"
 repository = "https://github.com/facebookincubator/cargo-guppy"

guppy/src/graph/build.rs

@@ -54,7 +54,13 @@ impl PackageGraph {
 
         let dep_graph = build_state.finish();
 
-        let workspace = WorkspaceImpl::new(workspace_root, &packages, workspace_members)?;
+        let workspace = WorkspaceImpl::new(
+            workspace_root,
+            metadata.target_directory,
+            metadata.workspace_metadata,
+            &packages,
+            workspace_members,
+        )?;
 
         Ok(Self {
             dep_graph,
@@ -72,6 +78,8 @@ impl WorkspaceImpl {
     /// Indexes and creates a new workspace.
     fn new(
         workspace_root: impl Into<Utf8PathBuf>,
+        target_directory: impl Into<Utf8PathBuf>,
+        metadata_table: serde_json::Value,
         packages: &HashMap<PackageId, PackageMetadataImpl>,
         members: impl IntoIterator<Item = PackageId>,
     ) -> Result<Self, Error> {
@@ -116,6 +124,8 @@ impl WorkspaceImpl {
 
         Ok(Self {
             root: workspace_root,
+            target_directory: target_directory.into(),
+            metadata_table,
             members_by_path,
             members_by_name,
             #[cfg(feature = "proptest1")]

guppy/src/graph/graph_impl.rs

@@ -494,6 +494,11 @@ impl<'g> Workspace<'g> {
         &self.inner.root
     }
 
+    /// Returns the target directory in which output artifacts are stored.
+    pub fn target_directory(&self) -> &'g Utf8Path {
+        &self.inner.target_directory
+    }
+
     /// Returns the number of packages in this workspace.
     pub fn member_count(&self) -> usize {
         self.inner.members_by_path.len()
@@ -604,6 +609,14 @@ impl<'g> Workspace<'g> {
             .map(|name| self.member_by_name(name.as_ref()))
             .collect()
     }
+
+    /// Returns the freeform metadata table for this workspace.
+    ///
+    /// This is the same as the `workspace.metadata` section of `Cargo.toml`. This section is
+    /// typically used by tools which would like to store workspace configuration in `Cargo.toml`.
+    pub fn metadata_table(&self) -> &'g JsonValue {
+        &self.inner.metadata_table
+    }
 }
 
 #[cfg(feature = "rayon1")]
@@ -660,6 +673,8 @@ mod workspace_rayon {
 #[derive(Clone, Debug)]
 pub(super) struct WorkspaceImpl {
     pub(super) root: Utf8PathBuf,
+    pub(super) target_directory: Utf8PathBuf,
+    pub(super) metadata_table: JsonValue,
     // This is a BTreeMap to allow presenting data in sorted order.
     pub(super) members_by_path: BTreeMap<Utf8PathBuf, PackageId>,
     pub(super) members_by_name: BTreeMap<Box<str>, PackageId>,

guppy/tests/graph-tests/graph_tests.rs

@@ -25,6 +25,13 @@ mod small {
         metadata1.verify();
 
         let graph = metadata1.graph();
+
+        assert_eq!(
+            graph.workspace().target_directory(),
+            "/fakepath/testcrate/target",
+            "target directory matches"
+        );
+
         let testcrate = graph
             .metadata(&package_id(json::METADATA1_TESTCRATE))
             .expect("root crate should exist");