Base classes and extension classes for building Unit tests based on XUnit and Given-When-Then pattern
Get Started
$ dotnet add package XspecTReadme
XspecT: A fluent unit testing framework
Framework for writing and running automated tests in .Net in a flexible and fluent style, based on the popular "Given-When-Then" pattern, built upon XUnit, Moq, AutoMock and FluentAssertions.
Whether you are beginner or expert in unit-testing, this framework will help you to write more descriptive, concise and maintainable tests.
Usage
It is assumed that you are already familiar with Xunit and Moq, or similar test and mocking frameworks.
This package includes FluentAssertions, but also comes with its own, more limited but less wordy assertion methods, based on the verb Is instead of Should.
Is-assertions have the same return-types as Should-assertions, so they can be combined in the same sentence.
Is-assertions are recommended to make the tests read more like specifications, listing requirements rather than asserting expected results.
This is an example of a complete test class (specification) with one test method (requirement):
using XspecT.Verification;
using XspecT.Fixture;
using static App.Calculator;
namespace App.Test;
public class CalculatorSpec : StaticSpec<int>
{
[Fact] public void WhenAdd_1_and_2_ThenSumIs_3() => Given(1, 2).When(Add).Then.Result.Is(3);
}
Test a static method with [Theory]
If you are used to writing one test class per production class and use Theory for test input, you can use a similar style with XspecT.
First you create your test-class overriding StaticSpec<[ReturnType]> with the expected return type as generic argument.
Then create a test-method, attributed with Theory and InlineData, called When[Something].
This method call Given and When, in any order, to setup the test pipeline with test data and the method to test.
Finally verify the result by calling Then.Result (or only Result) on the returned pipeline and check the result with Is.
Example:
public class CalculatorSpec : StaticSpec<int>
{
[Theory]
[InlineData(1, 1, 2)]
[InlineData(3, 4, 7)]
public void GivenTwoNumbers_WhenAdd_ReturnSum(int x, int y, int sum)
=> Given(x, y).When(Calculator.Add).Result.Is(sum);
[Theory]
[InlineData(1, 1, 1)]
[InlineData(3, 4, 12)]
public void WhenMultiplyThenReturnProduct(int x, int y, int product)
=> Given(x, y).When(Calculator.Multiply).Result.Is(product);
}