Filter
The filter class provides the TestRunnerApi with a specification of what tests to run when running tests programmatically.
Fields
Syntax |
Description |
TestMode testMode |
An enum flag that specifies if Edit Mode or Play Mode tests should run. Applying both Edit Mode and Play Mode is currently not supported when running tests from the API. |
string[] 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) . |
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 . |
string[] categoryNames |
The name of a Category to include in the run. Any test or fixtures runs that have a Category matching the string. |
string[] assemblyNames |
The name of assemblies included in the run. That is the assembly name, without the .dll file extension. E.g., MyTestAssembly . |
BuildTarget? targetPlatform |
The BuildTarget platform to run the test on. If set to null , then the Editor is the target for the tests. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.