Fail AzureKeyVaultHealthCheck if no keys, certificates or secrets con…

…figured
Xabaril · Jul 23, 2023 · 8d4301c · 8d4301c
1 parent 8f7d707
commit 8d4301c
Show file tree

Hide file tree

Showing 20 changed files with 100 additions and 55 deletions.
diff --git a/src/HealthChecks.AzureKeyVault/AzureKeyVaultHealthCheck.cs b/src/HealthChecks.AzureKeyVault/AzureKeyVaultHealthCheck.cs
@@ -29,6 +29,10 @@ public async Task<HealthCheckResult> CheckHealthAsync(HealthCheckContext context
     {
         try
         {
+            // https://github.com/Xabaril/AspNetCore.Diagnostics.HealthChecks/issues/785
+            if (_options._keys.Count == 0 && _options.Certificates.Count == 0 && _options._secrets.Count == 0)
+                return HealthCheckResult.Unhealthy("No keys, certificates or secrets configured.");
+
             foreach (string secret in _options.Secrets)
             {
                 var secretClient = CreateSecretClient();

diff --git a/test/HealthChecks.ArangoDb.Tests/Functional/ArangoDbHealthCheckTests.cs b/test/HealthChecks.ArangoDb.Tests/Functional/ArangoDbHealthCheckTests.cs
@@ -29,7 +29,7 @@ public async Task be_healthy_if_arangodb_is_available()
 
         using var server = new TestServer(webHostBuilder);
 
-        var response = await server.CreateRequest($"/health").GetAsync().ConfigureAwait(false);
+        var response = await server.CreateRequest("/health").GetAsync().ConfigureAwait(false);
 
         response.StatusCode.ShouldBe(HttpStatusCode.OK);
     }
@@ -67,7 +67,7 @@ public async Task be_healthy_if_multiple_arango_are_available()
 
         using var server = new TestServer(webHostBuilder);
 
-        var response = await server.CreateRequest($"/health").GetAsync().ConfigureAwait(false);
+        var response = await server.CreateRequest("/health").GetAsync().ConfigureAwait(false);
 
         response.StatusCode.ShouldBe(HttpStatusCode.OK);
     }
@@ -97,7 +97,7 @@ public async Task be_unhealthy_if_arango_is_not_available()
 
         using var server = new TestServer(webHostBuilder);
 
-        var response = await server.CreateRequest($"/health").GetAsync().ConfigureAwait(false);
+        var response = await server.CreateRequest("/health").GetAsync().ConfigureAwait(false);
 
         response.StatusCode.ShouldBe(HttpStatusCode.ServiceUnavailable);
     }

diff --git a/test/HealthChecks.AzureKeyVault.Tests/Functional/AzureKeyVaultHealthCheckTests.cs b/test/HealthChecks.AzureKeyVault.Tests/Functional/AzureKeyVaultHealthCheckTests.cs
@@ -0,0 +1,40 @@
+using System.Net;
+using Azure.Identity;
+
+namespace HealthChecks.AzureKeyVault.Tests.Functional;
+
+public class AzureKeyVaultHealthCheckTests
+{
+    // https://github.com/Xabaril/AspNetCore.Diagnostics.HealthChecks/issues/785
+    [Fact]
+    public async Task be_unhealthy_if_keyvalue_is_not_available()
+    {
+        var webHostBuilder = new WebHostBuilder()
+            .ConfigureServices(services =>
+            {
+                services.AddHealthChecks()
+                    .AddAzureKeyVault(
+                        new Uri("https://www.thisisnotarealurl.com"),
+                        new DefaultAzureCredential(),
+                        setup =>
+                        {
+                            //setup
+                            //    .UseKeyVaultUrl("https://www.thisisnotarealurl2.com")
+                            //    .UseAzureManagedServiceIdentity();
+                        });
+            })
+            .Configure(app =>
+            {
+                app.UseHealthChecks("/health", new HealthCheckOptions
+                {
+                    Predicate = _ => true,
+                });
+            });
+
+        using var server = new TestServer(webHostBuilder);
+
+        var response = await server.CreateRequest("/health").GetAsync().ConfigureAwait(false);
+
+        response.StatusCode.ShouldBe(HttpStatusCode.ServiceUnavailable);
+    }
+}
diff --git a/test/HealthChecks.AzureKeyVault.Tests/HealthChecks.AzureKeyVault.Tests.csproj b/test/HealthChecks.AzureKeyVault.Tests/HealthChecks.AzureKeyVault.Tests.csproj
@@ -5,6 +5,7 @@
   </PropertyGroup>
 
   <ItemGroup>
+    <PackageReference Include="Azure.Identity" Version="1.9.0" />
     <ProjectReference Include="..\..\src\HealthChecks.AzureKeyVault\HealthChecks.AzureKeyVault.csproj" />
   </ItemGroup>
 

diff --git a/test/HealthChecks.Consul.Tests/Functional/ConsulHealthCheckTests.cs b/test/HealthChecks.Consul.Tests/Functional/ConsulHealthCheckTests.cs
@@ -28,7 +28,7 @@ public async Task be_healthy_if_consul_is_available()
 
         using var server = new TestServer(webHostBuilder);
 
-        var response = await server.CreateRequest($"/health").GetAsync().ConfigureAwait(false);
+        var response = await server.CreateRequest("/health").GetAsync().ConfigureAwait(false);
 
         response.StatusCode.ShouldBe(HttpStatusCode.OK);
     }
