Crate Universe: crate.spec() supports path

This is inspired by #3464

Author: illicitonion

crate_universe/extensions.bzl

@@ -645,6 +645,7 @@ def _generate_hub_and_spokes(
             config_path = config_file,
             output_dir = tag_path.get_child("splicing-output"),
             debug_workspace_dir = tag_path.get_child("splicing-workspace"),
+            nonhermetic_root_bazel_workspace_dir = nonhermetic_root_bazel_workspace_dir,
             repository_name = cfg.name,
         )
 
@@ -1269,7 +1270,7 @@ _spec = tag_class(
             doc = "A list of features to use for the crate.",
         ),
         "git": attr.string(
-            doc = "The Git url to use for the crate. Cannot be used with `version`.",
+            doc = "The Git url to use for the crate. Cannot be used with `version` or `path`.",
         ),
         "lib": attr.bool(
             doc = "If using `artifact = 'bin'`, additionally setting `lib = True` declares a dependency on both the package's library and binary, as opposed to just the binary.",
@@ -1278,6 +1279,9 @@ _spec = tag_class(
             doc = "The explicit name of the package.",
             mandatory = True,
         ),
+        "path": attr.string(
+            doc = "The local path of the remote crate. Cannot be used with `version` or `git`.",
+        ),
         "repositories": attr.string_list(
             doc = "A list of repository names specified from `crate.from_cargo(name=...)` that this spec is applied to. Defaults to all repositories.",
             default = [],
@@ -1289,7 +1293,7 @@ _spec = tag_class(
             doc = "The git tag of the remote crate. Tied with the `git` param. Only one of branch, tag or rev may be specified. Specifying `rev` is recommended for fully-reproducible builds.",
         ),
         "version": attr.string(
-            doc = "The exact version of the crate. Cannot be used with `git`.",
+            doc = "The exact version of the crate. Cannot be used with `git` or `path`.",
         ),
     },
 )

crate_universe/private/crate.bzl

@@ -27,7 +27,8 @@ def _spec(
         git = None,
         branch = None,
         tag = None,
-        rev = None):
+        rev = None,
+        path = None):
     """A constructor for a crate dependency.
 
     See [specifying dependencies][sd] in the Cargo book for more details.
@@ -36,15 +37,16 @@ def _spec(
 
     Args:
         package (str, optional): The explicit name of the package (used when attempting to alias a crate).
-        version (str, optional): The exact version of the crate. Cannot be used with `git`.
+        version (str, optional): The exact version of the crate. Cannot be used with `git` or `path`.
         artifact (str, optional): Set to "bin" to pull in a binary crate as an artifact dependency. Requires a nightly Cargo.
         lib (bool, optional): If using `artifact = "bin"`, additionally setting `lib = True` declares a dependency on both the package's library and binary, as opposed to just the binary.
         default_features (bool, optional): Maps to the `default-features` flag.
         features (list, optional): A list of features to use for the crate
-        git (str, optional): The Git url to use for the crate. Cannot be used with `version`.
+        git (str, optional): The Git url to use for the crate. Cannot be used with `version` or `path`.
         branch (str, optional): The git branch of the remote crate. Tied with the `git` param. Only one of branch, tag or rev may be specified. Specifying `rev` is recommended for fully-reproducible builds.
         tag (str, optional): The git tag of the remote crate. Tied with the `git` param. Only one of branch, tag or rev may be specified. Specifying `rev` is recommended for fully-reproducible builds.
         rev (str, optional): The git revision of the remote crate. Tied with the `git` param. Only one of branch, tag or rev may be specified.
+        path (str, optional): The local path of the remote crate. Cannot be used with `version` or `git`.
 
     Returns:
         string: A json encoded string of all inputs
@@ -59,6 +61,7 @@ def _spec(
             "git": git,
             "lib": lib,
             "package": package,
+            "path": path,
             "rev": rev,
             "tag": tag,
             "version": version,

crate_universe/private/crates_repository.bzl

@@ -91,6 +91,7 @@ def _crates_repository_impl(repository_ctx):
             splicing_manifest = splicing_manifest,
             config_path = config_path,
             output_dir = repository_ctx.path("splicing-output"),
+            nonhermetic_root_bazel_workspace_dir = nonhermetic_root_bazel_workspace_dir,
             repository_name = repository_ctx.name,
         )
 

crate_universe/private/splicing_utils.bzl

@@ -123,6 +123,7 @@ def splice_workspace_manifest(
         config_path,
         output_dir,
         repository_name,
+        nonhermetic_root_bazel_workspace_dir,
         debug_workspace_dir = None):
     """Splice together a Cargo workspace from various other manifests and package definitions
 
