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
@@ -4,6 +4,8 @@ namespace ZB.MOM.WW.ScadaBridge.DelmiaNotifier.Tests;
public class ConfigLoaderTests
{
/// <summary>Verifies that invalid endpoint lists are rejected when the configuration loads.</summary>
/// <param name="urls">The base URL list to load.</param>
[Theory]
[InlineData("relative")]
[InlineData("ftp://example.com")]
@@ -17,6 +19,7 @@ public class ConfigLoaderTests
Assert.Contains("HTTP", error.Message);
}
/// <summary>Verifies that splitting base URLs trims entries and drops empty ones.</summary>
[Fact]
public void SplitBaseUrls_trims_and_drops_empties()
{
@@ -24,6 +27,7 @@ public class ConfigLoaderTests
Assert.Equal(new[] { "a", "b", "c" }, urls);
}
/// <summary>Verifies that a null or whitespace base URL list yields no URLs.</summary>
[Fact]
public void SplitBaseUrls_null_or_whitespace_returns_empty()
{
@@ -31,6 +35,7 @@ public class ConfigLoaderTests
Assert.Empty(ConfigLoader.SplitBaseUrls(" "));
}
/// <summary>Verifies that the timeout defaults to 30 seconds when it is omitted.</summary>
[Fact]
public void Load_defaults_timeout_to_30_when_omitted()
{
@@ -39,6 +44,7 @@ public class ConfigLoaderTests
Assert.Equal("http://x", cfg.ScadaBridge.BaseUrls);
}
/// <summary>Verifies that loading reads every configured field.</summary>
[Fact]
public void Load_reads_all_fields()
{
@@ -48,6 +54,7 @@ public class ConfigLoaderTests
Assert.Equal("l.log", cfg.ScadaBridge.LogPath);
}
/// <summary>Verifies that an unset or whitespace environment key resolves to null.</summary>
[Fact]
public void ResolveApiKey_returns_null_when_unset_or_whitespace()
{
@@ -55,12 +62,14 @@ public class ConfigLoaderTests
Assert.Null(ConfigLoader.ResolveApiKey(_ => " ", new NotifierConfig()));
}
/// <summary>Verifies that a key present in the environment is returned.</summary>
[Fact]
public void ResolveApiKey_returns_value_when_present()
{
Assert.Equal("sbk_x", ConfigLoader.ResolveApiKey(n => n == "SCADABRIDGE_API_KEY" ? "sbk_x" : null, new NotifierConfig()));
}
/// <summary>Verifies that the API key is read from the ScadaBridge configuration section.</summary>
[Fact]
public void Load_reads_ApiKey_from_ScadaBridge_section()
{
@@ -68,6 +77,7 @@ public class ConfigLoaderTests
Assert.Equal("sbk_file", cfg.ScadaBridge.ApiKey);
}
/// <summary>Verifies that the environment key takes precedence over the configured key.</summary>
[Fact]
public void ResolveApiKey_prefers_env_over_config()
{
@@ -75,6 +85,7 @@ public class ConfigLoaderTests
Assert.Equal("sbk_env", ConfigLoader.ResolveApiKey(n => n == "SCADABRIDGE_API_KEY" ? "sbk_env" : null, cfg));
}
/// <summary>Verifies that the configured key is used when the environment key is unset or blank.</summary>
[Fact]
public void ResolveApiKey_falls_back_to_config_when_env_unset_or_blank()
{
@@ -83,12 +94,14 @@ public class ConfigLoaderTests
Assert.Equal("sbk_file", ConfigLoader.ResolveApiKey(_ => " ", cfg));
}
/// <summary>Verifies that the environment key is trimmed the same way as the configured key.</summary>
[Fact]
public void ResolveApiKey_trims_env_value_like_the_file_value()
{
Assert.Equal("sbk_env", ConfigLoader.ResolveApiKey(_ => " sbk_env \t", new NotifierConfig()));
}
/// <summary>Verifies that key resolution reports whether the environment or the file supplied the key.</summary>
[Fact]
public void ResolveApiKey_reports_which_source_supplied_the_key()
{
@@ -101,6 +114,7 @@ public class ConfigLoaderTests
Assert.Null(none);
}
/// <summary>Verifies that the API key stays null when the configuration omits it.</summary>
[Fact]
public void Load_leaves_ApiKey_null_when_absent()
{
@@ -108,6 +122,7 @@ public class ConfigLoaderTests
Assert.Null(cfg.ScadaBridge.ApiKey);
}
/// <summary>Verifies that key resolution returns null when neither source supplies a key.</summary>
[Fact]
public void ResolveApiKey_returns_null_when_neither_source_set()
{