Add unit tests for task-based asynchronous API

appveyor.yml

@@ -1,5 +1,8 @@
 os: Visual Studio 2019
 
+init:
+ - netsh int ipv4 set dynamicport tcp start=1025 num=64510
+
 before_build:
   - nuget restore src\Renci.SshNet.VS2019.sln
 
@@ -9,6 +12,6 @@ build:
 
 test_script:
 - cmd: >-
-    vstest.console /logger:Appveyor src\Renci.SshNet.Tests\bin\Debug\net40\Renci.SshNet.Tests.dll /TestCaseFilter:"TestCategory!=integration&TestCategory!=LongRunning"
+    vstest.console /logger:Appveyor src\Renci.SshNet.Tests\bin\Debug\net472\Renci.SshNet.Tests.dll /TestCaseFilter:"TestCategory!=integration&TestCategory!=LongRunning"
 
-    vstest.console /logger:Appveyor src\Renci.SshNet.Tests\bin\Debug\net35\Renci.SshNet.Tests.dll /TestCaseFilter:"TestCategory!=integration&TestCategory!=LongRunning"
+    vstest.console /logger:Appveyor src\Renci.SshNet.Tests\bin\Debug\net5.0\Renci.SshNet.Tests.dll /TestCaseFilter:"TestCategory!=integration&TestCategory!=LongRunning"

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

@@ -94,7 +94,7 @@ public void IsConnectedOnSessionShouldBeInvokedOnce()
         }
 
         [TestMethod]
-        public void SendMessageOnSessionShouldBeInvokedThreeTimes()
+        public void SendMessageOnSessionShouldBeInvokedOneTime()
         {
             // allow keep-alive to be sent once
             Thread.Sleep(100);

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

@@ -13,6 +13,7 @@ public class BaseClientTest_Connected_KeepAliveInterval_NotNegativeOne : BaseCli
         private ConnectionInfo _connectionInfo;
         private TimeSpan _keepAliveInterval;
         private int _keepAliveCount;
+        private int _actualKeepAliveCount;
 
         protected override void SetupData()
         {
@@ -58,6 +59,8 @@ protected override void Act()
 
             // allow keep-alive to be sent a few times
             Thread.Sleep(195);
+
+            _actualKeepAliveCount = _keepAliveCount;
         }
 
         [TestMethod]
@@ -94,7 +97,7 @@ public void IsConnectedOnSessionShouldBeInvokedOnce()
         [TestMethod]
         public void SendMessageOnSessionShouldBeInvokedThreeTimes()
         {
-            _sessionMock.Verify(p => p.TrySendMessage(It.IsAny<IgnoreMessage>()), Times.Exactly(3));
+            Assert.AreEqual(3, _actualKeepAliveCount);
         }
 
         private class MyClient : BaseClient

src/Renci.SshNet.Tests/Classes/Channels/ChannelForwardedTcpipTest_Dispose_SessionIsConnectedAndChannelIsOpen.cs

@@ -51,17 +51,13 @@ public void CleanUp()
                 _remoteListener = null;
             }
 
-            if (_channelThread != null)
-            {
-                if (_channelThread.IsAlive)
-                    _channelThread.Abort();
-                _channelThread = null;
-            }
             if (_channel != null)
             {
                 _channel.Dispose();
                 _channel = null;
             }
+
+            _channelThread = null;
         }
 
         private void Arrange()
@@ -138,10 +134,12 @@ private void Arrange()
                 _remoteWindowSize,
                 _remotePacketSize);
 
