Feature: Enable variable expansion for remap_paths in pkg_tar (#947)

Author: dmarquez-splunk

MODULE.bazel

@@ -9,6 +9,7 @@ module(
 bazel_dep(name = "rules_license", version = "1.0.0")
 bazel_dep(name = "rules_python", version = "1.0.0")
 bazel_dep(name = "bazel_skylib", version = "1.7.1")
+bazel_dep(name = "aspect_bazel_lib", version = "2.14.0")
 
 # Only for development
 bazel_dep(name = "platforms", version = "0.0.10", dev_dependency = True)

WORKSPACE

@@ -81,3 +81,12 @@ http_archive(
 load("@rules_cc//cc:repositories.bzl", "rules_cc_dependencies")
 
 rules_cc_dependencies()
+
+http_archive(
+    name = "aspect_bazel_lib",
+    sha256 = "40ba9d0f62deac87195723f0f891a9803a7b720d7b89206981ca5570ef9df15b",
+    strip_prefix = "bazel-lib-2.14.0",
+    url = "https://github.com/bazel-contrib/bazel-lib/releases/download/v2.14.0/bazel-lib-v2.14.0.tar.gz",
+)
+
+aspect_bazel_lib_dependencies()

doc_build/BUILD

@@ -72,6 +72,7 @@ genrule(
         deps = [
             ":rules_pkg_lib",
             "//toolchains/rpm:standard_package",
+            "@aspect_bazel_lib//lib:expand_make_vars",
         ],
     )
     for rule, src in ORDER

pkg/private/tar/tar.bzl

@@ -13,6 +13,7 @@
 # limitations under the License.
 """Rules for making .tar files."""
 
+load("@aspect_bazel_lib//lib:expand_make_vars.bzl", "expand_variables")
 load("//pkg:providers.bzl", "PackageVariablesInfo")
 load(
     "//pkg/private:pkg_files.bzl",
@@ -119,8 +120,14 @@ def _pkg_tar_impl(ctx):
 
     # Now we begin processing the files.
     path_mapper = None
+    expanded_remap_paths = {}
     if ctx.attr.remap_paths:
-        path_mapper = lambda path: _remap(ctx.attr.remap_paths, path)
+        for prefix, replacement in ctx.attr.remap_paths.items():
+            expanded_prefix = expand_variables(ctx, prefix)
+            expanded_replacement = expand_variables(ctx, replacement)
+            expanded_remap_paths[expanded_prefix] = expanded_replacement
+
+        path_mapper = lambda path: _remap(expanded_remap_paths, path)
 
     mapping_context = create_mapping_context_from_ctx(
         ctx,

tests/tar/BUILD

@@ -464,6 +464,7 @@ py_test(
         ":test-pkg-tar-from-pkg-files-with-attributes",
         ":test-pkg-tar-with-attributes",
         ":test-remap-paths-tree-artifact",
+        ":test-remap-paths-variables",
         ":test-respect-externally-defined-duplicates.tar",
         ":test-tar-compression_level--1",
         ":test-tar-compression_level-3",
@@ -626,6 +627,16 @@ pkg_tar(
     },
 )
 
+pkg_tar(
+    name = "test-remap-paths-variables",
+    srcs = [
+        ":tree_artifact_to_rename",
+    ],
+    remap_paths = {
+        "/rename_me": "$(COMPILATION_MODE)",
+    },
+)
+
 #
 # Test with symlinks
 #

tests/tar/pkg_tar_test.py

@@ -285,6 +285,15 @@ def test_remap_paths_tree_artifact(self):
     ]
     self.assertTarFileContent('test-remap-paths-tree-artifact.tar', content)
 
+  def test_remap_paths_make_variables(self):
+    content = [
+      {'name': 'fastbuild', 'isdir': True},
+      {'name': 'fastbuild/a'},
+      {'name': 'fastbuild/rename_me', 'isdir': True},
+      {'name': 'fastbuild/rename_me/should_not_rename'},
+    ]
+    self.assertTarFileContent('test-remap-paths-variables.tar', content)
+
   def test_externally_defined_duplicate_structure(self):
     content = [
       {'name': './a'},