API review of Steeltoe.Common

.github/ISSUE_TEMPLATE/bug_report.md

@@ -8,9 +8,9 @@ assignees: ''
 ---
 
 ## Describe the bug
-A clear and concise description of the bug.  
+A clear and concise description of the bug.
 
-## Steps to reproduce 
+## Steps to reproduce
 Steps to reproduce the behavior:
 1.
 2.
@@ -20,9 +20,9 @@ A clear and concise description of what you expected to happen.
 
 ## Environment (please complete the following information):
  - Steeltoe Version [e.g. 2.3.0]
- - Platform: [e.g. Cloud Foundry, Azure, etc.) 
+ - Platform: [e.g. Cloud Foundry, Azure, etc.)
  - OS: [e.g. Windows, Linux, Mac OSX]
- - .NET Version [e.g. .NET Core 2.1.0, .NET Framework 4.7.1, etc.] 
+ - .NET Version [e.g. .NET Core 2.1.0, .NET Framework 4.7.1, etc.]
  - Any other library versions to note
 
 ## Screenshots

.github/ISSUE_TEMPLATE/question.md

@@ -11,7 +11,7 @@ assignees: ''
 _Enter your question or feedback here_
 
 ## Environment (please complete the following information):
- - .NET Version [e.g. .NET Core 3.1.4, .NET Framework 4.7.1, etc.] 
+ - .NET Version [e.g. .NET Core 3.1.4, .NET Framework 4.7.1, etc.]
  - Steeltoe Version [e.g. 3.0.1]
 
 ## Additional context or links

build/pr-code-cleanup.yml

@@ -82,7 +82,7 @@ jobs:
     displayName: Push changes
     condition: and(succeeded(), eq(variables['hasChangesToCommit'], 'True'))
     env:
-      SYSTEM_ACCESSTOKEN: $(System.AccessToken)  
+      SYSTEM_ACCESSTOKEN: $(System.AccessToken)
     inputs:
       targetType: 'inline'
       script: |
@@ -112,7 +112,7 @@ jobs:
           $statusMessage = "<samp>Code cleanup was canceled, no changes were pushed.</samp>"
         }
         elseif ($env:AGENT_JOBSTATUS -eq "Failed") {
-          $url = "$(System.TeamFoundationCollectionUri)$(System.TeamProject)/_build/results?buildId=$(Build.BuildId)" 
+          $url = "$(System.TeamFoundationCollectionUri)$(System.TeamProject)/_build/results?buildId=$(Build.BuildId)"
           $statusMessage = "<samp>Code cleanup failed to reformat and push changes.</samp><p>View details [here]($url).</p>"
         }
         else {

build/sign-packages.ps1

@@ -16,7 +16,7 @@ $appSettings = Join-Path $currentDirectory 'appsettings.json'
 $nupkgs = Get-ChildItem $env:ArtifactDirectory/Steeltoe*.*nupkg -recurse | Select-Object -ExpandProperty FullName
 
 foreach ($nupkg in $nupkgs) {
-	./SignClient 'sign' -c $appSettings -i $nupkg -r $env:SignClientUser -s $env:SignClientSecret -n 'Steeltoe' -d 'Steeltoe' -u 'https://github.com/SteeltoeOSS' 
+	./SignClient 'sign' -c $appSettings -i $nupkg -r $env:SignClientUser -s $env:SignClientSecret -n 'Steeltoe' -d 'Steeltoe' -u 'https://github.com/SteeltoeOSS'
 }
 
 Write-Host "Sign-packages completed."

build/templates/consolidate-coverage.yaml

@@ -28,4 +28,4 @@ jobs:
     displayName: Publish code coverage to Azure DevOps
     inputs:
       codeCoverageTool: Cobertura
-      summaryFileLocation: $(Build.ArtifactStagingDirectory)/CodeCoverage/Cobertura.xml
+      summaryFileLocation: $(Build.ArtifactStagingDirectory)/CodeCoverage/Cobertura.xml

build/verify-code-style.yml

@@ -51,10 +51,10 @@ jobs:
           # We are in detached head (the merge result), so there's no need to account for an out-of-date PR.
           $baseCommitHash = git rev-parse origin/$env:SYSTEM_PULLREQUEST_TARGETBRANCH
           if ($LastExitCode -ne 0) { throw "Command 'git rev-parse (1)' failed with exit code $LastExitCode." }
-  
+
           $headCommitHash = git rev-parse HEAD
           if ($LastExitCode -ne 0) { throw "Command 'git rev-parse (2)' failed with exit code $LastExitCode." }
-  
+
           Write-Output "Running code cleanup on commit range $baseCommitHash..$headCommitHash in pull request."
           dotnet regitlint -s src/Steeltoe.All.sln --print-command --skip-tool-check --max-runs=5 --jb --dotnetcoresdk=$(dotnet --version) --jb-profile="Steeltoe Full Cleanup" --jb --properties:Configuration=Release --jb --properties:NuGetAudit=false --jb --verbosity=WARN --fail-on-diff --print-diff -f commits -a $headCommitHash -b $baseCommitHash
         }

