Enable nullable context for options

dotnet · Jul 1, 2024 · 4e1979a · 4e1979a
1 parent c82a161
commit 4e1979a
Show file tree

Hide file tree

Showing 36 changed files with 120 additions and 81 deletions.
diff --git a/...Tests/Microsoft.Diagnostics.Monitoring.ConfigurationSchema/ExperimentalSchemaProcessor.cs b/...Tests/Microsoft.Diagnostics.Monitoring.ConfigurationSchema/ExperimentalSchemaProcessor.cs
@@ -17,7 +17,7 @@ public void Process(SchemaProcessorContext context)
             {
                 if (null != property.GetCustomAttribute<ExperimentalAttribute>())
                 {
-                    string description = context.Schema.Properties[property.Name].Description;
+                    string? description = context.Schema.Properties[property.Name].Description;
                     if (string.IsNullOrEmpty(description))
                     {
                         description = ExperimentalPrefix;

diff --git a/...onitoring.ConfigurationSchema/Microsoft.Diagnostics.Monitoring.ConfigurationSchema.csproj b/...onitoring.ConfigurationSchema/Microsoft.Diagnostics.Monitoring.ConfigurationSchema.csproj
@@ -2,6 +2,7 @@
 
   <PropertyGroup>
     <OutputType>Exe</OutputType>
+    <Nullable>enable</Nullable>
     <TargetFrameworks>$(SchemaTargetFramework)</TargetFrameworks>
     <DefineConstants>$(DefineConstants);SCHEMAGEN</DefineConstants>
   </PropertyGroup>

diff --git a/...s/Microsoft.Diagnostics.Monitoring.ConfigurationSchema/Options/ConsoleFormatterOptions.cs b/...s/Microsoft.Diagnostics.Monitoring.ConfigurationSchema/Options/ConsoleFormatterOptions.cs
@@ -18,7 +18,7 @@ internal sealed class ConsoleFormatterOptions
             ResourceType = typeof(OptionsDisplayStrings),
             Description = nameof(OptionsDisplayStrings.DisplayAttributeDescription_ConsoleFormatterOptions_TimestampFormat))]
         [DefaultValue(null)]
-        public string TimestampFormat { get; set; }
+        public string? TimestampFormat { get; set; }
 
         [Display(
             ResourceType = typeof(OptionsDisplayStrings),

diff --git a/...ests/Microsoft.Diagnostics.Monitoring.ConfigurationSchema/Options/ConsoleLoggerOptions.cs b/...ests/Microsoft.Diagnostics.Monitoring.ConfigurationSchema/Options/ConsoleLoggerOptions.cs
@@ -25,11 +25,11 @@ internal sealed class ConsoleLoggerOptions
         [Display(
             ResourceType = typeof(OptionsDisplayStrings),
             Description = nameof(OptionsDisplayStrings.DisplayAttributeDescription_ConsoleLoggerOptions_FormatterOptions))]
-        public object FormatterOptions { get; set; }
+        public object? FormatterOptions { get; set; }
 
         [Display(
             ResourceType = typeof(OptionsDisplayStrings),
             Description = nameof(OptionsDisplayStrings.DisplayAttributeDescription_ConsoleLoggerOptions_LogLevel))]
-        public IDictionary<string, LogLevel?> LogLevel { get; set; }
+        public IDictionary<string, LogLevel?>? LogLevel { get; set; }
     }
 }
diff --git a/...crosoft.Diagnostics.Monitoring.ConfigurationSchema/Options/JsonConsoleFormatterOptions.cs b/...crosoft.Diagnostics.Monitoring.ConfigurationSchema/Options/JsonConsoleFormatterOptions.cs
@@ -24,7 +24,7 @@ internal sealed class JsonConsoleFormatterOptions
             ResourceType = typeof(OptionsDisplayStrings),
             Description = nameof(OptionsDisplayStrings.DisplayAttributeDescription_ConsoleFormatterOptions_TimestampFormat))]
         [DefaultValue(null)]
