Merge pull request #16 from Black-Cockpit/hotfix/fixing_logging_dependency_injection

💯 Fixed logging dependency injection

Author: hasnimehdi91

.editorconfig

@@ -54,6 +54,9 @@ csharp_space_between_square_brackets = false
 csharp_preserve_single_line_statements = true
 csharp_preserve_single_line_blocks = true
 
+# Ensure source code is documented
+dotnet_diagnostic.CS1591.severity = error
+
 # Ensure names and members access are simplified 
 dotnet_diagnostic.ide0001.severity = error
 dotnet_diagnostic.ide0002.severity = error

NETCore.Keycloak.Client.Tests/Modules/KcAuthorizationTests/KcAuthorizationExtensionTests.cs

@@ -68,7 +68,7 @@ public void ShouldRegisterAuthorizationHandler()
             });
 
         // Create a mock for ILogger to simulate logging functionality.
-        var mockLogger = new Mock<ILogger>();
+        var mockLogger = new Mock<ILogger<IKcRealmAdminTokenHandler>>();
         _ = mockLogger.Setup(logger => logger.IsEnabled(It.IsAny<LogLevel>())).Returns(true);
 
         // Add Keycloak services, the token handler, and the logger to the service collection.
@@ -112,7 +112,7 @@ public void ShouldRegisterKeycloakProtectedResourcesPoliciesServices()
         var mockAuthorizationOptions = new Mock<IOptions<AuthorizationOptions>>();
 
         // Create a mock for ILogger to simulate logging functionality.
-        var mockLogger = new Mock<ILogger>();
+        var mockLogger = new Mock<ILogger<IKcRealmAdminTokenHandler>>();
         _ = mockLogger.Setup(logger => logger.IsEnabled(It.IsAny<LogLevel>())).Returns(true);
 
         // Add mocked services to the service collection.

NETCore.Keycloak.Client.Tests/Modules/KcAuthorizationTests/KcBearerAuthorizationHandlerTests.cs

@@ -139,14 +139,14 @@ public void SetUp()
             .Returns(mockScope.Object);
 
         // Set up a mock logger to simulate logging functionality
-        var mockLogger = new Mock<ILogger>();
+        var mockLogger = new Mock<ILogger<IKcRealmAdminTokenHandler>>();
         _ = mockLogger.Setup(logger => logger.IsEnabled(It.IsAny<LogLevel>())).Returns(true);
 
         // Configure the mock scope to resolve services
         _ = mockScope.Setup(x => x.ServiceProvider).Returns(_mockProvider.Object);
 
         // Mock resolution of ILogger from the service provider
-        _ = _mockProvider.Setup(x => x.GetService(typeof(ILogger)))
+        _ = _mockProvider.Setup(x => x.GetService(typeof(ILogger<IKcRealmAdminTokenHandler>)))
             .Returns(mockLogger.Object);
 
         // Mock resolution of IHttpContextAccessor from the service provider
@@ -772,14 +772,14 @@ private KcRealmAdminTokenHandler SetUpMockRealmAdminTokenHandler()
             .Returns(mockScope.Object);
 
         // Set up a mock logger to simulate logging functionality
-        var mockLogger = new Mock<ILogger>();
+        var mockLogger = new Mock<ILogger<IKcRealmAdminTokenHandler>>();
         _ = mockLogger.Setup(logger => logger.IsEnabled(It.IsAny<LogLevel>())).Returns(true);
 
         // Configure the mock scope to resolve services
         _ = mockScope.Setup(x => x.ServiceProvider).Returns(mockProvider.Object);
 
         // Mock resolution of ILogger from the service provider
-        _ = mockProvider.Setup(x => x.GetService(typeof(ILogger)))
+        _ = mockProvider.Setup(x => x.GetService(typeof(ILogger<IKcRealmAdminTokenHandler>)))
             .Returns(mockLogger.Object);
 
         // Define a test-specific configuration for the Keycloak realm

NETCore.Keycloak.Client.Tests/Modules/KcAuthorizationTests/KcRealmAdminTokenHandlerTests.cs

@@ -58,12 +58,12 @@ public void SetUp()
             .Returns(mockScope.Object);
 
         // Mock the logger.
-        var mockLogger = new Mock<ILogger>();
+        var mockLogger = new Mock<ILogger<IKcRealmAdminTokenHandler>>();
         _ = mockLogger.Setup(logger => logger.IsEnabled(It.IsAny<LogLevel>())).Returns(true);
 
         // Mock the service provider to return the logger when requested.
         _ = mockScope.Setup(x => x.ServiceProvider).Returns(_mockProvider.Object);
-        _ = _mockProvider.Setup(x => x.GetService(typeof(ILogger)))
+        _ = _mockProvider.Setup(x => x.GetService(typeof(ILogger<IKcRealmAdminTokenHandler>)))
             .Returns(mockLogger.Object);
 
         // Define test configuration for the Keycloak realm.

NETCore.Keycloak.Client/Authentication/Claims/KcRolesClaimsTransformer.cs

