Round 2 of analyzer fixes and general cleanup. (#1132)

sshnet · May 29, 2023 · c04cdbc · c04cdbc
1 parent 3ecbd10
commit c04cdbc
Show file tree

Hide file tree

Showing 365 changed files with 5,146 additions and 4,206 deletions.
diff --git a/.editorconfig_soon → .editorconfig b/.editorconfig_soon → .editorconfig
@@ -535,6 +535,11 @@ dotnet_diagnostic.IDE0045.severity = none
 # Configured using 'dotnet_style_prefer_conditional_expression_over_return'
 dotnet_diagnostic.IDE0046.severity = suggestion
 
+# IDE0047: Remove unnecessary parentheses
+# 
+# Removing "unnecessary" parentheses is not always a clear win for readability.
+dotnet_diagnostic.IDE0047.severity = suggestion
+
 # IDE0055: Fix formatting
 #
 # When enabled, diagnostics are reported for indented object initializers.
@@ -547,6 +552,12 @@ dotnet_diagnostic.IDE0046.severity = suggestion
 # There are no settings to configure this correctly, unless https://github.com/dotnet/roslyn/issues/63256 (or similar) is ever implemented.
 dotnet_diagnostic.IDE0055.severity = none
 
+# IDE0130: Namespace does not match folder structure
+# https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/style-rules/ide0130
+#
+# TODO: Remove when https://github.com/sshnet/SSH.NET/issues/1129 is fixed
+dotnet_diagnostic.IDE0130.severity = none
+
 # IDE0270: Null check can be simplified
 # 
 # var inputPath = originalDossierPathList.Find(x => x.id == updatedPath.id);

diff --git a/Directory.Build.props b/Directory.Build.props
@@ -9,10 +9,8 @@
         <AssemblyOriginatorKeyFile>$(MSBuildThisFileDirectory)src\Renci.SshNet.snk</AssemblyOriginatorKeyFile>
         <GenerateDocumentationFile>true</GenerateDocumentationFile>
         <LangVersion>latest</LangVersion>
-        <!--
         <WarningLevel>9999</WarningLevel>
         <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
-        -->
         <AutoGenerateBindingRedirects>false</AutoGenerateBindingRedirects>
     </PropertyGroup>
 

diff --git a/src/Renci.SshNet.Tests/.editorconfig b/src/Renci.SshNet.Tests/.editorconfig
@@ -0,0 +1,32 @@
+[*.cs]
+
+#### SYSLIB diagnostics ####
+
+# SYSLIB1045: Use 'GeneratedRegexAttribute' to generate the regular expression implementation at compile-time
+#
+# TODO: Remove this when https://github.com/sshnet/SSH.NET/issues/1131 is implemented.
+dotnet_diagnostic.SYSLIB1045.severity = none
+
+### StyleCop Analyzers rules ###
+
+#### .NET Compiler Platform analysers rules ####
+
+# IDE0007: Use var instead of explicit type
+# https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/style-rules/ide0007
+dotnet_diagnostic.IDE0007.severity = suggestion
+
+# IDE0028: Use collection initializers
+# https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/style-rules/ide0028
+dotnet_diagnostic.IDE0028.severity = suggestion
+
+# IDE0058: Remove unnecessary expression value
+# https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/style-rules/ide0058
+dotnet_diagnostic.IDE0058.severity = suggestion
+
+# IDE0059: Remove unnecessary value assignment
+# https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/style-rules/ide0059
+dotnet_diagnostic.IDE0059.severity = suggestion
+
+# IDE0230: Use UTF-8 string literal
+# https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/style-rules/ide0230
+dotnet_diagnostic.IDE0230.severity = suggestion
diff --git a/src/Renci.SshNet.Tests/Classes/BaseClientTestBase.cs b/src/Renci.SshNet.Tests/Classes/BaseClientTestBase.cs
@@ -6,15 +6,15 @@ namespace Renci.SshNet.Tests.Classes
 {
     public abstract class BaseClientTestBase : TripleATestBase
     {
-        internal Mock<IServiceFactory> _serviceFactoryMock { get; private set; }
-        internal Mock<ISocketFactory> _socketFactoryMock { get; private set; }
-        internal Mock<ISession> _sessionMock { get; private set; }
+        internal Mock<IServiceFactory> ServiceFactoryMock { get; private set; }
+        internal Mock<ISocketFactory> SocketFactoryMock { get; private set; }
+        internal Mock<ISession> SessionMock { get; private set; }
 
         protected virtual void CreateMocks()
         {
-            _serviceFactoryMock = new Mock<IServiceFactory>(MockBehavior.Strict);
-            _socketFactoryMock = new Mock<ISocketFactory>(MockBehavior.Strict);
-            _sessionMock = new Mock<ISession>(MockBehavior.Strict);
+            ServiceFactoryMock = new Mock<IServiceFactory>(MockBehavior.Strict);
+            SocketFactoryMock = new Mock<ISocketFactory>(MockBehavior.Strict);
+            SessionMock = new Mock<ISession>(MockBehavior.Strict);
         }
 
         protected virtual void SetupData()

diff --git a/src/Renci.SshNet.Tests/Classes/BaseClientTest_Connect_OnConnectedThrowsException.cs b/src/Renci.SshNet.Tests/Classes/BaseClientTest_Connect_OnConnectedThrowsException.cs
@@ -24,20 +24,20 @@ protected override void SetupData()
 
         protected override void SetupMocks()
         {
-            _serviceFactoryMock.Setup(p => p.CreateSocketFactory())
-                               .Returns(_socketFactoryMock.Object);
-            _serviceFactoryMock.Setup(p => p.CreateSession(_connectionInfo, _socketFactoryMock.Object))
-                               .Returns(_sessionMock.Object);
-            _sessionMock.Setup(p => p.Connect());
-            _sessionMock.Setup(p => p.Dispose());
+            ServiceFactoryMock.Setup(p => p.CreateSocketFactory())
+                               .Returns(SocketFactoryMock.Object);
+            ServiceFactoryMock.Setup(p => p.CreateSession(_connectionInfo, SocketFactoryMock.Object))
+                               .Returns(SessionMock.Object);
+            SessionMock.Setup(p => p.Connect());
+            SessionMock.Setup(p => p.Dispose());
         }
 
         protected override void TearDown()
         {
             if (_client != null)
             {
-                _sessionMock.Setup(p => p.OnDisconnecting());
-                _sessionMock.Setup(p => p.Dispose());
+                SessionMock.Setup(p => p.OnDisconnecting());
+                SessionMock.Setup(p => p.Dispose());
                 _client.Dispose();
             }
         }
@@ -46,7 +46,7 @@ protected override void Arrange()
         {
             base.Arrange();
 
-            _client = new MyClient(_connectionInfo, false, _serviceFactoryMock.Object)
+            _client = new MyClient(_connectionInfo, false, ServiceFactoryMock.Object)
                 {
                     OnConnectedException = _onConnectException
                 };
@@ -75,26 +75,26 @@ public void ConnectShouldRethrowExceptionThrownByOnConnect()
         [TestMethod]
         public void CreateSocketFactoryOnServiceFactoryShouldBeInvokedOnce()
         {
-            _serviceFactoryMock.Verify(p => p.CreateSocketFactory(), Times.Once);
+            ServiceFactoryMock.Verify(p => p.CreateSocketFactory(), Times.Once);
         }
 
         [TestMethod]
         public void CreateSessionOnServiceFactoryShouldBeInvokedOnce()
         {
-            _serviceFactoryMock.Verify(p => p.CreateSession(_connectionInfo, _socketFactoryMock.Object),
+            ServiceFactoryMock.Verify(p => p.CreateSession(_connectionInfo, SocketFactoryMock.Object),
                                        Times.Once);
         }
 
         [TestMethod]
         public void ConnectOnSessionShouldBeInvokedOnce()
         {
-            _sessionMock.Verify(p => p.Connect(), Times.Once);
+            SessionMock.Verify(p => p.Connect(), Times.Once);
         }
 
         [TestMethod]
         public void DisposeOnSessionShouldBeInvokedOnce()
         {
-            _sessionMock.Verify(p => p.Dispose(), Times.Once);
+            SessionMock.Verify(p => p.Dispose(), Times.Once);
         }
 
         [TestMethod]
@@ -104,7 +104,7 @@ public void ErrorOccuredOnSessionShouldNoLongerBeSignaledViaErrorOccurredOnBaseC
 
             _client.ErrorOccurred += (sender, args) => Interlocked.Increment(ref errorOccurredSignalCount);
 
-            _sessionMock.Raise(p => p.ErrorOccured += null, new ExceptionEventArgs(new Exception()));
+            SessionMock.Raise(p => p.ErrorOccured += null, new ExceptionEventArgs(new Exception()));
 
             Assert.AreEqual(0, errorOccurredSignalCount);
         }
@@ -116,7 +116,7 @@ public void HostKeyReceivedOnSessionShouldNoLongerBeSignaledViaHostKeyReceivedOn
 
             _client.HostKeyReceived += (sender, args) => Interlocked.Increment(ref hostKeyReceivedSignalCount);
 
-            _sessionMock.Raise(p => p.HostKeyReceived += null, new HostKeyEventArgs(GetKeyHostAlgorithm()));
+            SessionMock.Raise(p => p.HostKeyReceived += null, new HostKeyEventArgs(GetKeyHostAlgorithm()));
 
             Assert.AreEqual(0, hostKeyReceivedSignalCount);
         }

diff --git a/src/Renci.SshNet.Tests/Classes/BaseClientTest_Connected_KeepAliveInterval_NegativeOne.cs b/src/Renci.SshNet.Tests/Classes/BaseClientTest_Connected_KeepAliveInterval_NegativeOne.cs
@@ -1,8 +1,10 @@
 using System;
 using System.Threading;
+
 using Microsoft.VisualStudio.TestTools.UnitTesting;
+
 using Moq;
-using Renci.SshNet.Connection;
+
 using Renci.SshNet.Messages.Transport;
 
 namespace Renci.SshNet.Tests.Classes
@@ -24,22 +26,23 @@ protected override void SetupData()
 
         protected override void SetupMocks()
         {
-            _serviceFactoryMock.Setup(p => p.CreateSocketFactory())
-                               .Returns(_socketFactoryMock.Object);
-            _serviceFactoryMock.Setup(p => p.CreateSession(_connectionInfo, _socketFactoryMock.Object))
-                               .Returns(_sessionMock.Object);
-            _sessionMock.Setup(p => p.Connect());
-            _sessionMock.Setup(p => p.IsConnected).Returns(true);
-            _sessionMock.Setup(p => p.TrySendMessage(It.IsAny<IgnoreMessage>()))
-                        .Returns(true)
-                        .Callback(() => Interlocked.Increment(ref _keepAliveCount));
+            _ = ServiceFactoryMock.Setup(p => p.CreateSocketFactory())
+                                   .Returns(SocketFactoryMock.Object);
+            _ = ServiceFactoryMock.Setup(p => p.CreateSession(_connectionInfo, SocketFactoryMock.Object))
+                                   .Returns(SessionMock.Object);
+            _ = SessionMock.Setup(p => p.Connect());
+            _ = SessionMock.Setup(p => p.IsConnected)
+                            .Returns(true);
+            _ = SessionMock.Setup(p => p.TrySendMessage(It.IsAny<IgnoreMessage>()))
+                            .Returns(true)
+                            .Callback(() => Interlocked.Increment(ref _keepAliveCount));
         }
 
         protected override void Arrange()
         {
             base.Arrange();
 
-            _client = new MyClient(_connectionInfo, false, _serviceFactoryMock.Object);
+            _client = new MyClient(_connectionInfo, false, ServiceFactoryMock.Object);
             _client.Connect();
             _client.KeepAliveInterval = _keepAliveInterval;
         }
@@ -48,8 +51,8 @@ protected override void TearDown()
         {
             if (_client != null)
             {
-                _sessionMock.Setup(p => p.OnDisconnecting());
-                _sessionMock.Setup(p => p.Dispose());
+                SessionMock.Setup(p => p.OnDisconnecting());
+                SessionMock.Setup(p => p.Dispose());
                 _client.Dispose();
             }
         }
@@ -72,25 +75,25 @@ public void KeepAliveIntervalShouldReturnConfiguredValue()
         [TestMethod]
         public void CreateSocketFactoryOnServiceFactoryShouldBeInvokedOnce()
         {
-            _serviceFactoryMock.Verify(p => p.CreateSocketFactory(), Times.Once);
+            ServiceFactoryMock.Verify(p => p.CreateSocketFactory(), Times.Once);
         }
 
         [TestMethod]
         public void CreateSessionOnServiceFactoryShouldBeInvokedOnce()
         {
-            _serviceFactoryMock.Verify(p => p.CreateSession(_connectionInfo, _socketFactoryMock.Object), Times.Once);
+            ServiceFactoryMock.Verify(p => p.CreateSession(_connectionInfo, SocketFactoryMock.Object), Times.Once);
         }
 
         [TestMethod]
         public void ConnectOnSessionShouldBeInvokedOnce()
         {
-            _sessionMock.Verify(p => p.Connect(), Times.Once);
+            SessionMock.Verify(p => p.Connect(), Times.Once);
         }
 
         [TestMethod]
         public void IsConnectedOnSessionShouldBeInvokedOnce()
         {
-            _sessionMock.Verify(p => p.IsConnected, Times.Once);
+            SessionMock.Verify(p => p.IsConnected, Times.Once);
         }
 
         [TestMethod]
@@ -99,7 +102,7 @@ public void SendMessageOnSessionShouldBeInvokedOneTime()
             // allow keep-alive to be sent once
             Thread.Sleep(100);
 
-            _sessionMock.Verify(p => p.TrySendMessage(It.IsAny<IgnoreMessage>()), Times.Exactly(1));
+            SessionMock.Verify(p => p.TrySendMessage(It.IsAny<IgnoreMessage>()), Times.Exactly(1));
         }
 
         private class MyClient : BaseClient

diff --git a/src/Renci.SshNet.Tests/Classes/BaseClientTest_Connected_KeepAliveInterval_NotNegativeOne.cs b/src/Renci.SshNet.Tests/Classes/BaseClientTest_Connected_KeepAliveInterval_NotNegativeOne.cs
@@ -23,13 +23,13 @@ protected override void SetupData()
 
         protected override void SetupMocks()
         {
-            _serviceFactoryMock.Setup(p => p.CreateSocketFactory())
-                               .Returns(_socketFactoryMock.Object);
-            _serviceFactoryMock.Setup(p => p.CreateSession(_connectionInfo, _socketFactoryMock.Object))
-                               .Returns(_sessionMock.Object);
-            _sessionMock.Setup(p => p.Connect());
-            _sessionMock.Setup(p => p.IsConnected).Returns(true);
-            _sessionMock.Setup(p => p.TrySendMessage(It.IsAny<IgnoreMessage>()))
+            ServiceFactoryMock.Setup(p => p.CreateSocketFactory())
+                               .Returns(SocketFactoryMock.Object);
+            ServiceFactoryMock.Setup(p => p.CreateSession(_connectionInfo, SocketFactoryMock.Object))
+                               .Returns(SessionMock.Object);
+            SessionMock.Setup(p => p.Connect());
+            SessionMock.Setup(p => p.IsConnected).Returns(true);
+            SessionMock.Setup(p => p.TrySendMessage(It.IsAny<IgnoreMessage>()))
                         .Returns(true)
                         .Callback(() => Interlocked.Increment(ref _keepAliveCount));
         }
@@ -38,16 +38,16 @@ protected override void Arrange()
         {
             base.Arrange();
 
-            _client = new MyClient(_connectionInfo, false, _serviceFactoryMock.Object);
+            _client = new MyClient(_connectionInfo, false, ServiceFactoryMock.Object);
             _client.Connect();
         }
 
         protected override void TearDown()
         {
             if (_client != null)
             {
-                _sessionMock.Setup(p => p.OnDisconnecting());
-                _sessionMock.Setup(p => p.Dispose());
+                SessionMock.Setup(p => p.OnDisconnecting());
+                SessionMock.Setup(p => p.Dispose());
                 _client.Dispose();
             }
         }
@@ -74,32 +74,32 @@ public void KeepAliveIntervalShouldReturnConfiguredValue()
         [TestMethod]
         public void CreateSocketFactoryOnServiceFactoryShouldBeInvokedOnce()
         {
-            _serviceFactoryMock.Verify(p => p.CreateSocketFactory(), Times.Once);
+            ServiceFactoryMock.Verify(p => p.CreateSocketFactory(), Times.Once);
         }
 
         [TestMethod]
         public void CreateSessionOnServiceFactoryShouldBeInvokedOnce()
         {
-            _serviceFactoryMock.Verify(p => p.CreateSession(_connectionInfo, _socketFactoryMock.Object),
+            ServiceFactoryMock.Verify(p => p.CreateSession(_connectionInfo, SocketFactoryMock.Object),
                                        Times.Once);
         }
 
         [TestMethod]
         public void ConnectOnSessionShouldBeInvokedOnce()
         {
-            _sessionMock.Verify(p => p.Connect(), Times.Once);
+            SessionMock.Verify(p => p.Connect(), Times.Once);
         }
 
         [TestMethod]
         public void IsConnectedOnSessionShouldBeInvokedOnce()
         {
-            _sessionMock.Verify(p => p.IsConnected, Times.Once);
+            SessionMock.Verify(p => p.IsConnected, Times.Once);
         }
 
         [TestMethod]
         public void SendMessageOnSessionShouldBeInvokedThreeTimes()
         {
-            _sessionMock.Verify(p => p.TrySendMessage(It.IsAny<IgnoreMessage>()), Times.Exactly(3));
+            SessionMock.Verify(p => p.TrySendMessage(It.IsAny<IgnoreMessage>()), Times.Exactly(3));
         }
 
         private class MyClient : BaseClient