[msbuild] Promote '_PartialAppManifest' to a public item group ('Part…

…ialAppManifest'). Fixes #10646. (#12417)

* A couple of other changes to make sure we never overwrite the
  PartialAppManifest item group (as opposed to adding to it).
* Add tests.

Fixes #10646.

msbuild/Xamarin.MacDev.Tasks.Core/Tasks/CompileAppManifestTaskBase.cs

@@ -129,7 +129,7 @@ public override bool Execute ()
 			if (!Compile (plist))
 				return false;
 
-			// Merge with any partial plists generated by the Asset Catalog compiler...
+			// Merge with any partial plists...
 			MergePartialPlistTemplates (plist);
 
 			CompiledAppManifest = new TaskItem (Path.Combine (AppManifestBundleDirectory, "Info.plist"));

msbuild/Xamarin.MacDev.Tasks.Core/Tasks/CoreMLCompilerTaskBase.cs

@@ -201,6 +201,9 @@ public override bool Execute ()
 			}
 
 			BundleResources = bundleResources.ToArray ();
+
+			if (PartialAppManifests != null)
+				partialPlists.AddRange (PartialAppManifests);
 			PartialAppManifests = partialPlists.ToArray ();
 
 			return !Log.HasLoggedErrors;

msbuild/Xamarin.MacDev.Tasks.Core/Tasks/ReadItemsFromFileBase.cs

@@ -36,11 +36,16 @@ public override bool Execute ()
 		{
 			var document = XDocument.Load (this.File.ItemSpec);
 
-			this.Items = document.Root
+			var items = document.Root
 				.Elements (ItemGroupElementName)
 				.SelectMany (element => element.Elements ())
 				.Select (element => this.CreateItemFromElement (element))
-				.ToArray ();
+				.ToList ();
+
+			if (Items != null)
+				items.AddRange (Items);
+
+			Items = items.ToArray ();
 
 			return true;
 		}

msbuild/Xamarin.Shared/Xamarin.Shared.targets

@@ -286,7 +286,7 @@ Copyright (C) 2018 Microsoft. All rights reserved.
 
 	<Target Name="_CompileAppManifest"
 		DependsOnTargets="$(_CompileAppManifestDependsOn)"
-		Inputs="$(_AppManifest);@(_PartialAppManifest)"
+		Inputs="$(_AppManifest);@(PartialAppManifest)"
 		Outputs="$(_AppBundlePath)$(_AppBundleManifestRelativePath)Info.plist" >
 		<CompileAppManifest
 			SessionId="$(BuildSessionId)"
@@ -307,7 +307,7 @@ Copyright (C) 2018 Microsoft. All rights reserved.
 			IsWatchExtension="$(IsWatchExtension)"
 			IsXPCService="$(IsXPCService)"
 			MinimumOSVersion="$(_MinimumOSVersion)"
-			PartialAppManifests="@(_PartialAppManifest)"
+			PartialAppManifests="@(PartialAppManifest)"
 			ResourceRules="$(_PreparedResourceRules)"
 			TargetArchitectures="$(TargetArchitectures)"
 			TargetFrameworkMoniker="$(_ComputedTargetFrameworkMoniker)"
@@ -439,7 +439,7 @@ Copyright (C) 2018 Microsoft. All rights reserved.
 		<!-- If _BeforeCoreCompileImageAssets did not delete the generated items lists from _CoreCompileImageAsset, then we read them
 		     since that target won't run and we need the output items that are cached in those files, which includes full metadata -->
 		<ReadItemsFromFile File="$(_ACTool_PartialAppManifestCache)" Condition="Exists('$(_ACTool_PartialAppManifestCache)')">
-			<Output TaskParameter="Items" ItemName="_PartialAppManifest" />
+			<Output TaskParameter="Items" ItemName="PartialAppManifest" />
 		</ReadItemsFromFile>
 		<ReadItemsFromFile File="$(_ACTool_BundleResourceCache)" Condition="Exists('$(_ACTool_BundleResourceCache)')">
 			<Output TaskParameter="Items" ItemName="_BundleResourceWithLogicalName" />
@@ -476,7 +476,7 @@ Copyright (C) 2018 Microsoft. All rights reserved.
 			SdkVersion="$(_SdkVersion)"
 			TargetFrameworkMoniker="$(_ComputedTargetFrameworkMoniker)"
 			>
