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
@@ -40,6 +40,7 @@ public class NotificationSmsCommandTests
// ---- list create/update: --type + --phones ----------------------------
/// <summary>Verifies that creating an SMS list with phones builds an SMS command carrying the recipient phones.</summary>
[Fact]
public void ListCreate_SmsTypeWithPhones_BuildsSmsCommandWithRecipientPhones()
{
@@ -55,6 +56,7 @@ public class NotificationSmsCommandTests
Assert.Empty(cmd.RecipientEmails);
}
/// <summary>Verifies that the list type option is matched case-insensitively.</summary>
[Fact]
public void ListCreate_TypeIsCaseInsensitive()
{
@@ -66,6 +68,7 @@ public class NotificationSmsCommandTests
Assert.Equal(NotificationType.Sms, cmd.Type);
}
/// <summary>Verifies that a list created without a type defaults to email.</summary>
[Fact]
public void ListCreate_DefaultType_IsEmail()
{
@@ -79,6 +82,7 @@ public class NotificationSmsCommandTests
Assert.Null(cmd.RecipientPhones);
}
/// <summary>Verifies that an email list given phone numbers is rejected.</summary>
[Fact]
public void ListCreate_EmailTypeWithPhones_Throws()
{
@@ -90,6 +94,7 @@ public class NotificationSmsCommandTests
Assert.Contains("--phones", ex.Message);
}
/// <summary>Verifies that an SMS list with no phone numbers is rejected.</summary>
[Fact]
public void ListCreate_SmsTypeWithoutPhones_Throws()
{
@@ -100,6 +105,7 @@ public class NotificationSmsCommandTests
Assert.Contains("--phones", ex.Message);
}
/// <summary>Verifies that an email list with no email addresses is rejected.</summary>
[Fact]
public void ListCreate_EmailTypeWithoutEmails_Throws()
{
@@ -110,6 +116,7 @@ public class NotificationSmsCommandTests
Assert.Contains("--emails", ex.Message);
}
/// <summary>Verifies that an SMS list given email addresses is rejected.</summary>
[Fact]
public void ListCreate_SmsTypeWithEmails_Throws()
{
@@ -121,6 +128,7 @@ public class NotificationSmsCommandTests
Assert.Contains("--emails", ex.Message);
}
/// <summary>Verifies that an unknown list type is rejected.</summary>
[Fact]
public void ListCreate_UnknownType_Throws()
{
@@ -131,6 +139,7 @@ public class NotificationSmsCommandTests
() => NotificationCommands.BuildCreateNotificationListCommand(parse));
}
/// <summary>Verifies that updating an SMS list with phones builds an SMS command carrying the recipient phones.</summary>
[Fact]
public void ListUpdate_SmsTypeWithPhones_BuildsSmsCommandWithRecipientPhones()
{
@@ -146,6 +155,7 @@ public class NotificationSmsCommandTests
Assert.Empty(cmd.RecipientEmails);
}
/// <summary>Verifies that updating an email list with phone numbers is rejected.</summary>
[Fact]
public void ListUpdate_EmailTypeWithPhones_Throws()
{
@@ -160,6 +170,7 @@ public class NotificationSmsCommandTests
// ---- notification sms group -------------------------------------------
/// <summary>Verifies that the notification command has an SMS group with list and update subcommands.</summary>
[Fact]
public void Notification_HasSmsGroupWithListAndUpdate()
{
@@ -168,6 +179,7 @@ public class NotificationSmsCommandTests
Assert.Contains("update", subNames);
}
/// <summary>Verifies that an SMS update with every flag produces a command carrying all of them.</summary>
[Fact]
public void SmsUpdate_WithAllFlags_ProducesCommandCarryingThem()
{
@@ -187,6 +199,7 @@ public class NotificationSmsCommandTests
Assert.Equal("new-secret", cmd.AuthToken);
}
/// <summary>Verifies that omitting the optional flags produces a command with null values for them.</summary>
[Fact]
public void SmsUpdate_WithoutOptionalFlags_ProducesCommandWithNulls()
{
@@ -204,6 +217,7 @@ public class NotificationSmsCommandTests
Assert.Null(cmd.AuthToken);
}
/// <summary>Verifies that the optional SMS update flags are not marked as required.</summary>
[Fact]
public void SmsUpdate_OptionalFlags_AreNotRequired()
{
@@ -214,6 +228,7 @@ public class NotificationSmsCommandTests
Assert.False(update.Options.Single(o => o.Name == "--auth-token").Required);
}
/// <summary>Verifies that an SMS update with only a messaging service SID and no from number builds successfully.</summary>
[Fact]
public void SmsUpdate_MessagingServiceSidOnly_NoFromNumber_Builds()
{
@@ -229,6 +244,7 @@ public class NotificationSmsCommandTests
Assert.Equal("MGonly", cmd.MessagingServiceSid);
}
/// <summary>Verifies that an SMS update with neither a from number nor a messaging service SID is rejected.</summary>
[Fact]
public void SmsUpdate_NeitherFromNorMessagingService_Throws()
{
@@ -239,6 +255,7 @@ public class NotificationSmsCommandTests
Assert.Throws<ArgumentException>(() => NotificationCommands.BuildUpdateSmsConfigCommand(parse));
}
/// <summary>Verifies that both SMS commands resolve through the management command registry.</summary>
[Fact]
public void SmsCommands_ResolveViaRegistry()
{
@@ -262,6 +279,7 @@ public class NotificationSmsCommandTests
[Collection("Console")]
public class NotificationSmsAuthTokenRenderingTests
{
/// <summary>Verifies that a rendered SMS configuration list never contains the auth token value.</summary>
[Fact]
public void SmsConfigListResponse_RenderedAsJson_DoesNotContainAuthToken()
{