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:
@@ -4,7 +4,7 @@ using ZB.MOM.WW.ScadaBridge.CLI.Commands;
|
||||
namespace ZB.MOM.WW.ScadaBridge.CLI.Tests.Commands;
|
||||
|
||||
/// <summary>
|
||||
/// PLAN-06 Task 11: <c>external-system create</c> and <c>external-system update</c>
|
||||
/// <c>external-system create</c> and <c>external-system update</c>
|
||||
/// must expose an optional <c>--timeout-seconds</c> (<see cref="int"/>?) flag that
|
||||
/// carries the per-system ESG HTTP timeout. Omitting it preserves the existing value
|
||||
/// (update) / uses the gateway default (create).
|
||||
@@ -21,6 +21,7 @@ public class ExternalSystemTimeoutOptionTests
|
||||
private static Option? FindOption(Command command, string name)
|
||||
=> command.Options.SingleOrDefault(o => o.Name == name);
|
||||
|
||||
/// <summary>Verifies that the create command exposes an optional timeout-seconds option.</summary>
|
||||
[Fact]
|
||||
public void Create_HasOptionalTimeoutSecondsOption()
|
||||
{
|
||||
@@ -30,6 +31,7 @@ public class ExternalSystemTimeoutOptionTests
|
||||
Assert.False(option!.Required);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that the update command exposes an optional timeout-seconds option.</summary>
|
||||
[Fact]
|
||||
public void Update_HasOptionalTimeoutSecondsOption()
|
||||
{
|
||||
@@ -39,6 +41,7 @@ public class ExternalSystemTimeoutOptionTests
|
||||
Assert.False(option!.Required);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that the create command parses a supplied timeout-seconds value.</summary>
|
||||
[Fact]
|
||||
public void Create_ParsesTimeoutSecondsValue()
|
||||
{
|
||||
@@ -52,6 +55,7 @@ public class ExternalSystemTimeoutOptionTests
|
||||
Assert.Equal(15, parse.GetValue<int?>("--timeout-seconds"));
|
||||
}
|
||||
|
||||
/// <summary>Verifies that the update command parses a supplied timeout-seconds value.</summary>
|
||||
[Fact]
|
||||
public void Update_ParsesTimeoutSecondsValue()
|
||||
{
|
||||
@@ -65,6 +69,7 @@ public class ExternalSystemTimeoutOptionTests
|
||||
Assert.Equal(20, parse.GetValue<int?>("--timeout-seconds"));
|
||||
}
|
||||
|
||||
/// <summary>Verifies that omitting timeout-seconds on create parses without error.</summary>
|
||||
[Fact]
|
||||
public void Create_OmittedTimeoutSeconds_ParsesWithoutError()
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user