Merge pull request #38 from AutoMapper/ExplicitConfig

Exposes config option to not register statically

Author: jbogard

src/AutoMapper.Extensions.Microsoft.DependencyInjection/AutoMapper.Extensions.Microsoft.DependencyInjection.csproj

@@ -3,7 +3,7 @@
     <PropertyGroup>
         <Description>AutoMapper extensions for ASP.NET Core</Description>
         <Copyright>Copyright Jimmy Bogard</Copyright>
-        <VersionPrefix>3.1.0</VersionPrefix>
+        <VersionPrefix>3.2.0</VersionPrefix>
         <Authors>Jimmy Bogard</Authors>
         <TargetFrameworks>netstandard2.0</TargetFrameworks>
         <AssemblyName>AutoMapper.Extensions.Microsoft.DependencyInjection</AssemblyName>

src/AutoMapper.Extensions.Microsoft.DependencyInjection/ServiceCollectionExtensions.cs

@@ -14,9 +14,16 @@
     /// - Registers <see cref="Mapper.Configuration"/> as <see cref="ServiceLifetime.Singleton"/>
     /// - Registers <see cref="IMapper"/> as <see cref="ServiceLifetime.Scoped"/> with a service factory of the scoped <see cref="IServiceProvider"/>
     /// After calling AddAutoMapper you will have the static <see cref="Mapper"/> configuration initialized and you can use Mapper.Map and ProjectTo in your application code.
+    /// To use instance-based registration instead of the static <see cref="Mapper"/> class, set the <see cref="UseStaticRegistration"/> to false.
     /// </summary>
     public static class ServiceCollectionExtensions
     {
+        /// <summary>
+        /// Use the static registration method of Mapper.Initialize. Defaults to true.
+        /// When false, an instance of a MapperConfiguration object is registered instead.
+        /// </summary>
+        public static bool UseStaticRegistration { get; set; } = true;
+
         public static IServiceCollection AddAutoMapper(this IServiceCollection services)
         {
             return services.AddAutoMapper(null, AppDomain.CurrentDomain.GetAssemblies());
@@ -73,17 +80,30 @@ private static IServiceCollection AddAutoMapperClasses(IServiceCollection servic
                 .ToArray();
 
             var profiles = allTypes
-                .Where(t => typeof(Profile).GetTypeInfo().IsAssignableFrom(t) && !t.IsAbstract);
+                .Where(t => typeof(Profile).GetTypeInfo().IsAssignableFrom(t) && !t.IsAbstract)
+                .ToArray();
+
 
-            Mapper.Initialize(cfg =>
+            void ConfigAction(IMapperConfigurationExpression cfg)
             {
                 additionalInitAction(cfg);
 
                 foreach (var profile in profiles.Select(t => t.AsType()))
                 {
                     cfg.AddProfile(profile);
                 }
-            });
+            }
+
+            IConfigurationProvider config;
+            if (UseStaticRegistration)
+            {
+                Mapper.Initialize(ConfigAction);
+                config = Mapper.Configuration;
+            }
+            else
+            {
+                config = new MapperConfiguration(ConfigAction);
+            }
 
             var openTypes = new[]
             {
@@ -100,7 +120,7 @@ private static IServiceCollection AddAutoMapperClasses(IServiceCollection servic
                 services.AddTransient(type.AsType());
             }
 
-            services.AddSingleton(Mapper.Configuration);
+            services.AddSingleton(config);
             return services.AddScoped<IMapper>(sp => new Mapper(sp.GetRequiredService<IConfigurationProvider>(), sp.GetService));
         }
 

test/AutoMapper.Extensions.Microsoft.DependencyInjection.Tests/AppDomainResolutionTests.cs

@@ -14,6 +14,7 @@ public class AppDomainResolutionTests
 
         public AppDomainResolutionTests()
         {
+            ServiceCollectionExtensions.UseStaticRegistration = true;
             IServiceCollection services = new ServiceCollection();
             services.AddAutoMapper();
             _provider = services.BuildServiceProvider();

test/AutoMapper.Extensions.Microsoft.DependencyInjection.Tests/AssemblyResolutionTests.cs

@@ -14,6 +14,8 @@ public class AssemblyResolutionTests
 
         public AssemblyResolutionTests()
         {
+            ServiceCollectionExtensions.UseStaticRegistration = true;
+
             IServiceCollection services = new ServiceCollection();
             services.AddAutoMapper(typeof(Source).GetTypeInfo().Assembly);
             _provider = services.BuildServiceProvider();

test/AutoMapper.Extensions.Microsoft.DependencyInjection.Tests/RegistrationTests.cs

@@ -0,0 +1,34 @@
+using System;
+using Microsoft.Extensions.DependencyInjection;
+using Shouldly;
+using Xunit;
+
+namespace AutoMapper.Extensions.Microsoft.DependencyInjection.Tests
+{
+    [Collection(nameof(RegistrationTests))]
+    public class RegistrationTests
+    {
+        [Fact]
+        public void Should_not_register_static_instance_when_configured()
+        {
+            ServiceCollectionExtensions.UseStaticRegistration = false;
+
+            IServiceCollection services = new ServiceCollection();
+            services.AddAutoMapper();
+
+            var serviceProvider = services.BuildServiceProvider();
+
+            var config = serviceProvider.GetService<IConfigurationProvider>();
+            config.ShouldNotBeNull();
+
+            try
+            {
+                config.ShouldNotBeSameAs(Mapper.Configuration);
+            }
+            catch (InvalidOperationException)
+            {
+                // Success if the mapper has not been initialized anyway
+            }
+        }
+    }
+}

test/AutoMapper.Extensions.Microsoft.DependencyInjection.Tests/TypeResolutionTests.cs

@@ -66,6 +66,7 @@ public class TypeResolutionTests_ForStaticConfig
 
         public TypeResolutionTests_ForStaticConfig()
         {
+            ServiceCollectionExtensions.UseStaticRegistration = true;
             IServiceCollection services = new ServiceCollection();
             services.AddAutoMapper(typeof(Source));
             _provider = services.BuildServiceProvider();