Class 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:

• How to run tests programmatically
• How to get test results
• How to retrieve the list of tests

Inheritance

object

Object

ScriptableObject

TestRunnerApi

Inherited Members

ScriptableObject.SetDirty()

ScriptableObject.CreateInstance(string)

ScriptableObject.CreateInstance(Type)

ScriptableObject.CreateInstance<T>()

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectOfType<T>()

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

object.MemberwiseClone()

Namespace: UnityEditor.TestTools.TestRunner.Api

Assembly: solution.dll

Syntax

public class TestRunnerApi : ScriptableObject

Methods

Name	Description
CancelTestRun(string)	Cancel the test run with a given guid string. The guid string can be retrieved when executing the test run. The test run may take multiple frames to finish cleaning up from the test run. Any current active test will be marked as "Canceled" and any other remaining tests marked as "NotRun".
Execute(ExecutionSettings)	Starts a test run with a given set of executionSettings.
RegisterCallbacks<T>(T, int)	Sets up a given instance of ICallbacks to be invoked on test runs.
RegisterTestCallback<T>(T, int)	Sets up a given instance of ICallbacks to be invoked on test runs.
RetrieveTestList(TestMode, Action<ITestAdaptor>)	Retrieve the full test tree as ITestAdaptor for a given test mode. This is obsolete. Use TestRunnerApi.RetrieveTestTree instead.
SaveResultToFile(ITestResultAdaptor, string)	Save a given set of ITestResultAdaptor in NUnit XML Format to a file at the provided file path. Any matching existing file is overwritten.
UnregisterCallbacks<T>(T)	Unregister an instance of ICallbacks to no longer receive callbacks from test runs.
UnregisterTestCallback<T>(T)	Unregister an instance of ICallbacks to no longer receive callbacks from test runs.