Feature/executeasync

src/Renci.SshNet.Tests/Classes/SshClientTest.cs

@@ -7,6 +7,10 @@
 using System.IO;
 using System.Text;
 using System.Linq;
+#if FEATURE_TAP
+using System.Threading;
+using System.Threading.Tasks;
+#endif
 
 namespace Renci.SshNet.Tests.Classes
 {
@@ -35,6 +39,28 @@ public void Test_Connect_Using_Correct_Password()
             #endregion
         }
 
+#if FEATURE_TAP
+        [TestMethod]
+        [TestCategory("Authentication")]
+        [TestCategory("integration")]
+        public async Task Test_ConnectAsync_Using_Correct_Password()
+        {
+            var host = Resources.HOST;
+            var username = Resources.USERNAME;
+            var password = Resources.PASSWORD;
+
+            #region Example SshClient(host, username) Connect
+            using (var client = new SshClient(host, username, password))
+            {
+                var cancellationToken = new CancellationTokenSource(TimeSpan.FromSeconds(60)).Token;
+                await client.ConnectAsync(cancellationToken);
+                //  Do something here
+                client.Disconnect();
+            }
+            #endregion
+        }
+#endif
+
         [TestMethod]
         [TestCategory("Authentication")]
         [TestCategory("integration")]

src/Renci.SshNet.Tests/Classes/SshCommandTest.cs

@@ -56,6 +56,71 @@ public void Test_Run_SingleCommand()
             }
         }
 
+#if FEATURE_TAP
+        [TestMethod]
+        [TestCategory("integration")]
+        public async Task Test_Run_SingleCommandAsync()
+        {
+            var host = Resources.HOST;
+            var username = Resources.USERNAME;
+            var password = Resources.PASSWORD;
+
+            using (var client = new SshClient(host, username, password))
+            {
+                #region Example SshCommand RunCommand Result Async
+                var cancellationToken = new CancellationTokenSource(TimeSpan.FromSeconds(60)).Token;
+                await client.ConnectAsync(cancellationToken);
+
+                var testValue = Guid.NewGuid().ToString();
+                var command = await client.RunCommandAsync(string.Format("echo {0}", testValue), cancellationToken);
+                var result = await new StreamReader(command.OutputStream).ReadToEndAsync();
+                result = result.Substring(0, result.Length - 1);    //  Remove \n character returned by command
+
+                client.Disconnect();
+                #endregion
+
+                Assert.IsTrue(result.Equals(testValue));
+            }
+        }
+
+        [TestMethod]
+        [TestCategory("integration")]
+        public async Task Test_Run_SingleCommandAsync_WithShortTimeout()
+        {
+            var host = Resources.HOST;
+            var username = Resources.USERNAME;
+            var password = Resources.PASSWORD;
+
+            using (var client = new SshClient(host, username, password))
+            {
+                #region Example SshCommand RunCommand Result Async With Short Timeout
+                var cancellationToken = new CancellationTokenSource(TimeSpan.FromSeconds(60)).Token;
+                await client.ConnectAsync(cancellationToken);
+
+                // Timeout in 100ms
+                var shortTimeout = new CancellationTokenSource(TimeSpan.FromMilliseconds(100)).Token;
+
+                var testValue = Guid.NewGuid().ToString();
+                string result;
+                try
+                {
+                    var command = await client.RunCommandAsync(string.Format("echo {0};/bin/sleep 5", testValue), shortTimeout);
+                    result = await new StreamReader(command.OutputStream).ReadToEndAsync();
+                    result = result.Substring(0, result.Length - 1);    //  Remove \n character returned by command
+                }
+                catch (OperationCanceledException)
+                {
+                    result = "canceled";
+                }
+
+                client.Disconnect();
+                #endregion
+
+                Assert.IsTrue(result.Equals("canceled"));
+            }
+        }
+#endif
+
         [TestMethod]
         [TestCategory("integration")]
         public void Test_Execute_SingleCommand()
