[Swift shipping] Setup MacCatalyst tests on the CI

.gitignore

@@ -203,4 +203,4 @@ launchSettings.json
 # Testing artifacts
 testing/
 src/samples/
-GeneratedBindings/
+GeneratedBindings/

Directory.Build.props

@@ -1,5 +1,5 @@
 <Project>
-  <Import Project="Sdk.props" Sdk="Microsoft.DotNet.Arcade.Sdk" />
+  <Import Condition="'$(UseMaui)' != 'true'" Project="Sdk.props" Sdk="Microsoft.DotNet.Arcade.Sdk" />
 
   <PropertyGroup>
     <Copyright>$(CopyrightNetFoundation)</Copyright>

Directory.Build.targets

@@ -10,5 +10,5 @@
 
   <Import Condition="'$(IsTestProject)' == 'true'" Project="$(RepositoryEngineeringDir)testing\runsettings.targets" />
 
-  <Import Project="Sdk.targets" Sdk="Microsoft.DotNet.Arcade.Sdk" />
+  <Import Condition="'$(UseMaui)' != 'true'" Project="Sdk.targets" Sdk="Microsoft.DotNet.Arcade.Sdk" />
 </Project>

NuGet.config

@@ -9,6 +9,7 @@
     <add key="dotnet-eng" value="https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-eng/nuget/v3/index.json" />
     <add key="dotnet9" value="https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet9/nuget/v3/index.json" />
     <add key="dotnet-tools" value="https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-tools/nuget/v3/index.json" />
+    <add key="test-device-runners" value="https://pkgs.dev.azure.com/mattleibow/OpenSource/_packaging/test-device-runners/nuget/v3/index.json" />
   </packageSources>
   <disabledPackageSources>
     <clear />

eng/pipelines/common/templates/build-job.yml

@@ -52,14 +52,14 @@ jobs:
                 -c $(_BuildConfig)
                 $(_testBuildArg)
                 /p:TargetPlatform=${{ parameters.archType }}
-        displayName: Build and Test
+        displayName: Build and test
 
-      - script: ./verify.sh
+      - script: ./dotnet.sh format --exclude artifacts --verify-no-changes --verbosity detailed
         displayName: Verify code formatting
 
       - ${{ if and(eq(parameters.bindings.isBindingsBuild, true), ne(parameters.osGroup, 'Windows_NT')) }}:
         - script: ./generate.sh --configuration $(_BuildConfig) ${{ parameters.bindings.scriptArgs }}
-          displayName: Generate Bindings
+          displayName: Generate bindings
 
       - ${{ if eq(parameters.isOfficialBuild, true) }}:
         - template: /eng/pipelines/common/upload-intermediate-artifacts-step.yml

eng/pipelines/common/templates/test-job.yml

