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:
@@ -3,7 +3,7 @@ using ZB.MOM.WW.ScadaBridge.Commons.Entities.InboundApi;
|
||||
namespace ZB.MOM.WW.ScadaBridge.InboundAPI.Tests;
|
||||
|
||||
/// <summary>
|
||||
/// WP2.6b (arch-review misc — Inbound API per-request SQL): <see cref="ApiMethodCache"/>
|
||||
/// <see cref="ApiMethodCache"/>
|
||||
/// hit/miss/expiry/invalidation behavior, independent of the endpoint and subscriber wiring
|
||||
/// (covered separately by <see cref="ScriptArtifactChangeSubscriberTests"/>).
|
||||
/// </summary>
|
||||
@@ -11,6 +11,8 @@ public class ApiMethodCacheTests
|
||||
{
|
||||
private static ApiMethod Method(string name) => new(name, "return 1;") { Id = 1 };
|
||||
|
||||
/// <summary>Verifies that a second call within the TTL is served from the cache without refetching.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[Fact]
|
||||
public async Task GetOrFetchAsync_SecondCallWithinTtl_ServesFromCache_NoRefetch()
|
||||
{
|
||||
@@ -29,6 +31,8 @@ public class ApiMethodCacheTests
|
||||
Assert.Same(first, second);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a call after the TTL expires refetches the method.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[Fact]
|
||||
public async Task GetOrFetchAsync_AfterTtlExpiry_Refetches()
|
||||
{
|
||||
@@ -48,6 +52,8 @@ public class ApiMethodCacheTests
|
||||
Assert.Equal(2, fetchCount);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a negative result is cached until the TTL expires.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[Fact]
|
||||
public async Task GetOrFetchAsync_NegativeResult_IsCachedUntilTtlExpires()
|
||||
{
|
||||
@@ -67,6 +73,8 @@ public class ApiMethodCacheTests
|
||||
Assert.Equal(1, fetchCount);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that invalidating an entry makes the next call refetch it.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[Fact]
|
||||
public async Task Invalidate_DropsEntry_NextCallRefetches()
|
||||
{
|
||||
@@ -85,6 +93,7 @@ public class ApiMethodCacheTests
|
||||
Assert.Equal(2, fetchCount);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that invalidating an unknown method name does not throw.</summary>
|
||||
[Fact]
|
||||
public void Invalidate_UnknownName_DoesNotThrow()
|
||||
{
|
||||
@@ -92,6 +101,7 @@ public class ApiMethodCacheTests
|
||||
cache.Invalidate("never-cached");
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a non-positive TTL makes the constructor throw.</summary>
|
||||
[Fact]
|
||||
public void Constructor_NonPositiveTtl_Throws()
|
||||
{
|
||||
@@ -103,8 +113,13 @@ public class ApiMethodCacheTests
|
||||
private sealed class FakeTimeProvider : TimeProvider
|
||||
{
|
||||
private DateTimeOffset _now;
|
||||
/// <summary>Initializes the provider at the given start time.</summary>
|
||||
/// <param name="start">The initial UTC time.</param>
|
||||
public FakeTimeProvider(DateTimeOffset start) => _now = start;
|
||||
/// <summary>Advances the current time.</summary>
|
||||
/// <param name="by">The amount of time to advance.</param>
|
||||
public void Advance(TimeSpan by) => _now += by;
|
||||
/// <inheritdoc />
|
||||
public override DateTimeOffset GetUtcNow() => _now;
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user