-        public string TimestampFormat { get; set; }
+        public string? TimestampFormat { get; set; }
 
         [Display(
             ResourceType = typeof(OptionsDisplayStrings),

diff --git a/src/Tests/Microsoft.Diagnostics.Monitoring.ConfigurationSchema/Options/LogLevelOptions.cs b/src/Tests/Microsoft.Diagnostics.Monitoring.ConfigurationSchema/Options/LogLevelOptions.cs
@@ -13,6 +13,6 @@ internal sealed class LogLevelOptions
         [Display(
             ResourceType = typeof(OptionsDisplayStrings),
             Description = nameof(OptionsDisplayStrings.DisplayAttributeDescription_LogLevelOptions_LogLevel))]
-        public IDictionary<string, LogLevel?> LogLevel { get; set; }
+        public IDictionary<string, LogLevel?>? LogLevel { get; set; }
     }
 }
diff --git a/src/Tests/Microsoft.Diagnostics.Monitoring.ConfigurationSchema/Options/LoggingOptions.cs b/src/Tests/Microsoft.Diagnostics.Monitoring.ConfigurationSchema/Options/LoggingOptions.cs
@@ -14,27 +14,27 @@ internal sealed class LoggingOptions
         [Display(
             ResourceType = typeof(OptionsDisplayStrings),
             Description = nameof(OptionsDisplayStrings.DisplayAttributeDescription_LoggingOptions_LogLevel))]
-        public IDictionary<string, LogLevel?> LogLevel { get; set; }
+        public IDictionary<string, LogLevel?>? LogLevel { get; set; }
 
         [Display(
             ResourceType = typeof(OptionsDisplayStrings),
             Description = nameof(OptionsDisplayStrings.DisplayAttributeDescription_LoggingOptions_Console))]
-        public ConsoleLoggerOptions Console { get; set; }
+        public ConsoleLoggerOptions? Console { get; set; }
 
         [Display(
             ResourceType = typeof(OptionsDisplayStrings),
             Description = nameof(OptionsDisplayStrings.DisplayAttributeDescription_LoggingOptions_EventLog))]
-        public LogLevelOptions EventLog { get; set; }
+        public LogLevelOptions? EventLog { get; set; }
 
         [Display(
             ResourceType = typeof(OptionsDisplayStrings),
             Description = nameof(OptionsDisplayStrings.DisplayAttributeDescription_LoggingOptions_Debug))]
-        public LogLevelOptions Debug { get; set; }
+        public LogLevelOptions? Debug { get; set; }
 
         [Display(
             ResourceType = typeof(OptionsDisplayStrings),
             Description = nameof(OptionsDisplayStrings.DisplayAttributeDescription_LoggingOptions_EventSource))]
-        public LogLevelOptions EventSource { get; set; }
+        public LogLevelOptions? EventSource { get; set; }
 
         [Display(
             ResourceType = typeof(OptionsDisplayStrings),

diff --git a/...Tests/Microsoft.Diagnostics.Monitoring.ConfigurationSchema/Options/RootOptions.Logging.cs b/...Tests/Microsoft.Diagnostics.Monitoring.ConfigurationSchema/Options/RootOptions.Logging.cs
@@ -7,6 +7,6 @@ namespace Microsoft.Diagnostics.Tools.Monitor
 {
     internal partial class RootOptions
     {
-        public LoggingOptions Logging { get; set; }
+        public LoggingOptions? Logging { get; set; }
     }
 }
diff --git a/...osoft.Diagnostics.Monitoring.ConfigurationSchema/Options/SimpleConsoleFormatterOptions.cs b/...osoft.Diagnostics.Monitoring.ConfigurationSchema/Options/SimpleConsoleFormatterOptions.cs
@@ -31,7 +31,7 @@ internal sealed class SimpleConsoleFormatterOptions
             ResourceType = typeof(OptionsDisplayStrings),
             Description = nameof(OptionsDisplayStrings.DisplayAttributeDescription_ConsoleFormatterOptions_TimestampFormat))]
         [DefaultValue(null)]
