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
@@ -12,14 +12,21 @@ public class InboundDatabaseHelperTests
private sealed class SqliteGateway : IDatabaseGateway
{
private readonly string _cs;
// InboundAPI-027 test seam: when false the open ignores the passed token, so a
// Test seam: When false the open ignores the passed token, so a
// pre-cancelled token surfaces at Execute/Read (not at open) — letting a test
// prove the EXECUTE path honours the deadline token, not just the open.
private readonly bool _honorTokenOnOpen;
/// <summary>
/// Initializes a new instance of the <c>SqliteGateway</c> class.
/// </summary>
/// <param name="cs">The cs.</param>
/// <param name="honorTokenOnOpen">The honor token on open.</param>
public SqliteGateway(string cs, bool honorTokenOnOpen = true)
{ _cs = cs; _honorTokenOnOpen = honorTokenOnOpen; }
/// <inheritdoc />
public async Task<DbConnection> GetConnectionAsync(string name, CancellationToken ct = default)
{ var c = new SqliteConnection(_cs); await c.OpenAsync(_honorTokenOnOpen ? ct : CancellationToken.None); return c; }
/// <inheritdoc />
public Task<ExternalCallResult> CachedWriteAsync(string c, string s,
IReadOnlyDictionary<string, object?>? p = null, string? o = null, CancellationToken ct = default,
TrackedOperationId? t = null, Guid? e = null, string? src = null, Guid? pe = null)
@@ -36,6 +43,8 @@ public class InboundDatabaseHelperTests
return new SqliteGateway("DataSource=file:movein?mode=memory&cache=shared", honorTokenOnOpen);
}
/// <summary>Verifies that query single async returns first column with bound parameter.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task QuerySingleAsync_returns_first_column_with_bound_parameter()
{
@@ -44,6 +53,8 @@ public class InboundDatabaseHelperTests
Assert.Equal("Z28061A", code);
}
/// <summary>Verifies that query single async returns default when no rows.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task QuerySingleAsync_returns_default_when_no_rows()
{
@@ -52,6 +63,8 @@ public class InboundDatabaseHelperTests
Assert.Null(code);
}
/// <summary>Verifies that query async returns row with case insensitive keys.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task QueryAsync_returns_row_with_case_insensitive_keys()
{
@@ -63,6 +76,8 @@ public class InboundDatabaseHelperTests
Assert.Equal("Z28061A", row["CODE"]);
}
/// <summary>Verifies that query async returns empty list when no rows match.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task QueryAsync_returns_empty_list_when_no_rows_match()
{
@@ -71,8 +86,10 @@ public class InboundDatabaseHelperTests
Assert.Empty(rows);
}
// --- InboundAPI-026: writes are permitted (design decision) ---
// --- Writes are permitted (design decision) ---
/// <summary>Verifies that execute async performs write and returns rows affected.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ExecuteAsync_performs_write_and_returns_rows_affected()
{
@@ -86,8 +103,10 @@ public class InboundDatabaseHelperTests
Assert.Equal("UPDATED", code);
}
// --- InboundAPI-026: SQL-injection protection — values are bound, not concatenated ---
// --- SQL-injection protection — values are bound, not concatenated ---
/// <summary>Verifies that parameter values are bound not concatenated.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ParameterValues_are_bound_not_concatenated()
{
@@ -101,8 +120,10 @@ public class InboundDatabaseHelperTests
Assert.Null(code);
}
// --- InboundAPI-028: negative paths ---
// --- Negative paths ---
/// <summary>Verifies that query single async null gateway throws.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task QuerySingleAsync_null_gateway_throws()
{
@@ -111,6 +132,8 @@ public class InboundDatabaseHelperTests
() => helper.QuerySingleAsync<string>("BTDB", "SELECT 1"));
}
/// <summary>Verifies that query async null gateway throws.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task QueryAsync_null_gateway_throws()
{
@@ -119,6 +142,8 @@ public class InboundDatabaseHelperTests
() => helper.QueryAsync("BTDB", "SELECT 1"));
}
/// <summary>Verifies that execute async null gateway throws.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ExecuteAsync_null_gateway_throws()
{
@@ -127,8 +152,10 @@ public class InboundDatabaseHelperTests
() => helper.ExecuteAsync("BTDB", "DELETE FROM Machine"));
}
// --- InboundAPI-027: the method-deadline token bounds the query on the EXECUTE path ---
// --- The method-deadline token bounds the query on the EXECUTE path ---
/// <summary>Verifies that query single async honours cancellation token on execute.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task QuerySingleAsync_honours_cancellation_token_on_execute()
{