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:
+11
-1
@@ -5,7 +5,7 @@ using ZB.MOM.WW.ScadaBridge.Commons.Types;
|
||||
namespace ZB.MOM.WW.ScadaBridge.CentralUI.Tests.ScriptAnalysis;
|
||||
|
||||
/// <summary>
|
||||
/// Deferred-work #14 (full fidelity): the Test-Run sandbox routes value-equality
|
||||
/// Full-fidelity wait support: the Test-Run sandbox routes value-equality
|
||||
/// <c>WaitAsync</c>/<c>WaitForAsync</c> to the bound instance via
|
||||
/// <see cref="ISandboxInstanceGateway"/>; predicate overloads and unbound runs still
|
||||
/// throw a clearly-labelled <see cref="ScriptSandboxException"/>.
|
||||
@@ -15,6 +15,8 @@ public class SandboxWaitForAttributeTests
|
||||
private static SandboxAttributeAccessor BoundAccessor(ISandboxInstanceGateway gateway) =>
|
||||
new(new SandboxInstanceContext(gateway), prefix: string.Empty);
|
||||
|
||||
/// <summary>Verifies that wait async, value form, routes through gateway, and returns matched.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[Fact]
|
||||
public async Task WaitAsync_ValueForm_RoutesThroughGateway_AndReturnsMatched()
|
||||
{
|
||||
@@ -31,6 +33,8 @@ public class SandboxWaitForAttributeTests
|
||||
"Flag", AttributeValueCodec.Encode(true), TimeSpan.FromSeconds(5), false, Arg.Any<CancellationToken>());
|
||||
}
|
||||
|
||||
/// <summary>Verifies that wait for async, value form, passes require good quality, and returns full result.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[Fact]
|
||||
public async Task WaitForAsync_ValueForm_PassesRequireGoodQuality_AndReturnsFullResult()
|
||||
{
|
||||
@@ -48,6 +52,8 @@ public class SandboxWaitForAttributeTests
|
||||
"Done", AttributeValueCodec.Encode(7), TimeSpan.FromSeconds(3), true, Arg.Any<CancellationToken>());
|
||||
}
|
||||
|
||||
/// <summary>Verifies that wait async, predicate form, throws.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[Fact]
|
||||
public async Task WaitAsync_PredicateForm_Throws()
|
||||
{
|
||||
@@ -58,6 +64,8 @@ public class SandboxWaitForAttributeTests
|
||||
Assert.Contains("predicate", ex.Message, StringComparison.OrdinalIgnoreCase);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that wait for async, predicate form, throws.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[Fact]
|
||||
public async Task WaitForAsync_PredicateForm_Throws()
|
||||
{
|
||||
@@ -67,6 +75,8 @@ public class SandboxWaitForAttributeTests
|
||||
() => accessor.WaitForAsync("Done", v => v != null, TimeSpan.FromSeconds(1)));
|
||||
}
|
||||
|
||||
/// <summary>Verifies that wait async, value form, unbound instance, throws.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[Fact]
|
||||
public async Task WaitAsync_ValueForm_UnboundInstance_Throws()
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user