Class Filter
The filter class provides the TestRunnerApi with a specification of what tests to run when running tests programmatically.
Implements
Inherited Members
Namespace: UnityEditor.TestTools.TestRunner.Api
Assembly: solution.dll
Syntax
[Serializable]
public class Filter : ISerializationCallbackReceiver
Fields
Name | Description |
---|---|
assemblyNames | The name of assemblies included in the run. That is the assembly name, without the .dll file extension. E.g., MyTestAssembly |
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. |
categoryNames | The name of a Category to include in the run. Any test or fixtures runs that have a Category matching the 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. |
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. |
targetPlatform | The BuildTarget platform to run the test on. If set to null, then the Editor is the target for the tests. |
testMode | An enum flag that specifies if Edit Mode or Play Mode tests should run. |
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). |
Methods
Name | Description |
---|---|
Equals(object) | Implementation of Equals() that compares two objects to determine if they are equal. |
Equals(Filter) | Implementation of Equals() that compares two filters to determine if they are equal. |
GetHashCode() | Implementation of GetHashCode() that computes a hash code from the current filter values. |
OnAfterDeserialize() | Implement this method to receive a callback after Unity deserializes your object. |
OnBeforeSerialize() | Implement this method to receive a callback before Unity serializes your object. |
ToString() | Implementation of ToString() that builds a string composed of the filter values. |