Add Resource Assembly handling (#492)

purkhusid · web-flow · commit a6d374a6cbc2 · 2025-06-06T14:19:01.000Z
* Add Resource Assembly handling

## What?
Adds handling of resource assemblies in NuGet packages.

* Remove commented code

* Update docs
diff --git a/docs/defs.md b/docs/defs.md
diff --git a/dotnet/paket.rules_dotnet_dev_nuget_packages.bzl b/dotnet/paket.rules_dotnet_dev_nuget_packages.bzl
diff --git a/dotnet/private/common.bzl b/dotnet/private/common.bzl
@@ -366,7 +366,7 @@ def collect_transitive_runfiles(ctx, assembly_runtime_info, deps):
     Returns:
         A runfiles object that includes the transitive dependencies of the target
     """
-    runfiles = ctx.runfiles(files = assembly_runtime_info.data + assembly_runtime_info.native + assembly_runtime_info.xml_docs + assembly_runtime_info.libs)
+    runfiles = ctx.runfiles(files = assembly_runtime_info.data + assembly_runtime_info.native + assembly_runtime_info.xml_docs + assembly_runtime_info.libs + assembly_runtime_info.resource_assemblies)
 
     transitive_runfiles = []
     for dep in deps:
@@ -526,6 +526,19 @@ def framework_preprocessor_symbols(tfm):
 
     return defines
 
+def _get_resource_assembly_locale(file):
+    """Gets the locale of a resource assembly file.
+
+    The locale is the path fragment before the file name:
+    e.g. <TFM>/<locale>/assembly.resources.dll
+
+    Args:
+        file: The resource assembly file.
+    Returns:
+        The locale of the resource assembly file.
+    """
+    return file.dirname.split("/")[-1]
+
 # For deps.json spec see: https://github.com/dotnet/sdk/blob/main/documentation/specs/runtime-configuration-file.md
 def generate_depsjson(
         ctx,
@@ -637,6 +650,10 @@ def generate_depsjson(
             } for dll in runtime_dep.libs}
             target_fragment["native"] = {native_file.basename if not use_relative_paths else to_rlocation_path(ctx, native_file): {} for native_file in runtime_dep.native}
 
+            target_fragment["resources"] = {(resource_assembly.basename if not use_relative_paths else to_rlocation_path(ctx, resource_assembly)): {
+                "locale": _get_resource_assembly_locale(resource_assembly),
+            } for resource_assembly in runtime_dep.resource_assemblies}
+
         base["libraries"][library_name] = library_fragment
         base["targets"][runtime_target][library_name] = target_fragment
 
diff --git a/dotnet/private/providers.bzl b/dotnet/private/providers.bzl
@@ -33,6 +33,7 @@ DotnetAssemblyRuntimeInfo = provider(
         "xml_docs": "list[File]: The XML documentation files of the assembly",
         "native": "list[File]: Native runtime files",
         "data": "list[File]: Runtime data files",
+        "resource_assemblies": "list[File]: Resource assemblies",
         "appsetting_files": "list[File]: Appsetting files",
         "nuget_info": "NugetInfo",
         "deps": "depset[DotnetAssemblyRuntimeInfo]: The direct and transitive runtime dependencies of the assembly",
diff --git a/dotnet/private/rules/csharp/actions/csharp_assembly.bzl b/dotnet/private/rules/csharp/actions/csharp_assembly.bzl
@@ -350,6 +350,7 @@ def AssemblyAction(
         name = assembly_name,
         version = "1.0.0",  #TODO: Maybe make this configurable?
         libs = [out_dll] if not (is_analyzer or is_language_specific_analyzer) else [],
+        resource_assemblies = [],
         pdbs = [out_pdb] if out_pdb else [],
         xml_docs = [out_xml] if out_xml else [],
         data = data,
diff --git a/dotnet/private/rules/fsharp/actions/fsharp_assembly.bzl b/dotnet/private/rules/fsharp/actions/fsharp_assembly.bzl
@@ -303,6 +303,7 @@ def AssemblyAction(
         name = assembly_name,
         version = "1.0.0",  #TODO: Maybe make this configurable?
         libs = [out_dll],
+        resource_assemblies = [],
         pdbs = [out_pdb] if out_pdb else [],
         xml_docs = [out_xml] if out_xml else [],
         data = data,
diff --git a/dotnet/private/rules/nuget/imports.bzl b/dotnet/private/rules/nuget/imports.bzl
@@ -61,6 +61,7 @@ def _import_library(ctx):
         name = ctx.attr.library_name,
         version = ctx.attr.version,
         libs = ctx.files.libs,
+        resource_assemblies = ctx.files.resource_assemblies,
         # TODO: PDBs from nuget packages should also be forwarded
         pdbs = [],
         xml_docs = [],
@@ -126,6 +127,11 @@ import_library = rule(
             allow_files = True,  # [".dll"] currently does not work with empty file groups
             allow_empty = True,
         ),
+        "resource_assemblies": attr.label_list(
+            doc = "Resource assemblies",
+            allow_files = True,  # [".dll"] currently does not work with empty file groups
+            allow_empty = True,
+        ),
         "deps": attr.label_list(
             doc = "Other DLLs that this DLL depends on.",
             providers = [DotnetAssemblyRuntimeInfo, DotnetAssemblyCompileInfo],
@@ -181,6 +187,7 @@ def _import_dll(ctx):
         name = ctx.file.dll.basename[:-4],
         version = ctx.attr.version,
         libs = [ctx.file.dll],
+        resource_assemblies = [],
         pdbs = [],
         xml_docs = [],
         native = [],
diff --git a/dotnet/private/rules/nuget/nuget_archive.bzl b/dotnet/private/rules/nuget/nuget_archive.bzl
@@ -102,6 +102,15 @@ def _replace_non_standard_tfm(tfm):
 
     return tfm
 
+# A resource assembly is located at lib/<tfm>/<locale>/<assembly>.resources.dll
+def _process_resource_assembly(groups, tfm, file):
+    if groups["resource_assemblies"].get(tfm) == None:
+        groups["resource_assemblies"][tfm] = []
+
+    groups["resource_assemblies"][tfm].append(file)
+
+    return
+
 # This function processes a package file that has the following format:
 # <group>/<tfm>/<file>
 def _process_group_with_tfm(groups, group_name, file):
@@ -114,7 +123,7 @@ def _process_group_with_tfm(groups, group_name, file):
         return
 
     # If the folder is empty we do nothing
-    if file.find("/", tfm_end + 1) != -1:
+    if file.endswith(tfm) or file.endswith(tfm + "/"):
         return
 
     group = groups[group_name]
@@ -128,7 +137,11 @@ def _process_group_with_tfm(groups, group_name, file):
     if file.endswith("_._"):
         return
 
-    if not file.endswith(".dll") or file.endswith(".resources.dll"):
+    if group_name == "lib" and file.endswith(".resources.dll"):
+        _process_resource_assembly(groups, tfm, file)
+        return
+
+    if not file.endswith(".dll"):
         return
 
     group[tfm].append(file)
@@ -284,7 +297,6 @@ def _process_runtimes_file(groups, file):
     return
 
 def _process_key_and_file(groups, key, file):
-    # todo resource dlls
     if key == "lib":
         _process_group_with_tfm(groups, key, file)
     elif key == "ref":
@@ -391,6 +403,9 @@ def _nuget_archive_impl(ctx):
         },
         # Format: lib/<TFM>/<assembly>.dll
         "lib": {},
+        # Resource assemblies: https://learn.microsoft.com/en-us/nuget/create-packages/creating-localized-packages
+        # Format: lib/<TFM>/<locale>/<assembly>.resources.<dll|xml>
+        "resource_assemblies": {},
         # Format: ref/<TFM>/<assembly>.dll
         "ref": {},
         # See https://github.com/fsharp/fslang-design/blob/main/tooling/FST-1003-loading-type-provider-design-time-components.md
@@ -494,6 +509,7 @@ load("@rules_dotnet//dotnet/private/rules/nuget:nuget_archive.bzl", "tfm_filegro
 """ + "\n".join([
         _create_framework_select("libs", libs) or "filegroup(name = \"libs\", srcs = [])",
         _create_framework_select("refs", refs) or "filegroup(name = \"refs\", srcs = [])",
+        _create_framework_select("resource_assemblies", groups["resource_assemblies"]) or "filegroup(name = \"resource_assemblies\", srcs = [])",
         "filegroup(name = \"analyzers\", srcs = [%s])" % ",".join(["\n  \"%s\"" % a for a in groups.get("analyzers")["dotnet"]]),
         "filegroup(name = \"analyzers_csharp\", srcs = [%s])" % ",".join(["\n  \"%s\"" % a for a in groups.get("analyzers")["dotnet/cs"]]),
         "filegroup(name = \"analyzers_fsharp\", srcs = [%s])" % ",".join(["\n  \"%s\"" % a for a in groups.get("analyzers")["dotnet/fs"]]),
diff --git a/dotnet/private/rules/nuget/template.BUILD b/dotnet/private/rules/nuget/template.BUILD
@@ -15,6 +15,7 @@ import_library(
     native = ["@{PREFIX}.{ID_LOWER}.v{VERSION}//:native"],
     nupkg = "@{PREFIX}.{ID_LOWER}.v{VERSION}//:{ID_LOWER}.{VERSION}.nupkg",
     refs = ["@{PREFIX}.{ID_LOWER}.v{VERSION}//:refs"],
+    resource_assemblies = ["@{PREFIX}.{ID_LOWER}.v{VERSION}//:resource_assemblies"],
     sha512 = "{SHA_512}",
     targeting_pack_overrides = {TARGETING_PACK_OVERRIDES},
     version = "{VERSION}",
diff --git a/dotnet/private/rules/publish_binary/publish_binary.bzl b/dotnet/private/rules/publish_binary/publish_binary.bzl
@@ -18,6 +18,7 @@ def _copy_file(script_body, src, dst, is_windows):
 
 def _get_assembly_files(assembly_info, transitive_runtime_deps, deps_json_struct):
     libs = [] + assembly_info.libs
+    resource_assemblies = [] + assembly_info.resource_assemblies
     native = [] + assembly_info.native
     data = [] + assembly_info.data
     appsetting_files = assembly_info.appsetting_files.to_list()
@@ -37,7 +38,8 @@ def _get_assembly_files(assembly_info, transitive_runtime_deps, deps_json_struct
                         libs.append(file)
 
         data += dep.data
-    return (libs, native, data, appsetting_files)
+        resource_assemblies += dep.resource_assemblies
+    return (libs, resource_assemblies, native, data, appsetting_files)
 
 def _copy_to_publish(ctx, runtime_identifier, runtime_pack_info, binary_info, assembly_info, transitive_runtime_deps, deps_json_struct):
     is_windows = ctx.target_platform_has_constraint(ctx.attr._windows_constraint[platform_common.ConstraintValueInfo])
@@ -50,7 +52,7 @@ def _copy_to_publish(ctx, runtime_identifier, runtime_pack_info, binary_info, as
 
     _copy_file(script_body, binary_info.dll, main_dll_copy, is_windows = is_windows)
 
-    (libs, native, data, appsetting_files) = _get_assembly_files(assembly_info, transitive_runtime_deps, deps_json_struct)
+    (libs, resource_assemblies, native, data, appsetting_files) = _get_assembly_files(assembly_info, transitive_runtime_deps, deps_json_struct)
 
     # All managed DLLs are copied next to the app host in the publish directory
     for file in libs:
@@ -61,6 +63,17 @@ def _copy_to_publish(ctx, runtime_identifier, runtime_pack_info, binary_info, as
         inputs.append(file)
         _copy_file(script_body, file, output, is_windows = is_windows)
 
+    # Resource assemblies are copied next to the app host in the publish directory in a folder
+    # that has the same name as the locale of the resource assembly.
+    # Example: `de/MyAssembly.resources.dll`
+    for file in resource_assemblies:
+        locale = file.dirname.split("/")[-1]
+        output_dir = "{}/publish/{}/{}/{}".format(ctx.label.name, runtime_identifier, locale, file.basename)
+        output = ctx.actions.declare_file(output_dir)
+        outputs.append(output)
+        inputs.append(file)
+        _copy_file(script_body, file, output, is_windows = is_windows)
+
     # When publishing a self-contained binary, we need to copy the native DLLs to the
     # publish directory as well.
     for file in native:
diff --git a/dotnet/private/tests/resource_assemblies/BUILD.bazel b/dotnet/private/tests/resource_assemblies/BUILD.bazel
@@ -0,0 +1,53 @@
+"Tests for targeting pack conflicts with user provided dependencies."
+
+load("@aspect_bazel_lib//lib:diff_test.bzl", "diff_test")
+load("@aspect_bazel_lib//lib:run_binary.bzl", "run_binary")
+load(
+    "//dotnet:defs.bzl",
+    "csharp_binary",
+    "publish_binary",
+)
+
+csharp_binary(
+    name = "main",
+    srcs = ["Main.cs"],
+    target_frameworks = ["net9.0"],
+    deps = [
+        "@paket.rules_dotnet_dev_nuget_packages//humanizer.core",
+        "@paket.rules_dotnet_dev_nuget_packages//humanizer.core.de",
+        "@paket.rules_dotnet_dev_nuget_packages//humanizer.core.es",
+    ],
+)
+
+run_binary(
+    name = "run_main",
+    outs = ["actual"],
+    args = ["$@"],
+    tool = ":main",
+)
+
+diff_test(
+    name = "diff_test_main",
+    file1 = ":actual",
+    file2 = "expected_output",
+)
+
+publish_binary(
+    name = "publish_main",
+    binary = ":main",
+    self_contained = True,
+    target_framework = "net9.0",
+)
+
+run_binary(
+    name = "run_publish_main",
+    outs = ["actual_publish"],
+    args = ["$@"],
+    tool = ":publish_main",
+)
+
+diff_test(
+    name = "diff_test_publish_main",
+    file1 = ":actual_publish",
+    file2 = "expected_output",
+)
diff --git a/dotnet/private/tests/resource_assemblies/Main.cs b/dotnet/private/tests/resource_assemblies/Main.cs
@@ -0,0 +1,31 @@
+namespace ResourceAssembliesTest
+{
+    using System;
+    using Humanizer;
+    using System.Globalization;
+
+    class Program
+    {
+        static void Main(string[] args)
+        {
+            var outputFile = args[0];
+            if (string.IsNullOrEmpty(outputFile))
+            {
+                throw new ArgumentException("Output file path must be provided as the first argument.");
+            }
+
+            var date = DateTime.Now.AddYears(1);
+            var dateStringEnglish = date.Humanize(culture: CultureInfo.GetCultureInfo("en-US"));
+            var dateStringGerman = date.Humanize(culture: CultureInfo.GetCultureInfo("de-DE"));
+            var dateStringSpanish = date.Humanize(culture: CultureInfo.GetCultureInfo("es-ES"));
+
+            var cwd = System.IO.Directory.GetCurrentDirectory();
+            using (var writer = new System.IO.StreamWriter(outputFile))
+            {
+                writer.WriteLine($"English: {dateStringEnglish}");
+                writer.WriteLine($"German: {dateStringGerman}");
+                writer.WriteLine($"Spanish: {dateStringSpanish}");
+            }
+        }
+    }
+}
diff --git a/dotnet/private/tests/resource_assemblies/expected_output b/dotnet/private/tests/resource_assemblies/expected_output
@@ -0,0 +1,3 @@
+English: one year from now
+German: in einem Jahr
+Spanish: en un año
diff --git a/dotnet/private/tests/resource_assemblies/resource_assemblies.csproj b/dotnet/private/tests/resource_assemblies/resource_assemblies.csproj
@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <TargetFramework>net9.0</TargetFramework>
+    <EnableDefaultItems>false</EnableDefaultItems>
+    <IsPackable>false</IsPackable>
+  </PropertyGroup>
+  <ItemGroup>
+    <Compile Include="Main.cs" />
+  </ItemGroup>
+  <ItemGroup>
+    <PackageReference Include="Humanizer.Core" Version="3.0.0-beta.96" />
+    <PackageReference Include="Humanizer.Core.de" Version="3.0.0-beta.96" />
+    <PackageReference Include="Humanizer.Core.es" Version="3.0.0-beta.96" />
+  </ItemGroup>
+</Project>
diff --git a/paket.dependencies b/paket.dependencies
@@ -29,6 +29,9 @@ group rules_dotnet_dev_nuget_packages
     nuget Microsoft.CodeAnalysis.Analyzers 3.3.4
     nuget Microsoft.CodeAnalysis.CSharp 4.9.2
     nuget Microsoft.NETFramework.ReferenceAssemblies.net48 1.0.3
+    nuget Humanizer.Core 3.0.0-beta.96
+    nuget Humanizer.Core.es 3.0.0-beta.96
+    nuget Humanizer.Core.de 3.0.0-beta.96
 
 group rules_dotnet_nuget_packages
     framework: net9.0
diff --git a/paket.lock b/paket.lock
@@ -96,6 +96,14 @@ NUGET
     FSharp.Core (9.0.300)
     FSharp.Data (4.2.7)
       FSharp.Core (>= 4.7.2)
+    Humanizer.Core (3.0.0-beta.96)
+      System.Collections.Immutable (>= 8.0) - restriction: || (&& (== net9.0) (>= net48)) (&& (== net9.0) (< net8.0)) (== netstandard2.0) (== netstandard2.1)
+      System.ComponentModel.Annotations (>= 5.0) - restriction: || (&& (== net9.0) (>= net48)) (&& (== net9.0) (< net8.0)) (== netstandard2.0) (== netstandard2.1)
+      System.Memory (>= 4.5.5) - restriction: || (&& (== net9.0) (>= net48)) (&& (== net9.0) (< net8.0)) (== netstandard2.0) (== netstandard2.1)
+    Humanizer.Core.de (3.0.0-beta.96)
+      Humanizer.Core (3.0.0-beta.96)
+    Humanizer.Core.es (3.0.0-beta.96)
+      Humanizer.Core (3.0.0-beta.96)
     LibGit2Sharp (0.27.0-preview-0182)
       LibGit2Sharp.NativeBinaries (2.0.315-alpha.0.9)
     LibGit2Sharp.NativeBinaries (2.0.315-alpha.0.9)
@@ -118,6 +126,7 @@ NUGET
     System.Collections.Immutable (8.0)
       System.Memory (>= 4.5.5) - restriction: || (&& (== net9.0) (>= net462)) (&& (== net9.0) (< net6.0)) (== netstandard2.0) (== netstandard2.1)
       System.Runtime.CompilerServices.Unsafe (>= 6.0) - restriction: || (&& (== net9.0) (>= net462)) (&& (== net9.0) (< net6.0)) (&& (== net9.0) (< net7.0)) (== netstandard2.0) (== netstandard2.1)
+    System.ComponentModel.Annotations (5.0) - restriction: || (&& (== net9.0) (>= net48)) (&& (== net9.0) (< net8.0)) (== netstandard2.0) (== netstandard2.1)
     System.Memory (4.5.5)
       System.Buffers (>= 4.5.1) - restriction: || (&& (== net9.0) (>= monotouch)) (&& (== net9.0) (>= net461)) (&& (== net9.0) (< netcoreapp2.0)) (&& (== net9.0) (< netstandard1.1)) (&& (== net9.0) (< netstandard2.0)) (&& (== net9.0) (>= xamarinios)) (&& (== net9.0) (>= xamarinmac)) (&& (== net9.0) (>= xamarintvos)) (&& (== net9.0) (>= xamarinwatchos)) (== netstandard2.0) (== netstandard2.1)
       System.Numerics.Vectors (>= 4.4) - restriction: || (&& (== net9.0) (< netcoreapp2.0)) (== netstandard2.0) (== netstandard2.1)
