Improve management test coverage (#1520)

* Refactor tests for dbmigrations endpoint

* Refactor tests for env endpoint
- Only display changed values from placeholder/decryption providers
- Show placeholder/decryption providers *after* the configuration providers they wrap
- Hide providers that don't have any properties

* Add internal file system abstraction for testability of disk space contributor

* Order health check results in descending status

* Simplify test health contributors (single purpose)

* Refactor tests for health endpoint
- Remove duplicate information in details for ASP.NET health checks
- Fixed: X-Use-Status-Code-From-Response header not always respected
- Fixed inconsistency in case-sensitivity of health group names

* Refactor tests for health contributors, move availability contributors to matching namespace

* Move HttpExchanges into MemoryDumps category

* Refactor tests for heapdump endpoint

* Refactor tests for threaddump endpoint

* Refactor tests for httpexchanges endpoint
 - Replace IHttpExchangesRepository with IHttpExchangeRecorder, so that filtering logic becomes testable
 - Fixed: appsettings.json files from RazorPagesTestApp were still being copied by VS Build Acceleration
 - Fixed: options.IncludeTimeTaken was ignored

* Reduce pressure when running all tests locally, so that DiagnosticObserverHttpExchangeRecorder doesn't fail

* Refactor tests for hypermedia endpoint
- Fixed: The value returned for "templated" was always false

* Refactor tests for info endpoint
- Fixed: adjust contributor nullability to allow null dictionary values
- Fixed: do not skip lines in git.properties file that contain = character in their value

* Refactor tests for loggers endpoint

* Refactor tests for refresh endpoint
- Fixed: order keys alphabetically, without duplicates
- Fixed: throw when unable to reload, instead of silently do nothing

* Refactor tests for mappings endpoint

* Refactor tests for beans endpoint

* Revise tests for dependent services: get middleware instance to ensure all downstream dependencies are registered

* Simplify tests for options: there's no added value in using host builders

* Cleanup tests for management/endpoint options - Fixed: allow clearing default exposure using Spring-style configuration keys - Fixed: remove duplicate entries in exposure over regular and Spring-style keys

* Remove unused types

* Add tests for Spring Boot Admin

* Move content negotation tests for SBA

* Refactor tests for all actuators

* Adapt configuration key names to .NET naming convention, inline constants

* Rename/inline test type

* Refactor tests for cloudfoundryapplication endpoint
- Order the returned list of endpoints by ID
- Critical fix: block /cloudfoundryapplication and log warning when security middleware not added
- Critical fix: don't turn off all security when the /cloudfoundryapplication hypermedia endpoint is turned off

* Do not hide empty sources in env endpoint for Spring Boot compatibility

* Fix line endings in *.git.properties files

* Centralize "appsettings.json" constant

Author: bart-vmware

.gitattributes

@@ -0,0 +1,2 @@
+# Enable running shell scripts from bash on Windows
+*.git.properties eol=lf

src/Common/src/Common/HealthChecks/HealthAggregator.cs

@@ -4,7 +4,6 @@
 
 using System.Collections.Concurrent;
 using Microsoft.Extensions.Diagnostics.HealthChecks;
-using Steeltoe.Common.CasingConventions;
 using Steeltoe.Common.Extensions;
 using MicrosoftHealthCheckResult = Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult;
 using MicrosoftHealthStatus = Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus;
@@ -112,22 +111,14 @@ private static async Task<SteeltoeHealthCheckResult> RunMicrosoftHealthCheckAsyn
             IHealthCheck check = registration.Factory(serviceProvider);
             MicrosoftHealthCheckResult result = await check.CheckHealthAsync(context, cancellationToken);
 
-            SteeltoeHealthStatus status = ToHealthStatus(result.Status);
-            healthCheckResult.Status = status; // Only used for aggregate, doesn't get reported
+            healthCheckResult.Status = ToHealthStatus(result.Status);
             healthCheckResult.Description = result.Description;
 
             foreach ((string key, object value) in result.Data)
             {
                 healthCheckResult.Details[key] = value;
             }
 
-            healthCheckResult.Details["status"] = status.ToSnakeCaseString(SnakeCaseStyle.AllCaps);
-
-            if (result.Description != null)
-            {
-                healthCheckResult.Details.Add("description", result.Description);
-            }
-
             if (result.Exception != null && !string.IsNullOrEmpty(result.Exception.Message))
             {
                 healthCheckResult.Details.Add("error", result.Exception.Message);
@@ -172,16 +163,61 @@ private static string GetKey(ConcurrentBag<string> keys, string key)
 
     private static SteeltoeHealthCheckResult AddChecksSetStatus(SteeltoeHealthCheckResult result, IDictionary<string, SteeltoeHealthCheckResult> healthChecks)
     {
-        foreach (KeyValuePair<string, SteeltoeHealthCheckResult> healthCheck in healthChecks)
+        var orderedCheckResults = new SortedDictionary<CheckResultOrderingKey, SteeltoeHealthCheckResult>(CheckResultOrderingKeyComparer.Instance);
+
+        foreach ((string name, SteeltoeHealthCheckResult checkResult) in healthChecks)
         {
-            if (healthCheck.Value.Status > result.Status)
+            if (checkResult.Status > result.Status)
             {
-                result.Status = healthCheck.Value.Status;
+                result.Status = checkResult.Status;
             }
 
-            result.Details.Add(healthCheck.Key, healthCheck.Value);
+            var orderingKey = new CheckResultOrderingKey(checkResult.Status, name);
+            orderedCheckResults.Add(orderingKey, checkResult);
+        }
+
+        foreach ((CheckResultOrderingKey orderingKey, SteeltoeHealthCheckResult checkResult) in orderedCheckResults)
+        {
+            result.Details.Add(orderingKey.Name, checkResult);
         }
 
         return result;
     }
+
+    private sealed record CheckResultOrderingKey(SteeltoeHealthStatus Status, string Name);
+
+    private sealed class CheckResultOrderingKeyComparer : IComparer<CheckResultOrderingKey>
+    {
+        private static readonly List<SteeltoeHealthStatus> HealthStatusOrder =
+        [
+            SteeltoeHealthStatus.Down,
+            SteeltoeHealthStatus.OutOfService,
+            SteeltoeHealthStatus.Warning,
+            SteeltoeHealthStatus.Unknown,
+            SteeltoeHealthStatus.Up
+        ];
+
+        public static CheckResultOrderingKeyComparer Instance { get; } = new();
+
+        private CheckResultOrderingKeyComparer()
+        {
+        }
+
+        public int Compare(CheckResultOrderingKey? x, CheckResultOrderingKey? y)
+        {
+            if (x == null || y == null)
+            {
+                return Comparer<CheckResultOrderingKey>.Default.Compare(x, y);
+            }
+
+            int result = HealthStatusOrder.IndexOf(x.Status).CompareTo(HealthStatusOrder.IndexOf(y.Status));
+
+            if (result == 0)
+            {
+                result = string.Compare(x.Name, y.Name, StringComparison.Ordinal);
+            }
+
+            return result;
+        }
+    }
 }

src/Common/test/Common.Test/ApplicationInstanceInfoTest.cs

@@ -6,6 +6,7 @@
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 using Steeltoe.Common.Extensions;
+using Steeltoe.Common.TestResources;
 using Steeltoe.Common.TestResources.IO;
 
 namespace Steeltoe.Common.Test;
@@ -34,7 +35,7 @@ public async Task ReadsApplicationConfiguration()
             """;
 
         using var sandbox = new Sandbox();
-        string path = sandbox.CreateFile("appsettings.json", configJson);
+        string path = sandbox.CreateFile(MemoryFileProvider.DefaultAppSettingsFileName, configJson);
         string directory = Path.GetDirectoryName(path)!;
         string fileName = Path.GetFileName(path);
         var builder = new ConfigurationBuilder();

src/Common/test/TestResources/InactiveDiagnosticListener.cs

@@ -0,0 +1,61 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the Apache 2.0 License.
+// See the LICENSE file in the project root for more information.
+
+using System.Diagnostics;
+
+namespace Steeltoe.Common.TestResources;
+
+/// <summary>
+/// A no-op replacement for the built-in <see cref="DiagnosticListener" />.
+/// </summary>
+/// <para>
+/// This type is registered by host builders used in tests. It prevents failure in DiagnosticObserverHttpExchangeRecorder when many tests are running.
+/// </para>
+internal sealed class InactiveDiagnosticListener()
+    : DiagnosticListener("Empty")
+{
+    public override bool IsEnabled(string name)
+    {
+        return false;
+    }
+
+    public override bool IsEnabled(string name, object? arg1, object? arg2 = null)
+    {
+        return false;
+    }
+
+    public override IDisposable Subscribe(IObserver<KeyValuePair<string, object?>> observer)
+    {
+        return EmptyDisposable.Instance;
+    }
+
+    public override IDisposable Subscribe(IObserver<KeyValuePair<string, object?>> observer, Func<string, object?, object?, bool>? isEnabled)
+    {
+        return EmptyDisposable.Instance;
+    }
+
+    public override IDisposable Subscribe(IObserver<KeyValuePair<string, object?>> observer, Predicate<string>? isEnabled)
+    {
+        return EmptyDisposable.Instance;
+    }
+
+    // ReSharper disable once MethodOverloadWithOptionalParameter
+    public override IDisposable Subscribe(IObserver<KeyValuePair<string, object?>> observer, Func<string, object?, object?, bool>? isEnabled,
+        Action<Activity, object?>? onActivityImport = null, Action<Activity, object?>? onActivityExport = null)
+    {
+        return EmptyDisposable.Instance;
+    }
+
+    public override void Write(string name, object? value)
+    {
+    }
+
+    public override void OnActivityExport(Activity activity, object? payload)
+    {
+    }
+
+    public override void OnActivityImport(Activity activity, object? payload)
+    {
+    }
+}

src/Common/test/TestResources/MemoryFileProvider.cs

@@ -12,6 +12,8 @@ namespace Steeltoe.Common.TestResources;
 
 public sealed class MemoryFileProvider : IFileProvider
 {
+    public const string DefaultAppSettingsFileName = "appsettings.json";
+
     private static readonly char[] DirectorySeparators =
     [
         Path.DirectorySeparatorChar,

src/Common/test/TestResources/TestHostApplicationBuilderFactory.cs

@@ -2,7 +2,9 @@
 // The .NET Foundation licenses this file to you under the Apache 2.0 License.
 // See the LICENSE file in the project root for more information.
 
+using System.Diagnostics;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.DependencyInjection.Extensions;
 using Microsoft.Extensions.Hosting;
 
 namespace Steeltoe.Common.TestResources;
@@ -21,7 +23,7 @@ public static class TestHostApplicationBuilderFactory
     public static HostApplicationBuilder Create()
     {
         HostApplicationBuilder builder = Host.CreateEmptyApplicationBuilder(new HostApplicationBuilderSettings());
-        ConfigureBuilder(builder);
+        ConfigureBuilder(builder, true);
 
         return builder;
     }
@@ -39,13 +41,18 @@ public static HostApplicationBuilder Create(string[] args)
             Args = args
         });
 
-        ConfigureBuilder(builder);
+        ConfigureBuilder(builder, true);
 
         return builder;
     }
 
-    private static void ConfigureBuilder(HostApplicationBuilder builder)
+    private static void ConfigureBuilder(HostApplicationBuilder builder, bool deactivateDiagnostics)
     {
         builder.ConfigureContainer(new DefaultServiceProviderFactory(ValidatingServiceProviderOptions));
+
+        if (deactivateDiagnostics)
+        {
+            builder.Services.Replace(ServiceDescriptor.Singleton<DiagnosticListener, InactiveDiagnosticListener>());
+        }
     }
 }

src/Common/test/TestResources/TestHostBuilderFactory.cs

@@ -2,10 +2,12 @@
 // The .NET Foundation licenses this file to you under the Apache 2.0 License.
 // See the LICENSE file in the project root for more information.
 
+using System.Diagnostics;
 using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.AspNetCore.TestHost;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.DependencyInjection.Extensions;
 using Microsoft.Extensions.Hosting;
 
 namespace Steeltoe.Common.TestResources;
@@ -25,20 +27,20 @@ public static class TestHostBuilderFactory
     public static HostBuilder Create()
     {
         var builder = new HostBuilder();
-        ConfigureBuilder(builder, false, false);
+        ConfigureBuilder(builder, false, false, true);
 
         return builder;
     }
 
     public static HostBuilder CreateWeb()
     {
         var builder = new HostBuilder();
-        ConfigureBuilder(builder, true, true);
+        ConfigureBuilder(builder, true, true, true);
 
         return builder;
     }
 
-    private static void ConfigureBuilder(IHostBuilder builder, bool configureWebHost, bool useTestServer)
+    private static void ConfigureBuilder(HostBuilder builder, bool configureWebHost, bool useTestServer, bool deactivateDiagnostics)
     {
         builder.UseDefaultServiceProvider(ConfigureServiceProvider);
 
@@ -54,5 +56,10 @@ private static void ConfigureBuilder(IHostBuilder builder, bool configureWebHost
                 }
             });
         }
+
+        if (deactivateDiagnostics)
+        {
+            builder.ConfigureServices(services => services.Replace(ServiceDescriptor.Singleton<DiagnosticListener, InactiveDiagnosticListener>()));
+        }
     }
 }

src/Common/test/TestResources/TestWebApplicationBuilderFactory.cs

@@ -2,10 +2,12 @@
 // The .NET Foundation licenses this file to you under the Apache 2.0 License.
 // See the LICENSE file in the project root for more information.
 
+using System.Diagnostics;
 using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.AspNetCore.TestHost;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.DependencyInjection.Extensions;
 
 namespace Steeltoe.Common.TestResources;
 
@@ -52,7 +54,7 @@ public static WebApplicationBuilder Create(string[] args)
     public static WebApplicationBuilder Create(WebApplicationOptions options)
     {
         WebApplicationBuilder builder = WebApplication.CreateEmptyBuilder(options);
-        ConfigureBuilder(builder, true);
+        ConfigureBuilder(builder, true, true);
 
         return builder;
     }
@@ -80,18 +82,23 @@ public static WebApplicationBuilder CreateDefault()
     public static WebApplicationBuilder CreateDefault(bool useTestServer)
     {
         WebApplicationBuilder builder = WebApplication.CreateBuilder();
-        ConfigureBuilder(builder, useTestServer);
+        ConfigureBuilder(builder, useTestServer, false);
 
         return builder;
     }
 
-    private static void ConfigureBuilder(WebApplicationBuilder builder, bool useTestServer)
+    private static void ConfigureBuilder(WebApplicationBuilder builder, bool useTestServer, bool deactivateDiagnostics)
     {
         builder.WebHost.UseDefaultServiceProvider(ConfigureServiceProvider);
 
         if (useTestServer)
         {
             builder.WebHost.UseTestServer();
         }
+
+        if (deactivateDiagnostics)
+        {
+            builder.Services.Replace(ServiceDescriptor.Singleton<DiagnosticListener, InactiveDiagnosticListener>());
+        }
     }
 }

src/Common/test/TestResources/TestWebHostBuilderFactory.cs

@@ -2,10 +2,12 @@
 // The .NET Foundation licenses this file to you under the Apache 2.0 License.
 // See the LICENSE file in the project root for more information.
 
+using System.Diagnostics;
 using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.AspNetCore.TestHost;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.DependencyInjection.Extensions;
 
 namespace Steeltoe.Common.TestResources;
 
@@ -29,12 +31,12 @@ public static WebHostBuilder Create()
     public static WebHostBuilder Create(bool useTestServer)
     {
         var builder = new WebHostBuilder();
-        ConfigureBuilder(builder, useTestServer);
+        ConfigureBuilder(builder, useTestServer, true);
 
         return builder;
     }
 
-    private static void ConfigureBuilder(IWebHostBuilder builder, bool useTestServer)
+    private static void ConfigureBuilder(WebHostBuilder builder, bool useTestServer, bool deactivateDiagnostics)
     {
         builder.UseDefaultServiceProvider(ConfigureServiceProvider);
         builder.Configure(EmptyAction);
@@ -43,5 +45,10 @@ private static void ConfigureBuilder(IWebHostBuilder builder, bool useTestServer
         {
             builder.UseTestServer();
         }
+
+        if (deactivateDiagnostics)
+        {
+            builder.ConfigureServices(services => services.Replace(ServiceDescriptor.Singleton<DiagnosticListener, InactiveDiagnosticListener>()));
+        }
     }
 }

src/Configuration/src/Abstractions/ConfigurationProviderEnumerationExtensions.cs

@@ -66,11 +66,6 @@ private static IEnumerable<IConfigurationProvider> FilterProviders(IEnumerable<I
     {
         foreach (IConfigurationProvider provider in providers)
         {
-            if (predicate(provider))
-            {
-                yield return provider;
-            }
-
             if (provider is ChainedConfigurationProvider chainedConfigurationProvider)
             {
                 foreach (IConfigurationProvider match in EnumerateProviders(chainedConfigurationProvider.Configuration, predicate))
@@ -86,6 +81,11 @@ private static IEnumerable<IConfigurationProvider> FilterProviders(IEnumerable<I
                     yield return match;
                 }
             }
+
+            if (predicate(provider))
+            {
+                yield return provider;
+            }
         }
     }
 }