Merge pull request #1665 from nunit/Issue-1590_NetAnalyzers

Enable Minimum .NET Analyzers

Author: manfred-brands

.editorconfig

@@ -28,3 +28,9 @@ dotnet_diagnostic.CSIsNull001.severity = warning
 
 # CSIsNull002: Use `is object` for non-null checks
 dotnet_diagnostic.CSIsNull002.severity = warning
+
+# Microsoft NetAnalyzer
+
+# This relates to classes that have finalizers, but we should not have any finalizer
+# CA1816: Dispose methods should call SuppressFinalize
+dotnet_diagnostic.CA1816.severity = none

src/Directory.Build.props

@@ -6,6 +6,9 @@
         <LangVersion>12</LangVersion>
         <Features>strict</Features>
         <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+        <EnableNETAnalyzers>true</EnableNETAnalyzers>
+        <AnalysisMode>Minimum</AnalysisMode>
+        <EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
         <Version Condition="'$(Version)'==''">4.0.0.0</Version>
         <OutputPath>$(MSBuildThisFileDirectory)\..\bin\$(Configuration)\</OutputPath>
         <CheckEolTargetFramework>false</CheckEolTargetFramework>

src/NUnitCommon/nunit.agent.core.tests/AgentOptionTests.cs

@@ -25,7 +25,7 @@ public void DefaultOptionSettings<T>(string propertyName, T defaultValue)
             var options = new AgentOptions();
             var prop = typeof(AgentOptions).GetProperty(propertyName);
             Assert.That(prop, Is.Not.Null, $"Property {propertyName} does not exist");
-            Assert.That(prop.GetValue(options, new object[0]), Is.EqualTo(defaultValue));
+            Assert.That(prop.GetValue(options, Array.Empty<object>()), Is.EqualTo(defaultValue));
         }
 
         private static readonly Guid AGENT_GUID = Guid.NewGuid();
@@ -53,7 +53,7 @@ public void ValidOptionSettings<T>(string option, string propertyName, T expecte
             var options = new AgentOptions(option);
             var prop = typeof(AgentOptions).GetProperty(propertyName);
             Assert.That(prop, Is.Not.Null, $"Property {propertyName} does not exist");
-            Assert.That(prop.GetValue(options, new object[0]), Is.EqualTo(expectedValue));
+            Assert.That(prop.GetValue(options, Array.Empty<object>()), Is.EqualTo(expectedValue));
         }
 
         [Test]

src/NUnitCommon/nunit.agent.core.tests/Runners/DomainManagerTests.cs

@@ -71,7 +71,7 @@ public void CanCreateDomainWithApplicationBaseSpecified()
         public void CanUnloadDomain()
         {
             var domain = _domainManager.CreateDomain(_package);
-            _domainManager.Unload(domain);
+            DomainManager.Unload(domain);
 
             CheckDomainIsUnloaded(domain);
         }
@@ -80,14 +80,14 @@ public void CanUnloadDomain()
         public void UnloadingTwiceThrowsNUnitEngineUnloadException()
         {
             var domain = _domainManager.CreateDomain(_package);
-            _domainManager.Unload(domain);
+            DomainManager.Unload(domain);
 
-            Assert.That(() => _domainManager.Unload(domain), Throws.TypeOf<NUnitEngineUnloadException>());
+            Assert.That(() => DomainManager.Unload(domain), Throws.TypeOf<NUnitEngineUnloadException>());
 
             CheckDomainIsUnloaded(domain);
         }
 
-        private void CheckDomainIsUnloaded(AppDomain domain)
+        private static void CheckDomainIsUnloaded(AppDomain domain)
         {
             // HACK: Either the Assert will succeed or the
             // exception should be thrown.

src/NUnitCommon/nunit.agent.core.tests/Runners/TestAgentRunnerTests.cs

@@ -92,26 +92,26 @@ private void CheckPackageLoading()
                 Assert.That(_runner.IsPackageLoaded, Is.False, "Package should not be loaded automatically");
         }
 
-        private void CheckBasicResult(TestEngineResult result)
+        private static void CheckBasicResult(TestEngineResult result)
         {
             foreach (var node in result.XmlNodes)
                 CheckBasicResult(node);
         }
 
-        private void CheckBasicResult(XmlNode node)
+        private static void CheckBasicResult(XmlNode node)
         {
             Assert.That(node.Name, Is.EqualTo("test-suite"));
             Assert.That(node.GetAttribute("testcasecount", 0), Is.EqualTo(MockAssembly.Tests));
             Assert.That(node.GetAttribute("runstate"), Is.EqualTo("Runnable"));
         }
 
-        private void CheckRunResult(TestEngineResult result)
+        private static void CheckRunResult(TestEngineResult result)
         {
             foreach (var node in result.XmlNodes)
                 CheckRunResult(node);
         }
 
