Add scripts to run device tests (dotnet#13641)

raabin · Feb 10, 2021 · 678aff8 · 678aff8
1 parent 9fe1b41
commit 678aff8
Show file tree

Hide file tree

Showing 41 changed files with 291 additions and 2,812 deletions.
diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json
@@ -7,6 +7,12 @@
       "commands": [
         "dotnet-cake"
       ]
+    },
+    "microsoft.dotnet.xharness.cli": {
+      "version": "1.0.0-prerelease.21109.1",
+      "commands": [
+        "xharness"
+      ]
     }
   }
 }
diff --git a/...her/Assets/xamarin.essentials.icon.sketch → Assets/xamarin.essentials.icon.sketch b/...her/Assets/xamarin.essentials.icon.sketch → Assets/xamarin.essentials.icon.sketch
diff --git a/...her/Assets/xamarin.essentials_128x128.png → Assets/xamarin.essentials_128x128.png b/...her/Assets/xamarin.essentials_128x128.png → Assets/xamarin.essentials_128x128.png
diff --git a/build.ps1 b/build.ps1
@@ -9,7 +9,7 @@ Param(
 )
 
 # Restore Cake tool
-& dotnet tool restore
+& dotnet tool restore --configfile eng/DevopsNuget.config
 
 # Build Cake arguments
 $cakeArguments = @("$Script");

diff --git a/build.sh b/build.sh
@@ -17,7 +17,7 @@ for i in "$@"; do
 done
 
 # Restore Cake tool
-dotnet tool restore
+dotnet tool restore --configfile eng/DevopsNuget.config
 
 if [ $? -ne 0 ]; then
     echo "An error occured while installing Cake."

