docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class Filter

    The filter class provides the TestRunnerApi with a specification of what tests to run when running tests programmatically.

    Inheritance
    object
    Filter
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: UnityEditor.TestTools.TestRunner.Api
    Assembly: UnityEditor.TestRunner.dll
    Syntax
    [Serializable]
    public class Filter

    Fields

    assemblyNames

    The name of assemblies included in the run. That is the assembly name, without the .dll file extension. E.g., MyTestAssembly

    Declaration
    [SerializeField]
    public string[] assemblyNames
    Field Value
    Type Description
    string[]

    categoryNames

    The name of a Category to include in the run. Any test or fixtures runs that have a Category matching the string.

    Declaration
    [SerializeField]
    public string[] categoryNames
    Field Value
    Type Description
    string[]

    groupNames

    The same as testNames, except that it allows for Regex. This is useful for running specific fixtures or namespaces. E.g. "^MyNamespace\." Runs any tests where the top namespace is MyNamespace.

    Declaration
    [SerializeField]
    public string[] groupNames
    Field Value
    Type Description
    string[]

    targetPlatform

    The BuildTarget platform to run the test on. If set to null, then the Editor is the target for the tests. Obsolete. Use the targetPlatform property on the ExecutionSettings.

    Declaration
    [SerializeField]
    public BuildTarget? targetPlatform
    Field Value
    Type Description
    BuildTarget?

    testMode

    An enum flag that specifies if Edit Mode or Play Mode tests should run.

    Declaration
    [SerializeField]
    public TestMode testMode
    Field Value
    Type Description
    TestMode

    testNames

    The full name of the tests to match the filter. This is usually in the format FixtureName.TestName. If the test has test arguments, then include them in parenthesis. E.g. MyTestClass2.MyTestWithMultipleValues(1).

    Declaration
    [SerializeField]
    public string[] testNames
    Field Value
    Type Description
    string[]
    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)