-        private void CheckRunResult(XmlNode result)
+        private static void CheckRunResult(XmlNode result)
         {
             CheckBasicResult(result);
             Assert.That(result.GetAttribute("passed", 0), Is.EqualTo(MockAssembly.PassedInAttribute));

src/NUnitCommon/nunit.agent.core/Agents/RemoteTestAgent.cs

@@ -28,8 +28,6 @@ public RemoteTestAgent(Guid agentId) : base(agentId)
 
         public ITestAgentTransport? Transport;
 
-        public int ProcessId => System.Diagnostics.Process.GetCurrentProcess().Id;
-
         public override bool Start()
         {
             Guard.OperationValid(Transport is not null, "Transport must be set before calling Start().");

src/NUnitCommon/nunit.agent.core/Communication/Transports/Tcp/TestAgentTcpTransport.cs

@@ -17,20 +17,21 @@ namespace NUnit.Engine.Communication.Transports.Tcp
     public class TestAgentTcpTransport : ITestAgentTransport, ITestEventListener
     {
         private static readonly Logger log = InternalTrace.GetLogger(typeof(TestAgentTcpTransport));
+        private static readonly char[] PortSeparator = [':'];
 
         private readonly string _agencyUrl;
         private Socket? _clientSocket;
         private ITestEngineRunner? _runner;
 
         public TestAgentTcpTransport(RemoteTestAgent agent, string serverUrl)
         {
-            Guard.ArgumentNotNull(agent, nameof(agent));
+            Guard.ArgumentNotNull(agent);
             Agent = agent;
 
-            Guard.ArgumentNotNullOrEmpty(serverUrl, nameof(serverUrl));
+            Guard.ArgumentNotNullOrEmpty(serverUrl);
             _agencyUrl = serverUrl;
 
-            var parts = serverUrl.Split(new char[] { ':' });
+            var parts = serverUrl.Split(PortSeparator);
             Guard.ArgumentValid(parts.Length == 2, "Invalid server address specified. Must be a valid endpoint including the port number", nameof(serverUrl));
             ServerEndPoint = new IPEndPoint(IPAddress.Parse(parts[0]), int.Parse(parts[1]));
         }

src/NUnitCommon/nunit.agent.core/Drivers/DriverService.cs

@@ -17,7 +17,9 @@ public class DriverService : IDriverService
     {
         private static readonly Logger log = InternalTrace.GetLogger("DriverService");
 
-        private readonly IList<IDriverFactory> _factories = new List<IDriverFactory>();
+        private static readonly char[] CommaSeparator = [','];
+
+        private readonly List<IDriverFactory> _factories = new List<IDriverFactory>();
 
         public DriverService()
         {
@@ -63,7 +65,7 @@ public IFrameworkDriver GetDriver(AppDomain domain, TestPackage package, string
                 // any true Portable assembly would have a Profile as part of its name.
                 var platform = targetFramework == ".NETPortable,Version=v5.0"
                     ? ".NETStandard"
-                    : targetFramework.Split(new char[] { ',' })[0];
+                    : targetFramework.Split(CommaSeparator)[0];
 
                 if (platform == "Silverlight" || platform == ".NETPortable" || platform == ".NETStandard" || platform == ".NETCompactFramework")
                     if (skipNonTestAssemblies)

src/NUnitCommon/nunit.agent.core/Drivers/NUnit2DriverFactory.cs

@@ -45,7 +45,7 @@ public bool IsSupportedTestFramework(AssemblyName reference)
         public IFrameworkDriver GetDriver(AppDomain domain, string id, AssemblyName reference)
         {
             if (!IsSupportedTestFramework(reference))
-                throw new ArgumentException("Invalid framework", "reference");
+                throw new ArgumentException("Invalid framework", nameof(reference));
 
             if (!_resolverInstalled)
             {

src/NUnitCommon/nunit.agent.core/Drivers/NUnit3DriverFactory.cs

@@ -30,8 +30,8 @@ public bool IsSupportedTestFramework(AssemblyName reference)
         /// <returns>An IFrameworkDriver</returns>
         public IFrameworkDriver GetDriver(AppDomain domain, string id, AssemblyName reference)
         {
-            Guard.ArgumentNotNullOrEmpty(id, nameof(id));
-            Guard.ArgumentValid(IsSupportedTestFramework(reference), "Invalid framework", "reference");
+            Guard.ArgumentNotNullOrEmpty(id);
+            Guard.ArgumentValid(IsSupportedTestFramework(reference), "Invalid framework", nameof(reference));
 
             log.Info("Using NUnitFrameworkDriver");
             return new NUnitFrameworkDriver(domain, id, reference);
@@ -44,7 +44,7 @@ public IFrameworkDriver GetDriver(AppDomain domain, string id, AssemblyName refe
         /// <returns></returns>
         public IFrameworkDriver GetDriver(string id, AssemblyName reference)
         {
-            Guard.ArgumentNotNullOrEmpty(id, nameof(id));
+            Guard.ArgumentNotNullOrEmpty(id);
             Guard.ArgumentValid(IsSupportedTestFramework(reference), "Invalid framework", nameof(reference));
             log.Info("Using NUnitFrameworkDriver");
             return new NUnitFrameworkDriver(id, reference);