fixed CA1062 https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/ca1062 - Validate arguments of public methods

Author: FreeAndNil

src/log4net.Tests/Appender/RollingFileAppenderTest.cs

@@ -359,19 +359,19 @@ public RollFileEntry(string fileName, long fileLength)
   /// A table of entries showing files that should exist and their expected sizes
   /// after a message is logged
   /// </param>
-  public sealed class RollConditions(List<RollFileEntry> preLogFileEntries, List<RollFileEntry> postLogFileEntries)
+  public sealed class RollConditions(IList<RollFileEntry> preLogFileEntries, IList<RollFileEntry> postLogFileEntries)
   {
     /// <summary>
     /// A table of entries showing files that should exist and their expected sizes
     /// before logging is called
     /// </summary>
-    public List<RollFileEntry> GetPreLogFileEntries() => preLogFileEntries;
+    public IList<RollFileEntry> PreLogFileEntries => preLogFileEntries;
 
     /// <summary>
     /// A table of entries showing files that should exist and their expected sizes
     /// after a message is logged
     /// </summary>
-    public List<RollFileEntry> GetPostLogFileEntries() => postLogFileEntries;
+    public IList<RollFileEntry> PostLogFileEntries => postLogFileEntries;
   }
 
   private static void VerifyExistenceAndRemoveFromList(List<string> alExisting,
@@ -389,7 +389,7 @@ private static void VerifyExistenceAndRemoveFromList(List<string> alExisting,
   /// </summary>
   /// <param name="sBaseFileName"></param>
   /// <param name="fileEntries"></param>
-  private static void VerifyFileConditions(string sBaseFileName, List<RollFileEntry> fileEntries)
+  private static void VerifyFileConditions(string sBaseFileName, IList<RollFileEntry> fileEntries)
   {
     List<string> alExisting = GetExistingFiles(sBaseFileName);
 
@@ -429,7 +429,7 @@ private static void VerifyFileConditions(string sBaseFileName, List<RollFileEntr
   /// <param name="sBaseFileName"></param>
   /// <param name="entry"></param>
   private static void VerifyPreConditions(string sBaseFileName, RollConditions entry)
-    => VerifyFileConditions(sBaseFileName, entry.GetPreLogFileEntries());
+    => VerifyFileConditions(sBaseFileName, entry.PreLogFileEntries);
 
   /// <summary>
   /// Called after logging a message to check that all the expected files exist, 
@@ -439,7 +439,7 @@ private static void VerifyPreConditions(string sBaseFileName, RollConditions ent
   /// <param name="sBaseFileName"></param>
   /// <param name="entry"></param>
   private static void VerifyPostConditions(string sBaseFileName, RollConditions entry)
-    => VerifyFileConditions(sBaseFileName, entry.GetPostLogFileEntries());
+    => VerifyFileConditions(sBaseFileName, entry.PostLogFileEntries);
 
   /// <summary>
   /// Logs a message, verifying the expected message counts against the 
@@ -672,7 +672,7 @@ private static RollConditions BuildTableEntry(string sBackupFiles,
       return new RollConditions(AddFinalElement(null, current), post);
     }
 
-    return new RollConditions(preCondition.GetPostLogFileEntries(), post);
+    return new RollConditions(preCondition.PostLogFileEntries, post);
   }
 
   /// <summary>
@@ -1808,7 +1808,7 @@ private static List<string> GetExistingFiles(string baseFilePath, bool preserveL
   {
     2 => TestMessage98Chars,
     1 => TestMessage99Chars,
-    _ => throw new Exception("Unexpected Environment.NewLine.Length"),
+    _ => throw new InvalidOperationException("Unexpected Environment.NewLine.Length"),
   };
 }
 
@@ -1818,15 +1818,13 @@ public sealed class RollingFileAppenderSubClassTest : RollingFileAppender
   [Test]
   public void TestComputeCheckPeriod()
   {
-    RollingFileAppender rfa = new();
-
-    Assert.That(rfa.ComputeCheckPeriod(".yyyy-MM-dd HH:mm"), Is.EqualTo(RollPoint.TopOfMinute), "TopOfMinute pattern");
-    Assert.That(rfa.ComputeCheckPeriod(".yyyy-MM-dd HH"), Is.EqualTo(RollPoint.TopOfHour), "TopOfHour pattern");
-    Assert.That(rfa.ComputeCheckPeriod(".yyyy-MM-dd tt"), Is.EqualTo(RollPoint.HalfDay), "HalfDay pattern");
-    Assert.That(rfa.ComputeCheckPeriod(".yyyy-MM-dd"), Is.EqualTo(RollPoint.TopOfDay), "TopOfDay pattern");
-    Assert.That(rfa.ComputeCheckPeriod(".yyyy-MM"), Is.EqualTo(RollPoint.TopOfMonth), "TopOfMonth pattern");
+    Assert.That(ComputeCheckPeriod(".yyyy-MM-dd HH:mm"), Is.EqualTo(RollPoint.TopOfMinute), "TopOfMinute pattern");
+    Assert.That(ComputeCheckPeriod(".yyyy-MM-dd HH"), Is.EqualTo(RollPoint.TopOfHour), "TopOfHour pattern");
+    Assert.That(ComputeCheckPeriod(".yyyy-MM-dd tt"), Is.EqualTo(RollPoint.HalfDay), "HalfDay pattern");
+    Assert.That(ComputeCheckPeriod(".yyyy-MM-dd"), Is.EqualTo(RollPoint.TopOfDay), "TopOfDay pattern");
+    Assert.That(ComputeCheckPeriod(".yyyy-MM"), Is.EqualTo(RollPoint.TopOfMonth), "TopOfMonth pattern");
 
     // Test invalid roll point
-    Assert.That(rfa.ComputeCheckPeriod("..."), Is.EqualTo(RollPoint.InvalidRollPoint), "TopOfMonth pattern");
+    Assert.That(ComputeCheckPeriod("..."), Is.EqualTo(RollPoint.InvalidRollPoint), "TopOfMonth pattern");
   }
 }

src/log4net.Tests/Core/LoggingEventTest.cs

@@ -37,6 +37,7 @@ private static readonly DateTime _localTime
     = new(2000, 7, 1, 0, 0, 0, 0, CultureInfo.InvariantCulture.Calendar, DateTimeKind.Local);
 
   [Test]
+  [System.Diagnostics.CodeAnalysis.SuppressMessage("Security", "CA2300:Do not use insecure deserializer BinaryFormatter")]
   public void SerializeDeserialize_BinaryFormatter()
   {
     Utils.InconclusiveOnMono();
@@ -86,6 +87,7 @@ public void SerializeDeserialize_BinaryFormatter()
   /// Loads and validates the cached serialized v2 event data from the log4net2-SerializeEvent directory.
   /// </summary>
   [Test]
+  [System.Diagnostics.CodeAnalysis.SuppressMessage("Security", "CA2300:Do not use insecure deserializer BinaryFormatter")]
   public void DeserializeV2()
   {
     Utils.InconclusiveOnMono();

src/log4net.Tests/Util/PatternConverterTest.cs

@@ -136,6 +136,7 @@ public class PropertyKeyCountPatternLayoutConverter : PatternLayoutConverter
 {
   public PropertyKeyCountPatternLayoutConverter() => MostRecentInstance = this;
 
+  [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1062:Validate arguments of public methods")]
   protected override void Convert(TextWriter writer, LoggingEvent loggingEvent) 
     => writer.Write(Properties!.GetKeys().Length);
 
@@ -146,6 +147,7 @@ public class PropertyKeyCountPatternConverter : PatternConverter
 {
   public PropertyKeyCountPatternConverter() => MostRecentInstance = this;
 
+  [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1062:Validate arguments of public methods")]
   public override void Convert(TextWriter writer, object? state)
     => writer.Write(Properties!.GetKeys().Length);
 

src/log4net.globalconfig

@@ -55,9 +55,6 @@ dotnet_diagnostic.CA1027.severity = warning
 #CA1031: Do not catch general exception types
 dotnet_diagnostic.CA1031.severity = warning
 
-#CA1034: Nested types should not be visible
-dotnet_diagnostic.CA1034.severity = warning
-
 #CA1040: Avoid empty interfaces
 dotnet_diagnostic.CA1040.severity = warning
 
@@ -461,7 +458,7 @@ dotnet_diagnostic.CA5402.severity = warning
 dotnet_diagnostic.CA5403.severity = warning
 
 #IDE0010: Add missing cases to switch statement
-dotnet_diagnostic.IDE0010.severity = warning
+dotnet_diagnostic.IDE0010.severity = none
 
 #IDE0067: Disposable object is never disposed
 dotnet_diagnostic.IDE0067.severity = warning
@@ -470,4 +467,4 @@ dotnet_diagnostic.IDE0067.severity = warning
 dotnet_diagnostic.IDE0068.severity = warning
 
 #IDE0072: Add missing cases to switch expression
-dotnet_diagnostic.IDE0072.severity = warning
+dotnet_diagnostic.IDE0072.severity = none

src/log4net/Appender/AdoNetAppender.cs

@@ -450,6 +450,7 @@ public void AddParameter(AdoNetAppenderParameter parameter)
   /// </remarks>
   protected virtual void SendBuffer(IDbTransaction? dbTran, LoggingEvent[] events)
   {
+    events.EnsureNotNull();
     if (!string.IsNullOrWhiteSpace(CommandText))
     {
       using IDbCommand dbCmd = Connection.EnsureNotNull().CreateCommand();
@@ -522,7 +523,7 @@ protected virtual void Prepare(IDbCommand dbCmd)
       parameter.Prepare(dbCmd);
     }
 
-    dbCmd.Prepare();
+    dbCmd.EnsureNotNull().Prepare();
   }
 
   /// <summary>
@@ -883,7 +884,7 @@ public DbType DbType
   public virtual void Prepare(IDbCommand command)
   {
     // Create a new parameter
-    IDbDataParameter param = command.CreateParameter();
+    IDbDataParameter param = command.EnsureNotNull().CreateParameter();
 
     // Set the parameter properties
     param.ParameterName = ParameterName;
@@ -923,7 +924,8 @@ public virtual void Prepare(IDbCommand command)
   public virtual void FormatValue(IDbCommand command, LoggingEvent loggingEvent)
   {
     // Lookup the parameter
-    IDbDataParameter param = (IDbDataParameter)command.Parameters[ParameterName.EnsureNotNull()];
+    IDbDataParameter param = command.EnsureNotNull().Parameters[ParameterName.EnsureNotNull()]
+      .EnsureIs<IDbDataParameter>();
 
     // Format the value
     object? formattedValue = Layout?.Format(loggingEvent);

src/log4net/Appender/AnsiColorTerminalAppender.cs

@@ -242,7 +242,7 @@ public virtual string Target
   /// </remarks>
   protected override void Append(LoggingEvent loggingEvent)
   {
-    string loggingMessage = RenderLoggingEvent(loggingEvent);
+    string loggingMessage = RenderLoggingEvent(loggingEvent.EnsureNotNull());
 
     // see if there is a specified lookup.
     if (_levelMapping.Lookup(loggingEvent.Level) is LevelColors levelColors)

src/log4net/Appender/AppenderCollection.cs

@@ -409,17 +409,17 @@ public virtual int Capacity
   /// <summary>
   /// Adds the elements of another <see cref="AppenderCollection"/> to the current <see cref="AppenderCollection"/>.
   /// </summary>
-  /// <param name="x">The <see cref="AppenderCollection"/> whose elements should be added to the end of the current <see cref="AppenderCollection"/>.</param>
+  /// <param name="collection">The <see cref="AppenderCollection"/> whose elements should be added to the end of the current <see cref="AppenderCollection"/>.</param>
   /// <returns>The new <see cref="Count"/> of the <see cref="AppenderCollection"/>.</returns>
-  public virtual int AddRange(AppenderCollection x)
+  public virtual int AddRange(AppenderCollection collection)
   {
-    if (_count + x.Count >= _array.Length)
+    if (_count + collection.EnsureNotNull().Count >= _array.Length)
     {
-      EnsureCapacity(_count + x.Count);
+      EnsureCapacity(_count + collection.Count);
     }
 
-    Array.Copy(x._array, 0, _array, _count, x.Count);
-    _count += x.Count;
+    Array.Copy(collection._array, 0, _array, _count, collection.Count);
+    _count += collection.Count;
     _version++;
 
     return _count;
@@ -428,17 +428,17 @@ public virtual int AddRange(AppenderCollection x)
   /// <summary>
   /// Adds the elements of a <see cref="IAppender"/> array to the current <see cref="AppenderCollection"/>.
   /// </summary>
-  /// <param name="x">The <see cref="IAppender"/> array whose elements should be added to the end of the <see cref="AppenderCollection"/>.</param>
+  /// <param name="array">The <see cref="IAppender"/> array whose elements should be added to the end of the <see cref="AppenderCollection"/>.</param>
   /// <returns>The new <see cref="Count"/> of the <see cref="AppenderCollection"/>.</returns>
-  public virtual int AddRange(IAppender[] x)
+  public virtual int AddRange(IAppender[] array)
   {
-    if (_count + x.Length >= _array.Length)
+    if (_count + array.EnsureNotNull().Length >= _array.Length)
     {
-      EnsureCapacity(_count + x.Length);
+      EnsureCapacity(_count + array.Length);
     }
 
-    Array.Copy(x, 0, _array, _count, x.Length);
-    _count += x.Length;
+    Array.Copy(array, 0, _array, _count, array.Length);
+    _count += array.Length;
     _version++;
 
     return _count;
@@ -447,18 +447,18 @@ public virtual int AddRange(IAppender[] x)
   /// <summary>
   /// Adds the elements of a <see cref="IAppender"/> collection to the current <see cref="AppenderCollection"/>.
   /// </summary>
-  /// <param name="col">The <see cref="IAppender"/> collection whose elements should be added to the end of the <see cref="AppenderCollection"/>.</param>
+  /// <param name="collection">The <see cref="IAppender"/> collection whose elements should be added to the end of the <see cref="AppenderCollection"/>.</param>
   /// <returns>The new <see cref="Count"/> of the <see cref="AppenderCollection"/>.</returns>
-  public virtual int AddRange(ICollection col)
+  public virtual int AddRange(ICollection collection)
   {
-    if (_count + col.Count >= _array.Length)
+    if (_count + collection.EnsureNotNull().Count >= _array.Length)
     {
-      EnsureCapacity(_count + col.Count);
+      EnsureCapacity(_count + collection.Count);
     }
 
-    foreach (object item in col)
+    foreach (object item in collection)
     {
-      Add((IAppender)item);
+      Add(item.EnsureIs<IAppender>());
     }
 
     return _count;
@@ -475,7 +475,7 @@ public virtual int AddRange(ICollection col)
   /// <returns>the array</returns>
   public virtual IAppender[] ToArray()
   {
-    var resultArray = new IAppender[_count];
+    IAppender[] resultArray = new IAppender[_count];
     if (_count > 0)
     {
       Array.Copy(_array, 0, resultArray, 0, _count);

src/log4net/Appender/AppenderSkeleton.cs

@@ -332,11 +332,12 @@ public void DoAppend(LoggingEvent loggingEvent)
   /// </remarks>
   public void DoAppend(LoggingEvent[] loggingEvents)
   {
+    loggingEvents.EnsureNotNull();
+
     // This lock is absolutely critical for correct formatting
     // of the message in a multi-threaded environment.  Without
     // this, the message may be broken up into elements from
     // multiple thread contexts (like get the wrong thread ID).
-
     lock (LockObj)
     {
       if (_isClosed)
@@ -414,7 +415,7 @@ public void DoAppend(LoggingEvent[] loggingEvents)
   /// </remarks>
   protected virtual bool FilterEvent(LoggingEvent loggingEvent)
   {
-    if (!IsAsSevereAsThreshold(loggingEvent.Level))
+    if (!IsAsSevereAsThreshold(loggingEvent.EnsureNotNull().Level))
     {
       return false;
     }
@@ -553,7 +554,7 @@ protected virtual void OnClose()
   /// </remarks>
   protected virtual void Append(LoggingEvent[] loggingEvents)
   {
-    foreach (LoggingEvent loggingEvent in loggingEvents)
+    foreach (LoggingEvent loggingEvent in loggingEvents.EnsureNotNull())
     {
       Append(loggingEvent);
     }
@@ -575,7 +576,7 @@ protected virtual void Append(LoggingEvent[] loggingEvents)
   /// </remarks>
   protected virtual void Append(IEnumerable<LoggingEvent> loggingEvents)
   {
-    foreach (LoggingEvent loggingEvent in loggingEvents)
+    foreach (LoggingEvent loggingEvent in loggingEvents.EnsureNotNull())
     {
       Append(loggingEvent);
     }
@@ -674,14 +675,15 @@ protected string RenderLoggingEvent(LoggingEvent loggingEvent)
   /// </remarks>
   protected void RenderLoggingEvent(TextWriter writer, LoggingEvent loggingEvent)
   {
+    writer.EnsureNotNull();
     if (Layout is null)
     {
       throw new InvalidOperationException("A layout must be set");
     }
 
     if (Layout.IgnoresException)
     {
-      string? exceptionStr = loggingEvent.GetExceptionString();
+      string? exceptionStr = loggingEvent.EnsureNotNull().GetExceptionString();
       if (!string.IsNullOrEmpty(exceptionStr))
       {
         // render the event and the exception

src/log4net/Appender/BufferingAppenderSkeleton.cs

@@ -469,7 +469,7 @@ protected override void Append(LoggingEvent loggingEvent)
   /// </remarks>
   protected virtual void SendFromBuffer(LoggingEvent? firstLoggingEvent, CyclicBuffer buffer)
   {
-    LoggingEvent[] bufferEvents = buffer.PopAll();
+    LoggingEvent[] bufferEvents = buffer.EnsureNotNull().PopAll();
 
     if (firstLoggingEvent is null)
     {

src/log4net/Appender/ColoredConsoleAppender.cs

@@ -197,6 +197,7 @@ public virtual string Target
   [System.Security.Permissions.SecurityPermission(System.Security.Permissions.SecurityAction.Demand, UnmanagedCode = true)]
   protected override void Append(LoggingEvent loggingEvent)
   {
+    loggingEvent.EnsureNotNull();
     if (_consoleOutputWriter is not null)
     {
       IntPtr consoleHandle = GetStdHandle(_writeToErrorStream ? StdErrorHandle : StdOutputHandle);