[dotnet/msbuild] Copy binding resource packages to output directories…

… together with CopyLocal assemblies. Fixes #13910. (#17806)

With a project structure like this:

* Executable project references a library project.
* The library project references a binding project (or assembly).

The binding project's assembly will be copied to the library project's
output directory during the build. Unless we also make sure any binding
resource packages are copied as well, the executable project won't find those,
and the final app won't contain any native bits from the binding project.

The solution is to add any binding resource packages to the list of
files to be copied to the library's output directory.

Fixes #13910.

dotnet/targets/Xamarin.Shared.Sdk.targets

@@ -1956,6 +1956,83 @@ global using nfloat = global::System.Runtime.InteropServices.NFloat%3B
 		</ItemGroup>
 	</Target>
 
+	<Target Name="_CopyLocalBindingResources" AfterTargets="ResolveAssemblyReferences" BeforeTargets="CopyFilesToOutputDirectory">
+		<!--
+
+			We need to copy binding resource packages (either zipped or as a
+			.resources bundle) together with the binding assembly when the
+			binding assembly is copied around. This typically happens when
+			another library project references the binding project, in which
+			case the ResolveAssemblyReference task will add the binding
+			library to the ReferenceCopyLocalPaths item group (when building
+			the library project), which will cause the binding assembly to be
+			copied to the output directory for the other library project.
+
+			If this isn't done, then any projects referencing the library
+			project (and not the binding project), won't see any binding
+			resource packages from the binding project.
+
+			This is not good (https://github.com/xamarin/xamarin-macios/issues/13910).
+
+			This is a target that runs after the ReferenceCopyLocalPaths item
+			group has been populated by the ResolveAssemblyReferences target,
+			and will add any binding resource packages to the
+			ReferenceCopyLocalPaths item group.
+
+			This is somewhat complicated by the fact that we can have
+			.resources bundles (i.e. directories), so we need to expand those
+			to all their contained files.
+
+		-->
+
+		<ItemGroup>
+			<!-- List all potential compressed binding resource packages next to the assemblies we're copying to the output directory -->
+			<_CompressedBindingPackagesFromReferencedAssembliesCandidates Include="@(ReferenceCopyLocalPaths -> '%(RootDir)%(Directory)%(Filename).resources.zip')" />
+			<!-- We only care about those that actually exist, and we don't want duplicates either -->
+			<_CompressedBindingPackagesFromReferencedAssemblies Include="@(_CompressedBindingPackagesFromReferencedAssembliesCandidates->Distinct())" Condition="Exists('%(Identity)')" />
+
+			<!-- List all potential binding resource packages next to the assemblies we're copying to the output directory -->
+			<_BindingPackagesFromReferencedAssembliesDirectoriesCandidates Include="@(ReferenceCopyLocalPaths -> '%(RootDir)%(Directory)%(Filename).resources')" />
+			<!-- We only care about those that actually exist, and we don't want duplicates either -->
+			<_BindingPackagesFromReferencedAssembliesDirectoriesExists Include="@(_BindingPackagesFromReferencedAssembliesDirectoriesCandidates->Distinct())" Condition="Exists('%(Identity)')" />
+		</ItemGroup>
+
+		<!--
+			We need to expand items in an item group using globs, which is
+			kind of tricky, because globs in item transformations aren't
+			treated as globs. The workaround is to use a custom task for this.
+
+			Note that this task should run remotely from Windows when there's
+			a Mac connected, but locally when there's not a Mac connected (for
+			Hot Restart builds for instance), so we're not conditioning this
+			task on IsMacEnabled.
+
+		-->
+		<GetFileSystemEntries
+			SessionId="$(BuildSessionId)"
+			DirectoryPath="@(_BindingPackagesFromReferencedAssembliesDirectoriesExists)"
+			Pattern="*"
+			Recursive="true"
+			IncludeDirectories="false"
+			>
+			<Output TaskParameter="Entries" ItemName="_BindingPackagesFromReferencedAssemblies" />
+		</GetFileSystemEntries>
+
+		<ItemGroup>
+			<!-- We need to set the 'DestinationSubDirectory' metadata to indicate the actual target directory for items we expanded using a wildcard -->
+			<_BindingPackagesFromReferencedAssembliesWithDestinationDir Include="@(_BindingPackagesFromReferencedAssemblies)">
+				<DestinationSubDirectory>$([System.IO.Path]::GetFileName('%(OriginalItemSpec)'))\$([System.IO.Path]::GetDirectoryName('%(RecursiveDir)'))\</DestinationSubDirectory>
+			</_BindingPackagesFromReferencedAssembliesWithDestinationDir>
+			<!-- Add what we found to ReferenceCopyLocalPaths. Note that binding resource packages should generally not be published, so we're setting PublishFolderType=None -->
+			<ReferenceCopyLocalPaths Include="@(_CompressedBindingPackagesFromReferencedAssemblies)">
+				<PublishFolderType>None</PublishFolderType>
+			</ReferenceCopyLocalPaths>
+			<ReferenceCopyLocalPaths Include="@(_BindingPackagesFromReferencedAssembliesWithDestinationDir)">
+				<PublishFolderType>None</PublishFolderType>
+			</ReferenceCopyLocalPaths>
+		</ItemGroup>
+	</Target>
+
 	<!-- Import existing targets -->
 
 	<PropertyGroup>

