Class Filter

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

Inheritance
Object
Filter
Namespace: UnityEditor.TestTools.TestRunner.Api
Syntax
[Serializable]
public class Filter : ISerializationCallbackReceiver

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[]

assemblyType

An enum flag that filters whether the assembly of the test is in an editor only assembly or if it is in an assembly that also supports one or more platforms.

Declaration
[SerializeField]
public AssemblyType assemblyType
Field Value
Type Description
AssemblyType

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[]

requiresPlayMode

A nullable boolean flag specifying where to include tests that requires PlayMode into the filter. If left as null, tests are included regardless of if they require PlayMode or not.

Declaration
[NonSerialized]
public bool? requiresPlayMode
Field Value
Type Description
Nullable<Boolean>

targetPlatform

The BuildTarget platform to run the test on. If set to null, then the Editor is the target for the tests.

Declaration
public BuildTarget? targetPlatform
Field Value
Type Description
Nullable<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[]

Methods

Equals(Object)

Implementation of Equals() that compares two objects to determine if they are equal.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
Object obj

An object to compare with this filter.
Returns
Type Description
Boolean

True if the supplied object is the same as this filter.
Overrides

Equals(Filter)

Implementation of Equals() that compares two filters to determine if they are equal.

Declaration
public bool Equals(Filter p)
Parameters
Type Name Description
Filter p

A filter to compare with this filter.
Returns
Type Description
Boolean

True if the supplied filter is reference equal to this filter.

GetHashCode()

Implementation of GetHashCode() that computes a hash code from the current filter values.

Declaration
public override int GetHashCode()
Returns
Type Description
Int32

A hash code for this filter.
Overrides

OnAfterDeserialize()

Declaration
public void OnAfterDeserialize()
Implements

OnBeforeSerialize()

Declaration
public void OnBeforeSerialize()
Implements

ToString()

Implementation of ToString() that builds a string composed of the filter values.

Declaration
public override string ToString()
Returns
Type Description
String

The current filter values as a string.
Overrides