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
@@ -4,7 +4,7 @@ using ZB.MOM.WW.ScadaBridge.TemplateEngine.Validation;
namespace ZB.MOM.WW.ScadaBridge.TemplateEngine.Tests.Validation;
/// <summary>
/// M9-T32b deploy-time validation: a dangling <c>{"$ref":"lib:Name"}</c> in any
/// Deploy-time validation: a dangling <c>{"$ref":"lib:Name"}</c> in any
/// validated script parameter/return schema must BLOCK deployment (a
/// <see cref="ValidationCategory.SchemaReference"/> error naming the missing ref).
/// A valid ref resolved through the supplied seam passes. The check is inert for
@@ -15,6 +15,7 @@ public class SchemaRefValidationTests
{
private readonly ValidationService _sut = new();
/// <summary>Verifies that a dangling reference in the parameter definitions blocks deployment.</summary>
[Fact]
public void Validate_DanglingRefInParameterDefinitions_BlocksDeploy()
{
@@ -40,6 +41,7 @@ public class SchemaRefValidationTests
Assert.Contains("MissingLib", error.Message, StringComparison.Ordinal);
}
/// <summary>Verifies that a dangling reference in the return definition blocks deployment.</summary>
[Fact]
public void Validate_DanglingRefInReturnDefinition_BlocksDeploy()
{
@@ -65,6 +67,7 @@ public class SchemaRefValidationTests
&& e.Message.Contains("GoneReturn", StringComparison.Ordinal));
}
/// <summary>Verifies that a valid schema reference passes validation.</summary>
[Fact]
public void Validate_ValidRef_Passes()
{
@@ -91,6 +94,7 @@ public class SchemaRefValidationTests
Assert.DoesNotContain(result.Errors, e => e.Category == ValidationCategory.SchemaReference);
}
/// <summary>Verifies that a schema without references produces no schema reference error.</summary>
[Fact]
public void Validate_NoRefSchema_NoSchemaReferenceError()
{
@@ -114,6 +118,7 @@ public class SchemaRefValidationTests
Assert.DoesNotContain(result.Errors, e => e.Category == ValidationCategory.SchemaReference);
}
/// <summary>Verifies that validating without a schema resolver causes no regression.</summary>
[Fact]
public void Validate_NoResolverSupplied_NoRegression()
{
@@ -140,6 +145,7 @@ public class SchemaRefValidationTests
Assert.DoesNotContain(result.Errors, e => e.Category == ValidationCategory.SchemaReference);
}
/// <summary>Verifies that a cyclic reference blocks deployment without overflowing the stack.</summary>
[Fact]
public void Validate_CyclicRef_BlocksDeployWithoutOverflow()
{