+            ManualResetEvent isReady = new ManualResetEvent(false);
             _channelThread = new Thread(() =>
                 {
                     try
                     {
+                        isReady.Set();
                         _channel.Bind(_remoteEndpoint, _forwardedPortMock.Object);
                     }
                     catch (Exception ex)
@@ -156,6 +154,7 @@ private void Arrange()
             _channelThread.Start();
 
             // give channel time to bind to remote endpoint
+            isReady.WaitOne(10000);
             Thread.Sleep(100);
         }
 

src/Renci.SshNet.Tests/Classes/Channels/ChannelTest_Dispose_SessionIsConnectedAndChannelIsOpen_EofReceived.cs

@@ -25,6 +25,7 @@ public class ChannelTest_Dispose_SessionIsConnectedAndChannelIsOpen_EofReceived
         private ManualResetEvent _channelClosedReceived;
         private ManualResetEvent _channelClosedEventHandlerCompleted;
         private Thread _raiseChannelCloseReceivedThread;
+        private ManualResetEvent _threadStopEvent;
 
         protected override void SetupData()
         {
@@ -43,6 +44,7 @@ protected override void SetupData()
             _channelClosedReceived = new ManualResetEvent(false);
             _channelClosedEventHandlerCompleted = new ManualResetEvent(false);
             _raiseChannelCloseReceivedThread = null;
+            _threadStopEvent = new ManualResetEvent(false);
         }
 
         protected override void SetupMocks()
@@ -80,7 +82,9 @@ protected override void SetupMocks()
                                SessionMock.Raise(s => s.ChannelCloseReceived += null, new MessageEventArgs<ChannelCloseMessage>(new ChannelCloseMessage(_localChannelNumber)));
                            });
                            _raiseChannelCloseReceivedThread.Start();
-                           waitHandle.WaitOne();
+
+                           WaitHandle[] waitHandles = new WaitHandle[2] { waitHandle, _threadStopEvent };
+                           WaitHandle.WaitAny(waitHandles);
                        })
                        .Returns(WaitResult.Success);
         }
@@ -98,7 +102,7 @@ public void TearDown()
             {
                 if (!_raiseChannelCloseReceivedThread.Join(1000))
                 {
-                    _raiseChannelCloseReceivedThread.Abort();
+                    _threadStopEvent.Set();
                 }
             }
 

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

@@ -28,7 +28,11 @@ public void Ctor_PartialSuccessLimit_Zero()
             catch (ArgumentOutOfRangeException ex)
             {
                 Assert.IsNull(ex.InnerException);
+#if NETFRAMEWORK
                 Assert.AreEqual(string.Format("Cannot be less than one.{0}Parameter name: {1}", Environment.NewLine, ex.ParamName), ex.Message);
+#else
+                Assert.AreEqual(string.Format("Cannot be less than one. (Parameter '{1}')", Environment.NewLine, ex.ParamName), ex.Message);
+#endif
                 Assert.AreEqual("partialSuccessLimit", ex.ParamName);
             }
         }
@@ -46,7 +50,11 @@ public void Ctor_PartialSuccessLimit_Negative()
             catch (ArgumentOutOfRangeException ex)
             {
                 Assert.IsNull(ex.InnerException);
+#if NETFRAMEWORK
                 Assert.AreEqual(string.Format("Cannot be less than one.{0}Parameter name: {1}", Environment.NewLine, ex.ParamName), ex.Message);
+#else
+                Assert.AreEqual(string.Format("Cannot be less than one. (Parameter '{1}')", Environment.NewLine, ex.ParamName), ex.Message);
+#endif
                 Assert.AreEqual("partialSuccessLimit", ex.ParamName);
             }
         }

src/Renci.SshNet.Tests/Classes/Common/CountdownEventTest.cs

@@ -1,9 +1,8 @@
-using System;
+#if !FEATURE_THREAD_COUNTDOWNEVENT
+using System;
 using System.Threading;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
-#if !FEATURE_THREAD_COUNTDOWNEVENT
 using CountdownEvent = Renci.SshNet.Common.CountdownEvent;
-#endif
 
 namespace Renci.SshNet.Tests.Classes.Common
 {
@@ -336,3 +335,4 @@ private static CountdownEvent CreateCountdownEvent(int initialCount)
         }
     }
 }
+#endif

src/Renci.SshNet.Tests/Classes/Common/PacketDumpTest.cs

