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
@@ -6,8 +6,8 @@ using ZB.MOM.WW.ScadaBridge.AuditLog.Configuration;
namespace ZB.MOM.WW.ScadaBridge.AuditLog.Tests.Configuration;
/// <summary>
/// Task 9 (Bundle E): <see cref="AuditLogOptions"/> binding + validator
/// behavior. The validator enforces invariants used by M2+ writers
/// Tests for <see cref="AuditLogOptions"/> binding and validator
/// behavior. The validator enforces invariants used by the audit writers
/// (per <c>docs/plans/2026-05-20-auditlog-m1-foundation.md</c>):
/// <c>DefaultCapBytes &gt; 0</c>, <c>ErrorCapBytes &gt;= DefaultCapBytes</c>,
/// <c>RetentionDays in [30, 3650]</c>. Header-redact defaults match the
@@ -25,6 +25,7 @@ public class AuditLogOptionsTests
return services.BuildServiceProvider().GetRequiredService<IOptions<AuditLogOptions>>();
}
/// <summary>Verifies that a fully populated configuration section binds every scalar field onto the options.</summary>
[Fact]
public void ValidBinding_PopulatesAllScalarFields()
{
@@ -40,6 +41,7 @@ public class AuditLogOptionsTests
Assert.Equal(180, opts.RetentionDays);
}
/// <summary>Verifies that an empty configuration section yields reasonable default option values.</summary>
[Fact]
public void DefaultsAreReasonable_WhenSectionEmpty()
{
@@ -56,6 +58,7 @@ public class AuditLogOptionsTests
Assert.Empty(opts.PerTargetOverrides);
}
/// <summary>Verifies that header redaction entries bound from configuration are appended to the default list.</summary>
[Fact]
public void HeaderRedactList_BindsFromConfig_AppendsToDefaults()
{
@@ -77,6 +80,7 @@ public class AuditLogOptionsTests
Assert.Contains("X-Api-Key", opts.HeaderRedactList);
}
/// <summary>Verifies that per-target override settings bind from configuration.</summary>
[Fact]
public void PerTargetOverrides_BindsFromConfig()
{
@@ -93,6 +97,7 @@ public class AuditLogOptionsTests
Assert.Contains(@"\d{16}", crm.AdditionalBodyRedactors!);
}
/// <summary>Verifies that an invalid default payload cap fails validation.</summary>
[Fact]
public void InvalidDefaultCapBytes_FailsValidation()
{
@@ -104,6 +109,7 @@ public class AuditLogOptionsTests
Assert.Contains("DefaultCapBytes", result.FailureMessage);
}
/// <summary>Verifies that an invalid error payload cap fails validation.</summary>
[Fact]
public void InvalidErrorCapBytes_FailsValidation()
{
@@ -115,6 +121,7 @@ public class AuditLogOptionsTests
Assert.Contains("ErrorCapBytes", result.FailureMessage);
}
/// <summary>Verifies that a retention period below the minimum fails validation.</summary>
[Fact]
public void RetentionDaysBelowMinimum_FailsValidation()
{
@@ -126,6 +133,7 @@ public class AuditLogOptionsTests
Assert.Contains("RetentionDays", result.FailureMessage);
}
/// <summary>Verifies that a retention period above the maximum fails validation.</summary>
[Fact]
public void RetentionDaysAboveMaximum_FailsValidation()
{
@@ -137,6 +145,7 @@ public class AuditLogOptionsTests
Assert.Contains("RetentionDays", result.FailureMessage);
}
/// <summary>Verifies that the default options pass validation.</summary>
[Fact]
public void DefaultOptions_PassValidation()
{
@@ -147,6 +156,7 @@ public class AuditLogOptionsTests
Assert.True(result.Succeeded, result.FailureMessage);
}
/// <summary>Verifies that an invalid retention value bound from configuration is rejected when the options value is accessed.</summary>
[Fact]
public void InvalidRetention_BoundViaConfig_RejectedOnValueAccess()
{