Write tests for your Edit mode or Play mode code and run them through the Unity Editor’s Test RunnerThe Test Framework package (formerly called the Test Runner) is a Unity tool that tests your code in both Edit mode and Play mode, and also on target platforms such as Standalone, Android, or iOS. More info
See in Glossary window, from the command line, or from code. Unity Test Framework integrates a custom version of NUnit, the open-source unit testing library for .NET languages and extends it with Unity-specific capabilities.
As an alternative to NUnit tests, Unity Test Framework provides Unity tests, which can interact with Unity-specific concepts such as frames, the application loop, and domain reload. A Unity test runs as a coroutine in Play mode and in the EditorApplication.update callback loop in Edit mode.
Unity tests can yield instructions for the Unity Editor. Once the instruction is complete, the test run continues. You can also yield return null in a Unity test to skip a frame and defer an operation until the next iteration of either the EditorApplication.update or the per-frame game update loop.
This documentation assumes you’re familiar with NUnit and with fundamental principles of unit testing in C#. If you’re not, refer to Unit testing C# with NUnit and .NET Core and Unit testing best practices in the Microsoft documentation.
Note: Unity Test Framework is a core Unity package and is distributed as part of a Unity Editor installation. Unity Test Framework currently uses a custom version of NUnit based on version 3.5.
| Topic | Description |
|---|---|
| Get started with Unity Test Framework | Create your first test assembly and sample Unity Test Framework tests. |
| Command-line reference | Run tests and configure test settings from the Unity Editor command line. |
| Writing tests | Write Unity tests for Edit mode or Play mode code with the Unity Test Framework C# APIs. |
| Running tests | Run Unity tests from the Editor’s Test Runner window, from the command line, or directly from code. |
| Unity Test Framework learning materials | Follow a practical tutorial with a series of exercises to help you learn the fundamentals of Unity Test Framework. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
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.