protected override Task <ExitCode> InvokeInternal(ILogger logger)
{
logger.LogInformation("Getting state of ADB and attached Android device(s)");
try
{
var runner = new AdbRunner(logger);
string state = runner.GetAdbState();
if (string.IsNullOrEmpty(state))
{
state = "No device attached";
}
logger.LogInformation($"ADB Version info:{Environment.NewLine}{runner.GetAdbVersion()}");
logger.LogInformation($"ADB State ('device' if physically attached):{Environment.NewLine}{state}");
logger.LogInformation($"List of devices:");
var deviceAndArchList = runner.GetAttachedDevicesWithProperties("architecture");
foreach (string device in deviceAndArchList.Keys)
{
logger.LogInformation($"Device: '{device}' - Architecture: {deviceAndArchList[device]}");
}
return(Task.FromResult(ExitCode.SUCCESS));
}
catch (Exception toLog)
{
logger.LogCritical(toLog, $"Error: {toLog.Message}");
return(Task.FromResult(ExitCode.GENERAL_FAILURE));
}
}
public ExitCode InvokeHelper(ILogger logger, string apkPackageName, string appPackagePath, string?apkRequiredArchitecture, string?deviceId, AdbRunner runner)
{
try
{
using (logger.BeginScope("Initialization and setup of APK on device"))
{
// Make sure the adb server is started
runner.StartAdbServer();
// if call via install command device id must be set
// otherwise - from test command - apkRequiredArchitecture was set by user or .apk architecture
deviceId ??= apkRequiredArchitecture != null
? runner.GetDeviceToUse(logger, apkRequiredArchitecture, "architecture")
: throw new ArgumentNullException("Required architecture not specified");
if (deviceId == null)
{
throw new Exception($"Failed to find compatible device: {apkRequiredArchitecture}");
}
runner.SetActiveDevice(deviceId);
// Wait till at least device(s) are ready
runner.WaitForDevice();
logger.LogDebug($"Working with {runner.GetAdbVersion()}");
// If anything changed about the app, Install will fail; uninstall it first.
// (we'll ignore if it's not present)
// This is where mismatched architecture APKs fail.
runner.UninstallApk(apkPackageName);
if (runner.InstallApk(appPackagePath) != 0)
{
logger.LogCritical("Install failure: Test command cannot continue");
runner.UninstallApk(apkPackageName);
return(ExitCode.PACKAGE_INSTALLATION_FAILURE);
}
runner.KillApk(apkPackageName);
}
return(ExitCode.SUCCESS);
}
catch (Exception toLog)
{
throw new Exception($"Failed to run test package: {toLog.Message}");
}
}
protected override Task <ExitCode> InvokeInternal(ILogger logger)
{
logger.LogDebug($"Android Uninstall command called: App = {_arguments.PackageName}{Environment.NewLine}");
// Package Name is not guaranteed to match file name, so it needs to be mandatory.
string apkPackageName = _arguments.PackageName;
var runner = new AdbRunner(logger);
try
{
using (logger.BeginScope("Find device where to uninstall APK"))
{
// Make sure the adb server is started
runner.StartAdbServer();
var deviceId = _arguments.DeviceId;
if (string.IsNullOrEmpty(deviceId))
{
// trying to find out if there is only one device with the app installed
deviceId = runner.GetUniqueDeviceToUse(logger, "package:" + apkPackageName, "app");
if (string.IsNullOrEmpty(deviceId))
{
return(Task.FromResult(ExitCode.ADB_DEVICE_ENUMERATION_FAILURE));
}
}
runner.SetActiveDevice(deviceId);
logger.LogDebug($"Working with {runner.GetAdbVersion()}");
runner.UninstallApk(apkPackageName);
return(Task.FromResult(ExitCode.SUCCESS));
}
}
catch (Exception toLog)
{
logger.LogCritical(toLog, $"Failure to uninstall test package: {toLog.Message}");
}
return(Task.FromResult(ExitCode.GENERAL_FAILURE));
}
protected override Task <ExitCode> InvokeInternal()
{
_log.LogInformation("Getting state of ADB and attached Android device(s)");
try
{
var runner = new AdbRunner(_log);
string state = runner.GetAdbState();
if (string.IsNullOrEmpty(state))
{
state = "No device attached";
}
_log.LogInformation($"ADB Version info:{Environment.NewLine}{runner.GetAdbVersion()}");
_log.LogInformation($"ADB State ('device' if physically attached):{Environment.NewLine}{state}");
return(Task.FromResult(ExitCode.SUCCESS));
}
catch (Exception toLog)
{
_log.LogCritical(toLog, $"Error: {toLog.Message}");
return(Task.FromResult(ExitCode.GENERAL_FAILURE));
}
}
protected override Task <ExitCode> InvokeInternal(ILogger logger)
{
logger.LogDebug($"Android Test command called: App = {_arguments.AppPackagePath}{Environment.NewLine}Instrumentation Name = {_arguments.InstrumentationName}");
logger.LogDebug($"Output Directory:{_arguments.OutputDirectory}{Environment.NewLine}Timeout = {_arguments.Timeout.TotalSeconds} seconds.");
logger.LogDebug("Arguments to instrumentation:");
if (!File.Exists(_arguments.AppPackagePath))
{
logger.LogCritical($"Couldn't find {_arguments.AppPackagePath}!");
return(Task.FromResult(ExitCode.PACKAGE_NOT_FOUND));
}
var runner = new AdbRunner(logger);
// Assumption: APKs we test will only have one arch for now
string apkRequiredArchitecture;
if (!string.IsNullOrEmpty(_arguments.DeviceArchitecture))
{
apkRequiredArchitecture = _arguments.DeviceArchitecture;
logger.LogInformation($"Will attempt to run device on specified architecture: '{apkRequiredArchitecture}'");
}
else
{
apkRequiredArchitecture = ApkHelper.GetApkSupportedArchitectures(_arguments.AppPackagePath).First();
logger.LogInformation($"Will attempt to run device on detected architecture: '{apkRequiredArchitecture}'");
}
// Package Name is not guaranteed to match file name, so it needs to be mandatory.
string apkPackageName = _arguments.PackageName;
int instrumentationExitCode = (int)ExitCode.GENERAL_FAILURE;
try
{
using (logger.BeginScope("Initialization and setup of APK on device"))
{
// Make sure the adb server is freshly started
runner.KillAdbServer();
runner.StartAdbServer();
// Wait til at least device(s) are ready
runner.WaitForDevice();
// enumerate the devices attached and their architectures
// Tell ADB to only use that one (will always use the present one for systems w/ only 1 machine)
runner.SetActiveDevice(GetDeviceToUse(logger, runner, apkRequiredArchitecture));
// Empty log as we'll be uploading the full logcat for this execution
runner.ClearAdbLog();
logger.LogDebug($"Working with {runner.GetAdbVersion()}");
// If anything changed about the app, Install will fail; uninstall it first.
// (we'll ignore if it's not present)
// This is where mismatched architecture APKs fail.
runner.UninstallApk(apkPackageName);
if (runner.InstallApk(_arguments.AppPackagePath) != 0)
{
logger.LogCritical("Install failure: Test command cannot continue");
return(Task.FromResult(ExitCode.PACKAGE_INSTALLATION_FAILURE));
}
runner.KillApk(apkPackageName);
}
// No class name = default Instrumentation
(string stdOut, _, int exitCode) = runner.RunApkInstrumentation(apkPackageName, _arguments.InstrumentationName, _arguments.InstrumentationArguments, _arguments.Timeout);
using (logger.BeginScope("Post-test copy and cleanup"))
{
if (exitCode == (int)ExitCode.SUCCESS)
{
(var resultValues, var instrExitCode) = ParseInstrumentationOutputs(logger, stdOut);
instrumentationExitCode = instrExitCode;
foreach (string possibleResultKey in _xmlOutputVariableNames)
{
if (resultValues.ContainsKey(possibleResultKey))
{
logger.LogInformation($"Found XML result file: '{resultValues[possibleResultKey]}'(key: {possibleResultKey})");
runner.PullFiles(resultValues[possibleResultKey], _arguments.OutputDirectory);
}
}
}
// Optionally copy off an entire folder
if (!string.IsNullOrEmpty(_arguments.DeviceOutputFolder))
{
var logs = runner.PullFiles(_arguments.DeviceOutputFolder, _arguments.OutputDirectory);
foreach (string log in logs)
{
logger.LogDebug($"Found output file: {log}");
}
}
runner.DumpAdbLog(Path.Combine(_arguments.OutputDirectory, $"adb-logcat-{_arguments.PackageName}.log"));
runner.UninstallApk(apkPackageName);
}
if (instrumentationExitCode != (int)ExitCode.SUCCESS)
{
logger.LogError($"Non-success instrumentation exit code: {instrumentationExitCode}");
}
else
{
return(Task.FromResult(ExitCode.SUCCESS));
}
}
catch (Exception toLog)
{
logger.LogCritical(toLog, $"Failure to run test package: {toLog.Message}");
}
finally
{
runner.KillAdbServer();
}
return(Task.FromResult(ExitCode.GENERAL_FAILURE));
}
protected override Task <ExitCode> InvokeInternal(ILogger logger)
{
logger.LogDebug($"Android Test command called: App = {_arguments.AppPackagePath}{Environment.NewLine}Instrumentation Name = {_arguments.InstrumentationName}");
logger.LogDebug($"Output Directory:{_arguments.OutputDirectory}{Environment.NewLine}Timeout = {_arguments.Timeout.TotalSeconds} seconds.");
logger.LogDebug("Arguments to instrumentation:");
if (!File.Exists(_arguments.AppPackagePath))
{
logger.LogCritical($"Couldn't find {_arguments.AppPackagePath}!");
return(Task.FromResult(ExitCode.PACKAGE_NOT_FOUND));
}
var runner = new AdbRunner(logger);
// Package Name is not guaranteed to match file name, so it needs to be mandatory.
string apkPackageName = _arguments.PackageName;
int instrumentationExitCode = (int)ExitCode.GENERAL_FAILURE;
try
{
using (logger.BeginScope("Initialization and setup of APK on device"))
{
runner.KillAdbServer();
runner.StartAdbServer();
runner.WaitForDevice();
runner.ClearAdbLog();
logger.LogDebug($"Working with {runner.GetAdbVersion()}");
// If anything changed about the app, Install will fail; uninstall it first.
// (we'll ignore if it's not present)
runner.UninstallApk(apkPackageName);
if (runner.InstallApk(_arguments.AppPackagePath) != 0)
{
logger.LogCritical("Install failure: Test command cannot continue");
return(Task.FromResult(ExitCode.PACKAGE_INSTALLATION_FAILURE));
}
runner.KillApk(apkPackageName);
}
// No class name = default Instrumentation
(string stdOut, _, int exitCode) = runner.RunApkInstrumentation(apkPackageName, _arguments.InstrumentationName, _arguments.InstrumentationArguments, _arguments.Timeout);
using (logger.BeginScope("Post-test copy and cleanup"))
{
if (exitCode == (int)ExitCode.SUCCESS)
{
(var resultValues, var instrExitCode) = ParseInstrumentationOutputs(logger, stdOut);
instrumentationExitCode = instrExitCode;
foreach (string possibleResultKey in _xmlOutputVariableNames)
{
if (resultValues.ContainsKey(possibleResultKey))
{
logger.LogInformation($"Found XML result file: '{resultValues[possibleResultKey]}'(key: {possibleResultKey})");
runner.PullFiles(resultValues[possibleResultKey], _arguments.OutputDirectory);
}
}
}
// Optionally copy off an entire folder
if (!string.IsNullOrEmpty(_arguments.DeviceOutputFolder))
{
var logs = runner.PullFiles(_arguments.DeviceOutputFolder, _arguments.OutputDirectory);
foreach (string log in logs)
{
logger.LogDebug($"Detected output file: {log}");
}
}
runner.DumpAdbLog(Path.Combine(_arguments.OutputDirectory, $"adb-logcat-{_arguments.PackageName}.log"));
runner.UninstallApk(apkPackageName);
}
if (instrumentationExitCode != (int)ExitCode.SUCCESS)
{
logger.LogError($"Non-success instrumentation exit code: {instrumentationExitCode}");
}
else
{
return(Task.FromResult(ExitCode.SUCCESS));
}
}
catch (Exception toLog)
{
logger.LogCritical(toLog, $"Failure to run test package: {toLog.Message}");
}
finally
{
runner.KillAdbServer();
}
return(Task.FromResult(ExitCode.GENERAL_FAILURE));
}
protected override Task <int> InvokeInternal()
{
_log.LogDebug($"Android Test command called: App = {_arguments.AppPackagePath}{Environment.NewLine}Instrumentation Name = {_arguments.InstrumentationName}");
_log.LogDebug($"Output Directory:{_arguments.OutputDirectory}{Environment.NewLine}Working Directory = {_arguments.WorkingDirectory}{Environment.NewLine}Timeout = {_arguments.Timeout.TotalSeconds} seconds.");
_log.LogDebug("Arguments to instrumentation:");
if (!File.Exists(_arguments.AppPackagePath))
{
_log.LogCritical($"Couldn't find {_arguments.AppPackagePath}!");
return(Task.FromResult((int)ExitCodes.PACKAGE_NOT_FOUND));
}
var runner = new AdbRunner(_log);
string apkName = Path.GetFileNameWithoutExtension(_arguments.AppPackagePath);
try
{
using (_log.BeginScope("Initialization and setup of APK on device"))
{
runner.KillAdbServer();
runner.StartAdbServer();
runner.ClearAdbLog();
_log.LogDebug($"Working with {runner.GetAdbVersion()}");
// If anything changed about the app, Install will fail; uninstall it first.
// (we'll ignore if it's not present)
runner.UninstallApk(apkName);
if (runner.InstallApk(_arguments.AppPackagePath) != 0)
{
_log.LogCritical("Install failure: Test command cannot continue");
return(Task.FromResult((int)ExitCodes.PACKAGE_INSTALLATION_FAILURE));
}
runner.KillApk(apkName);
// App needs to be able to read and write the storage folders we use for IO
runner.GrantPermissions(apkName,
new string[] { "android.permission.READ_EXTERNAL_STORAGE",
"android.permission.WRITE_EXTERNAL_STORAGE" });
}
// No class name = default Instrumentation
runner.RunApkInstrumentation(apkName, _arguments.InstrumentationName, _arguments.InstrumentationArguments);
using (_log.BeginScope("Post-test copy and cleanup"))
{
var logs = runner.PullFiles("/sdcard/Documents/helix-results", _arguments.OutputDirectory);
foreach (string log in logs)
{
_log.LogDebug($"Detected output file: {log}");
}
runner.DumpAdbLog(Path.Combine(_arguments.OutputDirectory, "adb-logcat.log"));
runner.UninstallApk(apkName);
}
return(Task.FromResult((int)ExitCodes.SUCCESS));
}
catch (Exception toLog)
{
_log.LogCritical(toLog, $"Failure to run test package: {toLog.Message}");
}
finally
{
runner.KillAdbServer();
}
return(Task.FromResult((int)ExitCodes.GENERAL_FAILURE));
}
protected override Task <int> InvokeInternal()
{
_log.LogDebug($"Android Test command called: App = {_arguments.AppPackagePath}{Environment.NewLine}Instrumentation Name = {_arguments.InstrumentationName}");
_log.LogDebug($"Output Directory:{_arguments.OutputDirectory}{Environment.NewLine}Working Directory = {_arguments.WorkingDirectory}{Environment.NewLine}Timeout = {_arguments.Timeout.TotalSeconds} seconds.");
_log.LogDebug("Arguments to instrumentation:");
if (!File.Exists(_arguments.AppPackagePath))
{
_log.LogCritical($"Couldn't find {_arguments.AppPackagePath}!");
return(Task.FromResult((int)ExitCodes.PACKAGE_NOT_FOUND));
}
var runner = new AdbRunner(_log);
// Package Name is not guaranteed to match file name, so it needs to be mandatory.
string apkPackageName = _arguments.PackageName;
try
{
using (_log.BeginScope("Initialization and setup of APK on device"))
{
runner.KillAdbServer();
runner.StartAdbServer();
runner.ClearAdbLog();
_log.LogDebug($"Working with {runner.GetAdbVersion()}");
// If anything changed about the app, Install will fail; uninstall it first.
// (we'll ignore if it's not present)
runner.UninstallApk(apkPackageName);
if (runner.InstallApk(_arguments.AppPackagePath) != 0)
{
_log.LogCritical("Install failure: Test command cannot continue");
return(Task.FromResult((int)ExitCodes.PACKAGE_INSTALLATION_FAILURE));
}
runner.KillApk(apkPackageName);
}
// No class name = default Instrumentation
runner.RunApkInstrumentation(apkPackageName, _arguments.InstrumentationName, _arguments.InstrumentationArguments, _arguments.Timeout);
using (_log.BeginScope("Post-test copy and cleanup"))
{
if (!string.IsNullOrEmpty(_arguments.DeviceOutputFolder))
{
var logs = runner.PullFiles(_arguments.DeviceOutputFolder, _arguments.OutputDirectory);
foreach (string log in logs)
{
_log.LogDebug($"Detected output file: {log}");
}
}
runner.DumpAdbLog(Path.Combine(_arguments.OutputDirectory, $"adb-logcat-{_arguments.PackageName}.log"));
runner.UninstallApk(apkPackageName);
}
return(Task.FromResult((int)ExitCodes.SUCCESS));
}
catch (Exception toLog)
{
_log.LogCritical(toLog, $"Failure to run test package: {toLog.Message}");
}
finally
{
runner.KillAdbServer();
}
return(Task.FromResult((int)ExitCodes.GENERAL_FAILURE));
}