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
@@ -15,6 +15,7 @@ public class TransportOptionsValidatorTests
private static ValidateOptionsResult Validate(TransportOptions options) =>
new TransportOptionsValidator().Validate(Options.DefaultName, options);
/// <summary>Verifies that the default options are valid.</summary>
[Fact]
public void DefaultOptions_AreValid()
{
@@ -22,6 +23,7 @@ public class TransportOptionsValidatorTests
Assert.True(result.Succeeded, result.FailureMessage);
}
/// <summary>Verifies that a zero bundle session TTL is rejected.</summary>
[Fact]
public void ZeroBundleSessionTtlMinutes_IsRejected()
{
@@ -30,6 +32,7 @@ public class TransportOptionsValidatorTests
Assert.Contains("BundleSessionTtlMinutes", result.FailureMessage);
}
/// <summary>Verifies that a zero maximum bundle size is rejected.</summary>
[Fact]
public void ZeroMaxBundleSizeMb_IsRejected()
{
@@ -38,6 +41,7 @@ public class TransportOptionsValidatorTests
Assert.Contains("MaxBundleSizeMb", result.FailureMessage);
}
/// <summary>Verifies that a zero maximum of concurrent import sessions is rejected.</summary>
[Fact]
public void ZeroMaxConcurrentImportSessions_IsRejected()
{
@@ -46,6 +50,7 @@ public class TransportOptionsValidatorTests
Assert.Contains("MaxConcurrentImportSessions", result.FailureMessage); // FAILS today: validates clean
}
/// <summary>Verifies that a negative maximum of concurrent import sessions is rejected.</summary>
[Fact]
public void NegativeMaxConcurrentImportSessions_IsRejected()
{
@@ -54,6 +59,7 @@ public class TransportOptionsValidatorTests
Assert.Contains("MaxConcurrentImportSessions", result.FailureMessage);
}
/// <summary>Verifies that zero PBKDF2 iterations is rejected.</summary>
[Fact]
public void ZeroPbkdf2Iterations_IsRejected()
{
@@ -62,6 +68,7 @@ public class TransportOptionsValidatorTests
Assert.Contains("Pbkdf2Iterations", result.FailureMessage);
}
/// <summary>Verifies that a PBKDF2 iteration count below the security floor is rejected.</summary>
[Fact]
public void Pbkdf2Iterations_BelowSecurityFloor_IsRejected()
{
@@ -72,6 +79,7 @@ public class TransportOptionsValidatorTests
Assert.Contains("Pbkdf2Iterations", result.FailureMessage);
}
/// <summary>Verifies that a PBKDF2 iteration count at the security floor is valid.</summary>
[Fact]
public void Pbkdf2Iterations_AtSecurityFloor_IsValid()
{
@@ -79,6 +87,7 @@ public class TransportOptionsValidatorTests
Assert.True(result.Succeeded, result.FailureMessage);
}
/// <summary>Verifies that zero unlock attempts per session is rejected.</summary>
[Fact]
public void ZeroMaxUnlockAttemptsPerSession_IsRejected()
{
@@ -87,6 +96,7 @@ public class TransportOptionsValidatorTests
Assert.Contains("MaxUnlockAttemptsPerSession", result.FailureMessage);
}
/// <summary>Verifies that a zero maximum decompressed bundle entry size is rejected.</summary>
[Fact]
public void ZeroMaxBundleEntryDecompressedMb_IsRejected()
{
@@ -95,6 +105,7 @@ public class TransportOptionsValidatorTests
Assert.Contains("MaxBundleEntryDecompressedMb", result.FailureMessage);
}
/// <summary>Verifies that a zero maximum bundle entry count is rejected.</summary>
[Fact]
public void ZeroMaxBundleEntryCount_IsRejected()
{
@@ -103,6 +114,7 @@ public class TransportOptionsValidatorTests
Assert.Contains("MaxBundleEntryCount", result.FailureMessage);
}
/// <summary>Verifies that a zero maximum bundle entry compression ratio is rejected.</summary>
[Fact]
public void ZeroMaxBundleEntryCompressionRatio_IsRejected()
{
@@ -111,6 +123,7 @@ public class TransportOptionsValidatorTests
Assert.Contains("MaxBundleEntryCompressionRatio", result.FailureMessage);
}
/// <summary>Verifies that zero unlock attempts per IP per hour is rejected.</summary>
[Fact]
public void ZeroMaxUnlockAttemptsPerIpPerHour_IsRejected()
{
@@ -119,6 +132,7 @@ public class TransportOptionsValidatorTests
Assert.Contains("MaxUnlockAttemptsPerIpPerHour", result.FailureMessage);
}
/// <summary>Verifies that a zero major schema version is rejected.</summary>
[Fact]
public void ZeroSchemaVersionMajor_IsRejected()
{
@@ -127,6 +141,8 @@ public class TransportOptionsValidatorTests
Assert.Contains("SchemaVersionMajor", result.FailureMessage);
}
/// <summary>Verifies that a blank source environment is rejected.</summary>
/// <param name="value">The blank source environment value.</param>
[Theory]
[InlineData("")]
[InlineData(" ")]