feat: Added support for keyed services (#1374)

Author: linkdotnet

.github/workflows/ci.yml

@@ -109,7 +109,7 @@ jobs:
       - name: Validate package
         shell: pwsh
         run: meziantou.validate-nuget-package (Get-ChildItem "${{ env.NUGET_DIRECTORY }}/*.nupkg") --excluded-rules IconMustBeSet
-        
+
   run-test:
     strategy:
       fail-fast: false
@@ -134,7 +134,7 @@ jobs:
             8.0.x
 
       - name: 🧪 Run unit tests
-        run: dotnet test -c release
+        run: dotnet test -c release --blame --blame-crash --blame-hang
 
       - name: 📛 Upload hang- and crash-dumps on test failure
         if: failure()

CHANGELOG.md

@@ -6,6 +6,9 @@ All notable changes to **bUnit** will be documented in this file. The project ad
 
 ## [Unreleased]
 
+### Added
+- Support for `IKeyedServiceProvider` in net8.0. Reported by [@ViRuSTriNiTy](https://github.com/ViRuSTriNiTy). By [@linkdotnet](https://github.com/linkdotnet).
+
 ## [1.26.64] - 2023-12-20
 
 ### Changed

src/bunit.core/TestServiceProvider.cs

@@ -6,7 +6,11 @@ namespace Bunit;
 /// Represents a <see cref="IServiceProvider"/> and <see cref="IServiceCollection"/>
 /// as a single type used for test purposes.
 /// </summary>
+#if !NET8_0_OR_GREATER
 public sealed class TestServiceProvider : IServiceProvider, IServiceCollection, IDisposable, IAsyncDisposable
+#else
+public sealed class TestServiceProvider : IKeyedServiceProvider, IServiceCollection, IDisposable, IAsyncDisposable
+#endif
 {
 	private static readonly ServiceProviderOptions DefaultServiceProviderOptions = new() { ValidateScopes = true };
 	private readonly IServiceCollection serviceCollection;
@@ -230,6 +234,35 @@ public bool Remove(ServiceDescriptor item)
 		return serviceCollection.Remove(item);
 	}
 
+#if NET8_0_OR_GREATER
+	/// <inheritdoc/>
+	public object? GetKeyedService(Type serviceType, object? serviceKey)
+	{
+		if (serviceProvider is null)
+			InitializeProvider();
+
+		if (serviceProvider is IKeyedServiceProvider keyedServiceProvider)
+		{
+			var value = keyedServiceProvider.GetKeyedService(serviceType, serviceKey);
+			if (value is not null)
+				return value;
+		}
+
+		if (fallbackServiceProvider is IKeyedServiceProvider fallbackKeyedServiceProvider)
+			return fallbackKeyedServiceProvider.GetKeyedService(serviceType, serviceKey);
+
+		return default;
+	}
+
+	/// <inheritdoc/>
+	public object GetRequiredKeyedService(Type serviceType, object? serviceKey)
+	{
+		var service = GetKeyedService(serviceType, serviceKey) ?? throw new InvalidOperationException($"No service for type '{serviceType}' and key '{serviceKey}' has been registered.");
+
+		return service;
+	}
+#endif
+
 	private void CheckInitializedAndThrow()
 	{
 		if (IsProviderInitialized)

tests/.editorconfig

@@ -42,6 +42,7 @@ dotnet_diagnostic.CA2007.severity = none            # https://github.com/atc-net
 
 dotnet_diagnostic.CA1819.severity = suggestion		# CA1819: Properties should not return arrays
 dotnet_diagnostic.CA1849.severity = suggestion		# CA1849: Call async methods when in an async method
+dotnet_diagnostic.CA2255.severity = suggestion		# CA2255:  The 'ModuleInitializer' attribute is only intended to be used in application code or advanced source generator scenarios
 dotnet_diagnostic.xUnit1026.severity = none			# xUnit1026: Theory methods should use all of their parameters
 dotnet_diagnostic.xUnit1034.severity = none			# xUnit1034: Null should not be used for type parameter
 dotnet_diagnostic.S1144.severity = suggestion		# S1144: Unused private types or members should be removed

tests/bunit.core.tests/TestServiceProviderTest.cs

@@ -296,6 +296,40 @@ public void Test039()
 		dummyServiceProvider.ResolvedTestServices.ShouldContain(result);
 		dummyServiceProvider.ResolvedTestServices.Count.ShouldBe(1);
 	}
+	
+#if NET8_0_OR_GREATER
+	[Fact(DisplayName = "Should resolve keyed service from container")]
+	public void Test040()
+	{
+		using var ctx = new TestContext();
+		ctx.Services.AddKeyedScoped<DummyService>("Key");
+
+		var cut = ctx.RenderComponent<ComponentWithKeyedService>();
+
+		cut.Instance.Service.ShouldNotBeNull();
+	}
+
+	[Fact(DisplayName = "Should resolved keyed service from fallback service provider")]
+	public void Test041()
+	{
+		using var ctx = new TestContext();
+		var fallbackCollection = new ServiceCollection();
+		fallbackCollection.AddKeyedScoped<DummyService>("Key");
+		ctx.Services.AddFallbackServiceProvider(fallbackCollection.BuildServiceProvider());
+		
+		var cut = ctx.RenderComponent<ComponentWithKeyedService>();
+
+		cut.Instance.Service.ShouldNotBeNull();
+	}
+	
+	[Fact(DisplayName = "Throw an exception if required keyed service is not found")]
+	public void Test042()
+	{
+		using var ctx = new TestContext();
+
+		Should.Throw<InvalidOperationException>(() => ctx.RenderComponent<ComponentWithKeyedService>());
+	}
+#endif
 
 	private sealed class DummyService { }
 
@@ -381,4 +415,12 @@ public DummyServiceProviderFactoryContainerBuilder CreateBuilder(IServiceCollect
 		public IServiceProvider CreateServiceProvider(DummyServiceProviderFactoryContainerBuilder containerBuilder)
 			=> containerBuilder.Build();
 	}
+	
+#if NET8_0_OR_GREATER
+	private sealed class ComponentWithKeyedService : ComponentBase
+	{
+		[Inject(Key = "Key")]
+		public DummyService Service { get; set; }
+	}
+#endif
 }

tests/bunit.generators.tests/bunit.generators.tests.csproj

@@ -3,7 +3,7 @@
 	<PropertyGroup>
 		<TargetFramework>net8.0</TargetFramework>
 		<RootNamespace>Bunit</RootNamespace>
-		<AssemblyName>Bunit.Web.AngleSharp.Tests</AssemblyName>
+		<AssemblyName>Bunit.Generator.Tests</AssemblyName>
 		<ImplicitUsings>true</ImplicitUsings>
 		<SonarQubeTestProject>true</SonarQubeTestProject>
 		<IsPackable>false</IsPackable>
@@ -13,19 +13,20 @@
 	</PropertyGroup>
 
 	<ItemGroup>
+		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
 		<PackageReference Include="System.Net.Http" Version="4.3.4" />
 		<PackageReference Include="System.Text.RegularExpressions" Version="4.3.1" />
 		<PackageReference Include="Verify.SourceGenerators" Version="2.2.0" />
 		<PackageReference Include="Verify.Xunit" Version="23.1.0" />
-		<PackageReference Include="Microsoft.AspNetCore.Components.Web" Version="8.0.0" />
+		<PackageReference Include="Microsoft.AspNetCore.Components.Web" Version="8.0.2" />
 		<PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.8.0" />
 		<PackageReference Include="Microsoft.CodeAnalysis.Common" Version="4.8.0" />
 		<PackageReference Include="Microsoft.CodeAnalysis.Workspaces.Common" Version="4.8.0" />
 		<PackageReference Update="Microsoft.CodeAnalysis.CSharp.Workspaces" Version="4.8.0" />
 		<PackageReference Update="Microsoft.CodeAnalysis.CSharp.SourceGenerators.Testing.XUnit" Version="1.1.1" />
 
 		<PackageReference Include="xunit" Version="2.6.6" />
-		<PackageReference Include="xunit.runner.visualstudio" Version="2.5.4">
+		<PackageReference Include="xunit.runner.visualstudio" Version="2.5.6">
 			<PrivateAssets>all</PrivateAssets>
 			<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
 		</PackageReference>