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,7 +5,7 @@ using ZB.MOM.WW.ScadaBridge.Commons.Messages.Management;
namespace ZB.MOM.WW.ScadaBridge.CLI.Tests.Commands;
/// <summary>
/// MV-11: the <c>template attribute add</c> / <c>update</c> commands must support
/// The <c>template attribute add</c> / <c>update</c> commands must support
/// structured multi-value (List) attributes — a new <c>--element-type</c> option,
/// a JSON-array <c>--value</c>, client-side element-type validation, and
/// <see cref="AddTemplateAttributeCommand.ElementDataType"/> /
@@ -25,6 +25,7 @@ public class TemplateAttributeListTests
// ---- option surface ----
/// <summary>Verifies that the attribute add command exposes an element-type option.</summary>
[Fact]
public void AttributeAdd_HasElementTypeOption()
{
@@ -32,6 +33,7 @@ public class TemplateAttributeListTests
Assert.Contains("--element-type", add.Options.Select(o => o.Name));
}
/// <summary>Verifies that the attribute update command exposes an element-type option.</summary>
[Fact]
public void AttributeUpdate_HasElementTypeOption()
{
@@ -41,6 +43,8 @@ public class TemplateAttributeListTests
// ---- client-side element-type validation (both directions) ----
/// <summary>Verifies that a List attribute with a valid scalar element type passes validation.</summary>
/// <param name="elementType">The scalar element type name under test.</param>
[Theory]
[InlineData("String")]
[InlineData("Int32")]
@@ -55,6 +59,7 @@ public class TemplateAttributeListTests
Assert.Null(error);
}
/// <summary>Verifies that element-type validation for a List attribute is case-insensitive.</summary>
[Fact]
public void ValidateElementType_ListWithValidScalar_CaseInsensitive()
{
@@ -63,6 +68,7 @@ public class TemplateAttributeListTests
Assert.Null(error);
}
/// <summary>Verifies that a List attribute without an element type fails validation.</summary>
[Fact]
public void ValidateElementType_ListWithoutElementType_Error()
{
@@ -71,6 +77,7 @@ public class TemplateAttributeListTests
Assert.NotNull(error);
}
/// <summary>Verifies that a List attribute with a blank element type fails validation.</summary>
[Fact]
public void ValidateElementType_ListWithBlankElementType_Error()
{
@@ -79,6 +86,7 @@ public class TemplateAttributeListTests
Assert.NotNull(error);
}
/// <summary>Verifies that a List attribute with an invalid scalar element type fails validation.</summary>
[Fact]
public void ValidateElementType_ListWithInvalidScalar_Error()
{
@@ -87,6 +95,7 @@ public class TemplateAttributeListTests
Assert.NotNull(error);
}
/// <summary>Verifies that a List attribute with a binary element type fails validation.</summary>
[Fact]
public void ValidateElementType_ListWithBinaryScalar_Error()
{
@@ -96,6 +105,7 @@ public class TemplateAttributeListTests
Assert.NotNull(error);
}
/// <summary>Verifies that a scalar attribute with an element type fails validation.</summary>
[Fact]
public void ValidateElementType_ScalarWithElementType_Error()
{
@@ -104,6 +114,7 @@ public class TemplateAttributeListTests
Assert.NotNull(error);
}
/// <summary>Verifies that a scalar attribute without an element type passes validation.</summary>
[Fact]
public void ValidateElementType_ScalarWithoutElementType_Ok()
{
@@ -114,6 +125,7 @@ public class TemplateAttributeListTests
// ---- payload wiring: the raw JSON value + ElementDataType flow into the command ----
/// <summary>Verifies that building an add command for a List attribute carries the element type and the raw JSON value.</summary>
[Fact]
public void BuildAddCommand_ListAttribute_CarriesElementTypeAndRawJsonValue()
{
@@ -134,6 +146,7 @@ public class TemplateAttributeListTests
Assert.Equal("""["WO-1","WO-2"]""", cmd.Value);
}
/// <summary>Verifies that building an update command for a List attribute carries the element type and the raw JSON value.</summary>
[Fact]
public void BuildUpdateCommand_ListAttribute_CarriesElementTypeAndRawJsonValue()
{
@@ -153,6 +166,7 @@ public class TemplateAttributeListTests
Assert.Equal("""["A","B"]""", cmd.Value);
}
/// <summary>Verifies that building an add command for a scalar attribute leaves the element type null.</summary>
[Fact]
public void BuildAddCommand_ScalarAttribute_LeavesElementTypeNull()
{