@@ -37,7 +37,11 @@ public void Create_ByteArrayAndIndentLevel_IndentLevelLessThanZero()
             catch (ArgumentOutOfRangeException ex)
             {
                 Assert.IsNull(ex.InnerException);
+#if NETFRAMEWORK
                 Assert.AreEqual(string.Format("Cannot be less than zero.{0}Parameter name: {1}", Environment.NewLine, ex.ParamName), ex.Message);
+#else
+                Assert.AreEqual(string.Format("Cannot be less than zero. (Parameter '{1}')", Environment.NewLine, ex.ParamName), ex.Message);
+#endif
                 Assert.AreEqual("indentLevel", ex.ParamName);
             }
         }

src/Renci.SshNet.Tests/Classes/Common/PipeStream_Close_BlockingWrite.cs

@@ -11,13 +11,14 @@ public class PipeStream_Close_BlockingWrite : TripleATestBase
     {
         private PipeStream _pipeStream;
         private Exception _writeException;
-        private Thread _writehread;
+        private Thread _writeThread;
 
         protected override void Arrange()
         {
             _pipeStream = new PipeStream {MaxBufferLength = 3};
 
-            _writehread = new Thread(() =>
+            ManualResetEvent isArranged = new ManualResetEvent(false);
+            _writeThread = new Thread(() =>
                 {
                     _pipeStream.WriteByte(10);
                     _pipeStream.WriteByte(13);
@@ -27,32 +28,32 @@ protected override void Arrange()
                     // until bytes are read or the stream is closed
                     try
                     {
+                        isArranged.Set();
                         _pipeStream.WriteByte(35);
                     }
                     catch (Exception ex)
                     {
                         _writeException = ex;
-                        throw;
                     }
                 });
-            _writehread.Start();
+            _writeThread.Start();
 
             // ensure we've started writing
-            Assert.IsFalse(_writehread.Join(50));
+            isArranged.WaitOne(10000);
         }
 
         protected override void Act()
         {
             _pipeStream.Close();
 
             // give write time to complete
-            _writehread.Join(100);
+            Assert.IsTrue(_writeThread.Join(10000));
         }
 
         [TestMethod]
         public void BlockingWriteShouldHaveBeenInterrupted()
         {
-            Assert.AreEqual(ThreadState.Stopped, _writehread.ThreadState);
+            Assert.AreEqual(ThreadState.Stopped, _writeThread.ThreadState);
         }
 
         [TestMethod]

src/Renci.SshNet.Tests/Classes/Common/PipeStream_Flush_BytesRemainingAfterRead.cs

@@ -1,4 +1,5 @@
-using System.Threading;
+using System;
+using System.Threading;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
 using Renci.SshNet.Common;
 using Renci.SshNet.Tests.Common;
@@ -97,20 +98,25 @@ public void WriteCausesSubsequentReadToBlockUntilRequestedNumberOfBytesAreAvaila
             var buffer = new byte[4];
             int bytesRead = int.MaxValue;
 
+            ManualResetEvent isReady = new ManualResetEvent(false);
             Thread readThread = new Thread(() =>
             {
+                isReady.Set();
                 bytesRead = _pipeStream.Read(buffer, 0, buffer.Length);
             });
             readThread.Start();
 
+            Assert.IsTrue(isReady.WaitOne(10000));
             Assert.IsFalse(readThread.Join(500));
-            readThread.Abort();
 
             Assert.AreEqual(int.MaxValue, bytesRead);
             Assert.AreEqual(0, buffer[0]);
             Assert.AreEqual(0, buffer[1]);
             Assert.AreEqual(0, buffer[2]);
             Assert.AreEqual(0, buffer[3]);
+
+            Assert.IsFalse(readThread.Join(50));
+            _pipeStream.Dispose();
         }
     }
 }

src/Renci.SshNet.Tests/Classes/Common/PosixPathTest_CreateAbsoluteOrRelativeFilePath.cs

