Search code examples
c#unit-testingasync-awaitmstestc#-5.0

Why can't "async void" unit tests be recognized?


async void unit tests cannot be run within Visual Studio 2012:

[TestClass]
public class MyTestClass
{
    [TestMethod]
    public async void InvisibleMyTestMethod()
    {
        await Task.Delay(1000);
        Assert.IsTrue(true);
    }
}

If I want to have an asynchronous unit test, the test method has to return a Task:

[TestMethod]
public async Task VisibleMyTestMethod()
{
    await Task.Delay(1000);
    Assert.IsTrue(true);
}

Why is it so? Not that I absolutely need to have an async void test method, I am just curious. Visual Studio 2012 gives no warning nor error when you build an async void test method even though it won't be able to be run...


Solution

  • async void methods should be considered as "Fire and Forget" - there is no way to wait for them to finish. If Visual Studio were to start one of these tests, it wouldn't be able to wait for the test to complete (mark it as successful) or trap any exceptions raised.

    With an async Task, the caller is able to wait for execution to complete, and to trap any exceptions raised while it runs.

    See this answer for more discussion of async void vs async Task.