@@ -0,0 +1,79 @@
+parameters:
+  variables: {}
+  osGroup: ''
+  platform: ''
+  archType: ''
+  container: ''
+  pool: {}
+
+jobs:
+
+- template: /eng/common/templates/jobs/jobs.yml
+  parameters:
+    enableTelemetry: true
+    helixRepo: dotnet/runtimelab
+    pool: ${{ parameters.pool }}
+    enableMicrobuild: true
+    graphFileGeneration:
+      enabled: false
+      includeToolset: false
+
+    jobs:
+    - job: ${{ format('{0}_{1}_{2}', parameters.osGroup, parameters.platform, parameters.archType) }}
+      displayName: ${{ format('{0} {1} {2}', parameters.osGroup, parameters.platform, parameters.archType) }}
+      strategy:
+        matrix:
+          Release:
+            _BuildConfig: Release
+          Debug:
+            _BuildConfig: Debug
+
+      steps:
+      # Use .NET 9 as MAUI workloads are not available for the default SDK
+      - script: |
+          cat << 'EOF' > global.json
+          {
+            "sdk": {
+              "version": "9.0.102",
+              "allowPrerelease": true,
+              "rollForward": "major"
+            },
+            "tools": {
+              "dotnet": "9.0.102",
+              "runtimes": {
+                "dotnet": [
+                  "$(MicrosoftNETCoreAppVersion)"
+                ]
+              }
+            },
+            "msbuild-sdks": {
+              "Microsoft.DotNet.Arcade.Sdk": "10.0.0-beta.24515.3"
+            }
+          }
+          EOF
+          ./build.sh
+          ./dotnet.sh workload install maui maccatalyst --version 9.0.103 --source https://api.nuget.org/v3/index.json
+          ./dotnet.sh new tool-manifest && ./dotnet.sh tool install microsoft.dotnet.xharness.cli --version "9.0.0-prerelease*"
+          sudo xcode-select -s /Applications/Xcode_16.2.app/Contents/Developer
+        displayName: Install dependencies
+
+      - script: |
+          ./dotnet.sh build ./src/Swift.Bindings/tests/FrameworkTests/Swift.Bindings.Framework.Tests.csproj \
+          -f net9.0-${{ parameters.platform }} \
+          -c $(_BuildConfig) \
+          -r ${{ parameters.platform }}-${{ parameters.archType }} \
+          /p:UseMaui=true
+        displayName: Publish app
+
+      - script: |
+          ./dotnet.sh xharness apple test \
+          --target ${{ parameters.platform }} \
+          --timeout="00:02:00" \
+          --launch-timeout=00:06:00 \
+          --app ./src/Swift.Bindings/tests/FrameworkTests/bin/$(_BuildConfig)/net9.0-${{ parameters.platform }}/${{ parameters.platform }}-${{ parameters.archType }}/Swift.Bindings.Framework.Tests.app \
+          --output-directory artifacts
+        displayName: Run device tests
+
+      - script: |
+          cat artifacts/Swift.Bindings.Framework.Tests.log
+        displayName: Display logs

eng/pipelines/runtimelab.yml

@@ -53,21 +53,18 @@ stages:
     - template: /eng/pipelines/common/templates/build-job.yml
       parameters:
         osGroup: OSX
-        archType: arm64
+        archType: x64
         runTests: true
         pool:
           vmImage: 'macOS-latest'
         bindings:
           isBindingsBuild: true
-          scriptArgs: '--platform MacOSX --arch arm64e-apple-macos --framework StoreKit'
+          scriptArgs: '--platform MacOSX --arch x86_64-apple-macos --framework StoreKit'
 
-    - template: /eng/pipelines/common/templates/build-job.yml
+    - template: /eng/pipelines/common/templates/test-job.yml
       parameters:
         osGroup: OSX
+        platform: maccatalyst
         archType: x64
-        runTests: true
         pool:
           vmImage: 'macOS-latest'
-        bindings:
-          isBindingsBuild: true
-          scriptArgs: '--platform MacOSX --arch x86_64-apple-macos --framework StoreKit'

generate.sh

