bUnit - a testing library for Blazor components
bUnit is a testing library for Blazor Components. Its goal is to make it easy to write comprehensive, stable unit tests. With bUnit, you can:
- Setup and define components under tests using C# or Razor syntax
- Verify outcomes using semantic HTML comparer
- Interact with and inspect components as well as trigger event handlers
- Pass parameters, cascading values and inject services into components under test
- Mock
IJSRuntime, Blazor authentication and authorization, and others
bUnit builds on top of existing unit testing frameworks such as xUnit, NUnit, MSTest and TUnit, which run the Blazor component tests in just the same way as any normal unit test. bUnit runs a test in milliseconds, compared to browser-based UI tests which usually take seconds to run.
Go to bUnit.dev to learn more.
NuGet Downloads
bUnit is available on NuGet in various incarnations. Most should just pick the bUnit package:
| Name | Description | NuGet Download Link |
|---|
| bUnit | Adds support for testing Blazor components. | |
| bUnit.template | Template, which currently creates xUnit-based bUnit test projects only. | |
| bUnit.generators | Source code generators to minimize code setup in various situations. | |
| bUnit.web.query | bUnit implementation of testing-library.com's query APIs. | |
To get started, head to the getting started documentation to learn more.
bUnit and .NET version compatibility matrix
| bUnit version | .NET version |
|---|
| 1.x | ≥ .netcore3.1 && ≤ .net 9 |
| 2.x | ≥ .net8 |
For a migration guide, see Upgrading bUnit.
Sponsors
A huge thank you to the sponsors of bUnit. The higher tier sponsors are:
Contributors
Shout outs and a big thank you to all the contributors to the library, including those that raise issues, provide input to issues, and those who send pull requests. Thank you!
These good people have contributed code or documentation to bUnit:
Code of conduct
This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community.
For more information see the .NET Foundation Code of Conduct.
.NET Foundation
This project is supported by the .NET Foundation.
