[cargo-compare] add some comparison testing to CI

This works by:
* setting up a real, fairly complex fixture
* generating random queries using proptest
* running them through cargo and guppy
* ensuring that they produce the same results

Not only does this give us high confidence that cargo
and guppy produce the same results, it also gets us
most of the way to #82.

Most of the work in this commit is simply setting up
all the necessary test infrastructure. We piggy-back on
existing proptest infrastructure as much as possible.

fixtures/README.md

@@ -8,5 +8,7 @@ The fixtures are organized into several folders.
 
 * `small`: relatively simple examples that cover basic and some edge case functionality
 * `large`: complex examples pulled from real-world Rust repositories, that test a variety of edge cases
-* `invalid`: examples that are *representable* as cargo metadata (i.e. they are valid JSON and follow the general
-  schema) but are *invalid* in some way; `cargo metadata` should never be able to generate these
+* `invalid`: examples that are [*representable*](https://oleb.net/blog/2018/03/making-illegal-states-unrepresentable/)
+  as cargo metadata (i.e. they are valid JSON and follow the general schema) but are *invalid* in some way; `cargo
+  metadata` should never be able to generate these
+* `workspace`: real workspaces, used for comparison testing with Cargo

fixtures/workspace/inside-outside/external/.gitignore

@@ -0,0 +1,2 @@
+/target
+Cargo.lock

fixtures/workspace/inside-outside/external/Cargo.toml

@@ -0,0 +1,24 @@
+[package]
+name = "external"
+version = "0.1.0"
+authors = ["Fake Author <[email protected]>"]
+edition = "2018"
+
+[dependencies]
+transitive = { path = "../transitive" }
+bytes = { version = "0.5", optional = true }
+
+[dev-dependencies]
+transitive = { path = "../transitive", features = ["dev-feature"] }
+
+[build-dependencies]
+transitive = { path = "../transitive", features = ["build-feature"] }
+
+[features]
+internal-dev-feature = []
+internal-build-feature = []
+main-dev-feature = []
+main-build-feature = []
+side-feature = ["bytes"]
+
+[workspace]

fixtures/workspace/inside-outside/external/src/lib.rs

@@ -0,0 +1,7 @@
+#[cfg(test)]
+mod tests {
+    #[test]
+    fn it_works() {
+        assert_eq!(2 + 2, 4);
+    }
+}

fixtures/workspace/inside-outside/inactive/.gitignore

@@ -0,0 +1,2 @@
+/target
+Cargo.lock

fixtures/workspace/inside-outside/inactive/Cargo.toml

@@ -0,0 +1,21 @@
+[package]
+name = "inactive"
+version = "0.1.0"
+authors = ["Fake Author <[email protected]>"]
+edition = "2018"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+transitive = { path = "../transitive", features = ["inactive-normal"] }
+
+[build-dependencies]
+transitive = { path = "../transitive", features = ["inactive-build"] }
+
+[dev-dependencies]
+transitive = { path = "../transitive", features = ["inactive-dev"] }
+
+[features]
+extra = ["transitive/extra"]
+
+[workspace]

fixtures/workspace/inside-outside/inactive/src/lib.rs

@@ -0,0 +1,7 @@
+#[cfg(test)]
+mod tests {
+    #[test]
+    fn it_works() {
+        assert_eq!(2 + 2, 4);
+    }
+}

fixtures/workspace/inside-outside/transitive/.gitignore

@@ -0,0 +1,2 @@
+/target
+Cargo.lock

fixtures/workspace/inside-outside/transitive/Cargo.toml

@@ -0,0 +1,17 @@
+[package]
+name = "transitive"
+version = "0.1.0"
+authors = ["Fake Author <[email protected]>"]
+edition = "2018"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[features]
+build-feature = []
+dev-feature = []
+inactive-normal = []
+inactive-build = []
+inactive-dev = []
+extra = []
+
+[workspace]

fixtures/workspace/inside-outside/transitive/src/lib.rs

@@ -0,0 +1,7 @@
+#[cfg(test)]
+mod tests {
+    #[test]
+    fn it_works() {
+        assert_eq!(2 + 2, 4);
+    }
+}

fixtures/workspace/inside-outside/workspace/.gitignore

@@ -0,0 +1 @@
+/target

fixtures/workspace/inside-outside/workspace/Cargo.toml

@@ -0,0 +1,2 @@
+[workspace]
+members = ["main", "internal", "side"]

fixtures/workspace/inside-outside/workspace/internal/Cargo.toml

@@ -0,0 +1,23 @@
+[package]
+name = "internal"
+version = "0.1.0"
+authors = ["Fake Author <[email protected]>"]
+edition = "2018"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+lazy_static = "1"
+external = { path = "../../external" }
+
+[dev-dependencies]
+lazy_static = {version = "1", features = ["spin"] }
+bytes = "0.5"
+external = { path = "../../external", features = ["internal-dev-feature"] }
+
+[build-dependencies]
+external = { path = "../../external", features = ["internal-build-feature"] }
+
+[features]
+dev-feature = []
+build-feature = []

fixtures/workspace/inside-outside/workspace/internal/src/lib.rs

@@ -0,0 +1,7 @@
+#[cfg(test)]
+mod tests {
+    #[test]
+    fn it_works() {
+        assert_eq!(2 + 2, 4);
+    }
+}

fixtures/workspace/inside-outside/workspace/main/Cargo.toml

@@ -0,0 +1,26 @@
+[package]
+name = "main"
+version = "0.1.0"
+authors = ["Fake Author <[email protected]>"]
+edition = "2018"
+build = "build.rs"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+external = { path = "../../external" }
+internal = { path = "../internal" }
+
+[build-dependencies]
+external = { path = "../../external", features = ["main-build-feature"] }
+internal = { path = "../internal", features = ["build-feature"] }
+
+[dev-dependencies]
+external = { path = "../../external", features = ["main-dev-feature"] }
+internal = { path = "../internal", features = ["dev-feature"] }
+
+[target.'cfg(all(unix, not(unix)))'.build-dependencies]
+inactive = { path = "../../inactive" }
+
+[features]
+inactive-extra = ["inactive/extra"]

fixtures/workspace/inside-outside/workspace/main/build.rs

@@ -0,0 +1,2 @@
+fn main() {
+}

fixtures/workspace/inside-outside/workspace/main/src/lib.rs

@@ -0,0 +1,7 @@
+#[cfg(test)]
+mod tests {
+    #[test]
+    fn it_works() {
+        assert_eq!(2 + 2, 4);
+    }
+}

fixtures/workspace/inside-outside/workspace/side/Cargo.toml

@@ -0,0 +1,10 @@
+[package]
+name = "side"
+version = "0.1.0"
+authors = ["Fake Author <[email protected]>"]
+edition = "2018"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+external = { path = "../../external", features = ["side-feature"] }

fixtures/workspace/inside-outside/workspace/side/src/lib.rs

@@ -0,0 +1,7 @@
+#[cfg(test)]
+mod tests {
+    #[test]
+    fn it_works() {
+        assert_eq!(2 + 2, 4);
+    }
+}

fixtures/workspace/inside-outside/workspace/src/lib.rs

@@ -0,0 +1,7 @@
+#[cfg(test)]
+mod tests {
+    #[test]
+    fn it_works() {
+        assert_eq!(2 + 2, 4);
+    }
+}

guppy-cmdlib/Cargo.toml

@@ -11,3 +11,7 @@ edition = "2018"
 anyhow = "1.0.28"
 guppy = { path = "../guppy" }
 structopt = "0.3"
+proptest = { version = "0.9", optional = true }
+
+[features]
+proptest09 = ["proptest", "guppy/proptest09"]

guppy-cmdlib/src/lib.rs

@@ -5,6 +5,9 @@
 //!
 //! This library allows translating command-line arguments into guppy's data structures.
 
+#[cfg(feature = "proptest09")]
+pub mod proptest;
+
 use anyhow::Result;
 use guppy::graph::feature::{
     all_filter, default_filter, feature_filter, none_filter, FeatureFilter, FeatureQuery,
@@ -66,11 +69,11 @@ impl PackagesAndFeatures {
 /// Context for invoking the `cargo metadata` command.
 ///
 /// The options mirror Cargo's.
-#[derive(Debug, StructOpt)]
+#[derive(Clone, Debug, StructOpt)]
 pub struct CargoMetadataOptions {
     /// Path to Cargo.toml
     #[structopt(long = "manifest-path")]
-    manifest_path: Option<PathBuf>,
+    pub manifest_path: Option<PathBuf>,
 }
 
 impl CargoMetadataOptions {

guppy-cmdlib/src/proptest.rs

@@ -0,0 +1,33 @@
+// Copyright (c) The cargo-guppy Contributors
+// SPDX-License-Identifier: MIT OR Apache-2.0
+
+//! Proptest support.
+
+use crate::PackagesAndFeatures;
+use guppy::graph::PackageGraph;
+use proptest::collection::hash_set;
+use proptest::prelude::*;
+
+impl PackagesAndFeatures {
+    pub fn strategy<'g>(graph: &'g PackageGraph) -> impl Strategy<Value = Self> + 'g {
+        let workspace = graph.workspace();
+        (
+            // The lower bound of 0 is important because 0 means the whole workspace.
+            hash_set(workspace.prop09_name_strategy(), 0..8),
+            any::<bool>(),
+            any::<bool>(),
+        )
+            .prop_map(move |(packages, all_features, no_default_features)| {
+                // TODO: select features from these packages (probably requires flat_map :/ )
+                Self {
+                    packages: packages
+                        .into_iter()
+                        .map(|package| package.to_string())
+                        .collect(),
+                    features: vec![],
+                    all_features,
+                    no_default_features,
+                }
+            })
+    }
+}

guppy/src/graph/build.rs

@@ -108,6 +108,7 @@ impl WorkspaceImpl {
             root: workspace_root,
             members_by_path,
             members_by_name,
+            name_list: OnceCell::new(),
         })
     }
 }

