API review of Steeltoe.Configuration

Steeltoe.Debug.ruleset

@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <RuleSet Name="Steeltoe Debug" Description="Code quality rules for Steeltoe debug builds" ToolsVersion="17.0">
   <Rules AnalyzerId="SonarAnalyzer.CSharp" RuleNamespace="SonarAnalyzer.CSharp">
     <Rule Id="S100" Action="Warning" />
@@ -7,10 +7,9 @@
     <Rule Id="S1075" Action="None" />
     <Rule Id="S108" Action="Info" />
     <Rule Id="S110" Action="Warning" />
-    <Rule Id="S1104" Action="Info" />
+    <Rule Id="S1104" Action="None" />
     <Rule Id="S1135" Action="Info" />
     <Rule Id="S1151" Action="Warning" />
-    <Rule Id="S1168" Action="Info" />
     <Rule Id="S1172" Action="Info" />
     <Rule Id="S1185" Action="Info" />
     <Rule Id="S1186" Action="None" />
@@ -29,6 +28,7 @@
     <Rule Id="S2187" Action="None" />
     <Rule Id="S2327" Action="Warning" />
     <Rule Id="S2342" Action="Warning" />
+    <Rule Id="S2360" Action="Warning" />
     <Rule Id="S2387" Action="Warning" />
     <Rule Id="S2437" Action="Warning" />
     <Rule Id="S2583" Action="Info" />
@@ -46,19 +46,26 @@
     <Rule Id="S3597" Action="None" />
     <Rule Id="S3598" Action="None" />
     <Rule Id="S3776" Action="Info" />
+    <Rule Id="S3872" Action="Warning" />
+    <Rule Id="S3874" Action="Warning" />
     <Rule Id="S3884" Action="None" />
     <Rule Id="S3889" Action="None" />
+    <Rule Id="S3898" Action="Warning" />
     <Rule Id="S3906" Action="Warning" />
     <Rule Id="S3908" Action="Warning" />
     <Rule Id="S3925" Action="None" />
     <Rule Id="S3926" Action="None" />
     <Rule Id="S3927" Action="None" />
     <Rule Id="S3937" Action="Warning" />
+    <Rule Id="S3956" Action="Warning" />
     <Rule Id="S3962" Action="Warning" />
     <Rule Id="S3993" Action="Warning" />
     <Rule Id="S3998" Action="None" />
+    <Rule Id="S4004" Action="Warning" />
     <Rule Id="S4022" Action="Warning" />
+    <Rule Id="S4023" Action="Warning" />
     <Rule Id="S4039" Action="Warning" />
+    <Rule Id="S4059" Action="Warning" />
     <Rule Id="S4060" Action="Warning" />
     <Rule Id="S4061" Action="None" />
     <Rule Id="S4159" Action="None" />
@@ -150,7 +157,6 @@
     <Rule Id="SA1217" Action="Info" />
     <Rule Id="SA1309" Action="None" />
     <Rule Id="SA1400" Action="None" />
-    <Rule Id="SA1401" Action="None" />
     <Rule Id="SA1402" Action="None" />
     <Rule Id="SA1407" Action="None" />
     <Rule Id="SA1408" Action="None" />
@@ -186,4 +192,4 @@
     <Rule Id="SA1649" Action="None" />
     <Rule Id="SX1309" Action="Warning" />
   </Rules>
-</RuleSet>
+</RuleSet>

Steeltoe.Release.ruleset

@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <RuleSet Name="Steeltoe Release" Description="Code quality rules for Steeltoe release builds" ToolsVersion="17.0">
   <Rules AnalyzerId="SonarAnalyzer.CSharp" RuleNamespace="SonarAnalyzer.CSharp">
     <Rule Id="S100" Action="Warning" />
@@ -9,7 +9,6 @@
     <Rule Id="S1135" Action="None" />
     <Rule Id="S1144" Action="Warning" />
     <Rule Id="S1151" Action="Warning" />
-    <Rule Id="S1168" Action="None" />
     <Rule Id="S1186" Action="None" />
     <Rule Id="S1244" Action="Warning" />
     <Rule Id="S125" Action="None" />