@@ -57,7 +57,7 @@ public async Task be_unhealthy_if_consul_is_not_available()
 
         using var server = new TestServer(webHostBuilder);
 
-        var response = await server.CreateRequest($"/health").GetAsync().ConfigureAwait(false);
+        var response = await server.CreateRequest("/health").GetAsync().ConfigureAwait(false);
 
         response.StatusCode.ShouldBe(HttpStatusCode.ServiceUnavailable);
     }

diff --git a/test/HealthChecks.Elasticsearch.Tests/Functional/ElasticsearchAuthenticationTests.cs b/test/HealthChecks.Elasticsearch.Tests/Functional/ElasticsearchAuthenticationTests.cs
@@ -41,7 +41,7 @@ public async Task be_healthy_if_elasticsearch_is_using_valid_api_key()
 
         using var server = new TestServer(webHostBuilder);
 
-        var response = await server.CreateRequest($"/health")
+        var response = await server.CreateRequest("/health")
             .GetAsync()
             .ConfigureAwait(false);
 
@@ -77,7 +77,7 @@ public async Task be_healthy_if_elasticsearch_is_using_valid_user_and_password()
 
         using var server = new TestServer(webHostBuilder);
 
-        var response = await server.CreateRequest($"/health")
+        var response = await server.CreateRequest("/health")
             .GetAsync()
             .ConfigureAwait(false);
 

diff --git a/test/HealthChecks.Elasticsearch.Tests/Functional/ElasticsearchHealthCheckTests.cs b/test/HealthChecks.Elasticsearch.Tests/Functional/ElasticsearchHealthCheckTests.cs
@@ -25,7 +25,7 @@ public async Task be_healthy_if_elasticsearch_is_available()
 
         using var server = new TestServer(webHostBuilder);
 
-        var response = await server.CreateRequest($"/health").GetAsync().ConfigureAwait(false);
+        var response = await server.CreateRequest("/health").GetAsync().ConfigureAwait(false);
 
         response.StatusCode.ShouldBe(HttpStatusCode.OK);
     }
@@ -49,7 +49,7 @@ public async Task be_unhealthy_if_elasticsearch_is_not_available()
 
         using var server = new TestServer(webHostBuilder);
 
-        var response = await server.CreateRequest($"/health").GetAsync().ConfigureAwait(false);
+        var response = await server.CreateRequest("/health").GetAsync().ConfigureAwait(false);
 
         response.StatusCode.ShouldBe(HttpStatusCode.ServiceUnavailable);
     }

diff --git a/test/HealthChecks.EventStore.Tests/Functional/EventStoreHealthCheckTests.cs b/test/HealthChecks.EventStore.Tests/Functional/EventStoreHealthCheckTests.cs
@@ -25,7 +25,7 @@ public async Task be_healthy_if_eventstore_is_available_with_uri_format()
 
         using var server = new TestServer(webHostBuilder);
 