@@ -37,7 +37,11 @@ public void Path_Empty()
             catch (ArgumentException ex)
             {
                 Assert.IsNull(ex.InnerException);
+#if NETFRAMEWORK
                 Assert.AreEqual(string.Format("The path is a zero-length string.{0}Parameter name: {1}", Environment.NewLine, ex.ParamName), ex.Message);
+#else
+                Assert.AreEqual(string.Format("The path is a zero-length string. (Parameter '{1}')", Environment.NewLine, ex.ParamName), ex.Message);
+#endif
                 Assert.AreEqual("path", ex.ParamName);
             }
         }

src/Renci.SshNet.Tests/Classes/Connection/DirectConnectorTest_Connect_HostNameInvalid.cs

@@ -36,7 +36,10 @@ public void ConnectShouldHaveThrownSocketException()
         {
             Assert.IsNotNull(_actualException);
             Assert.IsNull(_actualException.InnerException);
-            Assert.AreEqual(SocketError.HostNotFound, _actualException.SocketErrorCode);
+            if (_actualException.SocketErrorCode != SocketError.TryAgain)
+            {
+                Assert.AreEqual(SocketError.HostNotFound, _actualException.SocketErrorCode);
+            }
         }
     }
 }

src/Renci.SshNet.Tests/Classes/Connection/HttpConnectorTest_Connect_ProxyHostInvalid.cs

@@ -43,7 +43,10 @@ public void ConnectShouldHaveThrownSocketException()
         {
             Assert.IsNotNull(_actualException);
             Assert.IsNull(_actualException.InnerException);
-            Assert.AreEqual(SocketError.HostNotFound, _actualException.SocketErrorCode);
+            if (_actualException.SocketErrorCode != SocketError.TryAgain)
+            {
+                Assert.AreEqual(SocketError.HostNotFound, _actualException.SocketErrorCode);
+            }
         }
     }
 }

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

@@ -79,7 +79,7 @@ private void SetupData()
             _exceptionRegister = new List<ExceptionEventArgs>();
             _endpoint = new IPEndPoint(IPAddress.Loopback, 8122);
             _remoteEndpoint = new IPEndPoint(IPAddress.Parse("193.168.1.5"), random.Next(IPEndPoint.MinPort, IPEndPoint.MaxPort));
-            _bindSleepTime = TimeSpan.FromMilliseconds(random.Next(100, 500));
+            _bindSleepTime = TimeSpan.FromMilliseconds(random.Next(100, 200));
             _userName = random.Next().ToString(CultureInfo.InvariantCulture);
             _channelBindStarted = new ManualResetEvent(false);
             _channelBindCompleted = new ManualResetEvent(false);

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

@@ -130,7 +130,10 @@ public void ClosingShouldHaveFiredOnce()
         [TestMethod]
         public void ExceptionShouldNotHaveFired()
         {
-            Assert.AreEqual(0, _exceptionRegister.Count);
+            if (_exceptionRegister.Count > 0)
+            {
+                throw new Exception("ForwardedPortDynamic rased an exception: " + _exceptionRegister[0].Exception.Message, _exceptionRegister[0].Exception);
+            }
         }
 
         [TestMethod]

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

@@ -80,7 +80,7 @@ private void SetupData()
             _exceptionRegister = new List<ExceptionEventArgs>();
             _endpoint = new IPEndPoint(IPAddress.Loopback, 8122);
             _remoteEndpoint = new IPEndPoint(IPAddress.Parse("193.168.1.5"), random.Next(IPEndPoint.MinPort, IPEndPoint.MaxPort));
-            _bindSleepTime = TimeSpan.FromMilliseconds(random.Next(100, 500));
+            _bindSleepTime = TimeSpan.FromMilliseconds(random.Next(100, 200));
             _userName = random.Next().ToString(CultureInfo.InvariantCulture);
             _forwardedPort = new ForwardedPortDynamic(_endpoint.Address.ToString(), (uint) _endpoint.Port);
             _sessionException = new Exception();

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