@@ -24,6 +23,7 @@
     <Rule Id="S2187" Action="None" />
     <Rule Id="S2327" Action="Warning" />
     <Rule Id="S2342" Action="Warning" />
+    <Rule Id="S2360" Action="Warning" />
     <Rule Id="S2387" Action="Warning" />
     <Rule Id="S2437" Action="Warning" />
     <Rule Id="S2674" Action="Warning" />
@@ -34,19 +34,27 @@
     <Rule Id="S3433" Action="None" />
     <Rule Id="S3597" Action="None" />
     <Rule Id="S3598" Action="None" />
+    <Rule Id="S3872" Action="Warning" />
+    <Rule Id="S3874" Action="Warning" />
     <Rule Id="S3884" Action="None" />
     <Rule Id="S3889" Action="None" />
+    <Rule Id="S3898" Action="Warning" />
+    <Rule Id="S3900" Action="Warning" />
     <Rule Id="S3906" Action="Warning" />
     <Rule Id="S3908" Action="Warning" />
     <Rule Id="S3925" Action="None" />
     <Rule Id="S3926" Action="None" />
     <Rule Id="S3927" Action="None" />
     <Rule Id="S3937" Action="Warning" />
+    <Rule Id="S3956" Action="Warning" />
     <Rule Id="S3962" Action="Warning" />
     <Rule Id="S3993" Action="Warning" />
     <Rule Id="S3998" Action="None" />
+    <Rule Id="S4004" Action="Warning" />
     <Rule Id="S4022" Action="Warning" />
+    <Rule Id="S4023" Action="Warning" />
     <Rule Id="S4039" Action="Warning" />
+    <Rule Id="S4059" Action="Warning" />
     <Rule Id="S4060" Action="Warning" />
     <Rule Id="S4061" Action="None" />
     <Rule Id="S4159" Action="None" />
@@ -58,7 +66,7 @@
     <Rule Id="S4277" Action="None" />
     <Rule Id="S4428" Action="None" />
     <Rule Id="S4433" Action="None" />
-    <Rule Id="S4487" Action="None" />
+    <Rule Id="S4487" Action="Warning" />
     <Rule Id="S4583" Action="None" />
     <Rule Id="S5773" Action="None" />
     <Rule Id="S881" Action="Warning" />
@@ -133,7 +141,6 @@
     <Rule Id="SA1214" Action="None" />
     <Rule Id="SA1309" Action="None" />
     <Rule Id="SA1400" Action="None" />
-    <Rule Id="SA1401" Action="None" />
     <Rule Id="SA1402" Action="None" />
     <Rule Id="SA1407" Action="None" />
     <Rule Id="SA1408" Action="None" />
@@ -165,4 +172,4 @@
     <Rule Id="SA1649" Action="None" />
     <Rule Id="SX1309" Action="Warning" />
   </Rules>
-</RuleSet>
+</RuleSet>

shared-package.props

@@ -45,4 +45,14 @@
   <Target Name="ValidatePackage" AfterTargets="BeforeBuild">
     <Error Text="The 'Description' property must be set for packable project '$(MSBuildProjectName)'." Condition="'$(Description)' == ''" />
   </Target>
+
+  <ItemGroup Condition="$(MSBuildProjectName.StartsWith('Steeltoe.Configuration'))">
+    <!-- Widen the condition above as we're completing more public API reviews -->
+    <PackageReference Include="Microsoft.CodeAnalysis.PublicApiAnalyzers" Version="$(PublicApiAnalyzersVersion)" PrivateAssets="All" />
+  </ItemGroup>
+
+  <PropertyGroup Condition="!$(MSBuildProjectName.StartsWith('Steeltoe.Configuration'))">
+    <!-- Narrow the condition above as we're completing more public API reviews -->
+    <NoWarn>$(NoWarn);SA1401;S1168;S2360;S3872;S3874;S3898;S3956;S4004;S4023;S4059;S4487;S3900</NoWarn>
+  </PropertyGroup>
 </Project>

shared-project.props

@@ -1,6 +1,6 @@
 <Project>
   <PropertyGroup>
