Add timeout option for IAdbCommandLineClient

wherewhere · wherewhere · commit 97250edadb1b · 2024-04-06T16:37:32.000+08:00
diff --git a/AdvancedSharpAdbClient.Tests/Dummys/DummyAdbCommandLineClient.cs b/AdvancedSharpAdbClient.Tests/Dummys/DummyAdbCommandLineClient.cs
@@ -9,12 +9,8 @@ namespace AdvancedSharpAdbClient.Tests
     /// <summary>
     /// A mock implementation of the <see cref="IAdbCommandLineClient"/> class.
     /// </summary>
-    internal class DummyAdbCommandLineClient : AdbCommandLineClient
+    internal class DummyAdbCommandLineClient() : AdbCommandLineClient(ServerName)
     {
-        public DummyAdbCommandLineClient() : base(ServerName)
-        {
-        }
-
         public AdbCommandLineStatus Version { get; set; }
 
         public bool ServerStarted { get; private set; }
@@ -24,7 +20,7 @@ public DummyAdbCommandLineClient() : base(ServerName)
 
         public override Task<bool> CheckAdbFileExistsAsync(string adbPath, CancellationToken cancellationToken = default) => Task.FromResult(true);
 
-        protected override int RunProcess(string filename, string command, ICollection<string> errorOutput, ICollection<string> standardOutput)
+        protected override int RunProcess(string filename, string command, ICollection<string> errorOutput, ICollection<string> standardOutput, int timeout)
         {
             if (filename == AdbPath)
             {
@@ -55,7 +51,7 @@ protected override int RunProcess(string filename, string command, ICollection<s
         protected override async Task<int> RunProcessAsync(string filename, string command, ICollection<string> errorOutput, ICollection<string> standardOutput, CancellationToken cancellationToken = default)
         {
             await Task.Yield();
-            return RunProcess(filename, command, errorOutput, standardOutput);
+            return RunProcess(filename, command, errorOutput, standardOutput, Timeout.Infinite);
         }
 
         private static string ServerName => RuntimeInformation.IsOSPlatform(OSPlatform.Windows) ? "adb.exe" : "adb";
diff --git a/AdvancedSharpAdbClient/AdbCommandLineClient.Async.cs b/AdvancedSharpAdbClient/AdbCommandLineClient.Async.cs
@@ -9,6 +9,7 @@
 using System.Diagnostics;
 using System.Diagnostics.CodeAnalysis;
 using System.IO;
+using System.Security.Cryptography;
 using System.Threading;
 
 namespace AdvancedSharpAdbClient
@@ -93,8 +94,7 @@ public virtual Task<bool> CheckAdbFileExistsAsync(string adbPath, CancellationTo
         /// This value can be <see langword="null"/> if you are not interested in the standard 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>
-        /// <remarks>Use this command only for <c>adb</c> commands that return immediately, such as
-        /// <c>adb version</c>. This operation times out after 5 seconds.</remarks>
+        /// <remarks>Use this command only for <c>adb</c> commands that return immediately, such as <c>adb version</c>.</remarks>
         /// <exception cref="AdbException">The process exited with an exit code other than <c>0</c>.</exception>
         protected async Task RunAdbProcessAsync(string command, ICollection<string>? errorOutput, ICollection<string>? standardOutput, CancellationToken cancellationToken = default)
         {
@@ -113,8 +113,7 @@ protected async Task RunAdbProcessAsync(string command, ICollection<string>? err
         /// This value can be <see langword="null"/> if you are not interested in the standard output.</param>
         /// <param name="cancellationToken">A <see cref="CancellationToken"/> which can be used to cancel the asynchronous operation.</param>
         /// <returns>A <see cref="Task{Int32}"/> which returns the return code of the <c>adb</c> process.</returns>
-        /// <remarks>Use this command only for <c>adb</c> commands that return immediately, such as
-        /// <c>adb version</c>. This operation times out after 5 seconds.</remarks>
+        /// <remarks>Use this command only for <c>adb</c> commands that return immediately, such as <c>adb version</c>.</remarks>
         protected async Task<int> RunAdbProcessInnerAsync(string command, ICollection<string>? errorOutput, ICollection<string>? standardOutput, CancellationToken cancellationToken = default)
         {
             ExceptionExtensions.ThrowIfNull(command);
@@ -124,7 +123,14 @@ protected async Task<int> RunAdbProcessInnerAsync(string command, ICollection<st
         /// <summary>
         /// Asynchronously runs process, invoking a specific command, and reads the standard output and standard error output.
         /// </summary>
-        /// <returns>The return code of the process.</returns>
+        /// <param name="filename">The filename of the process to start.</param>
+        /// <param name="command">The command to invoke, such as <c>version</c> or <c>start-server</c>.</param>
+        /// <param name="errorOutput">A list in which to store the standard error output. Each line is added as a new entry.
+        /// This value can be <see langword="null"/> if you are not interested in the standard error.</param>
+        /// <param name="standardOutput">A list in which to store the standard output. Each line is added as a new entry.
+        /// This value can be <see langword="null"/> if you are not interested in the standard output.</param>
+        /// <param name="cancellationToken">A <see cref="CancellationToken"/> which can be used to cancel the asynchronous operation.</param>
+        /// <returns>A <see cref="Task{Int32}"/> which returns the return code of the process.</returns>
 #if !HAS_PROCESS
         [DoesNotReturn]
 #endif
@@ -142,33 +148,19 @@ protected virtual async Task<int> RunProcessAsync(string filename, string comman
 
             using Process process = Process.Start(psi) ?? throw new AdbException($"The adb process could not be started. The process returned null when starting {filename} {command}");
 
-#if NET5_0_OR_GREATER
-            using (CancellationTokenSource completionSource = new(TimeSpan.FromMilliseconds(5000)))
+            using (CancellationTokenRegistration registration = cancellationToken.Register(process.Kill))
             {
-                try
-                {
-                    await process.WaitForExitAsync(completionSource.Token).ConfigureAwait(false);
-                }
-                catch (OperationCanceledException) when (completionSource.IsCancellationRequested)
-                {
-                    if (!process.HasExited)
-                    {
-                        process.Kill();
-                    }
-                }
+                string standardErrorString = await process.StandardError.ReadToEndAsync(cancellationToken).ConfigureAwait(false);
+                string standardOutputString = await process.StandardOutput.ReadToEndAsync(cancellationToken).ConfigureAwait(false);
+
+                errorOutput?.AddRange(standardErrorString.Split(separator, StringSplitOptions.RemoveEmptyEntries));
+                standardOutput?.AddRange(standardOutputString.Split(separator, StringSplitOptions.RemoveEmptyEntries));
             }
-#else
-            if (!process.WaitForExit(5000))
+
+            if (!process.HasExited)
             {
                 process.Kill();
             }
-#endif
-
-            string standardErrorString = await process.StandardError.ReadToEndAsync(cancellationToken).ConfigureAwait(false);
-            string standardOutputString = await process.StandardOutput.ReadToEndAsync(cancellationToken).ConfigureAwait(false);
-
-            errorOutput?.AddRange(standardErrorString.Split(separator, StringSplitOptions.RemoveEmptyEntries));
-            standardOutput?.AddRange(standardOutputString.Split(separator, StringSplitOptions.RemoveEmptyEntries));
 
             // get the return code from the process
             return process.ExitCode;
diff --git a/AdvancedSharpAdbClient/AdbCommandLineClient.cs b/AdvancedSharpAdbClient/AdbCommandLineClient.cs
@@ -8,6 +8,7 @@
 using System.Diagnostics;
 using System.Diagnostics.CodeAnalysis;
 using System.IO;
+using System.Threading;
 
 namespace AdvancedSharpAdbClient
 {
@@ -85,9 +86,9 @@ public AdbCommandLineStatus GetVersion()
         }
 
         /// <inheritdoc/>
-        public void StartServer()
+        public void StartServer(int timeout = Timeout.Infinite)
         {
-            int status = RunAdbProcessInner("start-server", null, null);
+            int status = RunAdbProcessInner("start-server", null, null, timeout);
             if (status == 0) { return; }
 
             // Starting the adb server failed for whatever reason. This can happen if adb.exe
@@ -97,15 +98,17 @@ public void StartServer()
 
             // Try again. This time, we don't call "Inner", and an exception will be thrown if the start operation fails
             // again. We'll let that exception bubble up the stack.
-            RunAdbProcess("start-server", null, null);
+            RunAdbProcess("start-server", null, null, timeout);
         }
 
         /// <inheritdoc/>
-        public virtual List<string> ExecuteAdbCommand(string command)
+        /// <remarks>Use this command only for <c>adb</c> commands that return immediately, such as
+        /// <c>adb version</c>. This operation times out after 5 seconds.</remarks>
+        public virtual List<string> ExecuteAdbCommand(string command, int timeout = 5000)
         {
             List<string> errorOutput = [];
             List<string> standardOutput = [];
-            int status = RunAdbProcessInner(command, errorOutput, standardOutput);
+            int status = RunAdbProcessInner(command, errorOutput, standardOutput, timeout);
             if (errorOutput.Count > 0)
             {
                 string error = StringExtensions.Join(Environment.NewLine, errorOutput!);
@@ -170,12 +173,13 @@ protected virtual void EnsureIsValidAdbFile(string adbPath)
         /// This value can be <see langword="null"/> if you are not interested in the standard error.</param>
         /// <param name="standardOutput">A list in which to store the standard output. Each line is added as a new entry.
         /// This value can be <see langword="null"/> if you are not interested in the standard output.</param>
+        /// <param name="timeout">The timeout in milliseconds to wait for the <c>adb</c> process to exit.</param>
         /// <remarks>Use this command only for <c>adb</c> commands that return immediately, such as
-        /// <c>adb version</c>. This operation times out after 5 seconds.</remarks>
+        /// <c>adb version</c>. This operation times out after 5 seconds in default.</remarks>
         /// <exception cref="AdbException">The process exited with an exit code other than <c>0</c>.</exception>
-        protected void RunAdbProcess(string command, ICollection<string>? errorOutput, ICollection<string>? standardOutput)
+        protected void RunAdbProcess(string command, ICollection<string>? errorOutput, ICollection<string>? standardOutput, int timeout = 5000)
         {
-            int status = RunAdbProcessInner(command, errorOutput, standardOutput);
+            int status = RunAdbProcessInner(command, errorOutput, standardOutput, timeout);
             if (status != 0) { throw new AdbException($"The adb process returned error code {status} when running command {command}"); }
         }
 
@@ -188,13 +192,14 @@ protected void RunAdbProcess(string command, ICollection<string>? errorOutput, I
         /// This value can be <see langword="null"/> if you are not interested in the standard error.</param>
         /// <param name="standardOutput">A list in which to store the standard output. Each line is added as a new entry.
         /// This value can be <see langword="null"/> if you are not interested in the standard output.</param>
+        /// <param name="timeout">The timeout in milliseconds to wait for the <c>adb</c> process to exit.</param>
         /// <returns>The return code of the <c>adb</c> process.</returns>
         /// <remarks>Use this command only for <c>adb</c> commands that return immediately, such as
-        /// <c>adb version</c>. This operation times out after 5 seconds.</remarks>
-        protected int RunAdbProcessInner(string command, ICollection<string>? errorOutput, ICollection<string>? standardOutput)
+        /// <c>adb version</c>. This operation times out after 5 seconds in default.</remarks>
+        protected int RunAdbProcessInner(string command, ICollection<string>? errorOutput, ICollection<string>? standardOutput, int timeout = 5000)
         {
             ExceptionExtensions.ThrowIfNull(command);
-            return RunProcess(AdbPath, command, errorOutput, standardOutput);
+            return RunProcess(AdbPath, command, errorOutput, standardOutput, timeout);
         }
 
         /// <summary>
@@ -235,11 +240,18 @@ protected virtual void KillProcess(string processName)
         /// <summary>
         /// Runs process, invoking a specific command, and reads the standard output and standard error output.
         /// </summary>
+        /// <param name="filename">The filename of the process to start.</param>
+        /// <param name="command">The command to invoke, such as <c>version</c> or <c>start-server</c>.</param>
+        /// <param name="errorOutput">A list in which to store the standard error output. Each line is added as a new entry.
+        /// This value can be <see langword="null"/> if you are not interested in the standard error.</param>
+        /// <param name="standardOutput">A list in which to store the standard output. Each line is added as a new entry.
+        /// This value can be <see langword="null"/> if you are not interested in the standard output.</param>
+        /// <param name="timeout">The timeout in milliseconds to wait for the process to exit.</param>
         /// <returns>The return code of the process.</returns>
 #if !HAS_PROCESS
         [DoesNotReturn]
 #endif
-        protected virtual int RunProcess(string filename, string command, ICollection<string>? errorOutput, ICollection<string>? standardOutput)
+        protected virtual int RunProcess(string filename, string command, ICollection<string>? errorOutput, ICollection<string>? standardOutput, int timeout)
         {
 #if HAS_PROCESS
             ProcessStartInfo psi = new(filename, command)
@@ -254,7 +266,7 @@ protected virtual int RunProcess(string filename, string command, ICollection<st
             using Process process = Process.Start(psi) ?? throw new AdbException($"The adb process could not be started. The process returned null when starting {filename} {command}");
 
             // get the return code from the process
-            if (!process.WaitForExit(5000))
+            if (!process.WaitForExit(timeout))
             {
                 process.Kill();
             }
diff --git a/AdvancedSharpAdbClient/AdbServer.cs b/AdvancedSharpAdbClient/AdbServer.cs
@@ -7,6 +7,7 @@
 using System.Globalization;
 using System.Net;
 using System.Net.Sockets;
+using System.Threading;
 
 namespace AdvancedSharpAdbClient
 {
@@ -199,7 +200,7 @@ public StartServerResult StartServer(string adbPath, bool restartServerIfNewer =
                         || (restartServerIfNewer && serverStatus.Version < commandLineVersion))
                     {
                         StopServer();
-                        commandLineClient.StartServer();
+                        commandLineClient.StartServer(Timeout.Infinite);
                         return StartServerResult.RestartedOutdatedDaemon;
                     }
                     else
@@ -209,7 +210,7 @@ public StartServerResult StartServer(string adbPath, bool restartServerIfNewer =
                 }
                 else
                 {
-                    commandLineClient.StartServer();
+                    commandLineClient.StartServer(Timeout.Infinite);
                     return StartServerResult.Started;
                 }
             }
diff --git a/AdvancedSharpAdbClient/Exceptions/DeviceNotFoundException.cs b/AdvancedSharpAdbClient/Exceptions/DeviceNotFoundException.cs
@@ -23,7 +23,7 @@ public DeviceNotFoundException() : base("The device was not found.")
         /// Initializes a new instance of the <see cref="DeviceNotFoundException"/> class.
         /// </summary>
         /// <param name="device">The device.</param>
-        public DeviceNotFoundException(string? device) : base("The device '" + device + "' was not found.")
+        public DeviceNotFoundException(string? device) : base($"The device '{device}' was not found.")
         {
         }
 
diff --git a/AdvancedSharpAdbClient/Interfaces/IAdbCommandLineClient.cs b/AdvancedSharpAdbClient/Interfaces/IAdbCommandLineClient.cs
@@ -20,14 +20,16 @@ public partial interface IAdbCommandLineClient
         /// <summary>
         /// Starts the adb server by running the <c>adb start-server</c> command.
         /// </summary>
-        void StartServer();
+        /// <param name="timeout">The timeout in milliseconds to wait for the <c>adb</c> process to exit.</param>
+        void StartServer(int timeout);
 
         /// <summary>
         /// Runs the <c>adb.exe</c> process, invoking a specific <paramref name="command"/>, and reads the standard output.
         /// </summary>
         /// <param name="command">The <c>adb.exe</c> command to invoke, such as <c>version</c> or <c>start-server</c>.</param>
+        /// <param name="timeout">The timeout in milliseconds to wait for the <c>adb</c> process to exit.</param>
         /// <return>A list in which to store the standard output. Each line is added as a new entry.</return>
-        List<string> ExecuteAdbCommand(string command);
+        List<string> ExecuteAdbCommand(string command, int timeout);
 
         /// <summary>
         /// Determines whether the <c>adb.exe</c> file exists.

Original file line number	Diff line number	Diff line change
`@@ -9,12 +9,8 @@ namespace AdvancedSharpAdbClient.Tests`
`9`	`9`	`/// <summary>`
`10`	`10`	`/// A mock implementation of the <see cref="IAdbCommandLineClient"/> class.`
`11`	`11`	`/// </summary>`
`12`		`- internal class DummyAdbCommandLineClient : AdbCommandLineClient`
	`12`	`+ internal class DummyAdbCommandLineClient() : AdbCommandLineClient(ServerName)`
`13`	`13`	`{`
`14`		`- public DummyAdbCommandLineClient() : base(ServerName)`
`15`		`- {`
`16`		`- }`
`17`		`-`
`18`	`14`	`public AdbCommandLineStatus Version { get; set; }`
`19`	`15`
`20`	`16`	`public bool ServerStarted { get; private set; }`
`@@ -24,7 +20,7 @@ public DummyAdbCommandLineClient() : base(ServerName)`
`24`	`20`
`25`	`21`	`public override Task<bool> CheckAdbFileExistsAsync(string adbPath, CancellationToken cancellationToken = default) => Task.FromResult(true);`
`26`	`22`
`27`		`- protected override int RunProcess(string filename, string command, ICollection<string> errorOutput, ICollection<string> standardOutput)`
	`23`	`+ protected override int RunProcess(string filename, string command, ICollection<string> errorOutput, ICollection<string> standardOutput, int timeout)`
`28`	`24`	`{`
`29`	`25`	`if (filename == AdbPath)`
`30`	`26`	`{`
`@@ -55,7 +51,7 @@ protected override int RunProcess(string filename, string command, ICollection<s`
`55`	`51`	`protected override async Task<int> RunProcessAsync(string filename, string command, ICollection<string> errorOutput, ICollection<string> standardOutput, CancellationToken cancellationToken = default)`
`56`	`52`	`{`
`57`	`53`	`await Task.Yield();`
`58`		`- return RunProcess(filename, command, errorOutput, standardOutput);`
	`54`	`+ return RunProcess(filename, command, errorOutput, standardOutput, Timeout.Infinite);`
`59`	`55`	`}`
`60`	`56`
`61`	`57`	`private static string ServerName => RuntimeInformation.IsOSPlatform(OSPlatform.Windows) ? "adb.exe" : "adb";`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,7 @@`
`7`	`7`	`using System.Globalization;`
`8`	`8`	`using System.Net;`
`9`	`9`	`using System.Net.Sockets;`
	`10`	`+using System.Threading;`
`10`	`11`
`11`	`12`	`namespace AdvancedSharpAdbClient`
`12`	`13`	`{`
`@@ -199,7 +200,7 @@ public StartServerResult StartServer(string adbPath, bool restartServerIfNewer =`
`199`	`200`	`\|\| (restartServerIfNewer && serverStatus.Version < commandLineVersion))`
`200`	`201`	`{`
`201`	`202`	`StopServer();`
`202`		`- commandLineClient.StartServer();`
	`203`	`+ commandLineClient.StartServer(Timeout.Infinite);`
`203`	`204`	`return StartServerResult.RestartedOutdatedDaemon;`
`204`	`205`	`}`
`205`	`206`	`else`
`@@ -209,7 +210,7 @@ public StartServerResult StartServer(string adbPath, bool restartServerIfNewer =`
`209`	`210`	`}`
`210`	`211`	`else`
`211`	`212`	`{`
`212`		`- commandLineClient.StartServer();`
	`213`	`+ commandLineClient.StartServer(Timeout.Infinite);`
`213`	`214`	`return StartServerResult.Started;`
`214`	`215`	`}`
`215`	`216`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ public DeviceNotFoundException() : base("The device was not found.")`
`23`	`23`	`/// Initializes a new instance of the <see cref="DeviceNotFoundException"/> class.`
`24`	`24`	`/// </summary>`
`25`	`25`	`/// <param name="device">The device.</param>`
`26`		`- public DeviceNotFoundException(string? device) : base("The device '" + device + "' was not found.")`
	`26`	`+ public DeviceNotFoundException(string? device) : base($"The device '{device}' was not found.")`
`27`	`27`	`{`
`28`	`28`	`}`
`29`	`29`