docs(tests): fix CommentChecker findings across tests/ — 13,392 → 0 (repo-wide scan clean)

Comment/XML-doc changes only:
- add summaries to ~10k test methods, fixtures, fakes and helpers
  (+ <param> on theories, <returns> on async Task methods,
  <inheritdoc/> on interface implementations the checker can resolve)
- strip ~2.6k project-tracking references (WP*, P*-*, row-NN, Task N,
  #NN, Component-0NN) from comments, keeping the explanatory text;
  reword false positives in comments only
- real docs on fakes implementing BCL/library interfaces
  (IDisposable, ILogger, IOptionsMonitor, IAsyncLifetime)
- reword the last 5 src/ false positives (CWE-1236, failures-1,
  year-0001, M365)

Only non-comment edits: four one-line nested classes split across lines
so members can carry docs. Build 0 errors / 0 warnings.
This commit is contained in:
Joseph Doherty
2026-10-07 15:05:49 -04:00
parent 0ffd4bdbea
commit 513fa1aa16
998 changed files with 17896 additions and 2395 deletions
@@ -3,7 +3,7 @@ using System.Data.Common;
namespace ZB.MOM.WW.ScadaBridge.ExternalSystemGateway.Tests;
/// <summary>
/// M2.3 (#7): unit tests for the transient-vs-permanent SQL error-number
/// Unit tests for the transient-vs-permanent SQL error-number
/// classifier that <c>DatabaseGateway</c> uses to decide whether a failed
/// cached write should be buffered (transient) or returned to the script
/// synchronously / parked (permanent).
@@ -13,6 +13,8 @@ public class SqlErrorClassifierTests
// The full transient set documented on SqlErrorClassifier — connection,
// timeout, deadlock, and Azure throttle error numbers. A retry can plausibly
// succeed for any of these, so they are buffered to store-and-forward.
/// <summary>Verifies that a known transient error number is classified as transient.</summary>
/// <param name="errorNumber">The SQL error number.</param>
[Theory]
[InlineData(-2)] // timeout expired
[InlineData(-1)] // connection error
@@ -37,6 +39,8 @@ public class SqlErrorClassifierTests
// Constraint, syntax, and permission errors are permanent — retrying the
// identical statement cannot succeed and may cause duplicate side effects.
/// <summary>Verifies that a known permanent error number is not classified as transient.</summary>
/// <param name="errorNumber">The SQL error number.</param>
[Theory]
[InlineData(547)] // constraint violation (FK/CHECK)
[InlineData(2627)] // primary-key / unique constraint violation
@@ -53,6 +57,8 @@ public class SqlErrorClassifierTests
Assert.False(SqlErrorClassifier.IsTransient(errorNumber));
}
/// <summary>Verifies that an unknown error number defaults to permanent.</summary>
/// <param name="errorNumber">The SQL error number.</param>
[Theory]
[InlineData(0)] // no error number captured
[InlineData(99999)] // unknown / undocumented number
@@ -65,11 +71,13 @@ public class SqlErrorClassifierTests
Assert.False(SqlErrorClassifier.IsTransient(errorNumber));
}
// ── M2.3 (#7) code-review fix: IsTransient(Exception) — a live DB outage does
// ── IsTransient(Exception) — a live DB outage does
// not always surface as a SqlException. Transport/connection/timeout/driver
// exception types are transient (buffer+retry), mirroring the HTTP path's
// ErrorClassifier.IsTransient(Exception). ──
/// <summary>Provides exception instances of the transport types that count as transient.</summary>
/// <returns>Theory data with one exception instance per row.</returns>
public static IEnumerable<object[]> TransientExceptionTypes()
{
yield return new object[] { new InvalidOperationException("connection not open") };
@@ -81,6 +89,8 @@ public class SqlErrorClassifierTests
yield return new object[] { new NonSqlDbException("provider transport error") };
}
/// <summary>Verifies that transport exception types are classified as transient.</summary>
/// <param name="ex">The exception to classify.</param>
[Theory]
[MemberData(nameof(TransientExceptionTypes))]
public void IsTransient_Exception_TrueForTransportTypes(Exception ex)
@@ -88,6 +98,7 @@ public class SqlErrorClassifierTests
Assert.True(SqlErrorClassifier.IsTransient(ex));
}
/// <summary>Verifies that an unexpected exception type is not classified as transient.</summary>
[Fact]
public void IsTransient_Exception_FalseForUnexpectedType()
{
@@ -100,6 +111,8 @@ public class SqlErrorClassifierTests
/// <summary>A concrete <see cref="DbException"/> that is not a SqlException, for the classifier unit test.</summary>
private sealed class NonSqlDbException : DbException
{
/// <summary>Initializes a database exception that is not a SQL exception.</summary>
/// <param name="message">The exception message.</param>
public NonSqlDbException(string message) : base(message) { }
}
}