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,16 +14,19 @@ namespace ZB.MOM.WW.ScadaBridge.ConfigurationDatabase.Tests;
|
||||
///
|
||||
/// Constructed with an explicit ephemeral Data Protection provider so secret-bearing
|
||||
/// columns are write-capable in tests. The schema-only no-provider constructor would
|
||||
/// throw on a secret-column write (ConfigurationDatabase-013); passing a provider here
|
||||
/// throw on a secret-column write; passing a provider here
|
||||
/// makes the test fixture's intent explicit at the call site.
|
||||
/// </summary>
|
||||
public class SqliteTestDbContext : ScadaBridgeDbContext
|
||||
{
|
||||
/// <summary>Initializes the context with the given SQLite options and an ephemeral data protection provider.</summary>
|
||||
/// <param name="options">The EF options configured for the SQLite provider.</param>
|
||||
public SqliteTestDbContext(DbContextOptions<ScadaBridgeDbContext> options)
|
||||
: base(options, new EphemeralDataProtectionProvider())
|
||||
{
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
protected override void OnModelCreating(ModelBuilder modelBuilder)
|
||||
{
|
||||
base.OnModelCreating(modelBuilder);
|
||||
@@ -38,7 +41,7 @@ public class SqliteTestDbContext : ScadaBridgeDbContext
|
||||
.ValueGeneratedNever();
|
||||
});
|
||||
|
||||
// Note (C5 / Task 2.5): the central dbo.AuditLog persisted computed columns
|
||||
// Note: the central dbo.AuditLog persisted computed columns
|
||||
// (JSON_VALUE-based) are neutralized for non-SQL-Server providers inside
|
||||
// ScadaBridgeDbContext.OnModelCreating itself, so every SQLite test context —
|
||||
// including ones that construct ScadaBridgeDbContext directly rather than via
|
||||
@@ -74,6 +77,8 @@ public class SqliteTestDbContext : ScadaBridgeDbContext
|
||||
|
||||
public static class SqliteTestHelper
|
||||
{
|
||||
/// <summary>Creates a context backed by a fresh in-memory SQLite database with the schema created.</summary>
|
||||
/// <returns>The open in-memory test context.</returns>
|
||||
public static ScadaBridgeDbContext CreateInMemoryContext()
|
||||
{
|
||||
var options = new DbContextOptionsBuilder<ScadaBridgeDbContext>()
|
||||
@@ -92,6 +97,8 @@ public static class SqliteTestHelper
|
||||
/// test observe the actual SQL a repository emits (e.g. count DELETE statements
|
||||
/// issued by a batched purge).
|
||||
/// </summary>
|
||||
/// <param name="interceptors">The EF interceptors to attach to the context.</param>
|
||||
/// <returns>The open in-memory test context with the interceptors attached.</returns>
|
||||
public static ScadaBridgeDbContext CreateInMemoryContext(params IInterceptor[] interceptors)
|
||||
{
|
||||
var options = new DbContextOptionsBuilder<ScadaBridgeDbContext>()
|
||||
@@ -106,6 +113,9 @@ public static class SqliteTestHelper
|
||||
return context;
|
||||
}
|
||||
|
||||
/// <summary>Creates a context backed by a SQLite database file.</summary>
|
||||
/// <param name="dbPath">The path of the SQLite database file.</param>
|
||||
/// <returns>The file-backed test context.</returns>
|
||||
public static ScadaBridgeDbContext CreateFileContext(string dbPath)
|
||||
{
|
||||
var options = new DbContextOptionsBuilder<ScadaBridgeDbContext>()
|
||||
|
||||
Reference in New Issue
Block a user