-        var response = await server.CreateRequest($"/health").GetAsync().ConfigureAwait(false);
+        var response = await server.CreateRequest("/health").GetAsync().ConfigureAwait(false);
 
         response.StatusCode.ShouldBe(HttpStatusCode.OK, await response.Content.ReadAsStringAsync().ConfigureAwait(false));
     }
@@ -50,7 +50,7 @@ public async Task be_healthy_if_eventstore_is_available()
 
         using var server = new TestServer(webHostBuilder);
 
-        var response = await server.CreateRequest($"/health").GetAsync().ConfigureAwait(false);
+        var response = await server.CreateRequest("/health").GetAsync().ConfigureAwait(false);
 
         response.StatusCode.ShouldBe(HttpStatusCode.OK, await response.Content.ReadAsStringAsync().ConfigureAwait(false));
     }
@@ -76,7 +76,7 @@ public async Task be_unhealthy_if_eventstore_is_not_available()
 
         using var server = new TestServer(webHostBuilder);
 
-        var response = await server.CreateRequest($"/health").GetAsync().ConfigureAwait(false);
+        var response = await server.CreateRequest("/health").GetAsync().ConfigureAwait(false);
 
         response.StatusCode.ShouldBe(HttpStatusCode.ServiceUnavailable, await response.Content.ReadAsStringAsync().ConfigureAwait(false));
     }

diff --git a/test/HealthChecks.EventStore.gRPC.Tests/Functional/EventStoreHealthCheckTests.cs b/test/HealthChecks.EventStore.gRPC.Tests/Functional/EventStoreHealthCheckTests.cs
@@ -23,7 +23,7 @@ public async Task be_healthy_if_eventstore_is_available()
 
         using var server = new TestServer(webHostBuilder);
 
-        var response = await server.CreateRequest($"/health").GetAsync().ConfigureAwait(false);
+        var response = await server.CreateRequest("/health").GetAsync().ConfigureAwait(false);
 
         response.StatusCode.ShouldBe(HttpStatusCode.OK);
     }

diff --git a/test/HealthChecks.Gremlin.Tests/Functional/GremlinHealthCheckTests.cs b/test/HealthChecks.Gremlin.Tests/Functional/GremlinHealthCheckTests.cs
@@ -28,7 +28,7 @@ public async Task be_healthy_if_gremlin_is_available()
 
         using var server = new TestServer(webHostBuilder);
 
-        var response = await server.CreateRequest($"/health").GetAsync().ConfigureAwait(false);
+        var response = await server.CreateRequest("/health").GetAsync().ConfigureAwait(false);
 
         response.StatusCode.ShouldBe(HttpStatusCode.OK);
     }
@@ -63,7 +63,7 @@ public async Task be_healthy_if_multiple_gremlin_are_available()
 
         using var server = new TestServer(webHostBuilder);
 
-        var response = await server.CreateRequest($"/health").GetAsync().ConfigureAwait(false);
+        var response = await server.CreateRequest("/health").GetAsync().ConfigureAwait(false);
 
         response.StatusCode.ShouldBe(HttpStatusCode.OK);
     }
@@ -92,7 +92,7 @@ public async Task be_unhealthy_if_gremlin_is_not_available()
 
         using var server = new TestServer(webHostBuilder);
 
-        var response = await server.CreateRequest($"/health").GetAsync().ConfigureAwait(false);
+        var response = await server.CreateRequest("/health").GetAsync().ConfigureAwait(false);
 
         response.StatusCode.ShouldBe(HttpStatusCode.ServiceUnavailable);
     }

diff --git a/test/HealthChecks.Network.Tests/Functional/SslHealthCheckTests.cs b/test/HealthChecks.Network.Tests/Functional/SslHealthCheckTests.cs
@@ -36,7 +36,7 @@ public async Task be_healthy_if_ssl_is_valid()
 
         using var server = new TestServer(webHostBuilder);
 
-        var response = await server.CreateRequest($"/health").GetAsync().ConfigureAwait(false);
+        var response = await server.CreateRequest("/health").GetAsync().ConfigureAwait(false);
 
         response.StatusCode.ShouldBe(HttpStatusCode.OK);
     }
@@ -60,7 +60,7 @@ public async Task be_unhealthy_if_ssl_is_not_present()
 
         using var server = new TestServer(webHostBuilder);
 
