Support Apple app bundle signing for already archived payloads

azure-pipelines.yml

@@ -196,10 +196,10 @@ stages:
               -ci
               -restore
               -test
-              -projects $(Build.SourcesDirectory)/tests/UnitTests.XHarness.iOS.Simulator.proj
-              /bl:$(Build.SourcesDirectory)/artifacts/log/$(_BuildConfig)/UnitTests.XHarness.iOS.Simulator.binlog
+              -projects $(Build.SourcesDirectory)/tests/UnitTests.XHarness.Apple.Simulator.proj
+              /bl:$(Build.SourcesDirectory)/artifacts/log/$(_BuildConfig)/UnitTests.XHarness.Apple.Simulator.binlog
               /p:RestoreUsingNuGetTargets=false
-            displayName: XHarness iOS Simulator Helix Testing
+            displayName: XHarness Apple Simulator Helix Testing
             env:
               SYSTEM_ACCESSTOKEN: $(System.AccessToken)
               HelixAccessToken: ''
@@ -209,10 +209,10 @@ stages:
               -ci
               -restore
               -test
-              -projects $(Build.SourcesDirectory)/tests/UnitTests.XHarness.iOS.Device.proj
-              /bl:$(Build.SourcesDirectory)/artifacts/log/$(_BuildConfig)/Helix.XHarness.iOS.Device.binlog
+              -projects $(Build.SourcesDirectory)/tests/UnitTests.XHarness.Apple.Device.proj
+              /bl:$(Build.SourcesDirectory)/artifacts/log/$(_BuildConfig)/Helix.XHarness.Apple.Device.binlog
               /p:RestoreUsingNuGetTargets=false
-            displayName: XHarness iOS Device Helix Testing
+            displayName: XHarness Apple Device Helix Testing
             env:
               SYSTEM_ACCESSTOKEN: $(System.AccessToken)
               HelixAccessToken: ''

src/Common/Microsoft.Arcade.Common/FileSystem.cs

@@ -33,7 +33,7 @@ public void WriteToFile(string path, string content)
             File.WriteAllText(path, content);
         }
 
-        public void FileCopy(string sourceFileName, string destFileName) => File.Copy(sourceFileName, destFileName);
+        public void CopyFile(string sourceFileName, string destFileName, bool overwrite = false) => File.Copy(sourceFileName, destFileName, overwrite);
 
         public Stream GetFileStream(string path, FileMode mode, FileAccess access) => new FileStream(path, mode, access);
 

src/Common/Microsoft.Arcade.Common/IFileSystem.cs

@@ -1,9 +1,9 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
-#nullable enable
 using System.IO;
 
