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:
+8
-1
@@ -7,11 +7,12 @@ namespace ZB.MOM.WW.ScadaBridge.Transport.Tests.Encryption;
|
||||
|
||||
public sealed class BundleSecretEncryptorTests
|
||||
{
|
||||
// Commons-015 sets the documented PBKDF2 floor to 100_000 (OWASP minimum);
|
||||
// The documented PBKDF2 floor is 100_000 (OWASP minimum);
|
||||
// the production value is 600_000. Using the floor keeps the test fast while
|
||||
// remaining a valid EncryptionMetadata.Iterations.
|
||||
private const int TestIterations = EncryptionMetadata.MinPbkdf2Iterations;
|
||||
|
||||
/// <summary>Verifies that encrypting and then decrypting arbitrary bytes returns the original bytes.</summary>
|
||||
[Fact]
|
||||
public void Encrypt_then_Decrypt_roundtrips_arbitrary_bytes()
|
||||
{
|
||||
@@ -24,6 +25,7 @@ public sealed class BundleSecretEncryptorTests
|
||||
Assert.Equal(plaintext, recovered);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that decrypting with the wrong passphrase throws a <see cref="System.Security.Cryptography.CryptographicException"/>.</summary>
|
||||
[Fact]
|
||||
public void Decrypt_with_wrong_passphrase_throws_CryptographicException()
|
||||
{
|
||||
@@ -35,6 +37,7 @@ public sealed class BundleSecretEncryptorTests
|
||||
Assert.ThrowsAny<CryptographicException>(() => sut.Decrypt(ciphertext, metadata, "wrong-pass"));
|
||||
}
|
||||
|
||||
/// <summary>Verifies that decrypting tampered ciphertext throws a <see cref="System.Security.Cryptography.CryptographicException"/>.</summary>
|
||||
[Fact]
|
||||
public void Decrypt_with_tampered_ciphertext_throws_CryptographicException()
|
||||
{
|
||||
@@ -47,6 +50,7 @@ public sealed class BundleSecretEncryptorTests
|
||||
Assert.ThrowsAny<CryptographicException>(() => sut.Decrypt(ciphertext, metadata, "pass"));
|
||||
}
|
||||
|
||||
/// <summary>Verifies that encrypting the same input twice produces different ciphertext because of the random IV.</summary>
|
||||
[Fact]
|
||||
public void Encrypt_produces_distinct_ciphertext_for_same_input_due_to_random_iv()
|
||||
{
|
||||
@@ -61,6 +65,7 @@ public sealed class BundleSecretEncryptorTests
|
||||
Assert.NotEqual(meta1.SaltB64, meta2.SaltB64);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that decrypting with mismatched associated data throws a <see cref="System.Security.Cryptography.CryptographicException"/>.</summary>
|
||||
[Fact]
|
||||
public void Decrypt_with_mismatched_AAD_throws_CryptographicException()
|
||||
{
|
||||
@@ -78,6 +83,7 @@ public sealed class BundleSecretEncryptorTests
|
||||
() => sut.Decrypt(ciphertext, metadata, "pass", aadOnDecrypt));
|
||||
}
|
||||
|
||||
/// <summary>Verifies that decrypting with matching associated data recovers the plaintext.</summary>
|
||||
[Fact]
|
||||
public void Decrypt_with_matching_AAD_recovers_plaintext()
|
||||
{
|
||||
@@ -92,6 +98,7 @@ public sealed class BundleSecretEncryptorTests
|
||||
Assert.Equal(plaintext, recovered);
|
||||
}
|
||||
|
||||
/// <summary>Verifies that encryption emits metadata matching the inputs needed for decryption.</summary>
|
||||
[Fact]
|
||||
public void Encrypt_emits_metadata_matching_decryption_inputs()
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user