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
@@ -7,7 +7,7 @@ using ZB.MOM.WW.ScadaBridge.Host;
namespace ZB.MOM.WW.ScadaBridge.Host.Tests;
/// <summary>
/// LocalDb Phase 1 (Task 8) — the passive sync endpoint's inbound gate.
/// LocalDb Phase 1 — the passive sync endpoint's inbound gate.
/// </summary>
/// <remarks>
/// The replication library's <c>LocalDbSyncService</c> verifies nothing; inbound auth is
@@ -47,22 +47,34 @@ public class LocalDbSyncAuthInterceptorTests
private sealed class FakeServerCallContext(string method, Metadata requestHeaders)
: ServerCallContext
{
/// <inheritdoc />
protected override string MethodCore => method;
/// <inheritdoc />
protected override string HostCore => "localhost";
/// <inheritdoc />
protected override string PeerCore => "ipv4:127.0.0.1:12345";
/// <inheritdoc />
protected override DateTime DeadlineCore => DateTime.UtcNow.AddMinutes(1);
/// <inheritdoc />
protected override Metadata RequestHeadersCore => requestHeaders;
/// <inheritdoc />
protected override CancellationToken CancellationTokenCore => CancellationToken.None;
/// <inheritdoc />
protected override Metadata ResponseTrailersCore { get; } = [];
/// <inheritdoc />
protected override Status StatusCore { get; set; }
/// <inheritdoc />
protected override WriteOptions? WriteOptionsCore { get; set; }
/// <inheritdoc />
protected override AuthContext AuthContextCore { get; } =
new(null, new Dictionary<string, List<AuthProperty>>());
/// <inheritdoc />
protected override ContextPropagationToken CreatePropagationTokenCore(
ContextPropagationOptions? options)
=> throw new NotSupportedException();
/// <inheritdoc />
protected override Task WriteResponseHeadersAsyncCore(Metadata responseHeaders)
=> Task.CompletedTask;
}
@@ -73,6 +85,8 @@ public class LocalDbSyncAuthInterceptorTests
=> interceptor.UnaryServerHandler<string, string>(
"request", context, (_, _) => Task.FromResult("ok"));
/// <summary>Verifies that a non-sync method passes through even when no key is configured.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task NonSyncMethod_PassesThrough_EvenWithNoKeyConfigured()
{
@@ -85,6 +99,8 @@ public class LocalDbSyncAuthInterceptorTests
Assert.Equal("ok", await Invoke(interceptor, context));
}
/// <summary>Verifies that a sync method is denied when no key is configured, even with a bearer token.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task SyncMethod_WithNoKeyConfigured_IsDenied_EvenWithABearerToken()
{
@@ -98,6 +114,8 @@ public class LocalDbSyncAuthInterceptorTests
Assert.Equal(StatusCode.PermissionDenied, ex.StatusCode);
}
/// <summary>Verifies that a sync method without a bearer token is denied.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task SyncMethod_WithNoBearerToken_IsDenied()
{
@@ -108,6 +126,8 @@ public class LocalDbSyncAuthInterceptorTests
Assert.Equal(StatusCode.PermissionDenied, ex.StatusCode);
}
/// <summary>Verifies that a sync method with the wrong bearer token is denied.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task SyncMethod_WithWrongBearerToken_IsDenied()
{
@@ -118,6 +138,8 @@ public class LocalDbSyncAuthInterceptorTests
Assert.Equal(StatusCode.PermissionDenied, ex.StatusCode);
}
/// <summary>Verifies that a sync method with the correct bearer token passes through.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task SyncMethod_WithCorrectBearerToken_PassesThrough()
{
@@ -127,6 +149,8 @@ public class LocalDbSyncAuthInterceptorTests
Assert.Equal("ok", await Invoke(interceptor, context));
}
/// <summary>Verifies that a sync method with the correct key but no Bearer scheme is denied.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task SyncMethod_WithCorrectKey_ButNoBearerScheme_IsDenied()
{
@@ -139,6 +163,8 @@ public class LocalDbSyncAuthInterceptorTests
Assert.Equal(StatusCode.PermissionDenied, ex.StatusCode);
}
/// <summary>Verifies that the token comparison is not a prefix match.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task SyncMethod_TokenComparison_IsNotAPrefixMatch()
{
@@ -151,6 +177,8 @@ public class LocalDbSyncAuthInterceptorTests
Assert.Equal(StatusCode.PermissionDenied, ex.StatusCode);
}
/// <summary>Verifies that duplex streaming calls are gated, because that is how sync actually runs.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task DuplexStreaming_IsGated_BecauseThatIsHowSyncActuallyRuns()
{