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:
+14
-2
@@ -35,6 +35,7 @@ public sealed class BundleExporterTests : IDisposable
|
||||
{
|
||||
private readonly ServiceProvider _provider;
|
||||
|
||||
/// <summary>Initializes the test class with an in-memory database and the exporter under test.</summary>
|
||||
public BundleExporterTests()
|
||||
{
|
||||
var services = new ServiceCollection();
|
||||
@@ -64,7 +65,7 @@ public sealed class BundleExporterTests : IDisposable
|
||||
sp.GetRequiredService<DbContextOptions<ScadaBridgeDbContext>>(),
|
||||
sp.GetRequiredService<IDataProtectionProvider>()));
|
||||
|
||||
// Repositories the resolver pulls from. M8 (B4): the resolver now injects
|
||||
// Repositories the resolver pulls from. The resolver now injects
|
||||
// ISiteRepository to walk the site/data-connection/instance closure, so it
|
||||
// must be registered or the BuildServiceProvider-time graph resolution for
|
||||
// DependencyResolver fails.
|
||||
@@ -87,8 +88,11 @@ public sealed class BundleExporterTests : IDisposable
|
||||
_provider = services.BuildServiceProvider();
|
||||
}
|
||||
|
||||
/// <summary>Releases the resources held by this instance.</summary>
|
||||
public void Dispose() => _provider.Dispose();
|
||||
|
||||
/// <summary>Verifies that exporting writes an audit event and returns a valid bundle.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[Fact]
|
||||
public async Task ExportAsync_writes_audit_event_and_returns_valid_bundle()
|
||||
{
|
||||
@@ -214,6 +218,8 @@ public sealed class BundleExporterTests : IDisposable
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>Verifies that exporting emits the selected SMS config with its secret and the summary count.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[Fact]
|
||||
public async Task ExportAsync_emits_selected_sms_config_with_secret_and_summary_count()
|
||||
{
|
||||
@@ -286,6 +292,8 @@ public sealed class BundleExporterTests : IDisposable
|
||||
Assert.Equal("super-secret-token", token);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that exporting with a passphrase produces an encrypted bundle.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[Fact]
|
||||
public async Task ExportAsync_with_passphrase_produces_encrypted_bundle()
|
||||
{
|
||||
@@ -369,6 +377,8 @@ public sealed class BundleExporterTests : IDisposable
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>Verifies that exporting with a site selection packs the sites, data connections and instances.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[Fact]
|
||||
public async Task ExportAsync_with_site_selection_packs_sites_dataconnections_and_instances()
|
||||
{
|
||||
@@ -464,7 +474,7 @@ public sealed class BundleExporterTests : IDisposable
|
||||
Assert.Equal("NORTH-01.Pump1", content.Instances[0].UniqueName);
|
||||
Assert.Equal("PumpStation", content.Instances[0].TemplateName);
|
||||
// The instance carries its binding, and the manifest dep-edge resolves the
|
||||
// owning site by identifier (I1) — Site:NORTH-01, never Site:<rawId>.
|
||||
// owning site by identifier (I1) — the site's identifier string, never the raw id.
|
||||
Assert.Single(content.Instances[0].ConnectionBindings);
|
||||
var instanceEntry = Assert.Single(
|
||||
manifest.Contents,
|
||||
@@ -473,6 +483,8 @@ public sealed class BundleExporterTests : IDisposable
|
||||
Assert.DoesNotContain(instanceEntry.DependsOn, d => d == $"Site:{siteId}");
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a directly selected instance records its owning site by identifier.</summary>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
[Fact]
|
||||
public async Task ExportAsync_directly_selected_instance_records_owning_site_by_identifier()
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user