Crate universe compile_data_glob_excludes (#3210)

Right now there is no way to exclude specific paths from compile_data.
And in a very rare cases this can be required, such example could be
what crate have generated filenames which incompatible with bazel (in my
case it was `:` symbol), usualy these files are used for test and not
required for compile.

I added new field to `annotation` called `compile_data_glob_excludes`,
it allows specify excludes on top of default ones, following same logic
as `compile_data_glob`.

---------

Signed-off-by: ianisimov <ianisimov@nvidia.com>

Author: yoks

crate_universe/extensions.bzl

@@ -1109,6 +1109,9 @@ _annotation = tag_class(
         "compile_data_glob": attr.string_list(
             doc = "A list of glob patterns to add to a crate's `rust_library::compile_data` attribute.",
         ),
+        "compile_data_glob_excludes": attr.string_list(
+            doc = "A list of glob patterns to be excllued from a crate's `rust_library::compile_data` attribute.",
+        ),
         "crate": attr.string(
             doc = "The name of the crate the annotation is applied to",
             mandatory = True,

crate_universe/private/crate.bzl

@@ -101,6 +101,7 @@ def _annotation(
         build_script_use_default_shell_env = None,
         compile_data = None,
         compile_data_glob = None,
+        compile_data_glob_excludes = None,
         crate_features = None,
         data = None,
         data_glob = None,
@@ -148,6 +149,8 @@ def _annotation(
         compile_data (list, optional): A list of labels to add to a crate's `rust_library::compile_data` attribute.
         compile_data_glob (list, optional): A list of glob patterns to add to a crate's `rust_library::compile_data`
             attribute.
+        compile_data_glob_excludes (list, optional): A list of glob patterns to be excluded from a crate's `rust_library::compile_data`
+            attribute.
         crate_features (optional): A list of strings to add to a crate's `rust_library::crate_features`
             attribute.
         data (list, optional): A list of labels to add to a crate's `rust_library::data` attribute.
@@ -206,6 +209,7 @@ def _annotation(
             build_script_use_default_shell_env = build_script_use_default_shell_env,
             compile_data = _stringify_list(compile_data),
             compile_data_glob = compile_data_glob,
+            compile_data_glob_excludes = compile_data_glob_excludes,
             crate_features = crate_features,
             data = _stringify_list(data),
             data_glob = data_glob,

crate_universe/src/config.rs

@@ -262,6 +262,10 @@ pub(crate) struct CrateAnnotations {
     /// [compile_data](https://bazelbuild.github.io/rules_rust/defs.html#rust_library-compile_data) attribute.
     pub(crate) compile_data_glob: Option<BTreeSet<String>>,
 
+    /// An optional glob pattern to set on the
+    /// [compile_data](https://bazelbuild.github.io/rules_rust/defs.html#rust_library-compile_data) excludes attribute.
+    pub(crate) compile_data_glob_excludes: Option<BTreeSet<String>>,
+
     /// If true, disables pipelining for library targets generated for this crate.
     pub(crate) disable_pipelining: bool,
 
@@ -404,6 +408,7 @@ impl Add for CrateAnnotations {
             disable_pipelining: self.disable_pipelining || rhs.disable_pipelining,
             compile_data: select_merge(self.compile_data, rhs.compile_data),
             compile_data_glob: joined_extra_member!(self.compile_data_glob, rhs.compile_data_glob, BTreeSet::new, BTreeSet::extend),
+            compile_data_glob_excludes: joined_extra_member!(self.compile_data_glob_excludes, rhs.compile_data_glob_excludes, BTreeSet::new, BTreeSet::extend),
             rustc_env: select_merge(self.rustc_env, rhs.rustc_env),
             rustc_env_files: select_merge(self.rustc_env_files, rhs.rustc_env_files),
             rustc_flags: select_merge(self.rustc_flags, rhs.rustc_flags),
@@ -463,6 +468,7 @@ pub(crate) struct AnnotationsProvidedByPackage {
     pub(crate) deps: Option<Select<BTreeSet<Label>>>,
     pub(crate) compile_data: Option<Select<BTreeSet<Label>>>,
     pub(crate) compile_data_glob: Option<BTreeSet<String>>,
+    pub(crate) compile_data_glob_excludes: Option<BTreeSet<String>>,
     pub(crate) rustc_env: Option<Select<BTreeMap<String, String>>>,
     pub(crate) rustc_env_files: Option<Select<BTreeSet<String>>>,
     pub(crate) rustc_flags: Option<Select<Vec<String>>>,
@@ -486,6 +492,7 @@ impl CrateAnnotations {
             deps,
             compile_data,
             compile_data_glob,
+            compile_data_glob_excludes,
             rustc_env,
             rustc_env_files,
             rustc_flags,
@@ -517,6 +524,10 @@ impl CrateAnnotations {
         default(&mut self.deps, deps);
         default(&mut self.compile_data, compile_data);
         default(&mut self.compile_data_glob, compile_data_glob);
+        default(
+            &mut self.compile_data_glob_excludes,
+            compile_data_glob_excludes,
+        );
         default(&mut self.rustc_env, rustc_env);
         default(&mut self.rustc_env_files, rustc_env_files);
         default(&mut self.rustc_flags, rustc_flags);

crate_universe/src/context/crate_context.rs

@@ -98,6 +98,9 @@ pub(crate) struct CommonAttributes {
     #[serde(skip_serializing_if = "BTreeSet::is_empty")]
     pub(crate) compile_data_glob: BTreeSet<String>,
 
+    #[serde(skip_serializing_if = "BTreeSet::is_empty")]
+    pub(crate) compile_data_glob_excludes: BTreeSet<String>,
+
     #[serde(skip_serializing_if = "Select::is_empty")]
     pub(crate) crate_features: Select<BTreeSet<String>>,
 
@@ -151,6 +154,7 @@ impl Default for CommonAttributes {
             compile_data: Default::default(),
             // Generated targets include all files in their package by default
             compile_data_glob: BTreeSet::from(["**".to_owned()]),
+            compile_data_glob_excludes: Default::default(),
             crate_features: Default::default(),
             data: Default::default(),
             data_glob: Default::default(),
@@ -182,6 +186,9 @@ pub(crate) struct BuildScriptAttributes {
     #[serde(skip_serializing_if = "BTreeSet::is_empty")]
     pub(crate) compile_data_glob: BTreeSet<String>,
 
+    #[serde(skip_serializing_if = "BTreeSet::is_empty")]
+    pub(crate) compile_data_glob_excludes: BTreeSet<String>,
+
     #[serde(skip_serializing_if = "Select::is_empty")]
     pub(crate) data: Select<BTreeSet<Label>>,
 
@@ -258,6 +265,7 @@ impl Default for BuildScriptAttributes {
             // The build script itself also has access to all
             // source files by default.
             compile_data_glob: BTreeSet::from(["**".to_owned()]),
+            compile_data_glob_excludes: BTreeSet::from(["**/*.rs".to_owned()]),
             data: Default::default(),
             // Build scripts include all sources by default
             data_glob: BTreeSet::from(["**".to_owned()]),
@@ -578,6 +586,13 @@ impl CrateContext {
                 self.common_attrs.compile_data_glob.extend(extra.clone());
             }
 
+            // Compile data glob excludes
+            if let Some(extra) = &crate_extra.compile_data_glob_excludes {
+                self.common_attrs
+                    .compile_data_glob_excludes
+                    .extend(extra.clone());
+            }
+
             // Crate features
             if let Some(extra) = &crate_extra.crate_features {
                 self.common_attrs.crate_features =

crate_universe/src/lockfile.rs

@@ -292,7 +292,7 @@ mod test {
         );
 
         assert_eq!(
-            Digest("2c4ee31fbefac161d2f3c6cae7fb8995c6311e292386a0500ac84e2586589dae".to_owned()),
+            Digest("d4899058bbb3a94af5f09c1d029bb6b7f152bd9a580a10563ac5211a842d1169".to_owned()),
             digest,
         );
     }

crate_universe/src/rendering.rs

@@ -499,8 +499,6 @@ impl Renderer {
     ) -> Result<CargoBuildScript> {
         let attrs = krate.build_script_attrs.as_ref();
 
-        const COMPILE_DATA_GLOB_EXCLUDES: &[&str] = &["**/*.rs"];
-
         Ok(CargoBuildScript {
             // Because `cargo_build_script` does some invisible target name
             // mutating to determine the package and crate name for a build
@@ -528,10 +526,9 @@ impl Renderer {
                 attrs
                     .map(|attrs| attrs.compile_data_glob.clone())
                     .unwrap_or_default(),
-                COMPILE_DATA_GLOB_EXCLUDES
-                    .iter()
-                    .map(|&pattern| pattern.to_owned())
-                    .collect(),
+                attrs
+                    .map(|attrs| attrs.compile_data_glob_excludes.clone())
+                    .unwrap_or_default(),
                 attrs
                     .map(|attrs| attrs.compile_data.clone())
                     .unwrap_or_default(),
@@ -544,6 +541,7 @@ impl Renderer {
                 attrs
                     .map(|attrs| attrs.data_glob.clone())
                     .unwrap_or_default(),
+                Default::default(),
                 attrs.map(|attrs| attrs.data.clone()).unwrap_or_default(),
             ),
             deps: SelectSet::new(
@@ -728,13 +726,15 @@ impl Renderer {
             compile_data: make_data(
                 platforms,
                 krate.common_attrs.compile_data_glob.clone(),
+                krate.common_attrs.compile_data_glob_excludes.clone(),
                 krate.common_attrs.compile_data.clone(),
             ),
             crate_features: SelectSet::new(krate.common_attrs.crate_features.clone(), platforms),
             crate_root: target.crate_root.clone(),
             data: make_data(
                 platforms,
                 krate.common_attrs.data_glob.clone(),
+                Default::default(),
                 krate.common_attrs.data.clone(),
             ),
             edition: krate.common_attrs.edition.clone(),
@@ -984,9 +984,10 @@ fn make_data_with_exclude(
 fn make_data(
     platforms: &Platforms,
     glob: BTreeSet<String>,
+    excludes: BTreeSet<String>,
     select: Select<BTreeSet<Label>>,
 ) -> Data {
-    make_data_with_exclude(platforms, glob, BTreeSet::new(), select)
+    make_data_with_exclude(platforms, glob, excludes, select)
 }
 
 #[cfg(test)]

examples/crate_universe/alias_rule/cargo-bazel-lock_global_alias_annotation_none.json

@@ -1,5 +1,5 @@
 {
-  "checksum": "bd90d955bdf1d6179d17e03bed1ee31c230f203539fc0f383b731949682d153f",
+  "checksum": "38545303789a26523d07ca189a42892a106f1bad909fcd30de9eff4a62732f8c",
   "crates": {
     "direct-cargo-bazel-deps 0.0.1": {
       "name": "direct-cargo-bazel-deps",
@@ -110,6 +110,9 @@
         "compile_data_glob": [
           "**"
         ],
+        "compile_data_glob_excludes": [
+          "**/*.rs"
+        ],
         "data_glob": [
           "**"
         ]

examples/crate_universe/alias_rule/cargo-bazel-lock_global_alias_annotation_opt.json

@@ -1,5 +1,5 @@
 {
-  "checksum": "185b85996af206151d0ac61700bbd27a5c6ba56e10d2bdeedeb229ec2d3620dc",
+  "checksum": "4f32204f9e97b48770d63da9b37612966dcd220ca27b67209c481412045615b3",
   "crates": {
     "direct-cargo-bazel-deps 0.0.1": {
       "name": "direct-cargo-bazel-deps",
@@ -110,6 +110,9 @@
         "compile_data_glob": [
           "**"
         ],
+        "compile_data_glob_excludes": [
+          "**/*.rs"
+        ],
         "data_glob": [
           "**"
         ]

examples/crate_universe/alias_rule/cargo-bazel-lock_global_custom_annotation_none.json

@@ -1,5 +1,5 @@
 {
-  "checksum": "4c18272a8dc6d1bc60827cc21b7b36418ce31b319d36280ceea4ae781a9228fc",
+  "checksum": "b1f2020829b8d898974c39d885673f4141ba6d5a483122ce7146f168445e7bc6",
   "crates": {
     "direct-cargo-bazel-deps 0.0.1": {
       "name": "direct-cargo-bazel-deps",
@@ -110,6 +110,9 @@
         "compile_data_glob": [
           "**"
         ],
+        "compile_data_glob_excludes": [
+          "**/*.rs"
+        ],
         "data_glob": [
           "**"
         ]

examples/crate_universe/alias_rule/cargo-bazel-lock_global_dbg_annotation_fastbuild.json

@@ -1,5 +1,5 @@
 {
-  "checksum": "5f88c0ea36c3f51f9d60943927b89fd8d801bccac2a62bea1a4130614e63120d",
+  "checksum": "a763b2dd2109e2a32a81e03f15a0ff5e74493e54e4436ac735ff73b9f311ae2a",
   "crates": {
     "direct-cargo-bazel-deps 0.0.1": {
       "name": "direct-cargo-bazel-deps",
@@ -110,6 +110,9 @@
         "compile_data_glob": [
           "**"
         ],
+        "compile_data_glob_excludes": [
+          "**/*.rs"
+        ],
         "data_glob": [
           "**"
         ]