feat: Add support for net8.0 (#1166)

linkdotnet · web-flow · commit 3de521184a34 · 2023-07-31T16:10:00.000+02:00
* feat: Add support for net8.0

* Don't warn for SYSLIB0051

* Added some fixes for .net8.0
diff --git a/.github/workflows/docs-deploy.yml b/.github/workflows/docs-deploy.yml
@@ -68,6 +68,7 @@ jobs:
             5.0.x
             6.0.x
             7.0.x
+            8.0.x
 
       - name: 🎨 Setup color
         run: |
diff --git a/.github/workflows/release-preview.yml b/.github/workflows/release-preview.yml
@@ -36,6 +36,7 @@ jobs:
             5.0.x
             6.0.x
             7.0.x
+            8.0.x
 
       - name: 🎨 Setup color
         run: |
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -67,6 +67,7 @@ jobs:
             5.0.x
             6.0.x
             7.0.x
+            8.0.x
 
       - name: 🛠️ Update changelog
         uses: thomaseizinger/keep-a-changelog-new-release@1.3.0
diff --git a/.github/workflows/verification.yml b/.github/workflows/verification.yml
@@ -48,6 +48,7 @@ jobs:
             5.0.x
             6.0.x
             7.0.x
+            8.0.x
 
       - name: 🎨 Setup color
         if: matrix.os != 'windows-latest'
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,11 @@ All notable changes to **bUnit** will be documented in this file. The project ad
 
 ## [Unreleased]
 
+
+### Added
+
+- `net8.0` support
+
 ## [1.22.19] - 2023-07-28
 
 ### Added
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -6,6 +6,7 @@
 		<DotNet5Version>5.0.0</DotNet5Version>
 		<DotNet6Version>6.0.0</DotNet6Version>
 		<DotNet7Version>7.0.0</DotNet7Version>
+		<DotNet8Version>8.0.0-*</DotNet8Version>
 	</PropertyGroup>
 
 	<!-- Solution wide properties -->
@@ -21,7 +22,7 @@
 		<LangVersion>11.0</LangVersion>
 		<AccelerateBuildsInVisualStudio>false</AccelerateBuildsInVisualStudio>
 		<ImplicitUsings>enable</ImplicitUsings>
-		<NoWarn>CA1014,NU5104,NETSDK1138</NoWarn>
+		<NoWarn>CA1014,NU5104,NETSDK1138,SYSLIB0051</NoWarn>
 		<CheckEolTargetFramework>false</CheckEolTargetFramework>
 
 		<!-- Used by code coverage -->
@@ -38,7 +39,7 @@
 	<PropertyGroup Label="Analyzer settings">
 		<AnalysisMode>AllEnabledByDefault</AnalysisMode>
 		<EnableNETAnalyzers>true</EnableNETAnalyzers>
-		<AnalysisLevel>latest</AnalysisLevel>
+		<AnalysisLevel>7</AnalysisLevel>
 		<EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
 	</PropertyGroup>
 
diff --git a/global.json b/global.json
@@ -1,6 +1,6 @@
 {
 	"sdk": {
 		"rollForward": "latestMajor",
-		"allowPrerelease": false
+		"allowPrerelease": true
 	}
 }
diff --git a/src/bunit.core/Rendering/TestRenderer.cs b/src/bunit.core/Rendering/TestRenderer.cs
@@ -12,7 +12,9 @@ public class TestRenderer : Renderer, ITestRenderer
 {
 	private static readonly Type RendererType = typeof(Renderer);
 	private static readonly FieldInfo IsBatchInProgressField = RendererType.GetField("_isBatchInProgress", BindingFlags.Instance | BindingFlags.NonPublic)!;
+#if !NET8_0_OR_GREATER
 	private static readonly MethodInfo GetRequiredComponentStateMethod = RendererType.GetMethod("GetRequiredComponentState", BindingFlags.Instance | BindingFlags.NonPublic)!;
+#endif
 
 	private readonly object renderTreeUpdateLock = new();
 	private readonly Dictionary<int, IRenderedFragmentBase> renderedComponents = new();
@@ -96,7 +98,11 @@ public IRenderedComponentBase<TComponent> RenderComponent<TComponent>(ComponentP
 		EventArgs eventArgs) => DispatchEventAsync(eventHandlerId, fieldInfo, eventArgs, ignoreUnknownEventHandlers: false);
 
 	/// <inheritdoc/>
+#if !NET8_0_OR_GREATER
 	public Task DispatchEventAsync(
+#else
+	public new Task DispatchEventAsync(
+#endif
 		ulong eventHandlerId,
 		EventFieldInfo fieldInfo,
 		EventArgs eventArgs,
@@ -188,6 +194,17 @@ public void DisposeComponents()
 			AssertNoUnhandledExceptions();
 		}
 	}
+	
+#if NET8_0_OR_GREATER
+	/// <inheritdoc/>
+	protected override IComponent ResolveComponentForRenderMode(Type componentType, int? parentComponentId,
+		IComponentActivator componentActivator, IComponentRenderMode renderMode)
+
+	{
+		ArgumentNullException.ThrowIfNull(componentActivator);
+		return componentActivator.CreateInstance(componentType);
+	}
+#endif
 
 	/// <inheritdoc/>
 	internal void SetDirectParameters(IRenderedFragmentBase renderedComponent, ParameterView parameters)
@@ -207,9 +224,14 @@ internal void SetDirectParameters(IRenderedFragmentBase renderedComponent, Param
 				try
 				{
 					IsBatchInProgress = true;
-
+					
+#if NET8_0_OR_GREATER
+					var setDirectParametersMethod = typeof(ComponentState).GetMethod("SetDirectParameters", BindingFlags.NonPublic | BindingFlags.Instance)!;
+					var componentState = GetComponentState(renderedComponent.ComponentId);
+#else
 					var componentState = GetRequiredComponentStateMethod.Invoke(this, new object[] { renderedComponent.ComponentId })!;
 					var setDirectParametersMethod = componentState.GetType().GetMethod("SetDirectParameters", BindingFlags.Public | BindingFlags.Instance)!;
+#endif
 					setDirectParametersMethod.Invoke(componentState, new object[] { parameters });
 				}
 				catch (TargetInvocationException ex) when (ex.InnerException is not null)
diff --git a/src/bunit.core/bunit.core.csproj b/src/bunit.core/bunit.core.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
 	<PropertyGroup>
-		<TargetFrameworks>netstandard2.1;net5.0;net6.0;net7.0</TargetFrameworks>
+		<TargetFrameworks>netstandard2.1;net5.0;net6.0;net7.0;net8.0</TargetFrameworks>
 		<RootNamespace>Bunit</RootNamespace>
 		<AssemblyName>Bunit.Core</AssemblyName>
 	</PropertyGroup>
@@ -38,4 +38,10 @@
 		<PackageReference Include="Microsoft.AspNetCore.Components" Version="$(DotNet7Version)" />
 	</ItemGroup>
 
+	<ItemGroup Condition="'$(TargetFramework)' == 'net8.0'">
+		<PackageReference Include="Microsoft.Extensions.Logging" Version="$(DotNet8Version)" />
+		<PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="$(DotNet8Version)" />
+		<PackageReference Include="Microsoft.AspNetCore.Components" Version="$(DotNet8Version)" />
+	</ItemGroup>
+
 </Project>
diff --git a/src/bunit.web.testcomponents/bunit.web.testcomponents.csproj b/src/bunit.web.testcomponents/bunit.web.testcomponents.csproj
@@ -33,10 +33,6 @@
 		<PackageReference Include="System.Reflection.Metadata" Version="$(DotNet5Version)" />
 	</ItemGroup>
 
-	<ItemGroup Condition="'$(TargetFramework)' == 'net6.0'">
-		<PackageReference Include="System.Reflection.Metadata" Version="$(DotNet6Version)" />
-	</ItemGroup>
-
 	<ItemGroup>
 		<ProjectReference Include="..\bunit.web\bunit.web.csproj" />
 	</ItemGroup>
diff --git a/src/bunit.web/Asserting/JSInvokeCountExpectedException.cs b/src/bunit.web/Asserting/JSInvokeCountExpectedException.cs
@@ -43,6 +43,9 @@ private JSInvokeCountExpectedException(SerializationInfo serializationInfo, Stre
 	}
 
 	/// <inheritdoc/>
+#if NET8_0_OR_GREATER
+	[Obsolete("This API supports obsolete formatter-based serialization. It should not be called or extended by application code.", DiagnosticId = "SYSLIB0051", UrlFormat = "https://aka.ms/dotnet-warnings/{0}")]
+#endif
 	public override void GetObjectData(SerializationInfo info, StreamingContext context)
 	{
 		if (info is null)
diff --git a/src/bunit.web/Extensions/ElementNotFoundException.cs b/src/bunit.web/Extensions/ElementNotFoundException.cs
@@ -40,6 +40,9 @@ protected ElementNotFoundException(SerializationInfo serializationInfo, Streamin
 	}
 
 	/// <inheritdoc/>
+#if NET8_0_OR_GREATER
+	[Obsolete("This API supports obsolete formatter-based serialization. It should not be called or extended by application code.", DiagnosticId = "SYSLIB0051", UrlFormat = "https://aka.ms/dotnet-warnings/{0}")]
+#endif
 	public override void GetObjectData(SerializationInfo info, StreamingContext context)
 	{
 		if (info is null)
diff --git a/src/bunit.web/Extensions/TestServiceProviderExtensions.cs b/src/bunit.web/Extensions/TestServiceProviderExtensions.cs
@@ -45,6 +45,11 @@ public static IServiceCollection AddDefaultTestContextServices(this IServiceColl
 		services.AddSingleton<FakeWebAssemblyHostEnvironment>();
 		services.AddSingleton<IWebAssemblyHostEnvironment>(s => s.GetRequiredService<FakeWebAssemblyHostEnvironment>());
 
+#if NET8_0_OR_GREATER
+		// bUnits fake ScrollToLocationHash
+		services.AddSingleton<IScrollToLocationHash, BunitScrollToLocationHash>();
+#endif
+		
 		// bUnit specific services
 		services.AddSingleton<TestContextBase>(testContext);
 		services.AddSingleton<WebTestRenderer>();
diff --git a/src/bunit.web/JSInterop/JSRuntimeInvocationDictionary.cs b/src/bunit.web/JSInterop/JSRuntimeInvocationDictionary.cs
@@ -53,11 +53,12 @@ internal void RegisterInvocation(JSRuntimeInvocation invocation)
 	{
 		Count++;
 
-		if (!invocations.ContainsKey(invocation.Identifier))
+		if (!invocations.TryGetValue(invocation.Identifier, out var value))
 		{
-			invocations.Add(invocation.Identifier, new List<JSRuntimeInvocation>());
+			value = new List<JSRuntimeInvocation>();
+			invocations.Add(invocation.Identifier, value);
 		}
 
-		invocations[invocation.Identifier].Add(invocation);
+		value.Add(invocation);
 	}
 }
diff --git a/src/bunit.web/Rendering/RenderedComponent.cs b/src/bunit.web/Rendering/RenderedComponent.cs
@@ -50,7 +50,7 @@ private void SetComponentAndID(RenderEvent renderEvent)
 		}
 	}
 
-	private bool TryFindComponent(RenderTreeFrameDictionary framesCollection, int parentComponentId, out int componentId, out TComponent component)
+	private static bool TryFindComponent(RenderTreeFrameDictionary framesCollection, int parentComponentId, out int componentId, out TComponent component)
 	{
 		componentId = -1;
 		component = default!;
diff --git a/src/bunit.web/TestDoubles/Components/CapturedParameterView{TComponent}.cs b/src/bunit.web/TestDoubles/Components/CapturedParameterView{TComponent}.cs
@@ -106,6 +106,6 @@ IEnumerator IEnumerable.GetEnumerator()
 	/// <returns>An instance of <see cref="CapturedParameterView{TComponent}"/>.</returns>
 	[SuppressMessage("Design", "CA1000:Do not declare static members on generic types", Justification = "Following factory pattern used in .net")]
 	public static CapturedParameterView<TComponent> From(ParameterView parameters)
-		=> new(parameters.ToDictionary());
+		=> new(parameters.ToDictionary()!);
 }
 #endif
diff --git a/src/bunit.web/TestDoubles/Localization/MissingMockStringLocalizationException.cs b/src/bunit.web/TestDoubles/Localization/MissingMockStringLocalizationException.cs
@@ -32,7 +32,10 @@ private MissingMockStringLocalizationException(SerializationInfo serializationIn
 		Arguments = serializationInfo.GetValue(nameof(Arguments), Array.Empty<object?>().GetType()) as object?[] ?? Array.Empty<object?>();
 	}
 
-	/// <inheritdoc/>
+	/// <inheritdoc/>¨
+#if NET8_0_OR_GREATER
+	[Obsolete("This API supports obsolete formatter-based serialization. It should not be called or extended by application code.", DiagnosticId = "SYSLIB0051", UrlFormat = "https://aka.ms/dotnet-warnings/{0}")]
+#endif
 	public override void GetObjectData(SerializationInfo info, StreamingContext context)
 	{
 		if (info is null)
diff --git a/src/bunit.web/TestDoubles/ScrollToLocationHash/BunitScrollToLocationHash.cs b/src/bunit.web/TestDoubles/ScrollToLocationHash/BunitScrollToLocationHash.cs
@@ -0,0 +1,10 @@
+#if NET8_0_OR_GREATER
+using Microsoft.AspNetCore.Components.Routing;
+
+namespace Bunit.TestDoubles;
+
+internal sealed class BunitScrollToLocationHash : IScrollToLocationHash
+{
+	public Task RefreshScrollPositionForHash(string locationAbsolute) => Task.CompletedTask;
+}
+#endif
diff --git a/src/bunit.web/bunit.web.csproj b/src/bunit.web/bunit.web.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
 	<PropertyGroup>
-		<TargetFrameworks>netstandard2.1;net5.0;net6.0;net7.0</TargetFrameworks>
+		<TargetFrameworks>netstandard2.1;net5.0;net6.0;net7.0;net8.0</TargetFrameworks>
 		<RootNamespace>Bunit</RootNamespace>
 		<AssemblyName>Bunit.Web</AssemblyName>
 	</PropertyGroup>
@@ -55,6 +55,15 @@
 		<PackageReference Include="Microsoft.AspNetCore.Components.WebAssembly.Authentication" Version="$(DotNet7Version)" />
 	</ItemGroup>
 
+	<ItemGroup Condition="'$(TargetFramework)' == 'net8.0'">
+		<PackageReference Include="Microsoft.AspNetCore.Components.Authorization" Version="$(DotNet8Version)" />
+		<PackageReference Include="Microsoft.Extensions.Localization.Abstractions" Version="$(DotNet8Version)" />
+		<PackageReference Include="Microsoft.Extensions.Caching.Memory" Version="$(DotNet8Version)" />
+		<PackageReference Include="Microsoft.AspNetCore.Components.Web" Version="$(DotNet8Version)" />
+		<PackageReference Include="Microsoft.AspNetCore.Components.WebAssembly" Version="$(DotNet8Version)" />
+		<PackageReference Include="Microsoft.AspNetCore.Components.WebAssembly.Authentication" Version="$(DotNet8Version)" />
+	</ItemGroup>
+
 	<ItemGroup>
 		<ProjectReference Include="..\AngleSharpWrappers\AngleSharpWrappers.csproj" PrivateAssets="All" />
 		<ProjectReference Include="..\bunit.core\bunit.core.csproj" />
@@ -68,15 +77,15 @@
 	<Target Name="CopyProjectReferencesToPackage" DependsOnTargets="BuildOnlySettings;ResolveReferences">
 		<ItemGroup>
 			<!-- Filter out unnecessary files -->
-			<_ReferenceCopyLocalPaths Include="@(ReferenceCopyLocalPaths->WithMetadataValue('ReferenceSourceTarget', 'ProjectReference')->WithMetadataValue('PrivateAssets', 'All'))"/>
+			<_ReferenceCopyLocalPaths Include="@(ReferenceCopyLocalPaths-&gt;WithMetadataValue('ReferenceSourceTarget', 'ProjectReference')-&gt;WithMetadataValue('PrivateAssets', 'All'))" />
 		</ItemGroup>
 
 		<!-- Print batches for debug purposes -->
 		<Message Text="Batch for .nupkg: ReferenceCopyLocalPaths = @(_ReferenceCopyLocalPaths), ReferenceCopyLocalPaths.DestinationSubDirectory = %(_ReferenceCopyLocalPaths.DestinationSubDirectory) Filename = %(_ReferenceCopyLocalPaths.Filename) Extension = %(_ReferenceCopyLocalPaths.Extension)" Importance="High" Condition="'@(_ReferenceCopyLocalPaths)' != ''" />
 
 		<ItemGroup>
 			<!-- Add file to package with consideration of sub folder. If empty, the root folder is chosen. -->
-			<BuildOutputInPackage Include="@(_ReferenceCopyLocalPaths)" TargetPath="%(_ReferenceCopyLocalPaths.DestinationSubDirectory)"/>
+			<BuildOutputInPackage Include="@(_ReferenceCopyLocalPaths)" TargetPath="%(_ReferenceCopyLocalPaths.DestinationSubDirectory)" />
 		</ItemGroup>
 	</Target>
 
diff --git a/src/bunit/bunit.csproj b/src/bunit/bunit.csproj
@@ -1,6 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
 	<PropertyGroup>
-		<TargetFrameworks>netstandard2.1;net5.0;net6.0;net7.0</TargetFrameworks>
+		<TargetFrameworks>netstandard2.1;net5.0;net6.0;net7.0;net8.0</TargetFrameworks>
 		<NoBuild>true</NoBuild>
 		<IncludeBuildOutput>false</IncludeBuildOutput>
 		<IncludeSymbols>false</IncludeSymbols>		
diff --git a/tests/AngleSharpWrappers.Tests/AngleSharpWrappers.Tests.csproj b/tests/AngleSharpWrappers.Tests/AngleSharpWrappers.Tests.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
 	<PropertyGroup>
-		<TargetFrameworks>netcoreapp3.1;net5.0;net6.0;net7.0</TargetFrameworks>
+		<TargetFrameworks>netcoreapp3.1;net5.0;net6.0;net7.0;net8.0</TargetFrameworks>
 		<RootNamespace>AngleSharpWrappers</RootNamespace>
 		<AssemblyName>AngleSharpWrappers.Tests</AssemblyName>
 	</PropertyGroup>
diff --git a/tests/bunit.core.tests/Rendering/TestRendererTest.cs b/tests/bunit.core.tests/Rendering/TestRendererTest.cs
@@ -488,6 +488,16 @@ public void Test208()
 		cut.Instance.AfterRenderCount.ShouldBe(2);
 		cut.Instance.AfterRenderAsyncCount.ShouldBe(2);
 	}
+	
+#if NET8_0_OR_GREATER
+	[Fact(DisplayName = "Can render components that have a RenderMode attribute")]
+	public void Test209()
+	{
+		var cut = RenderComponent<RenderModeServerComponent>();
+
+		cut.Find("h3").TextContent.ShouldBe("Hello from Server");
+	}
+#endif
 
 	internal sealed class LifeCycleMethodInvokeCounter : ComponentBase
 	{
@@ -622,4 +632,15 @@ protected override async Task OnAfterRenderAsync(bool firstRender)
 			throw new InvalidOperationException();
 		}
 	}
+	
+#if NET8_0_OR_GREATER
+	[RenderModeServer]
+	private sealed class RenderModeServerComponent : ComponentBase
+	{
+		protected override void BuildRenderTree(RenderTreeBuilder builder)
+		{
+			builder.AddMarkupContent(0, "<h3>Hello from Server</h3>");
+		}
+	}
+#endif
 }
diff --git a/tests/bunit.core.tests/bunit.core.tests.csproj b/tests/bunit.core.tests/bunit.core.tests.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk.Razor">
 
 	<PropertyGroup>
-		<TargetFrameworks>netcoreapp3.1;net5.0;net6.0;net7.0</TargetFrameworks>
+		<TargetFrameworks>netcoreapp3.1;net5.0;net6.0;net7.0;net8.0</TargetFrameworks>
 		<RootNamespace>Bunit</RootNamespace>
 		<AssemblyName>Bunit.Core.Tests</AssemblyName>
 	</PropertyGroup>
diff --git a/tests/bunit.testassets/bunit.testassets.csproj b/tests/bunit.testassets/bunit.testassets.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk.Razor">
 
 	<PropertyGroup>
-		<TargetFrameworks>netstandard2.1;net5.0;net6.0;net7.0</TargetFrameworks>
+		<TargetFrameworks>netstandard2.1;net5.0;net6.0;net7.0;net8.0</TargetFrameworks>
 		<RootNamespace>Bunit.TestAssets</RootNamespace>
 		<AssemblyName>Bunit.TestAssets</AssemblyName>
 		<OutputType>Library</OutputType>
@@ -42,5 +42,11 @@
 		<PackageReference Include="Microsoft.AspNetCore.Components.WebAssembly.Authentication" Version="$(DotNet7Version)" />
 		<PackageReference Include="Serilog.Extensions.Logging" Version="7.0.0" />
 	</ItemGroup>
+	<ItemGroup Condition="'$(TargetFramework)' == 'net8.0'">
+		<PackageReference Include="Microsoft.Extensions.Localization.Abstractions" Version="$(DotNet8Version)" />
+		<PackageReference Include="Microsoft.AspNetCore.Components.WebAssembly" Version="$(DotNet8Version)" />
+		<PackageReference Include="Microsoft.AspNetCore.Components.WebAssembly.Authentication" Version="$(DotNet8Version)" />
+		<PackageReference Include="Serilog.Extensions.Logging" Version="7.0.0" />
+	</ItemGroup>
 	
 </Project>
diff --git a/tests/bunit.web.tests/bunit.web.tests.csproj b/tests/bunit.web.tests/bunit.web.tests.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk.Razor">
 
 	<PropertyGroup>
-		<TargetFrameworks>netcoreapp3.1;net5.0;net6.0;net7.0</TargetFrameworks>
+		<TargetFrameworks>netcoreapp3.1;net5.0;net6.0;net7.0;net8.0</TargetFrameworks>
 		<RootNamespace>Bunit</RootNamespace>
 		<AssemblyName>Bunit.Web.Tests</AssemblyName>
 	</PropertyGroup>

-Original file line number
+Diff line change
 .0.x
 .0.x
 .0.x
 +            8.0.x
       - name: 🎨 Setup color
         run: |
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"sdk": {`
`3`	`3`	`"rollForward": "latestMajor",`
`4`		`- "allowPrerelease": false`
	`4`	`+ "allowPrerelease": true`
`5`	`5`	`}`
`6`	`6`	`}`