@@ -78,7 +78,7 @@ private void SetupData()
             _exceptionRegister = new List<ExceptionEventArgs>();
             _endpoint = new IPEndPoint(IPAddress.Loopback, 8122);
             _remoteEndpoint = new IPEndPoint(IPAddress.Parse("193.168.1.5"), random.Next(IPEndPoint.MinPort, IPEndPoint.MaxPort));
-            _bindSleepTime = TimeSpan.FromMilliseconds(random.Next(100, 500));
+            _bindSleepTime = TimeSpan.FromMilliseconds(random.Next(100, 200));
             _userName = random.Next().ToString(CultureInfo.InvariantCulture);
             _channelBindStarted = new ManualResetEvent(false);
             _channelBindCompleted = new ManualResetEvent(false);

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

@@ -130,7 +130,10 @@ public void ClosingShouldHaveFiredOnce()
         [TestMethod]
         public void ExceptionShouldNotHaveFired()
         {
-            Assert.AreEqual(0, _exceptionRegister.Count);
+            if (_exceptionRegister.Count > 0)
+            {
+                throw new Exception("ForwardedPortDynamic rased an exception: " + _exceptionRegister[0].Exception.Message, _exceptionRegister[0].Exception);
+            }
         }
 
         [TestMethod]

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

@@ -65,7 +65,7 @@ protected void Arrange()
             _exceptionRegister = new List<ExceptionEventArgs>();
             _localEndpoint = new IPEndPoint(IPAddress.Loopback, 8122);
             _remoteEndpoint = new IPEndPoint(IPAddress.Parse("193.168.1.5"), random.Next(IPEndPoint.MinPort, IPEndPoint.MaxPort));
-            _bindSleepTime = TimeSpan.FromMilliseconds(random.Next(100, 500));
+            _bindSleepTime = TimeSpan.FromMilliseconds(random.Next(100, 200));
             _forwardedPort = new ForwardedPortLocal(_localEndpoint.Address.ToString(), (uint) _localEndpoint.Port, _remoteEndpoint.Address.ToString(), (uint) _remoteEndpoint.Port);
             _channelBindStarted = new ManualResetEvent(false);
             _channelBindCompleted = new ManualResetEvent(false);

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

@@ -73,7 +73,7 @@ private void SetupData()
             _exceptionRegister = new List<ExceptionEventArgs>();
             _localEndpoint = new IPEndPoint(IPAddress.Loopback, 8122);
             _remoteEndpoint = new IPEndPoint(IPAddress.Parse("193.168.1.5"), random.Next(IPEndPoint.MinPort, IPEndPoint.MaxPort));
-            _bindSleepTime = TimeSpan.FromMilliseconds(random.Next(100, 500));
+            _bindSleepTime = TimeSpan.FromMilliseconds(random.Next(100, 200));
             _channelBound = new ManualResetEvent(false);
             _channelBindCompleted = new ManualResetEvent(false);
 

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

@@ -79,7 +79,7 @@ private void SetUpData()
             _exceptionRegister = new List<ExceptionEventArgs>();
             _bindEndpoint = new IPEndPoint(IPAddress.Any, random.Next(IPEndPoint.MinPort, IPEndPoint.MaxPort));
             _remoteEndpoint = new IPEndPoint(IPAddress.Parse("193.168.1.5"), random.Next(IPEndPoint.MinPort, IPEndPoint.MaxPort));
-            _bindSleepTime = TimeSpan.FromMilliseconds(random.Next(100, 500));
+            _bindSleepTime = TimeSpan.FromMilliseconds(random.Next(100, 200));
             _remoteChannelNumberWhileClosing = (uint) random.Next(0, 1000);
             _remoteWindowSizeWhileClosing = (uint) random.Next(0, int.MaxValue);
             _remotePacketSizeWhileClosing = (uint) random.Next(0, int.MaxValue);