TestFilterProviderAttribute<TFilter> Class

Definition

Namespace:

Microsoft.VisualStudio.TestTools.UnitTesting

Assembly:

MSTest.TestFramework.dll

Package:

MSTest.TestFramework v4.4.0

Strongly typed variant of TestFilterProviderAttribute that registers TFilter as the ITestFilter implementation the MSTest adapter invokes for every test it is about to run.

[System.AttributeUsage(System.AttributeTargets.Assembly, AllowMultiple=false, Inherited=false)]
[System.Diagnostics.CodeAnalysis.Experimental("MSTESTEXP", UrlFormat="https://aka.ms/mstest/diagnostics#{0}")]
public sealed class TestFilterProviderAttribute<TFilter> : Attribute where TFilter : ITestFilter, new()

[<System.AttributeUsage(System.AttributeTargets.Assembly, AllowMultiple=false, Inherited=false)>]
[<System.Diagnostics.CodeAnalysis.Experimental("MSTESTEXP", UrlFormat="https://aka.ms/mstest/diagnostics#{0}")>]
type TestFilterProviderAttribute<'Filter (requires 'Filter :> ITestFilter and 'Filter : (new : unit -> 'Filter))> = class
    inherit Attribute

Public NotInheritable Class TestFilterProviderAttribute(Of TFilter)
Inherits Attribute

Type Parameters

TFilter

The ITestFilter implementation to instantiate and invoke for every test in the consuming test assembly.

Inheritance

Attribute

TestFilterProviderAttribute<TFilter>

Attributes

AttributeUsageAttribute ExperimentalAttribute

Examples

[assembly: TestFilterProvider<NightlyFilter>]

public sealed class NightlyFilter : ITestFilter
{
    public TestFilterResult Filter(TestFilterContext context)
        => context.Categories.Contains("Nightly")
            && Environment.GetEnvironmentVariable("RUN_NIGHTLY") != "1"
            ? TestFilterResult.Skip("Set RUN_NIGHTLY=1 to run nightly tests.")
            : TestFilterResult.Run;
}

Remarks

This is the type-safe form of [assembly: TestFilterProvider(typeof(MyFilter))]. The generic constraints make the compiler enforce, at build time, what the non-generic attribute can only validate at run time: TFilter must implement ITestFilter and expose a public parameterless constructor.

Everything else behaves exactly like TestFilterProviderAttribute, including the "at most one per test assembly" rule — the two attributes count as one and the same registration, so applying both to a single assembly is an error. They are distinct types, so the compiler does not report that as a duplicate attribute; MSTEST0081 does.

This attribute is only available when targeting .NET. On .NET Framework, use the non-generic TestFilterProviderAttribute. A test project that multi-targets both can select the right form with #if NET:

#if NET
[assembly: TestFilterProvider<MyFilter>]
#else
[assembly: TestFilterProvider(typeof(MyFilter))]
#endif

Constructors

Name	Description
TestFilterProviderAttribute<TFilter>()