-			<Output TaskParameter="PartialAppManifest" ItemName="_PartialAppManifest" />
+			<Output TaskParameter="PartialAppManifest" ItemName="PartialAppManifest" />
 			<Output TaskParameter="BundleResources" ItemName="_BundleResourceWithLogicalName" />
 
 			<!-- Local items to be persisted to items files -->
@@ -485,7 +485,7 @@ Copyright (C) 2018 Microsoft. All rights reserved.
 		</ACTool>
 
 		<!-- Cache the generated outputs items for incremental build support -->
-		<WriteItemsToFile Items="@(_ACTool_PartialAppManifest)" ItemName="_PartialAppManifest" File="$(_ACTool_PartialAppManifestCache)" Overwrite="true" IncludeMetadata="true" />
+		<WriteItemsToFile Items="@(_ACTool_PartialAppManifest)" ItemName="PartialAppManifest" File="$(_ACTool_PartialAppManifestCache)" Overwrite="true" IncludeMetadata="true" />
 		<WriteItemsToFile Items="@(_ACTool_BundleResources)" ItemName="_BundleResourceWithLogicalName" File="$(_ACTool_BundleResourceCache)" Overwrite="true" IncludeMetadata="true" />
 		<ItemGroup>
 			<FileWrites Include="$(_ACTool_PartialAppManifestCache);$(_ACTool_BundleResourceCache)" />
@@ -703,7 +703,7 @@ Copyright (C) 2018 Microsoft. All rights reserved.
 		<!-- If _BeforeCompileCoreMLModels did not delete the generated items lists from _CoreCompileCoreMLModels, then we read them
 		     since that target won't run and we need the output items that are cached in those files, which includes full metadata -->
 		<ReadItemsFromFile File="$(_CoreMLModel_PartialAppManifestCache)" Condition="Exists('$(_CoreMLModel_PartialAppManifestCache)')">
-			<Output TaskParameter="Items" ItemName="_PartialAppManifest" />
+			<Output TaskParameter="Items" ItemName="PartialAppManifest" />
 		</ReadItemsFromFile>
 		<ReadItemsFromFile File="$(_CoreMLModel_BundleResourceCache)" Condition="Exists('$(_CoreMLModel_BundleResourceCache)')">
 			<Output TaskParameter="Items" ItemName="_BundleResourceWithLogicalName" />
@@ -727,15 +727,15 @@ Copyright (C) 2018 Microsoft. All rights reserved.
 			ResourcePrefix="$(_ResourcePrefix)"
 			SdkDevPath="$(_SdkDevPath)">
 			<Output TaskParameter="BundleResources" ItemName="_BundleResourceWithLogicalName" />
-			<Output TaskParameter="PartialAppManifests" ItemName="_PartialAppManifest" />
+			<Output TaskParameter="PartialAppManifests" ItemName="PartialAppManifest" />
 
 			<!-- Local items to be persisted to items files -->
 			<Output TaskParameter="PartialAppManifests" ItemName="_CoreMLModel_PartialAppManifest" />
 			<Output TaskParameter="BundleResources" ItemName="_CoreMLModel_BundleResources" />
 		</CoreMLCompiler>
 
 		<!-- Cache the generated outputs items for incremental build support -->
-		<WriteItemsToFile Items="@(_CoreMLModel_PartialAppManifest)" ItemName="_PartialAppManifest" File="$(_CoreMLModel_PartialAppManifestCache)" Overwrite="true" IncludeMetadata="true" />
+		<WriteItemsToFile Items="@(_CoreMLModel_PartialAppManifest)" ItemName="PartialAppManifest" File="$(_CoreMLModel_PartialAppManifestCache)" Overwrite="true" IncludeMetadata="true" />
 		<WriteItemsToFile Items="@(_CoreMLModel_BundleResources)" ItemName="_BundleResourceWithLogicalName" File="$(_CoreMLModel_BundleResourceCache)" Overwrite="true" IncludeMetadata="true" />
 		<ItemGroup>
 			<FileWrites Include="$(_CoreMLModel_PartialAppManifestCache);$(_CoreMLModel_BundleResourceCache)" />

tests/dotnet/MyPartialAppManifestApp/AppDelegate.cs

