Use ${pwd} prefix for INCLUDE path values

Author: ArchangelX360

cargo/private/cargo_build_script.bzl

@@ -212,6 +212,25 @@ def _prefix_pwd_to_flag(args, flag_variations):
 
     return res
 
+def _prefix_pwd_to_paths(args):
+    """Prefix execroot-relative paths with ${pwd}.
+
+    Handles plain path arguments without any associated flags.
+
+    Args:
+        args (list): List of path arguments.
+
+    Returns:
+        list: The modified argument list with relative paths prefixed with ${pwd}.
+    """
+    res = []
+    for path in args:
+        if not paths.is_absolute(path):
+            res.append("${{pwd}}/{}".format(path))
+        else:
+            res.append(path)
+    return res
+
 def _pwd_flags_sysroot(args):
     """Prefix execroot-relative paths in --sysroot= arguments with ${pwd}."""
     return _prefix_pwd_to_flag(args, ["--sysroot="])
@@ -236,6 +255,10 @@ def _pwd_flags_resource_dir(args):
     """Prefix execroot-relative paths in -resource-dir arguments with ${pwd}."""
     return _prefix_pwd_to_flag(args, ["-resource-dir=", "-resource-dir"])
 
+def _pwd_paths(args):
+    """Prefix execroot-relative paths with ${pwd}."""
+    return _prefix_pwd_to_paths(args)
+
 def _pwd_flags(args):
     return _pwd_flags_fsanitize_ignorelist(_pwd_flags_isystem(_pwd_flags_L(_pwd_flags_B(_pwd_flags_resource_dir(_pwd_flags_sysroot(args))))))
 
@@ -446,7 +469,11 @@ def _cargo_build_script_impl(ctx):
         cc_c_args, cc_cxx_args, cc_env = get_cc_compile_args_and_env(cc_toolchain, feature_configuration)
         include = cc_env.get("INCLUDE")
         if include:
-            env["INCLUDE"] = include
+            if toolchain.exec_triple.str.find("windows") > 0:
+                path_separator = ";"
+            else:
+                path_separator = ":"
+            env["INCLUDE"] = path_separator.join(_pwd_paths(include.split(path_separator)))
 
         toolchain_tools.append(cc_toolchain.all_files)
 

test/cargo_build_script/cc_args_and_env/BUILD.bazel

@@ -4,6 +4,9 @@ load(
     "bindir_relative_test",
     "fsanitize_ignorelist_absolute_test",
     "fsanitize_ignorelist_relative_test",
+    "include_absolute_test",
+    "include_mixed_test",
+    "include_relative_test",
     "isystem_absolute_test",
     "isystem_relative_test",
     "legacy_cc_toolchain_test",
@@ -43,3 +46,9 @@ libpath_relative_test(name = "libpath_relative_test")
 resource_dir_absolute_test(name = "resource_dir_absolute_test")
 
 resource_dir_relative_test(name = "resource_dir_relative_test")
+
+include_relative_test(name = "include_relative_test")
+
+include_absolute_test(name = "include_absolute_test")
+
+include_mixed_test(name = "include_mixed_test")

test/cargo_build_script/cc_args_and_env/cc_args_and_env_test.bzl

@@ -9,7 +9,7 @@ To verify the processed cargo cc_args, we use cc_args_and_env_analysis_test().
 
 load("@bazel_skylib//lib:unittest.bzl", "analysistest", "asserts")
 load("@rules_cc//cc:action_names.bzl", "ACTION_NAMES", "ACTION_NAME_GROUPS")
-load("@rules_cc//cc:cc_toolchain_config_lib.bzl", "action_config", "feature", "flag_group", "flag_set", "tool", "tool_path")
+load("@rules_cc//cc:cc_toolchain_config_lib.bzl", "action_config", "env_entry", "env_set", "feature", "flag_group", "flag_set", "tool", "tool_path")
 load("@rules_cc//cc:defs.bzl", "cc_toolchain")
 load("@rules_cc//cc/common:cc_common.bzl", "cc_common")
 load("//cargo:defs.bzl", "cargo_build_script")
@@ -35,6 +35,17 @@ def _test_cc_config_impl(ctx):
                     ]),
                 ),
             ],
+            env_sets = [
+                env_set(
+                    actions = ACTION_NAME_GROUPS.all_cc_compile_actions,
+                    env_entries = [
+                        env_entry(
+                            key = "INCLUDE",
+                            value = ctx.attr.extra_include_paths,
+                        ),
+                    ],
+                ),
+            ] if ctx.attr.extra_include_paths else [],
         ),
         feature(
             name = "default_cpp_flags",
@@ -155,6 +166,7 @@ test_cc_config = rule(
         "extra_ar_flags": attr.string_list(),
         "extra_cc_compile_flags": attr.string_list(),
         "extra_cxx_compile_flags": attr.string_list(),
+        "extra_include_paths": attr.string(default = ""),
         "legacy_cc_toolchain": attr.bool(default = False),
     },
     provides = [CcToolchainConfigInfo],
@@ -240,6 +252,15 @@ def _cc_args_and_env_analysis_test_impl(ctx):
         "set up by most Bazel C/C++ toolchains is extremely error-prone.",
     )
 
