aweXpect.Core 0.10.0

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 for usage scenarios.

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.Should().Throw() and await asyncAction.Should().ThrowAsync()
• 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)

Extensible

We added lots of extensibility points to allow you to build custom extensions.
Similar to fluentassertions extensibility is achieved via extension methods on .Should():

• for new types
  write a new .Should() extension method on IExpectSubject<TType>
• for existing types
  writing an extension method on IThat<TType>

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.