Update to MSTest 4 (#1721)

* Update to MSTest 4

* fix TestMethodForPlatformAttribute

replace Execute with ExecuteAsync and fix MSTEST0057

https://learn.microsoft.com/en-us/dotnet/core/testing/mstest-analyzers/mstest0057 (link currently dead)

* fix compilation error

* fix MSTEST0037

https://learn.microsoft.com/en-us/dotnet/core/testing/mstest-analyzers/mstest0037

* fix MSTEST0052

https://learn.microsoft.com/en-us/dotnet/core/testing/mstest-analyzers/mstest0052

* fix MSTEST0045

Fixing this properly would require the tests to respect
testContext.CancellationToken. I'm not sure this is worth fixing
or how to even do it for the sync methods.

https://learn.microsoft.com/en-us/dotnet/core/testing/mstest-analyzers/mstest0045

* fix MSTEST0001

I assume that parallelization would break a lot of stuff.

https://learn.microsoft.com/en-us/dotnet/core/testing/mstest-analyzers/mstest0001

* Workaround for new Sonar warnings because of MSTest4

* revert analyzer fixes in OrderedDictionaryTest

* use custom sync console logger for MSTest

to work around microsoft/testfx#6457

* remove redundant args

---------

Co-authored-by: Wojciech Nagórski <wojtpl2@gmail.com>
Co-authored-by: Rob Hague <rob.hague00@gmail.com>

Author: 3 people

Directory.Packages.props

@@ -14,7 +14,7 @@
     <PackageVersion Include="Microsoft.Bcl.Cryptography" Version="10.0.0" />
     <PackageVersion Include="Microsoft.Extensions.Logging.Abstractions" Version="8.0.3" />
     <PackageVersion Include="Microsoft.Extensions.Logging.Console" Version="9.0.9" />
-    <PackageVersion Include="MSTest" Version="3.9.3" />
+    <PackageVersion Include="MSTest" Version="4.0.2" />
     <PackageVersion Include="Moq" Version="4.20.72" />
     <PackageVersion Include="Nerdbank.GitVersioning" Version="3.7.115" />
     <PackageVersion Include="PolySharp" Version="1.15.0" />

test/.editorconfig

@@ -102,6 +102,12 @@ dotnet_diagnostic.SA1623.severity = none
 # For unit test projects, we do not care about documentation.
 dotnet_diagnostic.SA1629.severity = none
 
+# Workaround https://github.com/SonarSource/sonar-dotnet/issues/9767
+dotnet_diagnostic.S1450.severity = none
+dotnet_diagnostic.S1764.severity = none
+dotnet_diagnostic.S3260.severity = none
+dotnet_diagnostic.S5445.severity = none
+
 #### .NET Compiler Platform analysers rules ####
 
 # CA1001: Types that own disposable fields should be disposable

test/Renci.SshNet.IntegrationBenchmarks/Properties/AssemblyInfo.cs

@@ -0,0 +1 @@
+[assembly: DoNotParallelize]

test/Renci.SshNet.IntegrationTests/AuthenticationTests.cs

@@ -436,7 +436,7 @@ public void KeyboardInteractive_NoResponseSet_ThrowsSshAuthenticationException()
                 catch (SshAuthenticationException ex)
                 {
                     Assert.IsNull(ex.InnerException);
-                    Assert.IsTrue(ex.Message.StartsWith("AuthenticationPrompt.Response is null for prompt \"Password: \""), $"Message was \"{ex.Message}\"");
+                    Assert.StartsWith("AuthenticationPrompt.Response is null for prompt \"Password: \"", ex.Message);
                 }
             }
         }

test/Renci.SshNet.IntegrationTests/ConnectivityTests.cs

@@ -432,7 +432,7 @@ public void Common_HostKeyAlgorithms_NoMatch()
                 var ex = Assert.Throws<SshConnectionException>(client.Connect);
 
                 Assert.AreEqual(DisconnectReason.KeyExchangeFailed, ex.DisconnectReason);
-                Assert.IsTrue(ex.Message.StartsWith("No matching host key algorithm"), ex.Message);
+                Assert.StartsWith("No matching host key algorithm", ex.Message);
             }
         }
 

test/Renci.SshNet.IntegrationTests/Logging/TestConsoleLogger.cs

@@ -0,0 +1,40 @@
+#nullable enable
+using Microsoft.Extensions.Logging;
+
+namespace Renci.SshNet.IntegrationTests.Logging
+{
+    internal class TestConsoleLogger(string categoryName) : ILogger
+    {
+        public IDisposable? BeginScope<TState>(TState state)
+            where TState : notnull
+        {
+            return null;
+        }
+
+        public bool IsEnabled(LogLevel logLevel)
+        {
+            return true;
+        }
+
+        public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception? exception, Func<TState, Exception?, string> formatter)
+        {
+            StringBuilder sb = new StringBuilder();
+            sb.Append(logLevel);
+            sb.Append(": ");
+            sb.Append(categoryName);
+            sb.Append(": ");
+
+            string message = formatter(state, exception);
+            sb.Append(message);
+
+            if (exception != null)
+            {
+                sb.Append(": ");
+                sb.Append(exception);
+            }
+
+            string line = sb.ToString();
+            Console.WriteLine(line);
+        }
+    }
+}

test/Renci.SshNet.IntegrationTests/Logging/TestConsoleLoggerProvider.cs