-        public string TimestampFormat { get; set; }
+        public string? TimestampFormat { get; set; }
 
         [Display(
             ResourceType = typeof(OptionsDisplayStrings),

diff --git a/src/Tests/Microsoft.Diagnostics.Monitoring.ConfigurationSchema/SchemaGenerator.cs b/src/Tests/Microsoft.Diagnostics.Monitoring.ConfigurationSchema/SchemaGenerator.cs
@@ -275,15 +275,15 @@ private static JsonSchemaProperty AddDiscriminatedSubSchema(
             string discriminatingPropertyName,
             string discriminatingPropertyValue,
             string discriminatedPropertyName,
-            JsonSchema subSchema = null)
+            JsonSchema? subSchema = null)
         {
             if (null == subSchema)
             {
                 subSchema = new JsonSchema();
             }
 
             JsonSchemaProperty discriminatingProperty = new JsonSchemaProperty();
-            discriminatingProperty.ExtensionData = new Dictionary<string, object>();
+            discriminatingProperty.ExtensionData = new Dictionary<string, object?>();
             discriminatingProperty.ExtensionData.Add("const", discriminatingPropertyValue);
 
             subSchema.Properties.Add(discriminatingPropertyName, discriminatingProperty);

diff --git a/src/Tools/dotnet-monitor/CollectionRules/Options/Actions/CollectDumpOptions.cs b/src/Tools/dotnet-monitor/CollectionRules/Options/Actions/CollectDumpOptions.cs
@@ -35,6 +35,6 @@ internal sealed partial record class CollectDumpOptions : BaseRecordOptions, IEg
 #if !UNITTEST && !SCHEMAGEN
         [ValidateEgressProvider]
 #endif
-        public string Egress { get; set; }
+        public string Egress { get; set; } = string.Empty;
     }
 }
diff --git a/src/Tools/dotnet-monitor/CollectionRules/Options/Actions/CollectExceptionsOptions.cs b/src/Tools/dotnet-monitor/CollectionRules/Options/Actions/CollectExceptionsOptions.cs
@@ -1,6 +1,8 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+#nullable enable
+
 using Microsoft.Diagnostics.Monitoring.Options;
 using Microsoft.Diagnostics.Monitoring.WebApi;
 using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Options.CollectionRuleDefaultsInterfaces;
@@ -25,7 +27,7 @@ internal sealed partial record class CollectExceptionsOptions : BaseRecordOption
 #if !UNITTEST && !SCHEMAGEN
         [ValidateEgressProvider]
 #endif
-        public string Egress { get; set; }
+        public string Egress { get; set; } = string.Empty;
 
         [Display(
             ResourceType = typeof(OptionsDisplayStrings),
@@ -36,6 +38,6 @@ internal sealed partial record class CollectExceptionsOptions : BaseRecordOption
         [Display(
             ResourceType = typeof(OptionsDisplayStrings),
             Description = nameof(OptionsDisplayStrings.DisplayAttributeDescription_CollectExceptionsOptions_Filters))]
-        public ExceptionsConfiguration Filters { get; set; }
+        public ExceptionsConfiguration? Filters { get; set; }
     }
 }
diff --git a/src/Tools/dotnet-monitor/CollectionRules/Options/Actions/CollectGCDumpOptions.cs b/src/Tools/dotnet-monitor/CollectionRules/Options/Actions/CollectGCDumpOptions.cs
@@ -26,6 +26,6 @@ internal sealed partial record class CollectGCDumpOptions : BaseRecordOptions, I
 #if !UNITTEST && !SCHEMAGEN
         [ValidateEgressProvider]
 #endif
-        public string Egress { get; set; }
+        public string Egress { get; set; } = string.Empty;
     }
 }
