Test integration tests

.dockerignore

@@ -0,0 +1,31 @@
+**/.classpath
+**/.dockerignore
+**/.env
+**/.git
+**/.gitignore
+**/.project
+**/.settings
+**/.toolstarget
+**/.vs
+**/.vscode
+**/*.*proj.user
+**/*.dbmdl
+**/*.jfm
+**/azds.yaml
+**/bin
+**/charts
+**/docker-compose*
+**/Dockerfile*
+**/node_modules
+**/npm-debug.log
+**/obj
+**/secrets.dev.yaml
+**/values.dev.yaml
+LICENSE
+README.md
+!**/.gitignore
+!.git/HEAD
+!.git/config
+!.git/packed-refs
+!.git/refs/heads/**
+!**/Dockerfile.TestServer

appveyor.yml

@@ -1,17 +1,18 @@
-os: Visual Studio 2022
+os: Ubuntu2204
 
-before_build:
-  - nuget restore Renci.SshNet.sln
+services:
+- docker
 
-install:
-  - cinst dotnet-sdk --version=7.0.403 --limit-output
-
-build:
-  project: Renci.SshNet.sln
-  verbosity: minimal
+#for testing purposes only
+build_script:
+  - dotnet build test/Renci.SshNet.IntegrationTests/ -c Debug
 
 test_script:
-- cmd: >-
-    vstest.console /logger:Appveyor test\Renci.SshNet.Tests\bin\Debug\net462\Renci.SshNet.Tests.dll /TestCaseFilter:"TestCategory!=integration" --blame
-
-    vstest.console /logger:Appveyor test\Renci.SshNet.Tests\bin\Debug\net7.0\Renci.SshNet.Tests.dll /TestCaseFilter:"TestCategory!=integration" --blame
+- mkdir artifacts
+- sudo tcpdump -i any -c1000 -w artifacts/tcpdump.pcap
+#- dotnet test -c Debug --no-restore --no-build --results-directory artifacts --logger "console;verbosity=detailed" --logger "liquid.md;LogFileName=TestReport.md" -p:CollectCoverage=true -p:CoverletOutputFormat=cobertura -p:CoverletOutput=artifacts/coverage.xml test/Renci.SshNet.IntegrationTests/Renci.SshNet.IntegrationTests.csproj
+- ls artifacts
+
+artifacts:
+  - path: artifacts
+    name: artifacts

src/Renci.SshNet/Abstractions/DiagnosticAbstraction.cs

@@ -57,12 +57,13 @@ public static class DiagnosticAbstraction
         /// level.
         /// </summary>
         /// <param name="text">The message to log.</param>
+        /// <param name="type">The trace event type.</param>
         [Conditional("DEBUG")]
-        public static void Log(string text)
+        public static void Log(string text, TraceEventType type = TraceEventType.Information)
         {
-            Source.TraceEvent(TraceEventType.Verbose,
-                                System.Environment.CurrentManagedThreadId,
-                                text);
+            Source.TraceEvent(type,
+                              System.Environment.CurrentManagedThreadId,
+                              text);
         }
     }
 }

src/Renci.SshNet/Abstractions/SocketAbstraction.cs

