Testably.Expectations 0.5.0

Prefix Reserved
dotnet add package Testably.Expectations --version 0.5.0                
NuGet\Install-Package Testably.Expectations -Version 0.5.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Testably.Expectations" Version="0.5.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Testably.Expectations --version 0.5.0                
#r "nuget: Testably.Expectations, 0.5.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Testably.Expectations as a Cake Addin
#addin nuget:?package=Testably.Expectations&version=0.5.0

// Install Testably.Expectations as a Cake Tool
#tool nuget:?package=Testably.Expectations&version=0.5.0                

Testably.Expectations
Nuget Changelog Build Mutation testing badge

This library is used to assert unit tests in natural language by specifying expectations. It tries to take the best from fluentassertions and TUnit and combine them to a new assertions library.

Architecture

Async everything

All expectations are completely async. This allows complete support of IAsyncEnumerable as well es HttpResponseMessage or similar async types. No need to distinguish between action.Should().Throw() and await asyncAction.Should().ThrowAsync()!

Delayed evaluation

By using await, 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)

Extensibility

Fluentassertions have a proven way of extensibility via extension methods on .Should(). A similar approach is used here:

  • Extensions can be written for new types (by writing a .Should() extension methods for IExpectSubjectThat<TType>)...
  • and also for existing types (by writing an extension method on IThat<TType>)

Usage

By adding global using static Testably.Expectations.Expect; anywhere in the test project, that await can be part of the sentence of the expectation.

[Fact]
public async Task SomeMethod_ShouldThrowArgumentNullException()
{
  await That(SomeMethod).Should().Throw<ArgumentNullException>()
    .WithMessage("Value cannot be null")
	  .Because("we tested the null edge case");
}

Benchmarks

Some simple benchmarks are available here.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • .NETStandard 2.0

    • No dependencies.
  • net6.0

    • No dependencies.
  • net8.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.5.0 89 11/17/2024
0.4.0 97 11/10/2024
0.3.0 87 11/8/2024
0.2.0 86 11/4/2024
0.1.0 92 11/2/2024