feat: Add ability to pass ServiceProviderOptions to TestServiceProvider

Fixed #574

Author: rodolfograve

CHANGELOG.md

@@ -9,6 +9,7 @@ All notable changes to **bUnit** will be documented in this file. The project ad
 ### Added
 
 - Add `ComponentFactories` extensions method that makes it easy to register an instance of a replacement component. By [@egil](https://github.com/egil).
+- Add ability to pass `ServiceProviderOptions` to `TestServiceProvider` through property to allow users to customize the service provider. By [@rodolfograve](https://github.com/rodolfograve).
 
 ### Fixed
 

src/bunit.core/TestServiceProvider.cs

@@ -8,11 +8,13 @@ namespace Bunit;
 /// </summary>
 public sealed class TestServiceProvider : IServiceProvider, IServiceCollection, IDisposable
 {
+	private readonly static ServiceProviderOptions DefaultServiceProviderOptions = new() { ValidateScopes = true };
 	private readonly IServiceCollection serviceCollection;
 	private IServiceProvider? rootServiceProvider;
 	private IServiceScope? serviceScope;
 	private IServiceProvider? serviceProvider;
 	private IServiceProvider? fallbackServiceProvider;
+	private ServiceProviderOptions options = DefaultServiceProviderOptions;
 
 	/// <summary>
 	/// Gets a value indicating whether this <see cref="TestServiceProvider"/> has been initialized, and
@@ -37,6 +39,15 @@ public ServiceDescriptor this[int index]
 		}
 	}
 
+	/// <summary>
+	/// Gets or sets the <see cref="ServiceProviderOptions"/> used when the <see cref="IServiceProvider"/> is created.
+	/// </summary>
+	public ServiceProviderOptions Options
+	{
+		get => options;
+		set => options = value ?? DefaultServiceProviderOptions;
+	}
+
 	/// <summary>
 	/// Initializes a new instance of the <see cref="TestServiceProvider"/> class
 	/// and sets its service collection to the provided <paramref name="initialServiceCollection"/>, if any.
@@ -83,7 +94,7 @@ public object GetService(Type serviceType)
 		if (serviceProvider is null)
 		{
 			serviceCollection.AddSingleton<TestServiceProvider>(this);
-			rootServiceProvider = serviceCollection.BuildServiceProvider(validateScopes: true);
+			rootServiceProvider = serviceCollection.BuildServiceProvider(options);
 			serviceScope = rootServiceProvider.CreateScope();
 			serviceProvider = serviceScope.ServiceProvider;
 		}

tests/bunit.core.tests/TestContextBaseTest.net5.cs

@@ -1,10 +1,5 @@
+
 #if NET5_0_OR_GREATER
-using System;
-using Bunit.Extensions;
-using Bunit.TestAssets.SampleComponents;
-using Microsoft.AspNetCore.Components;
-using Moq;
-using Xunit;
 
 namespace Bunit;
 

tests/bunit.core.tests/TestServiceProviderTest.cs

@@ -10,6 +10,13 @@ private class AnotherDummyService { }
 
 	private class OneMoreDummyService { }
 
+	private class DummyServiceWithDependencyOnAnotherDummyService
+	{
+		public DummyServiceWithDependencyOnAnotherDummyService(AnotherDummyService anotherDummyService)
+		{
+		}
+	}
+
 	private class FallbackServiceProvider : IServiceProvider
 	{
 		public object GetService(Type serviceType) => new DummyService();
@@ -25,6 +32,16 @@ private class DummyComponentWhichRequiresDummyService : ComponentBase
 		[Inject] public DummyService Service { get; set; }
 	}
 
+	private sealed class DisposableService : IDisposable
+	{
+		public bool IsDisposed { get; private set; }
+
+		public void Dispose()
+		{
+			IsDisposed = true;
+		}
+	}
+
 	[Fact(DisplayName = "Provider initialized without a service collection has zero services by default")]
 	public void Test001()
 	{
@@ -240,13 +257,48 @@ public void Test033()
 		disposable.IsDisposed.ShouldBeTrue();
 	}
 
-	private sealed class DisposableService : IDisposable
+	[Fact(DisplayName = "Validates that all dependencies can be created when the first service is requested, if ServiceProviderOptions.ValidateOnBuild is true")]
+	public void Test035()
 	{
-		public bool IsDisposed { get; private set; }
+		using var sut = new TestServiceProvider();
+		sut.Options = new ServiceProviderOptions
+		{
+			ValidateOnBuild = true,
+			ValidateScopes = true
+		};
+		sut.AddSingleton<DummyService>();
+		sut.AddSingleton<DummyServiceWithDependencyOnAnotherDummyService>();
+		var action = () => sut.GetRequiredService<DummyService>();
+
+		action.ShouldThrow<AggregateException>("Some services are not able to be constructed (Error while validating the service descriptor");
+	}
 
-		public void Dispose()
+	[Fact(DisplayName ="Does not validate all dependencies can be created when the first service is requested, if ServiceProviderOptions.ValidateOnBuild is false")]
+	public void Test036()
+	{
+		using var sut = new TestServiceProvider();
+		sut.Options = new ServiceProviderOptions
 		{
-			IsDisposed = true;
-		}
+			ValidateOnBuild = false,
+			ValidateScopes = true
+		};
+		sut.AddSingleton<DummyService>();
+		sut.AddSingleton<DummyServiceWithDependencyOnAnotherDummyService>();
+
+		var result = sut.GetRequiredService<DummyService>();
+
+		result.ShouldNotBeNull();
+	}
+
+	[Fact(DisplayName ="Does not validate all dependencies can be created when the first service is requested, if no ServiceProviderOptions is provided (backwards compatibility)")]
+	public void Test037()
+	{
+		using var sut = new TestServiceProvider();
+		sut.AddSingleton<DummyService>();
+		sut.AddSingleton<DummyServiceWithDependencyOnAnotherDummyService>();
+
+		var result = sut.GetRequiredService<DummyService>();
+
+		result.ShouldNotBeNull();
 	}
 }

tests/bunit.core.tests/TestServiceProviderTest.net5.cs

@@ -1,10 +1,4 @@
 #if NET5_0_OR_GREATER
-using System;
-using System.Threading.Tasks;
-using Microsoft.Extensions.DependencyInjection;
-using Shouldly;
-using Xunit;
-
 namespace Bunit;
 
 public partial class TestServiceProviderTest