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
@@ -3,12 +3,14 @@ using ZB.MOM.WW.ScadaBridge.Commons.Types.Enums;
namespace ZB.MOM.WW.ScadaBridge.DeploymentManager.Tests;
/// <summary>
/// WP-4: Tests for instance state transition matrix.
/// Tests for the instance state transition matrix.
/// </summary>
public class StateTransitionValidatorTests
{
// ── Deploy transitions ──
/// <summary>Verifies that deploying is allowed from every instance state.</summary>
/// <param name="state">The current instance state.</param>
[Theory]
[InlineData(InstanceState.NotDeployed)]
[InlineData(InstanceState.Enabled)]
@@ -20,18 +22,21 @@ public class StateTransitionValidatorTests
// ── Disable transitions ──
/// <summary>Verifies that an enabled instance can be disabled.</summary>
[Fact]
public void CanDisable_WhenEnabled_ReturnsTrue()
{
Assert.True(StateTransitionValidator.CanDisable(InstanceState.Enabled));
}
/// <summary>Verifies that a disabled instance cannot be disabled again.</summary>
[Fact]
public void CanDisable_WhenDisabled_ReturnsFalse()
{
Assert.False(StateTransitionValidator.CanDisable(InstanceState.Disabled));
}
/// <summary>Verifies that a not-deployed instance cannot be disabled.</summary>
[Fact]
public void CanDisable_WhenNotDeployed_ReturnsFalse()
{
@@ -40,18 +45,21 @@ public class StateTransitionValidatorTests
// ── Enable transitions ──
/// <summary>Verifies that a disabled instance can be enabled.</summary>
[Fact]
public void CanEnable_WhenDisabled_ReturnsTrue()
{
Assert.True(StateTransitionValidator.CanEnable(InstanceState.Disabled));
}
/// <summary>Verifies that an enabled instance cannot be enabled again.</summary>
[Fact]
public void CanEnable_WhenEnabled_ReturnsFalse()
{
Assert.False(StateTransitionValidator.CanEnable(InstanceState.Enabled));
}
/// <summary>Verifies that a not-deployed instance cannot be enabled.</summary>
[Fact]
public void CanEnable_WhenNotDeployed_ReturnsFalse()
{
@@ -60,18 +68,21 @@ public class StateTransitionValidatorTests
// ── Delete transitions ──
/// <summary>Verifies that an enabled instance can be deleted.</summary>
[Fact]
public void CanDelete_WhenEnabled_ReturnsTrue()
{
Assert.True(StateTransitionValidator.CanDelete(InstanceState.Enabled));
}
/// <summary>Verifies that a disabled instance can be deleted.</summary>
[Fact]
public void CanDelete_WhenDisabled_ReturnsTrue()
{
Assert.True(StateTransitionValidator.CanDelete(InstanceState.Disabled));
}
/// <summary>Verifies that a not-deployed instance can be deleted.</summary>
[Fact]
public void CanDelete_WhenNotDeployed_ReturnsTrue()
{
@@ -80,6 +91,7 @@ public class StateTransitionValidatorTests
// ── ValidateTransition ──
/// <summary>Verifies that a valid deploy transition returns no error.</summary>
[Fact]
public void ValidateTransition_ValidDeploy_ReturnsNull()
{
@@ -87,6 +99,7 @@ public class StateTransitionValidatorTests
Assert.Null(error);
}
/// <summary>Verifies that an invalid enable transition returns an error.</summary>
[Fact]
public void ValidateTransition_InvalidEnable_ReturnsError()
{
@@ -95,6 +108,7 @@ public class StateTransitionValidatorTests
Assert.Contains("not allowed", error);
}
/// <summary>Verifies that an invalid disable transition returns an error.</summary>
[Fact]
public void ValidateTransition_InvalidDisable_ReturnsError()
{
@@ -102,6 +116,7 @@ public class StateTransitionValidatorTests
Assert.NotNull(error);
}
/// <summary>Verifies that deleting a not-deployed instance returns no error.</summary>
[Fact]
public void ValidateTransition_ValidDeleteOnNotDeployed_ReturnsNull()
{
@@ -109,6 +124,7 @@ public class StateTransitionValidatorTests
Assert.Null(error);
}
/// <summary>Verifies that an unknown operation returns an error.</summary>
[Fact]
public void ValidateTransition_UnknownOperation_ReturnsError()
{