-        var response = await server.CreateRequest($"/health").GetAsync().ConfigureAwait(false);
+        var response = await server.CreateRequest("/health").GetAsync().ConfigureAwait(false);
 
         response.StatusCode.ShouldBe(HttpStatusCode.ServiceUnavailable);
     }
@@ -84,7 +84,7 @@ public async Task be_unhealthy_if_ssl_is_not_valid()
 
         using var server = new TestServer(webHostBuilder);
 
-        var response = await server.CreateRequest($"/health").GetAsync().ConfigureAwait(false);
+        var response = await server.CreateRequest("/health").GetAsync().ConfigureAwait(false);
 
         response.StatusCode.ShouldBe(HttpStatusCode.ServiceUnavailable);
     }
@@ -108,7 +108,7 @@ public async Task be_unhealthy_if_ssl_is_expired()
 
         using var server = new TestServer(webHostBuilder);
 
-        var response = await server.CreateRequest($"/health").GetAsync().ConfigureAwait(false);
+        var response = await server.CreateRequest("/health").GetAsync().ConfigureAwait(false);
 
         response.StatusCode.ShouldBe(HttpStatusCode.ServiceUnavailable);
     }
@@ -132,7 +132,7 @@ public async Task be_degraded_if_ssl_daysbefore()
 
         using var server = new TestServer(webHostBuilder);
 
-        var response = await server.CreateRequest($"/health").GetAsync().ConfigureAwait(false);
+        var response = await server.CreateRequest("/health").GetAsync().ConfigureAwait(false);
 
         response.StatusCode.ShouldBe(HttpStatusCode.ServiceUnavailable);
         var resultAsString = await response.Content.ReadAsStringAsync().ConfigureAwait(false);

diff --git a/test/HealthChecks.OpenIdConnectServer.Tests/Functional/IdSvrHealthCheckTests.cs b/test/HealthChecks.OpenIdConnectServer.Tests/Functional/IdSvrHealthCheckTests.cs
@@ -23,7 +23,7 @@ public async Task be_unhealthy_if_idsvr_is_unavailable()
 
         using var server = new TestServer(webHostBuilder);
 
-        var response = await server.CreateRequest($"/health").GetAsync().ConfigureAwait(false);
+        var response = await server.CreateRequest("/health").GetAsync().ConfigureAwait(false);
 
         response.StatusCode.ShouldBe(HttpStatusCode.ServiceUnavailable);
     }
@@ -47,7 +47,7 @@ public async Task be_healthy_if_idsvr_is_available()
 
         using var server = new TestServer(webHostBuilder);
 
-        var response = await server.CreateRequest($"/health").GetAsync().ConfigureAwait(false);
+        var response = await server.CreateRequest("/health").GetAsync().ConfigureAwait(false);
 
         response.StatusCode.ShouldBe(HttpStatusCode.OK);
     }

diff --git a/test/HealthChecks.RabbitMQ.Tests/Functional/RabbitHealthCheckTests.cs b/test/HealthChecks.RabbitMQ.Tests/Functional/RabbitHealthCheckTests.cs
@@ -26,7 +26,7 @@ public async Task be_healthy_if_rabbitmq_is_available()
 
         using var server = new TestServer(webHostBuilder);
 
-        var response = await server.CreateRequest($"/health").GetAsync().ConfigureAwait(false);
+        var response = await server.CreateRequest("/health").GetAsync().ConfigureAwait(false);
 
         response.StatusCode.ShouldBe(HttpStatusCode.OK);
     }
@@ -52,7 +52,7 @@ public async Task be_healthy_if_rabbitmq_is_available_using_ssloption()
 
         using var server = new TestServer(webHostBuilder);
 
-        var response = await server.CreateRequest($"/health").GetAsync().ConfigureAwait(false);
+        var response = await server.CreateRequest("/health").GetAsync().ConfigureAwait(false);
 
         response.StatusCode.ShouldBe(HttpStatusCode.OK);
     }
@@ -76,7 +76,7 @@ public async Task be_unhealthy_if_rabbitmq_is_not_available()
 
         using var server = new TestServer(webHostBuilder);
 