@@ -31,8 +31,19 @@ namespace NETCore.Keycloak.Client.Authentication.Claims;
 /// </remarks>
 public class KcRolesClaimsTransformer : IClaimsTransformation
 {
+    /// <summary>
+    /// Represents the claim type used to identify user roles within the application.
+    /// </summary>
     private readonly string _roleClaimType;
+
+    /// <summary>
+    /// Defines the source of the role claims, used to identify how roles are sourced.
+    /// </summary>
     private readonly KcRolesClaimSource _roleSource;
+
+    /// <summary>
+    /// Represents the audience for the token, used to validate the intended recipient of the token.
+    /// </summary>
     private readonly string _audience;
 
     /// <summary>

NETCore.Keycloak.Client/Authentication/KcAuthenticationConfiguration.cs

@@ -80,7 +80,7 @@ public class KcAuthenticationConfiguration
     /// <summary>
     /// List of valid audiences
     /// </summary>
-    public IEnumerable<string> ValidAudiences { get; set; } = new List<string>();
+    public IEnumerable<string> ValidAudiences { get; set; } = [];
 
     /// <summary>
     /// Get valid issuer

NETCore.Keycloak.Client/Authorization/Handlers/KcBearerAuthorizationHandler.cs

@@ -42,7 +42,7 @@ public KcBearerAuthorizationHandler(IServiceProvider serviceProvider)
         using var scope = serviceProvider.CreateScope();
 
         // Resolve the logger instance.
-        _logger = scope.ServiceProvider.GetService<ILogger>();
+        _logger = scope.ServiceProvider.GetService<ILogger<KcBearerAuthorizationHandler>>();
 
         // Resolve the HTTP context accessor for accessing request data.
         _httpContextAccessor = scope.ServiceProvider.GetRequiredService<IHttpContextAccessor>();
@@ -61,10 +61,10 @@ protected override async Task HandleRequirementAsync(AuthorizationHandlerContext
         KcAuthorizationRequirement requirement)
     {
         // Ensure that authorization context is not null
-        ArgumentNullException.ThrowIfNull(context, "Authorization context is required.");
+        ArgumentNullException.ThrowIfNull(context);
 
         // Ensure that authorization requirement is not null.
-        ArgumentNullException.ThrowIfNull(requirement, "Authorization requirement is required.");
+        ArgumentNullException.ThrowIfNull(requirement);
 
         // Check if the user is authenticated
         if ( context.User.Identity?.IsAuthenticated ?? false )

NETCore.Keycloak.Client/Authorization/Handlers/KcRealmAdminTokenHandler.cs

@@ -62,7 +62,8 @@ public KcRealmAdminTokenHandler(KcRealmAdminConfigurationStore realmAdminConfigu
 
         // Create a scoped service provider to resolve the logger service.
         using var scope = provider.CreateScope();
-        _logger = scope.ServiceProvider.GetRequiredService<ILogger>(); // Get the logger from the scoped provider.
+        _logger = scope.ServiceProvider
+            .GetRequiredService<ILogger<IKcRealmAdminTokenHandler>>();
 
         // Initialize the token cache to store access and refresh tokens for different realms.
         _tokensCache = new ConcurrentDictionary<string, KcCachedToken>();

NETCore.Keycloak.Client/Authorization/KcAuthorizationExtension.cs

@@ -18,8 +18,9 @@ public static class KcAuthorizationExtension
     /// <param name="services"></param>
     /// <returns></returns>
     public static IServiceCollection AddKeycloakAuthorization(this IServiceCollection services) =>
-        services
-            .AddSingleton<IAuthorizationHandler, KcBearerAuthorizationHandler>().AddHttpContextAccessor();
+        services.AddSingleton<IAuthorizationHandler, KcBearerAuthorizationHandler>()
+            .AddHttpContextAccessor()
+            .AddLogging();
 
     /// <summary>
     /// Add keycloak policy provider
@@ -35,9 +36,8 @@ public static IServiceCollection AddKeycloakProtectedResourcesPolicies<T, TV>(
             .AddSingleton<KcRealmAdminConfigurationStore, TV>()
             .AddSingleton<IKcRealmAdminTokenHandler, KcRealmAdminTokenHandler>()
             .AddSingleton<IAuthorizationPolicyProvider, KcProtectedResourcePolicyProvider>(
-                provider =>
-                    new KcProtectedResourcePolicyProvider(provider,
-                        provider.GetRequiredService<IOptions<AuthorizationOptions>>()));
+                provider => new KcProtectedResourcePolicyProvider(provider,
+                    provider.GetRequiredService<IOptions<AuthorizationOptions>>()));
         return services;
     }
 }

NETCore.Keycloak.Client/Authorization/Requirements/KcAuthorizationRequirement.cs

@@ -51,7 +51,7 @@ public class KcAuthorizationRequirement : IAuthorizationRequirement
     public KcAuthorizationRequirement(KcProtectedResourceStore protectedResourceStore, string resource, string scope)
     {
         // Ensure protected resources is not null
-        ArgumentNullException.ThrowIfNull(protectedResourceStore, $"{nameof(protectedResourceStore)} cannot be null.");
+        ArgumentNullException.ThrowIfNull(protectedResourceStore);
 
         // Ensure resource is not null or empty
         if ( string.IsNullOrWhiteSpace(resource) )