using Microsoft.VisualStudio.TestTools.UnitTesting; using MQTTnet.Client; using MQTTnet.Server; using System; using System.Collections.Generic; using System.Diagnostics; using System.Linq; using System.Threading; using System.Threading.Tasks; using MQTTnet.Diagnostics; using MQTTnet.Extensions.Rpc; using MQTTnet.Extensions.Rpc.Options; using MQTTnet.Formatter; using MQTTnet.LowLevelClient; using IMqttClient = MQTTnet.Client.IMqttClient; namespace MQTTnet.Tests.Mockups { public sealed class TestEnvironment : IDisposable { readonly MqttProtocolVersion _protocolVersion; readonly List _lowLevelClients = new List(); readonly List _clients = new List(); readonly List _serverErrors = new List(); readonly List _clientErrors = new List(); readonly List _exceptions = new List(); public MqttFactory Factory { get; } = new MqttFactory(); public MqttServer Server { get; private set; } public bool IgnoreClientLogErrors { get; set; } public bool IgnoreServerLogErrors { get; set; } public int ServerPort { get; set; } = 1888; public MqttNetEventLogger ServerLogger { get; } = new MqttNetEventLogger("server"); public MqttNetEventLogger ClientLogger { get; } = new MqttNetEventLogger("client"); public TestContext TestContext { get; } public TestEnvironment() : this(null) { } public TestEnvironment(TestContext testContext, MqttProtocolVersion protocolVersion = MqttProtocolVersion.V311) { _protocolVersion = protocolVersion; TestContext = testContext; ServerLogger.LogMessagePublished += (s, e) => { if (Debugger.IsAttached) { Debug.WriteLine(e.LogMessage.ToString()); } if (e.LogMessage.Level == MqttNetLogLevel.Error) { lock (_serverErrors) { _serverErrors.Add(e.LogMessage.ToString()); } } }; ClientLogger.LogMessagePublished += (s, e) => { if (Debugger.IsAttached) { Debug.WriteLine(e.LogMessage.ToString()); } if (e.LogMessage.Level == MqttNetLogLevel.Error) { lock (_clientErrors) { _clientErrors.Add(e.LogMessage.ToString()); } } }; } public TestClientWrapper CreateClient() { lock (_clients) { var client = Factory.CreateMqttClient(ClientLogger); _clients.Add(client); return new TestClientWrapper(client, TestContext); } } public Task ConnectClient() { return ConnectClient(Factory.CreateClientOptionsBuilder().WithProtocolVersion(_protocolVersion)); } public async Task ConnectClient(Action optionsBuilder) { if (optionsBuilder == null) throw new ArgumentNullException(nameof(optionsBuilder)); var options = Factory.CreateClientOptionsBuilder() .WithProtocolVersion(_protocolVersion) .WithTcpServer("127.0.0.1", ServerPort); optionsBuilder.Invoke(options); var client = CreateClient(); await client.ConnectAsync(options.Build()).ConfigureAwait(false); return client; } public async Task ConnectClient(MqttClientOptionsBuilder options) { if (options == null) throw new ArgumentNullException(nameof(options)); options = options.WithTcpServer("127.0.0.1", ServerPort); var client = CreateClient(); await client.ConnectAsync(options.Build()).ConfigureAwait(false); return client; } public async Task ConnectClient(IMqttClientOptions options) { if (options == null) throw new ArgumentNullException(nameof(options)); var client = CreateClient(); await client.ConnectAsync(options).ConfigureAwait(false); return client; } public ILowLevelMqttClient CreateLowLevelClient() { lock (_clients) { var client = Factory.CreateLowLevelMqttClient(ClientLogger); _lowLevelClients.Add(client); return client; } } public Task ConnectLowLevelClient() { return ConnectLowLevelClient(o => { }); } public async Task ConnectLowLevelClient(Action optionsBuilder) { if (optionsBuilder == null) throw new ArgumentNullException(nameof(optionsBuilder)); var options = new MqttClientOptionsBuilder(); options = options.WithTcpServer("127.0.0.1", ServerPort); optionsBuilder.Invoke(options); var client = CreateLowLevelClient(); await client.ConnectAsync(options.Build(), CancellationToken.None).ConfigureAwait(false); return client; } public async Task ConnectRpcClient(IMqttRpcClientOptions options) { return new MqttRpcClient(await ConnectClient(), options); } public MqttServer CreateServer(MqttServerOptions options) { if (Server != null) { throw new InvalidOperationException("Server already started."); } Server = Factory.CreateMqttServer(options, ServerLogger); Server.ValidatingConnectionAsync += e => { if (TestContext != null) { // Null is used when the client id is assigned from the server! if (!string.IsNullOrEmpty(e.ClientId) && !e.ClientId.StartsWith(TestContext.TestName)) { TrackException(new InvalidOperationException($"Invalid client ID used ({e.ClientId}). It must start with UnitTest name.")); e.ReasonCode = Protocol.MqttConnectReasonCode.ClientIdentifierNotValid; } } return Task.CompletedTask; }; return Server; } public Task StartServer() { return StartServer(Factory.CreateServerOptionsBuilder()); } public async Task StartServer(MqttServerOptionsBuilder options) { var server = CreateServer(options.Build()); options.WithDefaultEndpointPort(ServerPort); options.WithMaxPendingMessagesPerClient(int.MaxValue); await server.StartAsync(); return server; } public async Task StartServer(Action options) { var optionsBuilder = Factory.CreateServerOptionsBuilder(); optionsBuilder.WithDefaultEndpointPort(ServerPort); optionsBuilder.WithMaxPendingMessagesPerClient(int.MaxValue); options.Invoke(optionsBuilder); var server = CreateServer(optionsBuilder.Build()); await server.StartAsync(); return server; } public TestApplicationMessageReceivedHandler CreateApplicationMessageHandler(IMqttClient mqttClient) { return new TestApplicationMessageReceivedHandler(mqttClient); } public void ThrowIfLogErrors() { lock (_serverErrors) { if (!IgnoreServerLogErrors && _serverErrors.Count > 0) { throw new Exception($"Server had {_serverErrors.Count} errors (${string.Join(Environment.NewLine, _serverErrors)})."); } } lock (_clientErrors) { if (!IgnoreClientLogErrors && _clientErrors.Count > 0) { throw new Exception($"Client(s) had {_clientErrors.Count} errors (${string.Join(Environment.NewLine, _clientErrors)})."); } } } public void TrackException(Exception exception) { lock (_exceptions) { _exceptions.Add(exception); } } public void Dispose() { foreach (var mqttClient in _clients) { try { //mqttClient.DisconnectAsync().GetAwaiter().GetResult(); } catch { // This can happen when the test already disconnected the client. } finally { mqttClient?.Dispose(); } } foreach (var lowLevelMqttClient in _lowLevelClients) { lowLevelMqttClient.Dispose(); } try { Server?.StopAsync().GetAwaiter().GetResult(); } catch { // This can happen when the test already stopped the server. } finally { Server?.Dispose(); } ThrowIfLogErrors(); if (_exceptions.Any()) { throw new Exception($"{_exceptions.Count} exceptions tracked.\r\n" + string.Join(Environment.NewLine, _exceptions)); } } } }