Add comments and fix build (#2114)

Xabaril · Dec 4, 2023 · 3adb447 · 3adb447
1 parent 2aad15f
commit 3adb447
Show file tree

Hide file tree

Showing 6 changed files with 47 additions and 34 deletions.
diff --git a/README.md b/README.md
@@ -110,7 +110,7 @@ HealthChecks packages include health checks for:
 | Solr                       | [![Nuget](https://img.shields.io/nuget/dt/AspNetCore.HealthChecks.Solr)](https://www.nuget.org/packages/AspNetCore.HealthChecks.Solr)                                         | [![Nuget](https://img.shields.io/nuget/v/AspNetCore.HealthChecks.Solr)](https://www.nuget.org/packages/AspNetCore.HealthChecks.Solr) | [![view](https://img.shields.io/github/issues/Xabaril/AspNetCore.Diagnostics.HealthChecks/solr)](https://github.com/Xabaril/AspNetCore.Diagnostics.HealthChecks/labels/solr)
 | Sqlite                     | [![Nuget](https://img.shields.io/nuget/dt/AspNetCore.HealthChecks.Sqlite)](https://www.nuget.org/packages/AspNetCore.HealthChecks.Sqlite)                                     | [![Nuget](https://img.shields.io/nuget/v/AspNetCore.HealthChecks.Sqlite)](https://www.nuget.org/packages/AspNetCore.HealthChecks.Sqlite) | [![view](https://img.shields.io/github/issues/Xabaril/AspNetCore.Diagnostics.HealthChecks/sqlite)](https://github.com/Xabaril/AspNetCore.Diagnostics.HealthChecks/labels/sqlite)
 | Sql Server                 | [![Nuget](https://img.shields.io/nuget/dt/AspNetCore.HealthChecks.SqlServer)](https://www.nuget.org/packages/AspNetCore.HealthChecks.SqlServer)                               | [![Nuget](https://img.shields.io/nuget/v/AspNetCore.HealthChecks.SqlServer)](https://www.nuget.org/packages/AspNetCore.HealthChecks.SqlServer) | [![view](https://img.shields.io/github/issues/Xabaril/AspNetCore.Diagnostics.HealthChecks/sqlserver)](https://github.com/Xabaril/AspNetCore.Diagnostics.HealthChecks/labels/sqlserver)
-| System                     | [![Nuget](https://img.shields.io/nuget/dt/AspNetCore.HealthChecks.System)](https://www.nuget.org/packages/AspNetCore.HealthChecks.System)                                     | [![Nuget](https://img.shields.io/nuget/v/AspNetCore.HealthChecks.System)](https://www.nuget.org/packages/AspNetCore.HealthChecks.System) | [![view](https://img.shields.io/github/issues/Xabaril/AspNetCore.Diagnostics.HealthChecks/system)](https://github.com/Xabaril/AspNetCore.Diagnostics.HealthChecks/labels/system) | Disk Storage, Folder, Private Memory, Virtual Memory, Process, Windows Service |
+| System                     | [![Nuget](https://img.shields.io/nuget/dt/AspNetCore.HealthChecks.System)](https://www.nuget.org/packages/AspNetCore.HealthChecks.System)                                     | [![Nuget](https://img.shields.io/nuget/v/AspNetCore.HealthChecks.System)](https://www.nuget.org/packages/AspNetCore.HealthChecks.System) | [![view](https://img.shields.io/github/issues/Xabaril/AspNetCore.Diagnostics.HealthChecks/system)](https://github.com/Xabaril/AspNetCore.Diagnostics.HealthChecks/labels/system) | Disk Storage, Folder, File, Private Memory, Virtual Memory, Process, Windows Service |
 | Uris                       | [![Nuget](https://img.shields.io/nuget/dt/AspNetCore.HealthChecks.Uris)](https://www.nuget.org/packages/AspNetCore.HealthChecks.Uris)                                         | [![Nuget](https://img.shields.io/nuget/v/AspNetCore.HealthChecks.Uris)](https://www.nuget.org/packages/AspNetCore.HealthChecks.Uris) | [![view](https://img.shields.io/github/issues/Xabaril/AspNetCore.Diagnostics.HealthChecks/uris)](https://github.com/Xabaril/AspNetCore.Diagnostics.HealthChecks/labels/uris) | Single uri and uri groups                                              |
 
 > We support netcoreapp 2.2, 3.0 and 3.1. Please use package versions 2.2.X, 3.0.X and 3.1.X to target different versions.

diff --git a/...ecks.System/DiskStorageLivenessOptions.cs → ...HealthChecks.System/DiskStorageOptions.cs b/...ecks.System/DiskStorageLivenessOptions.cs → ...HealthChecks.System/DiskStorageOptions.cs
@@ -1,30 +1,33 @@
-namespace HealthChecks.System;
-
-public class DiskStorageOptions
-{
-    internal Dictionary<string, (string DriveName, long MinimumFreeMegabytes)> ConfiguredDrives { get; } = new();
-
-    public DiskStorageOptions AddDrive(string driveName, long minimumFreeMegabytes = 1)
-    {
-        ConfiguredDrives.Add(driveName, (driveName, minimumFreeMegabytes));
-        return this;
-    }
-
-    public bool CheckAllDrives { get; set; }
-
-    public DiskStorageOptions WithCheckAllDrives()
-    {
-        CheckAllDrives = true;
-        return this;
-    }
-
-    /// <summary>
-    /// Allows to set custom description of the failed disk check.
-    /// </summary>
-    public ErrorDescription FailedDescription = (driveName, minimumFreeMegabytes, actualFreeMegabytes)
-        => actualFreeMegabytes == null
-            ? $"Configured drive {driveName} is not present on system"
-            : $"Minimum configured megabytes for disk {driveName} is {minimumFreeMegabytes} but actual free space are {actualFreeMegabytes} megabytes";
-
-    public delegate string ErrorDescription(string driveName, long minimumFreeMegabytes, long? actualFreeMegabytes);
-}
+namespace HealthChecks.System;
+
+/// <summary>
+/// Options for <see cref="DiskStorageHealthCheck"/>.
+/// </summary>
+public class DiskStorageOptions
+{
+    internal Dictionary<string, (string DriveName, long MinimumFreeMegabytes)> ConfiguredDrives { get; } = new();
+
+    public DiskStorageOptions AddDrive(string driveName, long minimumFreeMegabytes = 1)
+    {
+        ConfiguredDrives.Add(driveName, (driveName, minimumFreeMegabytes));
+        return this;
+    }
+
+    public bool CheckAllDrives { get; set; }
+
+    public DiskStorageOptions WithCheckAllDrives()
+    {
+        CheckAllDrives = true;
+        return this;
+    }
+
+    /// <summary>
+    /// Allows to set custom description of the failed disk check.
+    /// </summary>
+    public ErrorDescription FailedDescription = (driveName, minimumFreeMegabytes, actualFreeMegabytes)
+        => actualFreeMegabytes == null
+            ? $"Configured drive {driveName} is not present on system"
+            : $"Minimum configured megabytes for disk {driveName} is {minimumFreeMegabytes} but actual free space are {actualFreeMegabytes} megabytes";
+
+    public delegate string ErrorDescription(string driveName, long minimumFreeMegabytes, long? actualFreeMegabytes);
+}
diff --git a/src/HealthChecks.System/FileHealthCheck.cs b/src/HealthChecks.System/FileHealthCheck.cs
@@ -6,11 +6,15 @@ public class FileHealthCheck : IHealthCheck
 {
     private readonly FileHealthCheckOptions _fileOptions;
 
+    /// <summary>
+    /// Creates an instance of <see cref="FileHealthCheck"/> with the specified options.
+    /// </summary>
     public FileHealthCheck(FileHealthCheckOptions fileOptions)
     {
         _fileOptions = fileOptions;
     }
 
+    /// <inheritdoc />
     public Task<HealthCheckResult> CheckHealthAsync(HealthCheckContext context, CancellationToken cancellationToken = default)
     {
         try

diff --git a/src/HealthChecks.System/FileHealthCheckOptions.cs b/src/HealthChecks.System/FileHealthCheckOptions.cs
@@ -1,5 +1,8 @@
 namespace HealthChecks.System;
 
+/// <summary>
+/// Options for <see cref="FileHealthCheck"/>.
+/// </summary>
 public class FileHealthCheckOptions
 {
     public List<string> Files { get; } = new();

diff --git a/src/HealthChecks.System/FolderHealthCheck.cs b/src/HealthChecks.System/FolderHealthCheck.cs
@@ -6,6 +6,9 @@ public class FolderHealthCheck : IHealthCheck
 {
     private readonly FolderHealthCheckOptions _folderOptions;
 
+    /// <summary>
+    /// Creates an instance of <see cref="FolderHealthCheck"/> with the specified options.
+    /// </summary>
     public FolderHealthCheck(FolderHealthCheckOptions folderOptions)
     {
         _folderOptions = Guard.ThrowIfNull(folderOptions);

diff --git a/test/HealthChecks.System.Tests/Functional/FileHealthCheckTests.cs b/test/HealthChecks.System.Tests/Functional/FileHealthCheckTests.cs
@@ -23,7 +23,7 @@ public async Task be_healthy_if_file_is_available()
 
         using var server = new TestServer(webHostBuilder);
 
-        using var response = await server.CreateRequest("/health").GetAsync().ConfigureAwait(false);
+        using var response = await server.CreateRequest("/health").GetAsync();
 
         response.StatusCode.ShouldBe(HttpStatusCode.OK);
     }
@@ -49,7 +49,7 @@ public async Task be_healthy_if_no_file_provided()
 
         using var server = new TestServer(webHostBuilder);
 
-        using var response = await server.CreateRequest("/health").GetAsync().ConfigureAwait(false);
+        using var response = await server.CreateRequest("/health").GetAsync();
 
         response.StatusCode.ShouldBe(HttpStatusCode.OK);
     }
@@ -73,7 +73,7 @@ public async Task be_unhealthy_if_file_is_not_available()
 
         using var server = new TestServer(webHostBuilder);
 
-        using var response = await server.CreateRequest("/health").GetAsync().ConfigureAwait(false);
+        using var response = await server.CreateRequest("/health").GetAsync();
 
         response.StatusCode.ShouldBe(HttpStatusCode.ServiceUnavailable);
     }