elsa-core/test/integration/Elsa.Diagnostics.ConsoleLogs.IntegrationTests/ConsoleLogsAuthorizationTests.cs
Sipke Schoorstra 5245599131
Enhance console logging with improved context and lifecycle (#7536)
* Avoid null endpoint DTO metadata in tests

* Enforce console logs hub read permission

* Remove unused console logs hub import

* Support mapped endpoint metadata in auth tests

* Reduce console log capture throughput impact

* Address Copilot console logs review

* Refactor task scheduling to support tenant-level background work and enhance logging functionality.

* Introduce ConsoleStreamHook for stdout/stderr tee and enhance logging validation. Adjust test cases and startup warnings for distributed lock provider usage.

* Refactor console logging pipeline with capture optimization and new ConsoleLogsHost; update tests accordingly.

* Add Ansi SGR parser for console logs and associated unit tests

* Remove ANSI color renderings and parsers; integrate ConsoleLogScopeAccessor for improved logging context with workflow instance ID support.

* Address console logs code quality feedback

* Address PR review feedback

* Preserve console logs extension points

* Stabilize console logs host lifecycle

* Address final automated review comments

* Tighten console log capture shutdown

* Address console log review feedback

* Address follow-up review feedback

* Cover final review feedback

* Avoid recursive console provider initialization

* Guard console host lease shutdown

* Preserve console log scope and provider lifetime

* Correlate console log scope fallback

* Tighten console scope correlation

* Expose host services during provider construction

* Redact ANSI-normalized console lines

* Remove `ConsoleCaptureTee` and related services and tests

* Use pipeline contributors for console log context

* Update CShells package versions to 0.0.24-preview.132

* Filter live console logs by workflow instance

* Enhance console logging with activity execution metadata and extend test coverage.

* Address console logs stream consumption comment
2026-05-27 00:14:28 +02:00

359 lines
15 KiB
C#

using System.Reflection;
using System.Security.Claims;
using System.Text.Json;
using ConsoleLogStreaming.Contracts;
using ConsoleLogStreaming.Core;
using ConsoleLogStreaming.SignalR;
using Elsa.Diagnostics.ConsoleLogs.Contracts;
using Elsa.Diagnostics.ConsoleLogs.Features;
using Elsa.Diagnostics.ConsoleLogs.Permissions;
using Elsa.Diagnostics.ConsoleLogs.RealTime;
using Elsa.Diagnostics.ConsoleLogs.Services;
using FastEndpoints;
using Microsoft.AspNetCore.Http.Features;
using Microsoft.AspNetCore.SignalR;
using Microsoft.Extensions.Logging.Abstractions;
namespace Elsa.Diagnostics.ConsoleLogs.IntegrationTests;
public class ConsoleLogsAuthorizationTests
{
[Fact]
public async Task HubSubscribe_WithoutConsoleLogsPermission_DeniesAccess()
{
var hub = CreateHub("write:diagnostics:console-logs");
await Assert.ThrowsAsync<HubException>(() => hub.SubscribeAsync(new()));
}
[Fact]
public async Task HubUpdateFilter_WithoutConsoleLogsPermission_DeniesAccess()
{
var hub = CreateHub("write:diagnostics:console-logs");
await Assert.ThrowsAsync<HubException>(() => hub.UpdateFilterAsync(new()));
}
[Theory]
[InlineData(ConsoleLogsPermissions.Read)]
[InlineData(PermissionNames.All)]
[InlineData("read:*")]
public async Task HubSubscribe_WithConsoleLogsPermission_AllowsAccess(string permission)
{
var hub = CreateHub(permission);
await hub.SubscribeAsync(new());
}
[Theory]
[InlineData("Elsa.Diagnostics.ConsoleLogs.Endpoints.ConsoleLogs.Recent.Endpoint")]
[InlineData("Elsa.Diagnostics.ConsoleLogs.Endpoints.ConsoleLogs.Sources.Endpoint")]
public void RestEndpoints_RequireConsoleLogsPermission(string endpointTypeName)
{
var permissions = GetConfiguredPermissions(endpointTypeName);
Assert.Contains(ConsoleLogsPermissions.Read, permissions);
}
[Fact]
public async Task RecentEndpoint_MapsWorkflowInstanceIdToMetadataFilter()
{
var endpointType = typeof(ConsoleLogsFeature).Assembly.GetType("Elsa.Diagnostics.ConsoleLogs.Endpoints.ConsoleLogs.Recent.Endpoint", throwOnError: true)!;
var provider = new TestConsoleLogProvider();
var endpoint = Activator.CreateInstance(endpointType, provider, new ConsoleLogStreamingApiMapper())!;
var (requestDtoType, _) = GetEndpointDtoTypes(endpointType);
var request = JsonSerializer.Deserialize(
"""
{
"workflowInstanceId": "workflow-instance-a"
}
""",
requestDtoType,
new JsonSerializerOptions { PropertyNameCaseInsensitive = true })!;
var result = endpointType.GetMethod("ExecuteAsync")!.Invoke(endpoint, [request, CancellationToken.None]);
await Assert.IsAssignableFrom<Task>(result);
Assert.NotNull(provider.LastFilter);
var metadata = provider.LastFilter.Metadata;
Assert.True(metadata.TryGetValue(ConsoleLogMetadataKeys.WorkflowInstanceId, out var workflowInstanceId));
Assert.Equal("workflow-instance-a", workflowInstanceId);
}
[Fact]
public async Task RecentEndpoint_MapsActivityFiltersToMetadataFilter()
{
var endpointType = typeof(ConsoleLogsFeature).Assembly.GetType("Elsa.Diagnostics.ConsoleLogs.Endpoints.ConsoleLogs.Recent.Endpoint", throwOnError: true)!;
var provider = new TestConsoleLogProvider();
var endpoint = Activator.CreateInstance(endpointType, provider, new ConsoleLogStreamingApiMapper())!;
var (requestDtoType, _) = GetEndpointDtoTypes(endpointType);
var request = JsonSerializer.Deserialize(
"""
{
"workflowInstanceId": "workflow-instance-a",
"activityInstanceId": "activity-instance-a",
"activityId": "activity-a",
"activityNodeId": "node-a"
}
""",
requestDtoType,
new JsonSerializerOptions { PropertyNameCaseInsensitive = true })!;
var result = endpointType.GetMethod("ExecuteAsync")!.Invoke(endpoint, [request, CancellationToken.None]);
await Assert.IsAssignableFrom<Task>(result);
Assert.NotNull(provider.LastFilter);
AssertActivityMetadata(provider.LastFilter.Metadata);
}
[Fact]
public async Task HubStream_MapsWorkflowInstanceIdToMetadataFilter()
{
var provider = new TestConsoleLogProvider();
var hub = CreateHub(provider, ConsoleLogsPermissions.Read);
await foreach (var _ in hub.StreamAsync(new ElsaConsoleLogFilter { WorkflowInstanceId = "workflow-instance-a" }, CancellationToken.None))
{
// Intentionally consume the stream to trigger provider subscription/filter mapping side effects.
}
Assert.NotNull(provider.LastSubscriptionFilter);
var metadata = provider.LastSubscriptionFilter.Metadata;
Assert.True(metadata.TryGetValue(ConsoleLogMetadataKeys.WorkflowInstanceId, out var workflowInstanceId));
Assert.Equal("workflow-instance-a", workflowInstanceId);
}
[Fact]
public async Task HubStream_MapsActivityFiltersToMetadataFilter()
{
var provider = new TestConsoleLogProvider();
var hub = CreateHub(provider, ConsoleLogsPermissions.Read);
await foreach (var _ in hub.StreamAsync(new ElsaConsoleLogFilter
{
WorkflowInstanceId = "workflow-instance-a",
ActivityInstanceId = "activity-instance-a",
ActivityId = "activity-a",
ActivityNodeId = "node-a"
}, CancellationToken.None))
{
}
Assert.NotNull(provider.LastSubscriptionFilter);
AssertActivityMetadata(provider.LastSubscriptionFilter.Metadata);
}
[Fact]
public async Task HubSubscribe_MapsWorkflowInstanceIdToMetadataFilter()
{
var provider = new TestConsoleLogProvider();
var hub = CreateHub(provider, ConsoleLogsPermissions.Read);
await hub.SubscribeAsync(new ElsaConsoleLogFilter { WorkflowInstanceId = "workflow-instance-a" });
var filter = await provider.WaitForSubscriptionFilterAsync();
var metadata = filter.Metadata;
Assert.True(metadata.TryGetValue(ConsoleLogMetadataKeys.WorkflowInstanceId, out var workflowInstanceId));
Assert.Equal("workflow-instance-a", workflowInstanceId);
await hub.UnsubscribeAsync();
}
private static void AssertActivityMetadata(IReadOnlyDictionary<string, string> metadata)
{
Assert.Equal("workflow-instance-a", metadata[ConsoleLogMetadataKeys.WorkflowInstanceId]);
Assert.Equal("activity-instance-a", metadata[ConsoleLogMetadataKeys.ActivityInstanceId]);
Assert.Equal("activity-a", metadata[ConsoleLogMetadataKeys.ActivityId]);
Assert.Equal("node-a", metadata[ConsoleLogMetadataKeys.ActivityNodeId]);
}
private static IReadOnlyCollection<string> GetConfiguredPermissions(string endpointTypeName)
{
var endpointType = typeof(ConsoleLogsFeature).Assembly.GetType(endpointTypeName, throwOnError: true)!;
var mapper = new ConsoleLogStreamingApiMapper();
var endpoint = endpointTypeName.EndsWith(".Recent.Endpoint", StringComparison.Ordinal)
? Activator.CreateInstance(endpointType, new TestConsoleLogProvider(), mapper)!
: Activator.CreateInstance(endpointType, new TestConsoleLogProvider(), mapper)!;
var (requestDtoType, responseDtoType) = GetEndpointDtoTypes(endpointType);
var definition = new EndpointDefinition(endpointType, requestDtoType, responseDtoType);
endpointType
.GetProperty("Definition", BindingFlags.Instance | BindingFlags.Public | BindingFlags.NonPublic)!
.SetValue(endpoint, definition);
endpointType.GetMethod("Configure")!.Invoke(endpoint, null);
var permissions = definition
.GetType()
.GetProperty("AllowedPermissions", BindingFlags.Instance | BindingFlags.Public | BindingFlags.NonPublic)!
.GetValue(definition);
return Assert.IsAssignableFrom<IEnumerable<string>>(permissions).ToArray();
}
private static (Type RequestDtoType, Type ResponseDtoType) GetEndpointDtoTypes(Type endpointType)
{
var type = endpointType;
while (type.BaseType != null)
{
type = type.BaseType;
if (!type.IsGenericType)
continue;
var genericTypeDefinition = type.GetGenericTypeDefinition();
var genericArguments = type.GetGenericArguments();
if (genericTypeDefinition == typeof(Elsa.Abstractions.ElsaEndpoint<,>))
return (genericArguments[0], genericArguments[1]);
if (genericTypeDefinition == typeof(Elsa.Abstractions.ElsaEndpoint<,,>))
return (genericArguments[0], genericArguments[1]);
if (genericTypeDefinition == typeof(Elsa.Abstractions.ElsaEndpointWithoutRequest<>))
return (typeof(EmptyRequest), genericArguments[0]);
}
throw new InvalidOperationException($"Unsupported endpoint type '{endpointType.FullName}'.");
}
private static ElsaConsoleLogsHub CreateHub(params string[] permissions)
{
return CreateHub(new TestConsoleLogProvider(), permissions);
}
private static ElsaConsoleLogsHub CreateHub(TestConsoleLogProvider provider, params string[] permissions)
{
var sourceRegistry = new TestConsoleLogSourceRegistry();
var mapper = new ConsoleLogStreamingApiMapper();
var hubContext = new TestHubContext();
var subscriptionManager = new ElsaConsoleLogSubscriptionManager(provider, sourceRegistry, mapper, hubContext, NullLogger<ElsaConsoleLogSubscriptionManager>.Instance);
var authorizer = new ElsaConsoleLogStreamingHubAuthorizer();
return new ElsaConsoleLogsHub(provider, mapper, authorizer, subscriptionManager)
{
Context = new TestHubCallerContext(CreateUser(permissions))
};
}
private static ClaimsPrincipal CreateUser(params string[] permissions)
{
var permissionClaimType = (string)typeof(SecurityOptions)
.GetProperty(nameof(SecurityOptions.PermissionsClaimType))!
.GetValue(new Config().Security)!;
var claims = permissions.Select(x => new Claim(permissionClaimType, x));
var identity = new ClaimsIdentity(claims, "Test");
return new ClaimsPrincipal(identity);
}
private class TestConsoleLogProvider : IConsoleLogProvider
{
private readonly TaskCompletionSource<ConsoleLogStreaming.Core.Models.ConsoleLogFilter> _subscriptionFilterSet = new(TaskCreationOptions.RunContinuationsAsynchronously);
public ConsoleLogStreaming.Core.Models.ConsoleLogFilter? LastFilter { get; private set; }
public ConsoleLogStreaming.Core.Models.ConsoleLogFilter? LastSubscriptionFilter { get; private set; }
public Task<ConsoleLogStreaming.Core.Models.ConsoleLogFilter> WaitForSubscriptionFilterAsync() =>
_subscriptionFilterSet.Task.WaitAsync(TimeSpan.FromSeconds(5));
public ValueTask PublishAsync(ConsoleLogStreaming.Core.Models.ConsoleLogLine line, CancellationToken cancellationToken = default)
{
return ValueTask.CompletedTask;
}
public ValueTask<ConsoleLogStreaming.Core.Models.RecentConsoleLogsResult> GetRecentAsync(ConsoleLogStreaming.Core.Models.ConsoleLogFilter filter, CancellationToken cancellationToken = default)
{
LastFilter = filter;
return ValueTask.FromResult(new ConsoleLogStreaming.Core.Models.RecentConsoleLogsResult());
}
public IAsyncEnumerable<ConsoleLogStreaming.Core.Models.ConsoleLogStreamingItem> SubscribeAsync(
ConsoleLogStreaming.Core.Models.ConsoleLogFilter filter,
CancellationToken cancellationToken = default)
{
LastSubscriptionFilter = filter;
_subscriptionFilterSet.TrySetResult(filter);
return AsyncEnumerable.Empty<ConsoleLogStreaming.Core.Models.ConsoleLogStreamingItem>();
}
public ValueTask<IReadOnlyCollection<ConsoleLogStreaming.Core.Models.ConsoleLogSource>> ListSourcesAsync(CancellationToken cancellationToken = default)
{
return ValueTask.FromResult<IReadOnlyCollection<ConsoleLogStreaming.Core.Models.ConsoleLogSource>>([]);
}
}
private class TestConsoleLogSourceRegistry : IConsoleLogSourceRegistry
{
public event Action<ConsoleLogStreaming.Core.Models.ConsoleLogSource>? SourceChanged
{
add { }
remove { }
}
public ConsoleLogStreaming.Core.Models.ConsoleLogSource Current { get; } = new()
{
Id = "test",
DisplayName = "Test"
};
public ConsoleLogStreaming.Core.Models.ConsoleLogSource MarkSeen(ConsoleLogStreaming.Core.Models.ConsoleLogSource source, DateTimeOffset timestamp)
{
return source with { LastSeen = timestamp };
}
public IReadOnlyCollection<ConsoleLogStreaming.Core.Models.ConsoleLogSource> List()
{
return [Current];
}
}
private class TestHubContext : IHubContext<ElsaConsoleLogsHub, IConsoleLogsClient>
{
public IHubClients<IConsoleLogsClient> Clients { get; } = new TestHubClients();
public IGroupManager Groups { get; } = new TestGroupManager();
}
private class TestHubClients : IHubClients<IConsoleLogsClient>
{
public IConsoleLogsClient All => throw new NotSupportedException();
public IConsoleLogsClient AllExcept(IReadOnlyList<string> excludedConnectionIds) => throw new NotSupportedException();
public IConsoleLogsClient Client(string connectionId) => throw new NotSupportedException();
public IConsoleLogsClient Clients(IReadOnlyList<string> connectionIds) => throw new NotSupportedException();
public IConsoleLogsClient Group(string groupName) => throw new NotSupportedException();
public IConsoleLogsClient GroupExcept(string groupName, IReadOnlyList<string> excludedConnectionIds) => throw new NotSupportedException();
public IConsoleLogsClient Groups(IReadOnlyList<string> groupNames) => throw new NotSupportedException();
public IConsoleLogsClient User(string userId) => throw new NotSupportedException();
public IConsoleLogsClient Users(IReadOnlyList<string> userIds) => throw new NotSupportedException();
}
private class TestGroupManager : IGroupManager
{
public Task AddToGroupAsync(string connectionId, string groupName, CancellationToken cancellationToken = default)
{
return Task.CompletedTask;
}
public Task RemoveFromGroupAsync(string connectionId, string groupName, CancellationToken cancellationToken = default)
{
return Task.CompletedTask;
}
}
private class TestHubCallerContext(ClaimsPrincipal user) : HubCallerContext
{
public override string ConnectionId { get; } = "connection-1";
public override string? UserIdentifier { get; } = "user-1";
public override ClaimsPrincipal? User { get; } = user;
public override IDictionary<object, object?> Items { get; } = new Dictionary<object, object?>();
public override IFeatureCollection Features { get; } = new FeatureCollection();
public override CancellationToken ConnectionAborted { get; } = CancellationToken.None;
public override void Abort()
{
}
}
}