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
@@ -7,7 +7,7 @@ using ZB.MOM.WW.ScadaBridge.SiteRuntime.Scripts;
|
||||
namespace ZB.MOM.WW.ScadaBridge.SiteRuntime.Tests.Scripts;
|
||||
|
||||
/// <summary>
|
||||
/// M2.12 (#25): recursion-limit violations at <c>CallScript</c> and
|
||||
/// Recursion-limit violations at <c>CallScript</c> and
|
||||
/// <c>CallShared</c> must emit a <c>script</c> Error site event via
|
||||
/// <see cref="ISiteEventLogger"/> in addition to the existing
|
||||
/// <c>ILogger.LogError</c> + throw.
|
||||
@@ -46,6 +46,8 @@ public class RecursionLimitSiteEventTests
|
||||
// CallScript
|
||||
// -------------------------------------------------------------------------
|
||||
|
||||
/// <summary>Verifies that exceeding the CallScript recursion limit emits a script error site event.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[Fact]
|
||||
public async Task CallScript_RecursionLimitExceeded_EmitsScriptErrorSiteEvent()
|
||||
{
|
||||
@@ -76,6 +78,8 @@ public class RecursionLimitSiteEventTests
|
||||
Times.Once);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that exceeding the CallScript recursion limit with no site event logger configured does not throw.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[Fact]
|
||||
public async Task CallScript_RecursionLimitExceeded_NullLogger_DoesNotThrow()
|
||||
{
|
||||
@@ -93,6 +97,8 @@ public class RecursionLimitSiteEventTests
|
||||
// CallShared (via Scripts.CallShared)
|
||||
// -------------------------------------------------------------------------
|
||||
|
||||
/// <summary>Verifies that exceeding the CallShared recursion limit emits a script error site event.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[Fact]
|
||||
public async Task CallShared_RecursionLimitExceeded_EmitsScriptErrorSiteEvent()
|
||||
{
|
||||
@@ -121,6 +127,8 @@ public class RecursionLimitSiteEventTests
|
||||
Times.Once);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that exceeding the CallShared recursion limit with no site event logger configured does not throw.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[Fact]
|
||||
public async Task CallShared_RecursionLimitExceeded_NullLogger_DoesNotThrow()
|
||||
{
|
||||
@@ -136,6 +144,8 @@ public class RecursionLimitSiteEventTests
|
||||
// Verify the event shape precisely (category, severity, message content)
|
||||
// -------------------------------------------------------------------------
|
||||
|
||||
/// <summary>Verifies that the recursion-limit site event has the correct category and severity.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[Fact]
|
||||
public async Task CallScript_RecursionLimitExceeded_EventHasCorrectCategoryAndSeverity()
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user