Joseph Doherty
513fa1aa16
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.
91 lines
4.3 KiB
C#
91 lines
4.3 KiB
C#
using Microsoft.EntityFrameworkCore;
|
|
using Microsoft.Extensions.DependencyInjection;
|
|
using ZB.MOM.WW.ScadaBridge.Commons.Entities.Security;
|
|
using ZB.MOM.WW.ScadaBridge.Commons.Interfaces.Repositories;
|
|
using ZB.MOM.WW.ScadaBridge.Commons.Interfaces.Services;
|
|
using ZB.MOM.WW.ScadaBridge.ConfigurationDatabase;
|
|
|
|
namespace ZB.MOM.WW.ScadaBridge.IntegrationTests;
|
|
|
|
/// <summary>
|
|
/// Audit transactional guarantee — entity change + audit log in same transaction.
|
|
/// </summary>
|
|
public class AuditTransactionTests : IClassFixture<ScadaBridgeWebApplicationFactory>
|
|
{
|
|
private readonly ScadaBridgeWebApplicationFactory _factory;
|
|
|
|
/// <summary>Initializes a new instance of the <see cref="AuditTransactionTests"/> class.</summary>
|
|
/// <param name="factory">The factory used by the tests.</param>
|
|
public AuditTransactionTests(ScadaBridgeWebApplicationFactory factory)
|
|
{
|
|
_factory = factory;
|
|
}
|
|
|
|
/// <summary>Verifies the case: audit Log, is Committed With Entity Change, in Same Transaction.</summary>
|
|
/// <returns>A task that represents the asynchronous operation.</returns>
|
|
[Fact]
|
|
public async Task AuditLog_IsCommittedWithEntityChange_InSameTransaction()
|
|
{
|
|
using var scope = _factory.Services.CreateScope();
|
|
var securityRepo = scope.ServiceProvider.GetRequiredService<ISecurityRepository>();
|
|
var auditService = scope.ServiceProvider.GetRequiredService<IAuditService>();
|
|
var dbContext = scope.ServiceProvider.GetRequiredService<ScadaBridgeDbContext>();
|
|
|
|
// Add a mapping and an audit log entry in the same unit of work
|
|
var mapping = new LdapGroupMapping("test-group-audit", "Administrator");
|
|
await securityRepo.AddMappingAsync(mapping);
|
|
|
|
await auditService.LogAsync(
|
|
user: "test-user",
|
|
action: "Create",
|
|
entityType: "LdapGroupMapping",
|
|
entityId: "0", // ID not yet assigned
|
|
entityName: "test-group-audit",
|
|
afterState: new { Group = "test-group-audit", Role = "Administrator" });
|
|
|
|
// Both should be in the change tracker before saving
|
|
var trackedEntities = dbContext.ChangeTracker.Entries().Count(e => e.State == EntityState.Added);
|
|
Assert.True(trackedEntities >= 2, "Both entity and audit log should be tracked before SaveChanges");
|
|
|
|
// Single SaveChangesAsync commits both
|
|
await securityRepo.SaveChangesAsync();
|
|
|
|
// Verify both were persisted
|
|
var mappings = await securityRepo.GetAllMappingsAsync();
|
|
Assert.Contains(mappings, m => m.LdapGroupName == "test-group-audit");
|
|
|
|
var auditEntries = await dbContext.AuditLogEntries.ToListAsync();
|
|
Assert.Contains(auditEntries, a => a.EntityName == "test-group-audit" && a.Action == "Create");
|
|
}
|
|
|
|
/// <summary>Verifies the case: audit Log, is Not Persisted When Save Not Called.</summary>
|
|
/// <returns>A task that represents the asynchronous operation.</returns>
|
|
[Fact]
|
|
public async Task AuditLog_IsNotPersistedWhenSaveNotCalled()
|
|
{
|
|
// Create a separate scope so we have a fresh DbContext
|
|
using var scope1 = _factory.Services.CreateScope();
|
|
var securityRepo = scope1.ServiceProvider.GetRequiredService<ISecurityRepository>();
|
|
var auditService = scope1.ServiceProvider.GetRequiredService<IAuditService>();
|
|
|
|
// Add entity + audit but do NOT call SaveChangesAsync
|
|
var mapping = new LdapGroupMapping("orphan-group", "Designer");
|
|
await securityRepo.AddMappingAsync(mapping);
|
|
await auditService.LogAsync("test", "Create", "LdapGroupMapping", "0", "orphan-group", null);
|
|
|
|
// Dispose scope without saving — simulates a failed transaction
|
|
scope1.Dispose();
|
|
|
|
// In a new scope, verify nothing was persisted
|
|
using var scope2 = _factory.Services.CreateScope();
|
|
var securityRepo2 = scope2.ServiceProvider.GetRequiredService<ISecurityRepository>();
|
|
var dbContext2 = scope2.ServiceProvider.GetRequiredService<ScadaBridgeDbContext>();
|
|
|
|
var mappings = await securityRepo2.GetAllMappingsAsync();
|
|
Assert.DoesNotContain(mappings, m => m.LdapGroupName == "orphan-group");
|
|
|
|
var auditEntries = await dbContext2.AuditLogEntries.ToListAsync();
|
|
Assert.DoesNotContain(auditEntries, a => a.EntityName == "orphan-group");
|
|
}
|
|
}
|