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.Transport.Tests/Export/DependencyResolverTests.cs
+29 -1
View File
@@ -132,6 +132,8 @@ public sealed class DependencyResolverTests
.Returns(instance.ConnectionBindings.ToList());
}
/// <summary>Verifies that resolving includes the base template for a composed template.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Resolve_includes_base_template_for_composed_template()
{
@@ -152,6 +154,8 @@ public sealed class DependencyResolverTests
Assert.Contains(result.Templates, t => t.Id == 11);
}
/// <summary>Verifies that resolving includes the shared script referenced by a template.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Resolve_includes_shared_script_referenced_by_template()
{
@@ -170,6 +174,8 @@ public sealed class DependencyResolverTests
Assert.Equal("UtilHelper", result.SharedScripts[0].Name);
}
/// <summary>Verifies that resolving includes the external system referenced by a template.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Resolve_includes_external_system_referenced_by_template()
{
@@ -188,6 +194,8 @@ public sealed class DependencyResolverTests
Assert.Equal("ErpSystem", result.ExternalSystems[0].Name);
}
/// <summary>Verifies that resolving includes the shared script dependency of an API method.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Resolve_includes_api_method_shared_script_dependency()
{
@@ -206,6 +214,8 @@ public sealed class DependencyResolverTests
Assert.Equal("Validator", result.SharedScripts[0].Name);
}
/// <summary>Verifies that resolving includes the selected SMS configurations.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Resolve_includes_selected_sms_configs()
{
@@ -226,6 +236,8 @@ public sealed class DependencyResolverTests
e => e.Type == "SmsConfiguration" && e.Name == "AC_test_sid");
}
/// <summary>Verifies that resolving handles a diamond dependency without duplication.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Resolve_handles_diamond_dependency_without_duplication()
{
@@ -253,6 +265,8 @@ public sealed class DependencyResolverTests
Assert.Single(result.Templates, t => t.Id == 4);
}
/// <summary>Verifies that resolving includes the template folder for each selected template.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Resolve_includes_template_folder_for_each_selected_template()
{
@@ -276,6 +290,8 @@ public sealed class DependencyResolverTests
Assert.Equal("Grand", result.TemplateFolders[2].Name);
}
/// <summary>Verifies that resolving returns a topological order with base templates before derived ones.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Resolve_returns_topological_order_base_before_derived()
{
@@ -302,9 +318,11 @@ public sealed class DependencyResolverTests
}
// ---------------------------------------------------------------------------
// M8 (B1): site/instance-scoped expansion.
// Site/instance-scoped expansion.
// ---------------------------------------------------------------------------
/// <summary>Verifies that resolving a site pulls in its connections and instances.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Resolve_site_pulls_its_connections_and_instances()
{
@@ -331,6 +349,8 @@ public sealed class DependencyResolverTests
Assert.Single(result.Templates, t => t.Id == 9);
}
/// <summary>Verifies that resolving an instance with dependencies pulls in its site connections and template.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Resolve_instance_with_deps_pulls_site_connections_and_template()
{
@@ -370,6 +390,8 @@ public sealed class DependencyResolverTests
Assert.Single(resolvedInstance.NativeAlarmSourceOverrides);
}
/// <summary>Verifies that resolving an instance without dependencies does not pull in its site or template.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Resolve_instance_without_deps_does_not_pull_site_or_template()
{
@@ -395,6 +417,8 @@ public sealed class DependencyResolverTests
Assert.Empty(result.Templates);
}
/// <summary>Verifies that resolving deduplicates an instance when both the site and the instance are selected.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Resolve_dedups_instance_when_site_and_instance_both_selected()
{
@@ -422,6 +446,8 @@ public sealed class DependencyResolverTests
await _templates.Received(1).GetInstanceByIdAsync(instance.Id, Arg.Any<CancellationToken>());
}
/// <summary>Verifies that resolving orders sites, connections and instances deterministically.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Resolve_orders_sites_connections_and_instances_deterministically()
{
@@ -462,6 +488,8 @@ public sealed class DependencyResolverTests
Assert.Equal(new[] { "Alpha", "Zulu" }, result.Instances.Select(i => i.UniqueName).ToArray());
}
/// <summary>Verifies that resolving emits manifest entries with dependency edges for site scope.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Resolve_emits_manifest_entries_with_dependency_edges_for_site_scope()
{