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:
@@ -70,6 +70,8 @@ public abstract class LocalDbSitePairHarness : IAsyncLifetime
|
||||
/// <summary>Node B — the passive node, which listens.</summary>
|
||||
protected ILocalDb B => _dbProviderB.GetRequiredService<ILocalDb>();
|
||||
|
||||
/// <summary>Prepares the test class before the tests run.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
public async Task InitializeAsync()
|
||||
{
|
||||
_dbProviderA = BuildDatabaseProvider(_pathA, "node-a");
|
||||
@@ -83,6 +85,8 @@ public abstract class LocalDbSitePairHarness : IAsyncLifetime
|
||||
await StartInitiatorAsync();
|
||||
}
|
||||
|
||||
/// <summary>Releases the resources held by this test class asynchronously.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
public async Task DisposeAsync()
|
||||
{
|
||||
await StopHostAsync(_initiatorHost);
|
||||
@@ -179,6 +183,7 @@ public abstract class LocalDbSitePairHarness : IAsyncLifetime
|
||||
}
|
||||
|
||||
/// <summary>Starts node B, the passive listener.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
protected async Task StartPassiveAsync()
|
||||
{
|
||||
var config = ReplicationConfig(peerAddress: null);
|
||||
@@ -208,6 +213,7 @@ public abstract class LocalDbSitePairHarness : IAsyncLifetime
|
||||
}
|
||||
|
||||
/// <summary>Starts node A, which dials the passive node.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
protected async Task StartInitiatorAsync()
|
||||
{
|
||||
var config = ReplicationConfig(PassiveAddress());
|
||||
@@ -223,6 +229,7 @@ public abstract class LocalDbSitePairHarness : IAsyncLifetime
|
||||
}
|
||||
|
||||
/// <summary>Takes node B's listener down, leaving its database intact and writable.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
protected async Task StopPassiveAsync()
|
||||
{
|
||||
await StopHostAsync(_serverHost);
|
||||
@@ -233,6 +240,7 @@ public abstract class LocalDbSitePairHarness : IAsyncLifetime
|
||||
/// Brings node B back on a NEW loopback port and re-dials from A. The initiator's channel
|
||||
/// factory re-reads the peer address on each reconnect, so this is a genuine rejoin.
|
||||
/// </summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
protected async Task RestartPairAsync()
|
||||
{
|
||||
await StartPassiveAsync();
|
||||
@@ -252,6 +260,9 @@ public abstract class LocalDbSitePairHarness : IAsyncLifetime
|
||||
}
|
||||
|
||||
/// <summary>Polls <paramref name="condition"/> until true or the deadline passes.</summary>
|
||||
/// <param name="condition">The asynchronous condition to poll.</param>
|
||||
/// <param name="because">The failure message used if the condition never becomes true.</param>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
protected static async Task WaitUntilAsync(Func<Task<bool>> condition, string because)
|
||||
{
|
||||
var deadline = DateTime.UtcNow + ConvergeTimeout;
|
||||
|
||||
Reference in New Issue
Block a user