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:
+9
-1
@@ -7,7 +7,7 @@ namespace ZB.MOM.WW.ScadaBridge.Communication.Tests.Grpc;
|
||||
/// <summary>
|
||||
/// Round-trip tests for the additive <c>Secrets</c> / <c>SecretsApplied</c> wire contract
|
||||
/// on <see cref="DeployArtifactsCommand"/> / <see cref="ArtifactDeploymentResponse"/>
|
||||
/// (proto field 9 / field 6). Site secrets design §3.3, task-2 of
|
||||
/// (proto field 9 / field 6). Site secrets design §3.3,
|
||||
/// docs/plans/2026-09-28-site-secrets-artifact-deploy-design.md.
|
||||
/// </summary>
|
||||
public class SiteCommandDtoMapperSecretsTests
|
||||
@@ -16,6 +16,7 @@ public class SiteCommandDtoMapperSecretsTests
|
||||
[1, 2, 3], [4], [5], [6, 7], [8], [9], "kek-A", 7,
|
||||
DateTimeOffset.Parse("2026-09-01T00:00:00Z"), DateTimeOffset.Parse("2026-09-02T00:00:00Z"), "d");
|
||||
|
||||
/// <summary>Verifies that deploy-artifacts secrets round-trip verbatim through the DTO mapper.</summary>
|
||||
[Fact]
|
||||
public void DeployArtifacts_Secrets_RoundTrip_Verbatim()
|
||||
{
|
||||
@@ -37,6 +38,7 @@ public class SiteCommandDtoMapperSecretsTests
|
||||
Assert.Equal(7, back.Secrets[1].Revision);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that null deploy-artifacts secrets stay null through the mapper.</summary>
|
||||
[Fact]
|
||||
public void DeployArtifacts_NullSecrets_StaysNull()
|
||||
{
|
||||
@@ -46,6 +48,7 @@ public class SiteCommandDtoMapperSecretsTests
|
||||
Assert.Null(((DeployArtifactsCommand)SiteCommandDtoMapper.FromProto(dto)).Secrets);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that empty deploy-artifacts secrets stay empty rather than becoming null.</summary>
|
||||
[Fact]
|
||||
public void DeployArtifacts_EmptySecrets_StaysEmpty_NotNull()
|
||||
{
|
||||
@@ -56,6 +59,7 @@ public class SiteCommandDtoMapperSecretsTests
|
||||
Assert.Empty(back.Secrets!);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that a command DTO that lacks the secrets field maps to null secrets.</summary>
|
||||
[Fact]
|
||||
public void DeployArtifacts_CommandDtoWithoutField9_MapsToNullSecrets()
|
||||
{
|
||||
@@ -74,6 +78,8 @@ public class SiteCommandDtoMapperSecretsTests
|
||||
Assert.Null(back.Secrets);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that the applied-secrets count of an artifact response round-trips through the mapper.</summary>
|
||||
/// <param name="applied">The applied-secrets count, or <see langword="null"/> when the site did not report one.</param>
|
||||
[Theory]
|
||||
[InlineData(null)]
|
||||
[InlineData(3)]
|
||||
@@ -83,6 +89,7 @@ public class SiteCommandDtoMapperSecretsTests
|
||||
Assert.Equal(applied, SiteCommandDtoMapper.FromProto(SiteCommandDtoMapper.ToProto(r)).SecretsApplied);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that the removed-secrets list of an artifact response round-trips through the mapper.</summary>
|
||||
[Fact]
|
||||
public void ArtifactResponse_SecretsRemoved_RoundTrips()
|
||||
{
|
||||
@@ -91,6 +98,7 @@ public class SiteCommandDtoMapperSecretsTests
|
||||
Assert.Equal(["old-1", "old-2"], SiteCommandDtoMapper.FromProto(SiteCommandDtoMapper.ToProto(r)).SecretsRemoved!);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that an artifact response with no removed secrets is null on both sides of the mapper.</summary>
|
||||
[Fact]
|
||||
public void ArtifactResponse_NoSecretsRemoved_IsNullOnBothSides()
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user