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
@@ -13,6 +13,8 @@ namespace ZB.MOM.WW.ScadaBridge.Host.Tests;
/// <summary>Every actually mapped generated gRPC method must have an authentication gate.</summary>
public class MappedGrpcAuthenticationCoverageTests
{
/// <summary>Verifies every mapped grpc service is covered including external mappings.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task EveryMappedGrpcService_IsCoveredIncludingExternalMappings()
{
@@ -51,7 +53,7 @@ public class MappedGrpcAuthenticationCoverageTests
Assert.True(serviceTypes.Count >= typeNames.Count + 1, "The external LocalDb mapping must also be exercised.");
// The secrets hub — which used to install an all-method interceptor on its own service
// options and so needed a separate gate check here — is retired (Task 11): there is no
// options and so needed a separate gate check here — is retired: there is no
// longer a mapped gRPC service whose only gate is anything other than one of these prefixes.
var prefixes = ControlPlaneAuthInterceptor.DefaultGatedPrefixes
.Concat(CentralControlAuthInterceptor.DefaultGatedPrefixes)
@@ -89,13 +91,18 @@ public class MappedGrpcAuthenticationCoverageTests
private sealed class MethodCollector : ServiceBinderBase
{
/// <summary>Gets the full names of the gRPC methods registered with the fake binder.</summary>
public List<string> Methods { get; } = [];
/// <inheritdoc />
public override void AddMethod<TRequest, TResponse>(Method<TRequest, TResponse> method, UnaryServerMethod<TRequest, TResponse>? handler)
=> Methods.Add(method.FullName);
/// <inheritdoc />
public override void AddMethod<TRequest, TResponse>(Method<TRequest, TResponse> method, ClientStreamingServerMethod<TRequest, TResponse>? handler)
=> Methods.Add(method.FullName);
/// <inheritdoc />
public override void AddMethod<TRequest, TResponse>(Method<TRequest, TResponse> method, ServerStreamingServerMethod<TRequest, TResponse>? handler)
=> Methods.Add(method.FullName);
/// <inheritdoc />
public override void AddMethod<TRequest, TResponse>(Method<TRequest, TResponse> method, DuplexStreamingServerMethod<TRequest, TResponse>? handler)
=> Methods.Add(method.FullName);
}