How to Unit Test SignalR

dotnet / AspNetCore.Docs

Documentation for ASP.NET Core

https://docs.microsoft.com/aspnet/core

Creative Commons Attribution 4.0 International

12.63k stars 25.3k forks source link

How to Unit Test SignalR #11052

Open BlueDragon709 opened 5 years ago

BlueDragon709 commented 5 years ago

Doc request for unit testing signalr in a ASP.NetCore 2.2 app I am currently working on a signalr application and I want to be able to test my hubs. I couldn't find any information about unit testing signalr in AspNetCore/SignalR. The only information that i could find was from 2013 for AspNet/SignalR and is pretty outdated.

I am sugesting to put the topic about unit testing signalr on this location:

Docs/ASP.NET/ASP.NET Core/ASP.NET Core 2.2/Real-time apps/Unit testing or Docs/ASP.NET/ASP.NET Core/ASP.NET Core 2.2/Test, debug and roubleshoot/Unit testing/signalr hubs

This topic will cover the following topics: Testing of hubs, testing of groups and examples.

A rough outline:

Prerequisites
Testing hubs -- Using MSTest -- Using NUnit -- Using xUnit
Testing groups -- Using MSTest -- Using NUnit -- Using xUnit
Examples

I hope this gets added because there is not a lot of information on this topic.

NightAngell commented 5 years ago

I wrote lib (available via nuget) which provide support for unit testing in signalR core (both Hub (Hub<T>) and IHubContext<T> (IHubContext<T, P>) ). I wrote docs for it too then if you want you can easily use it. In short summary it provide preconfigured mocks which are auto set upped by testing framework (NUnit, xUnit, MsTest, but there is also info how to use it with custom testing framework in docs) and some helpful 'verify' methods. For testing hubs you need just add nuget to your project and inherit from provided by lib base class (there is also possibility to use it without base class, info in docs). I don't want duplicate docs, then if you are interested:

There are examples in docs too.