Add API approval tests, more implicit usings, add NRT annotations, cleanup whitespaces

.github/workflows/healthchecks_elasticsearch_cd.yml

@@ -5,7 +5,6 @@ on:
     tags:
       - release-elasticsearch-*  # Push events to release-elasticsearch*
 
-
 jobs:
   build:
     env:

.github/workflows/healthchecks_elasticsearch_cd_preview.yml

@@ -5,7 +5,6 @@ on:
     tags:
       - preview-elasticsearch-*  # Push events to release-elasticsearch*
 
-
 jobs:
   build:
     env:

Directory.Build.props

@@ -33,22 +33,39 @@
   <ItemGroup Condition="'$(IsPackable)' == 'true'">
     <None Include="..\..\assets\icon.png" Pack="true" PackagePath="\" />
     <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" PrivateAssets="All" />
+    <Compile Include="../ApiMarker.cs" Link="ApiMarker.cs" />
   </ItemGroup>
 
   <ItemGroup Condition="$(MSBuildProjectName.EndsWith('.Tests')) OR $(MSBuildProjectName) == 'UnitTests'">
     <PackageReference Include="Microsoft.AspNetCore.TestHost" Version="6.0.5" />
     <PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="6.0.0" />
     <PackageReference Include="Microsoft.Extensions.Diagnostics.HealthChecks" Version="6.0.5" />
     <PackageReference Include="FluentAssertions" Version="6.7.0" />
+    <PackageReference Include="Shouldly" Version="4.0.3" />
     <PackageReference Include="NSubstitute" Version="4.3.0" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.2.0" />
     <PackageReference Include="xunit" Version="2.4.1" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.4.5" />
+    <PackageReference Include="PublicApiGenerator" Version="10.3.0" />
     <PackageReference Include="coverlet.collector" Version="3.1.2">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
+
     <ProjectReference Include="..\..\src\HealthChecks.UI.Client\HealthChecks.UI.Client.csproj" />
+
+    <Compile Include="../ApiApprovalTests.cs" Link="ApiApprovalTests.cs" />
+
+    <Using Include="Microsoft.AspNetCore.Diagnostics.HealthChecks" />
+    <Using Include="Microsoft.AspNetCore.Hosting" />
+    <Using Include="Microsoft.AspNetCore.Builder" />
+    <Using Include="Microsoft.AspNetCore.TestHost" />
+    <Using Include="Microsoft.Extensions.DependencyInjection" />
+    <Using Include="Microsoft.Extensions.Diagnostics.HealthChecks" />
+    <Using Include="Microsoft.Extensions.Options" />
+    <Using Include="FluentAssertions" />
+    <Using Include="Shouldly" />
+    <Using Include="Xunit" />
   </ItemGroup>
 
 </Project>

build.ps1

@@ -48,7 +48,6 @@ finally {
     Pop-Location
 }
 
-
 if (-Not (Test-Path 'env:APPVEYOR')) {
     exec { & docker-compose up -d }
 }
@@ -66,7 +65,6 @@ finally {
     Pop-Location
 }
 
-
 if ($suffix -eq "") {
     exec { & dotnet pack .\src\HealthChecks.SqlServer\HealthChecks.SqlServer.csproj -c Release -o .\artifacts --include-symbols --no-build }
     exec { & dotnet pack .\src\HealthChecks.Redis\HealthChecks.Redis.csproj -c Release -o .\artifacts --include-symbols --no-build }

build/docker-images/HealthChecks.UI.Image/Configuration/AzureAppConfiguration.cs

@@ -24,15 +24,15 @@ public static bool Enabled
             EnvironmentVariable.HasValue(AzureAppConfigurationKeys.CacheExpiration)
             && double.TryParse(EnvironmentVariable.GetValue(AzureAppConfigurationKeys.CacheExpiration), out var _);
 
-        public static double CacheExpiration => double.Parse(EnvironmentVariable.GetValue(AzureAppConfigurationKeys.CacheExpiration));
+        public static double CacheExpiration => double.Parse(EnvironmentVariable.GetValue(AzureAppConfigurationKeys.CacheExpiration)!);
 
-        public static string ConnectionString =>
+        public static string? ConnectionString =>
             EnvironmentVariable.GetValue(AzureAppConfigurationKeys.ConnectionString);
 
-        public static string ManagedIdentityEndpoint =>
+        public static string? ManagedIdentityEndpoint =>
             EnvironmentVariable.GetValue(AzureAppConfigurationKeys.ManagedIdentityEndpoint);
 
-        public static string Label =>
+        public static string? Label =>
             EnvironmentVariable.GetValue(AzureAppConfigurationKeys.Label);
     }
 }