diff --git a/eng/devices/.gitignore b/eng/devices/.gitignore
@@ -0,0 +1 @@
+tools/
diff --git a/eng/devices/android.cake b/eng/devices/android.cake
@@ -0,0 +1,199 @@
+#addin nuget:?package=Cake.Android.Adb&version=3.2.0
+#addin nuget:?package=Cake.Android.AvdManager&version=2.2.0
+
+string TARGET = Argument("target", "Test");
+
+// required
+FilePath PROJECT = Argument("project", EnvironmentVariable("ANDROID_TEST_PROJECT") ?? "");
+string TEST_DEVICE = Argument("device", EnvironmentVariable("ANDROID_TEST_DEVICE") ?? "android-emulator-32_30");
+
+// optional
+var BINLOG = Argument("binlog", EnvironmentVariable("ANDROID_TEST_BINLOG") ?? PROJECT + ".binlog");
+var TEST_APP = Argument("app", EnvironmentVariable("ANDROID_TEST_APP") ?? "");
+var TEST_APP_PACKAGE_NAME = Argument("package", EnvironmentVariable("ANDROID_TEST_APP_PACKAGE_NAME") ?? "");
+var TEST_APP_INSTRUMENTATION = Argument("instrumentation", EnvironmentVariable("ANDROID_TEST_APP_INSTRUMENTATION") ?? "");
+var TEST_RESULTS = Argument("results", EnvironmentVariable("ANDROID_TEST_RESULTS") ?? "");
+
+// other
+string CONFIGURATION = "Debug"; // needs to be debug so unit tests get discovered
+string ANDROID_AVD = "DEVICE_TESTS_EMULATOR";
+string DEVICE_NAME = "Nexus 5X";
+string DEVICE_ID = "system-images;android-30;google_apis_playstore;x86";
+
+// set up env
+var ANDROID_HOME = EnvironmentVariable("ANDROID_HOME");
+if (string.IsNullOrEmpty(ANDROID_HOME)) {
+    throw new Exception("Environment variable 'ANDROID_HOME' must be set to the Android SDK root.");
+}
+System.Environment.SetEnvironmentVariable("PATH",
+    $"{ANDROID_HOME}/tools/bin" + System.IO.Path.PathSeparator +
+    $"{ANDROID_HOME}/platform-tools" + System.IO.Path.PathSeparator +
+    $"{ANDROID_HOME}/emulator" + System.IO.Path.PathSeparator +
+    EnvironmentVariable("PATH"));
+
+Information("ANDROID_HOME {0}", ANDROID_HOME);
+Information("Project File: {0}", PROJECT);
+Information("Build Binary Log (binlog): {0}", BINLOG);
+Information("Build Configuration: {0}", CONFIGURATION);
+
+var avdSettings = new AndroidAvdManagerToolSettings { SdkRoot = ANDROID_HOME };
+var adbSettings = new AdbToolSettings { SdkRoot = ANDROID_HOME };
+var emuSettings = new AndroidEmulatorToolSettings { SdkRoot = ANDROID_HOME, ArgumentCustomization = args => args.Append("-no-window") };
+
+AndroidEmulatorProcess emulatorProcess = null;
+
+Setup(context =>
+{
+    // determine the device characteristics
+    {
+        var working = TEST_DEVICE.Trim().ToLower();
+        var emulator = true;
+        var arch = "x86";
+        var api = 30;
+        // version
+        if (working.IndexOf("_") is int idx && idx > 0) {
+            api = int.Parse(working.Substring(idx + 1));
+            working = working.Substring(0, idx);
+        }
+        var parts = working.Split("-");
+        // os
+        if (parts[0] != "android")
+            throw new Exception("Unexpected platform (expected: android) in device: " + TEST_DEVICE);
+        // device/emulator
+        if (parts[1] == "device")
+            emulator = false;
+        else if (parts[1] != "emulator" && parts[1] != "simulator")
+            throw new Exception("Unexpected device type (expected: device|emulator) in device: " + TEST_DEVICE);
+        // arch/bits
+        if (parts[2] == "32") {
+            if (emulator)
+                arch = "x86";
+            else
+                arch = "armeabi-v7a";
+        } else if (parts[2] == "64") {
+            if (emulator)
+                arch = "x86_64";
+            else
+                arch = "arm64-v8a";
+        }
+        DEVICE_ID = $"system-images;android-{api};google_apis_playstore;{arch}";
+
+        // we are not using a virtual device, so quit
+        if (!emulator)
+            return;
+    }
+
+    Information("Test Device: {0}", TEST_DEVICE);
+    Information("Test Device ID: {0}", DEVICE_ID);
+
+    // delete the AVD first, if it exists
+    Information("Deleting AVD if exists: {0}...", ANDROID_AVD);
+    try { AndroidAvdDelete(ANDROID_AVD, avdSettings); }
+    catch { }
+
+    // create the new AVD
+    Information("Creating AVD: {0}...", ANDROID_AVD);
+    AndroidAvdCreate(ANDROID_AVD, DEVICE_ID, DEVICE_NAME, force: true, settings: avdSettings);
+
+    // start the emulator
+    Information("Starting Emulator: {0}...", ANDROID_AVD);
+    emulatorProcess = AndroidEmulatorStart(ANDROID_AVD, emuSettings);
+
+    // var waited = 0;
+    // while (AdbShell("getprop sys.boot_completed", adbSettings).FirstOrDefault() != "1") {
+    //     System.Threading.Thread.Sleep(1000);
+    //     if (waited++ > 60 * 10)
+    //         break;
+    // }
+    // Information("Waited {0} seconds for the emulator to boot up.", waited);
+});
+
+Teardown(context =>
+{
+    // no virtual device was used
+    if (emulatorProcess == null)
+        return;
+
+    // stop and cleanup the emulator
+    AdbEmuKill(adbSettings);
+
+    System.Threading.Thread.Sleep(5000);
+
+    // kill the process if it has not already exited
+    try { emulatorProcess.Kill(); }
+    catch { }
+
+    // delete the AVD
+    try { AndroidAvdDelete(ANDROID_AVD, avdSettings); }
+    catch { }
+});
+
+Task("Build")
+    .WithCriteria(!string.IsNullOrEmpty(PROJECT.FullPath))
+    .Does(() =>
+{
+    MSBuild(PROJECT.FullPath, c => {
+        c.Configuration = CONFIGURATION;
+        c.Restore = true;
+        c.Properties["ContinuousIntegrationBuild"] = new List<string> { "false" };
+        c.Targets.Clear();
+        c.Targets.Add("Rebuild");
+        c.Targets.Add("SignAndroidPackage");
+        c.BinaryLogger = new MSBuildBinaryLogSettings {
+            Enabled = true,
+            FileName = BINLOG,
+        };
+    });
+});
+
+Task("Test")
+    .IsDependentOn("Build")
+    .Does(() =>
+{
+    if (string.IsNullOrEmpty(TEST_APP)) {
+        if (string.IsNullOrEmpty(PROJECT.FullPath))
+            throw new Exception("If no app was specified, an app must be provided.");
+        var binDir = PROJECT.GetDirectory().Combine("bin").Combine(CONFIGURATION).FullPath;
+        var apps = GetFiles(binDir + "/*-Signed.apk");
+        if (apps.Any()) {
+            TEST_APP = apps.FirstOrDefault().FullPath;
+        } else {
+            apps = GetFiles(binDir + "/*.apk");
+            TEST_APP = apps.First().FullPath;
+        }
+    }
+    if (string.IsNullOrEmpty(TEST_APP_PACKAGE_NAME)) {
+        var appFile = (FilePath)TEST_APP;
+        appFile = appFile.GetFilenameWithoutExtension();
+        TEST_APP_PACKAGE_NAME = appFile.FullPath.Replace("-Signed", "");
+    }
+    if (string.IsNullOrEmpty(TEST_APP_INSTRUMENTATION)) {
+        TEST_APP_INSTRUMENTATION = TEST_APP_PACKAGE_NAME + ".TestInstrumentation";
+    }
+    if (string.IsNullOrEmpty(TEST_RESULTS)) {
+        TEST_RESULTS = TEST_APP + "-results";
+    }
+
+    Information("Test App: {0}", TEST_APP);
+    Information("Test App Package Name: {0}", TEST_APP_PACKAGE_NAME);
+    Information("Test App Instrumentation: {0}", TEST_APP_INSTRUMENTATION);
+    Information("Test Results Directory: {0}", TEST_RESULTS);
+
+    CleanDirectories(TEST_RESULTS);
+
+    var settings = new DotNetCoreToolSettings
+    {
+        DiagnosticOutput = true,
+        ArgumentCustomization = args=>args.Append("run xharness android test " +
+        $"--app=\"{TEST_APP}\" " +
+        $"--package-name=\"{TEST_APP_PACKAGE_NAME}\" " +
+        $"--instrumentation=\"{TEST_APP_INSTRUMENTATION}\" " +
+        $"--device-arch=\"x86\" " +
+        $"--output-directory=\"{TEST_RESULTS}\" " +
+        $"--verbosity=\"Debug\" ")
+    };
+
+    DotNetCoreTool("tool", settings);
+});
+
+RunTarget(TARGET);
diff --git a/eng/devices/ios.cake b/eng/devices/ios.cake
@@ -0,0 +1,76 @@
+#addin nuget:?package=Cake.AppleSimulator&version=0.2.0
+
+string TARGET = Argument("target", "Test");
+
+// required
+FilePath PROJECT = Argument("project", EnvironmentVariable("IOS_TEST_PROJECT") ?? "");
+    string TEST_DEVICE = Argument("device", EnvironmentVariable("IOS_TEST_DEVICE") ?? "ios-simulator-64_14.4"); // comma separated in the form <platform>-<device|simulator>[-<32|64>][_<version>] (eg: ios-simulator-64_13.4,[...])
+
+// optional
+var BINLOG = Argument("binlog", EnvironmentVariable("IOS_TEST_BINLOG") ?? PROJECT + ".binlog");
+var TEST_APP = Argument("app", EnvironmentVariable("IOS_TEST_APP") ?? "");
+var TEST_RESULTS = Argument("results", EnvironmentVariable("IOS_TEST_RESULTS") ?? "");
+
+// other
+string PLATFORM = TEST_DEVICE.ToLower().Contains("simulator") ? "iPhoneSimulator" : "iPhone";
+string CONFIGURATION = "Release";
+
+Information("Project File: {0}", PROJECT);
+Information("Build Binary Log (binlog): {0}", BINLOG);
+Information("Build Platform: {0}", PLATFORM);
+Information("Build Configuration: {0}", CONFIGURATION);
+
+Task("Build")
+    .WithCriteria(!string.IsNullOrEmpty(PROJECT.FullPath))
+    .Does(() =>
+{
+    MSBuild(PROJECT.FullPath, c => {
+        c.Configuration = CONFIGURATION;
+        c.Restore = true;
+        c.Properties["Platform"] = new List<string> { PLATFORM };
+        c.Properties["BuildIpa"] = new List<string> { "true" };
+        c.Properties["ContinuousIntegrationBuild"] = new List<string> { "false" };
+        c.Targets.Clear();
+        c.Targets.Add("Rebuild");
+        c.BinaryLogger = new MSBuildBinaryLogSettings {
+            Enabled = true,
+            FileName = BINLOG,
+        };
+    });
+});
+
+Task("Test")
+    .IsDependentOn("Build")
+    .Does(() =>
+{
+    if (string.IsNullOrEmpty(TEST_APP)) {
+        if (string.IsNullOrEmpty(PROJECT.FullPath))
+            throw new Exception("If no app was specified, an app must be provided.");
+        var binDir = PROJECT.GetDirectory().Combine("bin").Combine(PLATFORM).Combine(CONFIGURATION).FullPath;
+        var apps = GetDirectories(binDir + "/*.app");
+        TEST_APP = apps.First().FullPath;
+    }
+    if (string.IsNullOrEmpty(TEST_RESULTS)) {
+        TEST_RESULTS = TEST_APP + "-results";
+    }
+
+    Information("Test Device: {0}", TEST_DEVICE);
+    Information("Test App: {0}", TEST_APP);
+    Information("Test Results Directory: {0}", TEST_RESULTS);
+
+    CleanDirectories(TEST_RESULTS);
+
+    var settings = new DotNetCoreToolSettings
+    {
+        DiagnosticOutput = true,
+        ArgumentCustomization = args=>args.Append("run xharness apple test " +
+        $"--app=\"{TEST_APP}\" " +
+        $"--targets=\"{TEST_DEVICE}\" " +
+        $"--output-directory=\"{TEST_RESULTS}\" " +
+        $"--verbosity=\"Debug\" ")
+    };
+
+    DotNetCoreTool("tool", settings);
+});
+
+RunTarget(TARGET);