@@ -80,7 +80,7 @@ function ExtractABI {
     local framework=$1
 
     echo "Generating ABI for framework '$framework', platform '$platform', architecture '$arch'"
-    
+
     local sdk_path=$(xcrun -sdk $(echo "$platform" | tr '[:upper:]' '[:lower:]') --show-sdk-path)
     local swift_interface_path="$(xcode-select -p)/Platforms/${platform}.platform/Developer/SDKs/${platform}.sdk/System/Library/Frameworks/${framework}.framework/Versions/Current/Modules/${framework}.swiftmodule/${arch}.swiftinterface"
 

src/Dynamo/src/Dynamo.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>net10.0</TargetFramework>
+    <TargetFramework>net9.0</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>

src/Dynamo/tests/Dynamo.Unit.Tests.csproj

@@ -1,6 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <TargetFramework>net10.0</TargetFramework>
+    <TargetFramework>net9.0</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>disable</Nullable>
     <IsPackable>false</IsPackable>

src/Swift.Bindings/tests/FrameworkTests/MauiProgram.cs

@@ -0,0 +1,28 @@
+using DeviceRunners.UITesting;
+using DeviceRunners.VisualRunners;
+using DeviceRunners.XHarness;
+using Microsoft.Extensions.Logging;
+using Microsoft.Maui.Hosting;
+
+namespace BindingsGeneration.FrameworkTests;
+
+public static class MauiProgram
+{
+	public static MauiApp CreateMauiApp()
+	{
+		var builder = MauiApp.CreateBuilder();
+		builder
+			.ConfigureUITesting()
+			.UseXHarnessTestRunner(conf => conf
+				.AddTestAssembly(typeof(MauiProgram).Assembly)
+				.AddXunit())
+			.UseVisualTestRunner(conf => conf
+				.AddConsoleResultChannel()
+				.AddTestAssembly(typeof(MauiProgram).Assembly)
+				.AddXunit());
+
+		builder.Logging.AddDebug();
+
+		return builder.Build();
+	}
+}

src/Swift.Bindings/tests/FrameworkTests/Platforms/MacCatalyst/AppDelegate.cs

@@ -0,0 +1,9 @@
+using Foundation;
+
+namespace BindingsGeneration.FrameworkTests;
+
+[Register("AppDelegate")]
+public class AppDelegate : MauiUIApplicationDelegate
+{
+	protected override MauiApp CreateMauiApp() => MauiProgram.CreateMauiApp();
+}

src/Swift.Bindings/tests/FrameworkTests/Platforms/MacCatalyst/Entitlements.plist

@@ -0,0 +1,14 @@
+<?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">
+    <!-- See https://aka.ms/maui-publish-app-store#add-entitlements for more information about adding entitlements.-->
+    <dict>
+        <!-- App Sandbox must be enabled to distribute a MacCatalyst app through the Mac App Store. -->
+        <key>com.apple.security.app-sandbox</key>
+        <true/>
+        <!-- When App Sandbox is enabled, this value is required to open outgoing network connections. -->
+        <key>com.apple.security.network.client</key>
+        <true/>
+    </dict>
+</plist>
+

src/Swift.Bindings/tests/FrameworkTests/Platforms/MacCatalyst/Info.plist

@@ -0,0 +1,38 @@
+<?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>
+    <!-- The Mac App Store requires you specify if the app uses encryption. -->
+    <!-- Please consult https://developer.apple.com/documentation/bundleresources/information_property_list/itsappusesnonexemptencryption -->
+    <!-- <key>ITSAppUsesNonExemptEncryption</key> -->
+    <!-- Please indicate <true/> or <false/> here. -->
+
+    <!-- Specify the category for your app here. -->
+    <!-- Please consult https://developer.apple.com/documentation/bundleresources/information_property_list/lsapplicationcategorytype -->
+    <!-- <key>LSApplicationCategoryType</key> -->
+    <!-- <string>public.app-category.YOUR-CATEGORY-HERE</string> -->
+	<key>UIDeviceFamily</key>
+	<array>
+		<integer>2</integer>
+	</array>
+	<key>UIRequiredDeviceCapabilities</key>
+	<array>
+		<string>arm64</string>
+	</array>
+	<key>UISupportedInterfaceOrientations</key>
+	<array>
+		<string>UIInterfaceOrientationPortrait</string>
+		<string>UIInterfaceOrientationLandscapeLeft</string>
+		<string>UIInterfaceOrientationLandscapeRight</string>
+	</array>
+	<key>UISupportedInterfaceOrientations~ipad</key>
+	<array>
+		<string>UIInterfaceOrientationPortrait</string>
+		<string>UIInterfaceOrientationPortraitUpsideDown</string>
+		<string>UIInterfaceOrientationLandscapeLeft</string>
+		<string>UIInterfaceOrientationLandscapeRight</string>
+	</array>
+	<key>XSAppIconAssets</key>
+	<string>Assets.xcassets/appicon.appiconset</string>
+</dict>
+</plist>

src/Swift.Bindings/tests/FrameworkTests/Platforms/MacCatalyst/Program.cs

@@ -0,0 +1,15 @@
+using ObjCRuntime;
+using UIKit;
+
+namespace BindingsGeneration.FrameworkTests;
+
+public class Program
+{
+	// This is the main entry point of the application.
+	static void Main(string[] args)
+	{
+		// if you want to use a different Application Delegate class from "AppDelegate"
+		// you can specify it here.
+		UIApplication.Main(args, null, typeof(AppDelegate));
+	}
+}

src/Swift.Bindings/tests/FrameworkTests/Platforms/iOS/AppDelegate.cs

@@ -0,0 +1,9 @@
+using Foundation;
+
+namespace BindingsGeneration.FrameworkTests;
+
+[Register("AppDelegate")]
+public class AppDelegate : MauiUIApplicationDelegate
+{
+	protected override MauiApp CreateMauiApp() => MauiProgram.CreateMauiApp();
+}

src/Swift.Bindings/tests/FrameworkTests/Platforms/iOS/Info.plist

@@ -0,0 +1,32 @@
+<?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>LSRequiresIPhoneOS</key>
+	<true/>
+	<key>UIDeviceFamily</key>
+	<array>
+		<integer>1</integer>
+		<integer>2</integer>
+	</array>
+	<key>UIRequiredDeviceCapabilities</key>
+	<array>
+		<string>arm64</string>
+	</array>
+	<key>UISupportedInterfaceOrientations</key>
+	<array>
+		<string>UIInterfaceOrientationPortrait</string>
+		<string>UIInterfaceOrientationLandscapeLeft</string>
+		<string>UIInterfaceOrientationLandscapeRight</string>
+	</array>
+	<key>UISupportedInterfaceOrientations~ipad</key>
+	<array>
+		<string>UIInterfaceOrientationPortrait</string>
+		<string>UIInterfaceOrientationPortraitUpsideDown</string>
+		<string>UIInterfaceOrientationLandscapeLeft</string>
+		<string>UIInterfaceOrientationLandscapeRight</string>
+	</array>
+	<key>XSAppIconAssets</key>
+	<string>Assets.xcassets/appicon.appiconset</string>
+</dict>
+</plist>

src/Swift.Bindings/tests/FrameworkTests/Platforms/iOS/Program.cs

@@ -0,0 +1,15 @@
+using ObjCRuntime;
+using UIKit;
+
+namespace BindingsGeneration.FrameworkTests;
+
+public class Program
+{
+	// This is the main entry point of the application.
+	static void Main(string[] args)
+	{
+		// if you want to use a different Application Delegate class from "AppDelegate"
+		// you can specify it here.
+		UIApplication.Main(args, null, typeof(AppDelegate));
+	}
+}

src/Swift.Bindings/tests/FrameworkTests/Platforms/iOS/Resources/PrivacyInfo.xcprivacy

@@ -0,0 +1,51 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+This is the minimum required version of the Apple Privacy Manifest for .NET MAUI apps.
+The contents below are needed because of APIs that are used in the .NET framework and .NET MAUI SDK.
+
+You are responsible for adding extra entries as needed for your application.
+
+More information: https://aka.ms/maui-privacy-manifest
+-->
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+    <key>NSPrivacyAccessedAPITypes</key>
+    <array>
+        <dict>
+            <key>NSPrivacyAccessedAPIType</key>
+            <string>NSPrivacyAccessedAPICategoryFileTimestamp</string>
+            <key>NSPrivacyAccessedAPITypeReasons</key>
+            <array>
+                <string>C617.1</string>
+            </array>
+        </dict>
+        <dict>
+            <key>NSPrivacyAccessedAPIType</key>
+            <string>NSPrivacyAccessedAPICategorySystemBootTime</string>
+            <key>NSPrivacyAccessedAPITypeReasons</key>
+            <array>
+                <string>35F9.1</string>
+            </array>
+        </dict>
+        <dict>
+            <key>NSPrivacyAccessedAPIType</key>
+            <string>NSPrivacyAccessedAPICategoryDiskSpace</string>
+            <key>NSPrivacyAccessedAPITypeReasons</key>
+            <array>
+                <string>E174.1</string>
+            </array>
+        </dict>
+        <!--
+            The entry below is only needed when you're using the Preferences API in your app.
+        <dict>
+            <key>NSPrivacyAccessedAPIType</key>
+            <string>NSPrivacyAccessedAPICategoryUserDefaults</string>
+            <key>NSPrivacyAccessedAPITypeReasons</key>
+            <array>
+                <string>CA92.1</string>
+            </array>
+        </dict> -->
+    </array>
+</dict>
+</plist>