@@ -0,0 +1,18 @@
+#nullable enable
+
+using Microsoft.Extensions.Logging;
+
+namespace Renci.SshNet.IntegrationTests.Logging
+{
+    internal class TestConsoleLoggerProvider : ILoggerProvider
+    {
+        public ILogger CreateLogger(string categoryName)
+        {
+            return new TestConsoleLogger(categoryName);
+        }
+
+        public void Dispose()
+        {
+        }
+    }
+}

test/Renci.SshNet.IntegrationTests/Logging/TestConsoleLoggerProviderExtensions.cs

@@ -0,0 +1,16 @@
+#nullable enable
+
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.DependencyInjection.Extensions;
+using Microsoft.Extensions.Logging;
+
+namespace Renci.SshNet.IntegrationTests.Logging
+{
+    internal static class TestConsoleLoggerProviderExtensions
+    {
+        internal static void AddTestConsoleLogger(this ILoggingBuilder builder)
+        {
+            builder.Services.TryAddEnumerable(ServiceDescriptor.Singleton<ILoggerProvider, TestConsoleLoggerProvider>());
+        }
+    }
+}

test/Renci.SshNet.IntegrationTests/OldIntegrationTests/SftpClientTest.ListDirectory.cs

@@ -43,7 +43,7 @@ public void Test_Sftp_ListDirectory_Current()
 
                 var files = sftp.ListDirectory(".");
 
-                Assert.IsTrue(files.Count() > 0);
+                Assert.IsGreaterThan(0, files.Count());
 
                 foreach (var file in files)
                 {
@@ -71,7 +71,7 @@ public async Task Test_Sftp_ListDirectoryAsync_Current()
                     Debug.WriteLine(file.FullName);
                 }
 
-                Assert.IsTrue(count > 0);
+                Assert.IsGreaterThan(0, count);
 
                 sftp.Disconnect();
             }
@@ -87,7 +87,7 @@ public void Test_Sftp_ListDirectory_Empty()
 
                 var files = sftp.ListDirectory(string.Empty);
 
-                Assert.IsTrue(files.Count() > 0);
+                Assert.IsGreaterThan(0, files.Count());
 
                 foreach (var file in files)
                 {
@@ -128,7 +128,7 @@ public void Test_Sftp_ListDirectory_HugeDirectory()
                 var files = sftp.ListDirectory(".");
 
                 //  Ensure that directory has at least 10000 items
-                Assert.IsTrue(files.Count() > 10000);
+                Assert.IsGreaterThan(10000, files.Count());
 
                 sftp.Disconnect();
             }
@@ -158,7 +158,7 @@ public void Test_Sftp_Change_Directory()
 
                 var files = sftp.ListDirectory(".");
 
-                Assert.IsTrue(files.First().FullName.StartsWith(string.Format("{0}", sftp.WorkingDirectory)));
+                Assert.StartsWith(string.Format("{0}", sftp.WorkingDirectory), files.First().FullName);
 
                 sftp.ChangeDirectory("test1_1");
 
@@ -178,7 +178,7 @@ public void Test_Sftp_Change_Directory()
 
                 files = sftp.ListDirectory("test1/test1_1");
 
-                Assert.IsTrue(files.First().FullName.StartsWith(string.Format("{0}/test1/test1_1", sftp.WorkingDirectory)));
+                Assert.StartsWith(string.Format("{0}/test1/test1_1", sftp.WorkingDirectory), files.First().FullName);
 
                 sftp.ChangeDirectory("test1/test1_1");
 
@@ -227,7 +227,7 @@ public async Task Test_Sftp_Change_DirectoryAsync()
 
                 var files = sftp.ListDirectory(".");
 
-                Assert.IsTrue(files.First().FullName.StartsWith(string.Format("{0}", sftp.WorkingDirectory)));
+                Assert.StartsWith(string.Format("{0}", sftp.WorkingDirectory), files.First().FullName);
 
                 await sftp.ChangeDirectoryAsync("test1_1", CancellationToken.None).ConfigureAwait(false);
 
@@ -247,7 +247,7 @@ public async Task Test_Sftp_Change_DirectoryAsync()
 
                 files = sftp.ListDirectory("test1/test1_1");
 
-                Assert.IsTrue(files.First().FullName.StartsWith(string.Format("{0}/test1/test1_1", sftp.WorkingDirectory)));
+                Assert.StartsWith(string.Format("{0}/test1/test1_1", sftp.WorkingDirectory), files.First().FullName);
 
                 await sftp.ChangeDirectoryAsync("test1/test1_1", CancellationToken.None).ConfigureAwait(false);
 

test/Renci.SshNet.IntegrationTests/OldIntegrationTests/SftpClientTest.SynchronizeDirectories.cs

@@ -24,7 +24,7 @@ public void Test_Sftp_SynchronizeDirectories()
                 string searchPattern = Path.GetFileName(uploadedFileName);
                 var upLoadedFiles = sftp.SynchronizeDirectories(sourceDir, destDir, searchPattern);
 
-                Assert.IsTrue(upLoadedFiles.Count() > 0);
+                Assert.IsGreaterThan(0, upLoadedFiles.Count());
 
                 foreach (var file in upLoadedFiles)
                 {
@@ -63,7 +63,7 @@ public void Test_Sftp_BeginSynchronizeDirectories()
 
                 var upLoadedFiles = sftp.EndSynchronizeDirectories(asyncResult);
 
-                Assert.IsTrue(upLoadedFiles.Count() > 0);
+                Assert.IsGreaterThan(0, upLoadedFiles.Count());
 
                 foreach (var file in upLoadedFiles)
                 {