Add ExecuteShellCommandAsync in DeviceExtensions

Author: wherewhere

AdvancedSharpAdbClient.Tests/DeviceCommands/DeviceExtensionsTests.Async.cs

@@ -14,7 +14,8 @@ public async void ExecuteServerCommandAsyncTest()
         {
             const string command = nameof(command);
             IAdbSocket socket = Substitute.For<IAdbSocket>();
-            IShellOutputReceiver receiver = Substitute.For<IShellOutputReceiver>();
+            static bool predicate(string x) => true;
+            IShellOutputReceiver receiver = new FunctionOutputReceiver(predicate);
             List<string> result = ["Hello", "World", "!"];
 
             IAdbClient client = Substitute.For<IAdbClient>();
@@ -39,6 +40,7 @@ public async void ExecuteServerCommandAsyncTest()
 
             await client.ExecuteShellCommandAsync(Device, command);
             await client.ExecuteShellCommandAsync(Device, command, receiver);
+            await client.ExecuteShellCommandAsync(Device, command, predicate);
         }
 
         /// <summary>

AdvancedSharpAdbClient.Tests/DeviceCommands/DeviceExtensionsTests.cs

@@ -20,7 +20,8 @@ public partial class DeviceExtensionsTests
         public void ExecuteServerCommandTest()
         {
             const string command = nameof(command);
-            IShellOutputReceiver receiver = Substitute.For<IShellOutputReceiver>();
+            static bool predicate(string x) => true;
+            IShellOutputReceiver receiver = new FunctionOutputReceiver(predicate);
 
             IAdbClient client = Substitute.For<IAdbClient>();
             client.When(x => x.ExecuteRemoteCommand(Arg.Any<string>(), Arg.Any<DeviceData>()))
@@ -40,6 +41,7 @@ public void ExecuteServerCommandTest()
 
             client.ExecuteShellCommand(Device, command);
             client.ExecuteShellCommand(Device, command, receiver);
+            client.ExecuteShellCommand(Device, command, predicate);
         }
 
         /// <summary>

AdvancedSharpAdbClient/DeviceCommands/DeviceExtensions.Async.cs