-        var response = await server.CreateRequest($"/health").GetAsync().ConfigureAwait(false);
+        var response = await server.CreateRequest("/health").GetAsync().ConfigureAwait(false);
 
         response.StatusCode.ShouldBe(HttpStatusCode.ServiceUnavailable);
     }
@@ -110,7 +110,7 @@ public async Task be_healthy_if_rabbitmq_is_available_using_iconnectionfactory()
 
         using var server = new TestServer(webHostBuilder);
 
-        var response = await server.CreateRequest($"/health").GetAsync().ConfigureAwait(false);
+        var response = await server.CreateRequest("/health").GetAsync().ConfigureAwait(false);
 
         response.StatusCode.ShouldBe(HttpStatusCode.OK);
     }
@@ -147,7 +147,7 @@ public async Task be_healthy_if_rabbitmq_is_available_using_iconnection()
 
         using var server = new TestServer(webHostBuilder);
 
-        var response = await server.CreateRequest($"/health").GetAsync().ConfigureAwait(false);
+        var response = await server.CreateRequest("/health").GetAsync().ConfigureAwait(false);
 
         response.StatusCode.ShouldBe(HttpStatusCode.OK);
     }
@@ -173,7 +173,7 @@ public async Task be_healthy_if_rabbitmq_is_available_and_specify_default_sslopt
 
         using var server = new TestServer(webHostBuilder);
 
-        var response = await server.CreateRequest($"/health").GetAsync().ConfigureAwait(false);
+        var response = await server.CreateRequest("/health").GetAsync().ConfigureAwait(false);
 
         response.StatusCode.ShouldBe(HttpStatusCode.OK);
     }
@@ -207,7 +207,7 @@ public async Task be_not_crash_on_startup_when_rabbitmq_is_down_at_startup()
 
         using var server = new TestServer(webHostBuilder);
 
-        var response1 = await server.CreateRequest($"/health").GetAsync().ConfigureAwait(false);
+        var response1 = await server.CreateRequest("/health").GetAsync().ConfigureAwait(false);
         response1.StatusCode.ShouldBe(HttpStatusCode.ServiceUnavailable);
     }
 
@@ -234,7 +234,7 @@ public async Task be_healthy_if_rabbitmq_is_available_using_iServiceProvider()
 
         using var server = new TestServer(webHostBuilder);
 
-        var response = await server.CreateRequest($"/health").GetAsync().ConfigureAwait(false);
+        var response = await server.CreateRequest("/health").GetAsync().ConfigureAwait(false);
 
         response.StatusCode.ShouldBe(HttpStatusCode.OK);
     }

diff --git a/test/HealthChecks.RavenDb.Tests/Functional/RavenDbHealthCheckTests.cs b/test/HealthChecks.RavenDb.Tests/Functional/RavenDbHealthCheckTests.cs
@@ -47,7 +47,7 @@ public async Task be_healthy_if_ravendb_is_available()
 
         using var server = new TestServer(webHostBuilder);
 
-        var response = await server.CreateRequest($"/health").GetAsync().ConfigureAwait(false);
+        var response = await server.CreateRequest("/health").GetAsync().ConfigureAwait(false);
 
         response.StatusCode.ShouldBe(HttpStatusCode.OK, await response.Content.ReadAsStringAsync().ConfigureAwait(false));
     }
@@ -77,7 +77,7 @@ public async Task be_healthy_if_ravendb_is_available_and_contains_specific_datab
 
         using var server = new TestServer(webHostBuilder);
 
-        var response = await server.CreateRequest($"/health").GetAsync().ConfigureAwait(false);
+        var response = await server.CreateRequest("/health").GetAsync().ConfigureAwait(false);
 
         response.StatusCode.ShouldBe(HttpStatusCode.OK, await response.Content.ReadAsStringAsync().ConfigureAwait(false));
     }
@@ -136,7 +136,7 @@ public async Task be_unhealthy_if_ravendb_is_not_available()
 
         using var server = new TestServer(webHostBuilder);
 
-        var response = await server.CreateRequest($"/health").GetAsync().ConfigureAwait(false);
+        var response = await server.CreateRequest("/health").GetAsync().ConfigureAwait(false);
 
         response.StatusCode.ShouldBe(HttpStatusCode.ServiceUnavailable, await response.Content.ReadAsStringAsync().ConfigureAwait(false));
     }