Files
ScadaBridge/tests/ZB.MOM.WW.ScadaBridge.Security.Tests/ScadaBridgeGroupRoleMapperTests.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

194 lines
9.5 KiB
C#

using ZB.MOM.WW.Auth.Abstractions.Roles;
using ZB.MOM.WW.ScadaBridge.Commons.Entities.Security;
using ZB.MOM.WW.ScadaBridge.Commons.Interfaces.Repositories;
using ZB.MOM.WW.ScadaBridge.Security;
namespace ZB.MOM.WW.ScadaBridge.Security.Tests;
#region Task 1.1: ScadaBridgeGroupRoleMapper (IGroupRoleMapper<string> seam)
public class ScadaBridgeGroupRoleMapperTests
{
// A minimal in-memory ISecurityRepository so the seam test needs no database.
// Only the two reads RoleMapper.MapGroupsToRolesAsync uses are implemented;
// the rest throw to make any accidental dependency on them obvious.
private sealed class FakeSecurityRepository : ISecurityRepository
{
private readonly IReadOnlyList<LdapGroupMapping> _mappings;
private readonly IReadOnlyDictionary<int, IReadOnlyList<SiteScopeRule>> _scopeRules;
/// <summary>Initializes the fake repository with fixed mappings and scope rules.</summary>
/// <param name="mappings">The LDAP group mappings to return.</param>
/// <param name="scopeRules">The site scope rules keyed by LDAP group mapping id.</param>
public FakeSecurityRepository(
IReadOnlyList<LdapGroupMapping> mappings,
IReadOnlyDictionary<int, IReadOnlyList<SiteScopeRule>> scopeRules)
{
_mappings = mappings;
_scopeRules = scopeRules;
}
/// <inheritdoc />
public Task<IReadOnlyList<LdapGroupMapping>> GetAllMappingsAsync(CancellationToken cancellationToken = default)
=> Task.FromResult(_mappings);
/// <inheritdoc />
public Task<IReadOnlyList<SiteScopeRule>> GetScopeRulesForMappingAsync(int ldapGroupMappingId, CancellationToken cancellationToken = default)
=> Task.FromResult(_scopeRules.TryGetValue(ldapGroupMappingId, out var rules)
? rules
: (IReadOnlyList<SiteScopeRule>)Array.Empty<SiteScopeRule>());
/// <inheritdoc />
public Task<LdapGroupMapping?> GetMappingByIdAsync(int id, CancellationToken cancellationToken = default)
=> throw new NotSupportedException();
/// <inheritdoc />
public Task<IReadOnlyList<LdapGroupMapping>> GetMappingsByRoleAsync(string role, CancellationToken cancellationToken = default)
=> throw new NotSupportedException();
/// <inheritdoc />
public Task AddMappingAsync(LdapGroupMapping mapping, CancellationToken cancellationToken = default)
=> throw new NotSupportedException();
/// <inheritdoc />
public Task UpdateMappingAsync(LdapGroupMapping mapping, CancellationToken cancellationToken = default)
=> throw new NotSupportedException();
/// <inheritdoc />
public Task DeleteMappingAsync(int id, CancellationToken cancellationToken = default)
=> throw new NotSupportedException();
/// <inheritdoc />
public Task<SiteScopeRule?> GetScopeRuleByIdAsync(int id, CancellationToken cancellationToken = default)
=> throw new NotSupportedException();
/// <inheritdoc />
public Task AddScopeRuleAsync(SiteScopeRule rule, CancellationToken cancellationToken = default)
=> throw new NotSupportedException();
/// <inheritdoc />
public Task UpdateScopeRuleAsync(SiteScopeRule rule, CancellationToken cancellationToken = default)
=> throw new NotSupportedException();
/// <inheritdoc />
public Task DeleteScopeRuleAsync(int id, CancellationToken cancellationToken = default)
=> throw new NotSupportedException();
/// <inheritdoc />
public Task<int> SaveChangesAsync(CancellationToken cancellationToken = default)
=> throw new NotSupportedException();
}
private static LdapGroupMapping Mapping(int id, string group, string role)
{
var m = new LdapGroupMapping(group, role);
m.Id = id;
return m;
}
/// <summary>Verifies that mapping returns the same roles as the role mapper and carries the result in a site-scoped scope.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task MapAsync_ReturnsSameRolesAsRoleMapper_AndCarriesResultInScope_SiteScoped()
{
// Two matched mappings: an Admin group and a site-scoped Deployment group.
var mappings = new List<LdapGroupMapping>
{
Mapping(1, "SCADA-Admins", Roles.Administrator),
Mapping(2, "SiteDeployers", Roles.Deployer),
};
var scopeRules = new Dictionary<int, IReadOnlyList<SiteScopeRule>>
{
[2] = new[]
{
new SiteScopeRule { LdapGroupMappingId = 2, SiteId = 11 },
new SiteScopeRule { LdapGroupMappingId = 2, SiteId = 22 },
},
};
var repo = new FakeSecurityRepository(mappings, scopeRules);
var roleMapper = new RoleMapper(repo);
var sut = new ScadaBridgeGroupRoleMapper(roleMapper);
var groups = new[] { "SCADA-Admins", "SiteDeployers" };
// The wrapped RoleMapper result is the oracle the seam must preserve.
var expected = await roleMapper.MapGroupsToRolesAsync(groups, CancellationToken.None);
var mapping = await sut.MapAsync(groups, CancellationToken.None);
// Roles: same set as RoleMapper.
Assert.Equal(expected.Roles.OrderBy(r => r), mapping.Roles.OrderBy(r => r));
Assert.Contains(Roles.Administrator, mapping.Roles);
Assert.Contains(Roles.Deployer, mapping.Roles);
// Scope: carries the full RoleMappingResult (no site-scope info lost).
var scope = Assert.IsType<RoleMappingResult>(mapping.Scope);
Assert.False(scope.IsSystemWideDeployment);
Assert.Contains("11", scope.PermittedSiteIds);
Assert.Contains("22", scope.PermittedSiteIds);
Assert.Equal(expected.PermittedSiteIds.OrderBy(s => s), scope.PermittedSiteIds.OrderBy(s => s));
Assert.Equal(expected.IsSystemWideDeployment, scope.IsSystemWideDeployment);
}
/// <summary>Verifies that mapping preserves the system-wide deployment flag in the scope.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task MapAsync_PreservesSystemWideDeploymentFlagInScope()
{
// Unscoped Deployment mapping -> system-wide, empty PermittedSiteIds.
var mappings = new List<LdapGroupMapping>
{
Mapping(1, "GlobalDeployers", Roles.Deployer),
};
var repo = new FakeSecurityRepository(mappings, new Dictionary<int, IReadOnlyList<SiteScopeRule>>());
var roleMapper = new RoleMapper(repo);
var sut = new ScadaBridgeGroupRoleMapper(roleMapper);
var mapping = await sut.MapAsync(new[] { "GlobalDeployers" }, CancellationToken.None);
Assert.Contains(Roles.Deployer, mapping.Roles);
var scope = Assert.IsType<RoleMappingResult>(mapping.Scope);
Assert.True(scope.IsSystemWideDeployment);
Assert.Empty(scope.PermittedSiteIds);
}
/// <summary>Verifies that mapping empty groups returns no roles and a non-null scope.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task MapAsync_EmptyGroups_ReturnsNoRoles_AndNonNullScope()
{
// Empty-groups case: a user that resolves to NO
// groups must map to NO roles and a non-null, not-system-wide Scope with no
// permitted sites — so the login endpoint can build a roleless principal (which
// every authorization policy then denies) without NRE-ing on Scope. This is the
// post-cutover home for the donor's "no mapped groups" outcome, now that the
// shared LDAP service fail-closes a zero-GROUP LDAP result before it ever reaches
// the mapper.
var repo = new FakeSecurityRepository(
new List<LdapGroupMapping> { Mapping(1, "SCADA-Admins", Roles.Administrator) },
new Dictionary<int, IReadOnlyList<SiteScopeRule>>());
var sut = new ScadaBridgeGroupRoleMapper(new RoleMapper(repo));
var mapping = await sut.MapAsync(Array.Empty<string>(), CancellationToken.None);
Assert.Empty(mapping.Roles);
var scope = Assert.IsType<RoleMappingResult>(mapping.Scope);
Assert.Empty(scope.Roles);
Assert.False(scope.IsSystemWideDeployment);
Assert.Empty(scope.PermittedSiteIds);
}
/// <summary>Verifies that mapping groups that match no mapping returns no roles.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task MapAsync_GroupsMatchNoMapping_ReturnsNoRoles()
{
// A user WITH groups that match no configured LDAP-group→role mapping likewise
// yields zero roles (not an error) — the mapper is the authoritative empty-roles
// boundary now that the LDAP service no longer admits zero-group successes.
var repo = new FakeSecurityRepository(
new List<LdapGroupMapping> { Mapping(1, "SCADA-Admins", Roles.Administrator) },
new Dictionary<int, IReadOnlyList<SiteScopeRule>>());
var sut = new ScadaBridgeGroupRoleMapper(new RoleMapper(repo));
var mapping = await sut.MapAsync(new[] { "some-unmapped-group" }, CancellationToken.None);
Assert.Empty(mapping.Roles);
var scope = Assert.IsType<RoleMappingResult>(mapping.Scope);
Assert.Empty(scope.PermittedSiteIds);
Assert.False(scope.IsSystemWideDeployment);
}
}
#endregion