LanguageExt.UnitTesting 3.0.22

There is a newer version of this package available.
See the version list below for details.
Install-Package LanguageExt.UnitTesting -Version 3.0.22
dotnet add package LanguageExt.UnitTesting --version 3.0.22
<PackageReference Include="LanguageExt.UnitTesting" Version="3.0.22" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add LanguageExt.UnitTesting --version 3.0.22
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: LanguageExt.UnitTesting, 3.0.22"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install LanguageExt.UnitTesting as a Cake Addin
#addin nuget:?package=LanguageExt.UnitTesting&version=3.0.22

// Install LanguageExt.UnitTesting as a Cake Tool
#tool nuget:?package=LanguageExt.UnitTesting&version=3.0.22
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

LanguageExt.UnitTesting

Extension methods to simplify writing unit tests for code written using LanguageExt library. These extension methods throw an exception if expectation fails.

Avalable as LanguageExt.UnitTesting nuget package.

Option

  • ShouldBeSome<T>(Action<T> someValidation)
  • ShouldBeNone<T>()
Option<int> subject = UnitUnderTest();

// the following line throws an exception if subject is Option<int>.None 
// or the integer value wrapped by Some does not equal 5
subject.ShouldBeSome(some => Assert.Equal(5, some));

// the following line throws an exception if subject is not Option<int>.None
subject.ShouldBeNone();

Validation

  • ShouldBeSuccess<TFail, TSuccess>(Action<TSuccess> successValidation)
  • ShouldBeFail<TFail, TSuccess>(Action<IEnumerable<TFail>> failValidation)
Validation<string, int> subject = UnitUnderTest();

// the following line throws an exception if subject represents failure
// or in case of successful validation the integer value does not equal 5
subject.ShouldBeSuccess(success => Assert.Equal(5, success));

// the following line throws an exception if subject does not represent failed validation
// or in case of failed validation the failure value does not meet expectation
subject.ShouldBeFail(errors => Assert("value is not valid", errors.First()));

Either

  • ShouldBeRight<TLeft, TRight>(Action<TRight> rightValidation)
  • ShouldBeLeft<TLeft, TRight>(Action<TLeft> leftValidation)
Either<string, int> subject = UnitUnderTest();

// the following line throws an exception if subject represents left side of Either
// or in case of right side of Either when the integer value does not equal 5
subject.ShouldBeRight(right => Assert.Equal(5, right));

// the following line throws an exception if subject represents right side of Either
// or in case of left side of Either when the string value does not equal "abcd"
subject.ShouldBeLeft(left => Assert.Equal("abcd", left));

EitherAsync

  • ShouldBeRight<TLeft, TRight>(Action<TRight> rightValidation)
  • ShouldBeLeft<TLeft, TRight>(Action<TLeft> leftValidation)
EitherAsync<string, int> subject = UnitUnderTest();

// the following line throws an exception if subject represents left side of Either
// or in case of right side of Either when the integer value does not equal 5
await subject.ShouldBeRight(right => Assert.Equal(5, right));

// the following line throws an exception if subject represents right side of Either
// or in case of left side of Either when the string value does not equal "abcd"
await subject.ShouldBeLeft(left => Assert.Equal("abcd", left));

Try

  • ShouldBeSuccess<T>(Action<T> successValidation)
  • ShouldBeFail<T>(Action<Exception> failValidation)
Try<int> subject = UnitUnderTest();

// the following line throws an exception if subject represents failure
// or in case of successful try the integer value does not equal 5
subject.ShouldBeSuccess(success => Assert.Equal(5, success));

// the following line throws an exception if subject does not represent failure
// or in case of failure the exception has wrong message
subject.ShouldBeFail(ex => Assert.Equal("something went wrong", ex.Message));

TryAsync

  • ShouldBeSuccess<T>(Action<T> successValidation)
  • ShouldBeFail<T>(Action<Exception> failValidation)
TryAsync<int> subject = UnitUnderTest();

// the following line throws an exception if subject represents failure
// or in case of successful try the integer value does not equal 5
await subject.ShouldBeSuccess(success => Assert.Equal(5, success));

// the following line throws an exception if subject does not represent failure
// or in case of failure the  exception has wrong message
await subject.ShouldBeFail(ex => Assert.Equal("something went wrong", ex.Message));

TryOption

  • ShouldBeSome<T>(Action<T> someValidation)
  • ShouldBeNone<T>()
  • ShouldBeFail<T>(Action<Exception> failValidation)
TryOption<int> subject = UnitUnderTest();

// the following line throws an exception if subject represents failure or Option<T>.None
// or the integer value wrapped by Some does not equal 5
subject.ShouldBeSome(some => Assert.Equal(5, some));

// the following line throws an exception if subject is not Option<int>.None
subject.ShouldBeNone();

// the following line throws an exception if subject does not represent failure
// or in case of failure the exception has wrong message
subject.ShouldBeFail(ex => Assert.Equal("something went wrong", ex.Message));

TryOptionAsync

  • ShouldBeSome<T>(Action<T> someValidation)
  • ShouldBeNone<T>()
  • ShouldBeFail<T>(Action<Exception> failValidation)
TryOptionAsync<int> subject = UnitUnderTest();

// the following line throws an exception if subject represents failure or Option<T>.None
// or the integer value wrapped by Some does not equal 5
await subject.ShouldBeSome(some => Assert.Equal(5, some));

// the following line throws an exception if subject is not Option<int>.None
await subject.ShouldBeNone();

// the following line throws an exception if subject does not represent failure
// or in case of failure the exception has wrong message
await subject.ShouldBeFail(ex => Assert.Equal("something went wrong", ex.Message));

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
3.3.5 20,498 8/9/2019
3.1.14 29,351 12/15/2018
3.1.0 759 8/31/2018
3.0.22 1,628 8/20/2018
3.0.19 4,636 7/23/2018
2.1.0 467 7/22/2018
2.0.0 740 3/25/2018
1.0.0 722 3/24/2018

Adding TryOption extenstion methods. Made error messages more consistent.