+    if ctx.attr.expected_include:
+        actual_include = cargo_action.env.get("INCLUDE")
+        asserts.equals(
+            env,
+            ctx.attr.expected_include,
+            actual_include,
+            "error: expected INCLUDE '{}' but got '{}'".format(ctx.attr.expected_include, actual_include),
+        )
+
     return analysistest.end(env)
 
 cc_args_and_env_analysis_test = analysistest.make(
@@ -248,6 +269,7 @@ cc_args_and_env_analysis_test = analysistest.make(
     attrs = {
         "expected_cflags": attr.string_list(default = ["-Wall"]),
         "expected_cxxflags": attr.string_list(default = ["-fno-rtti"]),
+        "expected_include": attr.string(default = ""),
         "legacy_cc_toolchain": attr.bool(default = False),
     },
 )
@@ -258,6 +280,7 @@ def cargo_build_script_with_extra_cc_compile_flags(
         extra_cc_compile_flags = ["-Wall"],
         extra_cxx_compile_flags = ["-fno-rtti"],
         extra_ar_flags = ["-x"],
+        extra_include_paths = "",
         legacy_cc_toolchain = False):
     """Produces a test cargo_build_script target that's set up to use a custom cc_toolchain with the extra_cc_compile_flags.
 
@@ -272,6 +295,7 @@ def cargo_build_script_with_extra_cc_compile_flags(
       extra_cc_compile_flags: Extra C/C++ args for the cc_toolchain.
       extra_cxx_compile_flags: Extra C++-specific args for the cc_toolchain.
       extra_ar_flags: Extra archiver args for the cc_toolchain.
+      extra_include_paths: INCLUDE environment variable value for the cc_toolchain.
       legacy_cc_toolchain: Enables legacy tool_path configuration of the cc
         cc toolchain.
     """
@@ -281,6 +305,7 @@ def cargo_build_script_with_extra_cc_compile_flags(
         extra_cc_compile_flags = extra_cc_compile_flags,
         extra_cxx_compile_flags = extra_cxx_compile_flags,
         extra_ar_flags = extra_ar_flags,
+        extra_include_paths = extra_include_paths,
         legacy_cc_toolchain = legacy_cc_toolchain,
     )
     cc_toolchain(
@@ -466,3 +491,54 @@ def resource_dir_absolute_test(name):
         target_under_test = "%s/cargo_build_script" % name,
         expected_cflags = ["-resource-dir", "/test/absolute/resources", "-resource-dir=/test/absolute/resources2", "-resource-dir=", "some_unrelated_arg"],
     )
+
+def include_relative_test(name):
+    cargo_build_script_with_extra_cc_compile_flags(
+        name = "%s/cargo_build_script" % name,
+        extra_include_paths = select({
+            "@platforms//os:windows": "test/relative/include;another/relative/path",
+            "//conditions:default": "test/relative/include:another/relative/path",
+        }),
+    )
+    cc_args_and_env_analysis_test(
+        name = name,
+        target_under_test = "%s/cargo_build_script" % name,
+        expected_include = select({
+            "@platforms//os:windows": "${pwd}/test/relative/include;${pwd}/another/relative/path",
+            "//conditions:default": "${pwd}/test/relative/include:${pwd}/another/relative/path",
+        }),
+    )
+
+def include_absolute_test(name):
+    cargo_build_script_with_extra_cc_compile_flags(
+        name = "%s/cargo_build_script" % name,
+        extra_include_paths = select({
+            "@platforms//os:windows": "/test/absolute/include;/another/absolute/path",
+            "//conditions:default": "/test/absolute/include:/another/absolute/path",
+        }),
+    )
+    cc_args_and_env_analysis_test(
+        name = name,
+        target_under_test = "%s/cargo_build_script" % name,
+        expected_include = select({
+            "@platforms//os:windows": "/test/absolute/include;/another/absolute/path",
+            "//conditions:default": "/test/absolute/include:/another/absolute/path",
+        }),
+    )
+
+def include_mixed_test(name):
+    cargo_build_script_with_extra_cc_compile_flags(
+        name = "%s/cargo_build_script" % name,
+        extra_include_paths = select({
+            "@platforms//os:windows": "/test/absolute/include;test/relative/path",
+            "//conditions:default": "/test/absolute/include:test/relative/path",
+        }),
+    )
+    cc_args_and_env_analysis_test(
+        name = name,
+        target_under_test = "%s/cargo_build_script" % name,
+        expected_include = select({
+            "@platforms//os:windows": "/test/absolute/include;${pwd}/test/relative/path",
+            "//conditions:default": "/test/absolute/include:${pwd}/test/relative/path",
+        }),
+    )