BlazorTestingLibrary 1.1.0

.NET 6.0
dotnet add package BlazorTestingLibrary --version 1.1.0
NuGet\Install-Package BlazorTestingLibrary -Version 1.1.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="BlazorTestingLibrary" Version="1.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add BlazorTestingLibrary --version 1.1.0
#r "nuget: BlazorTestingLibrary, 1.1.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install BlazorTestingLibrary as a Cake Addin
#addin nuget:?package=BlazorTestingLibrary&version=1.1.0

// Install BlazorTestingLibrary as a Cake Tool
#tool nuget:?package=BlazorTestingLibrary&version=1.1.0

BlazorTestingLibrary

A (better?) React-like testing approach for Blazor apps. This is still a work in progress but it's useable 😃

Quickstart Example

using BlazorTestingLibrary;
using Bunit;
using FluentAssertions;
using Xunit;

...

[Fact]
public void SubmittingAValidForm()
{
    using var context = new TestContext();
    var component = context.RenderComponent<ExampleForm>();

    var forenameInput = component.FindByLabelText("Forename:");
    forenameInput.Change("John");

    var surnameInput = component.FindByLabelText("Surname:");
    surnameInput.Change("Smith");

    var emailInput = component.FindByLabelText("Email Address:");
    emailInput.Change("john.smith@developer.com");

    var submitButton = component.FindByText("Submit");
    submitButton.Click();

    component.FindByText("Your form is Submitted").Should().NotBeNull();
}

Search Methods

FindByText

Searches for a given text string in the DOM and returns the first element that contains it. Throws if there is more than one element found or nothing is found.

FindByPartialText

Searches for a given partial text string in the DOM and returns the first element that contains it. Throws if there is more than one element found or nothing is found.

FindAllByText

Searches for a given text string in the DOM and returns all instances of elements that contain it. Throws if nothing is found.

FindById

Searches for an element with a given id. Throws if there is more than one element found or nothing is found.

FindByLabelText

Searches for an input with a particular label attached to it via for attribute. Throws if there is more than one element found or nothing is found.

Verify Methods

ShouldHaveClass

Asserts that a given element has a class.

ShouldHaveId

Asserts that a given element has an id.

VerifyTextExists

Asserts that a given text exists in the DOM.

VerifyPartialTextExists

Asserts that a given partial text exists in the DOM.

VerifyElementWithIdExists

Asserts that an element with a given ID exists in the DOM.

VerifyTextDoesNotExist

Asserts that a given text does not exist in the DOM.

VerifyPartialTextDoesNotExist

Asserts that a given partial text does not exist in the DOM.

VerifyElementWithIdDoesNotExist

Asserts that an element with a given ID does not exist in the DOM.

Waiting for a condition (WaitFor)

Sometimes you may need to wait for something to happen, which you can do with WaitFor(Action action, int timeout = 5000). This will perform an action until it doesn't throw or the timeout is met. A ActionTimedOutException will be thrown if the timeout is reached.

Libraries Used

  • FluentAssertions
  • BUnit
  • RichardSzalay.MockHttp

Footnotes

This library currently only targets net6.0.

Product Versions
.NET net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.1.0 191 9/29/2022
1.0.2 185 9/29/2022
1.0.1 182 9/29/2022
1.0.0 187 9/28/2022