Miscellaneous cleanup/throw helpers (#1491)

* PrivateKeyFile stuff

* Extract from net7 branch

* more ThrowHelper stuff

Author: Rob-Hague

Directory.Build.props

@@ -32,7 +32,7 @@
         Disable nullable warnings on old frameworks because of missing annotations.
   -->
   <PropertyGroup Condition=" !$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)', 'net6.0')) ">
-    <NoWarn>$(NoWarn);CS8602</NoWarn>
+    <NoWarn>$(NoWarn);CS8602;CS8604;CS8777</NoWarn>
   </PropertyGroup>
 
   <!--

Directory.Packages.props

@@ -18,6 +18,7 @@
     <PackageVersion Include="MSTest.TestFramework" Version="3.6.0" />
     <PackageVersion Include="Moq" Version="4.20.72" />
     <PackageVersion Include="Nerdbank.GitVersioning" Version="3.7.70-alpha" />
+    <PackageVersion Include="PolySharp" Version="1.14.1" />
     <PackageVersion Include="SonarAnalyzer.CSharp" Version="9.19.0.84025" />
     <PackageVersion Include="StyleCop.Analyzers" Version="1.2.0-beta.556" />
     <PackageVersion Include="System.Formats.Asn1" Version="8.0.1" />

src/Renci.SshNet/.editorconfig

@@ -188,3 +188,6 @@ dotnet_diagnostic.MA0040.severity = none
 # MA0042: Do not use blocking calls in an async method
 # duplicate of CA1849
 dotnet_diagnostic.MA0042.severity = none
+
+# S3236: Caller information arguments should not be provided explicitly
+dotnet_diagnostic.S3236.severity = none

src/Renci.SshNet/Abstractions/SocketAbstraction.cs

@@ -129,7 +129,7 @@ public static void ClearReadBuffer(Socket socket)
 
         public static int ReadPartial(Socket socket, byte[] buffer, int offset, int size, TimeSpan timeout)
         {
-            socket.ReceiveTimeout = timeout.AsTimeout(nameof(timeout));
+            socket.ReceiveTimeout = timeout.AsTimeout();
 
             try
             {
@@ -274,7 +274,7 @@ public static int Read(Socket socket, byte[] buffer, int offset, int size, TimeS
             var totalBytesRead = 0;
             var totalBytesToRead = size;
 
-            socket.ReceiveTimeout = readTimeout.AsTimeout(nameof(readTimeout));
+            socket.ReceiveTimeout = readTimeout.AsTimeout();
 
             do
             {

src/Renci.SshNet/Abstractions/ThreadAbstraction.cs

@@ -2,6 +2,8 @@
 using System.Threading;
 using System.Threading.Tasks;
 
+using Renci.SshNet.Common;
+
 namespace Renci.SshNet.Abstractions
 {
     internal static class ThreadAbstraction
@@ -16,10 +18,7 @@ internal static class ThreadAbstraction
         /// </returns>
         public static Task ExecuteThreadLongRunning(Action action)
         {
-            if (action is null)
-            {
-                throw new ArgumentNullException(nameof(action));
-            }
+            ThrowHelper.ThrowIfNull(action);
 
             return Task.Factory.StartNew(action,
                                          CancellationToken.None,
@@ -33,10 +32,7 @@ public static Task ExecuteThreadLongRunning(Action action)
         /// <param name="action">The action to execute.</param>
         public static void ExecuteThread(Action action)
         {
-            if (action is null)
-            {
-                throw new ArgumentNullException(nameof(action));
-            }
+            ThrowHelper.ThrowIfNull(action);
 
             _ = ThreadPool.QueueUserWorkItem(o => action());
         }

src/Renci.SshNet/AuthenticationMethod.cs

@@ -1,5 +1,7 @@
 using System;
 
+using Renci.SshNet.Common;
+
 namespace Renci.SshNet
 {
     /// <summary>
@@ -34,10 +36,7 @@ public abstract class AuthenticationMethod : IAuthenticationMethod
         /// <exception cref="ArgumentException"><paramref name="username"/> is whitespace or <see langword="null"/>.</exception>
         protected AuthenticationMethod(string username)
         {
-            if (string.IsNullOrWhiteSpace(username))
-            {
-                throw new ArgumentException("username");
-            }
+            ThrowHelper.ThrowIfNullOrWhiteSpace(username);
 
             Username = username;
         }

src/Renci.SshNet/BaseClient.cs

@@ -184,15 +184,8 @@ protected BaseClient(ConnectionInfo connectionInfo, bool ownsConnectionInfo)
         /// </remarks>
         private protected BaseClient(ConnectionInfo connectionInfo, bool ownsConnectionInfo, IServiceFactory serviceFactory)
         {
-            if (connectionInfo is null)
-            {
-                throw new ArgumentNullException(nameof(connectionInfo));
-            }
-
-            if (serviceFactory is null)
-            {
-                throw new ArgumentNullException(nameof(serviceFactory));
-            }
+            ThrowHelper.ThrowIfNull(connectionInfo);
+            ThrowHelper.ThrowIfNull(serviceFactory);
 
             _connectionInfo = connectionInfo;
             _ownsConnectionInfo = ownsConnectionInfo;
@@ -458,17 +451,10 @@ protected virtual void Dispose(bool disposing)
         /// <summary>
         /// Check if the current instance is disposed.
         /// </summary>
-        /// <exception cref="ObjectDisposedException">THe current instance is disposed.</exception>
+        /// <exception cref="ObjectDisposedException">The current instance is disposed.</exception>
         protected void CheckDisposed()
         {
-#if NET7_0_OR_GREATER
-            ObjectDisposedException.ThrowIf(_isDisposed, this);
-#else
-            if (_isDisposed)
-            {
-                throw new ObjectDisposedException(GetType().FullName);
-            }
-#endif // NET7_0_OR_GREATER
+            ThrowHelper.ThrowObjectDisposedIf(_isDisposed, this);
         }
 
         /// <summary>

src/Renci.SshNet/ClientAuthentication.cs

@@ -52,15 +52,8 @@ internal int PartialSuccessLimit
         /// <exception cref="SshAuthenticationException">Failed to authenticate the client.</exception>
         public void Authenticate(IConnectionInfoInternal connectionInfo, ISession session)
         {
-            if (connectionInfo is null)
-            {
-                throw new ArgumentNullException(nameof(connectionInfo));
-            }
-
-            if (session is null)
-            {
-                throw new ArgumentNullException(nameof(session));
-            }
+            ThrowHelper.ThrowIfNull(connectionInfo);
+            ThrowHelper.ThrowIfNull(session);
 
             session.RegisterMessage("SSH_MSG_USERAUTH_FAILURE");
             session.RegisterMessage("SSH_MSG_USERAUTH_SUCCESS");

src/Renci.SshNet/Common/ChannelDataEventArgs.cs

@@ -16,10 +16,7 @@ internal class ChannelDataEventArgs : ChannelEventArgs
         public ChannelDataEventArgs(uint channelNumber, byte[] data)
             : base(channelNumber)
         {
-            if (data is null)
-            {
-                throw new ArgumentNullException(nameof(data));
-            }
+            ThrowHelper.ThrowIfNull(data);
 
             Data = data;
         }

src/Renci.SshNet/Common/ChannelInputStream.cs

@@ -101,10 +101,7 @@ public override int Read(byte[] buffer, int offset, int count)
         /// <exception cref="ArgumentOutOfRangeException">offset or count is negative.</exception>
         public override void Write(byte[] buffer, int offset, int count)
         {
-            if (buffer == null)
-            {
-                throw new ArgumentNullException(nameof(buffer));
-            }
+            ThrowHelper.ThrowIfNull(buffer);
 
             if (offset + count > buffer.Length)
             {
@@ -116,10 +113,7 @@ public override void Write(byte[] buffer, int offset, int count)
                 throw new ArgumentOutOfRangeException(nameof(offset), "offset or count is negative.");
             }
 
-            if (_isDisposed)
-            {
-                throw CreateObjectDisposedException();
-            }
+            ThrowHelper.ThrowObjectDisposedIf(_isDisposed, this);
 
             if (count == 0)
             {
@@ -208,10 +202,5 @@ public override long Position
             get { return _totalPosition; }
             set { throw new NotSupportedException(); }
         }
-
-        private ObjectDisposedException CreateObjectDisposedException()
-        {
-            return new ObjectDisposedException(GetType().FullName);
-        }
     }
 }