docs.unity.cn
    Show / Hide Table of Contents

    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

    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.
    Back to top Copyright © 2022 Unity Technologies
    Generated by DocFX
    on Tuesday, July 19, 2022
    Terms of use