Run UI tests as part of CI

.github/workflows/ci-sample.yml

@@ -8,12 +8,17 @@ on:
   pull_request:
     branches: [ "main" ]
 
+env:
+  BUILD_CONFIGURATION: Release
+  CSPROJ_TO_BUILD: samples/Plugin.Maui.UITestHelpers.Sample/Plugin.Maui.UITestHelpers.Sample.csproj
+
 jobs:
   build-sample-ci:
 
     runs-on: windows-latest
 
     steps:
     - uses: actions/checkout@v4
-    - name: Build
-      run: dotnet build samples\Plugin.Maui.UITestHelpers.Sample.sln -c Release
+
+    - name: Build Sample App
+      run: dotnet build ${{ env.CSPROJ_TO_BUILD }} -c ${{ env.BUILD_CONFIGURATION }}

.github/workflows/ui-test-android.yml

@@ -0,0 +1,78 @@
+name: Run UI Tests Android
+
+on:
+  push:
+    branches: [ "main" ]
+    paths-ignore:
+      - "**.md"
+  pull_request:
+    branches: [ "main" ]
+
+env:
+  BUILD_CONFIGURATION: Release
+  CSPROJ_TO_BUILD: samples/Plugin.Maui.UITestHelpers.Sample/Plugin.Maui.UITestHelpers.Sample.csproj
+  APP_TO_TEST: samples/Plugin.Maui.UITestHelpers.Sample/bin/Release/net8.0-android/com.companyname.uitesthelperssample-Signed.apk
+  CSPROJ_TO_TEST: samples/UITests.Android/UITests.Android.csproj
+  APP_ID: com.companyname.uitesthelperssample
+  TARGET_FRAMEWORK: net8.0-android
+  TEST_EMULATOR_NAME: UITestEmu
+  ANDROID_EMULATOR_IMAGE: system-images;android-33;default;x86_64
+  SCREENCAPTURE_FOLDER: samples/UITests.Android/bin/Debug/net8.0
+  ARTIFACTS_PATH: ${{ github.workspace }}/output
+
+jobs:
+  ui-test-android:
+
+    runs-on: macos-13
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Restore Workload
+      run: dotnet workload restore --project ${{ env.CSPROJ_TO_BUILD }}
+
+    - name: Publish APK
+      run: dotnet publish ${{ env.CSPROJ_TO_BUILD }} -f ${{ env.TARGET_FRAMEWORK }}
+
+    - name: Install xharness
+      run: |
+        dotnet tool install Microsoft.DotNet.XHarness.CLI                                                   \
+            --global                                                                                        \
+            --add-source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-eng/nuget/v3/index.json \
+            --version "9.0.0-prerelease*"
+
+    - name: Boot Android emulator
+      run: |
+        ${ANDROID_SDK_ROOT}/cmdline-tools/latest/bin/sdkmanager --install '${{ env.ANDROID_EMULATOR_IMAGE }}'
+
+        echo "no" | ${ANDROID_SDK_ROOT}/cmdline-tools/latest/bin/avdmanager create avd --name ${{ env.TEST_EMULATOR_NAME }} --package '${{ env.ANDROID_EMULATOR_IMAGE }}' --force
+
+        ${ANDROID_HOME}/tools/emulator -avd ${{ env.TEST_EMULATOR_NAME }} -gpu guest -memory 2048 -no-snapshot -no-audio -no-boot-anim -no-window -partition-size 4096 &
+
+        # The device is now booting, or close to be booted
+        # We just wait until the sys.boot_completed property is set to 1.
+        while [ "`adb shell getprop sys.boot_completed | tr -d '\r' `" != "1" ] ;
+        do
+          echo "Still waiting for boot.."
+          sleep 10;
+        done
+
+    - name: Install App
+      run: xharness android install --app=${{ env.APP_TO_TEST }} --package-name=${{ env.APP_ID }} --output-directory=${{ env.ARTIFACTS_PATH }}/xharness-logs
+
+    - name: Install Appium
+      run: |
+        npm install -g appium
+        appium driver install uiautomator2
+
+    - name: Run UI Tests
+      run: dotnet test ${{ env.CSPROJ_TO_TEST }} --environment APPIUM_LOG_FILE=${{ env.ARTIFACTS_PATH }}/appium-logs/appium.log --environment APPID="${{ env.APP_ID }}"
+
+    - name: Publish Artifacts
+      uses: actions/upload-artifact@v4
+      if: always()
+      with:
+        name: logs-and-screenshots
+        path: |
+          ${{ env.ARTIFACTS_PATH }}/**/*.*
+          ${{ env.SCREENCAPTURE_FOLDER }}/*.png

.github/workflows/ui-test-ios.yml

@@ -0,0 +1,77 @@
+name: Run UI Tests iOS
+
+on:
+  push:
+    branches: [ "main" ]
+    paths-ignore:
+      - "**.md"
+  pull_request:
+    branches: [ "main" ]
+
+env:
+  # Release builds don't run on the Simulator
+  BUILD_CONFIGURATION: Debug
+  CSPROJ_TO_BUILD: samples/Plugin.Maui.UITestHelpers.Sample/Plugin.Maui.UITestHelpers.Sample.csproj
+  APP_TO_TEST: samples/Plugin.Maui.UITestHelpers.Sample/bin/Debug/net8.0-ios/iossimulator-arm64/Plugin.Maui.UITestHelpers.Sample.app
+  CSPROJ_TO_TEST: samples/UITests.iOS/UITests.iOS.csproj
+  APP_ID: com.companyname.uitesthelperssample
+  TARGET_FRAMEWORK: net8.0-ios
+  XCODE_VERSION: 15.2
+  TEST_SIM_NAME: UITestSim
+  SCREENCAPTURE_FOLDER: samples/UITests.iOS/bin/Debug/net8.0
+  ARTIFACTS_PATH: ${{ github.workspace }}/output
+
+jobs:
+  ui-test-ios:
+
+    runs-on: macos-14
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Select Xcode version
+      run: sudo xcode-select -s '/Applications/Xcode_${{ env.XCODE_VERSION }}.app/Contents/Developer'
+
+    - name: Restore Workload
+      run: dotnet workload restore --project ${{ env.CSPROJ_TO_BUILD }}
+
+    - name: Build App
+      run: dotnet build ${{ env.CSPROJ_TO_BUILD }} -f ${{ env.TARGET_FRAMEWORK }} -c ${{ env.BUILD_CONFIGURATION }}
+
+    - name: Install xharness
+      run: |
+        dotnet tool install Microsoft.DotNet.XHarness.CLI                                                   \
+            --global                                                                                        \
+            --add-source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-eng/nuget/v3/index.json \
+            --version "9.0.0-prerelease*"
+
+    - name: Install Appium
+      run: |
+        npm install -g appium
+        appium driver install xcuitest
+
+    - name: Create iOS Simulator
+      # This creates a iPhone 15 Pro Simulator with iOS 16.4
+      run: |
+        xharness apple simulators install ios-simulator_16.4
+        simudid=$(xcrun simctl create ${{ env.TEST_SIM_NAME }} com.apple.CoreSimulator.SimDeviceType.iPhone-13 com.apple.CoreSimulator.SimRuntime.iOS-16-4)
+        echo "SIM_UDID=$(echo $simudid)" >> $GITHUB_ENV
+        echo "Created Simulator UDID: $simudid"
+
+    - name: Install App
+      run: xharness apple install --app=${{ env.APP_TO_TEST }} --output-directory=${{ env.ARTIFACTS_PATH }}/xharness-logs --device="${{ env.SIM_UDID }}" --target=ios-simulator
+
+    - name: Run UI Tests
+      # We're passing on the values we used to create the Simulator with to the test project to find the correct one
+      run: |
+        dotnet test ${{ env.CSPROJ_TO_TEST }} --environment SIMNAME="${{ env.TEST_SIM_NAME }}" --environment SIMID="${{ env.SIM_UDID }}" \
+        --environment APPIUM_LOG_FILE=${{ env.ARTIFACTS_PATH }}/appium-logs/appium.log --environment APPID="${{ env.APP_ID }}"
+
+    - name: Publish Artifacts
+      uses: actions/upload-artifact@v4
+      if: always()
+      with:
+        name: logs-and-screenshots
+        path: |
+          ${{ env.ARTIFACTS_PATH }}/**/*.*
+          ${{ env.SCREENCAPTURE_FOLDER }}/*.png

.github/workflows/ui-test-macos.yml

@@ -0,0 +1,66 @@
+name: Run UI Tests macOS
+
+on:
+  push:
+    branches: [ "main" ]
+    paths-ignore:
+      - "**.md"
+  pull_request:
+    branches: [ "main" ]
+
+env:
+  BUILD_CONFIGURATION: Release
+  CSPROJ_TO_BUILD: samples/Plugin.Maui.UITestHelpers.Sample/Plugin.Maui.UITestHelpers.Sample.csproj
+  APP_TO_TEST: samples/Plugin.Maui.UITestHelpers.Sample/bin/Release/net8.0-maccatalyst/maccatalyst-arm64/Plugin.Maui.UITestHelpers.Sample.app
+  CSPROJ_TO_TEST: samples/UITests.macOS/UITests.macOS.csproj
+  APP_ID: com.companyname.uitesthelperssample
+  TARGET_FRAMEWORK: net8.0-maccatalyst
+  XCODE_VERSION: 15.2
+  SCREENCAPTURE_FOLDER: samples/UITests.macOS/bin/Debug/net8.0
+  ARTIFACTS_PATH: ${{ github.workspace }}/output
+
+jobs:
+  ui-test-macos:
+
+    runs-on: macos-14
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Select Xcode version
+      run: sudo xcode-select -s '/Applications/Xcode_${{ env.XCODE_VERSION }}.app/Contents/Developer'
+
+    - name: Restore Workload
+      run: dotnet workload restore --project ${{ env.CSPROJ_TO_BUILD }}
+
+    - name: Build App
+      run: dotnet build ${{ env.CSPROJ_TO_BUILD }} -f ${{ env.TARGET_FRAMEWORK }} -c ${{ env.BUILD_CONFIGURATION }}
+
+    - name: Install xharness
+      run: |
+        dotnet tool install Microsoft.DotNet.XHarness.CLI                                                   \
+            --global                                                                                        \
+            --add-source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-eng/nuget/v3/index.json \
+            --version "9.0.0-prerelease*"
+
+    - name: Install Appium
+      run: |
+        npm install -g appium
+        appium driver install mac2
+
+    - name: Install App
+      # Deploy the app by running it on this Mac
+      run: dotnet build ${{ env.CSPROJ_TO_BUILD }} -t:Run -f ${{ env.TARGET_FRAMEWORK }} -c ${{ env.BUILD_CONFIGURATION }}
+
+    - name: Run UI Tests
+      run: |
+        dotnet test ${{ env.CSPROJ_TO_TEST }} --environment APPIUM_LOG_FILE=${{ env.ARTIFACTS_PATH }}/appium-logs/appium.log --environment APPID="${{ env.APP_ID }}"
+
+    - name: Publish Artifacts
+      uses: actions/upload-artifact@v4
+      if: always()
+      with:
+        name: logs-and-screenshots
+        path: |
+          ${{ env.ARTIFACTS_PATH }}/**/*.*
+          ${{ env.SCREENCAPTURE_FOLDER }}/*.png

.github/workflows/ui-test-windows.yml

@@ -0,0 +1,50 @@
+name: Run UI Tests Windows
+
+on:
+  push:
+    branches: [ "main" ]
+    paths-ignore:
+      - "**.md"
+  pull_request:
+    branches: [ "main" ]
+
+env:
+  BUILD_CONFIGURATION: Release
+  CSPROJ_TO_BUILD: samples/Plugin.Maui.UITestHelpers.Sample/Plugin.Maui.UITestHelpers.Sample.csproj
+  APP_TO_TEST: samples/Plugin.Maui.UITestHelpers.Sample/bin/Release/net8.0-windows10.0.19041.0/win10-x64/Plugin.Maui.UITestHelpers.Sample.exe
+  CSPROJ_TO_TEST: samples/UITests.Windows/UITests.Windows.csproj
+  TARGET_FRAMEWORK: net8.0-windows10.0.19041.0
+  SCREENCAPTURE_FOLDER: samples/UITests.Windows/bin/Debug/net8.0
+  ARTIFACTS_PATH: ${{ github.workspace }}/output
+
+jobs:
+  ui-test-windows:
+
+    runs-on: windows-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Build App
+      run: dotnet build ${{ env.CSPROJ_TO_BUILD }} -f ${{ env.TARGET_FRAMEWORK }} -c ${{ env.BUILD_CONFIGURATION }}
+
+    - name: Install Appium
+      run: |
+        npm install -g appium
+        appium driver install --source=npm appium-windows-driver
+
+    - name: Run UI Tests
+      run: |
+        # Set environment variable separately because of https://github.com/dotnet/sdk/issues/40848
+        $absolutePath = ("${{ env.APP_TO_TEST }}" | Resolve-Path).Path
+        $env:APPID = $absolutePath
+        dotnet test ${{ env.CSPROJ_TO_TEST }} --environment APPIUM_LOG_FILE=${{ env.ARTIFACTS_PATH }}/appium-logs/appium.log
+
+    - name: Publish Artifacts
+      uses: actions/upload-artifact@v4
+      if: always()
+      with:
+        name: logs-and-screenshots
+        path: |
+          ${{ env.ARTIFACTS_PATH }}/**/*.*
+          ${{ env.SCREENCAPTURE_FOLDER }}/*.png

samples/Plugin.Maui.UITestHelpers.Sample.sln

@@ -1,12 +1,19 @@
-Microsoft Visual Studio Solution File, Format Version 12.00
+
+Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio Version 17
 VisualStudioVersion = 17.0.31611.283
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Plugin.Maui.UITestHelpers.Sample", "Plugin.Maui.UITestHelpers.Sample\Plugin.Maui.UITestHelpers.Sample.csproj", "{490BB138-9606-4FFF-8AAD-841C5B1ED059}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "UITests.Android", "UITests.Android\UITests.Android.csproj", "{6557E077-F81A-4D64-B3C4-A07BB1BD31D4}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "UITests.Android", "UITests.Android\UITests.Android.csproj", "{6557E077-F81A-4D64-B3C4-A07BB1BD31D4}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "UITests.Shared", "UITests.Shared\UITests.Shared.csproj", "{DFD0E4D0-3519-4B55-8B31-CC7AF8106AAE}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "UITests.Shared", "UITests.Shared\UITests.Shared.csproj", "{DFD0E4D0-3519-4B55-8B31-CC7AF8106AAE}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "UITests.iOS", "UITests.iOS\UITests.iOS.csproj", "{2B36F0AB-6CF2-4EE8-8561-3A436304B744}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "UITests.macOS", "UITests.macOS\UITests.macOS.csproj", "{74557CDA-CB45-4719-9A7D-DE35B10B7345}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "UITests.Windows", "UITests.Windows\UITests.Windows.csproj", "{1A0A722B-2D19-42C6-A306-1417A283B244}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
@@ -28,6 +35,18 @@ Global
 		{DFD0E4D0-3519-4B55-8B31-CC7AF8106AAE}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{DFD0E4D0-3519-4B55-8B31-CC7AF8106AAE}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{DFD0E4D0-3519-4B55-8B31-CC7AF8106AAE}.Release|Any CPU.Build.0 = Release|Any CPU
+		{2B36F0AB-6CF2-4EE8-8561-3A436304B744}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{2B36F0AB-6CF2-4EE8-8561-3A436304B744}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{2B36F0AB-6CF2-4EE8-8561-3A436304B744}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{2B36F0AB-6CF2-4EE8-8561-3A436304B744}.Release|Any CPU.Build.0 = Release|Any CPU
+		{74557CDA-CB45-4719-9A7D-DE35B10B7345}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{74557CDA-CB45-4719-9A7D-DE35B10B7345}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{74557CDA-CB45-4719-9A7D-DE35B10B7345}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{74557CDA-CB45-4719-9A7D-DE35B10B7345}.Release|Any CPU.Build.0 = Release|Any CPU
+		{1A0A722B-2D19-42C6-A306-1417A283B244}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{1A0A722B-2D19-42C6-A306-1417A283B244}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{1A0A722B-2D19-42C6-A306-1417A283B244}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{1A0A722B-2D19-42C6-A306-1417A283B244}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE

samples/Plugin.Maui.UITestHelpers.Sample/Plugin.Maui.UITestHelpers.Sample.csproj

@@ -16,7 +16,6 @@
 
 		<!-- App Identifier -->
 		<ApplicationId>com.companyname.uitesthelperssample</ApplicationId>
-		<ApplicationIdGuid>A20E30BB-3BF7-4ACB-89F2-596834136909</ApplicationIdGuid>
 
 		<!-- Versions -->
 		<ApplicationDisplayVersion>1.0</ApplicationDisplayVersion>
@@ -30,6 +29,11 @@
 		<SupportedOSPlatformVersion Condition="$([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)')) == 'tizen'">6.5</SupportedOSPlatformVersion>
 	</PropertyGroup>
 
+	<PropertyGroup Condition="$([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)')) == 'windows'">
+		<WindowsPackageType>None</WindowsPackageType>
+		<IsPackable>false</IsPackable>
+	</PropertyGroup>
+
 	<ItemGroup>
 		<!-- App Icon -->
 		<MauiIcon Include="Resources\AppIcon\appicon.svg" ForegroundFile="Resources\AppIcon\appiconfg.svg" Color="#512BD4" />