Functional.Primitives.FluentAssertions.md

Functional.Primitives.FluentAssertions

This library extends FluentAssertions to provide assertion clauses for types defined by the Functional.Primitives NuGet package: Option<T> and Result<TSuccess, TFailure>.

• Upgrading from v3.x to x4.x
• Upgrading from v2.x to x3.x

Option<T>

HaveValue

var option = Option.Some(1337);

// verify that the option contains a value
option.Should().HaveValue();

// verify that the option contains a value and that the contained value matches some condition(s)
option.Should().HaveValue().AndValue.Should().Be(1337);
option.Should().HaveValue().AndValue.Should().BeGreaterThanOrEqualTo(0);
option.Should().HaveValue().AndValue.Should().BeGreaterThanOrEqualTo(0).And.LessThanOrEqualTo(2000);

NotHaveValue

var option = Option.None<int>();

// verify that the option does not have a value
option.Should().NotHaveValue();

Be

var option = Option.Some(1337);
var otherOption = Option.Some(1337);

// verify that the option is equal to another option
option.Should().Be(otherOption);

Task<Option<T>>

HaveValue

var optionTask = Task.FromResult(Option.Some(1337));

// await the task and verify that the resulting option contains a value
await optionTask.Should().HaveValue();

// await the task and verify that the resulting option contains a value and that the contained value matches some condition(s)
await optionTask.Should().HaveValue().AndValue(v => v.Should().Be(1337));
await optionTask.Should().HaveValue().AndValue(v => v.Should().BeGreaterThanOrEqualTo(0));
await optionTask.Should().HaveValue().AndValue(v => v.Should().BeGreaterThanOrEqualTo(0).And.LessThanOrEqualTo(2000));

NotHaveValue

var optionTask = Task.FromResult(Option.None<int>());

// await the task and verify that the resulting option does not have a value
await optionTask.Should().NotHaveValue();

Be

var optionTask = Task.FromResult(Option.Some(1337));
var otherOption = Task.FromResult(Option.Some(1337));

// await the task and verify that the resulting option is equal to another option
await optionTask.Should().Be(otherOption);

Result<TSuccess, TFailure>

BeSuccessful

var result = Result.Success<int, string>(1337);

// verify that the result represents a successful value
result.Should().BeSuccessful();

// verify that the result represents a successful value and that the contained value matches some condition(s)
result.Should().BeSuccessful().AndSuccessValue.Should().Be(1337);
result.Should().BeSuccessful().AndSuccessValue.Should().BeGreaterThanOrEqualTo(0);
result.Should().BeSuccessful().AndSuccessValue.Should().BeGreaterThanOrEqualTo(0).And.BeLessThanOrEqualTo(2000);

BeFaulted

var result = Result.Failure<int, string>(string.Empty);

// verify that the result represents a faulted value
result.Should().BeFaulted();

// verify that the result represents a faulted value and that the contained value matches some condition(s)
result.Should().BeFaulted().AndFailureValue.Should().Be(string.Empty);
result.Should().BeFaulted().AndFailureValue.Should().BeNullOrWhiteSpace();

Be

var result = Result.Success<int, string>(1337);
var otherResult = Result.Success<int, string>(1337);

// verify that the result is equal to another result
result.Should().Be(otherResult);

Task<Result<TSuccess, TFailure>>

BeSuccessful

var resultTask = Task.FromResult(Result.Success<int, string>(1337));

// await the Task and verify that the result represents a successful value
await resultTask.Should().BeSuccessful();

// await the Task and verify that the result represents a successful value and that the contained value matches some condition(s)
await resultTask.Should().BeSuccessful().AndSuccessValue(s => s.Should().Be(1337));
await resultTask.Should().BeSuccessful().AndSuccessValue(s => s.Should().BeGreaterThanOrEqualTo(0));
await resultTask.Should().BeSuccessful().AndSuccessValue(s => s.Should().BeGreaterThanOrEqualTo(0).And.BeLessThanOrEqualTo(2000));

BeFaulted

var resultTask = Task.FromResult(Result.Failure<int, string>(string.Empty));

// await the Task and verify that the result represents a faulted value
await resultTask.Should().BeFaulted();

// await the Task and verify that the result represents a faulted value and that the contained value matches some condition(s)
await resultTask.Should().BeFaulted().AndFailureValue(f => f.Should().Be(string.Empty));
await resultTask.Should().BeFaulted().AndFailureValue(f => f.Should().BeNullOrWhiteSpace());

Be

var resultTask = Task.FromResult(Result.Success<int, string>(1337));
var otherResult = Result.Success<int, string>(1337);

// await the Task and verify that the result is equal to another result
await resultTask.Should().Be(otherResult);