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 ZB.MOM.WW.ScadaBridge.AuditLog.Configuration;
namespace ZB.MOM.WW.ScadaBridge.AuditLog.Tests.Configuration;
/// <summary>
/// Task 1 of <c>docs/plans/2026-05-23-inbound-api-full-response-audit.md</c>:
/// Per <c>docs/plans/2026-05-23-inbound-api-full-response-audit.md</c>, this class
/// pins the <see cref="AuditLogOptions.InboundMaxBytes"/> default to 1 MiB and
/// the validator bounds to <c>[8 KiB, 16 MiB]</c>. The inbound channel needs a
/// much larger ceiling than the 8 KiB / 64 KiB default/error caps that other
@@ -14,6 +14,7 @@ namespace ZB.MOM.WW.ScadaBridge.AuditLog.Tests.Configuration;
/// </summary>
public class AuditLogOptionsValidatorTests
{
/// <summary>Verifies that the default options set the inbound maximum body size to one mebibyte.</summary>
[Fact]
public void Validate_InboundMaxBytes_DefaultOptions_IsOneMebibyte()
{
@@ -24,6 +25,8 @@ public class AuditLogOptionsValidatorTests
Assert.Equal(1_048_576, opts.InboundMaxBytes);
}
/// <summary>Verifies that an inbound maximum body size within the documented range passes validation.</summary>
/// <param name="value">The inbound maximum body size in bytes.</param>
[Theory]
[InlineData(8_192)] // documented min
[InlineData(1_048_576)] // default
@@ -35,6 +38,8 @@ public class AuditLogOptionsValidatorTests
Assert.True(validator.Validate(null, opts).Succeeded);
}
/// <summary>Verifies that an inbound maximum body size outside the documented range fails validation.</summary>
/// <param name="value">The inbound maximum body size in bytes.</param>
[Theory]
[InlineData(0)]
[InlineData(8_191)]
@@ -52,9 +57,10 @@ public class AuditLogOptionsValidatorTests
}
// ---------------------------------------------------------------------
// M5.5 (T3) per-channel retention overrides
// Per-channel retention overrides
// ---------------------------------------------------------------------
/// <summary>Verifies that a per-channel retention shorter than the global retention passes validation.</summary>
[Fact]
public void Validate_PerChannelRetention_ShorterThanGlobal_Passes()
{
@@ -75,6 +81,7 @@ public class AuditLogOptionsValidatorTests
Assert.True(validator.Validate(null, opts).Succeeded);
}
/// <summary>Verifies that a per-channel retention equal to the global retention passes validation.</summary>
[Fact]
public void Validate_PerChannelRetention_EqualToGlobal_Passes()
{
@@ -90,6 +97,7 @@ public class AuditLogOptionsValidatorTests
Assert.True(validator.Validate(null, opts).Succeeded);
}
/// <summary>Verifies that a per-channel retention longer than the global retention fails validation.</summary>
[Fact]
public void Validate_PerChannelRetention_LongerThanGlobal_Fails()
{
@@ -110,6 +118,7 @@ public class AuditLogOptionsValidatorTests
&& f.Contains("ApiInbound", StringComparison.Ordinal));
}
/// <summary>Verifies that a per-channel retention below the minimum fails validation.</summary>
[Fact]
public void Validate_PerChannelRetention_BelowMinimum_Fails()
{
@@ -127,6 +136,7 @@ public class AuditLogOptionsValidatorTests
f => f.Contains(nameof(AuditLogOptions.PerChannelRetentionDays), StringComparison.Ordinal));
}
/// <summary>Verifies that a per-channel retention keyed by an unknown channel fails validation.</summary>
[Fact]
public void Validate_PerChannelRetention_UnknownChannelKey_Fails()
{
@@ -146,6 +156,7 @@ public class AuditLogOptionsValidatorTests
f => f.Contains("NotAChannel", StringComparison.Ordinal));
}
/// <summary>Verifies that the default empty per-channel retention map passes validation.</summary>
[Fact]
public void Validate_PerChannelRetention_DefaultEmpty_Passes()
{