Filter Syntax

作者 dotnet0608d8924cd3MIT5.5K 个星标收录于 2026年10月8日更新于 2026年10月8日仓库今天更新

Reference-only filter syntax for VSTest and MTP with MSTest, NUnit, xUnit v3, and TUnit. Load only after the platform/framework is known and a consumer needs to create or translate a filter. Do not load for unfiltered runs or platform detection. Used by run-tests and mtp-hot-reload; never invoke directly.

AI 生成的概览

VSTest 与 MTP 测试筛选语法的参考,涵盖 MSTest、NUnit、xUnit v3 和 TUnit。

功能
该技能是一份参考文档,说明如何为 VSTest 和 Microsoft Testing Platform(MTP)编写测试筛选表达式。它按框架列出运算符、组合符和可用属性,给出命令示例,并提供从 VSTest 筛选到 xUnit v3 MTP 等价写法的对照表。它只输出指导内容,不生成可运行产物。
适用场景
当测试平台和框架已确定,需要创建或转换筛选表达式时使用,例如从 VSTest 迁移到 MTP 的过程中。不适用于无筛选的测试运行或平台探测。
运行要求
无需脚本或工具,仅为纯说明性参考。使用前提是了解 dotnet test 及相关测试框架。

Test Filter Syntax Reference

Filter syntax depends on the platform and test framework.

VSTest filters (MSTest, xUnit v2, NUnit on VSTest)

bash
dotnet test --filter <EXPRESSION>

Expression syntax: <Property><Operator><Value>[|&<Expression>]

Operators:

OperatorMeaning
=Exact match
!=Not exact match
~Contains
!~Does not contain

Combinators: | (OR), & (AND). Parentheses for grouping: (A|B)&C

Supported properties by framework:

FrameworkProperties
MSTestFullyQualifiedName, Name, ClassName, Priority, TestCategory
xUnitFullyQualifiedName, DisplayName, Traits
NUnitFullyQualifiedName, Name, Priority, TestCategory

An expression without an operator is treated as FullyQualifiedName~<value>.

Examples (VSTest):

bash
# Run tests whose name contains "LoginTest"dotnet test --filter "Name~LoginTest"
# Run a specific test classdotnet test --filter "ClassName=MyNamespace.MyTestClass"
# Run tests in a categorydotnet test --filter "TestCategory=Integration"
# Exclude a categorydotnet test --filter "TestCategory!=Slow"
# Combine: class AND categorydotnet test --filter "ClassName=MyNamespace.MyTestClass&TestCategory=Unit"
# Either of two classesdotnet test --filter "ClassName=MyNamespace.ClassA|ClassName=MyNamespace.ClassB"

MTP filters — MSTest and NUnit

MSTest and NUnit on MTP use the same --filter syntax as VSTest (same properties, operators, and combinators). The only difference is how the flag is passed:

bash
# .NET SDK 8/9 (after --)dotnet test -- --filter "Name~LoginTest"
# .NET SDK 10+ (direct)dotnet test --filter "Name~LoginTest"

MTP filters — xUnit (v3)

xUnit v3 on MTP uses framework-specific filter flags instead of the generic --filter expression:

FlagDescription
--filter-class "name"Run all tests in a given class
--filter-not-class "name"Exclude all tests in a given class
--filter-method "name"Run a specific test method
--filter-not-method "name"Exclude a specific test method
--filter-namespace "name"Run all tests in a namespace
--filter-not-namespace "name"Exclude all tests in a namespace
--filter-trait "name=value"Run tests with a matching trait
--filter-not-trait "name=value"Exclude tests with a matching trait

Multiple values can be specified with a single flag: --filter-class Foo Bar.

bash
# .NET SDK 8/9dotnet test -- --filter-class "MyNamespace.LoginTests"
# .NET SDK 10+dotnet test --filter-class "MyNamespace.LoginTests"
# Combine: namespace + traitdotnet test --filter-namespace "MyApp.Tests.Integration" --filter-trait "Category=Smoke"

xUnit v3 query filter language

For complex expressions, use --filter-query with a path-segment syntax:

text
/<assemblyFilter>/<namespaceFilter>/<classFilter>/<methodFilter>[traitName=traitValue]

Each segment matches against: assembly name, namespace, class name, method name. Use * for "match all" in any segment. Documentation: https://xunit.net/docs/query-filter-language

shell
# xUnit.net v3 MTP — using query language (assembly/namespace/class/method[trait])dotnet test -- --filter-query "/*/*/*IntegrationTests*/*[Category=Smoke]"

MTP filters — TUnit

TUnit uses --treenode-filter with a path-based syntax:

text
--treenode-filter "/<Assembly>/<Namespace>/<ClassName>/<TestName>"

Wildcards (*) are supported in any segment. Filter operators can be appended to test names for property-based filtering.

OperatorMeaning
*Wildcard match
=Exact property match (e.g., [Category=Unit])
!=Exclude property value
&AND (combine conditions)
|OR (within a segment, requires parentheses)

Examples (TUnit):

bash
# All tests in a classdotnet run --treenode-filter "/*/*/LoginTests/*"
# A specific testdotnet run --treenode-filter "/*/*/*/AcceptCookiesTest"
# By namespace prefix (wildcard)dotnet run --treenode-filter "/*/MyProject.Tests.Api*/*/*"
# By custom propertydotnet run --treenode-filter "/*/*/*/*[Category=Smoke]"
# Exclude by propertydotnet run --treenode-filter "/*/*/*/*[Category!=Slow]"
# OR across classesdotnet run --treenode-filter "/*/*/(LoginTests)|(SignupTests)/*"
# Combined: namespace + propertydotnet run --treenode-filter "/*/MyProject.Tests.Integration/*/*/*[Priority=Critical]"

VSTest → MTP filter translation (for migration)

MSTest, NUnit, and xUnit.net v2 (with YTest.MTP.XUnit2): The VSTest --filter syntax is identical on both VSTest and MTP. No changes needed.

xUnit.net v3 (native MTP): xUnit.net v3 does NOT support the VSTest --filter syntax on MTP. Translate filters using xUnit.net v3's native options:

VSTest --filter syntaxxUnit.net v3 MTP equivalentNotes
FullyQualifiedName~ClassName--filter-class *ClassName*Wildcards required for substring match
FullyQualifiedName=Ns.Class.Method--filter-method Ns.Class.MethodExact match on fully qualified method
Name=MethodName--filter-method *MethodName*Wildcards for substring match
Category=Value (trait)--filter-trait "Category=Value"Filter by trait name/value pair
Complex expressions--filter-query "expr"Uses xUnit.net query filter language (see above)

来源与署名

来源:dotnet/skills位于plugins/dotnet-test/skills/filter-syntax提交0608d89

许可证: MIT

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架