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
@@ -15,7 +15,7 @@ namespace ZB.MOM.WW.ScadaBridge.Transport.Tests.Import;
|
||||
|
||||
/// <summary>
|
||||
/// Tests for <see cref="ArtifactDiff"/>: the structured per-line Myers code diff
|
||||
/// embedded in <c>FieldDiffJson</c> (T20) and the M8 Site / DataConnection /
|
||||
/// embedded in <c>FieldDiffJson</c> (T20) and the Site / DataConnection /
|
||||
/// Instance compares. The diff records are private, so assertions parse the
|
||||
/// serialized <see cref="ImportPreviewItem.FieldDiffJson"/>.
|
||||
/// </summary>
|
||||
@@ -61,6 +61,7 @@ public sealed class ArtifactDiffTests
|
||||
|
||||
// ============ T20: structured per-line code diff ============
|
||||
|
||||
/// <summary>Verifies that a modified shared script emits a structured line diff.</summary>
|
||||
[Fact]
|
||||
public void SharedScript_ModifiedCode_EmitsStructuredLineDiff()
|
||||
{
|
||||
@@ -94,6 +95,7 @@ public sealed class ArtifactDiffTests
|
||||
Assert.DoesNotContain(hunks, h => h.Text.Contains("lines>"));
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a shared script with identical code reports no change.</summary>
|
||||
[Fact]
|
||||
public void SharedScript_IdenticalCode_NoChange()
|
||||
{
|
||||
@@ -156,7 +158,7 @@ public sealed class ArtifactDiffTests
|
||||
Assert.Equal(ConflictKind.Identical, item.Kind);
|
||||
}
|
||||
|
||||
// ============ arch-review 2026-08-19 P7-1: TimeoutSeconds in the diff (row-27 shape) ============
|
||||
// ============ TimeoutSeconds in the diff ============
|
||||
|
||||
/// <summary>
|
||||
/// The bundle has always CARRIED TimeoutSeconds and BundleImporter has always APPLIED it
|
||||
@@ -220,6 +222,7 @@ public sealed class ArtifactDiffTests
|
||||
Assert.Equal(ConflictKind.Identical, item.Kind);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a modified API method script emits a structured line diff.</summary>
|
||||
[Fact]
|
||||
public void ApiMethod_ModifiedScript_EmitsStructuredLineDiff()
|
||||
{
|
||||
@@ -244,6 +247,7 @@ public sealed class ArtifactDiffTests
|
||||
Assert.Contains(("add", "log(\"b\");"), hunks);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that modified template script code emits a structured line diff.</summary>
|
||||
[Fact]
|
||||
public void TemplateScript_ModifiedCode_EmitsStructuredLineDiff()
|
||||
{
|
||||
@@ -265,8 +269,9 @@ public sealed class ArtifactDiffTests
|
||||
Assert.Contains(("add", "new2"), hunks);
|
||||
}
|
||||
|
||||
// ============ #05-T23: placeholder-identity resolution via name maps ============
|
||||
// ============ placeholder-identity resolution via name maps ============
|
||||
|
||||
/// <summary>Verifies that templates with matching folder, base and composition names compare as identical.</summary>
|
||||
[Fact]
|
||||
public void CompareTemplate_MatchingFolderBaseAndComposition_IsIdentical()
|
||||
{
|
||||
@@ -295,6 +300,7 @@ public sealed class ArtifactDiffTests
|
||||
Assert.Equal(ConflictKind.Identical, item.Kind);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a divergent base template name makes the template compare as modified.</summary>
|
||||
[Fact]
|
||||
public void CompareTemplate_DivergentBaseTemplateName_IsModified()
|
||||
{
|
||||
@@ -311,8 +317,9 @@ public sealed class ArtifactDiffTests
|
||||
Assert.Equal(ConflictKind.Modified, item.Kind);
|
||||
}
|
||||
|
||||
// ============ #05-T6: single-source child equality — diff sees the full field set ============
|
||||
// ============ single-source child equality — diff sees the full field set ============
|
||||
|
||||
/// <summary>Verifies that a change to an attribute's element data type makes the template compare as modified.</summary>
|
||||
[Fact]
|
||||
public void CompareTemplate_AttributeElementDataTypeChange_IsModified()
|
||||
{
|
||||
@@ -334,6 +341,7 @@ public sealed class ArtifactDiffTests
|
||||
ChangeFor(item, "Attributes.L"); // ElementDataType diverged — previously missed.
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a change to the locked-in-derived flag makes the template compare as modified.</summary>
|
||||
[Fact]
|
||||
public void CompareTemplate_LockedInDerivedChange_IsModified()
|
||||
{
|
||||
@@ -355,6 +363,7 @@ public sealed class ArtifactDiffTests
|
||||
ChangeFor(item, "Attributes.L"); // LockedInDerived diverged — previously missed.
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a change to a script's execution timeout makes the template compare as modified.</summary>
|
||||
[Fact]
|
||||
public void CompareTemplate_ScriptExecutionTimeoutChange_IsModified()
|
||||
{
|
||||
@@ -372,6 +381,7 @@ public sealed class ArtifactDiffTests
|
||||
ChangeFor(item, "Scripts.S"); // ExecutionTimeoutSeconds diverged — previously missed.
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a change to an alarm's on-trigger script makes the template compare as modified.</summary>
|
||||
[Fact]
|
||||
public void CompareTemplate_AlarmOnTriggerScriptChange_IsModified()
|
||||
{
|
||||
@@ -396,6 +406,7 @@ public sealed class ArtifactDiffTests
|
||||
ChangeFor(item, "Alarms.A"); // OnTriggerScriptName diverged — previously missed.
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a change to an alarm's MES-reportable flag makes the template compare as modified.</summary>
|
||||
[Fact]
|
||||
public void CompareTemplate_AlarmIsMesReportableChange_IsModified()
|
||||
{
|
||||
@@ -418,6 +429,7 @@ public sealed class ArtifactDiffTests
|
||||
ChangeFor(item, "Alarms.A"); // IsMesReportable diverged.
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a change to an instance alarm override's MES-reportable flag makes the instance compare as modified.</summary>
|
||||
[Fact]
|
||||
public void CompareInstance_AlarmOverrideIsMesReportableChange_IsModified()
|
||||
{
|
||||
@@ -443,8 +455,9 @@ public sealed class ArtifactDiffTests
|
||||
Assert.Equal("<modified>", modified.GetProperty("newValue").GetString());
|
||||
}
|
||||
|
||||
// ============ M8: CompareSite ============
|
||||
// ============ CompareSite ============
|
||||
|
||||
/// <summary>Verifies that comparing a site against no existing site yields a new result.</summary>
|
||||
[Fact]
|
||||
public void CompareSite_ExistingNull_New()
|
||||
{
|
||||
@@ -457,6 +470,7 @@ public sealed class ArtifactDiffTests
|
||||
Assert.Null(item.FieldDiffJson);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a site with a differing field compares as modified.</summary>
|
||||
[Fact]
|
||||
public void CompareSite_FieldDiffers_Modified()
|
||||
{
|
||||
@@ -471,6 +485,7 @@ public sealed class ArtifactDiffTests
|
||||
Assert.Equal("new", change.GetProperty("newValue").GetString());
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a site with no changes compares as identical.</summary>
|
||||
[Fact]
|
||||
public void CompareSite_NoChanges_Identical()
|
||||
{
|
||||
@@ -490,8 +505,9 @@ public sealed class ArtifactDiffTests
|
||||
Assert.Null(item.FieldDiffJson);
|
||||
}
|
||||
|
||||
// ============ M8: CompareDataConnection ============
|
||||
// ============ CompareDataConnection ============
|
||||
|
||||
/// <summary>Verifies that comparing a data connection against no existing connection yields a new result.</summary>
|
||||
[Fact]
|
||||
public void CompareDataConnection_ExistingNull_New()
|
||||
{
|
||||
@@ -503,6 +519,7 @@ public sealed class ArtifactDiffTests
|
||||
Assert.Equal("opc1", item.Name);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a data connection with a different protocol compares as modified.</summary>
|
||||
[Fact]
|
||||
public void CompareDataConnection_ProtocolDiffers_Modified()
|
||||
{
|
||||
@@ -517,6 +534,7 @@ public sealed class ArtifactDiffTests
|
||||
Assert.Equal("MxAccess", change.GetProperty("newValue").GetString());
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a changed secret value with preserved presence is reported without echoing the secret.</summary>
|
||||
[Fact]
|
||||
public void CompareDataConnection_SecretValueChangesButPresencePreserved_NoSecretEcho()
|
||||
{
|
||||
@@ -541,6 +559,7 @@ public sealed class ArtifactDiffTests
|
||||
Assert.DoesNotContain("4840", item.FieldDiffJson ?? string.Empty);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a flip in secret presence is shown only as a present marker, without the secret value.</summary>
|
||||
[Fact]
|
||||
public void CompareDataConnection_SecretPresenceFlips_ShowsPresentMarkerOnly()
|
||||
{
|
||||
@@ -577,6 +596,7 @@ public sealed class ArtifactDiffTests
|
||||
? new SecretsBlock(new Dictionary<string, string> { ["AuthToken"] = "wire-token" })
|
||||
: null);
|
||||
|
||||
/// <summary>Verifies that comparing an SMS configuration against no existing configuration yields a new result.</summary>
|
||||
[Fact]
|
||||
public void CompareSmsConfiguration_ExistingNull_New()
|
||||
{
|
||||
@@ -587,6 +607,7 @@ public sealed class ArtifactDiffTests
|
||||
Assert.Equal("AC1", item.Name);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that an SMS configuration whose fields and secret presence all match compares as identical.</summary>
|
||||
[Fact]
|
||||
public void CompareSmsConfiguration_AllFieldsAndPresenceMatch_Identical()
|
||||
{
|
||||
@@ -596,6 +617,7 @@ public sealed class ArtifactDiffTests
|
||||
Assert.Null(item.FieldDiffJson);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that an SMS configuration with a different from-number compares as modified.</summary>
|
||||
[Fact]
|
||||
public void CompareSmsConfiguration_FromNumberDiffers_Modified()
|
||||
{
|
||||
@@ -607,6 +629,7 @@ public sealed class ArtifactDiffTests
|
||||
Assert.Equal("+15559999999", change.GetProperty("newValue").GetString());
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a changed auth token value with preserved presence is reported without echoing the secret.</summary>
|
||||
[Fact]
|
||||
public void CompareSmsConfiguration_AuthTokenValueChangesButPresencePreserved_NoSecretEcho()
|
||||
{
|
||||
@@ -620,6 +643,7 @@ public sealed class ArtifactDiffTests
|
||||
Assert.DoesNotContain("wire-token", json);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a flip in auth token presence is shown only as a present marker, without the secret value.</summary>
|
||||
[Fact]
|
||||
public void CompareSmsConfiguration_AuthTokenPresenceFlips_ShowsPresentMarkerOnly()
|
||||
{
|
||||
@@ -634,8 +658,9 @@ public sealed class ArtifactDiffTests
|
||||
Assert.DoesNotContain("stored-token", item.FieldDiffJson!);
|
||||
}
|
||||
|
||||
// ============ M8: CompareInstance ============
|
||||
// ============ CompareInstance ============
|
||||
|
||||
/// <summary>Verifies that comparing an instance against no existing instance yields a new result.</summary>
|
||||
[Fact]
|
||||
public void CompareInstance_ExistingNull_New()
|
||||
{
|
||||
@@ -647,6 +672,7 @@ public sealed class ArtifactDiffTests
|
||||
Assert.Equal("inst-1", item.Name);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that an instance with a differing state compares as modified.</summary>
|
||||
[Fact]
|
||||
public void CompareInstance_StateDiffers_Modified()
|
||||
{
|
||||
@@ -661,6 +687,7 @@ public sealed class ArtifactDiffTests
|
||||
Assert.Equal("Enabled", change.GetProperty("newValue").GetString());
|
||||
}
|
||||
|
||||
/// <summary>Verifies that an instance with no changes compares as identical.</summary>
|
||||
[Fact]
|
||||
public void CompareInstance_NoChanges_Identical()
|
||||
{
|
||||
@@ -673,6 +700,7 @@ public sealed class ArtifactDiffTests
|
||||
Assert.Null(item.FieldDiffJson);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that differing template and site names make the instance compare as modified.</summary>
|
||||
[Fact]
|
||||
public void CompareInstance_TemplateAndSiteNamesDiffer_Modified()
|
||||
{
|
||||
@@ -689,6 +717,7 @@ public sealed class ArtifactDiffTests
|
||||
Assert.Equal("site-b", ChangeFor(item, "SiteIdentifier").GetProperty("newValue").GetString());
|
||||
}
|
||||
|
||||
/// <summary>Verifies that added, removed and modified child overrides are reported for an instance.</summary>
|
||||
[Fact]
|
||||
public void CompareInstance_ChildOverridesAddedRemovedModified()
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user