Introduce ServiceProviderLifetimeType for scoped dependency container lifetimes and refactor related logic in ServiceCollectionFinder.

Author: AidenFuller

Plugins/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin/DependencyInjectionPlugin.cs

@@ -29,6 +29,7 @@ public class DependencyInjectionPlugin : IRuntimePlugin
         public void Initialize(RuntimePluginEvents runtimePluginEvents, RuntimePluginParameters runtimePluginParameters, UnitTestProviderConfiguration unitTestProviderConfiguration)
         {
             runtimePluginEvents.CustomizeGlobalDependencies += CustomizeGlobalDependencies;
+            runtimePluginEvents.CustomizeTestThreadDependencies += CustomizeTestThreadDependenciesEventHandler;
             runtimePluginEvents.CustomizeFeatureDependencies += CustomizeFeatureDependenciesEventHandler;
             runtimePluginEvents.CustomizeScenarioDependencies += CustomizeScenarioDependenciesEventHandler;
         }
@@ -45,21 +46,15 @@ private void CustomizeGlobalDependencies(object sender, CustomizeGlobalDependenc
                         args.ObjectContainer.RegisterTypeAs<ServiceCollectionFinder, IServiceCollectionFinder>();
                     }
 
-                    // We store the (MS) service provider in the global (BoDi) container, we create it only once.
-                    // It must be lazy (hence factory) because at this point we still don't have the bindings mapped.
-                    args.ObjectContainer.RegisterFactoryAs<RootServiceProviderContainer>(() =>
-                    {
-                        var serviceCollectionFinder = args.ObjectContainer.Resolve<IServiceCollectionFinder>();
-                        var (services, scoping) = serviceCollectionFinder.GetServiceCollection();
-
-                        RegisterProxyBindings(args.ObjectContainer, services);
-                        return new RootServiceProviderContainer(services.BuildServiceProvider(), scoping);
-                    });
+                    var serviceCollectionFinder = args.ObjectContainer.Resolve<IServiceCollectionFinder>();
+                    var lifetime = serviceCollectionFinder.GetServiceProviderLifetime();
 
-                    args.ObjectContainer.RegisterFactoryAs<IServiceProvider>(() =>
+                    if (lifetime == ServiceProviderLifetimeType.Global)
                     {
-                        return args.ObjectContainer.Resolve<RootServiceProviderContainer>().ServiceProvider;
-                    });
+                        args.ObjectContainer.RegisterFactoryAs<RootServiceProviderContainer>(() => BuildRootServiceProviderContainer(args.ObjectContainer));
+                    }
+
+                    args.ObjectContainer.RegisterFactoryAs<IServiceProvider>(c => c.Resolve<RootServiceProviderContainer>().ServiceProvider);
 
                     // Will make sure DI scope is disposed.
                     var lcEvents = args.ObjectContainer.Resolve<RuntimePluginTestExecutionLifecycleEvents>();
@@ -70,8 +65,27 @@ private void CustomizeGlobalDependencies(object sender, CustomizeGlobalDependenc
             }
         }
 
