[Xamarin.Android.Build.Tests] Add support for testing on system appli…

…cations. (#5708)

Context: https://devdiv.visualstudio.com/DevDiv/_workitems/edit/1288717
Context: xamarin/monodroid@83de4b4

Changes: xamarin/monodroid@b2a750a...4163ee9

  * xamarin/monodroid@4163ee947: [Xamarin.Android.Build.Tasks] Support FastDev for System Apps (#1177) (#1186)
  * xamarin/monodroid@947c6ef72: Bump to xamarin/xamarin-android/d16-9@877f5727 (#1183)

The new fast deployment system (xamarin/monodroid@767f6471) broke
fast deployment for system-installed applications.

This is fixed in xamarin/monodroid@4163ee94.

Adds unit tests to stop this kind of regression in the future.

In order to install a `system` application we need a few things:

 1. The emulator MUST be started with the `-system-writable` argument

 2. The `.apk` needs to be signed with a platform keystore, found at:
    https://github.com/aosp-mirror/platform_build/tree/master/target/product/security

 3. `AndroidManifest.xml` must set
    [`/manifest/@android:sharedUserId`][0] to `android.uid.system`:

        <manifest xmlns:android="http://schemas.android.com/apk/res/android"
            android:sharedUserId="android.uid.system"
            …>
        </manifest>

See also:

  * https://medium.com/xrpractices/android-system-apps-development-d73bedfb8def

[0]: https://developer.android.com/guide/topics/manifest/manifest-element#uid

.external

@@ -1,2 +1,2 @@
-xamarin/monodroid:d16-9@b2a750a2bd9f25e4f16592168dd919bf36930de4
+xamarin/monodroid:d16-9@4163ee94735f4176d2e212041d15c9158316371e
 mono/mono:2020-02@5e9cb6d1c1de430965312927d5aed7fcb27bfa73

Documentation/guides/building-apps/build-properties.md

@@ -986,6 +986,20 @@ To use a file located at `C:\Users\user1\AndroidSigningPassword.txt`:
 > The `env:` prefix is not supported when [`$(AndroidPackageFormat)`](#androidpackageformat)
 > is set to `aab`.
 
+## AndroidSigningPlatformKey
+
+Specifies the key file to use to sign the apk.
+This is only used when building `system` applications.
+
+Support for this property was added in Xamarin.Android 11.3.
+
+## AndroidSigningPlatformCert
+
+Specifies the certificate file to use to sign the apk.
+This is only used when building `system` applications.
+
+Support for this property was added in Xamarin.Android 11.3.
+
 ## AndroidSupportedAbis
 
 A string property that contains a

Documentation/guides/messages/xa4310.md

@@ -8,17 +8,14 @@ ms.date: 03/09/2020
 ## Example messages
 
 ```
-error XA4310: `$(AndroidSigningKeyStore)` file `filename.keystore` could not be found.
+error XA4310: `$(Property)` file `filename.keystore` could not be found.
 ```
 
 ## Issue
 
-The specified `$(AndroidSigningKeyStore)` file could not be located on disk.
+The specified `$(Property)` file could not be located on disk.
 
 ## Solution
 
-Check that the `$(AndroidSigningKeyStore)` MSBuild property is set to a valid
-path of an existing keystore.
-
-This property corresponds to the **Keystore** field in the **Android Package
-Signing** section of the Visual Studio project property pages.
+Check that the `$(Property)` MSBuild property is set to a valid
+path of an existing file.

Documentation/release-notes/5708.md

@@ -0,0 +1,13 @@
+#### Application build and deployment
+
+* [Developer Community 1288717][0]:
+  *Support Fast Deployment for System Applications.*
+  Added support for fast deployment while building system based
+  applications. Applications developed in this mode need to be
+  signed with a platform key and have a special attribute
+
+  `android:sharedUserId="android.uid.system"`
+
+  in the `AndroidManifest.xml`.
+
+[0]: https://developercommunity.visualstudio.com/t/VS-2019-1690-Error-XA0130-XamarinAndr/1359238

build-tools/Xamarin.Android.Tools.BootstrapTasks/Xamarin.Android.Tools.BootstrapTasks/StartAndroidEmulator.cs

@@ -20,6 +20,7 @@ public class StartAndroidEmulator : Task
 		public                  string          AndroidSdkHome  {get; set;}
 		public                  string          Port            {get; set;}
 		public                  string          ImageName       {get; set;} = "XamarinAndroidTestRunner64";
+		public                  string          Arguments       {get; set;}
 		public                  string          ToolPath        {get; set;}
 		public                  string          ToolExe         {get; set;}
 
@@ -62,7 +63,7 @@ void Run (string emulator)
 				return;
 
 			var port = string.IsNullOrEmpty (Port) ? "" : $" -port {Port}";
-			var arguments = $"-verbose -avd {ImageName}{port} -cache-size 512";
+			var arguments = $"{Arguments ?? string.Empty} -verbose -avd {ImageName}{port} -cache-size 512";
 			Log.LogMessage (MessageImportance.Low, $"Tool {emulator} execution started with arguments: {arguments}");
 			var psi = new ProcessStartInfo () {
 				FileName                = emulator,

build-tools/automation/azure-pipelines.yaml

@@ -63,7 +63,7 @@ variables:
   # - This is a non-fork branch with name containing "mono-" (for Mono bumps)
   IsMonoBranch: $[and(eq(variables['XA.Commercial.Build'], 'true'), ne(variables['System.PullRequest.IsFork'], 'True'), or(contains(variables['Build.SourceBranchName'], 'mono-'), contains(variables['System.PullRequest.SourceBranch'], 'mono-')))]
   RunAllTests: $[or(eq(variables['XA.RunAllTests'], true), eq(variables['IsMonoBranch'], true))]
-  DotNetNUnitCategories: '& TestCategory != DotNetIgnore & TestCategory != AOT & TestCategory != MkBundle & TestCategory != MonoSymbolicate & TestCategory != PackagesConfig & TestCategory != StaticProject & TestCategory != Debugger'
+  DotNetNUnitCategories: '& TestCategory != DotNetIgnore & TestCategory != AOT & TestCategory != MkBundle & TestCategory != MonoSymbolicate & TestCategory != PackagesConfig & TestCategory != StaticProject & TestCategory != Debugger & TestCategory != SystemApplication'
   NUnit.NumberOfTestWorkers: 4
   GitHub.Token: $(github--pat--vs-mobiletools-engineering-service2)
 

build-tools/automation/yaml-templates/run-msbuild-device-tests.yaml

@@ -57,7 +57,7 @@ jobs:
         useDotNet: $(UseDotNet)
         testRunTitle: MSBuildDeviceIntegration On Device - macOS - ${{ parameters.job_suffix }}
         testAssembly: $(System.DefaultWorkingDirectory)/bin/Test$(XA.Build.Configuration)/MSBuildDeviceIntegration/${{ parameters.target_framework }}/MSBuildDeviceIntegration.dll
-        nunitConsoleExtraArgs: --where "cat != TimeZoneInfo && cat != SmokeTests ${{ parameters.nunit_categories }}"
+        nunitConsoleExtraArgs: --where "cat != SystemApplication && cat != TimeZoneInfo && cat != SmokeTests ${{ parameters.nunit_categories }}"
         dotNetTestExtraArgs: --filter "TestCategory != TimeZoneInfo & TestCategory != SmokeTests ${{ parameters.nunit_categories }}"
         testResultsFile: TestResult-MSBuildDeviceIntegration-${{ parameters.job_name }}-$(XA.Build.Configuration).xml
 

build-tools/automation/yaml-templates/run-systemapp-tests.yaml

@@ -0,0 +1,52 @@
+# Runs TimeZoneInfo tests against an emulator running on macOS
+
+jobs:
+  - job: mac_systemapp_tests
+    displayName: System App Emulator Tests
+    pool:
+      vmImage: $(HostedMacImage)
+    timeoutInMinutes: 120
+    cancelTimeoutInMinutes: 5
+    workspace:
+      clean: all
+    steps:
+    - template: setup-test-environment.yaml
+
+    - script: mono $(System.DefaultWorkingDirectory)/build-tools/xaprepare/xaprepare/bin/$(XA.Build.Configuration)/xaprepare.exe --s=EmulatorTestDependencies --no-emoji --run-mode=CI
+      displayName: install emulator
+
+    - task: DownloadPipelineArtifact@2
+      inputs:
+        artifactName: $(TestAssembliesArtifactName)
+        downloadPath: $(System.DefaultWorkingDirectory)/bin/Test$(XA.Build.Configuration)
+
+    - task: MSBuild@1
+      displayName: start emulator
+      inputs:
+        solution: tests/Mono.Android-Tests/Mono.Android-Tests.csproj
+        configuration: $(XA.Build.Configuration)
+        msbuildArguments: >-
+          /t:AcquireAndroidTarget /p:TestEmulatorArguments=-writable-system /bl:$(System.DefaultWorkingDirectory)/bin/Test$(XA.Build.Configuration)/start-emulator.binlog
+
+    - template: run-nunit-tests.yaml
+      parameters:
+        testRunTitle: System App On Device - macOS
+        testAssembly: $(System.DefaultWorkingDirectory)/bin/Test$(XA.Build.Configuration)/MSBuildDeviceIntegration/net472/MSBuildDeviceIntegration.dll
+        nunitConsoleExtraArgs: --where "cat == SystemApplication"
+        testResultsFile: TestResult-SystemApp--$(XA.Build.Configuration).xml
+
+    - task: MSBuild@1
+      displayName: shut down emulator
+      inputs:
+        solution: tests/Mono.Android-Tests/Mono.Android-Tests.csproj
+        configuration: $(XA.Build.Configuration)
+        msbuildArguments: >-
+          /t:AcquireAndroidTarget,ReleaseAndroidTarget
+          /bl:$(System.DefaultWorkingDirectory)/bin/Test$(XA.Build.Configuration)/shutdown-emulator.binlog
+      condition: always()
+
+    - template: upload-results.yaml
+      parameters:
+        artifactName: Test Results - System App With Emulator - macOS
+
+    - template: fail-on-issue.yaml

build-tools/scripts/TestApks.targets

@@ -57,6 +57,7 @@
     <StartAndroidEmulator
         Condition=" '$(_ValidAdbTarget)' != 'True' "
         AndroidSdkHome="$(AndroidSdkDirectory)"
+        Arguments="$(TestEmulatorArguments)"
         ImageName="$(_TestImageName)"
         Port="$(_AdbEmulatorPort)"
         ToolExe="$(EmulatorToolExe)"

src/Xamarin.Android.Build.Tasks/Properties/Resources.resx

@@ -712,8 +712,10 @@ The following are literal names and should not be translated: ABI, 'libs/armeabi
     <comment>The following are literal names and should not be translated: MultiDexMainDexList</comment>
   </data>
   <data name="XA4310" xml:space="preserve">
-    <value>`$(AndroidSigningKeyStore)` file `{0}` could not be found.</value>
-    <comment>The following are literal names and should not be translated: `$(AndroidSigningKeyStore)`</comment>
+    <value>`{0}` file `{1}` could not be found.</value>
+    <comment>{0} - The MSBuildProperty which contains the file name value.
+{1} - The value of the MSBuildProperty. Normally a filename.
+</comment>
   </data>
   <data name="XA4311" xml:space="preserve">
     <value>The application won't contain the paired Wear package because the Wear application package APK is not created yet. If building on the command line, be sure to build the "SignAndroidPackage" target.</value>

src/Xamarin.Android.Build.Tasks/Properties/xlf/Resources.cs.xlf

@@ -744,9 +744,11 @@ In this message, "root element" refers to the root element of an XML file.
         <note>The following are literal names and should not be translated: MultiDexMainDexList</note>
       </trans-unit>
       <trans-unit id="XA4310">
-        <source>`$(AndroidSigningKeyStore)` file `{0}` could not be found.</source>
-        <target state="translated">Soubor $(AndroidSigningKeyStore) {0} se nepovedlo najít.</target>
-        <note>The following are literal names and should not be translated: `$(AndroidSigningKeyStore)`</note>
+        <source>`{0}` file `{1}` could not be found.</source>
+        <target state="needs-review-translation">Soubor {0} {1} se nepovedlo najít.</target>
+        <note>{0} - The MSBuildProperty which contains the file name value.
+{1} - The value of the MSBuildProperty. Normally a filename.
+</note>
       </trans-unit>
       <trans-unit id="XA4311">
         <source>The application won't contain the paired Wear package because the Wear application package APK is not created yet. If building on the command line, be sure to build the "SignAndroidPackage" target.</source>

src/Xamarin.Android.Build.Tasks/Properties/xlf/Resources.de.xlf

@@ -744,9 +744,11 @@ In this message, "root element" refers to the root element of an XML file.
         <note>The following are literal names and should not be translated: MultiDexMainDexList</note>
       </trans-unit>
       <trans-unit id="XA4310">
-        <source>`$(AndroidSigningKeyStore)` file `{0}` could not be found.</source>
-        <target state="translated">Die $(AndroidSigningKeyStore)-Datei "{0}" wurde nicht gefunden.</target>
-        <note>The following are literal names and should not be translated: `$(AndroidSigningKeyStore)`</note>
+        <source>`{0}` file `{1}` could not be found.</source>
+        <target state="needs-review-translation">Die {0}-Datei "{1}" wurde nicht gefunden.</target>
+        <note>{0} - The MSBuildProperty which contains the file name value.
+{1} - The value of the MSBuildProperty. Normally a filename.
+</note>
       </trans-unit>
       <trans-unit id="XA4311">
         <source>The application won't contain the paired Wear package because the Wear application package APK is not created yet. If building on the command line, be sure to build the "SignAndroidPackage" target.</source>

src/Xamarin.Android.Build.Tasks/Properties/xlf/Resources.es.xlf

@@ -744,9 +744,11 @@ In this message, "root element" refers to the root element of an XML file.
         <note>The following are literal names and should not be translated: MultiDexMainDexList</note>
       </trans-unit>
       <trans-unit id="XA4310">
-        <source>`$(AndroidSigningKeyStore)` file `{0}` could not be found.</source>
-        <target state="translated">No se ha encontrado el archivo "{0}" de "$(AndroidSigningKeyStore)".</target>
-        <note>The following are literal names and should not be translated: `$(AndroidSigningKeyStore)`</note>
+        <source>`{0}` file `{1}` could not be found.</source>
+        <target state="needs-review-translation">No se ha encontrado el archivo "{1}" de "{0}".</target>
+        <note>{0} - The MSBuildProperty which contains the file name value.
+{1} - The value of the MSBuildProperty. Normally a filename.
+</note>
       </trans-unit>
       <trans-unit id="XA4311">
         <source>The application won't contain the paired Wear package because the Wear application package APK is not created yet. If building on the command line, be sure to build the "SignAndroidPackage" target.</source>

src/Xamarin.Android.Build.Tasks/Properties/xlf/Resources.fr.xlf

@@ -744,9 +744,11 @@ In this message, "root element" refers to the root element of an XML file.
         <note>The following are literal names and should not be translated: MultiDexMainDexList</note>
       </trans-unit>
       <trans-unit id="XA4310">
-        <source>`$(AndroidSigningKeyStore)` file `{0}` could not be found.</source>
-        <target state="translated">Le fichier '$(AndroidSigningKeyStore)' '{0}' est introuvable.</target>
-        <note>The following are literal names and should not be translated: `$(AndroidSigningKeyStore)`</note>
+        <source>`{0}` file `{1}` could not be found.</source>
+        <target state="needs-review-translation">Le fichier '{0}' '{1}' est introuvable.</target>
+        <note>{0} - The MSBuildProperty which contains the file name value.
+{1} - The value of the MSBuildProperty. Normally a filename.
+</note>
       </trans-unit>
       <trans-unit id="XA4311">
         <source>The application won't contain the paired Wear package because the Wear application package APK is not created yet. If building on the command line, be sure to build the "SignAndroidPackage" target.</source>

src/Xamarin.Android.Build.Tasks/Properties/xlf/Resources.it.xlf

@@ -744,9 +744,11 @@ In this message, "root element" refers to the root element of an XML file.
         <note>The following are literal names and should not be translated: MultiDexMainDexList</note>
       </trans-unit>
       <trans-unit id="XA4310">
-        <source>`$(AndroidSigningKeyStore)` file `{0}` could not be found.</source>
-        <target state="translated">Non è stato possibile trovare il file `{0}` di `$(AndroidSigningKeyStore)`.</target>
-        <note>The following are literal names and should not be translated: `$(AndroidSigningKeyStore)`</note>
+        <source>`{0}` file `{1}` could not be found.</source>
+        <target state="needs-review-translation">Non è stato possibile trovare il file `{1}` di `{0}`.</target>
+        <note>{0} - The MSBuildProperty which contains the file name value.
+{1} - The value of the MSBuildProperty. Normally a filename.
+</note>
       </trans-unit>
       <trans-unit id="XA4311">
         <source>The application won't contain the paired Wear package because the Wear application package APK is not created yet. If building on the command line, be sure to build the "SignAndroidPackage" target.</source>

src/Xamarin.Android.Build.Tasks/Properties/xlf/Resources.ja.xlf

@@ -744,9 +744,11 @@ In this message, "root element" refers to the root element of an XML file.
         <note>The following are literal names and should not be translated: MultiDexMainDexList</note>
       </trans-unit>
       <trans-unit id="XA4310">
-        <source>`$(AndroidSigningKeyStore)` file `{0}` could not be found.</source>
-        <target state="translated">'$(AndroidSigningKeyStore)' ファイル '{0}' が見つかりませんでした。</target>
-        <note>The following are literal names and should not be translated: `$(AndroidSigningKeyStore)`</note>
+        <source>`{0}` file `{1}` could not be found.</source>
+        <target state="needs-review-translation">'{0}' ファイル '{1}' が見つかりませんでした。</target>
+        <note>{0} - The MSBuildProperty which contains the file name value.
+{1} - The value of the MSBuildProperty. Normally a filename.
+</note>
       </trans-unit>
       <trans-unit id="XA4311">
         <source>The application won't contain the paired Wear package because the Wear application package APK is not created yet. If building on the command line, be sure to build the "SignAndroidPackage" target.</source>

src/Xamarin.Android.Build.Tasks/Properties/xlf/Resources.ko.xlf

@@ -744,9 +744,11 @@ In this message, "root element" refers to the root element of an XML file.
         <note>The following are literal names and should not be translated: MultiDexMainDexList</note>
       </trans-unit>
       <trans-unit id="XA4310">
-        <source>`$(AndroidSigningKeyStore)` file `{0}` could not be found.</source>
-        <target state="translated">'$(AndroidSigningKeyStore)' 파일 '{0}'을(를) 찾을 수 없습니다.</target>
-        <note>The following are literal names and should not be translated: `$(AndroidSigningKeyStore)`</note>
+        <source>`{0}` file `{1}` could not be found.</source>
+        <target state="needs-review-translation">'{0}' 파일 '{1}'을(를) 찾을 수 없습니다.</target>
+        <note>{0} - The MSBuildProperty which contains the file name value.
+{1} - The value of the MSBuildProperty. Normally a filename.
+</note>
       </trans-unit>
       <trans-unit id="XA4311">
         <source>The application won't contain the paired Wear package because the Wear application package APK is not created yet. If building on the command line, be sure to build the "SignAndroidPackage" target.</source>

src/Xamarin.Android.Build.Tasks/Properties/xlf/Resources.pl.xlf

@@ -744,9 +744,11 @@ In this message, "root element" refers to the root element of an XML file.
         <note>The following are literal names and should not be translated: MultiDexMainDexList</note>
       </trans-unit>
       <trans-unit id="XA4310">
-        <source>`$(AndroidSigningKeyStore)` file `{0}` could not be found.</source>
-        <target state="translated">Nie można odnaleźć pliku „$(AndroidSigningKeyStore)” („{0}”).</target>
-        <note>The following are literal names and should not be translated: `$(AndroidSigningKeyStore)`</note>
+        <source>`{0}` file `{1}` could not be found.</source>
+        <target state="new">`{0}` file `{1}` could not be found.</target>
+        <note>{0} - The MSBuildProperty which contains the file name value.
+{1} - The value of the MSBuildProperty. Normally a filename.
+</note>
       </trans-unit>
       <trans-unit id="XA4311">
         <source>The application won't contain the paired Wear package because the Wear application package APK is not created yet. If building on the command line, be sure to build the "SignAndroidPackage" target.</source>

src/Xamarin.Android.Build.Tasks/Properties/xlf/Resources.pt-BR.xlf

@@ -744,9 +744,11 @@ In this message, "root element" refers to the root element of an XML file.
         <note>The following are literal names and should not be translated: MultiDexMainDexList</note>
       </trans-unit>
       <trans-unit id="XA4310">
-        <source>`$(AndroidSigningKeyStore)` file `{0}` could not be found.</source>
-        <target state="translated">Não foi possível localizar o arquivo `{0}` de `$(AndroidSigningKeyStore)`.</target>
-        <note>The following are literal names and should not be translated: `$(AndroidSigningKeyStore)`</note>
+        <source>`{0}` file `{1}` could not be found.</source>
+        <target state="new">`{0}` file `{1}` could not be found.</target>
+        <note>{0} - The MSBuildProperty which contains the file name value.
+{1} - The value of the MSBuildProperty. Normally a filename.
+</note>
       </trans-unit>
       <trans-unit id="XA4311">
         <source>The application won't contain the paired Wear package because the Wear application package APK is not created yet. If building on the command line, be sure to build the "SignAndroidPackage" target.</source>

src/Xamarin.Android.Build.Tasks/Properties/xlf/Resources.ru.xlf

@@ -744,9 +744,11 @@ In this message, "root element" refers to the root element of an XML file.
         <note>The following are literal names and should not be translated: MultiDexMainDexList</note>
       </trans-unit>
       <trans-unit id="XA4310">
-        <source>`$(AndroidSigningKeyStore)` file `{0}` could not be found.</source>
-        <target state="translated">Не удалось найти файл "$(AndroidSigningKeyStore)" с именем "{0}".</target>
-        <note>The following are literal names and should not be translated: `$(AndroidSigningKeyStore)`</note>
+        <source>`{0}` file `{1}` could not be found.</source>
+        <target state="new">`{0}` file `{1}` could not be found.</target>
+        <note>{0} - The MSBuildProperty which contains the file name value.
+{1} - The value of the MSBuildProperty. Normally a filename.
+</note>
       </trans-unit>
       <trans-unit id="XA4311">
         <source>The application won't contain the paired Wear package because the Wear application package APK is not created yet. If building on the command line, be sure to build the "SignAndroidPackage" target.</source>