@@ -266,7 +331,7 @@ public void Test_Execute_Command_ExitStatus()
                 client.Connect();
 
                 var cmd = client.RunCommand("exit 128");
-                
+
                 Console.WriteLine(cmd.ExitStatus);
 
                 client.Disconnect();
@@ -500,6 +565,33 @@ public void Test_Execute_Invalid_Command()
             }
         }
 
+#if FEATURE_TAP
+        [TestMethod]
+        [TestCategory("integration")]
+        public async Task Test_Execute_Invalid_CommandAsync()
+        {
+            using (var client = new SshClient(Resources.HOST, Resources.USERNAME, Resources.PASSWORD))
+            {
+                #region Example SshCommand CreateCommand Error Async
+
+                await client.ConnectAsync(default);
+
+                var cmd = client.CreateCommand(";");
+                await cmd.ExecuteAsync(default);
+                var error = await new StreamReader(cmd.ExtendedOutputStream).ReadToEndAsync();
+                if (!string.IsNullOrEmpty(error))
+                {
+                    Console.WriteLine(error);
+                }
+
+                client.Disconnect();
+
+                #endregion
+
+                Assert.Inconclusive();
+            }
+        }
+#endif
 
         /// <summary>
         ///A test for BeginExecute

src/Renci.SshNet.Tests/Properties/Resources.resx

@@ -149,7 +149,7 @@ D8DHbFwAT2mUv1QxRXYJO1y4pENboEzT6LUqxJgE+ae/F/29g2RD9DhtwqKqWjhM
 -----END DSA PRIVATE KEY-----</value>
   </data>
   <data name="HOST" xml:space="preserve">
-    <value>192.168.10.192</value>
+    <value>127.0.0.1</value>
   </data>
   <data name="INVALID_KEY" xml:space="preserve">
     <value>-----BEGIN DSA PRIVATE KEY-----
@@ -166,7 +166,7 @@ tM7dZpB+reWl9L5e2L8=
 -----END DSA PRIVATE KEY-----</value>
   </data>
   <data name="PASSWORD" xml:space="preserve">
-    <value>tester</value>
+    <value>jasmine1015</value>
   </data>
   <data name="PORT" xml:space="preserve">
     <value>22</value>
@@ -239,6 +239,6 @@ Vakr7Sa3K5niCyH5kxdyO1t29l1ksBqpDUrj+vViFuLkd3XIiui8IA==
 -----END RSA PRIVATE KEY-----</value>
   </data>
   <data name="USERNAME" xml:space="preserve">
-    <value>tester</value>
+    <value>kendallb</value>
   </data>
 </root>

src/Renci.SshNet.Tests/Renci.SshNet.Tests.csproj

@@ -3,14 +3,12 @@
 	  <LangVersion>7.3</LangVersion>
 	  <SignAssembly>true</SignAssembly>
     <AssemblyOriginatorKeyFile>..\Renci.SshNet.snk</AssemblyOriginatorKeyFile>
+    <TargetFramework>net472</TargetFramework>
   </PropertyGroup>
 
   <PropertyGroup Condition=" '$(VisualStudioVersion)' == '15.0' ">
     <TargetFrameworks>net35;net472;netcoreapp2.1</TargetFrameworks>
   </PropertyGroup>
-  <PropertyGroup Condition=" '$(VisualStudioVersion)' == '16.0' ">
-    <TargetFrameworks>net35;net472;netcoreapp3.1;net5.0</TargetFrameworks>
-  </PropertyGroup>
   <PropertyGroup Condition=" '$(VisualStudioVersion)' == '17.0' ">
     <TargetFrameworks>net472;netcoreapp3.1;net5.0;net6.0</TargetFrameworks>
   </PropertyGroup>

src/Renci.SshNet.VS2019.sln.DotSettings