-    <NoWarn>$(NoWarn);SA0001</NoWarn>
+    <NoWarn>$(NoWarn);SA0001;S3900</NoWarn>
     <IsPackable>false</IsPackable>
   </PropertyGroup>
 

src/Bootstrap/src/AutoConfiguration/HostBuilderExtensions.cs

@@ -9,6 +9,11 @@
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Logging.Abstractions;
 using Steeltoe.Common;
+using Steeltoe.Configuration.CloudFoundry;
+using Steeltoe.Configuration.ConfigServer;
+using Steeltoe.Configuration.Kubernetes;
+using Steeltoe.Configuration.Placeholder;
+using Steeltoe.Configuration.RandomValue;
 using Steeltoe.Connector;
 using Steeltoe.Connector.MongoDb;
 using Steeltoe.Connector.MySql;
@@ -18,11 +23,6 @@
 using Steeltoe.Connector.Redis;
 using Steeltoe.Connector.SqlServer;
 using Steeltoe.Discovery.Client;
-using Steeltoe.Extensions.Configuration.CloudFoundry;
-using Steeltoe.Extensions.Configuration.ConfigServer;
-using Steeltoe.Extensions.Configuration.Kubernetes;
-using Steeltoe.Extensions.Configuration.Placeholder;
-using Steeltoe.Extensions.Configuration.RandomValue;
 using Steeltoe.Extensions.Logging.DynamicSerilog;
 using Steeltoe.Management.Endpoint;
 using Steeltoe.Management.Endpoint.Metrics;
