Add Directory.Build.props. (#2120)

* Add Directory.Build.props.

* Adjust Analysis related properties and add conditional enablement for ContinuousIntegrationBuild.

* Adopt new changes in master

---------

Co-authored-by: christian <6939810+chkr1011@users.noreply.github.com>

Source/MQTTnet.Benchmarks/AsyncLockBenchmark.cs

@@ -43,7 +43,7 @@ public class AsyncLockBenchmark : BaseBenchmark
 
         if (globalI != tasksCount)
         {
-            throw new Exception($"Code is broken ({globalI})!");
+            throw new InvalidOperationException($"Code is broken ({globalI})!");
         }
     }
 

Source/MQTTnet.Benchmarks/ChannelAdapterBenchmark.cs

@@ -15,7 +15,7 @@ using MQTTnet.Tests.Mockups;
 namespace MQTTnet.Benchmarks;
 
 [MemoryDiagnoser]
-public sealed class ChannelAdapterBenchmark : BaseBenchmark
+public sealed class ChannelAdapterBenchmark : BaseBenchmark, IDisposable
 {
     MqttChannelAdapter _channelAdapter;
     int _iterations;
@@ -86,4 +86,10 @@ public sealed class ChannelAdapterBenchmark : BaseBenchmark
 
         return buffer.ToArray();
     }
+
+    public void Dispose()
+    {
+        _channelAdapter?.Dispose();
+        _stream?.Dispose();
+    }
 }

Source/MQTTnet.Benchmarks/MQTTnet.Benchmarks.csproj

@@ -1,20 +1,11 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
     <PropertyGroup>
-        <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
         <OutputType>Exe</OutputType>
         <DebugType>Full</DebugType>
-        <TargetFramework>net8.0</TargetFramework>
         <IsPackable>false</IsPackable>
-        <EnableNETAnalyzers>false</EnableNETAnalyzers>
-        <EnforceCodeStyleInBuild>false</EnforceCodeStyleInBuild>
-        <DisableImplicitAspNetCoreAnalyzers>true</DisableImplicitAspNetCoreAnalyzers>
-        <NoWarn>1591;NETSDK1138;NU1803;NU1901;NU1902;CS8892</NoWarn>
+        <NoWarn>$(NoWarn);CS8892;CA1707;CA1051;CA1822</NoWarn>
         <TreatWarningsAsErrors>false</TreatWarningsAsErrors>
-        <NuGetAuditMode>all</NuGetAuditMode>
-        <NuGetAudit>true</NuGetAudit>
-        <NuGetAuditLevel>low</NuGetAuditLevel>
-        <AnalysisLevel>latest-Recommended</AnalysisLevel>
     </PropertyGroup>
 
     <ItemGroup>

Source/MQTTnet.Benchmarks/MessageDeliveryBenchmark.cs

@@ -2,10 +2,6 @@
 // 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 BenchmarkDotNet.Attributes;
 using MQTTnet.Packets;
 using MQTTnet.Server;
@@ -13,7 +9,7 @@ using MQTTnet.Server;
 namespace MQTTnet.Benchmarks;
 
 [MemoryDiagnoser]
-public class MessageDeliveryBenchmark : BaseBenchmark
+public sealed class MessageDeliveryBenchmark : BaseBenchmark, IDisposable
 {
     List<string> _allSubscribedTopics; // Keep track of the subset of topics that are subscribed
     CancellationTokenSource _cancellationTokenSource;
@@ -99,10 +95,16 @@ public class MessageDeliveryBenchmark : BaseBenchmark
 
         if (_messagesReceivedCount < _messagesExpectedCount)
         {
-            throw new Exception($"Messages Received Count mismatch, expected {_messagesExpectedCount}, received {_messagesReceivedCount}");
+            throw new InvalidOperationException($"Messages Received Count mismatch, expected {_messagesExpectedCount}, received {_messagesReceivedCount}");
         }
     }
 
