Havret · Havret · Apr 8, 2024 · Apr 8, 2024
diff --git a/src/ArtemisNetCoreClient/ArtemisNetCoreClient.csproj b/src/ArtemisNetCoreClient/ArtemisNetCoreClient.csproj
@@ -13,4 +13,8 @@
         </AssemblyAttribute>
     </ItemGroup>
 
+    <ItemGroup>
+      <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="8.0.1" />
+    </ItemGroup>
+
 </Project>
diff --git a/src/ArtemisNetCoreClient/Session.cs b/src/ArtemisNetCoreClient/Session.cs
@@ -1,5 +1,6 @@
 using System.Collections.Concurrent;
 using ActiveMQ.Artemis.Core.Client.Framing;
+using Microsoft.Extensions.Logging;
 
 namespace ActiveMQ.Artemis.Core.Client;
 
@@ -10,9 +11,10 @@ internal class Session : ISession
     private readonly ConcurrentDictionary<long, TaskCompletionSource<Packet>> _completionSources = new();
     private readonly ConcurrentDictionary<long, Consumer> _consumers = new();
 
-    public Session(Transport transport)
+    public Session(Transport transport, ILoggerFactory loggerFactory)
     {
         _transport = transport;
+        var logger = loggerFactory.CreateLogger<Session>();
 
         // TODO: Clean up while loop on close
         _ = Task.Run(async () =>
@@ -40,12 +42,14 @@ public Session(Transport transport)
                 }
                 catch (Exception e)
                 {
+                    logger.LogError(e, "Error in packet processing or network communication");
                     // TODO: Handle exception
-                    Console.WriteLine(e);
                 }
             }
         });
     }