@@ -60,8 +60,8 @@ static HostBuilderExtensions()
     public static IHostBuilder AddSteeltoe(this IHostBuilder hostBuilder, IEnumerable<string> exclusions = null, ILoggerFactory loggerFactory = null)
     {
         AssemblyExtensions.ExcludedAssemblies = exclusions ?? new List<string>();
-        _loggerFactory = loggerFactory;
-        ILogger logger = loggerFactory?.CreateLogger(LoggerName) ?? NullLogger.Instance;
+        _loggerFactory = loggerFactory ?? NullLoggerFactory.Instance;
+        ILogger logger = _loggerFactory.CreateLogger(LoggerName);
         hostBuilder.Properties[LoggerName] = logger;
 
         if (!hostBuilder.WireIfLoaded(WireConfigServer, SteeltoeAssemblies.SteeltoeExtensionsConfigurationConfigServer))
@@ -126,22 +126,18 @@ private static bool WireIfLoaded(this IHostBuilder hostBuilder, Action<IHostBuil
         return false;
     }
 
-    private static bool WireIfAnyLoaded(this IHostBuilder hostBuilder, Action<IHostBuilder> action, params string[] assembly)
+    private static void WireIfAnyLoaded(this IHostBuilder hostBuilder, Action<IHostBuilder> action, params string[] assembly)
     {
         if (assembly.Any(AssemblyExtensions.IsAssemblyLoaded))
         {
             action(hostBuilder);
-            return true;
         }
-
-        return false;
     }
 
-    private static IHostBuilder Log(this IHostBuilder host, string message)
+    private static void Log(this IHostBuilder host, string message)
     {
         var logger = (ILogger)host.Properties[LoggerName];
         logger.LogInformation(message);
-        return host;
     }
 
     [MethodImpl(MethodImplOptions.NoInlining)]
@@ -160,7 +156,7 @@ private static void WireCloudFoundryConfiguration(this IHostBuilder hostBuilder)
     [MethodImpl(MethodImplOptions.NoInlining)]
     private static void WireKubernetesConfiguration(this IHostBuilder hostBuilder)
     {
-        hostBuilder.ConfigureAppConfiguration(cfg => cfg.AddKubernetes(loggerFactory: _loggerFactory))
+        hostBuilder.ConfigureAppConfiguration(cfg => cfg.AddKubernetes(_loggerFactory))
             .ConfigureServices(serviceCollection => serviceCollection.AddKubernetesConfigurationServices()).Log(LogMessages.WireKubernetesConfiguration);
     }
 

src/Bootstrap/src/AutoConfiguration/Steeltoe.Bootstrap.AutoConfiguration.csproj

@@ -14,11 +14,11 @@
 
   <ItemGroup>
     <ProjectReference Include="..\..\..\Common\src\Common\Steeltoe.Common.csproj" />
-    <ProjectReference Include="..\..\..\Configuration\src\CloudFoundry\Steeltoe.Extensions.Configuration.CloudFoundry.csproj" PrivateAssets="All" />
-    <ProjectReference Include="..\..\..\Configuration\src\ConfigServer\Steeltoe.Extensions.Configuration.ConfigServer.csproj" PrivateAssets="All" />
-    <ProjectReference Include="..\..\..\Configuration\src\Kubernetes\Steeltoe.Extensions.Configuration.Kubernetes.csproj" PrivateAssets="All" />
-    <ProjectReference Include="..\..\..\Configuration\src\RandomValue\Steeltoe.Extensions.Configuration.RandomValue.csproj" PrivateAssets="All" />
-    <ProjectReference Include="..\..\..\Configuration\src\Placeholder\Steeltoe.Extensions.Configuration.Placeholder.csproj" PrivateAssets="All" />
+    <ProjectReference Include="..\..\..\Configuration\src\CloudFoundry\Steeltoe.Configuration.CloudFoundry.csproj" PrivateAssets="All" />
+    <ProjectReference Include="..\..\..\Configuration\src\ConfigServer\Steeltoe.Configuration.ConfigServer.csproj" PrivateAssets="All" />
+    <ProjectReference Include="..\..\..\Configuration\src\Kubernetes\Steeltoe.Configuration.Kubernetes.csproj" PrivateAssets="All" />
+    <ProjectReference Include="..\..\..\Configuration\src\RandomValue\Steeltoe.Configuration.RandomValue.csproj" PrivateAssets="All" />
+    <ProjectReference Include="..\..\..\Configuration\src\Placeholder\Steeltoe.Configuration.Placeholder.csproj" PrivateAssets="All" />
     <ProjectReference Include="..\..\..\Connectors\src\EntityFramework6\Steeltoe.Connector.EntityFramework6.csproj" PrivateAssets="All" />
     <ProjectReference Include="..\..\..\Connectors\src\Connector\Steeltoe.Connector.csproj" PrivateAssets="All" />
     <ProjectReference Include="..\..\..\Discovery\src\Client\Steeltoe.Discovery.Client.csproj" PrivateAssets="All" />

src/Bootstrap/src/AutoConfiguration/SteeltoeAssemblies.cs

@@ -8,11 +8,11 @@ namespace Steeltoe.Bootstrap.AutoConfiguration;
 
 public static class SteeltoeAssemblies
 {
-    public const string SteeltoeExtensionsConfigurationCloudFoundry = "Steeltoe.Extensions.Configuration.CloudFoundry";
-    public const string SteeltoeExtensionsConfigurationConfigServer = "Steeltoe.Extensions.Configuration.ConfigServer";
-    public const string SteeltoeExtensionsConfigurationKubernetes = "Steeltoe.Extensions.Configuration.Kubernetes";
-    public const string SteeltoeExtensionsConfigurationRandomValue = "Steeltoe.Extensions.Configuration.RandomValue";
-    public const string SteeltoeExtensionsConfigurationPlaceholder = "Steeltoe.Extensions.Configuration.Placeholder";
+    public const string SteeltoeExtensionsConfigurationCloudFoundry = "Steeltoe.Configuration.CloudFoundry";
+    public const string SteeltoeExtensionsConfigurationConfigServer = "Steeltoe.Configuration.ConfigServer";
+    public const string SteeltoeExtensionsConfigurationKubernetes = "Steeltoe.Configuration.Kubernetes";
+    public const string SteeltoeExtensionsConfigurationRandomValue = "Steeltoe.Configuration.RandomValue";
+    public const string SteeltoeExtensionsConfigurationPlaceholder = "Steeltoe.Configuration.Placeholder";
     public const string SteeltoeConnector = "Steeltoe.Connector";
     public const string SteeltoeDiscoveryClient = "Steeltoe.Discovery.Client";
     public const string SteeltoeExtensionsLoggingDynamicSerilog = "Steeltoe.Extensions.Logging.DynamicSerilog";

src/Bootstrap/src/AutoConfiguration/WebApplicationBuilderExtensions.cs

@@ -8,6 +8,11 @@
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Logging.Abstractions;
 using Steeltoe.Common;
+using Steeltoe.Configuration.CloudFoundry;
+using Steeltoe.Configuration.ConfigServer;
+using Steeltoe.Configuration.Kubernetes;
+using Steeltoe.Configuration.Placeholder;
+using Steeltoe.Configuration.RandomValue;
 using Steeltoe.Connector;
 using Steeltoe.Connector.MongoDb;
 using Steeltoe.Connector.MySql;
@@ -17,11 +22,6 @@
 using Steeltoe.Connector.Redis;
 using Steeltoe.Connector.SqlServer;
 using Steeltoe.Discovery.Client;
-using Steeltoe.Extensions.Configuration.CloudFoundry;
-using Steeltoe.Extensions.Configuration.ConfigServer;
-using Steeltoe.Extensions.Configuration.Kubernetes;
-using Steeltoe.Extensions.Configuration.Placeholder;
-using Steeltoe.Extensions.Configuration.RandomValue;
 using Steeltoe.Extensions.Logging.DynamicSerilog;
 using Steeltoe.Management.Endpoint;
 using Steeltoe.Management.Kubernetes;
@@ -60,8 +60,8 @@ public static WebApplicationBuilder AddSteeltoe(this WebApplicationBuilder webAp
         ILoggerFactory loggerFactory = null)
     {
         AssemblyExtensions.ExcludedAssemblies = exclusions ?? new List<string>();
-        _loggerFactory = loggerFactory;
-        _logger = loggerFactory?.CreateLogger(LoggerName) ?? NullLogger.Instance;
+        _loggerFactory = loggerFactory ?? NullLoggerFactory.Instance;
+        _logger = _loggerFactory.CreateLogger(LoggerName);
 
         if (!webApplicationBuilder.WireIfLoaded(WireConfigServer, SteeltoeAssemblies.SteeltoeExtensionsConfigurationConfigServer))
         {
@@ -162,7 +162,7 @@ private static void WireCloudFoundryConfiguration(this WebApplicationBuilder web
     [MethodImpl(MethodImplOptions.NoInlining)]
     private static void WireKubernetesConfiguration(this WebApplicationBuilder webApplicationBuilder)
     {
-        webApplicationBuilder.Configuration.AddKubernetes(loggerFactory: _loggerFactory);
+        webApplicationBuilder.Configuration.AddKubernetes(_loggerFactory);
         webApplicationBuilder.Services.AddKubernetesConfigurationServices();
         Log(LogMessages.WireKubernetesConfiguration);
     }

src/Bootstrap/src/AutoConfiguration/WebHostBuilderExtensions.cs

@@ -9,6 +9,11 @@
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Logging.Abstractions;
 using Steeltoe.Common;
+using Steeltoe.Configuration.CloudFoundry;
+using Steeltoe.Configuration.ConfigServer;
+using Steeltoe.Configuration.Kubernetes;
+using Steeltoe.Configuration.Placeholder;
+using Steeltoe.Configuration.RandomValue;
 using Steeltoe.Connector;
 using Steeltoe.Connector.MongoDb;
 using Steeltoe.Connector.MySql;
@@ -18,11 +23,6 @@
 using Steeltoe.Connector.Redis;
 using Steeltoe.Connector.SqlServer;
 using Steeltoe.Discovery.Client;
-using Steeltoe.Extensions.Configuration.CloudFoundry;
-using Steeltoe.Extensions.Configuration.ConfigServer;
-using Steeltoe.Extensions.Configuration.Kubernetes;
-using Steeltoe.Extensions.Configuration.Placeholder;
-using Steeltoe.Extensions.Configuration.RandomValue;
 using Steeltoe.Extensions.Logging.DynamicSerilog;
 using Steeltoe.Management.Endpoint;
 using Steeltoe.Management.Endpoint.Metrics;
@@ -61,8 +61,8 @@ static WebHostBuilderExtensions()
     public static IWebHostBuilder AddSteeltoe(this IWebHostBuilder hostBuilder, IEnumerable<string> exclusions = null, ILoggerFactory loggerFactory = null)
     {
         AssemblyExtensions.ExcludedAssemblies = exclusions ?? new List<string>();
-        _loggerFactory = loggerFactory;
-        _logger = loggerFactory?.CreateLogger(LoggerName) ?? NullLogger.Instance;
+        _loggerFactory = loggerFactory ?? NullLoggerFactory.Instance;
+        _logger = _loggerFactory.CreateLogger(LoggerName);
 
         if (!hostBuilder.WireIfLoaded(WireConfigServer, SteeltoeAssemblies.SteeltoeExtensionsConfigurationConfigServer))
         {
@@ -159,7 +159,7 @@ private static void WireCloudFoundryConfiguration(this IWebHostBuilder hostBuild
     [MethodImpl(MethodImplOptions.NoInlining)]
     private static void WireKubernetesConfiguration(this IWebHostBuilder hostBuilder)
     {
-        hostBuilder.ConfigureAppConfiguration(cfg => cfg.AddKubernetes(loggerFactory: _loggerFactory))
+        hostBuilder.ConfigureAppConfiguration(cfg => cfg.AddKubernetes(_loggerFactory))
             .ConfigureServices(serviceCollection => serviceCollection.AddKubernetesConfigurationServices()).Log(LogMessages.WireKubernetesConfiguration);
     }
 

src/Bootstrap/test/AutoConfiguration.Test/HostBuilderExtensionsTest.cs

@@ -22,14 +22,14 @@
 using StackExchange.Redis;
 using Steeltoe.Common.Options;
 using Steeltoe.Common.Security;
+using Steeltoe.Configuration.CloudFoundry;
+using Steeltoe.Configuration.ConfigServer;
+using Steeltoe.Configuration.Kubernetes;
+using Steeltoe.Configuration.Placeholder;
+using Steeltoe.Configuration.RandomValue;
 using Steeltoe.Connector;
 using Steeltoe.Discovery;
 using Steeltoe.Discovery.Eureka;
-using Steeltoe.Extensions.Configuration.CloudFoundry;
-using Steeltoe.Extensions.Configuration.ConfigServer;
-using Steeltoe.Extensions.Configuration.Kubernetes;
-using Steeltoe.Extensions.Configuration.Placeholder;
-using Steeltoe.Extensions.Configuration.RandomValue;
 using Steeltoe.Extensions.Logging;
 using Steeltoe.Extensions.Logging.DynamicSerilog;
 using Steeltoe.Management.Endpoint;

src/Bootstrap/test/AutoConfiguration.Test/Steeltoe.Bootstrap.AutoConfiguration.Test.csproj

@@ -6,9 +6,9 @@
   <Import Project="..\..\..\..\shared.props" />
 
   <ItemGroup>
-    <ProjectReference Include="..\..\..\Configuration\src\ConfigServer\Steeltoe.Extensions.Configuration.ConfigServer.csproj" />
-    <ProjectReference Include="..\..\..\Configuration\src\Kubernetes\Steeltoe.Extensions.Configuration.Kubernetes.csproj" />
-    <ProjectReference Include="..\..\..\Configuration\src\RandomValue\Steeltoe.Extensions.Configuration.RandomValue.csproj" />
+    <ProjectReference Include="..\..\..\Configuration\src\ConfigServer\Steeltoe.Configuration.ConfigServer.csproj" />
+    <ProjectReference Include="..\..\..\Configuration\src\Kubernetes\Steeltoe.Configuration.Kubernetes.csproj" />
+    <ProjectReference Include="..\..\..\Configuration\src\RandomValue\Steeltoe.Configuration.RandomValue.csproj" />
     <ProjectReference Include="..\..\..\Discovery\src\Client\Steeltoe.Discovery.Client.csproj" />
     <ProjectReference Include="..\..\..\Discovery\src\Eureka\Steeltoe.Discovery.Eureka.csproj" />
     <ProjectReference Include="..\..\..\Logging\src\DynamicSerilog\Steeltoe.Extensions.Logging.DynamicSerilog.csproj" />