|
| 1 | +using System.Security.Claims; |
| 2 | +using Elsa.Common.Multitenancy; |
| 3 | +using Elsa.Workflows.Api.RealTime.Hubs; |
| 4 | +using Elsa.Workflows.Management; |
| 5 | +using Elsa.Workflows.Management.Entities; |
| 6 | +using Elsa.Workflows.Management.Filters; |
| 7 | +using FastEndpoints; |
| 8 | +using Microsoft.AspNetCore.SignalR; |
| 9 | +using NSubstitute; |
| 10 | + |
| 11 | +namespace Elsa.Workflows.Api.UnitTests.RealTime.Hubs; |
| 12 | + |
| 13 | +[Collection(nameof(WorkflowInstanceHubTestsCollection))] |
| 14 | +public class WorkflowInstanceHubTests : IDisposable |
| 15 | +{ |
| 16 | + private const string ConnectionId = "connection-1"; |
| 17 | + private const string WorkflowInstanceId = "workflow-instance-1"; |
| 18 | + private const string TenantId = "tenant-a"; |
| 19 | + private const string OtherTenantId = "tenant-b"; |
| 20 | + private const string ReadWorkflowInstancesPermission = "read:workflow-instances"; |
| 21 | + private const string CustomPermissionsClaimType = "elsa-permissions"; |
| 22 | + private readonly IWorkflowInstanceStore _workflowInstanceStore; |
| 23 | + private readonly ITenantAccessor _tenantAccessor; |
| 24 | + private readonly IGroupManager _groups; |
| 25 | + private readonly HubCallerContext _context; |
| 26 | + private readonly WorkflowInstanceHub _hub; |
| 27 | + private readonly string _originalPermissionsClaimType; |
| 28 | + private readonly CancellationTokenSource _connectionAbortedTokenSource = new(); |
| 29 | + private WorkflowInstance? _workflowInstance; |
| 30 | + |
| 31 | + public WorkflowInstanceHubTests() |
| 32 | + { |
| 33 | + _originalPermissionsClaimType = GetPermissionsClaimType(); |
| 34 | + UsePermissionsClaimType("permissions"); |
| 35 | + _workflowInstanceStore = Substitute.For<IWorkflowInstanceStore>(); |
| 36 | + _tenantAccessor = Substitute.For<ITenantAccessor>(); |
| 37 | + _groups = Substitute.For<IGroupManager>(); |
| 38 | + _context = Substitute.For<HubCallerContext>(); |
| 39 | + _workflowInstance = CreateWorkflowInstance(TenantId); |
| 40 | + _hub = new WorkflowInstanceHub(_workflowInstanceStore, _tenantAccessor) |
| 41 | + { |
| 42 | + Context = _context, |
| 43 | + Groups = _groups |
| 44 | + }; |
| 45 | + |
| 46 | + _tenantAccessor.TenantId.Returns(TenantId); |
| 47 | + _context.ConnectionId.Returns(ConnectionId); |
| 48 | + _context.ConnectionAborted.Returns(_connectionAbortedTokenSource.Token); |
| 49 | + UseUser(ReadWorkflowInstancesPermission); |
| 50 | + StubWorkflowInstance(); |
| 51 | + } |
| 52 | + |
| 53 | + public void Dispose() |
| 54 | + { |
| 55 | + UsePermissionsClaimType(_originalPermissionsClaimType); |
| 56 | + _connectionAbortedTokenSource.Dispose(); |
| 57 | + } |
| 58 | + |
| 59 | + [Fact] |
| 60 | + public async Task ObserveInstanceAsync_WithReadPermissionAndMatchingTenant_JoinsInstanceGroup() |
| 61 | + { |
| 62 | + await _hub.ObserveInstanceAsync(WorkflowInstanceId); |
| 63 | + |
| 64 | + await _groups.Received(1).AddToGroupAsync(ConnectionId, WorkflowInstanceId, _connectionAbortedTokenSource.Token); |
| 65 | + } |
| 66 | + |
| 67 | + [Theory] |
| 68 | + [InlineData("*")] |
| 69 | + [InlineData("read:*")] |
| 70 | + public async Task ObserveInstanceAsync_WithWildcardReadPermission_JoinsInstanceGroup(string permission) |
| 71 | + { |
| 72 | + UseUser(permission); |
| 73 | + |
| 74 | + await _hub.ObserveInstanceAsync(WorkflowInstanceId); |
| 75 | + |
| 76 | + await _groups.Received(1).AddToGroupAsync(ConnectionId, WorkflowInstanceId, _connectionAbortedTokenSource.Token); |
| 77 | + } |
| 78 | + |
| 79 | + [Fact] |
| 80 | + public async Task ObserveInstanceAsync_UsesConfiguredFastEndpointsPermissionClaimType() |
| 81 | + { |
| 82 | + UsePermissionsClaimType(CustomPermissionsClaimType); |
| 83 | + UseUserClaim(CustomPermissionsClaimType, ReadWorkflowInstancesPermission); |
| 84 | + |
| 85 | + await _hub.ObserveInstanceAsync(WorkflowInstanceId); |
| 86 | + |
| 87 | + await _groups.Received(1).AddToGroupAsync(ConnectionId, WorkflowInstanceId, _connectionAbortedTokenSource.Token); |
| 88 | + } |
| 89 | + |
| 90 | + [Fact] |
| 91 | + public async Task ObserveInstanceAsync_WithoutReadPermission_DoesNotJoinInstanceGroup() |
| 92 | + { |
| 93 | + UseUser("write:workflow-instances"); |
| 94 | + |
| 95 | + await Assert.ThrowsAsync<HubException>(() => _hub.ObserveInstanceAsync(WorkflowInstanceId)); |
| 96 | + |
| 97 | + await _groups.DidNotReceive().AddToGroupAsync(Arg.Any<string>(), Arg.Any<string>(), Arg.Any<CancellationToken>()); |
| 98 | + } |
| 99 | + |
| 100 | + [Fact] |
| 101 | + public async Task ObserveInstanceAsync_WithDifferentTenant_DoesNotJoinInstanceGroup() |
| 102 | + { |
| 103 | + UseWorkflowInstanceTenant(OtherTenantId); |
| 104 | + |
| 105 | + await Assert.ThrowsAsync<HubException>(() => _hub.ObserveInstanceAsync(WorkflowInstanceId)); |
| 106 | + |
| 107 | + await _groups.DidNotReceive().AddToGroupAsync(Arg.Any<string>(), Arg.Any<string>(), Arg.Any<CancellationToken>()); |
| 108 | + } |
| 109 | + |
| 110 | + [Fact] |
| 111 | + public async Task ObserveInstanceAsync_WhenInstanceIsNotVisible_DoesNotJoinInstanceGroup() |
| 112 | + { |
| 113 | + UseWorkflowInstance(null); |
| 114 | + |
| 115 | + await Assert.ThrowsAsync<HubException>(() => _hub.ObserveInstanceAsync(WorkflowInstanceId)); |
| 116 | + |
| 117 | + await _groups.DidNotReceive().AddToGroupAsync(Arg.Any<string>(), Arg.Any<string>(), Arg.Any<CancellationToken>()); |
| 118 | + } |
| 119 | + |
| 120 | + [Fact] |
| 121 | + public async Task ObserveInstanceAsync_WithTenantAgnosticInstance_JoinsInstanceGroup() |
| 122 | + { |
| 123 | + UseWorkflowInstanceTenant(Tenant.AgnosticTenantId); |
| 124 | + |
| 125 | + await _hub.ObserveInstanceAsync(WorkflowInstanceId); |
| 126 | + |
| 127 | + await _groups.Received(1).AddToGroupAsync(ConnectionId, WorkflowInstanceId, _connectionAbortedTokenSource.Token); |
| 128 | + } |
| 129 | + |
| 130 | + [Fact] |
| 131 | + public async Task ObserveInstanceAsync_WithoutTenantAccessor_JoinsVisibleInstanceGroup() |
| 132 | + { |
| 133 | + var hub = new WorkflowInstanceHub(_workflowInstanceStore) |
| 134 | + { |
| 135 | + Context = _context, |
| 136 | + Groups = _groups |
| 137 | + }; |
| 138 | + |
| 139 | + await hub.ObserveInstanceAsync(WorkflowInstanceId); |
| 140 | + |
| 141 | + await _groups.Received(1).AddToGroupAsync(ConnectionId, WorkflowInstanceId, _connectionAbortedTokenSource.Token); |
| 142 | + } |
| 143 | + |
| 144 | + [Fact] |
| 145 | + public async Task ObserveInstanceAsync_WithNonCanonicalCurrentTenant_NormalizesBeforeComparing() |
| 146 | + { |
| 147 | + _tenantAccessor.TenantId.Returns(string.Empty); |
| 148 | + UseWorkflowInstanceTenant(null); |
| 149 | + |
| 150 | + await _hub.ObserveInstanceAsync(WorkflowInstanceId); |
| 151 | + |
| 152 | + await _groups.Received(1).AddToGroupAsync(ConnectionId, WorkflowInstanceId, _connectionAbortedTokenSource.Token); |
| 153 | + } |
| 154 | + |
| 155 | + private void UseUser(params string[] permissions) |
| 156 | + { |
| 157 | + var claims = permissions.Select(x => new Claim("permissions", x)); |
| 158 | + var identity = new ClaimsIdentity(claims, "Test"); |
| 159 | + _context.User.Returns(new ClaimsPrincipal(identity)); |
| 160 | + } |
| 161 | + |
| 162 | + private void UseUserClaim(string claimType, params string[] permissions) |
| 163 | + { |
| 164 | + var claims = permissions.Select(x => new Claim(claimType, x)); |
| 165 | + var identity = new ClaimsIdentity(claims, "Test"); |
| 166 | + _context.User.Returns(new ClaimsPrincipal(identity)); |
| 167 | + } |
| 168 | + |
| 169 | + private void UseWorkflowInstanceTenant(string? tenantId) |
| 170 | + { |
| 171 | + UseWorkflowInstance(CreateWorkflowInstance(tenantId)); |
| 172 | + } |
| 173 | + |
| 174 | + private void UseWorkflowInstance(WorkflowInstance? workflowInstance) |
| 175 | + { |
| 176 | + _workflowInstance = workflowInstance; |
| 177 | + StubWorkflowInstance(); |
| 178 | + } |
| 179 | + |
| 180 | + private void StubWorkflowInstance() |
| 181 | + { |
| 182 | + _workflowInstanceStore |
| 183 | + .FindAsync(Arg.Is<WorkflowInstanceFilter>(x => x.Id == WorkflowInstanceId), Arg.Any<CancellationToken>()) |
| 184 | + .Returns(_ => new ValueTask<WorkflowInstance?>(_workflowInstance)); |
| 185 | + } |
| 186 | + |
| 187 | + private static WorkflowInstance CreateWorkflowInstance(string? tenantId) |
| 188 | + { |
| 189 | + return new() |
| 190 | + { |
| 191 | + Id = WorkflowInstanceId, |
| 192 | + TenantId = tenantId, |
| 193 | + DefinitionId = "definition-1", |
| 194 | + DefinitionVersionId = "definition-version-1" |
| 195 | + }; |
| 196 | + } |
| 197 | + |
| 198 | + private static void UsePermissionsClaimType(string claimType) |
| 199 | + { |
| 200 | + var property = typeof(SecurityOptions).GetProperty(nameof(SecurityOptions.PermissionsClaimType))!; |
| 201 | + property.SetValue(new Config().Security, claimType); |
| 202 | + } |
| 203 | + |
| 204 | + private static string GetPermissionsClaimType() |
| 205 | + { |
| 206 | + var property = typeof(SecurityOptions).GetProperty(nameof(SecurityOptions.PermissionsClaimType))!; |
| 207 | + return (string)property.GetValue(new Config().Security)!; |
| 208 | + } |
| 209 | +} |
| 210 | + |
| 211 | +[CollectionDefinition(nameof(WorkflowInstanceHubTestsCollection), DisableParallelization = true)] |
| 212 | +public class WorkflowInstanceHubTestsCollection; |
0 commit comments