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 outcome using semantic HTML comparer
• Interact with and inspect components as well as triggering event handlers
• Pass parameters, cascading values and inject services into components under test
• Mock IJsRuntime and Blazors authentication and authorization
• Perform snapshot testing

bUnit builds on top of existing unit testing frameworks such as xUnit, NUnit, and MSTest, which runs the Blazor components tests just as any normal unit test.

Go to bUnit.egilhansen.com to learn more.

NuGet Downloads

bUnit is available on NuGet in various incarnations. If you are using xUnit as your general purpose testing framework, you can use bunit, which includes everything in one package. If you want to use NUnit or MStest, then pick bunit.core and bunit.web:

Name	Description	NuGet Download Link
bUnit.web	Adds support for testing Blazor components for the web. This includes bUnit.core.
bUnit.xUnit	Adds additional support for using bUnit with xUnit, including support for Razor-based tests.
bUnit.core	Core library that enables rendering a Blazor component in a test context.
bUnit.template	Template, which currently creates an xUnit based bUnit test projects only

To get started, head to the getting started documentation to learn more.

Sponsors

A huge thank you to the sponsors of my work with bUnit. The higher tier sponsors are:

Progress-Telerik

Hassan Rezk Habib (@hassanhabib)

Milestones to v1.0.0

These are the current goals that should be reached before v1.0.0 is ready:

• Stabilize the APIs, such that they work equally well with both xUnit, NUnit, and MSTest as the underlying test framework. The general goals are to make it easy for developers to create the tests they need, and to fall into the pit of success.
• Get the Razor-based testing to be stable, e.g. make the discovery and running of tests defined in .razor files stable and efficient. This includes adding support for NUnit and MSTest as test runners.
• Improve the documentation. It’s a good idea to get an experienced technical editor to review the documentation, making sure it is clear and understandable. In addition to this, more ‘How to’ guides are planned in the Update Docs milestone.
• Join the .NET Foundation.. This project is too large for one person to be the owner and the sole maintainer, so the plan is to apply for membership as soon as possible - most likely close to or after v1.0.0 ships - and to get the required support and guidance to ensure the project long term.

In the post-v1.0.0 to v1.0.x time frame, focus will be on improving performance. In particular, it would be nice to reduce the spin-up time of about one second.

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!