+    public void Dispose()
+    {
+        _cancellationTokenSource?.Dispose();
+        _mqttServer?.Dispose();
+    }
+
     [GlobalSetup]
     public void Setup()
     {
@@ -173,7 +175,7 @@ public class MessageDeliveryBenchmark : BaseBenchmark
         var topicIndexStep = totalNumTopics / (_numSubscribedTopicsPerSubscriber * _numSubscribers);
         if (topicIndexStep * _numSubscribedTopicsPerSubscriber * _numSubscribers != totalNumTopics)
         {
-            throw new Exception(
+            throw new InvalidOperationException(
                 $"The total number of topics must be divisible by the number of subscribed topics across all subscribers. Total number of topics: {totalNumTopics}, topic step: {topicIndexStep}");
         }
 

Source/MQTTnet.Benchmarks/MqttTcpChannelBenchmark.cs

@@ -4,8 +4,6 @@
 
 using System.Buffers;
 using System.Reflection;
-using System.Threading;
-using System.Threading.Tasks;
 using BenchmarkDotNet.Attributes;
 using BenchmarkDotNet.Jobs;
 using MQTTnet.Channel;
@@ -18,9 +16,9 @@ namespace MQTTnet.Benchmarks;
 
 [SimpleJob(RuntimeMoniker.Net60)]
 [MemoryDiagnoser]
-public class MqttTcpChannelBenchmark : BaseBenchmark
+public sealed class MqttTcpChannelBenchmark : BaseBenchmark, IDisposable
 {
-    IMqttChannel _clientChannel;
+    MqttTcpChannel _clientChannel;
     MqttServer _mqttServer;
     IMqttChannel _serverChannel;
 
@@ -84,4 +82,11 @@ public class MqttTcpChannelBenchmark : BaseBenchmark
             await _serverChannel.WriteAsync(buffer, true, CancellationToken.None).ConfigureAwait(false);
         }
     }
+
+    public void Dispose()
+    {
+        _clientChannel?.Dispose();
+        _mqttServer?.Dispose();
+        _serverChannel?.Dispose();
+    }
 }

Source/MQTTnet.Benchmarks/Program.cs

@@ -92,7 +92,7 @@ public static class Program
             return;
         }
 
-        _selectedBenchmarkIndex = _benchmarks.FindIndex(b => b.Name.Equals(arguments[0]));
+        _selectedBenchmarkIndex = _benchmarks.FindIndex(b => b.Name.Equals(arguments[0], StringComparison.Ordinal));
 
         if (_selectedBenchmarkIndex < 0)
         {

Source/MQTTnet.Benchmarks/ReaderExtensionsBenchmark.cs

@@ -13,7 +13,7 @@ namespace MQTTnet.Benchmarks;
 [SimpleJob(RuntimeMoniker.Net60)]
 [RPlotExporter, RankColumn]
 [MemoryDiagnoser]
-public class ReaderExtensionsBenchmark
+public sealed class ReaderExtensionsBenchmark : IDisposable, IAsyncDisposable
 {
     MqttPacketFormatterAdapter _mqttPacketFormatter;
     MemoryStream _stream;
@@ -83,4 +83,17 @@ public class ReaderExtensionsBenchmark
             }
         }
     }
+
+    public void Dispose()
+    {
+        _stream?.Dispose();
+    }
+
+    public async ValueTask DisposeAsync()
+    {
+        if (_stream != null)
+        {
+            await _stream.DisposeAsync();
+        }
+    }
 }

Source/MQTTnet.Benchmarks/SendPacketAsyncBenchmark.cs

@@ -1,39 +1,19 @@
+using System.Buffers;
+using System.IO.Pipelines;
 using BenchmarkDotNet.Attributes;
 using BenchmarkDotNet.Jobs;
 using MQTTnet.Formatter;
-using System;
-using System.Buffers;
-using System.IO;
-using System.IO.Pipelines;
-using System.Threading.Tasks;
 
 namespace MQTTnet.Benchmarks;
 
 [SimpleJob(RuntimeMoniker.Net60)]