guppy/src/graph/graph_impl.rs

@@ -463,7 +463,7 @@ impl<'g> DependsCache<'g> {
 #[derive(Clone, Debug)]
 pub struct Workspace<'g> {
     graph: &'g PackageGraph,
-    inner: &'g WorkspaceImpl,
+    pub(super) inner: &'g WorkspaceImpl,
 }
 
 impl<'g> Workspace<'g> {
@@ -472,6 +472,11 @@ impl<'g> Workspace<'g> {
         &self.inner.root
     }
 
+    /// Returns the number of packages in this workspace.
+    pub fn member_count(&self) -> usize {
+        self.inner.members_by_path.len()
+    }
+
     /// Returns an iterator over workspace paths and package metadatas, sorted by the path
     /// they're in.
     pub fn members(
@@ -522,6 +527,9 @@ pub(super) struct WorkspaceImpl {
     // This is a BTreeMap to allow presenting data in sorted order.
     pub(super) members_by_path: BTreeMap<PathBuf, PackageId>,
     pub(super) members_by_name: BTreeMap<Box<str>, PackageId>,
+    // Cache for members by name (only used for proptests)
+    #[cfg(feature = "proptest09")]
+    pub(super) name_list: OnceCell<Vec<Box<str>>>,
 }
 
 /// Information about a specific package in a `PackageGraph`.