+#nullable enable
 namespace Microsoft.Arcade.Common
 {
     public interface IFileSystem
@@ -28,7 +28,7 @@ public interface IFileSystem
 
         void DeleteFile(string path);
 
-        void FileCopy(string sourceFileName, string destFileName);
+        void CopyFile(string sourceFileName, string destFileName, bool overwrite = false);
 
         Stream GetFileStream(string path, FileMode mode, FileAccess access);
 

src/Common/Microsoft.Arcade.Common/IZipArchiveManager.cs

@@ -2,12 +2,20 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System.IO;
+using System.IO.Compression;
 using System.Threading.Tasks;
 
 namespace Microsoft.Arcade.Common
 {
     public interface IZipArchiveManager
     {
+        /// <summary>
+        /// Opens a given archive.
+        /// </summary>
+        /// <param name="archivePath">Path to the zip archive</param>
+        /// <param name="mode">Access mode</param>
+        ZipArchive OpenArchive(string archivePath, ZipArchiveMode mode);
+
         /// <summary>
         /// Loads an embedded resource and adds it to a target archive.
         /// </summary>

src/Common/Microsoft.Arcade.Common/ZipArchiveManager.cs

@@ -12,6 +12,9 @@ namespace Microsoft.Arcade.Common
 {
     public class ZipArchiveManager : IZipArchiveManager
     {
+        public ZipArchive OpenArchive(string archivePath, ZipArchiveMode mode)
+            => ZipFile.Open(archivePath, mode);
+
         public async Task AddResourceFileToArchive<TAssembly>(string archivePath, string resourceName, string targetFileName = null)
         {
             using Stream fileStream = GetResourceFileContent<TAssembly>(resourceName);

src/Common/Microsoft.Arcade.Test.Common/MockFileSystem.cs

@@ -54,7 +54,7 @@ public void DeleteFile(string path)
 
         public void WriteToFile(string path, string content) => Files[path] = content;
 
-        public void FileCopy(string sourceFileName, string destFileName) => Files[destFileName] = Files[sourceFileName];
+        public void CopyFile(string sourceFileName, string destFileName, bool overwrite = false) => Files[destFileName] = Files[sourceFileName];
 
         public Stream GetFileStream(string path, FileMode mode, FileAccess access)
             => FileExists(path) ? new MemoryStream() : new MockFileStream(this, path);

src/Microsoft.DotNet.Helix/Sdk.Tests/Microsoft.DotNet.Helix.Sdk.Tests/CreateXHarnessAppleWorkItemsTests.cs

@@ -92,7 +92,7 @@ public void AppleXHarnessWorkItemIsCreated()
             command.Should().Contain("--launch-timeout \"00:02:33\"");
 
             _profileProvider
-                .Verify(x => x.AddProfilesToBundles(It.Is<ITaskItem[]>(bundles => bundles.Any(b => b.ItemSpec == "/apps/System.Foo.app"))), Times.Once);
+                .Verify(x => x.AddProfileToPayload(payloadArchive, "ios-device_13.5"), Times.Once);
             _zipArchiveManager
                 .Verify(x => x.ArchiveDirectory("/apps/System.Foo.app", payloadArchive, true), Times.Once);
             _zipArchiveManager
@@ -238,7 +238,7 @@ public void ZippedAppIsProvided()
             command.Should().Contain("--launch-timeout \"00:02:33\"");
 
             _profileProvider
-                .Verify(x => x.AddProfilesToBundles(It.Is<ITaskItem[]>(bundles => bundles.Any(b => b.ItemSpec == "/apps/System.Foo.zip"))), Times.Once);
+                .Verify(x => x.AddProfileToPayload(payloadArchive, "ios-device_13.5"), Times.Once);
             _zipArchiveManager
                 .Verify(x => x.ArchiveDirectory("/apps/System.Foo.app", payloadArchive, true), Times.Never);
             _zipArchiveManager

src/Microsoft.DotNet.Helix/Sdk/CreateXHarnessAppleWorkItems.cs

@@ -73,8 +73,7 @@ public bool ExecuteTask(
             IZipArchiveManager zipArchiveManager,
             IFileSystem fileSystem)
         {
-            provisioningProfileProvider.AddProfilesToBundles(AppBundles);
-            var tasks = AppBundles.Select(bundle => PrepareWorkItem(zipArchiveManager, fileSystem, bundle));
+            var tasks = AppBundles.Select(bundle => PrepareWorkItem(zipArchiveManager, fileSystem, provisioningProfileProvider, bundle));
 
             WorkItems = Task.WhenAll(tasks).GetAwaiter().GetResult().Where(wi => wi != null).ToArray();
 
@@ -89,6 +88,7 @@ public bool ExecuteTask(
         private async Task<ITaskItem> PrepareWorkItem(
             IZipArchiveManager zipArchiveManager,
             IFileSystem fileSystem,
+            IProvisioningProfileProvider provisioningProfileProvider,
             ITaskItem appBundleItem)
         {
             var (workItemName, appFolderPath) = GetNameAndPath(appBundleItem, MetadataNames.AppBundlePath, fileSystem);
@@ -107,6 +107,17 @@ private async Task<ITaskItem> PrepareWorkItem(
                 Log.LogError($"App bundle not found in {appFolderPath}");
                 return null;
             }
+
+            // If we are re-using one .zip for multiple work items, we need to copy it to a new location
+            // because we will be changing the contents (we assume we don't mind otherwise)
+            if (isAlreadyArchived && appBundleItem.TryGetMetadata(MetadataNames.AppBundlePath, out string metadata) && !string.IsNullOrEmpty(metadata))
+            {
+                string appFolderDirectory = fileSystem.GetDirectoryName(appFolderPath);
+                string fileName = $"xharness-payload-{workItemName.ToLowerInvariant()}.zip";
+                string archiveCopyPath = fileSystem.PathCombine(appFolderDirectory, fileName);
+                fileSystem.CopyFile(appFolderPath, archiveCopyPath, overwrite: true);
+                appFolderPath = archiveCopyPath;
+            }
 
             var (testTimeout, workItemTimeout, expectedExitCode, customCommands) = ParseMetadata(appBundleItem);
 
@@ -142,7 +153,7 @@ private async Task<ITaskItem> PrepareWorkItem(
 
             if (includesTestRunner && expectedExitCode != 0 && customCommands != null)
             {
-                Log.LogWarning("The ExpectedExitCode property is ignored in the `apple test` scenario");
+                Log.LogWarning($"The {MetadataName.ExpectedExitCode} property is ignored in the `apple test` scenario");
             }
 
             bool resetSimulator = false;
@@ -172,6 +183,8 @@ private async Task<ITaskItem> PrepareWorkItem(
                 customCommands,
                 new[] { EntryPointScript, RunnerScript });
 
+            provisioningProfileProvider.AddProfileToPayload(payloadArchivePath, target);
+
             return CreateTaskItem(workItemName, payloadArchivePath, helixCommand, workItemTimeout);
         }