coverlet.runsettings

@@ -4,7 +4,7 @@
     <DataCollectors>
       <DataCollector friendlyName="XPlat Code Coverage">
         <Configuration>
-          <Format>opencover</Format>          
+          <Format>opencover</Format>
           <Exclude>[*.Test*]*,[*]Microsoft.Diagnostics*</Exclude>
           <Include>[Steeltoe.*]*</Include>
           <ExcludeByAttribute>Obsolete,GeneratedCodeAttribute,CompilerGeneratedAttribute</ExcludeByAttribute>
@@ -15,4 +15,4 @@
       </DataCollector>
     </DataCollectors>
   </DataCollectionRunSettings>
-</RunSettings>
+</RunSettings>

shared-package.props

@@ -46,24 +46,11 @@
 
   <ItemGroup>
     <PackageReference Include="Microsoft.SourceLink.GitHub" Version="$(SourceLinkGitHubVersion)" PrivateAssets="All" />
+    <PackageReference Include="Microsoft.CodeAnalysis.PublicApiAnalyzers" Version="$(PublicApiAnalyzersVersion)" PrivateAssets="All" />
   </ItemGroup>
 
   <Target Name="ValidatePackage" AfterTargets="BeforeBuild">
     <Error Text="The 'Description' property must be set for packable project '$(MSBuildProjectName)'." Condition="'$(Description)' == ''" />
     <Error Text="The 'PackageTags' property must be set for packable project '$(MSBuildProjectName)'." Condition="'$(PackageTags)' == ''" />
   </Target>
-
-  <ItemGroup Condition="!$(MSBuildProjectName.StartsWith('Steeltoe.Common'))">
-    <!--
-      Remove the condition above after public API review of Steeltoe.Common.
-    -->
-    <PackageReference Include="Microsoft.CodeAnalysis.PublicApiAnalyzers" Version="$(PublicApiAnalyzersVersion)" PrivateAssets="All" />
-  </ItemGroup>
-
-  <PropertyGroup Condition="$(MSBuildProjectName.StartsWith('Steeltoe.Common'))">
-    <!--
-      Remove the condition above after public API review of Steeltoe.Common.
-    -->
-    <NoWarn>$(NoWarn);SA1401;S1168;S2360;S3900;S3956;S4004;S4023</NoWarn>
-  </PropertyGroup>
 </Project>

shared.props

@@ -1,6 +1,7 @@
 <Project>
   <PropertyGroup>
     <LangVersion>latest</LangVersion>
+    <Nullable>enable</Nullable>
     <ImplicitUsings>enable</ImplicitUsings>
     <EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
     <GenerateAssemblyCompanyAttribute>false</GenerateAssemblyCompanyAttribute>

src/Bootstrap/src/AutoConfiguration/BootstrapScanner.cs

