Run selected unit tests

MSTest examples

using Microsoft.VisualStudio.TestTools.UnitTesting;

namespace MSTestNamespace
{
    [TestClass]
    public class UnitTest1
    {
        [TestMethod, Priority(1), TestCategory("CategoryA")]
        public void TestMethod1()
        {
        }

        [TestMethod, Priority(2)]
        public void TestMethod2()
        {
        }
    }
}

Id filtering requires MSTest.TestAdapter 3.6 or later. Obtain the GUID from the test case that VSTest discovery returns in TestCase.Id. This filter can select one unfolded data-driven iteration without matching or escaping its display name. Each row must be discovered as an individual test case; a folded data-driven test exposes only one parent identity.

Examples using the conditional operators | and &:

• To run tests that have UnitTest1 in their FullyQualifiedName or TestCategoryAttribute is "CategoryA".

  dotnet test --filter "FullyQualifiedName~UnitTest1|TestCategory=CategoryA"
  

• To run tests that have UnitTest1 in their FullyQualifiedName and have a TestCategoryAttribute of "CategoryA".

  dotnet test --filter "FullyQualifiedName~UnitTest1&TestCategory=CategoryA"
  

• To run tests that have either FullyQualifiedName containing UnitTest1 and have a TestCategoryAttribute of "CategoryA" or have a PriorityAttribute with a priority of 1.

  dotnet test --filter "(FullyQualifiedName~UnitTest1&TestCategory=CategoryA)|Priority=1"
  

xUnit examples

using Xunit;

namespace XUnitNamespace
{
    public class TestClass1
    {
        [Fact, Trait("Priority", "1"), Trait("Category", "CategoryA")]
        public void Test1()
        {
        }

        [Fact, Trait("Priority", "2")]
        public void Test2()
        {
        }
    }
}

In the code example, the defined traits with keys "Category" and "Priority" can be used for filtering.

Examples using the conditional operators | and &:

• To run tests that have TestClass1 in their FullyQualifiedName or have a Trait with a key of "Category" and value of "CategoryA".

  dotnet test --filter "FullyQualifiedName~TestClass1|Category=CategoryA"
  

• To run tests that have TestClass1 in their FullyQualifiedName and have a Trait with a key of "Category" and value of "CategoryA".

  dotnet test --filter "FullyQualifiedName~TestClass1&Category=CategoryA"
  

• To run tests that have either FullyQualifiedName containing TestClass1 and have a Trait with a key of "Category" and value of "CategoryA" or have a Trait with a key of "Priority" and value of 1.

  dotnet test --filter "(FullyQualifiedName~TestClass1&Category=CategoryA)|Priority=1"
  

NUnit examples

For NUnit, TestCategory and Category are interchangeable filter property names. Both filter the categories that you assign with the Category attribute, so existing NUnit commands that use --filter Category=MyCategory don't need to change.

using NUnit.Framework;

namespace NUnitNamespace
{
    public class UnitTest1
    {
        [Test, Property("Priority", 1), Category("CategoryA")]
        public void TestMethod1()
        {
        }

        [Test, Property("Priority", 2)]
        public void TestMethod2()
        {
        }
    }
}

Examples using the conditional operators | and &:

To run tests that have UnitTest1 in their FullyQualifiedName or have a Category of "CategoryA".

dotnet test --filter "FullyQualifiedName~UnitTest1|TestCategory=CategoryA"

To run tests that have UnitTest1 in their FullyQualifiedName and have a Category of "CategoryA".

dotnet test --filter "FullyQualifiedName~UnitTest1&TestCategory=CategoryA"

To run tests that have either a FullyQualifiedName containing UnitTest1 and have a Category of "CategoryA" or have a Property with a "Priority" of 1.

dotnet test --filter "(FullyQualifiedName~UnitTest1&TestCategory=CategoryA)|Priority=1"

For more information, see TestCase filter.

TUnit examples

TUnit doesn't support the --filter option described earlier in this article. Instead, it uses the MTP --treenode-filter option. A tree node filter is a path in the form /<Assembly>/<Namespace>/<Class>/<Method>, where:

• * matches any value within a single path segment, and can be combined with other text, such as *Method*.
• ** matches any number of path segments.
• [<Property>=<Value>] after a path segment matches tests that have that property. [Category("CategoryA")] is exposed as the property Category, and [Property("Priority", "2")] as the property Priority.
• | (or) and & (and) combine alternatives within a single path segment or property filter. Enclose each alternative in parentheses, for example /*/*/(UnitTest1)|(UnitTest2)/* or [(Category=CategoryA)|(Priority=2)].

The --treenode-filter option is an MTP option, so dotnet test must run in its MTP mode. With the .NET 10 SDK or later, add the following configuration to the global.json file in your solution root:

{
    "test": {
        "runner": "Microsoft.Testing.Platform"
    }
}

Without it, dotnet test runs in VSTest mode and fails with MSB1001: Unknown switch before any test runs. For more information, including how to run MTP projects with earlier SDKs, see MTP mode of dotnet test.

The examples use the following test class:

namespace TUnitNamespace;

public class UnitTest1
{
    [Test, Property("Priority", "1"), Category("CategoryA")]
    public void TestMethod1()
    {
    }

    [Test, Property("Priority", "2")]
    public void TestMethod2()
    {
    }
}

Examples using the conditional operators | and &:

To run tests that are in class UnitTest1 and have a Category of "CategoryA":

dotnet test --treenode-filter "/*/*/UnitTest1/*[Category=CategoryA]"

To run tests that have a Category of "CategoryA" or a Priority of "2":

dotnet test --treenode-filter "/**[(Category=CategoryA)|(Priority=2)]"

To run tests that are in class UnitTest1 and have either a Category of "CategoryA" or a Priority of "2":

dotnet test --treenode-filter "/*/*/UnitTest1/*[(Category=CategoryA)|(Priority=2)]"

To run tests that have a Category of "CategoryA" and a Priority of "1":

dotnet test --treenode-filter "/**[(Category=CategoryA)&(Priority=1)]"