Skip to content

Provides an ITestCaseOrderer that allows you to control the order of execution of Xunit tests within a class.

License

Notifications You must be signed in to change notification settings

asherber/Xunit.Priority

Repository files navigation

Icon

Xunit.Priority NuGet Build status

Provides an ITestCaseOrderer that allows you to control the order of execution of Xunit tests within a class.

Based closely on the code at https://github.com/xunit/samples.xunit/tree/main/TestOrderExamples/TestCaseOrdering

Note that the Xunit folks have stated that they don't believe that well-written unit tests should be dependent on being run in a particular order, which is why this functionality is not available as part of the core package. Nevertheless, there are some testing scenarios which are not strict unit testing and which may require test ordering.

Usage

Add the following attribute to classes for which you want tests run in order:

[TestCaseOrderer(PriorityOrderer.Name, PriorityOrderer.Assembly)]

Then decorate your test methods with the Priority attribute.

[Fact, Priority(-10)]
public void FirstTestToRun() { }

[Fact, Priority(0)]
public void SecondTestToRun() { }

[Fact, Priority(10)]
public void ThirdTestToRunA() { }

[Fact, Priority(10)]
public void ThirdTestToRunB() { }

[Fact]
public void TestsWithNoPriorityRunLast() { }

Priorities are evaluated in numeric order (including 0 and negative numbers). If there are multiple tests with the same priority, those tests will be run in alphabetical order.

By default, tests with no explicit Priority attribute are assigned priority int.MaxValue and will be run last. You can change this by setting a DefaultPriority attribute on your test class.

[DefaultPriority(0)]
public class MyTests
{
    [Fact]
    public void SomeTest() { }

    [Fact]
    public void SomeOtherTest() { }

    [Fact, Priority(10)]
    public void RunMeLast() { }
}

About

Provides an ITestCaseOrderer that allows you to control the order of execution of Xunit tests within a class.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages