feat: lists handlers types that can be managed

aguacongas · aguacongas · commit 04e12d73006a · 2018-12-09T19:25:57.000+01:00
diff --git a/sample/Aguacongas.AspNetCore.Authentication.Sample/Startup.cs b/sample/Aguacongas.AspNetCore.Authentication.Sample/Startup.cs
@@ -43,7 +43,7 @@ public void ConfigureServices(IServiceCollection services)
                     options.UseInMemoryDatabase(Guid.NewGuid().ToString());
                 }, (context) => 
                 {
-                    Debug.WriteLine($"{context.Scheme} has been {context.Action}");
+                    Debug.WriteLine($"The scheme {context.Scheme} has been {context.Action}");
                 })
                 .AddGoogle()
                 .AddFacebook()
diff --git a/src/Aguacongas.AspNetCore.Authentication.TestBase/DynamicManagerTestBase.cs b/src/Aguacongas.AspNetCore.Authentication.TestBase/DynamicManagerTestBase.cs
@@ -63,6 +63,8 @@ Task onSignId(CookieSignedInContext context)
             });
 
             var sut = provider.GetRequiredService<DynamicManager<TSchemeDefinition>>();
+            Assert.Contains(typeof(CookieAuthenticationHandler), sut.ManagedHandlerType);
+
             var cookieOptions = new CookieAuthenticationOptions
             {
                 Cookie = new CookieBuilder
@@ -115,6 +117,8 @@ Task onCreatingTicket(OAuthCreatingTicketContext context)
             });
 
             var sut = provider.GetRequiredService<DynamicManager<TSchemeDefinition>>();
+            Assert.Contains(typeof(FacebookHandler), sut.ManagedHandlerType);
+
             var facebookOptions = new FacebookOptions
             {
                 AppId = "test",
@@ -167,6 +171,8 @@ Task onCreatingTicket(OAuthCreatingTicketContext context)
             });
 
             var sut = provider.GetRequiredService<DynamicManager<TSchemeDefinition>>();
+            Assert.Contains(typeof(GoogleHandler), sut.ManagedHandlerType);
+
             var googleOptions = new GoogleOptions
             {
                 ClientId = "test",
@@ -233,6 +239,8 @@ Task onMessageReceived(Microsoft.AspNetCore.Authentication.JwtBearer.MessageRece
             };
 
             var sut = provider.GetRequiredService<DynamicManager<TSchemeDefinition>>();
+            Assert.Contains(typeof(JwtBearerHandler), sut.ManagedHandlerType);
+
             await sut.AddAsync(definition);
             var state = await VerifyAddedAsync<JwtBearerOptions>("test", provider);
 
@@ -282,6 +290,8 @@ Task onCreatingTicket(OAuthCreatingTicketContext context)
             };
 
             var sut = provider.GetRequiredService<DynamicManager<TSchemeDefinition>>();
+            Assert.Contains(typeof(MicrosoftAccountHandler), sut.ManagedHandlerType);
+
             await sut.AddAsync(definition);
             var state = await VerifyAddedAsync<MicrosoftAccountOptions>("test", provider);
 
@@ -335,6 +345,8 @@ Task onTicketReceived(TicketReceivedContext context)
             };
 
             var sut = provider.GetRequiredService<DynamicManager<TSchemeDefinition>>();
+            Assert.Contains(typeof(OpenIdConnectHandler), sut.ManagedHandlerType);
+
             await sut.AddAsync(definition);
             var state = await VerifyAddedAsync<OpenIdConnectOptions>("test", provider);
 
@@ -385,6 +397,8 @@ Task onTicketReceived(TicketReceivedContext context)
             };
 
             var sut = provider.GetRequiredService<DynamicManager<TSchemeDefinition>>();
+            Assert.Contains(typeof(TwitterHandler), sut.ManagedHandlerType);
+
             await sut.AddAsync(definition);
             var state = await VerifyAddedAsync<TwitterOptions>("test", provider);
 
@@ -437,6 +451,8 @@ Task onTicketReceived(TicketReceivedContext context)
             };
 
             var sut = provider.GetRequiredService<DynamicManager<TSchemeDefinition>>();
+            Assert.Contains(typeof(WsFederationHandler), sut.ManagedHandlerType);
+
             await sut.AddAsync(definition);
             var state = await VerifyAddedAsync<WsFederationOptions>("test", provider);
 
@@ -489,6 +505,9 @@ Task onTicketReceived(TicketReceivedContext context)
             };
 
             var sut = provider.GetRequiredService<DynamicManager<TSchemeDefinition>>();
+            Assert.Contains(typeof(CookieAuthenticationHandler), sut.ManagedHandlerType);
+            Assert.Contains(typeof(WsFederationHandler), sut.ManagedHandlerType);
+
             await Assert.ThrowsAsync<InvalidOperationException>(() => sut.UpdateAsync(definition));
 
             await sut.AddAsync(definition);
@@ -550,6 +569,8 @@ public async Task RemoveAsync_should_remove_handler()
             };
 
             var sut = provider.GetRequiredService<DynamicManager<TSchemeDefinition>>();
+            Assert.Contains(typeof(CookieAuthenticationHandler), sut.ManagedHandlerType);
+
             await sut.AddAsync(definition);
             await VerifyAddedAsync<CookieAuthenticationOptions>("test", provider);
 
diff --git a/src/Aguacongas.AspNetCore.Authentication/AuthenticationBuilderExtensions.cs b/src/Aguacongas.AspNetCore.Authentication/AuthenticationBuilderExtensions.cs
@@ -14,17 +14,25 @@ public static class AuthenticationBuilderExtensions
         /// <summary>
         /// Configures the DI for dynamic scheme management.
         /// </summary>
-        /// <typeparam name="TDefinition">The type of the definition.</typeparam>
+        /// <typeparam name="TSchemeDefinition">The type of the definition.</typeparam>
         /// <param name="builder">The builder.</param>
         /// <param name="notify">The action to call on scheme added or removed.</param>
         /// <returns></returns>
-        public static DynamicAuthenticationBuilder AddDynamic<TDefinition>(this AuthenticationBuilder builder, Action<NotificationContext> notify = null)
-            where TDefinition: SchemeDefinitionBase, new()
+        public static DynamicAuthenticationBuilder AddDynamic<TSchemeDefinition>(this AuthenticationBuilder builder, Action<NotificationContext> notify = null)
+            where TSchemeDefinition: SchemeDefinitionBase, new()
         {
+            var dynamicBuilder = new DynamicAuthenticationBuilder(builder.Services, notify);
             builder.Services
                 .AddSingleton<OptionsMonitorCacheWrapperFactory>()
-                .AddTransient<DynamicManager<TDefinition>>();
-            return new DynamicAuthenticationBuilder(builder.Services, notify);
+                .AddTransient(provider => new DynamicManager<TSchemeDefinition>
+                (
+                    provider.GetRequiredService<IAuthenticationSchemeProvider>(),
+                    provider.GetRequiredService<OptionsMonitorCacheWrapperFactory>(),
+                    provider.GetRequiredService<IDynamicProviderStore<TSchemeDefinition>>(),
+                    dynamicBuilder.HandlerTypes
+                )
+                );
+            return dynamicBuilder;
         }
     }
 }
diff --git a/src/Aguacongas.AspNetCore.Authentication/DynamicAuthenticationBuilder.cs b/src/Aguacongas.AspNetCore.Authentication/DynamicAuthenticationBuilder.cs
@@ -4,6 +4,7 @@
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Options;
 using System;
+using System.Collections.Generic;
 
 namespace Aguacongas.AspNetCore.Authentication
 {
@@ -19,6 +20,15 @@ public enum SchemeAction
     public class DynamicAuthenticationBuilder : AuthenticationBuilder
     {
         private readonly Action<NotificationContext> _notify;
+        private readonly List<Type> _handlerTypes = new List<Type>();
+
+        /// <summary>
+        /// Gets the handler types managed by this instance.
+        /// </summary>
+        /// <value>
+        /// The handler types.
+        /// </value>
+        public IEnumerable<Type> HandlerTypes { get; }
 
         /// <summary>
         /// Initializes a new instance of the <see cref="DynamicAuthenticationBuilder"/> class.
@@ -28,6 +38,7 @@ public class DynamicAuthenticationBuilder : AuthenticationBuilder
         public DynamicAuthenticationBuilder(IServiceCollection services, Action<NotificationContext> notify): base(services)
         {
             _notify = notify;
+            HandlerTypes = _handlerTypes;
         }
 
         /// <summary>
@@ -43,14 +54,19 @@ public DynamicAuthenticationBuilder(IServiceCollection services, Action<Notifica
         /// </returns>
         public override AuthenticationBuilder AddScheme<TOptions, THandler>(string authenticationScheme, string displayName, Action<TOptions> configureOptions)
         {
-            Services.AddSingleton(provider => new OptionsMonitorCacheWrapper<TOptions>(
-                provider.GetRequiredService<IOptionsMonitorCache<TOptions>>(),
-                (name, configure) =>
-                {
-                    configureOptions?.Invoke((TOptions)configure);
-                    _notify?.Invoke(new NotificationContext(provider, name, SchemeAction.Added));
-                },
-                name => _notify?.Invoke(new NotificationContext(provider, name, SchemeAction.Removed))));
+            _handlerTypes.Add(typeof(THandler));
+            Services.AddSingleton(provider => 
+                new OptionsMonitorCacheWrapper<TOptions>
+                (
+                    provider.GetRequiredService<IOptionsMonitorCache<TOptions>>(),
+                    (name, configure) =>
+                    {
+                        configureOptions?.Invoke((TOptions)configure);
+                        _notify?.Invoke(new NotificationContext(provider, name, SchemeAction.Added));
+                    },
+                    name => _notify?.Invoke(new NotificationContext(provider, name, SchemeAction.Removed))
+                )
+            );
             base.AddScheme<TOptions, THandler>(authenticationScheme, displayName, configureOptions);
             return this;
         }
diff --git a/src/Aguacongas.AspNetCore.Authentication/DynamicManager.cs b/src/Aguacongas.AspNetCore.Authentication/DynamicManager.cs
@@ -4,6 +4,7 @@
 using Microsoft.Extensions.DependencyModel;
 using Microsoft.Extensions.Logging;
 using System;
+using System.Collections.Generic;
 using System.Linq;
 using System.Reflection;
 using System.Threading;
@@ -23,6 +24,8 @@ public class DynamicManager<TSchemeDefinition>
         private readonly IAuthenticationSchemeProvider _schemeProvider;
         private readonly OptionsMonitorCacheWrapperFactory _wrapperFactory;
 
+        public virtual IEnumerable<Type> ManagedHandlerType { get; }
+
         /// <summary>
         /// Initializes a new instance of the <see cref="DynamicManager{TSchemeDefinition}"/> class.
         /// </summary>
@@ -38,11 +41,13 @@ public class DynamicManager<TSchemeDefinition>
         /// </exception>
         public DynamicManager(IAuthenticationSchemeProvider schemeProvider,
             OptionsMonitorCacheWrapperFactory wrapperFactory,
-            IDynamicProviderStore<TSchemeDefinition> store)
+            IDynamicProviderStore<TSchemeDefinition> store,
+            IEnumerable<Type> managedTypes)
         {
             _schemeProvider = schemeProvider ?? throw new ArgumentNullException(nameof(schemeProvider));
             _wrapperFactory = wrapperFactory ?? throw new ArgumentNullException(nameof(wrapperFactory));
             _store = store ?? throw new ArgumentNullException(nameof(store));
+            ManagedHandlerType = managedTypes ?? throw new ArgumentNullException(nameof(managedTypes));
         }
 
         /// <summary>
@@ -52,7 +57,7 @@ public DynamicManager(IAuthenticationSchemeProvider schemeProvider,
         /// <param name="cancellationToken">The cancellation token.</param>
         /// <returns></returns>
         /// <exception cref="ArgumentNullException">definition</exception>
-        public async Task AddAsync(TSchemeDefinition definition, CancellationToken cancellationToken = default(CancellationToken))
+        public virtual async Task AddAsync(TSchemeDefinition definition, CancellationToken cancellationToken = default(CancellationToken))
         {
             if (definition == null)
             {
@@ -82,7 +87,7 @@ public DynamicManager(IAuthenticationSchemeProvider schemeProvider,
         /// <returns></returns>
         /// <exception cref="ArgumentNullException">definition</exception>
         /// <exception cref="InvalidOperationException">The scheme does not exist.</exception>
-        public async Task UpdateAsync(TSchemeDefinition definition, CancellationToken cancellationToken = default(CancellationToken))
+        public virtual async Task UpdateAsync(TSchemeDefinition definition, CancellationToken cancellationToken = default(CancellationToken))
         {
             if (definition == null)
             {
@@ -115,7 +120,7 @@ public DynamicManager(IAuthenticationSchemeProvider schemeProvider,
         /// <param name="cancellationToken">The cancellation token.</param>
         /// <returns></returns>
         /// <exception cref="ArgumentException">scheme cannot be null or white space.</exception>
-        public async Task RemoveAsync(string scheme, CancellationToken cancellationToken = default(CancellationToken))
+        public virtual async Task RemoveAsync(string scheme, CancellationToken cancellationToken = default(CancellationToken))
         {
             if (string.IsNullOrWhiteSpace(scheme))
             {
@@ -139,7 +144,7 @@ public DynamicManager(IAuthenticationSchemeProvider schemeProvider,
         /// <param name="scheme">The scheme.</param>
         /// <returns>The scheme definition or null.</returns>
         /// <exception cref="ArgumentException">scheme cannot be null or white space.</exception>
-        public Task<TSchemeDefinition> FindBySchemeAsync(string scheme)
+        public virtual Task<TSchemeDefinition> FindBySchemeAsync(string scheme)
         {
             if (string.IsNullOrWhiteSpace(scheme))
             {
@@ -151,7 +156,7 @@ public Task<TSchemeDefinition> FindBySchemeAsync(string scheme)
         /// <summary>
         /// Loads the configuration.
         /// </summary>
-        public void Load()
+        public virtual void Load()
         {
             var platform = Environment.OSVersion.Platform.ToString();
             var runtimeAssemblyNames = DependencyContext.Default.GetRuntimeAssemblyNames(platform);
diff --git a/test/Aguacongas.AspNetCore.Authentication.Test/DynamicManagerTest.cs b/test/Aguacongas.AspNetCore.Authentication.Test/DynamicManagerTest.cs
@@ -3,6 +3,7 @@
 using Microsoft.AspNetCore.Authentication;
 using Moq;
 using System;
+using System.Collections.Generic;
 using System.Threading.Tasks;
 using Xunit;
 
@@ -13,14 +14,14 @@ public class DynamicManagerTest
         [Fact]
         public async Task Assertions()
         {
-            Assert.Throws<ArgumentNullException>(() => new DynamicManager<FakeSchemeDefinition>(null, null, null));
+            Assert.Throws<ArgumentNullException>(() => new DynamicManager<FakeSchemeDefinition>(null, null, null, null));
             var schemeProviderMock = new Mock<IAuthenticationSchemeProvider>().Object;
-            Assert.Throws<ArgumentNullException>(() => new DynamicManager<FakeSchemeDefinition>(schemeProviderMock, null, null));
+            Assert.Throws<ArgumentNullException>(() => new DynamicManager<FakeSchemeDefinition>(schemeProviderMock, null, null, null));
             var serviceProviderMock = new Mock<IServiceProvider>().Object;
             var factory = new OptionsMonitorCacheWrapperFactory(serviceProviderMock);
-            Assert.Throws<ArgumentNullException>(() => new DynamicManager<FakeSchemeDefinition>(schemeProviderMock, factory, null));
+            Assert.Throws<ArgumentNullException>(() => new DynamicManager<FakeSchemeDefinition>(schemeProviderMock, factory, null, null));
             var storeMock = new Mock<IDynamicProviderStore<FakeSchemeDefinition>>().Object;
-            var manager = new DynamicManager<FakeSchemeDefinition>(schemeProviderMock, factory, storeMock);
+            var manager = new DynamicManager<FakeSchemeDefinition>(schemeProviderMock, factory, storeMock, new List<Type>());
             await Assert.ThrowsAsync<ArgumentNullException>(() => manager.AddAsync(null));
             await Assert.ThrowsAsync<ArgumentNullException>(() => manager.UpdateAsync(null));
             await Assert.ThrowsAsync<ArgumentException>(() => manager.RemoveAsync(null));

Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ public void ConfigureServices(IServiceCollection services)`
`43`	`43`	`options.UseInMemoryDatabase(Guid.NewGuid().ToString());`
`44`	`44`	`}, (context) =>`
`45`	`45`	`{`
`46`		`- Debug.WriteLine($"{context.Scheme} has been {context.Action}");`
	`46`	`+ Debug.WriteLine($"The scheme {context.Scheme} has been {context.Action}");`
`47`	`47`	`})`
`48`	`48`	`.AddGoogle()`
`49`	`49`	`.AddFacebook()`