msbuild/Xamarin.MacDev.Tasks/Tasks/GetFileSystemEntriesTaskBase.cs

@@ -6,15 +6,17 @@
 using Microsoft.Build.Framework;
 using Microsoft.Build.Utilities;
 
+#nullable enable
+
 namespace Xamarin.MacDev.Tasks {
 	public abstract class GetFileSystemEntriesTaskBase : XamarinTask {
 		#region Inputs
 
 		[Required]
-		public string DirectoryPath { get; set; }
+		public ITaskItem [] DirectoryPath { get; set; } = Array.Empty<ITaskItem> ();
 
 		[Required]
-		public string Pattern { get; set; }
+		public string Pattern { get; set; } = string.Empty;
 
 		[Required]
 		public bool Recursive { get; set; }
@@ -26,18 +28,31 @@ public abstract class GetFileSystemEntriesTaskBase : XamarinTask {
 		#region Outputs
 
 		[Output]
-		public ITaskItem [] Entries { get; set; }
+		public ITaskItem [] Entries { get; set; } = Array.Empty<ITaskItem> ();
 
 		#endregion
 
 		public override bool Execute ()
 		{
 			var searchOption = Recursive ? SearchOption.AllDirectories : SearchOption.TopDirectoryOnly;
-			var entriesFullPath = IncludeDirectories ?
-				Directory.GetFileSystemEntries (DirectoryPath, Pattern, searchOption) :
-				Directory.GetFiles (DirectoryPath, Pattern, searchOption);
-
-			Entries = entriesFullPath.Select (v => new TaskItem (v)).ToArray ();
+			var entries = new List<ITaskItem> ();
+			foreach (var item in DirectoryPath) {
+				var path = item.ItemSpec.TrimEnd ('\\', '/');
+				var entriesFullPath = IncludeDirectories ?
+					Directory.GetFileSystemEntries (path, Pattern, searchOption) :
+					Directory.GetFiles (path, Pattern, searchOption);
+
+				foreach (var entry in entriesFullPath) {
+					var recursiveDir = entry.Substring (path.Length + 1);
+					var newItem = new TaskItem (entry);
+					item.CopyMetadataTo (newItem);
+					newItem.SetMetadata ("RecursiveDir", recursiveDir);
+					newItem.SetMetadata ("OriginalItemSpec", item.ItemSpec);
+					entries.Add (newItem);
+				}
+			}
+
+			Entries = entries.ToArray ();
 
 			return !Log.HasLoggedErrors;
 		}

tests/dotnet/BindingWithUncompressedResourceBundle/ApiDefinition.cs

@@ -0,0 +1,7 @@
+using Foundation;
+
+namespace BindingWithUncompressedResourceBundle {
+	[BaseType (typeof (NSObject))]
+	interface MyNativeClass {
+	}
+}

tests/dotnet/BindingWithUncompressedResourceBundle/MacCatalyst/ApiDefinition.cs

@@ -0,0 +1,7 @@
+using Foundation;
+
+namespace BindingWithUncompressedResourceBundle {
+	[BaseType (typeof (NSObject))]
+	interface MyNativeClass {
+	}
+}

tests/dotnet/BindingWithUncompressedResourceBundle/MacCatalyst/BindingWithUncompressedResourceBundle.csproj

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project Sdk="Microsoft.NET.Sdk">
+	<PropertyGroup>
+		<TargetFramework>net$(BundledNETCoreAppTargetFrameworkVersion)-maccatalyst</TargetFramework>
+	</PropertyGroup>
+	<Import Project="..\shared.csproj" />
+</Project>
+

tests/dotnet/BindingWithUncompressedResourceBundle/MacCatalyst/Makefile

@@ -0,0 +1 @@
+include ../shared.mk

tests/dotnet/BindingWithUncompressedResourceBundle/MacCatalyst/MyClass.cs

@@ -0,0 +1,8 @@
+using System;
+namespace BindingWithUncompressedResourceBundle {
+	public class MyClass {
+		public MyClass ()
+		{
+		}
+	}
+}

tests/dotnet/BindingWithUncompressedResourceBundle/MacCatalyst/StructsAndEnums.cs

@@ -0,0 +1,6 @@
+namespace BindingWithUncompressedResourceBundle {
+	public struct MyStruct {
+		public int A;
+		public int B;
+	}
+}

tests/dotnet/BindingWithUncompressedResourceBundle/MyClass.cs

@@ -0,0 +1,8 @@
+using System;
+namespace BindingWithUncompressedResourceBundle {
+	public class MyClass {
+		public MyClass ()
+		{
+		}
+	}
+}

tests/dotnet/BindingWithUncompressedResourceBundle/StructsAndEnums.cs

@@ -0,0 +1,6 @@
+namespace BindingWithUncompressedResourceBundle {
+	public struct MyStruct {
+		public int A;
+		public int B;
+	}
+}

tests/dotnet/BindingWithUncompressedResourceBundle/iOS/ApiDefinition.cs

@@ -0,0 +1,7 @@
+using Foundation;
+
+namespace BindingWithUncompressedResourceBundle {
+	[BaseType (typeof (NSObject))]
+	interface MyNativeClass {
+	}
+}

tests/dotnet/BindingWithUncompressedResourceBundle/iOS/BindingWithUncompressedResourceBundle.csproj

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project Sdk="Microsoft.NET.Sdk">
+	<PropertyGroup>
+		<TargetFramework>net$(BundledNETCoreAppTargetFrameworkVersion)-ios</TargetFramework>
+	</PropertyGroup>
+	<Import Project="..\shared.csproj" />
+</Project>
+

tests/dotnet/BindingWithUncompressedResourceBundle/iOS/Makefile

@@ -0,0 +1 @@
+include ../shared.mk

tests/dotnet/BindingWithUncompressedResourceBundle/iOS/MyClass.cs

@@ -0,0 +1,8 @@
+using System;
+namespace BindingWithUncompressedResourceBundle {
+	public class MyClass {
+		public MyClass ()
+		{
+		}
+	}
+}

tests/dotnet/BindingWithUncompressedResourceBundle/iOS/StructsAndEnums.cs

@@ -0,0 +1,6 @@
+namespace BindingWithUncompressedResourceBundle {
+	public struct MyStruct {
+		public int A;
+		public int B;
+	}
+}

tests/dotnet/BindingWithUncompressedResourceBundle/macOS/ApiDefinition.cs

@@ -0,0 +1,7 @@
+using Foundation;
+
+namespace BindingWithUncompressedResourceBundle {
+	[BaseType (typeof (NSObject))]
+	interface MyNativeClass {
+	}
+}

tests/dotnet/BindingWithUncompressedResourceBundle/macOS/BindingWithUncompressedResourceBundle.csproj

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project Sdk="Microsoft.NET.Sdk">
+	<PropertyGroup>
+		<TargetFramework>net$(BundledNETCoreAppTargetFrameworkVersion)-macos</TargetFramework>
+	</PropertyGroup>
+	<Import Project="..\shared.csproj" />
+</Project>
+

tests/dotnet/BindingWithUncompressedResourceBundle/macOS/Makefile

@@ -0,0 +1 @@
+include ../shared.mk

tests/dotnet/BindingWithUncompressedResourceBundle/macOS/MyClass.cs

@@ -0,0 +1,8 @@
+using System;
+namespace BindingWithUncompressedResourceBundle {
+	public class MyClass {
+		public MyClass ()
+		{
+		}
+	}
+}

tests/dotnet/BindingWithUncompressedResourceBundle/macOS/StructsAndEnums.cs

@@ -0,0 +1,6 @@
+namespace BindingWithUncompressedResourceBundle {
+	public struct MyStruct {
+		public int A;
+		public int B;
+	}
+}

tests/dotnet/BindingWithUncompressedResourceBundle/shared.csproj

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project>
+	<PropertyGroup>
+		<IsBindingProject>true</IsBindingProject>
+	</PropertyGroup>
+
+	<Import Project="../../common/shared-dotnet.csproj" />
+
+	<ItemGroup>
+		<ObjcBindingApiDefinition Include="ApiDefinition.cs" />
+		<ObjcBindingCoreSource Include="StructsAndEnums.cs" />
+		<NativeReference Include="..\..\..\test-libraries\.libs\$(NativeLibName)\libtest.a">
+			<Kind>Static</Kind>
+		</NativeReference>
+	</ItemGroup>
+</Project>

tests/dotnet/BindingWithUncompressedResourceBundle/shared.mk

@@ -0,0 +1,2 @@
+TOP=../../../..
+include $(TOP)/tests/common/shared-dotnet.mk

tests/dotnet/BindingWithUncompressedResourceBundle/tvOS/ApiDefinition.cs

@@ -0,0 +1,7 @@
+using Foundation;
+
+namespace BindingWithUncompressedResourceBundle {
+	[BaseType (typeof (NSObject))]
+	interface MyNativeClass {
+	}
+}

tests/dotnet/BindingWithUncompressedResourceBundle/tvOS/BindingWithUncompressedResourceBundle.csproj

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project Sdk="Microsoft.NET.Sdk">
+	<PropertyGroup>
+		<TargetFramework>net$(BundledNETCoreAppTargetFrameworkVersion)-tvos</TargetFramework>
+	</PropertyGroup>
+	<Import Project="..\shared.csproj" />
+</Project>
+

tests/dotnet/BindingWithUncompressedResourceBundle/tvOS/Makefile

@@ -0,0 +1 @@
+include ../shared.mk

tests/dotnet/BindingWithUncompressedResourceBundle/tvOS/MyClass.cs

@@ -0,0 +1,8 @@
+using System;
+namespace BindingWithUncompressedResourceBundle {
+	public class MyClass {
+		public MyClass ()
+		{
+		}
+	}
+}

tests/dotnet/BindingWithUncompressedResourceBundle/tvOS/StructsAndEnums.cs

@@ -0,0 +1,6 @@
+namespace BindingWithUncompressedResourceBundle {
+	public struct MyStruct {
+		public int A;
+		public int B;
+	}
+}

tests/dotnet/LibraryReferencingBindingLibrary/Library.cs

@@ -0,0 +1,10 @@
+using System;
+
+namespace LibraryReferencingBindingLibrary {
+	public class Library {
+		public static void DoSomething ()
+		{
+			Console.WriteLine (typeof (MyClassLibrary.MyClass));
+		}
+	}
+}

tests/dotnet/LibraryReferencingBindingLibrary/MacCatalyst/LibraryReferencingBindingLibrary.csproj

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project Sdk="Microsoft.NET.Sdk">
+	<PropertyGroup>
+		<TargetFramework>net$(BundledNETCoreAppTargetFrameworkVersion)-maccatalyst</TargetFramework>
+	</PropertyGroup>
+	<Import Project="..\shared.csproj" />
+</Project>

tests/dotnet/LibraryReferencingBindingLibrary/MacCatalyst/Makefile

@@ -0,0 +1 @@
+include ../shared.mk

tests/dotnet/LibraryReferencingBindingLibrary/Makefile

@@ -0,0 +1,2 @@
+TOP=../../..
+include $(TOP)/tests/common/shared-dotnet-test.mk

tests/dotnet/LibraryReferencingBindingLibrary/iOS/LibraryReferencingBindingLibrary.csproj

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project Sdk="Microsoft.NET.Sdk">
+	<PropertyGroup>
+		<TargetFramework>net$(BundledNETCoreAppTargetFrameworkVersion)-ios</TargetFramework>
+	</PropertyGroup>
+	<Import Project="..\shared.csproj" />
+</Project>

tests/dotnet/LibraryReferencingBindingLibrary/iOS/Makefile

@@ -0,0 +1 @@
+include ../shared.mk

tests/dotnet/LibraryReferencingBindingLibrary/macOS/LibraryReferencingBindingLibrary.csproj

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project Sdk="Microsoft.NET.Sdk">
+	<PropertyGroup>
+		<TargetFramework>net$(BundledNETCoreAppTargetFrameworkVersion)-macos</TargetFramework>
+	</PropertyGroup>
+	<Import Project="..\shared.csproj" />
+</Project>

tests/dotnet/LibraryReferencingBindingLibrary/macOS/Makefile

@@ -0,0 +1 @@
+include ../shared.mk

tests/dotnet/LibraryReferencingBindingLibrary/shared.csproj

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project>
+	<Import Project="../../common/shared-dotnet.csproj" />
+
+	<ItemGroup>
+		<Compile Include="../*.cs" />
+		<ProjectReference Include="../../BindingWithDefaultCompileInclude/$(_PlatformName)/BindingWithDefaultCompileInclude.csproj" />
+		<ProjectReference Include="../../BindingWithUncompressedResourceBundle/$(_PlatformName)/BindingWithUncompressedResourceBundle.csproj" />
+		<ProjectReference Include="../../../bindings-framework-test/dotnet/$(_PlatformName)/bindings-framework-test.csproj" />
+	</ItemGroup>
+</Project>

tests/dotnet/LibraryReferencingBindingLibrary/shared.mk

@@ -0,0 +1,2 @@
+TOP=../../../..
+include $(TOP)/tests/common/shared-dotnet.mk

tests/dotnet/LibraryReferencingBindingLibrary/tvOS/LibraryReferencingBindingLibrary.csproj

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project Sdk="Microsoft.NET.Sdk">
+	<PropertyGroup>
+		<TargetFramework>net$(BundledNETCoreAppTargetFrameworkVersion)-tvos</TargetFramework>
+	</PropertyGroup>
+	<Import Project="..\shared.csproj" />
+</Project>

tests/dotnet/LibraryReferencingBindingLibrary/tvOS/Makefile

@@ -0,0 +1 @@
+include ../shared.mk