diff --git a/src/Tools/dotnet-monitor/CollectionRules/Options/Actions/CollectLiveMetricsOptions.cs b/src/Tools/dotnet-monitor/CollectionRules/Options/Actions/CollectLiveMetricsOptions.cs
@@ -1,6 +1,8 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+#nullable enable
+
 using Microsoft.Diagnostics.Monitoring.WebApi;
 using Microsoft.Diagnostics.Monitoring.WebApi.Models;
 using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Options.CollectionRuleDefaultsInterfaces;
@@ -29,12 +31,12 @@ internal sealed partial record class CollectLiveMetricsOptions : BaseRecordOptio
         [Display(
             ResourceType = typeof(OptionsDisplayStrings),
             Description = nameof(OptionsDisplayStrings.DisplayAttributeDescription_CollectLiveMetricsOptions_Providers))]
-        public EventMetricsProvider[] Providers { get; set; }
+        public EventMetricsProvider[]? Providers { get; set; }
 
         [Display(
             ResourceType = typeof(OptionsDisplayStrings),
             Description = nameof(OptionsDisplayStrings.DisplayAttributeDescription_CollectLiveMetricsOptions_Meters))]
-        public EventMetricsMeter[] Meters { get; set; }
+        public EventMetricsMeter[]? Meters { get; set; }
 
         [Display(
             ResourceType = typeof(OptionsDisplayStrings),
@@ -52,6 +54,6 @@ internal sealed partial record class CollectLiveMetricsOptions : BaseRecordOptio
 #if !UNITTEST && !SCHEMAGEN
         [ValidateEgressProvider]
 #endif
-        public string Egress { get; set; }
+        public string Egress { get; set; } = string.Empty;
     }
 }
diff --git a/src/Tools/dotnet-monitor/CollectionRules/Options/Actions/CollectLogsOptions.cs b/src/Tools/dotnet-monitor/CollectionRules/Options/Actions/CollectLogsOptions.cs
@@ -1,6 +1,8 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+#nullable enable
+
 using Microsoft.Diagnostics.Monitoring.Options;
 using Microsoft.Diagnostics.Monitoring.WebApi;
 using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Options.CollectionRuleDefaultsInterfaces;
@@ -32,7 +34,7 @@ internal sealed partial record class CollectLogsOptions : BaseRecordOptions, IEg
         [Display(
             ResourceType = typeof(OptionsDisplayStrings),
             Description = nameof(OptionsDisplayStrings.DisplayAttributeDescription_CollectLogsOptions_FilterSpecs))]
