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/Services/InstanceServiceTests.cs
+43 -2
View File
@@ -15,11 +15,14 @@ public class InstanceServiceTests
private readonly Mock<IAuditService> _auditMock = new();
private readonly InstanceService _sut;
/// <summary>Initializes the test with a mocked repository and audit service and the service under test.</summary>
public InstanceServiceTests()
{
_sut = new InstanceService(_repoMock.Object, _auditMock.Object);
}
/// <summary>Verifies that creating an instance with valid input returns success.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task CreateInstance_ValidInput_ReturnsSuccess()
{
@@ -38,6 +41,8 @@ public class InstanceServiceTests
_repoMock.Verify(r => r.AddInstanceAsync(It.IsAny<Instance>(), It.IsAny<CancellationToken>()), Times.Once);
}
/// <summary>Verifies that creating an instance with a duplicate name returns a failure.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task CreateInstance_DuplicateName_ReturnsFailure()
{
@@ -52,6 +57,8 @@ public class InstanceServiceTests
Assert.Contains("already exists", result.Error);
}
/// <summary>Verifies that creating an instance from a missing template returns a failure.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task CreateInstance_MissingTemplate_ReturnsFailure()
{
@@ -64,6 +71,8 @@ public class InstanceServiceTests
Assert.Contains("not found", result.Error);
}
/// <summary>Verifies that overriding a locked attribute returns a failure.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task SetAttributeOverride_LockedAttribute_ReturnsFailure()
{
@@ -82,6 +91,8 @@ public class InstanceServiceTests
Assert.Contains("locked", result.Error, StringComparison.OrdinalIgnoreCase);
}
/// <summary>Verifies that overriding a non-existent attribute returns a failure.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task SetAttributeOverride_NonExistentAttribute_ReturnsFailure()
{
@@ -97,6 +108,8 @@ public class InstanceServiceTests
Assert.Contains("does not exist", result.Error);
}
/// <summary>Verifies that overriding an unlocked attribute returns success.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task SetAttributeOverride_UnlockedAttribute_ReturnsSuccess()
{
@@ -120,7 +133,7 @@ public class InstanceServiceTests
Assert.Equal("99", result.Value.OverrideValue);
}
// --- TemplateEngine-008 regression: SetAlarmOverrideAsync validation ---
// --- SetAlarmOverrideAsync validation regression ---
private static Template TemplateWithAlarms(int id, params TemplateAlarm[] alarms)
{
@@ -133,6 +146,8 @@ public class InstanceServiceTests
return t;
}
/// <summary>Verifies that overriding a non-existent alarm returns a failure.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task SetAlarmOverride_NonExistentAlarm_ReturnsFailure()
{
@@ -153,6 +168,8 @@ public class InstanceServiceTests
It.IsAny<InstanceAlarmOverride>(), It.IsAny<CancellationToken>()), Times.Never);
}
/// <summary>Verifies that overriding a locked alarm on a composed template returns a failure.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task SetAlarmOverride_ComposedLockedAlarm_ReturnsFailure()
{
@@ -177,6 +194,8 @@ public class InstanceServiceTests
It.IsAny<InstanceAlarmOverride>(), It.IsAny<CancellationToken>()), Times.Never);
}
/// <summary>Verifies that overriding an unlocked alarm on a composed template returns success.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task SetAlarmOverride_ComposedUnlockedAlarm_ReturnsSuccess()
{
@@ -202,6 +221,8 @@ public class InstanceServiceTests
It.IsAny<InstanceAlarmOverride>(), It.IsAny<CancellationToken>()), Times.Once);
}
/// <summary>Verifies that overriding a locked alarm declared directly on the template returns a failure.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task SetAlarmOverride_DirectLockedAlarm_ReturnsFailure()
{
@@ -220,6 +241,8 @@ public class InstanceServiceTests
Assert.Contains("locked", result.Error, StringComparison.OrdinalIgnoreCase);
}
/// <summary>Verifies that setting an alarm override stores the MES-reportable override.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task SetAlarmOverrideAsync_StoresIsMesReportableOverride()
{
@@ -250,6 +273,8 @@ public class InstanceServiceTests
Assert.True(result.Value.IsMesReportableOverride);
}
/// <summary>Verifies that a null MES-reportable override clears the existing override.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task SetAlarmOverrideAsync_NullIsMesReportableOverride_ClearsExistingOverride()
{
@@ -284,6 +309,8 @@ public class InstanceServiceTests
It.IsAny<CancellationToken>()), Times.Once);
}
/// <summary>Verifies that setting an alarm override updates the MES-reportable override on an existing override.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task SetAlarmOverrideAsync_UpdatesIsMesReportableOverrideOnExisting()
{
@@ -315,6 +342,8 @@ public class InstanceServiceTests
Assert.Equal(3, existingOverride.PriorityLevelOverride);
}
/// <summary>Verifies that enabling an existing instance sets its state to enabled.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Enable_ExistingInstance_SetsEnabled()
{
@@ -330,6 +359,8 @@ public class InstanceServiceTests
Assert.Equal(InstanceState.Enabled, result.Value.State);
}
/// <summary>Verifies that disabling an existing instance sets its state to disabled.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Disable_ExistingInstance_SetsDisabled()
{
@@ -345,6 +376,8 @@ public class InstanceServiceTests
Assert.Equal(InstanceState.Disabled, result.Value.State);
}
/// <summary>Verifies that a bulk connection-binding assignment succeeds.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task SetConnectionBindings_BulkAssignment_Success()
{
@@ -364,8 +397,10 @@ public class InstanceServiceTests
_repoMock.Verify(r => r.AddInstanceConnectionBindingAsync(It.IsAny<InstanceConnectionBinding>(), It.IsAny<CancellationToken>()), Times.Exactly(2));
}
// --- NJ-2: ElementDataType stamping on SetAttributeOverrideAsync ---
// --- ElementDataType stamping on SetAttributeOverrideAsync ---
/// <summary>Verifies that creating an override for a list attribute stamps the element data type.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task SetAttributeOverride_CreatePath_ListAttribute_StampsElementDataType()
{
@@ -398,6 +433,8 @@ public class InstanceServiceTests
Assert.Equal(DataType.String, captured.ElementDataType);
}
/// <summary>Verifies that updating an override for a list attribute stamps the element data type.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task SetAttributeOverride_UpdatePath_ListAttribute_StampsElementDataType()
{
@@ -432,6 +469,8 @@ public class InstanceServiceTests
Assert.Equal(DataType.String, captured.ElementDataType);
}
/// <summary>Verifies that creating an override for a scalar attribute leaves the element data type null.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task SetAttributeOverride_CreatePath_ScalarAttribute_ElementDataTypeIsNull()
{
@@ -464,6 +503,8 @@ public class InstanceServiceTests
Assert.Null(captured.ElementDataType);
}
/// <summary>Verifies that assigning an instance to an area in a different site returns a failure.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task AssignToArea_AreaInDifferentSite_ReturnsFailure()
{