+        private static void CustomizeTestThreadDependenciesEventHandler(object sender, CustomizeTestThreadDependenciesEventArgs args)
+        {
+            var serviceCollectionFinder = args.ObjectContainer.Resolve<IServiceCollectionFinder>();
+            var lifetime = serviceCollectionFinder.GetServiceProviderLifetime();
+
+            if (lifetime == ServiceProviderLifetimeType.TestThread)
+            {
+                args.ObjectContainer.RegisterFactoryAs<RootServiceProviderContainer>(() => BuildRootServiceProviderContainer(args.ObjectContainer));
+            }
+        }
+
         private static void CustomizeFeatureDependenciesEventHandler(object sender, CustomizeFeatureDependenciesEventArgs args)
         {
+            var serviceCollectionFinder = args.ObjectContainer.Resolve<IServiceCollectionFinder>();
+            var lifetime = serviceCollectionFinder.GetServiceProviderLifetime();
+
+            if (lifetime == ServiceProviderLifetimeType.Feature)
+            {
+                args.ObjectContainer.RegisterFactoryAs<RootServiceProviderContainer>(() => BuildRootServiceProviderContainer(args.ObjectContainer));
+            }
+
             // At this point we have the bindings, we can resolve the service provider, which will build it if it's the first time.
             var spContainer = args.ObjectContainer.Resolve<RootServiceProviderContainer>();
 
@@ -101,6 +115,14 @@ private static void AfterFeaturePluginLifecycleEventHandler(object sender, Runti
 
         private static void CustomizeScenarioDependenciesEventHandler(object sender, CustomizeScenarioDependenciesEventArgs args)
         {
+            var serviceCollectionFinder = args.ObjectContainer.Resolve<IServiceCollectionFinder>();
+            var lifetime = serviceCollectionFinder.GetServiceProviderLifetime();
+
+            if (lifetime == ServiceProviderLifetimeType.Scenario)
+            {
+                args.ObjectContainer.RegisterFactoryAs<RootServiceProviderContainer>(() => BuildRootServiceProviderContainer(args.ObjectContainer));
+            }
+
             // At this point we have the bindings, we can resolve the service provider, which will build it if it's the first time.
             var spContainer = args.ObjectContainer.Resolve<RootServiceProviderContainer>();
 
@@ -127,6 +149,15 @@ private static void AfterScenarioPluginLifecycleEventHandler(object sender, Runt
             }
         }
 
+        private static RootServiceProviderContainer BuildRootServiceProviderContainer(IObjectContainer container)
+        {
+            var serviceCollectionFinder = container.Resolve<IServiceCollectionFinder>();
+            var (services, scoping) = serviceCollectionFinder.GetServiceCollection();
+
+            RegisterProxyBindings(container, services);
+            return new RootServiceProviderContainer(services.BuildServiceProvider(), scoping);
+        }
+
         private static void RegisterProxyBindings(IObjectContainer objectContainer, IServiceCollection services)
         {
             // Required for DI of binding classes that want container injections

Plugins/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin/IServiceCollectionFinder.cs

@@ -4,6 +4,7 @@ namespace Reqnroll.Microsoft.Extensions.DependencyInjection
 {
     public interface IServiceCollectionFinder
     {
+        ServiceProviderLifetimeType GetServiceProviderLifetime();
         (IServiceCollection, ScopeLevelType) GetServiceCollection();
     }
 }

Plugins/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin/ScenarioDependenciesAttribute.cs

@@ -14,6 +14,26 @@ public enum ScopeLevelType
         Feature
     }
 
+    public enum ServiceProviderLifetimeType
+    {
+        /// <summary>
+        /// Global lifetime. The container is created once for the entire test run.
+        /// </summary>
+        Global,
+        /// <summary>
+        /// Test thread lifetime. The container is created once for each test thread.
+        /// </summary>
+        TestThread,
+        /// <summary>
+        /// Feature lifetime. The container is created once for each feature.
+        /// </summary>
+        Feature,
+        /// <summary>
+        /// Scenario lifetime. The container is created once for each scenario.
+        /// </summary>
+        Scenario
+    }
+
     [AttributeUsage(AttributeTargets.Method)]
     public class ScenarioDependenciesAttribute : Attribute
     {
@@ -26,5 +46,10 @@ public class ScenarioDependenciesAttribute : Attribute
         /// Define when to create and destroy scope. 
         /// </summary>
         public ScopeLevelType ScopeLevel { get; set; } = ScopeLevelType.Scenario;
+
+        /// <summary>
+        /// Define the lifetime of the Service Provider instance.
+        /// </summary>
+        public ServiceProviderLifetimeType ServiceProviderLifetime { get; set; } = ServiceProviderLifetimeType.Global;
     }
 }

Plugins/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin/ServiceCollectionFinder.cs

@@ -3,32 +3,58 @@
 using System.Linq;
 using System.Reflection;
 using Microsoft.Extensions.DependencyInjection;
+using Reqnroll.Bindings.Discovery;
+using Reqnroll.Infrastructure;
 
 namespace Reqnroll.Microsoft.Extensions.DependencyInjection
 {
     public class ServiceCollectionFinder : IServiceCollectionFinder
     {
-        private readonly ITestRunnerManager testRunnerManager;
-        private (IServiceCollection, ScopeLevelType) _cache;
+        private readonly ITestRunnerManager _testRunnerManager;
+        private readonly IRuntimeBindingRegistryBuilder _bindingRegistryBuilder;
+        private readonly ITestAssemblyProvider _testAssemblyProvider;
+        private (IServiceCollection ServiceCollection, ScenarioDependenciesAttribute Attribute) _cache;
 
-        public ServiceCollectionFinder(ITestRunnerManager testRunnerManager)
+        public ServiceCollectionFinder(ITestRunnerManager testRunnerManager, IRuntimeBindingRegistryBuilder bindingRegistryBuilder, ITestAssemblyProvider testAssemblyProvider, IBindingAssemblyLoader bindingAssemblyLoader)
         {
-            this.testRunnerManager = testRunnerManager;
+            _testRunnerManager = testRunnerManager;
+            _bindingRegistryBuilder = bindingRegistryBuilder;
+            _testAssemblyProvider = testAssemblyProvider;
+        }
+
+        public ServiceProviderLifetimeType GetServiceProviderLifetime()
+        {
+            if (_cache == default)
+            {
+                PopulateCache();
+            }
+
+            return _cache.Attribute.ServiceProviderLifetime;
         }
 
         public (IServiceCollection, ScopeLevelType) GetServiceCollection()
+        {
+            if (_cache == default)
+            {
+                PopulateCache();
+            }
+
+            return (_cache.ServiceCollection, _cache.Attribute.ScopeLevel);
+        }
+
+        private void PopulateCache()
         {
             if (_cache != default)
             {
-                return _cache;
+                return;
             }
 
-            var assemblies = testRunnerManager.BindingAssemblies;
+            var assemblies = _testRunnerManager.BindingAssemblies ?? _bindingRegistryBuilder.GetBindingAssemblies(_testAssemblyProvider.TestAssembly);
             foreach (var assembly in assemblies)
             {
                 foreach (var type in assembly.GetTypes())
                 {
-                    foreach (MethodInfo methodInfo in type.GetMethods(BindingFlags.Static | BindingFlags.NonPublic | BindingFlags.Public))
+                    foreach (var methodInfo in type.GetMethods(BindingFlags.Static | BindingFlags.NonPublic | BindingFlags.Public))
                     {
                         var scenarioDependenciesAttribute = (ScenarioDependenciesAttribute)Attribute.GetCustomAttribute(methodInfo, typeof(ScenarioDependenciesAttribute));
 
@@ -39,7 +65,8 @@ public ServiceCollectionFinder(ITestRunnerManager testRunnerManager)
                             {
                                 AddBindingAttributes(assemblies, serviceCollection);
                             }
-                            return _cache = (serviceCollection, scenarioDependenciesAttribute.ScopeLevel);
+                            _cache = (serviceCollection, scenarioDependenciesAttribute);
+                            return;
                         }
                     }
                 }
@@ -50,12 +77,13 @@ public ServiceCollectionFinder(ITestRunnerManager testRunnerManager)
 
         private static IServiceCollection GetServiceCollection(MethodInfo methodInfo)
         {
-            var serviceCollection = methodInfo.Invoke(null, null);
-            if(methodInfo.ReturnType == typeof(void))
+            if (methodInfo.ReturnType == typeof(void))
             {
                 throw new InvalidScenarioDependenciesException("the method doesn't return a value.");
             }
 
+            var serviceCollection = methodInfo.Invoke(null, null);
+
             if (serviceCollection == null)
             {
                 throw new InvalidScenarioDependenciesException("returned null.");