-        public Dictionary<string, LogLevel?> FilterSpecs { get; set; }
+        public Dictionary<string, LogLevel?>? FilterSpecs { get; set; }
 
         [Display(
             ResourceType = typeof(OptionsDisplayStrings),
@@ -56,7 +58,7 @@ internal sealed partial record class CollectLogsOptions : BaseRecordOptions, IEg
 #if !UNITTEST && !SCHEMAGEN
         [ValidateEgressProvider]
 #endif
-        public string Egress { get; set; }
+        public string Egress { get; set; } = string.Empty;
 
         [Display(
             ResourceType = typeof(OptionsDisplayStrings),

diff --git a/src/Tools/dotnet-monitor/CollectionRules/Options/Actions/CollectStacksOptions.cs b/src/Tools/dotnet-monitor/CollectionRules/Options/Actions/CollectStacksOptions.cs
@@ -31,7 +31,7 @@ internal sealed partial record class CollectStacksOptions : BaseRecordOptions, I
 #if !UNITTEST && !SCHEMAGEN
         [ValidateEgressProvider]
 #endif
-        public string Egress { get; set; }
+        public string Egress { get; set; } = string.Empty;
 
         [Display(
             ResourceType = typeof(OptionsDisplayStrings),

diff --git a/src/Tools/dotnet-monitor/CollectionRules/Options/Actions/CollectTraceOptions.cs b/src/Tools/dotnet-monitor/CollectionRules/Options/Actions/CollectTraceOptions.cs
@@ -1,6 +1,8 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+#nullable enable
+
 using Microsoft.Diagnostics.Monitoring.WebApi;
 using Microsoft.Diagnostics.Monitoring.WebApi.Models;
 using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Options.CollectionRuleDefaultsInterfaces;
@@ -30,7 +32,7 @@ internal sealed partial record class CollectTraceOptions : BaseRecordOptions, IE
         [Display(
             ResourceType = typeof(OptionsDisplayStrings),
             Description = nameof(OptionsDisplayStrings.DisplayAttributeDescription_CollectTraceOptions_Providers))]
-        public List<EventPipeProvider> Providers { get; set; }
+        public List<EventPipeProvider>? Providers { get; set; }
 
         [Display(
             ResourceType = typeof(OptionsDisplayStrings),
@@ -61,11 +63,11 @@ internal sealed partial record class CollectTraceOptions : BaseRecordOptions, IE
 #if !UNITTEST && !SCHEMAGEN
         [ValidateEgressProvider]
 #endif
-        public string Egress { get; set; }
+        public string Egress { get; set; } = string.Empty;
 
         [Display(
             ResourceType = typeof(OptionsDisplayStrings),
             Description = nameof(OptionsDisplayStrings.DisplayAttributeDescription_CollectTraceOptions_StoppingEvent))]
-        public TraceEventFilter StoppingEvent { get; set; }
+        public TraceEventFilter? StoppingEvent { get; set; }
     }
 }
diff --git a/src/Tools/dotnet-monitor/CollectionRules/Options/Actions/ExecuteOptions.cs b/src/Tools/dotnet-monitor/CollectionRules/Options/Actions/ExecuteOptions.cs
@@ -1,6 +1,8 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+#nullable enable
+
 using Microsoft.Diagnostics.Monitoring.WebApi;
 using System.ComponentModel;
 using System.ComponentModel.DataAnnotations;
@@ -21,13 +23,13 @@ internal sealed record class ExecuteOptions : BaseRecordOptions
             ResourceType = typeof(OptionsDisplayStrings),
             Description = nameof(OptionsDisplayStrings.DisplayAttributeDescription_ExecuteOptions_Path))]
         [Required]
-        public string Path { get; set; }
+        public string Path { get; set; } = string.Empty;
 
         [Display(
             ResourceType = typeof(OptionsDisplayStrings),
             Description = nameof(OptionsDisplayStrings.DisplayAttributeDescription_ExecuteOptions_Arguments))]
         [ActionOptionsDependencyProperty]
-        public string Arguments { get; set; }
+        public string? Arguments { get; set; }
 
         [DefaultValue(ExecuteOptionsDefaults.IgnoreExitCode)]
         public bool? IgnoreExitCode { get; set; }

diff --git a/src/Tools/dotnet-monitor/CollectionRules/Options/Actions/GetEnvironmentVariableOptions.cs b/src/Tools/dotnet-monitor/CollectionRules/Options/Actions/GetEnvironmentVariableOptions.cs
@@ -20,6 +20,6 @@ internal sealed record class GetEnvironmentVariableOptions : BaseRecordOptions
             ResourceType = typeof(OptionsDisplayStrings),
             Description = nameof(OptionsDisplayStrings.DisplayAttributeDescription_GetEnvironmentVariableOptions_Name))]
         [Required]
-        public string Name { get; set; }
+        public string Name { get; set; } = string.Empty;
     }
 }
diff --git a/src/Tools/dotnet-monitor/CollectionRules/Options/Actions/LoadProfilerOptions.cs b/src/Tools/dotnet-monitor/CollectionRules/Options/Actions/LoadProfilerOptions.cs
@@ -21,7 +21,7 @@ internal sealed record class LoadProfilerOptions : BaseRecordOptions
             ResourceType = typeof(OptionsDisplayStrings),
             Description = nameof(OptionsDisplayStrings.DisplayAttributeDescription_LoadProfilerOptions_Path))]
         [Required]
