more reliable implementation and tests

Author: eerii

Cargo.toml

@@ -1,5 +1,8 @@
-[package]
-name = "system-deps"
+[workspace]
+members = [ "meta" ]
+exclude = [ "target" ]
+
+[workspace.package]
 version = "7.0.3"
 authors = [
     "Guillaume Desmottes <[email protected]>",
@@ -17,10 +20,20 @@ keywords = [
 ]
 edition = "2018"
 documentation = "https://docs.rs/system-deps/"
-readme = "README.md"
 
-[build-dependencies]
-system-deps-meta = { path = "./meta", optional = true }
+[workspace.dependencies]
+system-deps-meta = { path = "./meta" }
+
+[package]
+name = "system-deps"
+version.workspace = true
+authors.workspace = true
+license.workspace = true
+description.workspace = true
+keywords.workspace = true
+edition.workspace = true
+documentation.workspace = true
+readme = "README.md"
 
 [dependencies]
 pkg-config = "0.3.25"
@@ -29,13 +42,15 @@ version-compare = "0.2"
 heck = "0.5"
 cfg-expr = { version = "0.17", features = ["targets"] }
 
+[build-dependencies]
+system-deps-meta = { workspace = true, optional = true }
+
 [dev-dependencies]
-lazy_static = "1"
 itertools = "0.13"
 assert_matches = "1.5"
 
 [features]
-default = [ "binary" ]
+default = [ ]
 binary = [ "system-deps-meta/binary" ]
 gx = [ "system-deps-meta/gz" ]
 xz = [ "system-deps-meta/xz" ]

build.rs

@@ -1,32 +1,31 @@
 pub fn main() {
     #[cfg(feature = "binary")]
-    binary::build();
+    binary::build().unwrap_or_else(|e| panic!("{}", e));
 }
 
 #[cfg(feature = "binary")]
 mod binary {
-    use std::{collections::HashMap, fs, path::Path};
+    use std::{collections::HashMap, convert::TryInto, fs, path::Path};
 
-    use system_deps_meta::{read_metadata, Binary, BinaryPaths, BUILD_TARGET_DIR};
-
-    pub fn build() {
-        // Add pkg-config paths to the overrides
-        // TODO: This should probably follow some deterministic ordering to avoid issues
-
-        let dest_path = Path::new(BUILD_TARGET_DIR).join("binary_config.rs");
-        println!("cargo:rustc-env=BINARY_CONFIG={}", dest_path.display());
+    use system_deps_meta::{
+        binary::{merge_binary, Binary, BinaryPaths},
+        error::{BinaryError, Error},
+        parse::{MetadataList, ValueExt},
+        BUILD_MANIFEST, BUILD_TARGET_DIR,
+    };
 
+    // Add pkg-config paths to the overrides
+    pub fn build() -> Result<(), Error> {
         // Read metadata from the crate graph
-        let metadata = read_metadata(system_deps_meta::BUILD_MANIFEST, "system-deps");
+        let metadata = MetadataList::new(BUILD_MANIFEST, "system-deps")?;
 
         // Download the binaries and get their pkg_config paths
-        let mut binaries = metadata
-            .get::<HashMap<String, Binary>>(|| true)
-            .unwrap_or_default();
-        println!("cargo:warning=BINARIES {:?}", binaries);
-        let paths = BinaryPaths::from(binaries.drain());
-        println!("cargo:warning=PATHS {:?}", paths);
+        let list: HashMap<String, Binary> = metadata.build(merge_binary)?.to().unwrap_or_default();
+        let paths: BinaryPaths = list.try_into()?;
 
-        fs::write(dest_path, paths.build()).expect("Error when writing binary config");
+        // Write the binary paths to a file for later use
+        let dest_path = Path::new(BUILD_TARGET_DIR).join("binary_config.rs");
+        println!("cargo:rustc-env=BINARY_CONFIG={}", dest_path.display());
+        fs::write(dest_path, paths.build()).map_err(|e| BinaryError::InvalidDirectory(e).into())
     }
 }

meta/Cargo.toml

@@ -1,22 +1,24 @@
 [package]
 name = "system-deps-meta"
-version = "0.1.0"
-edition = "2021"
+version.workspace = true
+authors.workspace = true
+license.workspace = true
+description.workspace = true
+keywords.workspace = true
+edition.workspace = true
+documentation.workspace = true
 
 [dependencies]
 cargo_metadata = "0.19"
-# Metadata
 serde_json = "1.0"
 serde = "1.0"
 cfg-expr = { version = "0.17", features = ["targets"] }
-# Binary
 sha256 = { version = "1.5", optional = true }
 reqwest = { version = "0.12", features = ["blocking"], optional = true }
 flate2 = { version = "1.0", optional = true }
 xz = { version = "0.1", optional = true }
 tar = { version = "0.4", optional = true }
 zip = { version = "2.2", optional = true }
-apple-flat-package = { version = "0.20", optional = true }
 
 [dev-dependencies]
 toml = "0.8"
@@ -27,4 +29,3 @@ binary = [ "dep:sha256", "dep:reqwest" ]
 gz = [ "dep:flate2", "dep:tar" ]
 xz = [ "dep:xz", "dep:tar" ]
 zip = [ "dep:zip" ]
-pkg = [ "dep:apple-flat-package" ]

meta/build.rs

@@ -4,7 +4,7 @@ use std::{
 };
 
 /// Environment variable to override the top level `Cargo.toml`.
-const MANIFEST_VAR: &str = "SYSTEM_DEPS_MANIFEST";
+const MANIFEST_VAR: &str = "SYSTEM_DEPS_BUILD_MANIFEST";
 
 /// Environment variable to override the directory where `system-deps`
 /// will store build products such as binary outputs.
@@ -26,27 +26,6 @@ fn find_with_cargo(dir: &Path) -> Option<PathBuf> {
     Some(PathBuf::from(std::str::from_utf8(&out).ok()?.trim()))
 }
 
-/// Try to find the project root finding the outmost Cargo.toml
-/// TODO: Check if this is ever called
-fn find_by_path(mut dir: PathBuf) -> Option<PathBuf> {
-    let mut best_match = None;
-    loop {
-        let Ok(read) = dir.read_dir() else {
-            break;
-        };
-        for entry in read {
-            let Ok(entry) = entry else { continue };
-            if entry.file_name() == "Cargo.toml" {
-                best_match = Some(entry.path());
-            }
-        }
-        if !dir.pop() {
-            break;
-        }
-    }
-    best_match
-}
-
 /// Get the manifest from the project directory. This is **not** the directory
 /// where `system-deps` is cloned, it should point to the top level `Cargo.toml`
 /// file. This is needed to obtain metadata from all of dependencies, including
@@ -75,34 +54,23 @@ fn manifest() -> PathBuf {
     );
     dir.pop();
 
-    // Try to find the project first with cargo
-    if let Some(dir) = find_with_cargo(&dir) {
-        return dir;
-    }
-
-    // If it doesn't work, try to find a Cargo.toml
-    find_by_path(dir).expect(
+    // Try to find the project with cargo
+    find_with_cargo(&dir).expect(
         "Error determining the cargo root manifest.\n\
          Please set `SYSTEM_DEPS_MANIFEST` to the path of your project's Cargo.toml",
     )
 }
 
-/// Directory where system-deps related build products will be stored.
-/// Notably, binary outputs are located here.
-fn target_dir() -> String {
-    println!("cargo:rerun-if-env-changed={}", TARGET_VAR);
-    env::var(TARGET_VAR).or(env::var("OUT_DIR")).unwrap()
-}
-
-/// This will set compile time values for the manifest and target paths.
+/// Set compile time values for the manifest and target paths, and the compile target.
 /// Calculating this in a build script is necessary so that they are only calculated
 /// once and every invocation of `system-deps` references the same metadata.
 pub fn main() {
     let manifest = manifest();
     println!("cargo:rerun-if-changed={}", manifest.display());
     println!("cargo:rustc-env=BUILD_MANIFEST={}", manifest.display());
 
-    let target_dir = target_dir();
+    let target_dir = env::var(TARGET_VAR).or(env::var("OUT_DIR")).unwrap();
+    println!("cargo:rerun-if-env-changed={}", TARGET_VAR);
     println!("cargo:rustc-env=BUILD_TARGET_DIR={}", target_dir);
 
     println!(