natemcmaster / xunit-extensions

Making XUnit.NET test projects even better

Xunit Extensions

This repo contains a class library of utilities and helpers for writing tests with XUnit.NET.

Getting started

Install this as a NuGet package using your favorite IDE.

Install-Package McMaster.Extensions.Xunit
dotnet add package McMaster.Extensions.Xunit

Dynamically skip tests

In many cases, it's useful to automatically skip tests, based on conditions that cannot be determined at compile-time.

Test conditions you can use include

• SkipOnOS (skip on certain operating systems)
• SkipInEnvironment (skip if certain environment variables are set)
• SkipOnRuntimes (only run tests on Mono, .NET Core, or .NET Framework)
• SkipIfNotDocker (only run tests if running inside a Docker container)
• Your own (if you write a test that implements ITestCondition)

using McMaster.Extensions.Xunit;

public class MyTests
{
    [SkippableFact]
    [SkipOnOS(OS.Linux | OS.MacOS)
    public void RunCommandPrompt()
    {
        Process.Start("cmd.exe", "/c dir").WaitForExit();
    }
    
    [SkippableFact]
    [SkipUnlessIsNoon]
    public void Test1() { }
    
    // Implement your own conditional logic by implementing ITestCondition
    public class SkipUnlessIsNoonAttribute : Attribute, ITestCondition
    {
        public bool IsMet => DateTime.Now.Hours == 12;
        public string SkipReason { get; } = "This test can only run at noon."
    }
}

Test in different cultures

Ensure tests run with a particular culture set.

using McMaster.Extensions.Xunit;

public class I18nTests
{
    [Fact]
    [UseCulture("fr-FR")
    public void TestInFrench()
    {
    }
}

Misc

Other useful helpers are included.

Task.TimeoutAfter - prevent async from running too long

[Fact]
public async Task Test()
{
    await thing.TimeoutAfter(TimeSpan.FromMinutes(4));
}

xunit-extensions's Issues

A bout xunit framework

Sorry to bother you, I am studying how to develop a unit-test-framework, and I see your project xunit-extensions, that's a good sample for me to understand how to work and what is my first step, but a very confuse question for me. That's why I can click run test button and my unit-test-framework will working, I don't know from the project can you tell me why and help me what document record this

Docker skip doesn't work on Windows

Hey @natemcmaster

Found Arnot's Xunit.SkippableFact library on nuget as well as your lib. Was hoping your docker skipper was generic, but it's not...