docs.unity.cn
    Show / Hide Table of Contents

    Class TestRunCallbackAttribute

    An assembly level attribute that indicates that a given type implementing ITestRunCallback should be subscribed to updates on the test progress. You can invoke the callbacks with NUnit ITest and ITestResult classes.

    At the RunStarted and RunFinished methods, the test and test results are for the whole test tree. These methods invoke at each node in the test tree; first with the whole test assembly, then with the test class, and last with the test method.

    From these callbacks, it's possible to read the partial or the full results, and to save the XML version of the result for further processing or continuous integration.

    Inheritance
    Object
    Attribute
    TestRunCallbackAttribute
    Namespace: UnityEngine.TestRunner
    Syntax
    [AttributeUsage(AttributeTargets.Assembly)]
    public class TestRunCallbackAttribute : Attribute, _Attribute
    Examples
    using NUnit.Framework.Interfaces;
    using UnityEngine;
    using UnityEngine.TestRunner;
    
    [assembly:TestRunCallback(typeof(TestListener))]
    
    public class TestListener : ITestRunCallback
    {
       public void RunStarted(ITest testsToRun)
       {
    
       }
    
       public void RunFinished(ITestResult testResults)
       {
           Debug.Log($"Run finished with result {testResults.ResultState}.");
       }
    
       public void TestStarted(ITest test)
       {
    
       }
    
       public void TestFinished(ITestResult result)
       {
    
       }
    }

    Note: The TestRunCallback does not need any references to the UnityEditor namespace and can run in standalone Players on the Player side.

    Constructors

    TestRunCallbackAttribute(Type)

    Constructs a new instance of the TestRunCallbackAttribute class.

    Declaration
    public TestRunCallbackAttribute(Type type)
    Parameters
    Type Name Description
    Type type

    A target type that implements ITestRunCallback.

    Exceptions
    Type Condition
    ArgumentException

    Throws an ArgumentException if the provided type does not implement ITestRunCallback.

    Back to top Copyright © 2022 Unity Technologies
    Generated by DocFX
    on Monday, November 14, 2022
    Terms of use