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, Boolean)

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, Boolean)

Object.Destroy(Object, Single)

Object.Destroy(Object)

Object.DestroyImmediate(Object, Boolean)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, Single)

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

Namespace: UnityEditor.TestTools.TestRunner.Api

Syntax

public class TestRunnerApi : ScriptableObject, ITestRunnerApi

Methods

Execute(ExecutionSettings)

Starts a test run with a given set of executionSettings.

Declaration

public string Execute(ExecutionSettings executionSettings)

Parameters

Type	Name	Description
ExecutionSettings	executionSettings	Set of ExecutionSettings

Returns

Type	Description
String	A GUID that identifies the TestJobData.

RegisterCallbacks<T>(T, Int32)

Sets up a given instance of ICallbacks to be invoked on test runs.

Declaration

public void RegisterCallbacks<T>(T testCallbacks, int priority = 0)
    where T : ICallbacks

Parameters

Type	Name	Description
T	testCallbacks	The test callbacks to be invoked.
Int32	priority	Sets the order in which the callbacks are invoked, starting with the highest value first.

Type Parameters

Name	Description
T	Generic representing a type of callback.

RetrieveTestList(TestMode, Action<ITestAdaptor>)

Retrieve the full test tree as ITestAdaptor for a given test mode. This is obsolete. Use TestRunnerApi.RetrieveTestTree instead.

Declaration

public void RetrieveTestList(TestMode testMode, Action<ITestAdaptor> callback)

Parameters

Type	Name	Description
TestMode	testMode
Action<ITestAdaptor>	callback

UnregisterCallbacks<T>(T)

Unregister an instance of ICallbacks to no longer receive callbacks from test runs.

Declaration

public void UnregisterCallbacks<T>(T testCallbacks)
    where T : ICallbacks

Parameters

Type	Name	Description
T	testCallbacks	The test callbacks to unregister.

Type Parameters

Name	Description
T	Generic representing a type of callback.