Files
ScadaBridge/tests/ZB.MOM.WW.ScadaBridge.SiteRuntime.Tests/Scripts/AuditingDbTransactionTests.cs
T
Joseph Doherty 513fa1aa16 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.
2026-10-07 15:05:49 -04:00

73 lines
3.7 KiB
C#

using Microsoft.Data.Sqlite;
using Microsoft.Extensions.Logging.Abstractions;
using Moq;
using ZB.MOM.WW.ScadaBridge.Commons.Interfaces.Services;
using ZB.MOM.WW.ScadaBridge.SiteRuntime.Scripts;
namespace ZB.MOM.WW.ScadaBridge.SiteRuntime.Tests.Scripts;
public class AuditingDbTransactionTests
{
/// <summary>Verifies that sr11, transaction connection and command readback remain audited.</summary>
/// <param name="asynchronous">Test case input.</param>
/// <returns>A task that represents the asynchronous operation.</returns>
[Theory]
[InlineData(false)]
[InlineData(true)]
public async Task SR11_TransactionConnectionAndCommandReadbackRemainAudited(bool asynchronous)
{
var inner = new SqliteConnection("Data Source=:memory:");
await inner.OpenAsync();
using (var seed = inner.CreateCommand())
{
seed.CommandText = "CREATE TABLE t (value INTEGER); INSERT INTO t VALUES (0)";
seed.ExecuteNonQuery();
}
var writer = new Mock<IAuditWriter>();
writer.Setup(w => w.WriteAsync(It.IsAny<ZB.MOM.WW.Audit.AuditEvent>(), It.IsAny<CancellationToken>()))
.Returns(Task.CompletedTask);
await using var connection = new AuditingDbConnection(inner, writer.Object, "db", "site", "instance",
"script", NullLogger.Instance, Guid.NewGuid());
await using var transaction = asynchronous
? await connection.BeginTransactionAsync()
: connection.BeginTransaction();
Assert.Same(connection, transaction.Connection);
using var command = transaction.Connection!.CreateCommand();
Assert.Same(connection, command.Connection);
command.Transaction = transaction;
Assert.Same(transaction, command.Transaction);
Assert.Same(connection, command.Transaction!.Connection);
command.CommandText = "UPDATE t SET value = 42";
Assert.Equal(1, asynchronous ? await command.ExecuteNonQueryAsync() : command.ExecuteNonQuery());
if (asynchronous) await transaction.CommitAsync(); else transaction.Commit();
writer.Verify(w => w.WriteAsync(It.IsAny<ZB.MOM.WW.Audit.AuditEvent>(), It.IsAny<CancellationToken>()), Times.Once);
using var check = inner.CreateCommand();
check.CommandText = "SELECT value FROM t";
Assert.Equal(42L, check.ExecuteScalar());
}
/// <summary>Verifies that sr11, command connection cannot expose provider.</summary>
[Fact]
public void SR11_CommandConnectionCannotExposeProvider()
{
using var inner = new SqliteConnection("Data Source=:memory:");
using var connection = new AuditingDbConnection(inner, Mock.Of<IAuditWriter>(), "db", "site", "instance",
"script", NullLogger.Instance, Guid.NewGuid());
using var command = connection.CreateCommand();
Assert.Same(connection, command.Connection);
}
/// <summary>Verifies that sr4, connection cannot be retargeted or reveal credentials.</summary>
[Fact]
public void SR4_ConnectionCannotBeRetargetedOrRevealCredentials()
{
using var inner = new SqliteConnection("Data Source=:memory:;Password=secret-value");
using var connection = new AuditingDbConnection(inner, Mock.Of<IAuditWriter>(), "MES-Prod", "site", "instance",
"script", NullLogger.Instance, Guid.NewGuid());
Assert.DoesNotContain("secret-value", connection.ConnectionString);
Assert.Throws<NotSupportedException>(() => connection.ConnectionString = "Data Source=other.db");
Assert.Throws<NotSupportedException>(() => connection.ChangeDatabase("other"));
Assert.Equal("Data Source=:memory:;Password=secret-value", inner.ConnectionString);
}
}