aweXpect.Core

aweXpect

Assert unit tests in natural language using awesome expectations.

Getting started

1. Install the aweXpect nuget package

   dotnet add package aweXpect
   

2. Add the following using statement:

   using aweXpect;
   

   This brings the static Expect class and lots of extension methods into scope.

3. See the documentation or the migration guide for more information.

Features

Async everything

By using async assertions per default, we have a consistent API and other perks:

• Complete async support, e.g. IAsyncEnumerable HttpResponseMessage or similar async types
• No need to distinguish between action.Throws() and await asyncAction.ThrowsAsync()
• The evaluation is only triggered after the complete fluent chain is loaded, which has some nice benefits:
  • Because can be registered once as a general method that can be applied at the end of the expectation instead of cluttering all methods with the because and becauseArgs parameters
  • WithCancellation can also be registered at the end an applies a CancellationToken to all async methods which allows cancellation of IAsyncEnumerable evaluations
  • Expectations can be combined directly (via Expect.ThatAll) instead of relying on global state ( e.g. assertion scopes)

Performant

A focus on performance allows you to execute your tests as fast as possible.
Special care is taken for the happy case (succeeding tests) to be as performant as possible. See the benchmarks for more details.

Extensible

We added lots of extensibility points to allow you to build custom extensions.
The aweXpect.Core package is intended to be a stable source for extensions, so that the risk of version conflicts between different extensions can be reduced.

You can extend the functionality for any types, by adding extension methods on IThat<TType>. More information can be found in the extensibility guide.

Extension projects

• aweXpect.Json
  
  Expectations for the System.Text.Json namespace.

• aweXpect.Web
  
  Expectations for HttpClient.

• aweXpect.Reflection
  
  Expectations for reflection types.

• aweXpect.Testably
  
  Expectations for the file and time system from Testably.Abstractions.