fix: allow rules to consume tools env data (#1397)

Author: jsun-splunk

foreign_cc/built_tools/private/built_tools_framework.bzl

@@ -112,7 +112,7 @@ def built_tool_rule_impl(ctx, script_lines, out_dir, mnemonic, additional_tools
 
     root = detect_root(ctx.attr.srcs)
     lib_name = ctx.attr.name
-    env_prelude = get_env_prelude(ctx, out_dir.path, [])
+    env_prelude = get_env_prelude(ctx, out_dir.path, [], {})
 
     cc_toolchain = find_cpp_toolchain(ctx)
 

foreign_cc/cmake.bzl

@@ -156,14 +156,18 @@ load(
 load(
     "//toolchains/native_tools:tool_access.bzl",
     "get_cmake_data",
+    "get_m4_data",
     "get_make_data",
     "get_ninja_data",
+    "get_pkgconfig_data",
 )
 
 def _cmake_impl(ctx):
     cmake_data = get_cmake_data(ctx)
+    pkgconfig_data = get_pkgconfig_data(ctx)
+    m4_data = get_m4_data(ctx)
 
-    tools_data = [cmake_data]
+    tools_data = [cmake_data, pkgconfig_data, m4_data]
 
     env = dict(ctx.attr.env)
 

foreign_cc/configure.bzl

@@ -21,13 +21,29 @@ load(
     "expand_locations_and_make_variables",
 )
 load("//foreign_cc/private:transitions.bzl", "foreign_cc_rule_variant")
-load("//toolchains/native_tools:tool_access.bzl", "get_make_data", "get_pkgconfig_data")
+load(
+    "//toolchains/native_tools:tool_access.bzl",
+    "get_autoconf_data",
+    "get_automake_data",
+    "get_m4_data",
+    "get_make_data",
+    "get_pkgconfig_data",
+)
 
 def _configure_make(ctx):
     make_data = get_make_data(ctx)
     pkg_config_data = get_pkgconfig_data(ctx)
+    autoconf_data = get_autoconf_data(ctx)
+    automake_data = get_automake_data(ctx)
+    m4_data = get_m4_data(ctx)
 
-    tools_data = [make_data, pkg_config_data]
+    tools_data = [
+        make_data,
+        pkg_config_data,
+        autoconf_data,
+        automake_data,
+        m4_data,
+    ]
 
     if ctx.attr.autogen and not ctx.attr.configure_in_place:
         fail("`autogen` requires `configure_in_place = True`. Please update {}".format(

foreign_cc/private/framework.bzl

@@ -310,13 +310,14 @@ dependencies.""",
 def _is_msvc_var(var):
     return var == "INCLUDE" or var == "LIB"
 
-def get_env_prelude(ctx, installdir, data_dependencies):
+def get_env_prelude(ctx, installdir, data_dependencies, tools_env):
     """Generate a bash snippet containing environment variable definitions
 
     Args:
         ctx (ctx): The rule's context object
         installdir (str): The path from the root target's directory in the build output
         data_dependencies (list): A list of targets representing dependencies
+        tools_env (dict): A dictionary of environment variables from toolchain
 
     Returns:
         tuple: A list of environment variables to define in the build script and a dict
@@ -330,6 +331,7 @@ def get_env_prelude(ctx, installdir, data_dependencies):
     ]
 
     env = dict()
+    env.update(tools_env)
 
     # Add all environment variables from the cc_toolchain
     cc_toolchain = find_cpp_toolchain(ctx)
@@ -455,15 +457,18 @@ def cc_external_rule_impl(ctx, attrs):
     target_root = paths.dirname(installdir_copy.file.dirname)
 
     data_dependencies = ctx.attr.data + ctx.attr.build_data + ctx.attr.toolchains
+    tools_env = {}
     for tool in attrs.tools_data:
         if tool.target:
             data_dependencies.append(tool.target)
+        if tool.env:
+            tools_env.update(tool.env)
 
     # Also add legacy dependencies while they're still available
     data_dependencies += ctx.attr.tools_deps + ctx.attr.additional_tools
 
     installdir = target_root + "/" + lib_name
-    env_prelude = get_env_prelude(ctx, installdir, data_dependencies)
+    env_prelude = get_env_prelude(ctx, installdir, data_dependencies, tools_env)
 
     if not attrs.postfix_script:
         postfix_script = []

toolchains/native_tools/tool_access.bzl

@@ -47,13 +47,22 @@ def _access_and_expect_label_copied(toolchain_type_, ctx):
         # This could be made more efficient by changing the
         # toolchain to provide the executable as a target
         cmd_file = tool_data
+        tool_env = dict(tool_data.env)
+
         for f in tool_data.target.files.to_list():
             if f.path.endswith("/" + tool_data.path):
                 cmd_file = f
                 break
+
+        # Environment vars for tools such as MAKE and CMAKE needs to be absolute
+        # as they are used from build_tmpdir and not bazel's exec/sandbox root
+        for k, v in tool_env.items():
+            if v.endswith(tool_data.path):
+                tool_env[k] = "$EXT_BUILD_ROOT/{}".format(cmd_file.path)
+
         return struct(
             target = tool_data.target,
-            env = tool_data.env,
+            env = tool_env,
             # as the tool will be copied into tools directory
             path = "$EXT_BUILD_ROOT/{}".format(cmd_file.path),
         )