@@ -36,9 +36,21 @@ public static Task ExecuteShellCommandAsync(this IAdbClient client, DeviceData d
         /// <param name="receiver">Optionally, a <see cref="IShellOutputReceiver"/> that processes the command output.</param>
         /// <param name="cancellationToken">A <see cref="CancellationToken"/> which can be used to cancel the asynchronous operation.</param>
         /// <returns>A <see cref="Task"/> which represents the asynchronous operation.</returns>
-        public static Task ExecuteShellCommandAsync(this IAdbClient client, DeviceData device, string command, IShellOutputReceiver receiver, CancellationToken cancellationToken = default) =>
+        public static Task ExecuteShellCommandAsync(this IAdbClient client, DeviceData device, string command, IShellOutputReceiver? receiver, CancellationToken cancellationToken = default) =>
             client.ExecuteRemoteCommandAsync(command, device, receiver, AdbClient.Encoding, cancellationToken);
 
+        /// <summary>
+        /// Asynchronously executes a shell command on the device.
+        /// </summary>
+        /// <param name="client">The <see cref="IAdbClient"/> to use when executing the command.</param>
+        /// <param name="device">The device on which to run the command.</param>
+        /// <param name="command">The command to execute.</param>
+        /// <param name="predicate">Optionally, a <see cref="Func{String, Boolean}"/> that processes the command output.</param>
+        /// <param name="cancellationToken">A <see cref="CancellationToken"/> which can be used to cancel the asynchronous operation.</param>
+        /// <returns>A <see cref="Task"/> which represents the asynchronous operation.</returns>
+        public static Task ExecuteShellCommandAsync(this IAdbClient client, DeviceData device, string command, Func<string, bool>? predicate, CancellationToken cancellationToken = default) =>
+            client.ExecuteRemoteCommandAsync(command, device, predicate.AsShellOutputReceiver(), AdbClient.Encoding, cancellationToken);
+
         /// <summary>
         /// Asynchronously gets the current device screen snapshot asynchronously.
         /// </summary>
@@ -387,7 +399,7 @@ public static async Task PullAsync(this IAdbClient client, DeviceData device,
             CancellationToken cancellationToken = default)
         {
             using ISyncService service = Factories.SyncServiceFactory(client, device);
-            await service.PullAsync(remotePath, stream, progress == null ? null : progress.Report, cancellationToken).ConfigureAwait(false);
+            await service.PullAsync(remotePath, stream, progress.AsAction(), cancellationToken).ConfigureAwait(false);
         }
 
         /// <summary>
@@ -408,7 +420,7 @@ public static async Task PushAsync(this IAdbClient client, DeviceData device,
             CancellationToken cancellationToken = default)
         {
             using ISyncService service = Factories.SyncServiceFactory(client, device);
-            await service.PushAsync(stream, remotePath, permissions, timestamp, progress == null ? null : progress.Report, cancellationToken).ConfigureAwait(false);
+            await service.PushAsync(stream, remotePath, permissions, timestamp, progress.AsAction(), cancellationToken).ConfigureAwait(false);
         }
 
         /// <summary>

AdvancedSharpAdbClient/DeviceCommands/DeviceExtensions.cs

@@ -33,9 +33,19 @@ public static void ExecuteShellCommand(this IAdbClient client, DeviceData device
         /// <param name="device">The device on which to run the command.</param>
         /// <param name="command">The command to execute.</param>
         /// <param name="receiver">Optionally, a <see cref="IShellOutputReceiver"/> that processes the command output.</param>
-        public static void ExecuteShellCommand(this IAdbClient client, DeviceData device, string command, IShellOutputReceiver receiver) =>
+        public static void ExecuteShellCommand(this IAdbClient client, DeviceData device, string command, IShellOutputReceiver? receiver) =>
             client.ExecuteRemoteCommand(command, device, receiver, AdbClient.Encoding);
 
+        /// <summary>
+        /// Executes a shell command on the device.
+        /// </summary>
+        /// <param name="client">The <see cref="IAdbClient"/> to use when executing the command.</param>
+        /// <param name="device">The device on which to run the command.</param>
+        /// <param name="command">The command to execute.</param>
+        /// <param name="predicate">Optionally, a <see cref="Func{String, Boolean}"/> that processes the command output.</param>
+        public static void ExecuteShellCommand(this IAdbClient client, DeviceData device, string command, Func<string, bool>? predicate) =>
+            client.ExecuteRemoteCommand(command, device, predicate.AsShellOutputReceiver(), AdbClient.Encoding);
+
         /// <summary>
         /// Gets the current device screen snapshot.
         /// </summary>
@@ -334,7 +344,7 @@ public static void Pull(this IAdbClient client, DeviceData device,
             in bool isCancelled = false)
         {
             using ISyncService service = Factories.SyncServiceFactory(client, device);
-            service.Pull(remotePath, stream, progress == null ? null : progress.Report, in isCancelled);
+            service.Pull(remotePath, stream, progress.AsAction(), in isCancelled);
         }
 
         /// <summary>
@@ -354,7 +364,7 @@ public static void Push(this IAdbClient client, DeviceData device,
             in bool isCancelled = false)
         {
             using ISyncService service = Factories.SyncServiceFactory(client, device);
-            service.Push(stream, remotePath, permissions, timestamp, progress == null ? null : progress.Report, in isCancelled);
+            service.Push(stream, remotePath, permissions, timestamp, progress.AsAction(), in isCancelled);
         }
 
         /// <summary>

AdvancedSharpAdbClient/DeviceCommands/PackageManager.Async.cs

@@ -353,7 +353,7 @@ await splitRemoteFilePaths.Select(async splitRemoteFilePath =>
         /// <param name="arguments">The arguments to pass to <c>adb install</c>.</param>
         /// <returns>A <see cref="Task"/> which represents the asynchronous operation.</returns>
         public virtual async Task InstallPackageAsync(string packageFilePath, IProgress<InstallProgressEventArgs>? progress = null, CancellationToken cancellationToken = default, params string[] arguments) =>
-            await InstallPackageAsync(packageFilePath, progress == null ? null : progress.Report, cancellationToken, arguments).ConfigureAwait(false);
+            await InstallPackageAsync(packageFilePath, progress.AsAction(), cancellationToken, arguments).ConfigureAwait(false);
 
         /// <summary>
         /// Asynchronously installs the application package that was pushed to a temporary location on the device.
@@ -365,7 +365,7 @@ public virtual async Task InstallPackageAsync(string packageFilePath, IProgress<
         /// <param name="arguments">The arguments to pass to <c>pm install</c>.</param>
         /// <returns>A <see cref="Task"/> which represents the asynchronous operation.</returns>
         public virtual async Task InstallRemotePackageAsync(string remoteFilePath, IProgress<InstallProgressEventArgs>? progress = null, CancellationToken cancellationToken = default, params string[] arguments) =>
-            await InstallRemotePackageAsync(remoteFilePath, progress == null ? null : progress.Report, cancellationToken, arguments).ConfigureAwait(false);
+            await InstallRemotePackageAsync(remoteFilePath, progress.AsAction(), cancellationToken, arguments).ConfigureAwait(false);
 
         /// <summary>
         /// Asynchronously installs Android multiple application on device.
@@ -378,7 +378,7 @@ public virtual async Task InstallRemotePackageAsync(string remoteFilePath, IProg
         /// <param name="arguments">The arguments to pass to <c>pm install-create</c>.</param>
         /// <returns>A <see cref="Task"/> which represents the asynchronous operation.</returns>
         public virtual async Task InstallMultiplePackageAsync(string basePackageFilePath, IEnumerable<string> splitPackageFilePaths, IProgress<InstallProgressEventArgs>? progress = null, CancellationToken cancellationToken = default, params string[] arguments) =>
-            await InstallMultiplePackageAsync(basePackageFilePath, splitPackageFilePaths, progress == null ? null : progress.Report, cancellationToken, arguments).ConfigureAwait(false);
+            await InstallMultiplePackageAsync(basePackageFilePath, splitPackageFilePaths, progress.AsAction(), cancellationToken, arguments).ConfigureAwait(false);
 
         /// <summary>
         /// Asynchronously installs Android multiple application on device.
@@ -391,7 +391,7 @@ public virtual async Task InstallMultiplePackageAsync(string basePackageFilePath
         /// <param name="arguments">The arguments to pass to <c>pm install-create</c>.</param>
         /// <returns>A <see cref="Task"/> which represents the asynchronous operation.</returns>
         public virtual async Task InstallMultiplePackageAsync(IEnumerable<string> splitPackageFilePaths, string packageName, IProgress<InstallProgressEventArgs>? progress = null, CancellationToken cancellationToken = default, params string[] arguments) =>
-            await InstallMultiplePackageAsync(splitPackageFilePaths, packageName, progress == null ? null : progress.Report, cancellationToken, arguments).ConfigureAwait(false);
+            await InstallMultiplePackageAsync(splitPackageFilePaths, packageName, progress.AsAction(), cancellationToken, arguments).ConfigureAwait(false);
 
         /// <summary>
         /// Asynchronously installs the multiple application package that was pushed to a temporary location on the device.
@@ -404,7 +404,7 @@ public virtual async Task InstallMultiplePackageAsync(IEnumerable<string> splitP
         /// <param name="arguments">The arguments to pass to <c>pm install-create</c>.</param>
         /// <returns>A <see cref="Task"/> which represents the asynchronous operation.</returns>
         public virtual async Task InstallMultipleRemotePackageAsync(string baseRemoteFilePath, IEnumerable<string> splitRemoteFilePaths, IProgress<InstallProgressEventArgs>? progress = null, CancellationToken cancellationToken = default, params string[] arguments) =>
-            await InstallMultipleRemotePackageAsync(baseRemoteFilePath, splitRemoteFilePaths, progress == null ? null : progress.Report, cancellationToken, arguments).ConfigureAwait(false);
+            await InstallMultipleRemotePackageAsync(baseRemoteFilePath, splitRemoteFilePaths, progress.AsAction(), cancellationToken, arguments).ConfigureAwait(false);
 
         /// <summary>
         /// Asynchronously installs the multiple application package that was pushed to a temporary location on the device.
@@ -417,7 +417,7 @@ public virtual async Task InstallMultipleRemotePackageAsync(string baseRemoteFil
         /// <param name="arguments">The arguments to pass to <c>pm install-create</c>.</param>
         /// <returns>A <see cref="Task"/> which represents the asynchronous operation.</returns>
         public virtual async Task InstallMultipleRemotePackageAsync(IEnumerable<string> splitRemoteFilePaths, string packageName, IProgress<InstallProgressEventArgs>? progress = null, CancellationToken cancellationToken = default, params string[] arguments) =>
-            await InstallMultipleRemotePackageAsync(splitRemoteFilePaths, packageName, progress == null ? null : progress.Report, cancellationToken, arguments).ConfigureAwait(false);
+            await InstallMultipleRemotePackageAsync(splitRemoteFilePaths, packageName, progress.AsAction(), cancellationToken, arguments).ConfigureAwait(false);
 #endif
 
         /// <summary>

AdvancedSharpAdbClient/DeviceCommands/PackageManager.cs

@@ -401,7 +401,7 @@ public virtual void InstallMultipleRemotePackage(IEnumerable<string> splitRemote
         /// The progress is reported as <see cref="InstallProgressEventArgs"/>, representing the state of installation.</param>
         /// <param name="arguments">The arguments to pass to <c>adb install</c>.</param>
         public virtual void InstallPackage(string packageFilePath, IProgress<InstallProgressEventArgs>? progress = null, params string[] arguments) =>
-            InstallPackage(packageFilePath, progress == null ? null : progress.Report, arguments);
+            InstallPackage(packageFilePath, progress.AsAction(), arguments);
 
         /// <summary>
         /// Installs the application package that was pushed to a temporary location on the device.
@@ -411,7 +411,7 @@ public virtual void InstallPackage(string packageFilePath, IProgress<InstallProg
         /// The progress is reported as <see cref="InstallProgressEventArgs"/>, representing the state of installation.</param>
         /// <param name="arguments">The arguments to pass to <c>adb install</c>.</param>
         public virtual void InstallRemotePackage(string remoteFilePath, IProgress<InstallProgressEventArgs>? progress = null, params string[] arguments) =>
-            InstallRemotePackage(remoteFilePath, progress == null ? null : progress.Report, arguments);
+            InstallRemotePackage(remoteFilePath, progress.AsAction(), arguments);
 
         /// <summary>
         /// Installs Android multiple application on device.
@@ -422,7 +422,7 @@ public virtual void InstallRemotePackage(string remoteFilePath, IProgress<Instal
         /// The progress is reported as <see cref="InstallProgressEventArgs"/>, representing the state of installation.</param>
         /// <param name="arguments">The arguments to pass to <c>pm install-create</c>.</param>
         public virtual void InstallMultiplePackage(string basePackageFilePath, IEnumerable<string> splitPackageFilePaths, IProgress<InstallProgressEventArgs>? progress = null, params string[] arguments) =>
-            InstallMultiplePackage(basePackageFilePath, splitPackageFilePaths, progress == null ? null : progress.Report, arguments);
+            InstallMultiplePackage(basePackageFilePath, splitPackageFilePaths, progress.AsAction(), arguments);
 
         /// <summary>
         /// Installs Android multiple application on device.
@@ -433,7 +433,7 @@ public virtual void InstallMultiplePackage(string basePackageFilePath, IEnumerab
         /// The progress is reported as <see cref="InstallProgressEventArgs"/>, representing the state of installation.</param>
         /// <param name="arguments">The arguments to pass to <c>pm install-create</c>.</param>
         public virtual void InstallMultiplePackage(IEnumerable<string> splitPackageFilePaths, string packageName, IProgress<InstallProgressEventArgs>? progress = null, params string[] arguments) =>
-            InstallMultiplePackage(splitPackageFilePaths, packageName, progress == null ? null : progress.Report, arguments);
+            InstallMultiplePackage(splitPackageFilePaths, packageName, progress.AsAction(), arguments);
 
         /// <summary>
         /// Installs the multiple application package that was pushed to a temporary location on the device.
@@ -444,7 +444,7 @@ public virtual void InstallMultiplePackage(IEnumerable<string> splitPackageFileP
         /// The progress is reported as <see cref="InstallProgressEventArgs"/>, representing the state of installation.</param>
         /// <param name="arguments">The arguments to pass to <c>pm install-create</c>.</param>
         public virtual void InstallMultipleRemotePackage(string baseRemoteFilePath, IEnumerable<string> splitRemoteFilePaths, IProgress<InstallProgressEventArgs>? progress = null, params string[] arguments) =>
-            InstallMultipleRemotePackage(baseRemoteFilePath, splitRemoteFilePaths, progress == null ? null : progress.Report, arguments);
+            InstallMultipleRemotePackage(baseRemoteFilePath, splitRemoteFilePaths, progress.AsAction(), arguments);
 
         /// <summary>
         /// Installs the multiple application package that was pushed to a temporary location on the device.
@@ -455,7 +455,7 @@ public virtual void InstallMultipleRemotePackage(string baseRemoteFilePath, IEnu
         /// The progress is reported as <see cref="InstallProgressEventArgs"/>, representing the state of installation.</param>
         /// <param name="arguments">The arguments to pass to <c>pm install-create</c>.</param>
         public virtual void InstallMultipleRemotePackage(IEnumerable<string> splitRemoteFilePaths, string packageName, IProgress<InstallProgressEventArgs>? progress = null, params string[] arguments) =>
-            InstallMultipleRemotePackage(splitRemoteFilePaths, packageName, progress == null ? null : progress.Report, arguments);
+            InstallMultipleRemotePackage(splitRemoteFilePaths, packageName, progress.AsAction(), arguments);
 #endif
 
         /// <summary>