chore: Enable nullable annotation on test projects (#3009)

* chore: enable nullable annotation on test projects

* chore: add condition to skip overwrite nullable setting

* chore: fix remaining nullable errors

* chore: modify code based on comment

* chore: simplify nullable relating code

* chore: modify nullable annotation

* chore: modify code based on review comment

* chore: adjust spacing style

* chore: modify fields modifier and remove default!

* chore: add additional attribute definitions for roslyn toolchain

* chore: add type ignore settings

Author: filzrev

build/common.props

@@ -23,7 +23,7 @@
     <CodeAnalysisRuleSet>$(MSBuildThisFileDirectory)CodingStyle.ruleset</CodeAnalysisRuleSet>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
     <WarningsNotAsErrors>NU1900</WarningsNotAsErrors>
-    <Nullable>annotations</Nullable>
+    <Nullable Condition="'$(Nullable)' == ''">annotations</Nullable>
     <!-- Suppress warning for nuget package used in old (unsupported) tfm. -->
     <SuppressTfmSupportBuildWarnings>true</SuppressTfmSupportBuildWarnings>
   </PropertyGroup>

src/BenchmarkDotNet/Disassemblers/DataContracts.cs

@@ -32,8 +32,8 @@ internal SourceCode() { }
 
 public sealed class Sharp : SourceCode
 {
-    public string Text { get; set; } = default!;
-    public string FilePath { get; set; } = default!;
+    public required string Text { get; set; }
+    public required string FilePath { get; set; }
     public int LineNumber { get; set; }
 }
 

src/BenchmarkDotNet/Templates/BenchmarkProgram.txt

@@ -133,5 +133,31 @@ namespace BenchmarkDotNet.Autogenerated
     }
 #endif // NETFRAMEWORK
 
-    $DerivedTypes$
+$DerivedTypes$
 }
+
+#if !NET7_0_OR_GREATER
+namespace System.Runtime.CompilerServices
+{
+    [global::System.AttributeUsage(global::System.AttributeTargets.All, AllowMultiple = true, Inherited = false)]
+    [global::System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
+    internal sealed class CompilerFeatureRequiredAttribute : global::System.Attribute
+    {
+        public CompilerFeatureRequiredAttribute(global::System.String featureName)
+        {
+            FeatureName = featureName;
+        }
+
+        public global::System.String FeatureName { get; }
+        public global::System.Boolean IsOptional { get; set; }
+        public const global::System.String RefStructs = nameof(RefStructs);
+        public const global::System.String RequiredMembers = nameof(RequiredMembers);
+    }
+
+    [global::System.AttributeUsage(global::System.AttributeTargets.Class | global::System.AttributeTargets.Struct | global::System.AttributeTargets.Field | global::System.AttributeTargets.Property, AllowMultiple = false, Inherited = false)]
+    [global::System.ComponentModel.EditorBrowsable(global::System.ComponentModel.EditorBrowsableState.Never)]
+    internal sealed class RequiredMemberAttribute : global::System.Attribute
+    {
+    }
+}
+#endif

tests/BenchmarkDotNet.Analyzers.Tests/BenchmarkDotNet.Analyzers.Tests.csproj

@@ -3,7 +3,6 @@
   <PropertyGroup>
     <AssemblyName>BenchmarkDotNet.Analyzers.Tests</AssemblyName>
     <TargetFrameworks>net462;net8.0;net10.0</TargetFrameworks>
-    <Nullable>enable</Nullable>
     <PreserveCompilationContext>true</PreserveCompilationContext>
     <AutoGenerateBindingRedirects>true</AutoGenerateBindingRedirects>
     <GenerateBindingRedirectsOutputType>true</GenerateBindingRedirectsOutputType>

tests/BenchmarkDotNet.Exporters.Plotting.Tests/ScottPlotExporterTests.cs

@@ -271,9 +271,9 @@ public class Invalid_TwoMethodBaselines
             {
                 [Benchmark(Baseline = true)] public void Foo() { }
                 [Benchmark(Baseline = true)] public void Bar() { }
-            }
+            }
 #pragma warning restore BDN1107
-
+
             [RankColumn, LogicalGroupColumn, BaselineColumn]
             [SimpleJob(id: "Job1", baseline: true), SimpleJob(id: "Job2", baseline: true)]
             public class Invalid_TwoJobBaselines