+
+    public long ChannelId { get; init; }
 
     public async Task CreateAddress(string address, IEnumerable<RoutingType> routingTypes, CancellationToken cancellationToken)
     {
@@ -65,8 +69,7 @@ public async Task CreateAddress(string address, IEnumerable<RoutingType> routing
         {
             Address = address
         };
-        var response =
-            await SendBlockingAsync<SessionBindingQueryMessage, SessionBindingQueryResponseMessageV5>(request, cancellationToken);
+        var response = await SendBlockingAsync<SessionBindingQueryMessage, SessionBindingQueryResponseMessageV5>(request, cancellationToken);
 
         if (response.Exists)
         {
@@ -196,8 +199,6 @@ internal async Task SendAsync<TRequest>(TRequest request, CancellationToken canc
         await _transport.SendAsync(request, ChannelId, cancellationToken);
     }
 
-    public long ChannelId { get; init; }
-
     public async Task StartAsync(CancellationToken cancellationToken)
     {
         await _transport.SendAsync(new SessionStart(), ChannelId, cancellationToken);

diff --git a/src/ArtemisNetCoreClient/SessionFactory.cs b/src/ArtemisNetCoreClient/SessionFactory.cs
@@ -1,6 +1,8 @@
 using System.Net;
 using System.Net.Sockets;
 using ActiveMQ.Artemis.Core.Client.Framing;
+using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Logging.Abstractions;
 
 namespace ActiveMQ.Artemis.Core.Client;
 
@@ -68,7 +70,7 @@ public async Task<ISession> CreateAsync(Endpoint endpoint, CancellationToken can
 
         if (receivedPacket is CreateSessionResponseMessage)
         {
-            var session = new Session(transport)
+            var session = new Session(transport, LoggerFactory)
             {
                 ChannelId = createSessionMessageV2.SessionChannelId
             };
@@ -80,4 +82,6 @@ public async Task<ISession> CreateAsync(Endpoint endpoint, CancellationToken can
             throw new InvalidOperationException("Received invalid response from the broker");
         }
     }
+
+    public ILoggerFactory LoggerFactory { get; set; } = new NullLoggerFactory();
 }
diff --git a/test/ArtemisNetCoreClient.Tests/ArtemisNetCoreClient.Tests.csproj b/test/ArtemisNetCoreClient.Tests/ArtemisNetCoreClient.Tests.csproj
@@ -10,6 +10,7 @@
     </PropertyGroup>
 
     <ItemGroup>
+        <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="8.0.1" />
         <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.6.0"/>
         <PackageReference Include="xunit" Version="2.4.2"/>
         <PackageReference Include="xunit.runner.visualstudio" Version="2.4.5">

diff --git a/...misNetCoreClient.Tests/ByteBufferTests.cs → ...emisNetCoreClient.Tests/ByteBufferSpec.cs b/...misNetCoreClient.Tests/ByteBufferTests.cs → ...emisNetCoreClient.Tests/ByteBufferSpec.cs
@@ -2,7 +2,7 @@
 
 namespace ActiveMQ.Artemis.Core.Client.Tests;
 
-public class ByteBufferTests
+public class ByteBufferSpec
 {
     [Fact]
     public void should_encode_byte()

diff --git a/...temisNetCoreClient.Tests/ConsumerTests.cs → ...rtemisNetCoreClient.Tests/ConsumerSpec.cs b/...temisNetCoreClient.Tests/ConsumerTests.cs → ...rtemisNetCoreClient.Tests/ConsumerSpec.cs
@@ -1,18 +1,19 @@
 using ActiveMQ.Artemis.Core.Client.Framing;
+using ActiveMQ.Artemis.Core.Client.Tests.Utils;
 using Xunit;
+using Xunit.Abstractions;
 
 namespace ActiveMQ.Artemis.Core.Client.Tests;
 
-public class ConsumerTests
+public class ConsumerSpec(ITestOutputHelper testOutputHelper)
 {
     [Fact]
     public async Task should_receive_message()
     {
         // Arrange
-        await using var testFixture = await TestFixture.CreateAsync();
+        await using var testFixture = await TestFixture.CreateAsync(testOutputHelper);
 
-        var connectionFactory = new SessionFactory();
-        await using var session = await connectionFactory.CreateAsync(testFixture.GetEndpoint(), testFixture.CancellationToken);
+        await using var session = await testFixture.CreateSessionAsync();
         var addressName = Guid.NewGuid().ToString();
         await session.CreateAddress(addressName, new[] { RoutingType.Anycast }, testFixture.CancellationToken);
 

diff --git a/...temisNetCoreClient.Tests/ProducerTests.cs → ...rtemisNetCoreClient.Tests/ProducerSpec.cs b/...temisNetCoreClient.Tests/ProducerTests.cs → ...rtemisNetCoreClient.Tests/ProducerSpec.cs
@@ -1,18 +1,19 @@
 using ActiveMQ.Artemis.Core.Client.Framing;
+using ActiveMQ.Artemis.Core.Client.Tests.Utils;
 using Xunit;
+using Xunit.Abstractions;
 
 namespace ActiveMQ.Artemis.Core.Client.Tests;
 
-public class ProducerTests
+public class ProducerSpec(ITestOutputHelper testOutputHelper)
 {
     [Fact]
     public async Task should_send_message()
     {
         // Arrange
-        await using var testFixture = await TestFixture.CreateAsync();
+        await using var testFixture = await TestFixture.CreateAsync(testOutputHelper);
 
-        var connectionFactory = new SessionFactory();
-        await using var session = await connectionFactory.CreateAsync(testFixture.GetEndpoint(), testFixture.CancellationToken);
+        await using var session = await testFixture.CreateSessionAsync();
         var addressName = Guid.NewGuid().ToString();
         await session.CreateAddress(addressName, new [] { RoutingType.Multicast }, testFixture.CancellationToken);
         await using var producer = await session.CreateProducerAsync(new ProducerConfiguration

diff --git a/...rtemisNetCoreClient.Tests/SessionTests.cs → ...ArtemisNetCoreClient.Tests/SessionSpec.cs b/...rtemisNetCoreClient.Tests/SessionTests.cs → ...ArtemisNetCoreClient.Tests/SessionSpec.cs
@@ -1,19 +1,21 @@
 using ActiveMQ.Artemis.Core.Client.Framing;
+using ActiveMQ.Artemis.Core.Client.Tests.Utils;
 using Xunit;
+using Xunit.Abstractions;
 
 namespace ActiveMQ.Artemis.Core.Client.Tests;
 
-public class SessionTests
+public class SessionSpec(ITestOutputHelper testOutputHelper)
 {
     [Fact]
     public async Task should_establish_session()
     {
         // Arrange
-        await using var testFixture = await TestFixture.CreateAsync();
+        await using var testFixture = await TestFixture.CreateAsync(testOutputHelper);
 
         // Act
         var connectionFactory = new SessionFactory();
-        var session = await connectionFactory.CreateAsync(testFixture.GetEndpoint(), testFixture.CancellationToken);
+        var session = await connectionFactory.CreateAsync(TestFixture.GetEndpoint(), testFixture.CancellationToken);
 
         // Assert
         Assert.NotNull(session);
@@ -27,10 +29,9 @@ public async Task should_establish_session()
     public async Task should_create_address_with_selected_routing_type(RoutingType[] routingTypes)
     {
         // Arrange
-        await using var testFixture = await TestFixture.CreateAsync();
+        await using var testFixture = await TestFixture.CreateAsync(testOutputHelper);
 
-        var connectionFactory = new SessionFactory();
-        await using var session = await connectionFactory.CreateAsync(testFixture.GetEndpoint(), testFixture.CancellationToken);
+        await using var session = await testFixture.CreateSessionAsync();
 
         // Act
         var addressName = $"{Guid.NewGuid().ToString()}-{string.Join("-", routingTypes)}";
@@ -49,10 +50,9 @@ public async Task should_create_address_with_selected_routing_type(RoutingType[]
     public async Task should_create_queue_with_selected_routing_type(RoutingType routingType)
     {
         // Arrange
-        await using var testFixture = await TestFixture.CreateAsync();
+        await using var testFixture = await TestFixture.CreateAsync(testOutputHelper);
 
-        var connectionFactory = new SessionFactory();
-        await using var session = await connectionFactory.CreateAsync(testFixture.GetEndpoint(), testFixture.CancellationToken);
+        await using var session = await testFixture.CreateSessionAsync();
         var addressName = Guid.NewGuid().ToString();
         await session.CreateAddress(addressName, [routingType], testFixture.CancellationToken);
 
@@ -77,10 +77,9 @@ await session.CreateQueue(new QueueConfiguration
     public async Task should_not_return_address_info_when_address_does_not_exist()
     {
         // Arrange
-        await using var testFixture = await TestFixture.CreateAsync();
+        await using var testFixture = await TestFixture.CreateAsync(testOutputHelper);
 
-        var connectionFactory = new SessionFactory();
-        await using var session = await connectionFactory.CreateAsync(testFixture.GetEndpoint(), testFixture.CancellationToken);
+        await using var session = await testFixture.CreateSessionAsync();
 
         // Act
         var addressName = Guid.NewGuid().ToString();
@@ -94,10 +93,9 @@ public async Task should_not_return_address_info_when_address_does_not_exist()
     public async Task should_not_return_queue_info_when_queue_does_not_exist()
     {
         // Arrange
-        await using var testFixture = await TestFixture.CreateAsync();
+        await using var testFixture = await TestFixture.CreateAsync(testOutputHelper);
 
-        var connectionFactory = new SessionFactory();
-        await using var session = await connectionFactory.CreateAsync(testFixture.GetEndpoint(), testFixture.CancellationToken);
+        await using var session = await testFixture.CreateSessionAsync();
 
         // Act
         var queueName = Guid.NewGuid().ToString();
@@ -111,10 +109,9 @@ public async Task should_not_return_queue_info_when_queue_does_not_exist()
     public async Task should_create_and_dispose_consumer()
     {
         // Arrange
-        await using var testFixture = await TestFixture.CreateAsync();
+        await using var testFixture = await TestFixture.CreateAsync(testOutputHelper);
 
-        var connectionFactory = new SessionFactory();
-        await using var session = await connectionFactory.CreateAsync(testFixture.GetEndpoint(), testFixture.CancellationToken);
+        await using var session = await testFixture.CreateSessionAsync();
 
         var addressName = Guid.NewGuid().ToString();
         await session.CreateAddress(addressName, new [] { RoutingType.Multicast }, testFixture.CancellationToken);
@@ -140,10 +137,9 @@ await session.CreateQueue(new QueueConfiguration
     public async Task should_create_and_dispose_producer()
     {
         // Arrange
-        await using var testFixture = await TestFixture.CreateAsync();
+        await using var testFixture = await TestFixture.CreateAsync(testOutputHelper);
 
-        var connectionFactory = new SessionFactory();
-        await using var session = await connectionFactory.CreateAsync(testFixture.GetEndpoint(), testFixture.CancellationToken);
+        await using var session = await testFixture.CreateSessionAsync();
         var addressName = Guid.NewGuid().ToString();
         await session.CreateAddress(addressName, new [] { RoutingType.Multicast }, testFixture.CancellationToken);
 

diff --git a/test/ArtemisNetCoreClient.Tests/Utils/Logging/XUnitLogger.cs b/test/ArtemisNetCoreClient.Tests/Utils/Logging/XUnitLogger.cs
@@ -0,0 +1,69 @@
+using Microsoft.Extensions.Logging;
+using Xunit.Abstractions;
+
+namespace ActiveMQ.Artemis.Core.Client.Tests.Utils.Logging;
+
+public sealed class XUnitLogger(ITestOutputHelper output, string name) : ILogger
+{
+    private static readonly string LoglevelPadding = ": ";
+    private static readonly string MessagePadding;
+
+    static XUnitLogger()
+    {
+        var logLevelString = GetLogLevelString(LogLevel.Information);
+        MessagePadding = new string(' ', logLevelString.Length + LoglevelPadding.Length);
+    }
+
+    public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception? exception, Func<TState, Exception?, string> formatter)
+    {
+        if (!IsEnabled(logLevel))
+        {
+            return;
+        }
+
+        var message = formatter(state, exception);
+
+        if (!string.IsNullOrEmpty(message) || exception != null)
+        {
+            WriteMessage(logLevel, name, message, exception);
+        }
+    }
+
+    public bool IsEnabled(LogLevel logLevel)
+    {
+        return logLevel != LogLevel.None;
+    }
+
+    IDisposable ILogger.BeginScope<TState>(TState state)
+    {
+        throw new NotSupportedException();
+    }
+
+    private void WriteMessage(LogLevel logLevel, string logName, string message, Exception? exception)
+    {
+        var logLevelString = GetLogLevelString(logLevel);
+
+        output.WriteLine($"{logLevelString}: {logName}");
+
+        if (!string.IsNullOrEmpty(message))
+        {
+            output.WriteLine($"{MessagePadding}{message}");
+        }
+
+        if (exception != null)
+        {
+            output.WriteLine(exception.ToString());
+        }
+    }
+
+    private static string GetLogLevelString(LogLevel logLevel) => logLevel switch
+    {
+        LogLevel.Trace => "trce",
+        LogLevel.Debug => "dbug",
+        LogLevel.Information => "info",
+        LogLevel.Warning => "warn",
+        LogLevel.Error => "fail",
+        LogLevel.Critical => "crit",
+        _ => throw new ArgumentOutOfRangeException(nameof(logLevel))
+    };
+}
diff --git a/test/ArtemisNetCoreClient.Tests/Utils/Logging/XUnitLoggerFactory.cs b/test/ArtemisNetCoreClient.Tests/Utils/Logging/XUnitLoggerFactory.cs
@@ -0,0 +1,27 @@
+using Microsoft.Extensions.Logging;
+using Xunit.Abstractions;
+
+namespace ActiveMQ.Artemis.Core.Client.Tests.Utils.Logging;
+
+public sealed class XUnitLoggerFactory : ILoggerFactory
+{
+    private readonly ITestOutputHelper _output;
+
+    public XUnitLoggerFactory(ITestOutputHelper output)
+    {
+        _output = output;
+    }
+
+    public ILogger CreateLogger(string categoryName)
+    {
+        return new XUnitLogger(_output, categoryName);
+    }
+
+    void IDisposable.Dispose()
+    {
+    }
+
+    void ILoggerFactory.AddProvider(ILoggerProvider provider)
+    {
+    }
+}
diff --git a/test/ArtemisNetCoreClient.Tests/Utils/Logging/XUnitLoggerProvider.cs b/test/ArtemisNetCoreClient.Tests/Utils/Logging/XUnitLoggerProvider.cs
@@ -0,0 +1,23 @@
+using Microsoft.Extensions.Logging;
+using Xunit.Abstractions;
+
+namespace ActiveMQ.Artemis.Core.Client.Tests.Utils.Logging;
+
+public class XUnitLoggerProvider : ILoggerProvider
+{
+    private readonly ITestOutputHelper _testOutputHelper;
+
+    public XUnitLoggerProvider(ITestOutputHelper testOutputHelper)
+    {
+        _testOutputHelper = testOutputHelper;
+    }
+
+    public ILogger CreateLogger(string categoryName)
+    {
+        return new XUnitLogger(_testOutputHelper, categoryName);
+    }
+
+    public void Dispose()
+    {
+    }
+}