TestRunnerApi
The TestRunnerApi
retrieves and runs tests programmatically from code inside the project, or inside other packages. TestRunnerApi
is a ScriptableObject.
You can initialize the API like this:
var testRunnerApi = ScriptableObject.CreateInstance<TestRunnerApi>();
Note: You can subscribe and receive test results in one instance of the API, even if the run starts from another instance.
The TestRunnerApi
supports the following workflows:
Public methods
Syntax |
Description |
void Execute(ExecutionSettings executionSettings) |
Starts a test run with a given set of ExecutionSettings. |
void RegisterCallbacks(ICallbacks testCallbacks, int priority = 0) |
Sets up a given instance of ICallbacks to be invoked on test runs. |
void UnregisterCallbacks(ICallbacks testCallbacks) |
Unregisters an instance of ICallbacks to no longer receive callbacks from test runs. |
void RetrieveTestList(TestMode testMode, Action<ITestAdaptor> callback) |
Retrieve the full test tree as ITestAdaptor for a given test mode. |
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.