@@ -59,7 +59,31 @@ public static async Task ConnectAsync(Socket socket, IPEndPoint remoteEndpoint,
 
         private static void ConnectCore(Socket socket, IPEndPoint remoteEndpoint, TimeSpan connectTimeout, bool ownsSocket)
         {
-#if FEATURE_SOCKET_EAP
+#if FEATURE_SOCKET_TAP
+            AsyncHelper.RunSync(async () =>
+            {
+                using var ctsTs = new CancellationTokenSource(connectTimeout);
+
+                try
+                {
+                    await socket.ConnectAsync(remoteEndpoint, ctsTs.Token).ConfigureAwait(false);
+                }
+                catch (OperationCanceledException)
+                {
+                    throw new SshOperationTimeoutException(
+                        string.Format(CultureInfo.InvariantCulture,
+                                      "Connection failed to establish within {0:F0} milliseconds.",
+                                      connectTimeout.TotalMilliseconds));
+                }
+                finally
+                {
+                    if (!socket.Connected && ownsSocket)
+                    {
+                        socket.Dispose();
+                    }
+                }
+            });
+#elif FEATURE_SOCKET_EAP
             var connectCompleted = new ManualResetEvent(initialState: false);
             var args = new SocketAsyncEventArgs
                 {
@@ -113,18 +137,8 @@ private static void ConnectCore(Socket socket, IPEndPoint remoteEndpoint, TimeSp
 
             // dispose SocketAsyncEventArgs
             args.Dispose();
-#elif FEATURE_SOCKET_APM
-            var connectResult = socket.BeginConnect(remoteEndpoint, null, null);
-            if (!connectResult.AsyncWaitHandle.WaitOne(connectTimeout, false))
-                throw new SshOperationTimeoutException(string.Format(CultureInfo.InvariantCulture,
-                    "Connection failed to establish within {0:F0} milliseconds.", connectTimeout.TotalMilliseconds));
-            socket.EndConnect(connectResult);
-#elif FEATURE_SOCKET_TAP
-            if (!socket.ConnectAsync(remoteEndpoint).Wait(connectTimeout))
-                throw new SshOperationTimeoutException(string.Format(CultureInfo.InvariantCulture,
-                    "Connection failed to establish within {0:F0} milliseconds.", connectTimeout.TotalMilliseconds));
 #else
-            #error Connecting to a remote endpoint is not implemented.
+#error Connecting to a remote endpoint is not implemented.
 #endif
         }
 
@@ -325,9 +339,16 @@ public static int Read(Socket socket, byte[] buffer, int offset, int size, TimeS
             return totalBytesRead;
         }
 
-        public static Task<int> ReadAsync(Socket socket, byte[] buffer, int offset, int length, CancellationToken cancellationToken)
+        public static Task<int> ReadAsync(Socket socket, byte[] buffer, CancellationToken cancellationToken)
         {
-            return socket.ReceiveAsync(buffer, offset, length, cancellationToken);
+#if FEATURE_SOCKET_TAP
+            Memory<byte> memory = buffer;
+            return socket.ReceiveAsync(memory, SocketFlags.None, cancellationToken).AsTask();
+#elif FEATURE_SOCKET_EAP
+            return socket.ReceiveAsync(buffer, 0, buffer.Length, cancellationToken);
+#else
+#error Reading from a remote endpoint is not implemented.
+#endif
         }
 
         public static void Send(Socket socket, byte[] data)

src/Renci.SshNet/Abstractions/SocketExtensions.cs

@@ -1,4 +1,5 @@
-using System;
+#if FEATURE_SOCKET_EAP
+using System;
 using System.Net;
 using System.Net.Sockets;
 using System.Runtime.CompilerServices;
@@ -90,23 +91,23 @@ public void GetResult()
         }
 
         public static async Task ConnectAsync(this Socket socket, IPEndPoint remoteEndpoint, CancellationToken cancellationToken)
-        {
-            cancellationToken.ThrowIfCancellationRequested();
-
-            using (var args = new AwaitableSocketAsyncEventArgs())
-            {
-                args.RemoteEndPoint = remoteEndpoint;
-
-#if NET || NETSTANDARD2_1_OR_GREATER
-                await using (cancellationToken.Register(o => ((AwaitableSocketAsyncEventArgs)o).SetCancelled(), args, useSynchronizationContext: false).ConfigureAwait(continueOnCapturedContext: false))
-#else
-                using (cancellationToken.Register(o => ((AwaitableSocketAsyncEventArgs) o).SetCancelled(), args, useSynchronizationContext: false))
-#endif // NET || NETSTANDARD2_1_OR_GREATER
-                {
-                    await args.ExecuteAsync(socket.ConnectAsync);
-                }
-            }
-        }
+         {
+             cancellationToken.ThrowIfCancellationRequested();
+
+             using (var args = new AwaitableSocketAsyncEventArgs())
+             {
+                 args.RemoteEndPoint = remoteEndpoint;
+
+ #if NET || NETSTANDARD2_1_OR_GREATER
+                 await using (cancellationToken.Register(o => ((AwaitableSocketAsyncEventArgs)o).SetCancelled(), args, useSynchronizationContext: false).ConfigureAwait(continueOnCapturedContext: false))
+ #else
+                 using (cancellationToken.Register(o => ((AwaitableSocketAsyncEventArgs) o).SetCancelled(), args, useSynchronizationContext: false))
+ #endif // NET || NETSTANDARD2_1_OR_GREATER
+                 {
+                     await args.ExecuteAsync(socket.ConnectAsync);
+                 }
+             }
+         }
 
         public static async Task<int> ReceiveAsync(this Socket socket, byte[] buffer, int offset, int length, CancellationToken cancellationToken)
         {
@@ -130,3 +131,4 @@ public static async Task<int> ReceiveAsync(this Socket socket, byte[] buffer, in
         }
     }
 }
+#endif

src/Renci.SshNet/Common/AsyncHelper.cs

@@ -0,0 +1,42 @@
+using System;
+using System.Globalization;
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace Renci.SshNet.Common
+{
+#pragma warning disable CA2008
+    internal static class AsyncHelper
+    {
+        private static readonly TaskFactory MyTaskFactory = new TaskFactory(
+            CancellationToken.None,
+            TaskCreationOptions.None,
+            TaskContinuationOptions.None,
+            TaskScheduler.Default);
+
+        public static TResult RunSync<TResult>(Func<Task<TResult>> func)
+        {
+            var cultureUi = CultureInfo.CurrentUICulture;
+            var culture = CultureInfo.CurrentCulture;
+            return MyTaskFactory.StartNew(() =>
+            {
+                Thread.CurrentThread.CurrentCulture = culture;
+                Thread.CurrentThread.CurrentUICulture = cultureUi;
+                return func();
+            }).Unwrap().GetAwaiter().GetResult();
+        }
+
+        public static void RunSync(Func<Task> func)
+        {
+            var cultureUi = CultureInfo.CurrentUICulture;
+            var culture = CultureInfo.CurrentCulture;
+            MyTaskFactory.StartNew(() =>
+            {
+                Thread.CurrentThread.CurrentCulture = culture;
+                Thread.CurrentThread.CurrentUICulture = cultureUi;
+                return func();
+            }).Unwrap().GetAwaiter().GetResult();
+        }
+    }
+#pragma warning restore CA2008
+}

src/Renci.SshNet/Connection/ProtocolVersionExchange.cs

@@ -187,7 +187,7 @@ private static async Task<string> SocketReadLineAsync(Socket socket, List<byte>
             // to be processed by subsequent invocations.
             while (true)
             {
-                var bytesRead = await SocketAbstraction.ReadAsync(socket, data, 0, data.Length, cancellationToken).ConfigureAwait(false);
+                var bytesRead = await SocketAbstraction.ReadAsync(socket, data, cancellationToken).ConfigureAwait(false);
                 if (bytesRead == 0)
                 {
                     throw new SshConnectionException("The connection was closed by the remote host.");

src/Renci.SshNet/Renci.SshNet.csproj

@@ -6,7 +6,7 @@
   </PropertyGroup>
 
   <PropertyGroup Condition=" '$(TargetFramework)' == 'net462' ">
-    <DefineConstants>$(DefineConstants);FEATURE_BINARY_SERIALIZATION;FEATURE_SOCKET_EAP;FEATURE_SOCKET_APM;FEATURE_DNS_SYNC;FEATURE_HASH_RIPEMD160_CREATE;FEATURE_HMAC_RIPEMD160</DefineConstants>
+    <DefineConstants>$(DefineConstants);FEATURE_BINARY_SERIALIZATION;FEATURE_DNS_SYNC;FEATURE_HASH_RIPEMD160_CREATE;FEATURE_HMAC_RIPEMD160</DefineConstants>
   </PropertyGroup>
 
   <ItemGroup Condition=" '$(TargetFramework)' == 'netstandard2.0' or '$(TargetFramework)' == 'netstandard2.1' or '$(TargetFramework)' == 'net6.0' or '$(TargetFramework)' == 'net7.0' ">
@@ -18,6 +18,15 @@
   </ItemGroup>
 
   <PropertyGroup Condition=" '$(TargetFramework)' == 'netstandard2.0' or '$(TargetFramework)' == 'netstandard2.1' or '$(TargetFramework)' == 'net6.0' or '$(TargetFramework)' == 'net7.0' ">
-    <DefineConstants>$(DefineConstants);FEATURE_SOCKET_TAP;FEATURE_SOCKET_APM;FEATURE_SOCKET_EAP;FEATURE_DNS_SYNC;FEATURE_DNS_APM;FEATURE_DNS_TAP</DefineConstants>
+    <DefineConstants>$(DefineConstants);FEATURE_DNS_SYNC;FEATURE_DNS_APM;FEATURE_DNS_TAP</DefineConstants>
   </PropertyGroup>
+
+  <PropertyGroup Condition="'$(TargetFramework)' == 'net462' or '$(TargetFramework)' == 'netstandard2.0' or '$(TargetFramework)' == 'netstandard2.1' ">
+      <DefineConstants>$(DefineConstants);FEATURE_SOCKET_EAP</DefineConstants>
+  </PropertyGroup>
+
+  <PropertyGroup Condition="'$(TargetFramework)' == 'net6.0' or '$(TargetFramework)' == 'net7.0' ">
+      <DefineConstants>$(DefineConstants);FEATURE_SOCKET_TAP</DefineConstants>
+  </PropertyGroup>
+
 </Project>

src/Renci.SshNet/Session.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Diagnostics;
 using System.Globalization;
 using System.Linq;
 using System.Net.Sockets;
@@ -1052,7 +1053,7 @@ internal void SendMessage(Message message)
                 WaitOnHandle(_keyExchangeCompletedWaitHandle);
             }
 
-            DiagnosticAbstraction.Log(string.Format("[{0}] Sending message '{1}' to server: '{2}'.", ToHex(SessionId), message.GetType().Name, message));
+            DiagnosticAbstraction.Log(string.Format("[{0}] Sending message '{1}' to server: '{2}'.", ToHex(SessionId), message.GetType().Name, message), message is ChannelDataMessage ? TraceEventType.Verbose : TraceEventType.Information);
 
             var paddingMultiplier = _clientCipher is null ? (byte) 8 : Math.Max((byte) 8, _serverCipher.MinimumSize);
             var packetData = message.GetPacket(paddingMultiplier, _clientCompression);
@@ -1711,7 +1712,7 @@ private Message LoadMessage(byte[] data, int offset, int count)
             var message = _sshMessageFactory.Create(messageType);
             message.Load(data, offset + 1, count - 1);
 
-            DiagnosticAbstraction.Log(string.Format("[{0}] Received message '{1}' from server: '{2}'.", ToHex(SessionId), message.GetType().Name, message));
+            DiagnosticAbstraction.Log(string.Format("[{0}] Received message '{1}' from server: '{2}'.", ToHex(SessionId), message.GetType().Name, message), message is ChannelDataMessage ? TraceEventType.Verbose : TraceEventType.Information);
 
             return message;
         }

test/Renci.SshNet.IntegrationTests/Dockerfile

@@ -1,50 +1,28 @@
-FROM alpine:latest
-
-COPY --chown=root:root server/ssh /etc/ssh/
-COPY --chown=root:root server/script /opt/sshnet
-COPY user/sshnet /home/sshnet/.ssh
-
-RUN apk update && apk upgrade --no-cache && \
-    apk add --no-cache syslog-ng && \
-    # install and configure sshd
-    apk add --no-cache openssh && \
-    # install openssh-server-pam to allow for keyboard-interactive authentication
-    apk add --no-cache openssh-server-pam && \
-    dos2unix /etc/ssh/* && \
-    chmod 400 /etc/ssh/ssh*key && \
-    sed -i 's/#PasswordAuthentication yes/PasswordAuthentication yes/' /etc/ssh/sshd_config && \
-    sed -i 's/#LogLevel\s*INFO/LogLevel DEBUG3/' /etc/ssh/sshd_config && \
-    # Set the default RSA key
-    echo 'HostKey /etc/ssh/ssh_host_rsa_key' >> /etc/ssh/sshd_config && \
-    chmod 646 /etc/ssh/sshd_config && \
-    # install and configure sudo
-    apk add --no-cache sudo && \
-    addgroup sudo && \
-    # allow root to run any command
-    echo 'root ALL=(ALL) ALL' > /etc/sudoers && \
-    # allow everyone in the 'sudo' group to run any command without a password
-    echo '%sudo ALL=(ALL) NOPASSWD:ALL' >> /etc/sudoers && \
-    # add user to run most of the integration tests
-    adduser -D sshnet && \
-    passwd -u sshnet && \
-    echo 'sshnet:ssh4ever' | chpasswd && \
-    dos2unix /home/sshnet/.ssh/* && \
-    chown -R sshnet:sshnet /home/sshnet && \
-    chmod -R 700 /home/sshnet/.ssh && \
-    chmod -R 644 /home/sshnet/.ssh/authorized_keys && \
-    # add user to administer container (update configs, restart sshd)
-    adduser -D sshnetadm && \
-    passwd -u sshnetadm && \
-    echo 'sshnetadm:ssh4ever' | chpasswd && \
-    addgroup sshnetadm sudo && \
-    dos2unix /opt/sshnet/* && \
-    # install shadow package; we use chage command in this package to expire/unexpire password of the sshnet user
-    apk add --no-cache shadow && \
-    # allow us to use telnet command; we use this in the remote port forwarding tests
-    apk --no-cache add busybox-extras && \
-    # install full-fledged ps command
-    apk add --no-cache procps
-
-EXPOSE 22 22
-
-ENTRYPOINT ["/opt/sshnet/start.sh"]
+FROM mcr.microsoft.com/dotnet/sdk:7.0.403-bullseye-slim AS build
+ENV DEBIAN_FRONTEND=noninteractive
+ENV DEBCONF_NOWARNINGS="yes"
+ARG BUILD_CONFIGURATION=Debug
+
+RUN curl -fsSL https://get.docker.com -o get-docker.sh \
+    && sh get-docker.sh
+
+WORKDIR /src
+
+COPY ["test/Directory.Build.props", "test/"]
+COPY ["Directory.Build.props", "."]
+COPY ["test/Renci.SshNet.IntegrationTests/Dockerfile.TestServer", "test/Renci.SshNet.IntegrationTests/"]
+COPY ["test/Renci.SshNet.IntegrationTests/Renci.SshNet.IntegrationTests.csproj", "test/Renci.SshNet.IntegrationTests/"]
+COPY ["test/Renci.SshNet.TestTools.OpenSSH/Renci.SshNet.TestTools.OpenSSH.csproj", "test/Renci.SshNet.TestTools.OpenSSH/"]
+COPY ["src/Renci.SshNet/Renci.SshNet.csproj", "src/Renci.SshNet/"]
+RUN dotnet restore "./test/Renci.SshNet.IntegrationTests/./Renci.SshNet.IntegrationTests.csproj"
+
+COPY . .
+
+run ls test/Renci.SshNet.IntegrationTests/
+
+WORKDIR "/src/test/Renci.SshNet.IntegrationTests"
+RUN dotnet build "./Renci.SshNet.IntegrationTests.csproj" -c $BUILD_CONFIGURATION -o /app/build
+
+WORKDIR "/src/test/Renci.SshNet.IntegrationTests"
+CMD ["dotnet", "test", "--no-restore", "--no-build", "-o", "/app/build", "--results-directory", "artifacts", "--logger", "console;verbosity=detailed", "--logger", "liquid.md;LogFileName=TestReport.md", "-p:CollectCoverage=true", "-p:CoverletOutputFormat=cobertura", "-p:CoverletOutput=artifacts/coverage.xml", "Renci.SshNet.IntegrationTests.csproj"]
+