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:
Joseph Doherty
2026-10-07 15:05:49 -04:00
parent 0ffd4bdbea
commit 513fa1aa16
998 changed files with 17896 additions and 2395 deletions
@@ -5,12 +5,13 @@ using ZB.MOM.WW.ScadaBridge.Commons.Types.Enums;
namespace ZB.MOM.WW.ScadaBridge.Commons.Tests.Debugging;
/// <summary>
/// Flow Debugger step-logs plan (2026-09-09) Task 1: the Commons log-line vocabulary —
/// Flow Debugger step-logs plan (2026-09-09): the Commons log-line vocabulary —
/// exception detail on a step (D3), and the <c>ScriptTrace.ScriptLog</c> row projecting
/// onto a <see cref="FlowLogLine"/> rather than a node (D1).
/// </summary>
public class FlowStepProjectorLogLineTests
{
/// <summary>Verifies that projecting an audit event carries its error detail onto the step.</summary>
[Fact]
public void Project_CarriesErrorDetail()
{
@@ -23,6 +24,7 @@ public class FlowStepProjectorLogLineTests
Assert.StartsWith("System.InvalidOperationException", step.ErrorDetail);
}
/// <summary>Verifies that the projected error detail is null when the audit event has none.</summary>
[Fact]
public void Project_ErrorDetail_IsNullWhenAbsent()
{
@@ -31,6 +33,7 @@ public class FlowStepProjectorLogLineTests
Assert.Null(FlowStepProjector.Project(evt).ErrorDetail);
}
/// <summary>Verifies that a script log row projects to the unknown kind and never to a step kind of its own.</summary>
[Fact]
public void ScriptLog_ProjectsToUnknownKind_NeverItsOwnStepKind()
{
@@ -40,6 +43,7 @@ public class FlowStepProjectorLogLineTests
Assert.False(Enum.GetNames<FlowStepKind>().Contains("ScriptLog"));
}
/// <summary>Verifies that a row is a log line only for the script trace channel with the script log kind.</summary>
[Fact]
public void IsLogLine_TrueOnlyForScriptTraceScriptLog()
{
@@ -50,6 +54,7 @@ public class FlowStepProjectorLogLineTests
Assert.False(FlowStepProjector.IsLogLine(run));
}
/// <summary>Verifies that rows on other channels are not log lines.</summary>
[Fact]
public void IsLogLine_FalseForOtherChannels()
{
@@ -58,6 +63,7 @@ public class FlowStepProjectorLogLineTests
Assert.False(FlowStepProjector.IsLogLine(outbound));
}
/// <summary>Verifies that converting a row to a log line reads its level, source and exception.</summary>
[Fact]
public void ToLogLine_ReadsLevelSourceAndException()
{
@@ -81,6 +87,7 @@ public class FlowStepProjectorLogLineTests
Assert.Equal(3, line.Seq);
}
/// <summary>Verifies that converting a row to a log line defaults the level and source when the extra payload is missing.</summary>
[Fact]
public void ToLogLine_DefaultsLevelAndSourceWhenExtraMissing()
{
@@ -97,6 +104,7 @@ public class FlowStepProjectorLogLineTests
Assert.Null(line.Seq);
}
/// <summary>Verifies that the log members of the script trace extra round-trip through JSON.</summary>
[Fact]
public void ScriptTraceExtra_LogMembers_RoundTripThroughJson()
{
@@ -111,6 +119,7 @@ public class FlowStepProjectorLogLineTests
Assert.Equal(12, parsed.Seq);
}
/// <summary>Verifies that a flow step's logs and error detail default to null.</summary>
[Fact]
public void FlowStep_LogsAndErrorDetail_DefaultToNull()
{
@@ -124,6 +133,7 @@ public class FlowStepProjectorLogLineTests
Assert.Single((step with { Logs = [line] }).Logs!);
}
/// <summary>Verifies that the log truncation members of a flow graph default to off.</summary>
[Fact]
public void FlowGraph_LogTruncationMembers_DefaultToOff()
{