How do I test an async method with NUnit (or possibly with another framework)?

by

As of today (7/2/2014) async testing is supported by:

In the first two frameworks, the test method must have this signature:

[TestMethod]
public async Task MyTestMethod()
{
   ...
   var result = await objectUnderTest.TestedAsyncMethod(...);
   // Make assertions
}

NUnit v2.6.2+ (but before 3.0), apart from that signature, supports this one:

public async void MyTestMethod()

Of course, inside any of these test methods you can use await to call and wait on asynchronous methods.

If you’re using a testing framework that doesn’t support async test methods, then, the only way to do it, is to call the async method and wait until it finishes running using any of the usual ways: await, reading the Result property of the Task<T> returned by an async method, using any of the usual wait methods of Task and so on. After the awaiting, you can do all the asserts as usual. For example, using MSTest:

[TestMethod]
public void MyTestMethod()
{
    ...
    Task<MyResultClass> task = objectUnderTest.MyAsyncMethod(...);
    // Make anything that waits for the method to end
    MyResultClass result = task.Result;

    // Make the assertions
    Assert.IsNotNull(result);
    ...
}

More Related Contents:

  1. .NET NUnit test – Assembly.GetEntryAssembly() is null
  2. How and when to use ‘async’ and ‘await’
  3. How do you unit test private methods?
  4. Should I avoid ‘async void’ event handlers?
  5. Running multiple async tasks and waiting for them all to complete
  6. Fake DbContext of Entity Framework 4.1 to Test
  7. How do yield and await implement flow of control in .NET?
  8. Fire and forget async method in asp.net mvc
  9. Task sequencing and re-entracy
  10. Enforce an async method to be called once
  11. ConfigureAwait(false) relevant in ASP.NET Core?
  12. NetworkStream.ReadAsync with a cancellation token never cancels
  13. Why use Async/await all the way down
  14. The repository itself is not usually tested?
  15. Different forms of the WCF service contract interface
  16. How does async works in C#?
  17. C# – Asserting two objects are equal in unit tests
  18. How to cancel a long-running Database operation?
  19. Should I worry about “This async method lacks ‘await’ operators and will run synchronously” warning
  20. Use Task.Run() in synchronous method to avoid deadlock waiting on async method?
  21. A pattern for self-cancelling and restarting task
  22. Async always WaitingForActivation
  23. What is the correct way to cancel an async operation that doesn’t accept a CancellationToken?
  24. Async thread body loop, It just works, but how?
  25. Horrible performance using SqlCommand Async methods with large data
  26. Unit test for thread safe-ness?
  27. Where is the “Create Unit Tests” selection?
  28. AspNetSynchronizationContext
  29. Await and SynchronizationContext in a managed component hosted by an unmanaged app
  30. Timeout pattern on task-based asynchronous method in C#

Leave a Comment