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:
@@ -4,7 +4,7 @@ using Microsoft.AspNetCore.Mvc.Testing;
|
||||
namespace ZB.MOM.WW.ScadaBridge.IntegrationTests;
|
||||
|
||||
/// <summary>
|
||||
/// WP-22: Startup validation — missing required config fails with clear error.
|
||||
/// Startup validation — missing required config fails with clear error.
|
||||
/// Tests the StartupValidator that runs on boot.
|
||||
///
|
||||
/// Note: These tests temporarily set environment variables because Program.cs reads
|
||||
@@ -13,6 +13,7 @@ namespace ZB.MOM.WW.ScadaBridge.IntegrationTests;
|
||||
/// </summary>
|
||||
public class StartupValidationTests
|
||||
{
|
||||
/// <summary>Verifies that a missing role throws an InvalidOperationException.</summary>
|
||||
[Fact]
|
||||
public void MissingRole_ThrowsInvalidOperationException()
|
||||
{
|
||||
@@ -34,6 +35,7 @@ public class StartupValidationTests
|
||||
factory.Dispose();
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a missing JWT signing key for the Central role throws an InvalidOperationException.</summary>
|
||||
[Fact]
|
||||
public void MissingJwtSigningKey_ForCentral_ThrowsInvalidOperationException()
|
||||
{
|
||||
@@ -59,6 +61,7 @@ public class StartupValidationTests
|
||||
factory.Dispose();
|
||||
}
|
||||
|
||||
/// <summary>Verifies that the Central role starts successfully with a valid configuration.</summary>
|
||||
[Fact]
|
||||
public void CentralRole_StartsSuccessfully_WithValidConfig()
|
||||
{
|
||||
@@ -101,6 +104,8 @@ public class StartupValidationTests
|
||||
"ScadaBridge__Security__Ldap__ServiceAccountPassword",
|
||||
};
|
||||
|
||||
/// <summary>Sets the given environment variables, remembering the prior values so they can be restored.</summary>
|
||||
/// <param name="varsToSet">The environment variables to set.</param>
|
||||
public TempEnvironment(Dictionary<string, string> varsToSet)
|
||||
{
|
||||
// Save and clear all known keys
|
||||
@@ -119,6 +124,7 @@ public class StartupValidationTests
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>Releases the resources held by this test class.</summary>
|
||||
public void Dispose()
|
||||
{
|
||||
foreach (var (key, previousValue) in _previousValues)
|
||||
|
||||
Reference in New Issue
Block a user