mrakestraw-bbins
commented
3 years ago Forgot to include project files: BBINS-bUnit.zip
Closed mrakestraw-bbins closed 3 years ago
mrakestraw-bbins
commented
3 years ago Forgot to include project files: BBINS-bUnit.zip
egil
commented
3 years ago First of, excellent bug report writing, thanks for adding all the details @mrakestraw-bbins 🥇🥇
I just did a read through the InputFile component, and it has some JSInterop magic going on, which might be causing the problems... I wonder if this is related to preview-01 adding support for IJSUnmarshalledRuntime.
This should be a fun one investigating.
And just to clarify, when awaiting something that just returns a completed task immediately, the usage of cut.WaitForAssertion is not needed, as the Blazor renderer will simply re-render right away without yielding back to the test thread.
mrakestraw-bbins
commented
3 years ago Thanks @egil. Nice library by the way. Wish I had more time to dig in and try to patch it myself.
egil
commented
3 years ago This is probably related to this error that sometimes happens when running the tests here in GitHub Actions:
[xUnit.net 00:00:06.21] Bunit.BlazorE2E.ComponentRenderingTest.CanDispatchAsyncWorkToSyncContext [FAIL]
Failed Bunit.BlazorE2E.ComponentRenderingTest.CanDispatchAsyncWorkToSyncContext [2 s]
Error Message:
Bunit.Extensions.WaitForHelpers.WaitForFailedException : The assertion did not pass within the timeout period.
---- Assert.Equal() Failure
↓ (pos 6)
Expected: First Second Third Fourth Fifth
Actual: First Third Second Fourth Fifth
↑ (pos 6)
Stack Trace:
at Bunit.RenderedFragmentWaitForHelperExtensions.WaitForAssertion(IRenderedFragmentBase renderedFragment, Action assertion, Nullable`1 timeout) in /home/runner/work/bUnit/bUnit/src/bunit.core/Extensions/WaitForHelpers/RenderedFragmentWaitForHelperExtensions.cs:line 53
at Bunit.BlazorE2E.ComponentRenderingTest.CanDispatchAsyncWorkToSyncContext() in /home/runner/work/bUnit/bUnit/tests/bunit.web.tests/BlazorE2E/ComponentRenderingTest.cs:line 561
----- Inner Stack Trace -----
at Bunit.BlazorE2E.ComponentRenderingTest.<>c__DisplayClass30_0.<CanDispatchAsyncWorkToSyncContext>b__0() in /home/runner/work/bUnit/bUnit/tests/bunit.web.tests/BlazorE2E/ComponentRenderingTest.cs:line 566
at Bunit.Extensions.WaitForHelpers.WaitForAssertionHelper.<>c__DisplayClass7_0.<.ctor>b__0() in /home/runner/work/bUnit/bUnit/src/bunit.core/Extensions/WaitForHelpers/WaitForAssertionHelper.cs:line 33
at Bunit.Extensions.WaitForHelpers.WaitForHelper.OnAfterRender(Object sender, EventArgs args) in /home/runner/work/bUnit/bUnit/src/bunit.core/Extensions/WaitForHelpers/WaitForHelper.cs:line 89
{"Key":"a","Code":null,"Location":0,"Repeat":false,"CtrlKey":false,"ShiftKey":false,"AltKey":false,"MetaKey":false,"Type":null}
{"Key":"b","Code":null,"Location":0,"Repeat":false,"CtrlKey":false,"ShiftKey":false,"AltKey":false,"MetaKey":false,"Type":null}I know this test used to work all the time, so I will have to investigate where a possible regression has been introduced. Gotta love those subtle race condition bugs 😒
egil
commented
3 years ago @mrakestraw-bbins, if I reduce the test case even more, we get a different exception/error, which I actually thing is the root cause, because the error indicate a missing IOptions<InputFile> is not added to the Services collection. It is a bug that the error does not show up in the test output though, but I think that is due to it happening async on the other thread. With the test case below, we force the exception to happen essentially while the test thread and the renderer thread are the same.
Our CUT:
@if (!show)
{
<div id="loading"/>
}
else
{
<InputFile Id="sampleInputFileIdbad" />
<div id="showing"/>
}
@code {
bool show = false;
protected override async Task OnInitializedAsync()
{
await Task.CompletedTask;
show = true;
}
}The test:
[Fact]
public async Task WeatherDisplayInitializeTest2()
{
var cut = RenderComponent<WeatherDisplay>();
Assert.Equal(1, cut.FindAll("#showing").Count);
}The output:
Test Name: Client.Test.WeatherDisplayTests.WeatherDisplayInitializeTest2
Test FullName: Client.Test.Client.Test.WeatherDisplayTests.Client.Test.WeatherDisplayTests.WeatherDisplayInitializeTest2
Test Source: C:\source\temp\BBINS-bUnit\Client.Test\WeatherDisplayTests.cs : line 42
Test Outcome: Failed
Test Duration: 0:00:00
Test Name: Client.Test.WeatherDisplayTests.WeatherDisplayInitializeTest2
Test Outcome: Failed
Result StackTrace:
at Microsoft.AspNetCore.Components.ComponentFactory.<>c__DisplayClass6_0.<CreateInitializer>g__Initialize|2(IServiceProvider serviceProvider, IComponent component)
at Microsoft.AspNetCore.Components.ComponentFactory.PerformPropertyInjection(IServiceProvider serviceProvider, IComponent instance)
at Microsoft.AspNetCore.Components.ComponentFactory.InstantiateComponent(IServiceProvider serviceProvider, Type componentType)
at Microsoft.AspNetCore.Components.RenderTree.Renderer.InstantiateComponent(Type componentType)
at Microsoft.AspNetCore.Components.RenderTree.Renderer.InstantiateChildComponentOnFrame(RenderTreeFrame& frame, Int32 parentComponentId)
at Microsoft.AspNetCore.Components.RenderTree.RenderTreeDiffBuilder.InitializeNewComponentFrame(DiffContext& diffContext, Int32 frameIndex)
at Microsoft.AspNetCore.Components.RenderTree.RenderTreeDiffBuilder.InitializeNewSubtree(DiffContext& diffContext, Int32 frameIndex)
at Microsoft.AspNetCore.Components.RenderTree.RenderTreeDiffBuilder.InsertNewFrame(DiffContext& diffContext, Int32 newFrameIndex)
at Microsoft.AspNetCore.Components.RenderTree.RenderTreeDiffBuilder.AppendDiffEntriesForRange(DiffContext& diffContext, Int32 oldStartIndex, Int32 oldEndIndexExcl, Int32 newStartIndex, Int32 newEndIndexExcl)
at Microsoft.AspNetCore.Components.RenderTree.RenderTreeDiffBuilder.ComputeDiff(Renderer renderer, RenderBatchBuilder batchBuilder, Int32 componentId, ArrayRange`1 oldTree, ArrayRange`1 newTree)
at Microsoft.AspNetCore.Components.Rendering.ComponentState.RenderIntoBatch(RenderBatchBuilder batchBuilder, RenderFragment renderFragment)
at Microsoft.AspNetCore.Components.RenderTree.Renderer.RenderInExistingBatch(RenderQueueEntry renderQueueEntry)
at Microsoft.AspNetCore.Components.RenderTree.Renderer.ProcessRenderQueue()
--- End of stack trace from previous location ---
at Bunit.Rendering.TestRenderer.AssertNoUnhandledExceptions() in /_/src/bunit.core/Rendering/TestRenderer.cs:line 280
at Bunit.Rendering.TestRenderer.Render[TResult](RenderFragment renderFragment, Func`2 activator) in /_/src/bunit.core/Rendering/TestRenderer.cs:line 164
at Bunit.Rendering.TestRenderer.RenderFragment(RenderFragment renderFragment) in /_/src/bunit.core/Rendering/TestRenderer.cs:line 38
at Bunit.Extensions.TestContextExtensions.RenderInsideRenderTree[TComponent](TestContextBase testContext, RenderFragment renderFragment) in /_/src/bunit.web/Extensions/TestContextExtensions.cs:line 20
at Bunit.TestContext.Render[TComponent](RenderFragment renderFragment) in /_/src/bunit.web/TestContext.cs:line 61
at Bunit.TestContext.RenderComponent[TComponent](ComponentParameter[] parameters) in /_/src/bunit.web/TestContext.cs:line 36
at Client.Test.WeatherDisplayTests.WeatherDisplayInitializeTest2() in C:\source\temp\BBINS-bUnit\Client.Test\WeatherDisplayTests.cs:line 44
--- End of stack trace from previous location ---
Result Message: System.InvalidOperationException : Cannot provide a value for property 'Options' on type 'Microsoft.AspNetCore.Components.Forms.InputFile'. There is no registered service of type 'Microsoft.Extensions.Options.IOptions`1[Microsoft.AspNetCore.Components.Forms.RemoteBrowserFileStreamOptions]'.OK, this turns out not to be a race condition or a bug, per say... but more a problem with bUnit not having built in support for the <InputFile> component.
Here is how to write the test, using a mocking framework of choice, to create a mock of the IOptions<RemoteBrowserFileStreamOptions> that InputFile requires.
using System;
using System.Collections.Generic;
using BBINS.Shared;
using Bunit;
using Bunit.JSInterop;
using Microsoft.AspNetCore.Components.Forms;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Options;
using NSubstitute;
using RichardSzalay.MockHttp;
using Xunit;
namespace Client.Test
{
public class WeatherDisplayTests : TestContext
{
public WeatherDisplayTests()
{
var mock = Services.AddMockHttpClient();
mock.When("/sample-data/weather.json").RespondJson(new List<WeatherDisplay.WeatherForecast> {
new()
{
Date = new DateTime(1990, 12, 31),
Summary = "Freezing",
TemperatureC = 1
},
new()
{
Date = new DateTime(2001, 12, 31),
Summary = "Freezing",
TemperatureC = 2
}
});
var optionsMock = Substitute.For<IOptions<RemoteBrowserFileStreamOptions>>();
Services.AddSingleton<IOptions<RemoteBrowserFileStreamOptions>>(optionsMock);
JSInterop.SetupVoid("Blazor._internal.InputFile.init", x => true);
}
[Fact]
public void WeatherDisplayInitializeTest()
{
var cut = RenderComponent<WeatherDisplay>();
// Is this a race condition?
Assert.Equal("Loading...", cut.Find("p#LoadingMessage").TextContent);
}
[Fact]
public void WeatherDisplayInitializeTest2()
{
var cut = RenderComponent<WeatherDisplay>();
cut.WaitForState(() => cut.Instance.Forecasts != null);
// Will not find the table if InputFile included in Razor
cut.WaitForAssertion(() => cut.Find("#forecasttable"));
}
[Fact]
public void WeatherDisplayInitializeTest3()
{
var cut = RenderComponent<WeatherDisplay>();
cut.WaitForAssertion(() => cut.Find("#forecasttable"));
}
}
}
Describe the bug
Per the razor component below, simply add an
InputFiletag to your markup and Bunit will not be able to re-render the component upon state change. Sometimes the state will be updated and sometimes not, but never is the markup updated so that you can find markup elements in theelsecondition of the page.Note that the
inputtag works fine.For reference: Microsoft.AspnetCore.Components.Forms.InputFile
Also, occasionally, I saw a Bunit recursive render stack overflow, but that seemed to be caused by the
await LoadForecasts();in the OnInitializedAsync method. If I see that happen again, I'll try to recreate and open a different bug report.Example: Testing this component: WeatherDisplay.razor
With this test:
Results in this output:
Expected behavior: If I comment out the
<InputFile />tag, I get:Version info: Test Project
Version Info: Blazor WASM project