-        public string Path { get; set; }
+        public string Path { get; set; } = string.Empty;
 
         [Display(
             ResourceType = typeof(OptionsDisplayStrings),

diff --git a/src/Tools/dotnet-monitor/CollectionRules/Options/Actions/SetEnvironmentVariableOptions.cs b/src/Tools/dotnet-monitor/CollectionRules/Options/Actions/SetEnvironmentVariableOptions.cs
@@ -1,6 +1,8 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+#nullable enable
+
 using Microsoft.Diagnostics.Monitoring.WebApi;
 using System.ComponentModel.DataAnnotations;
 using System.Diagnostics;
@@ -20,11 +22,11 @@ internal sealed record class SetEnvironmentVariableOptions : BaseRecordOptions
             ResourceType = typeof(OptionsDisplayStrings),
             Description = nameof(OptionsDisplayStrings.DisplayAttributeDescription_SetEnvironmentVariableOptions_Name))]
         [Required]
-        public string Name { get; set; }
+        public string Name { get; set; } = string.Empty;
 
         [Display(
             ResourceType = typeof(OptionsDisplayStrings),
             Description = nameof(OptionsDisplayStrings.DisplayAttributeDescription_SetEnvironmentVariableOptions_Value))]
-        public string Value { get; set; }
+        public string? Value { get; set; }
     }
 }
diff --git a/src/Tools/dotnet-monitor/CollectionRules/Options/Actions/TraceEventFilter.cs b/src/Tools/dotnet-monitor/CollectionRules/Options/Actions/TraceEventFilter.cs
@@ -1,6 +1,8 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+#nullable enable
+
 using Microsoft.Diagnostics.Monitoring.WebApi;
 using System.Collections.Generic;
 using System.ComponentModel.DataAnnotations;
@@ -21,17 +23,17 @@ internal sealed record class TraceEventFilter : BaseRecordOptions
             ResourceType = typeof(OptionsDisplayStrings),
             Description = nameof(OptionsDisplayStrings.DisplayAttributeDescription_TraceEventFilter_ProviderName))]
         [Required]
-        public string ProviderName { get; set; }
+        public string ProviderName { get; set; } = string.Empty;
 
         [Display(
             ResourceType = typeof(OptionsDisplayStrings),
             Description = nameof(OptionsDisplayStrings.DisplayAttributeDescription_TraceEventFilter_EventName))]
         [Required]
-        public string EventName { get; set; }
+        public string EventName { get; set; } = string.Empty;
 
         [Display(
             ResourceType = typeof(OptionsDisplayStrings),
             Description = nameof(OptionsDisplayStrings.DisplayAttributeDescription_TraceEventFilter_PayloadFilter))]
-        public IDictionary<string, string> PayloadFilter { get; set; }
+        public IDictionary<string, string>? PayloadFilter { get; set; }
     }
 }
diff --git a/src/Tools/dotnet-monitor/CollectionRules/Options/CollectionRuleActionDefaultsOptions.cs b/src/Tools/dotnet-monitor/CollectionRules/Options/CollectionRuleActionDefaultsOptions.cs
@@ -1,6 +1,8 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+#nullable enable
+
 using Microsoft.Diagnostics.Monitoring.WebApi;
 using System.ComponentModel.DataAnnotations;
 
@@ -11,6 +13,6 @@ internal sealed class CollectionRuleActionDefaultsOptions
         [Display(
             ResourceType = typeof(OptionsDisplayStrings),
             Description = nameof(OptionsDisplayStrings.DisplayAttributeDescription_CollectionRuleActionDefaultsOptions_Egress))]
-        public string Egress { get; set; }
+        public string? Egress { get; set; }
     }
 }