Joseph Doherty
480 lines
20 KiB
C#
480 lines
20 KiB
C#
using Microsoft.EntityFrameworkCore;
|
|
using Microsoft.EntityFrameworkCore.Diagnostics;
|
|
using ZB.MOM.WW.ScadaBridge.Commons.Entities.Audit;
|
|
using ZB.MOM.WW.ScadaBridge.Commons.Entities.Deployment;
|
|
using ZB.MOM.WW.ScadaBridge.Commons.Entities.Instances;
|
|
using ZB.MOM.WW.ScadaBridge.Commons.Entities.Security;
|
|
using ZB.MOM.WW.ScadaBridge.Commons.Entities.Sites;
|
|
using ZB.MOM.WW.ScadaBridge.Commons.Entities.Templates;
|
|
using ZB.MOM.WW.ScadaBridge.Commons.Types.Enums;
|
|
using ZB.MOM.WW.ScadaBridge.ConfigurationDatabase;
|
|
using ZB.MOM.WW.ScadaBridge.ConfigurationDatabase.Repositories;
|
|
|
|
namespace ZB.MOM.WW.ScadaBridge.ConfigurationDatabase.Tests;
|
|
|
|
public class SecurityRepositoryTests : IDisposable
|
|
{
|
|
private readonly ScadaBridgeDbContext _context;
|
|
private readonly SecurityRepository _repository;
|
|
|
|
/// <summary>Initializes the test class with a fresh in-memory database context.</summary>
|
|
public SecurityRepositoryTests()
|
|
{
|
|
var options = new DbContextOptionsBuilder<ScadaBridgeDbContext>()
|
|
.UseSqlite("DataSource=:memory:")
|
|
.Options;
|
|
|
|
_context = new ScadaBridgeDbContext(options);
|
|
_context.Database.OpenConnection();
|
|
_context.Database.EnsureCreated();
|
|
_repository = new SecurityRepository(_context);
|
|
}
|
|
|
|
/// <summary>Releases the resources held by this instance.</summary>
|
|
public void Dispose()
|
|
{
|
|
_context.Database.CloseConnection();
|
|
_context.Dispose();
|
|
}
|
|
|
|
/// <summary>Verifies that an added mapping can be retrieved by its id.</summary>
|
|
/// <returns>A task that represents the asynchronous operation.</returns>
|
|
[Fact]
|
|
public async Task AddMapping_AndGetById_ReturnsMapping()
|
|
{
|
|
var mapping = new LdapGroupMapping("CN=Admins,DC=test", "Administrator");
|
|
await _repository.AddMappingAsync(mapping);
|
|
await _repository.SaveChangesAsync();
|
|
|
|
var loaded = await _repository.GetMappingByIdAsync(mapping.Id);
|
|
Assert.NotNull(loaded);
|
|
Assert.Equal("CN=Admins,DC=test", loaded.LdapGroupName);
|
|
Assert.Equal("Administrator", loaded.Role);
|
|
}
|
|
|
|
/// <summary>Verifies that getting all mappings returns every mapping.</summary>
|
|
/// <returns>A task that represents the asynchronous operation.</returns>
|
|
[Fact]
|
|
public async Task GetAllMappings_ReturnsAll()
|
|
{
|
|
await _repository.AddMappingAsync(new LdapGroupMapping("Group1", "Administrator"));
|
|
await _repository.AddMappingAsync(new LdapGroupMapping("Group2", "Designer"));
|
|
await _repository.SaveChangesAsync();
|
|
|
|
// +1 for seed data
|
|
var all = await _repository.GetAllMappingsAsync();
|
|
Assert.True(all.Count >= 2);
|
|
}
|
|
|
|
/// <summary>Verifies that updating a mapping persists the change.</summary>
|
|
/// <returns>A task that represents the asynchronous operation.</returns>
|
|
[Fact]
|
|
public async Task UpdateMapping_PersistsChange()
|
|
{
|
|
var mapping = new LdapGroupMapping("OldGroup", "Administrator");
|
|
await _repository.AddMappingAsync(mapping);
|
|
await _repository.SaveChangesAsync();
|
|
|
|
mapping.Role = "Designer";
|
|
await _repository.UpdateMappingAsync(mapping);
|
|
await _repository.SaveChangesAsync();
|
|
|
|
_context.ChangeTracker.Clear();
|
|
var loaded = await _repository.GetMappingByIdAsync(mapping.Id);
|
|
Assert.Equal("Designer", loaded!.Role);
|
|
}
|
|
|
|
/// <summary>Verifies that deleting a mapping removes the entity.</summary>
|
|
/// <returns>A task that represents the asynchronous operation.</returns>
|
|
[Fact]
|
|
public async Task DeleteMapping_RemovesEntity()
|
|
{
|
|
var mapping = new LdapGroupMapping("ToDelete", "Administrator");
|
|
await _repository.AddMappingAsync(mapping);
|
|
await _repository.SaveChangesAsync();
|
|
|
|
await _repository.DeleteMappingAsync(mapping.Id);
|
|
await _repository.SaveChangesAsync();
|
|
|
|
var loaded = await _repository.GetMappingByIdAsync(mapping.Id);
|
|
Assert.Null(loaded);
|
|
}
|
|
|
|
/// <summary>Verifies that an added scope rule can be retrieved for its mapping.</summary>
|
|
/// <returns>A task that represents the asynchronous operation.</returns>
|
|
[Fact]
|
|
public async Task AddScopeRule_AndGetForMapping()
|
|
{
|
|
var site = new Site("Site1", "SITE-001");
|
|
_context.Sites.Add(site);
|
|
var mapping = new LdapGroupMapping("Deployers", "Deployer");
|
|
await _repository.AddMappingAsync(mapping);
|
|
await _repository.SaveChangesAsync();
|
|
|
|
var rule = new SiteScopeRule { LdapGroupMappingId = mapping.Id, SiteId = site.Id };
|
|
await _repository.AddScopeRuleAsync(rule);
|
|
await _repository.SaveChangesAsync();
|
|
|
|
var rules = await _repository.GetScopeRulesForMappingAsync(mapping.Id);
|
|
Assert.Single(rules);
|
|
Assert.Equal(site.Id, rules[0].SiteId);
|
|
}
|
|
|
|
/// <summary>Verifies that getting a scope rule by id returns the rule.</summary>
|
|
/// <returns>A task that represents the asynchronous operation.</returns>
|
|
[Fact]
|
|
public async Task GetScopeRuleById_ReturnsRule()
|
|
{
|
|
var site = new Site("Site1", "SITE-001");
|
|
_context.Sites.Add(site);
|
|
var mapping = new LdapGroupMapping("Group", "Deployer");
|
|
await _repository.AddMappingAsync(mapping);
|
|
await _repository.SaveChangesAsync();
|
|
|
|
var rule = new SiteScopeRule { LdapGroupMappingId = mapping.Id, SiteId = site.Id };
|
|
await _repository.AddScopeRuleAsync(rule);
|
|
await _repository.SaveChangesAsync();
|
|
|
|
var loaded = await _repository.GetScopeRuleByIdAsync(rule.Id);
|
|
Assert.NotNull(loaded);
|
|
Assert.Equal(mapping.Id, loaded.LdapGroupMappingId);
|
|
}
|
|
|
|
/// <summary>Verifies that updating a scope rule persists the change.</summary>
|
|
/// <returns>A task that represents the asynchronous operation.</returns>
|
|
[Fact]
|
|
public async Task UpdateScopeRule_PersistsChange()
|
|
{
|
|
var site1 = new Site("Site1", "SITE-001");
|
|
var site2 = new Site("Site2", "SITE-002");
|
|
_context.Sites.AddRange(site1, site2);
|
|
var mapping = new LdapGroupMapping("Group", "Deployer");
|
|
await _repository.AddMappingAsync(mapping);
|
|
await _repository.SaveChangesAsync();
|
|
|
|
var rule = new SiteScopeRule { LdapGroupMappingId = mapping.Id, SiteId = site1.Id };
|
|
await _repository.AddScopeRuleAsync(rule);
|
|
await _repository.SaveChangesAsync();
|
|
|
|
rule.SiteId = site2.Id;
|
|
await _repository.UpdateScopeRuleAsync(rule);
|
|
await _repository.SaveChangesAsync();
|
|
|
|
_context.ChangeTracker.Clear();
|
|
var loaded = await _repository.GetScopeRuleByIdAsync(rule.Id);
|
|
Assert.Equal(site2.Id, loaded!.SiteId);
|
|
}
|
|
|
|
/// <summary>Verifies that deleting a scope rule removes the entity.</summary>
|
|
/// <returns>A task that represents the asynchronous operation.</returns>
|
|
[Fact]
|
|
public async Task DeleteScopeRule_RemovesEntity()
|
|
{
|
|
var site = new Site("Site1", "SITE-001");
|
|
_context.Sites.Add(site);
|
|
var mapping = new LdapGroupMapping("Group", "Deployer");
|
|
await _repository.AddMappingAsync(mapping);
|
|
await _repository.SaveChangesAsync();
|
|
|
|
var rule = new SiteScopeRule { LdapGroupMappingId = mapping.Id, SiteId = site.Id };
|
|
await _repository.AddScopeRuleAsync(rule);
|
|
await _repository.SaveChangesAsync();
|
|
|
|
await _repository.DeleteScopeRuleAsync(rule.Id);
|
|
await _repository.SaveChangesAsync();
|
|
|
|
var loaded = await _repository.GetScopeRuleByIdAsync(rule.Id);
|
|
Assert.Null(loaded);
|
|
}
|
|
}
|
|
|
|
public class CentralUiRepositoryTests : IDisposable
|
|
{
|
|
private readonly ScadaBridgeDbContext _context;
|
|
private readonly CentralUiRepository _repository;
|
|
|
|
/// <summary>Initializes the test class with a fresh in-memory database context.</summary>
|
|
public CentralUiRepositoryTests()
|
|
{
|
|
_context = SqliteTestHelper.CreateInMemoryContext();
|
|
_repository = new CentralUiRepository(_context);
|
|
}
|
|
|
|
/// <summary>Releases the resources held by this instance.</summary>
|
|
public void Dispose()
|
|
{
|
|
_context.Database.CloseConnection();
|
|
_context.Dispose();
|
|
}
|
|
|
|
/// <summary>Verifies that getting all sites returns them ordered by name.</summary>
|
|
/// <returns>A task that represents the asynchronous operation.</returns>
|
|
[Fact]
|
|
public async Task GetAllSites_ReturnsOrderedByName()
|
|
{
|
|
_context.Sites.AddRange(
|
|
new Site("Zulu", "Z-001"),
|
|
new Site("Alpha", "A-001"));
|
|
await _context.SaveChangesAsync();
|
|
|
|
var sites = await _repository.GetAllSitesAsync();
|
|
Assert.Equal(2, sites.Count);
|
|
Assert.Equal("Alpha", sites[0].Name);
|
|
Assert.Equal("Zulu", sites[1].Name);
|
|
}
|
|
|
|
/// <summary>Verifies that filtered instances can be restricted by site id.</summary>
|
|
/// <returns>A task that represents the asynchronous operation.</returns>
|
|
[Fact]
|
|
public async Task GetInstancesFiltered_BySiteId()
|
|
{
|
|
var site1 = new Site("Site1", "S-001");
|
|
var site2 = new Site("Site2", "S-002");
|
|
var template = new Template("T1");
|
|
_context.Sites.AddRange(site1, site2);
|
|
_context.Templates.Add(template);
|
|
await _context.SaveChangesAsync();
|
|
|
|
_context.Instances.AddRange(
|
|
new Instance("Inst1") { SiteId = site1.Id, TemplateId = template.Id },
|
|
new Instance("Inst2") { SiteId = site2.Id, TemplateId = template.Id });
|
|
await _context.SaveChangesAsync();
|
|
|
|
var instances = await _repository.GetInstancesFilteredAsync(siteId: site1.Id);
|
|
Assert.Single(instances);
|
|
Assert.Equal("Inst1", instances[0].UniqueName);
|
|
}
|
|
|
|
/// <summary>Verifies that filtered instances can be restricted by search term.</summary>
|
|
/// <returns>A task that represents the asynchronous operation.</returns>
|
|
[Fact]
|
|
public async Task GetInstancesFiltered_BySearchTerm()
|
|
{
|
|
var site = new Site("Site1", "S-001");
|
|
var template = new Template("T1");
|
|
_context.Sites.Add(site);
|
|
_context.Templates.Add(template);
|
|
await _context.SaveChangesAsync();
|
|
|
|
_context.Instances.AddRange(
|
|
new Instance("PumpStation1") { SiteId = site.Id, TemplateId = template.Id },
|
|
new Instance("TankLevel1") { SiteId = site.Id, TemplateId = template.Id });
|
|
await _context.SaveChangesAsync();
|
|
|
|
var instances = await _repository.GetInstancesFilteredAsync(searchTerm: "Pump");
|
|
Assert.Single(instances);
|
|
}
|
|
|
|
/// <summary>Verifies paged instances filter in SQL, order by name, page and report the total.</summary>
|
|
/// <returns>A task that represents the asynchronous operation.</returns>
|
|
[Fact]
|
|
public async Task GetInstancesPaged_FiltersOrdersAndPages()
|
|
{
|
|
var site1 = new Site("Site1", "S-001");
|
|
var site2 = new Site("Site2", "S-002");
|
|
var template = new Template("T1");
|
|
_context.Sites.AddRange(site1, site2);
|
|
_context.Templates.Add(template);
|
|
await _context.SaveChangesAsync();
|
|
|
|
_context.Instances.AddRange(
|
|
new Instance("Pump3") { SiteId = site1.Id, TemplateId = template.Id },
|
|
new Instance("Pump1") { SiteId = site1.Id, TemplateId = template.Id },
|
|
new Instance("Pump2") { SiteId = site2.Id, TemplateId = template.Id },
|
|
new Instance("XPump") { SiteId = site1.Id, TemplateId = template.Id });
|
|
await _context.SaveChangesAsync();
|
|
|
|
var (rows, total) = await _repository.GetInstancesPagedAsync(null, null, "Pump", 1, 2);
|
|
Assert.Equal(3, total);
|
|
Assert.Equal(new[] { "Pump2", "Pump3" }, rows.Select(r => r.UniqueName));
|
|
|
|
var (scoped, scopedTotal) = await _repository.GetInstancesPagedAsync(new[] { site1.Id }, template.Id, "Pump", 0, 10);
|
|
Assert.Equal(2, scopedTotal);
|
|
Assert.Equal(new[] { "Pump1", "Pump3" }, scoped.Select(r => r.UniqueName));
|
|
|
|
var (none, noneTotal) = await _repository.GetInstancesPagedAsync(Array.Empty<int>(), null, null, 0, 10);
|
|
Assert.Empty(none);
|
|
Assert.Equal(0, noneTotal);
|
|
}
|
|
|
|
/// <summary>Verifies that audit log entries can be filtered by user.</summary>
|
|
/// <returns>A task that represents the asynchronous operation.</returns>
|
|
[Fact]
|
|
public async Task GetAuditLogEntries_FiltersByUser()
|
|
{
|
|
_context.AuditLogEntries.AddRange(
|
|
new AuditLogEntry("admin", "Create", "Template", "1", "T1") { Timestamp = DateTimeOffset.UtcNow },
|
|
new AuditLogEntry("user1", "Update", "Instance", "2", "I1") { Timestamp = DateTimeOffset.UtcNow });
|
|
await _context.SaveChangesAsync();
|
|
|
|
var (entries, total) = await _repository.GetAuditLogEntriesAsync(user: "admin");
|
|
Assert.Single(entries);
|
|
Assert.Equal(1, total);
|
|
Assert.Equal("admin", entries[0].User);
|
|
}
|
|
|
|
/// <summary>Verifies that audit log entries can be filtered by entity type.</summary>
|
|
/// <returns>A task that represents the asynchronous operation.</returns>
|
|
[Fact]
|
|
public async Task GetAuditLogEntries_FiltersByEntityType()
|
|
{
|
|
_context.AuditLogEntries.AddRange(
|
|
new AuditLogEntry("admin", "Create", "Template", "1", "T1") { Timestamp = DateTimeOffset.UtcNow },
|
|
new AuditLogEntry("admin", "Create", "Instance", "2", "I1") { Timestamp = DateTimeOffset.UtcNow });
|
|
await _context.SaveChangesAsync();
|
|
|
|
var (entries, total) = await _repository.GetAuditLogEntriesAsync(entityType: "Template");
|
|
Assert.Single(entries);
|
|
Assert.Equal(1, total);
|
|
}
|
|
|
|
/// <summary>Verifies that audit log entries can be filtered by action type.</summary>
|
|
/// <returns>A task that represents the asynchronous operation.</returns>
|
|
[Fact]
|
|
public async Task GetAuditLogEntries_FiltersByActionType()
|
|
{
|
|
_context.AuditLogEntries.AddRange(
|
|
new AuditLogEntry("admin", "Create", "Template", "1", "T1") { Timestamp = DateTimeOffset.UtcNow },
|
|
new AuditLogEntry("admin", "Delete", "Template", "2", "T2") { Timestamp = DateTimeOffset.UtcNow });
|
|
await _context.SaveChangesAsync();
|
|
|
|
var (entries, total) = await _repository.GetAuditLogEntriesAsync(action: "Delete");
|
|
Assert.Single(entries);
|
|
}
|
|
|
|
/// <summary>Verifies that audit log entries can be filtered by time range.</summary>
|
|
/// <returns>A task that represents the asynchronous operation.</returns>
|
|
[Fact]
|
|
public async Task GetAuditLogEntries_FiltersByTimeRange()
|
|
{
|
|
var now = DateTimeOffset.UtcNow;
|
|
_context.AuditLogEntries.AddRange(
|
|
new AuditLogEntry("admin", "Create", "Template", "1", "T1") { Timestamp = now.AddHours(-5) },
|
|
new AuditLogEntry("admin", "Update", "Template", "2", "T2") { Timestamp = now.AddHours(-1) });
|
|
await _context.SaveChangesAsync();
|
|
|
|
var (entries, total) = await _repository.GetAuditLogEntriesAsync(from: now.AddHours(-2));
|
|
Assert.Single(entries);
|
|
}
|
|
|
|
/// <summary>Verifies that audit log entries can be filtered by entity id.</summary>
|
|
/// <returns>A task that represents the asynchronous operation.</returns>
|
|
[Fact]
|
|
public async Task GetAuditLogEntries_FiltersByEntityId()
|
|
{
|
|
_context.AuditLogEntries.AddRange(
|
|
new AuditLogEntry("admin", "Create", "Template", "1", "T1") { Timestamp = DateTimeOffset.UtcNow },
|
|
new AuditLogEntry("admin", "Create", "Template", "2", "T2") { Timestamp = DateTimeOffset.UtcNow });
|
|
await _context.SaveChangesAsync();
|
|
|
|
var (entries, total) = await _repository.GetAuditLogEntriesAsync(entityId: "1");
|
|
Assert.Single(entries);
|
|
}
|
|
|
|
/// <summary>Verifies that audit log entries can be filtered by entity name.</summary>
|
|
/// <returns>A task that represents the asynchronous operation.</returns>
|
|
[Fact]
|
|
public async Task GetAuditLogEntries_FiltersByEntityName()
|
|
{
|
|
_context.AuditLogEntries.AddRange(
|
|
new AuditLogEntry("admin", "Create", "Template", "1", "PumpStation") { Timestamp = DateTimeOffset.UtcNow },
|
|
new AuditLogEntry("admin", "Create", "Template", "2", "TankLevel") { Timestamp = DateTimeOffset.UtcNow });
|
|
await _context.SaveChangesAsync();
|
|
|
|
var (entries, total) = await _repository.GetAuditLogEntriesAsync(entityName: "Pump");
|
|
Assert.Single(entries);
|
|
}
|
|
|
|
/// <summary>Verifies that audit log entries can be filtered by bundle import id.</summary>
|
|
/// <returns>A task that represents the asynchronous operation.</returns>
|
|
[Fact]
|
|
public async Task GetAuditLogEntries_FiltersByBundleImportId()
|
|
{
|
|
// T24 — Bundle Import filter on the Configuration Audit Log page is
|
|
// backed by the new optional bundleImportId arg on the repo query.
|
|
// Only rows stamped with the given id should come back.
|
|
var importA = Guid.NewGuid();
|
|
var importB = Guid.NewGuid();
|
|
_context.AuditLogEntries.AddRange(
|
|
new AuditLogEntry("admin", "Create", "Template", "1", "T1")
|
|
{ Timestamp = DateTimeOffset.UtcNow, BundleImportId = importA },
|
|
new AuditLogEntry("admin", "Create", "Template", "2", "T2")
|
|
{ Timestamp = DateTimeOffset.UtcNow, BundleImportId = importB },
|
|
new AuditLogEntry("admin", "Update", "Template", "3", "T3")
|
|
{ Timestamp = DateTimeOffset.UtcNow });
|
|
await _context.SaveChangesAsync();
|
|
|
|
var (entries, total) = await _repository.GetAuditLogEntriesAsync(bundleImportId: importA);
|
|
Assert.Single(entries);
|
|
Assert.Equal(1, total);
|
|
Assert.Equal(importA, entries[0].BundleImportId);
|
|
}
|
|
|
|
/// <summary>Verifies that audit log entries are returned in reverse chronological order with pagination.</summary>
|
|
/// <returns>A task that represents the asynchronous operation.</returns>
|
|
[Fact]
|
|
public async Task GetAuditLogEntries_ReverseChronologicalWithPagination()
|
|
{
|
|
var now = DateTimeOffset.UtcNow;
|
|
for (int i = 0; i < 10; i++)
|
|
{
|
|
_context.AuditLogEntries.Add(new AuditLogEntry("admin", "Create", "Template", i.ToString(), $"T{i}")
|
|
{
|
|
Timestamp = now.AddMinutes(i)
|
|
});
|
|
}
|
|
await _context.SaveChangesAsync();
|
|
|
|
var (page1, total) = await _repository.GetAuditLogEntriesAsync(page: 1, pageSize: 3);
|
|
Assert.Equal(10, total);
|
|
Assert.Equal(3, page1.Count);
|
|
Assert.Equal("T9", page1[0].EntityName); // Most recent first
|
|
|
|
var (page2, _) = await _repository.GetAuditLogEntriesAsync(page: 2, pageSize: 3);
|
|
Assert.Equal(3, page2.Count);
|
|
Assert.Equal("T6", page2[0].EntityName);
|
|
}
|
|
|
|
/// <summary>Entries sharing one Timestamp page deterministically (Id tie-break) with no repeats or gaps (review 08/P5).</summary>
|
|
/// <returns>A task that represents the asynchronous operation.</returns>
|
|
[Fact]
|
|
public async Task GetAuditLogEntries_SameTimestamp_PagesDeterministicallyWithoutOverlap()
|
|
{
|
|
var ts = DateTimeOffset.UtcNow;
|
|
for (var i = 0; i < 10; i++)
|
|
_context.AuditLogEntries.Add(new AuditLogEntry("admin", "Create", "Template", i.ToString(), $"T{i}") { Timestamp = ts });
|
|
await _context.SaveChangesAsync();
|
|
|
|
var seen = new List<int>();
|
|
for (var page = 1; page <= 4; page++)
|
|
{
|
|
var (entries, _) = await _repository.GetAuditLogEntriesAsync(page: page, pageSize: 3);
|
|
seen.AddRange(entries.Select(e => e.Id));
|
|
}
|
|
|
|
Assert.Equal(10, seen.Distinct().Count());
|
|
Assert.Equal(seen.OrderByDescending(x => x), seen);
|
|
}
|
|
|
|
/// <summary>Verifies that the area tree returns the area hierarchy.</summary>
|
|
/// <returns>A task that represents the asynchronous operation.</returns>
|
|
[Fact]
|
|
public async Task GetAreaTree_ReturnsHierarchy()
|
|
{
|
|
var site = new Site("Site1", "S-001");
|
|
_context.Sites.Add(site);
|
|
await _context.SaveChangesAsync();
|
|
|
|
var parent = new Area("Building A") { SiteId = site.Id };
|
|
_context.Areas.Add(parent);
|
|
await _context.SaveChangesAsync();
|
|
|
|
var child = new Area("Floor 1") { SiteId = site.Id, ParentAreaId = parent.Id };
|
|
_context.Areas.Add(child);
|
|
await _context.SaveChangesAsync();
|
|
|
|
var areas = await _repository.GetAreaTreeBySiteIdAsync(site.Id);
|
|
Assert.Equal(2, areas.Count);
|
|
}
|
|
}
|