@@ -0,0 +1,3 @@
+<wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
+	<s:String x:Key="/Default/Environment/Hierarchy/Build/BuildTool/CustomBuildToolPath/@EntryValue">C:\Program Files (x86)\Microsoft Visual Studio\2019\Professional\MSBuild\Current\Bin\MSBuild.exe</s:String>
+	<s:Int64 x:Key="/Default/Environment/Hierarchy/Build/BuildTool/MsbuildVersion/@EntryValue">1048576</s:Int64></wpf:ResourceDictionary>

src/Renci.SshNet/Channels/Channel.cs

@@ -562,14 +562,11 @@ protected virtual void Close()
                     // this also ensures don't raise the Closed event more than once
                     IsOpen = false;
 
-                    if (_closeMessageReceived)
+                    // raise event signaling that both ends of the channel have been closed
+                    var closed = Closed;
+                    if (closed != null)
                     {
-                        // raise event signaling that both ends of the channel have been closed
-                        var closed = Closed;
-                        if (closed != null)
-                        {
-                            closed(this, new ChannelEventArgs(LocalChannelNumber));
-                        }
+                        closed(this, new ChannelEventArgs(LocalChannelNumber));
                     }
                 }
             }

src/Renci.SshNet/Renci.SshNet.csproj

@@ -7,7 +7,7 @@
     <AssemblyOriginatorKeyFile>../Renci.SshNet.snk</AssemblyOriginatorKeyFile>
     <LangVersion>6</LangVersion>
     <SignAssembly>true</SignAssembly>
-    <TargetFrameworks>net35;net40;net472;netstandard1.3;netstandard2.0</TargetFrameworks>
+    <TargetFramework>net472</TargetFramework>
   </PropertyGroup>
 
   <!--

src/Renci.SshNet/SshClient.cs

@@ -4,6 +4,10 @@
 using System.Text;
 using System.Diagnostics.CodeAnalysis;
 using System.Net;
+#if FEATURE_TAP
+using System.Threading;
+using System.Threading.Tasks;
+#endif
 using Renci.SshNet.Common;
 
 namespace Renci.SshNet
@@ -275,6 +279,31 @@ public SshCommand RunCommand(string commandText)
             return cmd;
         }
 
+#if FEATURE_TAP
+        /// <summary>
+        /// Creates and executes the command.
+        /// </summary>
+        /// <param name="commandText">The command text.</param>
+        /// <param name="cancellationToken">The <see cref="CancellationToken"/> to observe.</param>
+        /// <returns>Returns an instance of <see cref="Task{SshCommand}"/> with execution results.</returns>
+        /// <remarks>This method internally uses asynchronous calls.</remarks>
+        /// <example>
+        ///     <code source="..\..\src\Renci.SshNet.Tests\Classes\SshCommandTest.cs" region="Example SshCommand RunCommand Result Async" language="C#" title="Running simple command async" />
+        ///     <code source="..\..\src\Renci.SshNet.Tests\Classes\SshCommandTest.cs" region="Example SshCommand RunCommand Result Async With Short Timeout" language="C#" title="Running simple command with short timeout async" />
+        /// </example>
+        /// <exception cref="ArgumentException">CommandText property is empty.</exception>
+        /// <exception cref="T:Renci.SshNet.Common.SshException">Invalid Operation - An existing channel was used to execute this command.</exception>
+        /// <exception cref="InvalidOperationException">Asynchronous operation is already in progress.</exception>
+        /// <exception cref="SshConnectionException">Client is not connected.</exception>
+        /// <exception cref="ArgumentNullException"><paramref name="commandText"/> is <c>null</c>.</exception>
+        public async Task<SshCommand> RunCommandAsync(string commandText, CancellationToken cancellationToken)
+        {
+            var cmd = CreateCommand(commandText);
+            await cmd.ExecuteAsync(cancellationToken).ConfigureAwait(false);
+            return cmd;
+        }
+#endif
+
         /// <summary>
         /// Creates the shell.
         /// </summary>