Xunit RazorTest runner (#103)

Custom xUnit discoverer and test runner for razor based tests.

Author: egil

.github/workflows/CI.yml

@@ -21,7 +21,7 @@ jobs:
           echo "::set-env name=BRANCH::$(echo ${GITHUB_REF#refs/heads/} | sed 's/\//_/g')"
           echo "::set-env name=COMMIT::$GITHUB_SHA"
       - run: echo Version $VERSION - Branch $BRANCH - Commit $COMMIT
-      - uses: actions/checkout@v1   
+      - uses: actions/checkout@v2   
       - name: Update tokens in project files
         uses: cschleiden/replace-tokens@v1
         with:
@@ -31,15 +31,20 @@ jobs:
           dotnet-version: '3.1.201' 
       - name: Building and verifying library
         run: |
-          dotnet build src -c Release
-          dotnet test src -c Release /nowarn:CS1591          
+          dotnet restore 
+          dotnet build src -c Release --no-restore
+          dotnet test src -c Release --no-restore --verbosity normal /nowarn:CS1591          
       - name: Creating library package
-        run: dotnet pack src/ -c Release -o ${GITHUB_WORKSPACE}/lib -p:version=$VERSION /nowarn:CS1591
-      - name: Buidling template package
-        run: dotnet pack templates/bunit-project/ -c Release -o ${GITHUB_WORKSPACE}/templates -p:version=$VERSION -p:PackageVersion=$VERSION
-      - name: Verifying template
         run: |
-          dotnet new --install ${GITHUB_WORKSPACE}/templates/bunit.template.$VERSION.nupkg
-          dotnet new bunit -o ${GITHUB_WORKSPACE}/Test
-          dotnet restore ${GITHUB_WORKSPACE}/Test/Test.csproj --source ${GITHUB_WORKSPACE}/lib
-          dotnet test ${GITHUB_WORKSPACE}/Test
+          dotnet pack src/bunit.core/ -c Release -o ${GITHUB_WORKSPACE}/lib -p:version=$VERSION /nowarn:CS1591
+          dotnet pack src/bunit.web/ -c Release -o ${GITHUB_WORKSPACE}/lib -p:version=$VERSION /nowarn:CS1591
+          dotnet pack src/bunit.xunit/ -c Release -o ${GITHUB_WORKSPACE}/lib -p:version=$VERSION /nowarn:CS1591
+          dotnet pack src/bunit/ -c Release -o ${GITHUB_WORKSPACE}/lib -p:version=$VERSION /nowarn:CS1591          
+#      - name: Buidling template package
+#        run: dotnet pack templates/bunit-project/ -c Release -o ${GITHUB_WORKSPACE}/templates -p:version=$VERSION -p:PackageVersion=$VERSION
+#      - name: Verifying template
+#        run: |
+#          dotnet new --install ${GITHUB_WORKSPACE}/templates/bunit.template.$VERSION.nupkg
+#          dotnet new bunit -o ${GITHUB_WORKSPACE}/Test
+#          dotnet restore ${GITHUB_WORKSPACE}/Test/Test.csproj --source ${GITHUB_WORKSPACE}/lib
+#          dotnet test ${GITHUB_WORKSPACE}/Test

.github/workflows/nuget-pack-push.yml

@@ -35,7 +35,11 @@ jobs:
           dotnet build src -c Release /nowarn:CS1591
           dotnet test src -c Release /nowarn:CS1591
       - name: Creating library package
-        run: dotnet pack src/ -c Release -o ${GITHUB_WORKSPACE}/lib -p:version=$VERSION /nowarn:CS1591
+        run: |
+          dotnet pack src/bunit.core/ -c Release -o ${GITHUB_WORKSPACE}/lib -p:version=$VERSION /nowarn:CS1591
+          dotnet pack src/bunit.web/ -c Release -o ${GITHUB_WORKSPACE}/lib -p:version=$VERSION /nowarn:CS1591
+          dotnet pack src/bunit.xunit/ -c Release -o ${GITHUB_WORKSPACE}/lib -p:version=$VERSION /nowarn:CS1591
+          dotnet pack src/bunit/ -c Release -o ${GITHUB_WORKSPACE}/lib -p:version=$VERSION /nowarn:CS1591
       - name: Buidling template package
         run: dotnet pack template/ -c Release -o ${GITHUB_WORKSPACE}/template -p:version=$VERSION -p:PackageVersion=$VERSION
       - name: Verifying template

src/Directory.Build.props

@@ -3,10 +3,11 @@
     <LangVersion>8.0</LangVersion>
     <Nullable>enable</Nullable>
     <WarningsAsErrors>CS8600;CS8602;CS8603;CS8625</WarningsAsErrors>
+		<Deterministic>true</Deterministic>
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Update="Microsoft.CodeAnalysis.FxCopAnalyzers" Version="3.0.0-beta3.final">
+    <PackageReference Update="Microsoft.CodeAnalysis.FxCopAnalyzers" Version="3.0.0">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>

src/bunit.core.tests/ComponentParameterBuilderTests.cs

@@ -1,7 +1,7 @@
 using System;
 using System.Threading.Tasks;
 using Bunit.Rendering;
-using Bunit.SampleComponents;
+using Bunit.TestAssets.SampleComponents;
 using Microsoft.AspNetCore.Components;
 using Shouldly;
 using Xunit;

src/bunit.core.tests/TestRendererTest.cs

@@ -3,7 +3,7 @@
 using System.Threading.Tasks;
 using Bunit.Rendering;
 using Bunit.Rendering.RenderEvents;
-using Bunit.SampleComponents;
+using Bunit.TestAssets.SampleComponents;
 using Microsoft.AspNetCore.Components;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging.Abstractions;

src/bunit.core.tests/bunit.core.tests.csproj

@@ -8,11 +8,13 @@
 	</PropertyGroup>
 
 	<ItemGroup>
+		<PackageReference Include="Microsoft.AspNetCore.Components" Version="3.1.*" />
+		<PackageReference Include="Microsoft.AspNetCore.Components.Web" Version="3.1.*" />
 		<PackageReference Include="AngleSharp" Version="0.14.0" />
 		<PackageReference Include="AngleSharp.Css" Version="0.14.0" />
 		<PackageReference Include="AngleSharp.Diffing" Version="0.14.0" />
-		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.5.0" />
-		<PackageReference Include="Moq" Version="4.13.1" />
+		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.6.0" />
+		<PackageReference Include="Moq" Version="4.14.1" />
 		<PackageReference Include="Shouldly" Version="4.0.0-beta0002" />
 		<PackageReference Include="xunit" Version="2.4.1" />
 		<PackageReference Include="xunit.runner.visualstudio" Version="2.4.1">
@@ -26,7 +28,8 @@
 	</ItemGroup>
 
 	<ItemGroup>
-		<ProjectReference Include="..\bunit.core\bunit.core.csproj" />		
+		<ProjectReference Include="..\bunit.core\bunit.core.csproj" />
+		<ProjectReference Include="..\bunit.testassets\bunit.testassets.csproj" />
 	</ItemGroup>
 
 </Project>

src/bunit.core/RazorTesting/ComponentUnderTest.cs

@@ -5,7 +5,7 @@
 namespace Bunit
 {
 	/// <summary>
-	/// Represents a component that can be added inside a <see cref="RazorTest"/>,
+	/// Represents a component that can be added inside a <see cref="RazorTestBase"/>,
 	/// where a component under test can be defined as the child content.
 	/// </summary>
 	public class ComponentUnderTest : FragmentBase

src/bunit.core/RazorTesting/FixtureBase.cs

@@ -1,8 +1,10 @@
 using System;
 using System.Collections.Generic;
 using System.Threading.Tasks;
+
 using Bunit.RazorTesting;
 using Bunit.Rendering;
+
 using Microsoft.AspNetCore.Components;
 using Microsoft.Extensions.DependencyInjection;
 
@@ -13,7 +15,7 @@ namespace Bunit
 	/// define the <see cref="ComponentUnderTest"/> and any <see cref="Fragment"/>'s
 	/// you might need during testing, and assert against them in the Test methods.
 	/// </summary>
-	public abstract class FixtureBase<TFixture> : RazorTest
+	public abstract class FixtureBase<TFixture> : RazorTestBase
 	{
 		/// <summary>
 		/// Gets or sets the child content of the fragment.
@@ -73,24 +75,31 @@ public abstract class FixtureBase<TFixture> : RazorTest
 		/// <inheritdoc/>
 		public override Task SetParametersAsync(ParameterView parameters)
 		{
-			if (parameters.TryGetValue<RenderFragment>(nameof(ChildContent), out RenderFragment childContent))
-				ChildContent = childContent;
-			else
-				throw new InvalidOperationException($"No {nameof(ChildContent)} specified in the {GetType().Name} component.");
-
+			ChildContent = parameters.GetValueOrDefault<RenderFragment>(nameof(ChildContent));
 			Setup = parameters.GetValueOrDefault<Action<TFixture>>(nameof(Setup));
 			SetupAsync = parameters.GetValueOrDefault<Func<TFixture, Task>>(nameof(SetupAsync));
 			Test = parameters.GetValueOrDefault<Action<TFixture>>(nameof(Test));
 			TestAsync = parameters.GetValueOrDefault<Func<TFixture, Task>>(nameof(TestAsync));
-			Tests = parameters.GetValueOrDefault<IReadOnlyCollection<Action<TFixture>>>(nameof(Tests));
-			TestsAsync = parameters.GetValueOrDefault<IReadOnlyCollection<Func<TFixture, Task>>>(nameof(TestsAsync));
+			Tests = parameters.GetValueOrDefault<IReadOnlyCollection<Action<TFixture>>>(nameof(Tests), Array.Empty<Action<TFixture>>());
+			TestsAsync = parameters.GetValueOrDefault<IReadOnlyCollection<Func<TFixture, Task>>>(nameof(TestsAsync), Array.Empty<Func<TFixture, Task>>());
 
 			return base.SetParametersAsync(parameters);
 		}
 
+		/// <inheritdoc/>
+		public override void Validate()
+		{
+			base.Validate();
+			if (ChildContent is null)
+				throw new ArgumentException($"No {nameof(ChildContent)} specified in the {GetType().Name} component.");
+			if (Test is null && TestAsync is null && Tests?.Count == 0 && TestsAsync?.Count == 0)
+				throw new ArgumentException($"No test/assertions provided to the {GetType().Name} component.");
+		}
+
 		/// <inheritdoc/>
 		protected virtual async Task Run(TFixture self)
 		{
+			Validate();
 			if (Setup is { })
 				TryRun(Setup, self);
 

src/bunit.core/RazorTesting/RazorTest.cs …bunit.core/RazorTesting/RazorTestBase.cssrc/bunit.core/RazorTesting/RazorTest.cs renamed to src/bunit.core/RazorTesting/RazorTestBase.cs src/bunit.core/RazorTesting/RazorTest.cs renamed to src/bunit.core/RazorTesting/RazorTestBase.cs

@@ -1,13 +1,14 @@
 using System;
 using System.Threading.Tasks;
+
 using Microsoft.AspNetCore.Components;
 
 namespace Bunit.RazorTesting
 {
 	/// <summary>
 	/// Represents a component used to define tests in Razor files.
 	/// </summary>
-	public abstract class RazorTest : TestContextBase, ITestContext, IComponent
+	public abstract class RazorTestBase : TestContextBase, ITestContext, IComponent
 	{
 		/// <summary>
 		/// Gets whether the tests is running or not.
@@ -30,14 +31,14 @@ public abstract class RazorTest : TestContextBase, ITestContext, IComponent
 		[Parameter] public int Timeout { get; set; } = 0;
 
 		/// <summary>
-		/// Run the test logic of the <see cref="RazorTest"/>.
+		/// Run the test logic of the <see cref="RazorTestBase"/>.
 		/// </summary>
 		/// <exception cref="InvalidOperationException">Thrown when called and <see cref="IsRunning"/> is true.</exception>
 		/// <returns></returns>
 		public async Task RunTest()
 		{
 			if (IsRunning)
-				throw new InvalidOperationException("The fixture test is already running.");
+				throw new InvalidOperationException("The razor test is already running.");
 
 			IsRunning = true;
 
@@ -51,17 +52,21 @@ public async Task RunTest()
 			}
 		}
 
-		/// <inheritdoc/>
-		public override string ToString() => $"{Description ?? "[no description]"}";
-
 		/// <inheritdoc/>
 		public virtual Task SetParametersAsync(ParameterView parameters)
 		{
 			Skip = parameters.GetValueOrDefault<string>(nameof(Skip));
 			Description = parameters.GetValueOrDefault<string>(nameof(Description));
+			Timeout = parameters.GetValueOrDefault<int>(nameof(Timeout));
 			return Task.CompletedTask;
 		}
 
+		/// <summary>
+		/// Validates the test and throws an exception if the test does not have received all
+		/// input it needs to run.
+		/// </summary>
+		public virtual void Validate() { }
+
 		/// <inheritdoc/>
 		void IComponent.Attach(RenderHandle renderHandle) { }
 

src/bunit.core/RazorTesting/RazorTestFailedException.cs

@@ -4,7 +4,7 @@
 namespace Bunit.RazorTesting
 {
 	/// <summary>
-	/// Exception thrown when an <see cref="RazorTest"/> in a Razor based test fails.
+	/// Exception thrown when an <see cref="RazorTestBase"/> in a Razor based test fails.
 	/// </summary>
 	[SuppressMessage("Design", "CA1032:Implement standard exception constructors", Justification = "Do not need them")]
 	public class RazorTestFailedException : Exception