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:
+6
-3
@@ -12,10 +12,10 @@ using ZB.MOM.WW.ScadaBridge.SiteRuntime.Tests.TestSupport;
|
||||
namespace ZB.MOM.WW.ScadaBridge.SiteRuntime.Tests.Actors;
|
||||
|
||||
/// <summary>
|
||||
/// WP3.1 test group 3 — a script's execution deadline is armed when the run is ENQUEUED, not
|
||||
/// A script's execution deadline is armed when the run is ENQUEUED, not
|
||||
/// when it is dequeued.
|
||||
///
|
||||
/// <para>Before WP3.1 the deadline <see cref="CancellationTokenSource"/> was constructed inside
|
||||
/// <para>Previously the deadline <see cref="CancellationTokenSource"/> was constructed inside
|
||||
/// the queued body, so a run that spent ten minutes waiting behind blocked scripts still got a
|
||||
/// fresh full 30 s budget when it finally started — and then ran work whose triggering
|
||||
/// condition was long stale. Now queue wait consumes the run's own budget, and a body that
|
||||
@@ -26,6 +26,7 @@ public class ScriptDeadlineAtEnqueueTests : TestKit, IDisposable
|
||||
{
|
||||
private readonly SharedScriptLibrary _sharedLibrary;
|
||||
|
||||
/// <summary>Initializes the test with an isolated script execution scheduler.</summary>
|
||||
public ScriptDeadlineAtEnqueueTests()
|
||||
{
|
||||
var compilationService = new ScriptCompilationService(
|
||||
@@ -36,6 +37,7 @@ public class ScriptDeadlineAtEnqueueTests : TestKit, IDisposable
|
||||
DeadlineHooks.SecondScriptRan = false;
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
void IDisposable.Dispose()
|
||||
{
|
||||
DeadlineHooks.Gate.Release(8);
|
||||
@@ -64,6 +66,7 @@ public class ScriptDeadlineAtEnqueueTests : TestKit, IDisposable
|
||||
NullLogger<ScriptActor>.Instance, null, null, null, serviceProvider, scheduler, null)));
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a run that dequeues past its deadline is shed without executing its body.</summary>
|
||||
[Fact]
|
||||
public void ARunThatDequeuesPastItsDeadline_IsShedWithoutExecutingItsBody()
|
||||
{
|
||||
@@ -86,7 +89,7 @@ public class ScriptDeadlineAtEnqueueTests : TestKit, IDisposable
|
||||
{
|
||||
ScriptExecutionTimeoutSeconds = 1,
|
||||
StuckScriptGraceMs = 1000,
|
||||
// WP3.2 defaults per-run Started/Completed events OFF, which would make the
|
||||
// The defaults leave per-run Started/Completed events OFF, which would make the
|
||||
// "no started event" assertion below vacuously true whether the body ran or not.
|
||||
// Opt back in so that assertion actually discriminates: a body that reached the
|
||||
// run loop WOULD emit "started" here, and its absence is therefore evidence.
|
||||
|
||||
Reference in New Issue
Block a user