@@ -47,9 +47,10 @@ internal sealed class BootstrapScanner
 
     public BootstrapScanner(HostBuilderWrapper wrapper, IReadOnlySet<string> assemblyNamesToExclude, ILoggerFactory loggerFactory)
     {
-        ArgumentGuard.NotNull(wrapper);
-        ArgumentGuard.NotNull(assemblyNamesToExclude);
-        ArgumentGuard.NotNull(loggerFactory);
+        ArgumentNullException.ThrowIfNull(wrapper);
+        ArgumentNullException.ThrowIfNull(assemblyNamesToExclude);
+        ArgumentGuard.ElementsNotNullOrWhiteSpace(assemblyNamesToExclude);
+        ArgumentNullException.ThrowIfNull(loggerFactory);
 
         _wrapper = wrapper;
         _loader = new AssemblyLoader(assemblyNamesToExclude);
@@ -61,7 +62,7 @@ public void ConfigureSteeltoe()
     {
         if (_loggerFactory is IBootstrapLoggerFactory)
         {
-            BootstrapLoggerHostedService.Register(_loggerFactory, _wrapper);
+            BootstrapLoggerHostedService.Register(_wrapper);
         }
 
         if (!WireIfLoaded(WireConfigServer, SteeltoeAssemblyNames.ConfigurationConfigServer))

src/Bootstrap/src/AutoConfiguration/HostApplicationBuilderExtensions.cs

@@ -23,7 +23,7 @@ public static class HostApplicationBuilderExtensions
     /// The <see cref="IHostApplicationBuilder" /> to configure.
     /// </param>
     /// <returns>
-    /// The incoming <see cref="IHostApplicationBuilder" /> so that additional calls can be chained.
+    /// The incoming <paramref name="builder" /> so that additional calls can be chained.
     /// </returns>
     public static IHostApplicationBuilder AddSteeltoe(this IHostApplicationBuilder builder)
     {
@@ -40,7 +40,7 @@ public static IHostApplicationBuilder AddSteeltoe(this IHostApplicationBuilder b
     /// The set of assembly names to exclude from autoconfiguration. For ease of use, select from the constants in <see cref="SteeltoeAssemblyNames" />.
     /// </param>
     /// <returns>
-    /// The incoming <see cref="IHostApplicationBuilder" /> so that additional calls can be chained.
+    /// The incoming <paramref name="builder" /> so that additional calls can be chained.
     /// </returns>
     public static IHostApplicationBuilder AddSteeltoe(this IHostApplicationBuilder builder, IReadOnlySet<string> assemblyNamesToExclude)
     {
@@ -58,7 +58,7 @@ public static IHostApplicationBuilder AddSteeltoe(this IHostApplicationBuilder b
     /// write only to the console until logging is fully initialized.
     /// </param>
     /// <returns>
-    /// The incoming <see cref="IHostApplicationBuilder" /> so that additional calls can be chained.
+    /// The incoming <paramref name="builder" /> so that additional calls can be chained.
     /// </returns>
     public static IHostApplicationBuilder AddSteeltoe(this IHostApplicationBuilder builder, ILoggerFactory loggerFactory)
     {
@@ -79,14 +79,15 @@ public static IHostApplicationBuilder AddSteeltoe(this IHostApplicationBuilder b
     /// write only to the console until logging is fully initialized.
     /// </param>
     /// <returns>
-    /// The incoming <see cref="IHostApplicationBuilder" /> so that additional calls can be chained.
+    /// The incoming <paramref name="builder" /> so that additional calls can be chained.
     /// </returns>
     public static IHostApplicationBuilder AddSteeltoe(this IHostApplicationBuilder builder, IReadOnlySet<string> assemblyNamesToExclude,
         ILoggerFactory loggerFactory)
     {
-        ArgumentGuard.NotNull(builder);
-        ArgumentGuard.NotNull(assemblyNamesToExclude);
-        ArgumentGuard.NotNull(loggerFactory);
+        ArgumentNullException.ThrowIfNull(builder);
+        ArgumentNullException.ThrowIfNull(assemblyNamesToExclude);
+        ArgumentGuard.ElementsNotNullOrWhiteSpace(assemblyNamesToExclude);
+        ArgumentNullException.ThrowIfNull(loggerFactory);
 
         HostBuilderWrapper wrapper = HostBuilderWrapper.Wrap(builder);
 

src/Bootstrap/src/AutoConfiguration/HostBuilderExtensions.cs

@@ -23,7 +23,7 @@ public static class HostBuilderExtensions
     /// The <see cref="IHostBuilder" /> to configure.
     /// </param>
     /// <returns>
-    /// The incoming <see cref="IHostBuilder" /> so that additional calls can be chained.
+    /// The incoming <paramref name="builder" /> so that additional calls can be chained.
     /// </returns>
     public static IHostBuilder AddSteeltoe(this IHostBuilder builder)
     {
@@ -40,7 +40,7 @@ public static IHostBuilder AddSteeltoe(this IHostBuilder builder)
     /// The set of assembly names to exclude from autoconfiguration. For ease of use, select from the constants in <see cref="SteeltoeAssemblyNames" />.
     /// </param>
     /// <returns>
-    /// The incoming <see cref="IHostBuilder" /> so that additional calls can be chained.
+    /// The incoming <paramref name="builder" /> so that additional calls can be chained.
     /// </returns>
     public static IHostBuilder AddSteeltoe(this IHostBuilder builder, IReadOnlySet<string> assemblyNamesToExclude)
     {
@@ -58,7 +58,7 @@ public static IHostBuilder AddSteeltoe(this IHostBuilder builder, IReadOnlySet<s
     /// write only to the console until logging is fully initialized.
     /// </param>
     /// <returns>
-    /// The incoming <see cref="IHostBuilder" /> so that additional calls can be chained.
+    /// The incoming <paramref name="builder" /> so that additional calls can be chained.
     /// </returns>
     public static IHostBuilder AddSteeltoe(this IHostBuilder builder, ILoggerFactory loggerFactory)
     {
@@ -79,13 +79,14 @@ public static IHostBuilder AddSteeltoe(this IHostBuilder builder, ILoggerFactory
     /// write only to the console until logging is fully initialized.
     /// </param>
     /// <returns>
-    /// The incoming <see cref="IHostBuilder" /> so that additional calls can be chained.
+    /// The incoming <paramref name="builder" /> so that additional calls can be chained.
     /// </returns>
     public static IHostBuilder AddSteeltoe(this IHostBuilder builder, IReadOnlySet<string> assemblyNamesToExclude, ILoggerFactory loggerFactory)
     {
-        ArgumentGuard.NotNull(builder);
-        ArgumentGuard.NotNull(assemblyNamesToExclude);
-        ArgumentGuard.NotNull(loggerFactory);
+        ArgumentNullException.ThrowIfNull(builder);
+        ArgumentNullException.ThrowIfNull(assemblyNamesToExclude);
+        ArgumentGuard.ElementsNotNullOrWhiteSpace(assemblyNamesToExclude);
+        ArgumentNullException.ThrowIfNull(loggerFactory);
 
         HostBuilderWrapper wrapper = HostBuilderWrapper.Wrap(builder);
 

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

@@ -4,7 +4,6 @@
     <Description>Package for automatically configuring Steeltoe packages that have separately been added to a project.</Description>
     <PackageTags>Autoconfiguration;automatic configuration;application bootstrapping</PackageTags>
     <IsPackable>true</IsPackable>
-    <Nullable>enable</Nullable>
   </PropertyGroup>
 
   <Import Project="..\..\..\..\shared.props" />

src/Bootstrap/src/AutoConfiguration/WebHostBuilderExtensions.cs

@@ -23,7 +23,7 @@ public static class WebHostBuilderExtensions
     /// The <see cref="IWebHostBuilder" /> to configure.
     /// </param>
     /// <returns>
-    /// The incoming <see cref="IWebHostBuilder" /> so that additional calls can be chained.
+    /// The incoming <paramref name="builder" /> so that additional calls can be chained.
     /// </returns>
     public static IWebHostBuilder AddSteeltoe(this IWebHostBuilder builder)
     {
@@ -40,7 +40,7 @@ public static IWebHostBuilder AddSteeltoe(this IWebHostBuilder builder)
     /// The set of assembly names to exclude from autoconfiguration. For ease of use, select from the constants in <see cref="SteeltoeAssemblyNames" />.
     /// </param>
     /// <returns>
-    /// The incoming <see cref="IWebHostBuilder" /> so that additional calls can be chained.
+    /// The incoming <paramref name="builder" /> so that additional calls can be chained.
     /// </returns>
     public static IWebHostBuilder AddSteeltoe(this IWebHostBuilder builder, IReadOnlySet<string> assemblyNamesToExclude)
     {
@@ -58,7 +58,7 @@ public static IWebHostBuilder AddSteeltoe(this IWebHostBuilder builder, IReadOnl
     /// write only to the console until logging is fully initialized.
     /// </param>
     /// <returns>
-    /// The incoming <see cref="IWebHostBuilder" /> so that additional calls can be chained.
+    /// The incoming <paramref name="builder" /> so that additional calls can be chained.
     /// </returns>
     public static IWebHostBuilder AddSteeltoe(this IWebHostBuilder builder, ILoggerFactory loggerFactory)
     {
@@ -79,13 +79,14 @@ public static IWebHostBuilder AddSteeltoe(this IWebHostBuilder builder, ILoggerF
     /// write only to the console until logging is fully initialized.
     /// </param>
     /// <returns>
-    /// The incoming <see cref="IWebHostBuilder" /> so that additional calls can be chained.
+    /// The incoming <paramref name="builder" /> so that additional calls can be chained.
     /// </returns>
     public static IWebHostBuilder AddSteeltoe(this IWebHostBuilder builder, IReadOnlySet<string> assemblyNamesToExclude, ILoggerFactory loggerFactory)
     {
-        ArgumentGuard.NotNull(builder);
-        ArgumentGuard.NotNull(assemblyNamesToExclude);
-        ArgumentGuard.NotNull(loggerFactory);
+        ArgumentNullException.ThrowIfNull(builder);
+        ArgumentNullException.ThrowIfNull(assemblyNamesToExclude);
+        ArgumentGuard.ElementsNotNullOrWhiteSpace(assemblyNamesToExclude);
+        ArgumentNullException.ThrowIfNull(loggerFactory);
 
         HostBuilderWrapper wrapper = HostBuilderWrapper.Wrap(builder);
 

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

@@ -14,6 +14,7 @@
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
+using Microsoft.Extensions.Options;
 using MongoDB.Driver;
 using MySqlConnector;
 using Npgsql;
@@ -355,8 +356,12 @@ private static void AssertTracingIsAutowired(HostWrapper hostWrapper)
     {
         var tracerProvider = hostWrapper.Services.GetRequiredService<TracerProvider>();
 
-        hostWrapper.Services.GetService<IHostedService>().Should().NotBeNull();
-        hostWrapper.Services.GetService<TracingOptions>().Should().NotBeNull();
+        IHostedService[] hostedServices = hostWrapper.Services.GetServices<IHostedService>().ToArray();
+        hostedServices.Should().ContainSingle(hostedService => hostedService.GetType().Name == "TelemetryHostedService");
+
+        var optionsMonitor = hostWrapper.Services.GetRequiredService<IOptionsMonitor<TracingOptions>>();
+        optionsMonitor.CurrentValue.Name.Should().NotBeNull();
+
         hostWrapper.Services.GetService<IDynamicMessageProcessor>().Should().NotBeNull();
 
         FieldInfo? instrumentationsField = tracerProvider.GetType().GetField("instrumentations", BindingFlags.NonPublic | BindingFlags.Instance);
@@ -396,7 +401,7 @@ private static IHost GetHostExcluding(IReadOnlySet<string> assemblyNamesToExclud
             {
                 builder.UseDefaultServiceProvider(options => options.ValidateScopes = true);
                 builder.ConfigureAppConfiguration(configurationBuilder => configurationBuilder.AddInMemoryCollection(TestHelpers.FastTestsConfiguration));
-                builder.ConfigureServices(services => services.AddRouting().AddActionDescriptorCollectionProvider());
+                builder.ConfigureServices(services => services.AddRouting().AddActionDescriptorCollectionProviderMock());
                 builder.Configure(applicationBuilder => applicationBuilder.UseRouting());
                 builder.UseTestServer();
 
@@ -411,7 +416,7 @@ private static IWebHost GetWebHostExcluding(IReadOnlySet<string> assemblyNamesTo
             IWebHostBuilder builder = WebHost.CreateDefaultBuilder();
             builder.UseDefaultServiceProvider(options => options.ValidateScopes = true);
             builder.ConfigureAppConfiguration(configurationBuilder => configurationBuilder.AddInMemoryCollection(TestHelpers.FastTestsConfiguration));
-            builder.ConfigureServices(services => services.AddActionDescriptorCollectionProvider());
+            builder.ConfigureServices(services => services.AddActionDescriptorCollectionProviderMock());
             builder.Configure(applicationBuilder => applicationBuilder.UseRouting());
             builder.UseTestServer();
 
@@ -425,7 +430,7 @@ private static WebApplication GetWebApplicationExcluding(IReadOnlySet<string> as
             WebApplicationBuilder builder = WebApplication.CreateBuilder();
             builder.WebHost.UseDefaultServiceProvider(options => options.ValidateScopes = true);
             builder.Configuration.AddInMemoryCollection(TestHelpers.FastTestsConfiguration);
-            builder.Services.AddActionDescriptorCollectionProvider();
+            builder.Services.AddActionDescriptorCollectionProviderMock();
             builder.WebHost.UseTestServer();
 
             builder.AddSteeltoe(assemblyNamesToExclude);

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

@@ -1,7 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <TargetFrameworks>net8.0</TargetFrameworks>
-    <Nullable>enable</Nullable>
   </PropertyGroup>
 
   <Import Project="..\..\..\..\shared.props" />

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

@@ -1,7 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <TargetFrameworks>net8.0</TargetFrameworks>
-    <Nullable>enable</Nullable>
   </PropertyGroup>
 
   <Import Project="..\..\..\..\shared.props" />