LoFuUnit.Xunit 1.3.0

Unit Testing with Local Functions 🐯

Use Xunit to write TDD or BDD tests:

✔️ Arrange / Act / Assert
✔️ Given / When / Then
✔️ Context / Specification

Install-Package LoFuUnit.Xunit -Version 1.3.0
dotnet add package LoFuUnit.Xunit --version 1.3.0
<PackageReference Include="LoFuUnit.Xunit" Version="1.3.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add LoFuUnit.Xunit --version 1.3.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: LoFuUnit.Xunit, 1.3.0"
#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 LoFuUnit.Xunit as a Cake Addin
#addin nuget:?package=LoFuUnit.Xunit&version=1.3.0

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

Build status CodeFactor

Use xUnit.net for BDD.

Use local functions to structure tests with patterns like:

  • Arrange / Act / Assert
  • Given / When / Then
  • Context / Specification

LoFuUnit.Xunit and related packages makes it convenient for developers to write tests with collaboration & communication in mind.

Tests ✔️

An example of a test with LoFuUnit.Xunit and FluentAssertions:

using FluentAssertions;
using LoFuUnit.Xunit;
using Xunit;
using Xunit.Abstractions;

namespace LoFuUnitDocs
{
    public class AuthenticationTests : LoFuTest
    {
        public AuthenticationTests(ITestOutputHelper output) : base(output) { }

        SecurityService Subject;
        UserToken Token;

        [Fact]
        public void Authenticate_admin_users()
        {
            Subject = new SecurityService();

            void when_authenticating_an_admin_user() =>
                Token = Subject.Authenticate("username", "password");

            void should_indicate_the_user_s_role() =>
                Token.Role.Should().Be(Roles.Admin);

            void should_have_a_unique_session_id() =>
                Token.SessionId.Should().NotBeNull();
        }
    }
}

Output:

Authenticate admin users
	when authenticating an admin user
	should indicate the user's role
	should have a unique session id

Test methods can contain local functions that are invoked implicitly. These test functions can perform the arrange, act or assert steps of the test.

The LoFuUnit.Xunit package contains the LoFuTest base class for test fixtures to inherit from. This class implements the DisposeAsync method from the IAsyncLifetime interface, and it is called after running each test in the test fixture. The DisposeAsync method invokes the test functions in the containing test method that was just executed. The invocations will occur in the order that the test functions are declared. If a test function fails, the test method fails directly. Any subsequent test functions in the test method will not be invoked.

More documentation is available at https://github.com/hlaueriksson/LoFuUnit

Build status CodeFactor

Use xUnit.net for BDD.

Use local functions to structure tests with patterns like:

  • Arrange / Act / Assert
  • Given / When / Then
  • Context / Specification

LoFuUnit.Xunit and related packages makes it convenient for developers to write tests with collaboration & communication in mind.

Tests ✔️

An example of a test with LoFuUnit.Xunit and FluentAssertions:

using FluentAssertions;
using LoFuUnit.Xunit;
using Xunit;
using Xunit.Abstractions;

namespace LoFuUnitDocs
{
    public class AuthenticationTests : LoFuTest
    {
        public AuthenticationTests(ITestOutputHelper output) : base(output) { }

        SecurityService Subject;
        UserToken Token;

        [Fact]
        public void Authenticate_admin_users()
        {
            Subject = new SecurityService();

            void when_authenticating_an_admin_user() =>
                Token = Subject.Authenticate("username", "password");

            void should_indicate_the_user_s_role() =>
                Token.Role.Should().Be(Roles.Admin);

            void should_have_a_unique_session_id() =>
                Token.SessionId.Should().NotBeNull();
        }
    }
}

Output:

Authenticate admin users
	when authenticating an admin user
	should indicate the user's role
	should have a unique session id

Test methods can contain local functions that are invoked implicitly. These test functions can perform the arrange, act or assert steps of the test.

The LoFuUnit.Xunit package contains the LoFuTest base class for test fixtures to inherit from. This class implements the DisposeAsync method from the IAsyncLifetime interface, and it is called after running each test in the test fixture. The DisposeAsync method invokes the test functions in the containing test method that was just executed. The invocations will occur in the order that the test functions are declared. If a test function fails, the test method fails directly. Any subsequent test functions in the test method will not be invoked.

More documentation is available at https://github.com/hlaueriksson/LoFuUnit

Release Notes

🔢 Test functions are executed in order of declaration

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version History

Version Downloads Last updated
1.3.0 77 6/4/2021
1.2.0 331 4/11/2020
1.1.1 220 12/27/2019
1.0.0 506 1/23/2019