From c4db2e9c7c8763c77fed2d7b6fae3cbfeff9d2b1 Mon Sep 17 00:00:00 2001 From: Giuseppe Marazzi Date: Mon, 6 Jan 2025 11:18:55 +0100 Subject: [PATCH] Add Test MqttHostedServerStartup --- .../MQTTnet.AspNetCore.csproj | 5 ++ Source/MQTTnet.AspnetCore/MqttHostedServer.cs | 56 ++++++++++++++++ .../ServiceCollectionExtensions.cs | 8 +++ .../ASP/MqttHostedServerStartup.cs | 66 +++++++++++++++++++ 4 files changed, 135 insertions(+) create mode 100644 Source/MQTTnet.Tests/ASP/MqttHostedServerStartup.cs diff --git a/Source/MQTTnet.AspnetCore/MQTTnet.AspNetCore.csproj b/Source/MQTTnet.AspnetCore/MQTTnet.AspNetCore.csproj index 5357dd702..022747b51 100644 --- a/Source/MQTTnet.AspnetCore/MQTTnet.AspNetCore.csproj +++ b/Source/MQTTnet.AspnetCore/MQTTnet.AspNetCore.csproj @@ -1,5 +1,10 @@ + + + $(DefineConstants);HOSTEDSERVER_WITHOUT_STARTUP_YIELD + + net8.0 MQTTnet.AspNetCore diff --git a/Source/MQTTnet.AspnetCore/MqttHostedServer.cs b/Source/MQTTnet.AspnetCore/MqttHostedServer.cs index 3dfd6c648..2b7f588de 100644 --- a/Source/MQTTnet.AspnetCore/MqttHostedServer.cs +++ b/Source/MQTTnet.AspnetCore/MqttHostedServer.cs @@ -2,6 +2,10 @@ // The .NET Foundation licenses this file to you under the MIT license. // See the LICENSE file in the project root for more information. +//TODO: remove before close https://github.com/dotnet/MQTTnet/pull/2102 +////WIP: Fix ignored exceptions in MqttHostedServer startup #2102 +#if HOSTEDSERVER_WITHOUT_STARTUP_YIELD + using System; using System.Collections.Generic; using System.Threading; @@ -35,3 +39,55 @@ public override async Task StopAsync(CancellationToken cancellationToken) await base.StopAsync(cancellationToken); } } +#else + +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. +// See the LICENSE file in the project root for more information. + +using System; +using System.Collections.Generic; +using System.Threading; +using System.Threading.Tasks; +using Microsoft.Extensions.Hosting; +using MQTTnet.Diagnostics.Logger; +using MQTTnet.Server; + +namespace MQTTnet.AspNetCore; + +public sealed class MqttHostedServer : MqttServer, IHostedService +{ + readonly IHostApplicationLifetime _hostApplicationLifetime; + readonly MqttServerFactory _mqttFactory; + + public MqttHostedServer( + IHostApplicationLifetime hostApplicationLifetime, + MqttServerFactory mqttFactory, + MqttServerOptions options, + IEnumerable adapters, + IMqttNetLogger logger) : base(options, adapters, logger) + { + _mqttFactory = mqttFactory ?? throw new ArgumentNullException(nameof(mqttFactory)); + _hostApplicationLifetime = hostApplicationLifetime; + } + + public async Task StartAsync(CancellationToken cancellationToken) + { + // The yield makes sure that the hosted service is considered up and running. + await Task.Yield(); + + _hostApplicationLifetime.ApplicationStarted.Register(OnStarted); + } + + public Task StopAsync(CancellationToken cancellationToken) + { + return StopAsync(_mqttFactory.CreateMqttServerStopOptionsBuilder().Build()); + } + + void OnStarted() + { + _ = StartAsync(); + } +} + +#endif \ No newline at end of file diff --git a/Source/MQTTnet.AspnetCore/ServiceCollectionExtensions.cs b/Source/MQTTnet.AspnetCore/ServiceCollectionExtensions.cs index 2f03d0334..b374c70a3 100644 --- a/Source/MQTTnet.AspnetCore/ServiceCollectionExtensions.cs +++ b/Source/MQTTnet.AspnetCore/ServiceCollectionExtensions.cs @@ -45,8 +45,16 @@ public static void AddHostedMqttServer(this IServiceCollection services) services.TryAddSingleton(new MqttServerFactory()); services.AddSingleton(); +//TODO: remove before close https://github.com/dotnet/MQTTnet/pull/2102 +////WIP: Fix ignored exceptions in MqttHostedServer startup #2102 +#if HOSTEDSERVER_WITHOUT_STARTUP_YIELD services.AddHostedService(s => s.GetService()); services.AddSingleton(s => s.GetService().MqttServer); +#else + services.AddSingleton(s => s.GetService()); + services.AddSingleton(s => s.GetService()); +#endif + } public static IServiceCollection AddHostedMqttServerWithServices(this IServiceCollection services, Action configure) diff --git a/Source/MQTTnet.Tests/ASP/MqttHostedServerStartup.cs b/Source/MQTTnet.Tests/ASP/MqttHostedServerStartup.cs new file mode 100644 index 000000000..d3b1e9cd5 --- /dev/null +++ b/Source/MQTTnet.Tests/ASP/MqttHostedServerStartup.cs @@ -0,0 +1,66 @@ +using Microsoft.AspNetCore.Builder; +using Microsoft.VisualStudio.TestTools.UnitTesting; +using MQTTnet.AspNetCore; +using System.Net.Sockets; +using System.Net; +using System.Threading.Tasks; +using Microsoft.Extensions.DependencyInjection; +using MQTTnet.Server; +using Microsoft.AspNetCore.Hosting; + +namespace MQTTnet.Tests.ASP +{ + [TestClass] + public class MqttHostedServerStartup + { + private async Task TestStartup(bool useOccupiedPort) + { + using TcpListener l = new TcpListener(IPAddress.Any, 0); + l.Start(); + int port = ((IPEndPoint)l.LocalEndpoint).Port; + + if(!useOccupiedPort) + l.Stop(); + + + var builder = WebApplication.CreateBuilder(); + builder.WebHost.UseUrls("http://127.0.0.1:0"); + + builder.Services.AddMqttTcpServerAdapter(); + builder.Services.AddHostedMqttServer(cfg => + { + cfg + .WithDefaultEndpoint() + .WithDefaultEndpointPort(port); + }); + + + var app = builder.Build(); + + if(!useOccupiedPort) + { + await app.StartAsync(); + var server = app.Services.GetRequiredService(); + Assert.IsTrue(server.IsStarted); + await app.StopAsync(); + } + else + { + await Assert.ThrowsExceptionAsync(() => + app.StartAsync() + ); + } + } + + [TestMethod] + [DoNotParallelize] + public Task TestSuccessfullyStartup() + => TestStartup(useOccupiedPort: false); + + [TestMethod] + [DoNotParallelize] + public Task TestFailedStartup() + => TestStartup(useOccupiedPort: true); + + } +}