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
@@ -30,11 +30,13 @@ public class CentralControlAuthInterceptorTests
/// <summary>An <see cref="ISitePskProvider"/> backed by a fixed site→key map; throws for unknown sites.</summary>
private sealed class MapPskProvider(IReadOnlyDictionary<string, string> keys) : ISitePskProvider
{
/// <inheritdoc />
public ValueTask<string> GetAsync(string siteId, CancellationToken ct)
=> keys.TryGetValue(siteId, out var key)
? new ValueTask<string>(key)
: throw new InvalidOperationException($"no key for '{siteId}'");
/// <inheritdoc />
public void Invalidate(string siteId) { }
}
@@ -58,22 +60,34 @@ public class CentralControlAuthInterceptorTests
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;
}
@@ -83,6 +97,9 @@ public class CentralControlAuthInterceptorTests
=> interceptor.UnaryServerHandler<string, string>(
"request", context, (_, _) => Task.FromResult("ok"));
/// <summary>Verifies that a verified site A cannot submit ownership of site B for the given kind of request.</summary>
/// <param name="kind">The kind.</param>
/// <returns>A task that represents the asynchronous operation.</returns>
[Theory]
[InlineData("notification")]
[InlineData("reconcile")]
@@ -128,6 +145,8 @@ public class CentralControlAuthInterceptorTests
Assert.False(continued); // no actor dispatch, token mint, or partial batch ingest
}
/// <summary>Verifies that a method outside the gated prefixes passes through.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task NonGatedMethod_PassesThrough()
{
@@ -139,6 +158,8 @@ public class CentralControlAuthInterceptorTests
Assert.Equal("ok", await Invoke(interceptor, context));
}
/// <summary>Verifies that a request with the correct site and key is accepted.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task CorrectSiteAndKey_IsAccepted()
{
@@ -148,6 +169,8 @@ public class CentralControlAuthInterceptorTests
Assert.Equal("ok", await Invoke(interceptor, context));
}
/// <summary>Verifies that a request with a missing site header is denied.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task MissingSiteHeader_IsDenied()
{
@@ -160,6 +183,8 @@ public class CentralControlAuthInterceptorTests
Assert.Equal(StatusCode.PermissionDenied, ex.StatusCode);
}
/// <summary>Verifies that a request with a blank site header is denied.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task BlankSiteHeader_IsDenied()
{
@@ -170,6 +195,8 @@ public class CentralControlAuthInterceptorTests
Assert.Equal(StatusCode.PermissionDenied, ex.StatusCode);
}
/// <summary>Verifies that a request from an unknown site is denied rather than passed through.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task UnknownSite_IsDenied_NotPassedThrough()
{
@@ -182,6 +209,8 @@ public class CentralControlAuthInterceptorTests
Assert.Equal(StatusCode.PermissionDenied, ex.StatusCode);
}
/// <summary>Verifies that a request with no bearer token is denied.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task NoBearerToken_IsDenied()
{
@@ -192,6 +221,8 @@ public class CentralControlAuthInterceptorTests
Assert.Equal(StatusCode.PermissionDenied, ex.StatusCode);
}
/// <summary>Verifies that a request with the wrong key for the site is denied.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task WrongKeyForTheSite_IsDenied()
{
@@ -204,6 +235,8 @@ public class CentralControlAuthInterceptorTests
Assert.Equal(StatusCode.PermissionDenied, ex.StatusCode);
}
/// <summary>Verifies that each site is verified against its own key.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task EachSiteIsVerifiedAgainstItsOwnKey()
{
@@ -215,6 +248,7 @@ public class CentralControlAuthInterceptorTests
Assert.Equal("ok", await Invoke(interceptor, context));
}
/// <summary>Verifies that the interceptor has exactly one public constructor.</summary>
[Fact]
public void TheInterceptorHasExactlyOnePublicConstructor()
{
@@ -229,6 +263,7 @@ public class CentralControlAuthInterceptorTests
Assert.Single(publicCtors);
}
/// <summary>Verifies that the default gated prefixes match the real central control service path.</summary>
[Fact]
public void DefaultGatedPrefixes_MatchTheRealCentralControlServicePath()
{