dohertj2/ScadaBridge
1
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Releases Wiki Activity

docs(tests): fix CommentChecker findings across tests/ — 13,392 → 0 (repo-wide scan clean)

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files
tests/ZB.MOM.WW.ScadaBridge.TemplateEngine.Tests/CycleDetectorTests.cs
+19 -4
View File
@@ -5,9 +5,10 @@ namespace ZB.MOM.WW.ScadaBridge.TemplateEngine.Tests;
public class CycleDetectorTests
{
// ========================================================================
// WP-13: Inheritance cycle detection
// Inheritance cycle detection
// ========================================================================
/// <summary>Verifies that self-inheritance is reported as a cycle.</summary>
[Fact]
public void DetectInheritanceCycle_SelfInheritance_ReturnsCycle()
{
@@ -20,6 +21,7 @@ public class CycleDetectorTests
Assert.Contains("itself", result);
}
/// <summary>Verifies that a direct inheritance cycle is reported.</summary>
[Fact]
public void DetectInheritanceCycle_DirectCycle_ReturnsCycle()
{
@@ -34,6 +36,7 @@ public class CycleDetectorTests
Assert.Contains("cycle", result, StringComparison.OrdinalIgnoreCase);
}
/// <summary>Verifies that a three-node inheritance cycle is reported.</summary>
[Fact]
public void DetectInheritanceCycle_ThreeNodeCycle_ReturnsCycle()
{
@@ -49,6 +52,7 @@ public class CycleDetectorTests
Assert.Contains("cycle", result, StringComparison.OrdinalIgnoreCase);
}
/// <summary>Verifies that an inheritance chain with no cycle returns null.</summary>
[Fact]
public void DetectInheritanceCycle_NoCycle_ReturnsNull()
{
@@ -62,9 +66,10 @@ public class CycleDetectorTests
}
// ========================================================================
// WP-13: Composition cycle detection
// Composition cycle detection
// ========================================================================
/// <summary>Verifies that self-composition is reported as a cycle.</summary>
[Fact]
public void DetectCompositionCycle_SelfComposition_ReturnsCycle()
{
@@ -77,6 +82,7 @@ public class CycleDetectorTests
Assert.Contains("compose itself", result);
}
/// <summary>Verifies that a direct composition cycle is reported.</summary>
[Fact]
public void DetectCompositionCycle_DirectCycle_ReturnsCycle()
{
@@ -92,6 +98,7 @@ public class CycleDetectorTests
Assert.Contains("cycle", result, StringComparison.OrdinalIgnoreCase);
}
/// <summary>Verifies that a transitive composition cycle is reported.</summary>
[Fact]
public void DetectCompositionCycle_TransitiveCycle_ReturnsCycle()
{
@@ -108,6 +115,7 @@ public class CycleDetectorTests
Assert.NotNull(result);
}
/// <summary>Verifies that a composition graph with no cycle returns null.</summary>
[Fact]
public void DetectCompositionCycle_NoCycle_ReturnsNull()
{
@@ -121,9 +129,10 @@ public class CycleDetectorTests
}
// ========================================================================
// WP-13: Cross-graph cycle detection (inheritance + composition)
// Cross-graph cycle detection (inheritance + composition)
// ========================================================================
/// <summary>Verifies that a cycle spanning inheritance and composition is reported as a cross-graph cycle.</summary>
[Fact]
public void DetectCrossGraphCycle_InheritanceCompositionCross_ReturnsCycle()
{
@@ -141,6 +150,7 @@ public class CycleDetectorTests
Assert.Contains("Cross-graph cycle", result);
}
/// <summary>Verifies that a graph with no cross-graph cycle returns null.</summary>
[Fact]
public void DetectCrossGraphCycle_NoCycle_ReturnsNull()
{
@@ -155,9 +165,10 @@ public class CycleDetectorTests
}
// ========================================================================
// TemplateEngine-013: robustness against duplicate Ids and Id 0
// Robustness against duplicate Ids and Id 0
// ========================================================================
/// <summary>Verifies that duplicate ids in the list do not cause an exception when detecting an inheritance cycle.</summary>
[Fact]
public void DetectInheritanceCycle_DuplicateIdsInList_DoesNotThrow()
{
@@ -173,6 +184,7 @@ public class CycleDetectorTests
Assert.Null(ex);
}
/// <summary>Verifies that duplicate ids in the list do not cause an exception when detecting a composition cycle.</summary>
[Fact]
public void DetectCompositionCycle_DuplicateIdsInList_DoesNotThrow()
{
@@ -185,6 +197,7 @@ public class CycleDetectorTests
Assert.Null(ex);
}
/// <summary>Verifies that duplicate ids in the list do not cause an exception when detecting a cross-graph cycle.</summary>
[Fact]
public void DetectCrossGraphCycle_DuplicateIdsInList_DoesNotThrow()
{
@@ -197,6 +210,7 @@ public class CycleDetectorTests
Assert.Null(ex);
}
/// <summary>Verifies that an inheritance cycle through a real id of zero is still detected.</summary>
[Fact]
public void DetectInheritanceCycle_RealIdZero_StillDetectsCycle()
{
@@ -212,6 +226,7 @@ public class CycleDetectorTests
Assert.Contains("itself", result);
}
/// <summary>Verifies that a parent chain passing through id zero is detected as a cycle.</summary>
[Fact]
public void DetectInheritanceCycle_ParentChainThroughIdZero_DetectsCycle()
{