@@ -286,7 +286,7 @@ [Benchmark] public void Bar() { }
 
             public class Escape_ParamsAndArguments
             {
-                [Params("\t", "\n")] public string StringParam;
+                [Params("\t", "\n")] public required string StringParam;
 
                 [Arguments('\t')]
                 [Arguments('\n')]

tests/BenchmarkDotNet.IntegrationTests.ManualRunning.MultipleFrameworks/MultipleFrameworksTest.cs

@@ -4,13 +4,18 @@
 using BenchmarkDotNet.Extensions;
 using BenchmarkDotNet.Jobs;
 using Xunit;
+using Xunit.Abstractions;
 
 namespace BenchmarkDotNet.IntegrationTests.ManualRunning
 {
     public class MultipleFrameworksTest : BenchmarkTestExecutor
     {
         private const string TfmEnvVarName = "TfmEnvVarName";
 
+        public MultipleFrameworksTest(ITestOutputHelper output) : base(output)
+        {
+        }
+
         [Theory]
         [InlineData(RuntimeMoniker.Net461)]
         [InlineData(RuntimeMoniker.Net48)]

tests/BenchmarkDotNet.IntegrationTests.ManualRunning/ExpectedBenchmarkResultsTests.cs

@@ -262,5 +262,5 @@ public class EmptyVoidPointer
 
 public class EmptyClass
 {
-    [Benchmark] public object Class() => default;
+    [Benchmark] public object? Class() => default;
 }

tests/BenchmarkDotNet.IntegrationTests.ManualRunning/MsBuildArgumentTests.cs

@@ -4,13 +4,18 @@
 using BenchmarkDotNet.Environments;
 using BenchmarkDotNet.Jobs;
 using Xunit;
+using Xunit.Abstractions;
 
 namespace BenchmarkDotNet.IntegrationTests.ManualRunning
 {
     public class MsBuildArgumentTests : BenchmarkTestExecutor
     {
         private const string CustomPropEnvVarName = "CustomPropEnvVarName";
 
+        public MsBuildArgumentTests(ITestOutputHelper output) : base(output)
+        {
+        }
+
         [Theory]
         [InlineData(true)]
         [InlineData(false)]

tests/BenchmarkDotNet.IntegrationTests/ArgumentsTests.cs

@@ -206,10 +206,10 @@ public void Simple(in bool boolean, in int number)
         public class WithComplexTypesReturnedFromSources
         {
             [ParamsSource(nameof(DictionaryAsParam))]
-            public Dictionary<int, string> DictionaryParamInstance;
+            public required Dictionary<int, string> DictionaryParamInstance;
 
             [ParamsSource(nameof(SameButStatic))]
-            public Dictionary<int, string> DictionaryParamStatic;
+            public required Dictionary<int, string> DictionaryParamStatic;
 
             [Benchmark]
             [ArgumentsSource(nameof(NonPrimitive))]
@@ -1072,10 +1072,10 @@ public class ParamsSourcePointingToAnotherClass
             public int ParamTwo { get; set; }
 
             [ParamsSource(typeof(ExternalClassWithParamsSource), nameof(ExternalClassWithParamsSource.NonPrimitiveTypeMethod))]
-            public Version ParamThree { get; set; }
+            public required Version ParamThree { get; set; }
 
             [ParamsSource(typeof(ExternalClassWithParamsSource), nameof(ExternalClassWithParamsSource.NonPrimitiveTypeProperty))]
-            public Version ParamFour { get; set; }
+            public required Version ParamFour { get; set; }
 
             [Benchmark]
             public void Test()
@@ -1146,7 +1146,7 @@ public void Test(string first, string second)
         public class Perf_Regex_Industry_RustLang_Sherlock
         {
             [Params(@"[""'][^""']{0,30}[?!.][""']")]
-            public string Pattern { get; set; }
+            public required string Pattern { get; set; }
 
             [Benchmark]
             public int Consume() => Pattern.Length;
@@ -1164,7 +1164,7 @@ public IEnumerable<Disposable> GetDisposables()
             }
 
             [ParamsSource(nameof(GetDisposables))]
-            public Disposable used;
+            public required Disposable used;
 
             [Benchmark]
             public void CheckDisposed()
@@ -1202,7 +1202,7 @@ public Disposable(int id)
             }
         }
 
-        private Reports.Summary CanExecute<T>(IToolchain toolchain, Func<IConfig, IConfig> furtherConfigure = null)
+        private Reports.Summary CanExecute<T>(IToolchain toolchain, Func<IConfig, IConfig>? furtherConfigure = null)
         {
             var config = CreateSimpleConfig(job: Job.Dry.WithToolchain(toolchain));
 

tests/BenchmarkDotNet.IntegrationTests/AsyncBenchmarksTests.cs

@@ -15,8 +15,8 @@ internal class ValueTaskSource<T> : IValueTaskSource<T>, IValueTaskSource
         void IValueTaskSource.GetResult(short token) => _core.GetResult(token);
         ValueTaskSourceStatus IValueTaskSource<T>.GetStatus(short token) => _core.GetStatus(token);
         ValueTaskSourceStatus IValueTaskSource.GetStatus(short token) => _core.GetStatus(token);
-        void IValueTaskSource<T>.OnCompleted(Action<object> continuation, object state, short token, ValueTaskSourceOnCompletedFlags flags) => _core.OnCompleted(continuation, state, token, flags);
-        void IValueTaskSource.OnCompleted(Action<object> continuation, object state, short token, ValueTaskSourceOnCompletedFlags flags) => _core.OnCompleted(continuation, state, token, flags);
+        void IValueTaskSource<T>.OnCompleted(Action<object?> continuation, object? state, short token, ValueTaskSourceOnCompletedFlags flags) => _core.OnCompleted(continuation, state, token, flags);
+        void IValueTaskSource.OnCompleted(Action<object?> continuation, object? state, short token, ValueTaskSourceOnCompletedFlags flags) => _core.OnCompleted(continuation, state, token, flags);
         public void Reset() => _core.Reset();
         public short Token => _core.Version;
         public void SetResult(T result) => _core.SetResult(result);
@@ -32,8 +32,8 @@ internal class ValueTaskSourceCallbackOnly<T> : IValueTaskSource<T>, IValueTaskS
         // Always return pending state so OnCompleted will be called.
         ValueTaskSourceStatus IValueTaskSource<T>.GetStatus(short token) => ValueTaskSourceStatus.Pending;
         ValueTaskSourceStatus IValueTaskSource.GetStatus(short token) => ValueTaskSourceStatus.Pending;
-        void IValueTaskSource<T>.OnCompleted(Action<object> continuation, object state, short token, ValueTaskSourceOnCompletedFlags flags) => _core.OnCompleted(continuation, state, token, flags);
-        void IValueTaskSource.OnCompleted(Action<object> continuation, object state, short token, ValueTaskSourceOnCompletedFlags flags) => _core.OnCompleted(continuation, state, token, flags);
+        void IValueTaskSource<T>.OnCompleted(Action<object?> continuation, object? state, short token, ValueTaskSourceOnCompletedFlags flags) => _core.OnCompleted(continuation, state, token, flags);
+        void IValueTaskSource.OnCompleted(Action<object?> continuation, object? state, short token, ValueTaskSourceOnCompletedFlags flags) => _core.OnCompleted(continuation, state, token, flags);
         public void Reset() => _core.Reset();
         public short Token => _core.Version;
         public void SetResult(T result) => _core.SetResult(result);
@@ -49,13 +49,13 @@ public void TaskReturningMethodsAreAwaited()
             var summary = CanExecute<TaskDelayMethods>();
 
             foreach (var report in summary.Reports)
-            foreach (var measurement in report.AllMeasurements)
-            {
-                double actual = measurement.Nanoseconds;
-                const double minExpected = TaskDelayMethods.NanosecondsDelay - TaskDelayMethods.MaxTaskDelayResolutionInNanoseconds;
-                string name = report.BenchmarkCase.Descriptor.GetFilterName();
-                Assert.True(actual > minExpected, $"{name} has not been awaited, took {actual}ns, while it should take more than {minExpected}ns");
-            }
+                foreach (var measurement in report.AllMeasurements)
+                {
+                    double actual = measurement.Nanoseconds;
+                    const double minExpected = TaskDelayMethods.NanosecondsDelay - TaskDelayMethods.MaxTaskDelayResolutionInNanoseconds;
+                    string name = report.BenchmarkCase.Descriptor.GetFilterName();
+                    Assert.True(actual > minExpected, $"{name} has not been awaited, took {actual}ns, while it should take more than {minExpected}ns");
+                }
         }
 
         [Fact]