@@ -0,0 +1,19 @@
+using System;
+using System.Runtime.InteropServices;
+
+using Foundation;
+
+namespace MySimpleApp
+{
+	public class Program
+	{
+		static int Main (string[] args)
+		{
+			GC.KeepAlive (typeof (NSObject)); // prevent linking away the platform assembly
+
+			Console.WriteLine (Environment.GetEnvironmentVariable ("MAGIC_WORD"));
+
+			return args.Length;
+		}
+	}
+}

tests/dotnet/MyPartialAppManifestApp/MacCatalyst/Info.plist

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+</dict>
+</plist>

tests/dotnet/MyPartialAppManifestApp/MacCatalyst/Makefile

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

tests/dotnet/MyPartialAppManifestApp/MacCatalyst/MyPartialAppManifestApp.csproj

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

tests/dotnet/MyPartialAppManifestApp/Makefile

@@ -0,0 +1,20 @@
+TOP=../../..
+
+include $(TOP)/Make.config
+
+prepare:
+	cd .. && $(MAKE) global.json NuGet.config
+	rm -Rf */bin */obj
+
+all-ios: prepare
+	$(DOTNET6) build iOS/*.csproj /bl
+
+all-mac: prepare
+	$(DOTNET6) build macOS/*.csproj /bl
+
+run-mac:
+	./macOS/bin/Debug/net6.0-macos/osx-x64/$(notdir $(CURDIR)).app/Contents/MacOS/$(notdir $(CURDIR))
+
+diag:
+	cd .. && $(MAKE) global.json NuGet.config
+	$(DOTNET6) build /v:diag *binlog

tests/dotnet/MyPartialAppManifestApp/Partial.plist

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>Something</key>
+	<string>SomeValue</string>
+</dict>
+</plist>

tests/dotnet/MyPartialAppManifestApp/iOS/Info.plist

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<!-- We need this because some tests will build this project for 32-bit targets -->
+	<key>MinimumOSVersion</key>
+	<string>10.0</string></dict>
+</plist>

tests/dotnet/MyPartialAppManifestApp/iOS/Makefile

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

tests/dotnet/MyPartialAppManifestApp/iOS/MyPartialAppManifestApp.csproj

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

tests/dotnet/MyPartialAppManifestApp/macOS/Info.plist

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<!-- We need this because we'd otherwise default to the latest macOS version we support (currently 12.0), and we'll want to execute on earlier versions -->
+	<key>LSMinimumSystemVersion</key>
+	<string>11.0</string>
+</dict>
+</plist>

tests/dotnet/MyPartialAppManifestApp/macOS/Makefile

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

tests/dotnet/MyPartialAppManifestApp/macOS/MyPartialAppManifestApp.csproj

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

tests/dotnet/MyPartialAppManifestApp/shared.csproj

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project>
+	<PropertyGroup>
+		<OutputType>Exe</OutputType>
+
+		<ApplicationTitle>MyPartialAppManifestApp</ApplicationTitle>
+		<ApplicationId>com.xamarin.mypartialappmanifestapp</ApplicationId>
+		<ApplicationVersion>3.14</ApplicationVersion>
+	</PropertyGroup>
+
+	<ItemGroup>
+		<Compile Include="../*.cs" />
+		<None Include="Info.plist" />
+		<PartialAppManifest Include="../Partial.plist" />
+	</ItemGroup>
+</Project>

tests/dotnet/MyPartialAppManifestApp/shared.mk

@@ -0,0 +1,28 @@
+TOP=../../../..
+include $(TOP)/Make.config
+
+prepare:
+	$(Q) $(MAKE) -C $(TOP)/tests/dotnet copy-dotnet-config
+
+reload:
+	$(Q) rm -Rf $(TOP)/tests/dotnet/packages
+	$(Q) $(MAKE) -C $(TOP) -j8 all
+	$(Q) $(MAKE) -C $(TOP) -j8 install
+	$(Q) git clean -xfdq
+
+reload-and-build:
+	$(Q) $(MAKE) reload
+	$(Q) $(MAKE) build
+
+reload-and-run:
+	$(Q) $(MAKE) reload
+	$(Q) $(MAKE) run
+
+build: prepare
+	$(Q) $(DOTNET6) build /bl *.csproj $(MSBUILD_VERBOSITY) $(BUILD_ARGUMENTS)
+
+run: prepare
+	$(Q) $(DOTNET6) build /bl *.csproj $(MSBUILD_VERBOSITY) $(BUILD_ARGUMENTS) -t:Run
+
+diag: prepare
+	$(Q) $(DOTNET6) build /v:diag msbuild.binlog

tests/dotnet/MyPartialAppManifestApp/tvOS/Info.plist

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+</dict>
+</plist>

tests/dotnet/MyPartialAppManifestApp/tvOS/Makefile

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

tests/dotnet/MyPartialAppManifestApp/tvOS/MyPartialAppManifestApp.csproj

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

tests/dotnet/UnitTests/PartialAppManifestTest.cs

@@ -0,0 +1,34 @@
+using System.Collections.Generic;
+
+using NUnit.Framework;
+
+using Xamarin.Utils;
+using Xamarin.MacDev;
+
+namespace Xamarin.Tests {
+	public class PartialAppManifestTest : TestBaseClass {
+
+		[Test]
+		[TestCase (ApplePlatform.MacCatalyst, "maccatalyst-x64")]
+		public void Build (ApplePlatform platform, string runtimeIdentifiers)
+		{
+			var project = "MyPartialAppManifestApp";
+			Configuration.IgnoreIfIgnoredPlatform (platform);
+
+			var project_path = GetProjectPath (project, runtimeIdentifiers: runtimeIdentifiers, platform: platform, out var appPath);
+			Clean (project_path);
+			var properties = new Dictionary<string, string> (verbosity);
+			SetRuntimeIdentifiers (properties, runtimeIdentifiers);
+
+			DotNet.AssertBuild (project_path, properties);
+
+			var infoPlistPath = GetInfoPListPath (platform, appPath);
+			var infoPlist = PDictionary.FromFile (infoPlistPath);
+			Assert.AreEqual ("com.xamarin.mypartialappmanifestapp", infoPlist.GetString ("CFBundleIdentifier").Value, "CFBundleIdentifier");
+			Assert.AreEqual ("MyPartialAppManifestApp", infoPlist.GetString ("CFBundleDisplayName").Value, "CFBundleDisplayName");
+			Assert.AreEqual ("3.14", infoPlist.GetString ("CFBundleVersion").Value, "CFBundleVersion");
+			Assert.AreEqual ("3.14", infoPlist.GetString ("CFBundleShortVersionString").Value, "CFBundleShortVersionString");
+			Assert.AreEqual ("SomeValue", infoPlist.GetString ("Something").Value, "Something");
+		}
+	}
+}

tests/dotnet/UnitTests/ProjectTest.cs

@@ -641,21 +641,6 @@ void AssertThatLinkerDidNotExecute (ExecutionResult result)
 			Assert.That (output, Does.Not.Contain ("LinkerConfiguration:"), "Custom steps did not run as expected.");
 		}
 
-		string GetInfoPListPath (ApplePlatform platform, string app_directory)
-		{
-			switch (platform) {
-			case ApplePlatform.iOS:
-			case ApplePlatform.TVOS:
-			case ApplePlatform.WatchOS:
-				return Path.Combine (app_directory, "Info.plist");
-			case ApplePlatform.MacOSX:
-			case ApplePlatform.MacCatalyst:
-				return Path.Combine (app_directory, "Contents", "Info.plist");
-			default:
-				throw new NotImplementedException ($"Unknown platform: {platform}");
-			}
-		}
-
 		void AssertAppContents (ApplePlatform platform, string app_directory)
 		{
 			var info_plist_path = GetInfoPListPath (platform, app_directory);

tests/dotnet/UnitTests/TestBaseClass.cs

@@ -77,5 +77,21 @@ protected void Clean (string project_path)
 				Directory.Delete (dir, true);
 			}
 		}
+
+		protected string GetInfoPListPath (ApplePlatform platform, string app_directory)
+		{
+			switch (platform) {
+			case ApplePlatform.iOS:
+			case ApplePlatform.TVOS:
+			case ApplePlatform.WatchOS:
+				return Path.Combine (app_directory, "Info.plist");
+			case ApplePlatform.MacOSX:
+			case ApplePlatform.MacCatalyst:
+				return Path.Combine (app_directory, "Contents", "Info.plist");
+			default:
+				throw new NotImplementedException ($"Unknown platform: {platform}");
+			}
+		}
+
 	}
 }