@@ -134,6 +135,7 @@ def splice_workspace_manifest(
         config_path (path): The path to the config file (containing `cargo_bazel::config::Config`.)
         output_dir (path): THe location in which to write splicing outputs.
         repository_name (str): Name of the repository being generated.
+        nonhermetic_root_bazel_workspace_dir (path): The path to the current workspace root
         debug_workspace_dir (path): The location in which to save splicing outputs for future review.
 
     Returns:
@@ -151,6 +153,8 @@ def splice_workspace_manifest(
         config_path,
         "--repository-name",
         repository_name,
+        "--nonhermetic-root-bazel-workspace-dir",
+        nonhermetic_root_bazel_workspace_dir,
     ]
 
     if cargo_lockfile:

crate_universe/src/cli/splice.rs

@@ -64,6 +64,13 @@ pub struct SpliceOptions {
     /// The name of the repository being generated.
     #[clap(long)]
     pub repository_name: String,
+
+    /// The path to the Bazel root workspace (i.e. the directory containing the WORKSPACE.bazel file or similar).
+    /// BE CAREFUL with this value. We never want to include it in a lockfile hash (to keep lockfiles portable),
+    /// which means you also should not use it anywhere that _should_ be guarded by a lockfile hash.
+    /// You basically never want to use this value.
+    #[clap(long)]
+    pub nonhermetic_root_bazel_workspace_dir: Utf8PathBuf,
 }
 
 /// Combine a set of disjoint manifests into a single workspace.
@@ -73,12 +80,12 @@ pub fn splice(opt: SpliceOptions) -> Result<()> {
         .context("Failed to parse splicing manifest")?;
 
     // Determine the splicing workspace
-    let temp_dir;
+    // let temp_dir;
     let splicing_dir = match &opt.workspace_dir {
         Some(dir) => dir.clone(),
         None => {
-            temp_dir = tempfile::tempdir().context("Failed to generate temporary directory")?;
-            Utf8PathBuf::from_path_buf(temp_dir.as_ref().to_path_buf())
+            let temp_dir = tempfile::tempdir().context("Failed to generate temporary directory")?;
+            Utf8PathBuf::from_path_buf(temp_dir.into_path())
                 .unwrap_or_else(|path| panic!("Temporary directory wasn't valid UTF-8: {:?}", path))
         }
     };
@@ -91,7 +98,7 @@ pub fn splice(opt: SpliceOptions) -> Result<()> {
 
     // Splice together the manifest
     let manifest_path = prepared_splicer
-        .splice(&splicing_dir)
+        .splice(&splicing_dir, &opt.nonhermetic_root_bazel_workspace_dir)
         .with_context(|| format!("Failed to splice workspace {}", opt.repository_name))?;
 
     // Generate a lockfile

crate_universe/src/cli/vendor.rs

@@ -217,7 +217,7 @@ pub fn vendor(opt: VendorOptions) -> anyhow::Result<()> {
 
     // Splice together the manifest
     let manifest_path = splicer
-        .splice_workspace()
+        .splice_workspace(&opt.nonhermetic_root_bazel_workspace_dir)
         .context("Failed to splice workspace")?;
 
     // Gather a cargo lockfile