-[RPlotExporter, RankColumn]
+[RPlotExporter]
+[RankColumn]
 [MemoryDiagnoser]
-public class SendPacketAsyncBenchmark : BaseBenchmark
+public sealed class SendPacketAsyncBenchmark : BaseBenchmark, IDisposable, IAsyncDisposable
 {
-    MemoryStream _stream;
     MqttPacketBuffer _buffer;
-
-    [GlobalSetup]
-    public void GlobalSetup()
-    {
-        _stream = new MemoryStream(1024);
-        var packet = new ArraySegment<byte>(new byte[10]);
-        _buffer = new MqttPacketBuffer(packet);
-    }
-
-    [Benchmark(Baseline = true)]
-    public async ValueTask Before()
-    {
-        _stream.Position = 0;
-        var output = PipeWriter.Create(_stream);
-
-        WritePacketBuffer(output, _buffer);
-        await output.FlushAsync();
-    }
+    MemoryStream _stream;
 
     [Benchmark]
     public async ValueTask After()
@@ -52,6 +32,37 @@ public class SendPacketAsyncBenchmark : BaseBenchmark
         }
     }
 
+    [Benchmark(Baseline = true)]
+    public async ValueTask Before()
+    {
+        _stream.Position = 0;
+        var output = PipeWriter.Create(_stream);
+
+        WritePacketBuffer(output, _buffer);
+        await output.FlushAsync();
+    }
+
+    public void Dispose()
+    {
+        _stream?.Dispose();
+    }
+
+    public async ValueTask DisposeAsync()
+    {
+        if (_stream != null)
+        {
+            await _stream.DisposeAsync();
+        }
+    }
+
+    [GlobalSetup]
+    public void GlobalSetup()
+    {
+        _stream = new MemoryStream(1024);
+        var packet = new ArraySegment<byte>(new byte[10]);
+        _buffer = new MqttPacketBuffer(packet);
+    }
+
     static void WritePacketBuffer(PipeWriter output, MqttPacketBuffer buffer)
     {
         // copy MqttPacketBuffer's Packet and Payload to the same buffer block of PipeWriter

Source/MQTTnet.Benchmarks/SerializerBenchmark.cs

@@ -26,7 +26,7 @@ public class SerializerBenchmark : BaseBenchmark
 {
     MqttPacket _packet;
     ArraySegment<byte> _serializedPacket;
-    IMqttPacketFormatter _serializer;
+    MqttV3PacketFormatter _serializer;
     MqttBufferWriter _bufferWriter;
 
     [GlobalSetup]
@@ -43,7 +43,7 @@ public class SerializerBenchmark : BaseBenchmark
     }
 
     [Benchmark]
-    public void Serialize_10000_Messages()
+    public void Serialize10000Messages()
     {
         for (var i = 0; i < 10000; i++)
         {
@@ -53,7 +53,7 @@ public class SerializerBenchmark : BaseBenchmark
     }
 
     [Benchmark]
-    public void Deserialize_10000_Messages()
+    public void Deserialize10000Messages()
     {
         var channel = new BenchmarkMqttChannel(_serializedPacket);
         var reader = new MqttChannelAdapter(channel, new MqttPacketFormatterAdapter(new MqttBufferWriter(4096, 65535)), new MqttNetEventLogger());
@@ -66,7 +66,7 @@ public class SerializerBenchmark : BaseBenchmark
         }
     }
 
-    class BenchmarkMqttChannel : IMqttChannel
+    sealed class BenchmarkMqttChannel : IMqttChannel
     {
         readonly ArraySegment<byte> _buffer;
         int _position;
@@ -81,7 +81,7 @@ public class SerializerBenchmark : BaseBenchmark
 
         public EndPoint LocalEndPoint { get; set; }
 
-        public bool IsSecureConnection { get; } = false;
+        public bool IsSecureConnection { get; }
 
         public X509Certificate2 ClientCertificate { get; set; }