build/docker-images/HealthChecks.UI.Image/Configuration/Helpers/EnvironmentVariable.cs

@@ -2,7 +2,7 @@ namespace HealthChecks.UI.Image.Configuration.Helpers
 {
     public class EnvironmentVariable
     {
-        public static string GetValue(string variable) =>
+        public static string? GetValue(string variable) =>
             Environment.GetEnvironmentVariable(variable);
 
         public static bool HasValue(string variable) =>

build/docker-images/HealthChecks.UI.Image/Configuration/StorageProvider.cs

@@ -39,6 +39,7 @@ public class StorageProvider
     {
         public bool RequiresConnectionString { get; set; }
         public Action<HealthChecksUIBuilder, string> SetupProvider { get; set; }
+            = (_, connection) => throw new InvalidOperationException($"Misconfigured storage provider for {connection}");
     }
 
     public enum StorageProviderEnum

build/docker-images/HealthChecks.UI.Image/Extensions/HealthChecksUIBuilderExtensions.cs

@@ -4,7 +4,6 @@ namespace Microsoft.Extensions.DependencyInjection
 {
     public static class HealthChecksUIBuilderExtensions
     {
-
         public static IServiceCollection AddStorageProvider(this HealthChecksUIBuilder builder, IConfiguration configuration)
         {
             string configuredStorage = configuration[UIKeys.STORAGE_PROVIDER];

build/docker-images/HealthChecks.UI.Image/Extensions/IConfigurationBuilderExtensions.cs

@@ -11,7 +11,7 @@ public static IConfigurationBuilder UseAzureAppConfiguration(this IConfiguration
             Action<AzureAppConfigurationOptions> setupConfig = AzureAppConfiguration.UseConnectionString switch
             {
                 true => options => options.Connect(AzureAppConfiguration.ConnectionString),
-                false => options => options.Connect(new Uri(AzureAppConfiguration.ManagedIdentityEndpoint), new ManagedIdentityCredential())
+                false => options => options.Connect(new Uri(AzureAppConfiguration.ManagedIdentityEndpoint!), new ManagedIdentityCredential())
             };
 
             builder.AddAzureAppConfiguration(options =>

build/docker-images/HealthChecks.UI.Image/Extensions/IEndpointRouteBuilderExtensions.cs

@@ -13,7 +13,7 @@ public static IEndpointConventionBuilder MapHealthChecksUI(this IEndpointRouteBu
         {
             if (bool.TryParse(configuration[PushServiceKeys.Enabled], out bool enabled) && enabled)
             {
-                builder.MapHealthCheckPushEndpoint(configuration);
+                builder.MapHealthCheckPushEndpoint(/*configuration*/);
             }
 
             return builder.MapHealthChecksUI(setup =>
@@ -23,10 +23,8 @@ public static IEndpointConventionBuilder MapHealthChecksUI(this IEndpointRouteBu
 
             });
         }
-        private static void MapHealthCheckPushEndpoint(this IEndpointRouteBuilder builder,
-            IConfiguration configuration)
+        private static void MapHealthCheckPushEndpoint(this IEndpointRouteBuilder builder/*, IConfiguration configuration*/)
         {
-
             var logger = builder.ServiceProvider.GetRequiredService<ILogger<Program>>();
             logger.LogInformation("HealthChecks Push Endpoint Enabled");
 
@@ -45,7 +43,7 @@ private static void MapHealthCheckPushEndpoint(this IEndpointRouteBuilder builde
 
                     if (!string.IsNullOrEmpty(name) && !string.IsNullOrEmpty(uri))
                     {
-                        var pushService = context.RequestServices.GetService<HealthChecksPushService>();
+                        var pushService = context.RequestServices.GetRequiredService<HealthChecksPushService>();
 
                         if (type == PushServiceKeys.ServiceAdded)
                         {
@@ -65,7 +63,6 @@ private static void MapHealthCheckPushEndpoint(this IEndpointRouteBuilder builde
                 {
                     context.Response.StatusCode = 401;
                 }
-
             });
         }
     }

build/docker-images/HealthChecks.UI.Image/PushService/HealthChecksPushService.cs

@@ -58,7 +58,7 @@ public async Task UpdateAsync(string name, string uri)
             }
         }
 
-        private Task<HealthCheckConfiguration> Get(string name)
+        private Task<HealthCheckConfiguration?> Get(string name)
         {
             return _db.Configurations.FirstOrDefaultAsync(c => c.Name == name);
         }

dotnet-install.ps1

@@ -248,7 +248,6 @@ function GetHTTPResponse([Uri] $Uri)
     })
 }
 
-
 function Get-Latest-Version-Info([string]$AzureFeed, [string]$Channel, [bool]$Coherent) {
     Say-Invocation $MyInvocation
 
@@ -286,7 +285,6 @@ function Get-Latest-Version-Info([string]$AzureFeed, [string]$Channel, [bool]$Co
     return $VersionInfo
 }
 
-
 function Get-Specific-Version-From-Version([string]$AzureFeed, [string]$Channel, [string]$Version) {
     Say-Invocation $MyInvocation
 

samples/HealthChecks.UIAndApiCustomization/Options/RemoteOptions.cs

@@ -2,6 +2,6 @@ namespace HealthChecks.UIAndApi.Options
 {
     public class RemoteOptions
     {
-        public Uri RemoteDependency { get; set; }
+        public Uri RemoteDependency { get; set; } = null!;
     }
 }

src/ApiMarker.cs

@@ -0,0 +1,6 @@
+/// <summary>
+/// Used for test purposes only.
+/// </summary>
+internal static class ApiMarker
+{
+}

src/HealthChecks.AzureDigitalTwin/AzureDigitalTwinHealthCheck.cs

@@ -52,7 +52,6 @@ public AzureDigitalTwinHealthCheck(TokenCredential tokenCredential)
             TokenCredential = tokenCredential ?? throw new ArgumentNullException(nameof(tokenCredential));
         }
 
-
         protected AzureDigitalTwinsManagementClient CreateManagementClient()
         {
             var credential = ServiceClientCredentials

src/HealthChecks.Publisher.ApplicationInsights/ApplicationInsightsPublisher.cs

@@ -50,7 +50,6 @@ public Task PublishAsync(HealthReport report, CancellationToken cancellationToke
                 SaveGeneralizedReport(report, client);
             }
 
-
             return Task.CompletedTask;
         }
 

src/HealthChecks.UI/Core/UIResourceMapper.cs

@@ -53,7 +53,6 @@ public void Map(IApplicationBuilder app, Options options)
                 });
             });
 
-
             foreach (var item in styleSheets)
             {
                 app.Map(item.ResourcePath, appBuilder =>

src/HealthChecks.UI/Extensions/EndpointRouteBuilderExtensions.cs

@@ -31,7 +31,6 @@ public static IEndpointConventionBuilder MapHealthChecksUI(this IEndpointRouteBu
                     .UseMiddleware<UIWebHooksApiMiddleware>()
                     .Build();
 
-
             var embeddedResourcesAssembly = typeof(UIResource).Assembly;
 
             var resourcesEndpoints =

src/HealthChecks.UI/assets/healthchecksui.css

@@ -331,7 +331,6 @@ h4 {
   min-width: 3.5rem;
 }
 
-
 .hc-button:hover {
   background-image: var(--bgImageDarken);
 }

src/HealthChecks.UI/client/App.tsx

@@ -9,7 +9,6 @@ import fetchers from './api/fetchers';
 import { AlertPanel } from './components/AlertPanel';
 import { useQuery } from 'react-query';
 
-
 interface AppProps {
     uiSettings: UISettings;
 }
@@ -58,4 +57,4 @@ const App: FunctionComponent<AppProps> = ({ uiSettings }) => {
     );
 }
 
-export { App };
+export { App };

src/HealthChecks.UI/client/components/AlertPanel.tsx

@@ -18,5 +18,4 @@ const AlertPanel: FunctionComponent<AlertPanelProps> = ({ message }) =>
         </div>
     );
 
-
-export { AlertPanel };
+export { AlertPanel };

src/HealthChecks.UI/client/components/LivenessMenu.tsx

@@ -8,9 +8,8 @@ interface LivenessMenuProps {
 
 const LivenessMenu: FunctionComponent<LivenessMenuProps> = ({ running, onRunningClick, pollingInterval }) => {
 
-
     return (
-        <div className="hc-refesh-group">            
+        <div className="hc-refesh-group">
             <span>Polling interval: <b>{pollingInterval}</b> secs</span>
             <button
                 onClick={onRunningClick}
@@ -21,4 +20,4 @@ const LivenessMenu: FunctionComponent<LivenessMenuProps> = ({ running, onRunning
         </div>)
 };
 
-export { LivenessMenu };
+export { LivenessMenu };

src/HealthChecks.UI/client/components/LivenessTable.tsx

@@ -1,9 +1,8 @@
-import React, { FunctionComponent } from 'react';
+import React, { FunctionComponent } from 'react';
 import { Liveness } from '../typings/models';
 import { discoveryServices, getStatusConfig } from '../healthChecksResources';
 import { CheckTable } from './CheckTable';
 
-
 interface LivenessTableProps {
   livenessData: Array<Liveness>;
   collapseAll: (event: any) => void;
@@ -28,7 +27,6 @@ const LivenessTable: FunctionComponent<LivenessTableProps> = ({ livenessData, ex
     });
   };
 
-
   const toggleAll = (event: any) => {
     let { currentTarget } = event;
     let iconToggle = currentTarget.getElementsByClassName('js-toggle-all')[0];
@@ -109,7 +107,6 @@ const LivenessTable: FunctionComponent<LivenessTableProps> = ({ livenessData, ex
   );
 };
 
-
 const getDiscoveryServiceImage = (discoveryService: string) => {
   if (discoveryService != null) {
     let discoveryServiceImage = discoveryServices.find(
@@ -140,4 +137,4 @@ const toggleVisibility = (event: any) => {
   iconImage.setAttribute('title', isHidden ? 'hide info' : 'expand info');
 };
 
-export { LivenessTable };
+export { LivenessTable };

src/HealthChecks.UI/client/pages/LivenessPage.tsx

@@ -7,7 +7,6 @@ import { getHealthChecks } from '../api/fetchers';
 import { LivenessMenu } from '../components/LivenessMenu';
 import { AlertPanel } from '../components/AlertPanel';
 
-
 interface LivenessState {
     error: Nullable<string>;
     pollingIntervalSetting: string | number;
@@ -95,4 +94,4 @@ const LivenessPage: React.FunctionComponent<LivenessProps> = ({ apiSettings }) =
 
 };
 
-export { LivenessPage };
+export { LivenessPage };

src/HealthChecks.UI/client/pages/WebhooksPage.tsx

@@ -7,14 +7,13 @@ import { useQuery } from 'react-query';
 import fetchers from '../api/fetchers';
 import { AlertPanel } from '../components/AlertPanel';
 
-
 interface WebHooksPageState {
   webhooks: Array<WebHook>;
 }
 
 const WebhooksPage = () => {
 
-  const { data: webhooks, isError } = useQuery("webhooks", fetchers.getWebhooks, {retry: 1});  
+  const { data: webhooks, isError } = useQuery("webhooks", fetchers.getWebhooks, {retry: 1});
 
   const renderWebhooks = (webhooks: Array<WebHook>) => {
     let webHooksChunk = chunkArray(webhooks, 2);
@@ -64,4 +63,4 @@ const WebhooksPage = () => {
 
 };
 
-export { WebhooksPage };
+export { WebhooksPage };