refactor: Rename TestServiceProvider to BunitServiceProvider (#1416)

Author: linkdotnet

MIGRATION.md

@@ -76,3 +76,6 @@ public class HelloWorldInstancePerTestCase : Bunit.TestContext
 ```
 
 Or use the `BunitContext` directly and manage the lifecycle yourself.
+
+## `TestServiceProvider` renamed to `BunitTestServiceProvider`
+The `TestServiceProvider` class has been renamed to `BunitTestServiceProvider`. If you used `TestServiceProvider`, you should replace it with `BunitTestServiceProvider`.

docs/samples/tests/xunit/MockHttpClientBunitHelpers.cs

@@ -11,7 +11,7 @@ namespace Bunit.Docs.Samples;
 
 public static class MockHttpClientBunitHelpers
 {
-  public static MockHttpMessageHandler AddMockHttpClient(this TestServiceProvider services)
+  public static MockHttpMessageHandler AddMockHttpClient(this BunitServiceProvider services)
   {
     var mockHttpHandler = new MockHttpMessageHandler();
     var httpClient = mockHttpHandler.ToHttpClient();

docs/site/docs/providing-input/inject-services-into-components.md

@@ -28,11 +28,11 @@ The highlighted line shows how the `IWeatherForecastService` is registered in th
 
 ##  Fallback service provider
 
-A fallback service provider can be registered with the built-in `TestServiceProvider`. This enables a few interesting use cases, such as using an alternative IoC container (which should implement the `IServiceProvider` interface), or automatically creating mock services for your Blazor components. The latter can be achieved by using a combination of [AutoFixture](https://github.com/AutoFixture/AutoFixture) and your favorite mocking framework, e.g. Moq, NSubsitute, or Telerik JustMock.
+A fallback service provider can be registered with the built-in `BunitServiceProvider`. This enables a few interesting use cases, such as using an alternative IoC container (which should implement the `IServiceProvider` interface), or automatically creating mock services for your Blazor components. The latter can be achieved by using a combination of [AutoFixture](https://github.com/AutoFixture/AutoFixture) and your favorite mocking framework, e.g. Moq, NSubsitute, or Telerik JustMock.
 
 ### When is the fallback service provider used?
 
-The logic inside the `TestServiceProvider` for using the fallback service provider is as follows:
+The logic inside the `BunitServiceProvider` for using the fallback service provider is as follows:
 
 1. Try resolving the requested service from the standard service provider in bUnit.
 2. If that fails, try resolving from a fallback service provider, if one exists.
@@ -52,7 +52,7 @@ Here is a test where the fallback service provider is used:
 In this example, the `DummyService` is provided by the fallback service provider, since it is not registered in the default service provider.
 
 ## Using a custom IServiceProvider implementation
-A custom service provider factory can be registered with the built-in `TestServiceProvider`. It is used to create the underlying IServiceProvider. This enables a few interesting use cases, such as using an alternative IoC container (which should implement the `IServiceProvider` interface). This approach can be useful if the fallback service provider is not an option. For example, if you have dependencies in the fallback container, that rely on dependencies which are in the main container and vice versa.
+A custom service provider factory can be registered with the built-in `BunitServiceProvider`. It is used to create the underlying IServiceProvider. This enables a few interesting use cases, such as using an alternative IoC container (which should implement the `IServiceProvider` interface). This approach can be useful if the fallback service provider is not an option. For example, if you have dependencies in the fallback container, that rely on dependencies which are in the main container and vice versa.
 
 ### Registering Autofac service provider factory
 The example makes use of `AutofacServiceProviderFactory` and `AutofacServiceProvider` from the package `Autofac.Extensions.DependencyInjection` and shows how to use an Autofac dependency container with bUnit.

src/bunit/Asserting/MarkupMatchesAssertExtensions.cs

@@ -275,7 +275,7 @@ public static void MarkupMatches(this RenderedFragment actual, RenderFragment ex
 		// TODO: This will be obsolete with: https://github.com/bUnit-dev/bUnit/issues/1018
 		// As the renderer would be transient we don't have to new up an instance
 		using var renderer = new BunitRenderer(
-			actual.Services.GetRequiredService<TestServiceProvider>(),
+			actual.Services.GetRequiredService<BunitServiceProvider>(),
 			actual.Services.GetRequiredService<ILoggerFactory>());
 		var renderedFragment = renderer.RenderFragment(expected);
 		MarkupMatches(actual, renderedFragment, userMessage);

src/bunit/BunitContext.cs

@@ -33,7 +33,7 @@ public partial class BunitContext : IDisposable, IAsyncDisposable
 	/// Gets the service collection and service provider that is used when a
 	/// component is rendered by the test context.
 	/// </summary>
-	public TestServiceProvider Services { get; }
+	public BunitServiceProvider Services { get; }
 
 	/// <summary>
 	/// Gets the <see cref="RootRenderTree"/> that all components rendered with the
@@ -58,7 +58,7 @@ public partial class BunitContext : IDisposable, IAsyncDisposable
 	/// </summary>
 	public BunitContext()
 	{
-		Services = new TestServiceProvider();
+		Services = new BunitServiceProvider();
 		Services.AddSingleton<ComponentFactoryCollection>(_ => ComponentFactories);
 		Services.AddDefaultBunitContextServices(this, JSInterop);
 	}

src/bunit/TestServiceProvider.cs renamed to src/bunit/BunitServiceProvider.cs

@@ -6,7 +6,7 @@ namespace Bunit;
 /// Represents a <see cref="IServiceProvider"/> and <see cref="IServiceCollection"/>
 /// as a single type used for test purposes.
 /// </summary>
-public sealed class TestServiceProvider : IKeyedServiceProvider, IServiceCollection, IDisposable, IAsyncDisposable
+public sealed class BunitServiceProvider : IKeyedServiceProvider, IServiceCollection, IDisposable, IAsyncDisposable
 {
 	private static readonly ServiceProviderOptions DefaultServiceProviderOptions = new() { ValidateScopes = true };
 	private readonly IServiceCollection serviceCollection;
@@ -18,7 +18,7 @@ public sealed class TestServiceProvider : IKeyedServiceProvider, IServiceCollect
 	private Func<IServiceProvider> serviceProviderFactory;
 
 	/// <summary>
-	/// Gets a value indicating whether this <see cref="TestServiceProvider"/> has been initialized, and
+	/// Gets a value indicating whether this <see cref="BunitServiceProvider"/> has been initialized, and
 	/// no longer will accept calls to the <c>AddService</c>'s methods.
 	/// </summary>
 	public bool IsProviderInitialized => serviceProvider is not null;
@@ -50,15 +50,15 @@ public ServiceProviderOptions Options
 	}
 
 	/// <summary>
-	/// Initializes a new instance of the <see cref="TestServiceProvider"/> class
+	/// Initializes a new instance of the <see cref="BunitServiceProvider"/> class
 	/// and sets its service collection to the provided <paramref name="initialServiceCollection"/>, if any.
 	/// </summary>
-	public TestServiceProvider(IServiceCollection? initialServiceCollection = null)
+	public BunitServiceProvider(IServiceCollection? initialServiceCollection = null)
 		: this(initialServiceCollection ?? new ServiceCollection(), initializeProvider: false)
 	{
 	}
 
-	private TestServiceProvider(IServiceCollection initialServiceCollection, bool initializeProvider)
+	private BunitServiceProvider(IServiceCollection initialServiceCollection, bool initializeProvider)
 	{
 		serviceCollection = initialServiceCollection;
 		serviceProviderFactory = () => serviceCollection.BuildServiceProvider(Options);
@@ -110,7 +110,7 @@ private void InitializeProvider()
 	{
 		CheckInitializedAndThrow();
 
-		serviceCollection.AddSingleton<TestServiceProvider>(this);
+		serviceCollection.AddSingleton<BunitServiceProvider>(this);
 		rootServiceProvider = serviceProviderFactory.Invoke();
 		serviceScope = rootServiceProvider.CreateScope();
 		serviceProvider = serviceScope.ServiceProvider;

src/bunit/Extensions/TestServiceProviderExtensions.cs renamed to src/bunit/Extensions/BunitServiceProviderExtensions.cs

@@ -12,7 +12,7 @@ namespace Bunit.Extensions;
 /// <summary>
 /// Helper methods for correctly registering test dependencies.
 /// </summary>
-public static class TestServiceProviderExtensions
+public static class BunitServiceProviderExtensions
 {
 	/// <summary>
 	/// Registers the default services required by the web <see cref="BunitContext"/>.

src/bunit/Rendering/BunitRenderer.cs

@@ -10,7 +10,7 @@ namespace Bunit.Rendering;
 /// </summary>
 public sealed class BunitRenderer : Renderer
 {
-	private readonly TestServiceProvider services;
+	private readonly BunitServiceProvider services;
 
 	[UnsafeAccessor(UnsafeAccessorKind.Field, Name = "_isBatchInProgress")]
 	private static extern ref bool GetIsBatchInProgressField(Renderer renderer);
@@ -57,7 +57,7 @@ private bool IsBatchInProgress
 	/// <summary>
 	/// Initializes a new instance of the <see cref="BunitRenderer"/> class.
 	/// </summary>
-	public BunitRenderer(TestServiceProvider services, ILoggerFactory loggerFactory)
+	public BunitRenderer(BunitServiceProvider services, ILoggerFactory loggerFactory)
 		: base(services, loggerFactory, new BunitComponentActivator(services.GetRequiredService<ComponentFactoryCollection>(), null))
 	{
 		this.services = services;
@@ -68,7 +68,7 @@ public BunitRenderer(TestServiceProvider services, ILoggerFactory loggerFactory)
 	/// <summary>
 	/// Initializes a new instance of the <see cref="BunitRenderer"/> class.
 	/// </summary>
-	public BunitRenderer(TestServiceProvider services, ILoggerFactory loggerFactory, IComponentActivator componentActivator)
+	public BunitRenderer(BunitServiceProvider services, ILoggerFactory loggerFactory, IComponentActivator componentActivator)
 		: base(services, loggerFactory, new BunitComponentActivator(services.GetRequiredService<ComponentFactoryCollection>(), componentActivator))
 	{
 		this.services = services;

src/bunit/Rendering/RenderedFragment.cs

@@ -10,7 +10,7 @@ namespace Bunit;
 [DebuggerDisplay("Rendered:{RenderCount}")]
 public class RenderedFragment : IDisposable
 {
-	[SuppressMessage("Usage", "CA2213:Disposable fields should be disposed", Justification = "Owned by TestServiceProvider, disposed by it.")]
+	[SuppressMessage("Usage", "CA2213:Disposable fields should be disposed", Justification = "Owned by BunitServiceProvider, disposed by it.")]
 	private readonly BunitHtmlParser htmlParser;
 	private string markup = string.Empty;
 	private INodeList? latestRenderNodes;

src/bunit/TestDoubles/Authorization/BunitAuthorizationContext.cs

@@ -53,7 +53,7 @@ public class BunitAuthorizationContext
 	/// <summary>
 	/// Creates a new instance of <see cref="BunitAuthorizationContext"/>.
 	/// </summary>
-	internal BunitAuthorizationContext(TestServiceProvider services)
+	internal BunitAuthorizationContext(BunitServiceProvider services)
 	{
 		services.AddSingleton<IAuthorizationService>(authService);
 		services.AddSingleton<IAuthorizationPolicyProvider>(policyProvider);