docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Custom assertion

    A test fails if Unity logs a message other than a regular log or warning message. Use LogAssert to check for an expected message in the log so that the test does not fail when Unity logs the message.

    Use LogAssert.Expect before running the code under test, as the check for expected logs runs at the end of each frame.

    A test also reports a failure, if an expected message does not appear, or if Unity does not log any regular log or warning messages.

    Example

    [Test] public void LogAssertExample() { // Expect a regular log message LogAssert.Expect(LogType.Log, "Log message"); // The test fails without the following expected log message Debug.Log("Log message"); // An error log Debug.LogError("Error message"); // Without expecting an error log, the test would fail LogAssert.Expect(LogType.Error, "Error message"); }

    LogAssert

    LogAssert lets you expect Unity log messages that would otherwise cause the test to fail. It is available under the namespace UnityEngine.TestTools, see the Scripting API for more details.

    Static properties

    Syntax Description
    bool ignoreFailingMessages Set this property to true to prevent unexpected error log messages from triggering an assertion. By default, it is false.

    Static Methods

    Syntax Description
    void Expect(LogType type, string message); void Expect(LogType type, Regex message); Verifies that a log message of a specified type appears in the log. A test won’t fail from an expected error, assertion, or exception log message. It does fail if an expected message does not appear in the log.
    void NoUnexpectedReceived(); Triggers an assertion when receiving any log messages and fails the test if some are unexpected messages. If multiple tests need to check for no received unexpected logs, consider using the TestMustExpectAllLogs attribute instead.

    Expect string message

    void Expect(LogType type, string message);

    Parameters

    Syntax Description
    LogType type A type of log to expect. It can take one of the LogType enum values.
    string message A string value that should equate to the expected message.

    Expect Regex message

    void Expect(LogType type, Regex message);

    Parameters

    Syntax Description
    LogType type A type of log to expect. It can take one of the LogType enum values.
    Regex message A regular expression pattern to match the expected message.

    Did you find this page useful? Please give it a rating:

    Thanks for rating this page!

    Report a problem on this page

    What kind of problem would you like to report?

    • This page needs code samples
    • Code samples do not work
    • Information is missing
    • Information is incorrect
    • Information is unclear or confusing
    • There is a spelling/grammar error on this page
    • Something else

    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.

    In This Article
    • Example
    • LogAssert
      • Static properties
      • Static Methods
      • Expect string message
        • Parameters
      • Expect Regex message
        • Parameters
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)