About Unity Test Framework
The Unity Test Framework (UTF) enables Unity users to test their code in both Edit Mode and Play Mode, and also on target platforms such as Standalone, Android, iOS, etc.
This package provides a standard test framework for users of Unity and developers at Unity so that both benefit from the same features and can write tests the same way.
UTF uses a Unity integration of NUnit library, which is an open-source unit testing library for .Net languages. UTF currently uses NUnit version 3.5. For more information about NUnit, see the official NUnit website and the NUnit documentation.
Note: UTF is not a new concept or toolset; it is an adjusted and more descriptive naming for the toolset otherwise known as Unity Test Runner, which is now available as this package.
Installing Unity Test Framework
To install this package, follow the instructions in the Package Manager documentation.
Note: Search for the Test Framework package. In Unity 2019.2 and higher, you may need to enable the package before use.
Using Unity Test Framework
To learn how to use the Unity Test Framework package in your project, read the manual.
This version of the Unity Test Framework is compatible with the following versions of the Unity Editor:
- 2019.2 and later.
Unity Test Framework version 1.0.18 includes the following known limitations:
UnityTestattribute does not support WebGL and WSA platforms.
UnityTestattribute does not support Parameterized tests (except for
UnityTestattribute does not support the
- Nested test fixture cannot run from the Editor UI.
- When using the
NUnitRetry attribute in PlayMode tests, it throws
- Async tests are not supported in the current version of UTF.
The following table indicates the root folders in the package where you can find useful resources:
|/com.unity.test-framework/Documentation~||Contains the documentation for the package.|
Document revision history
|February 4, 2021||Applied user feedback to the documentation. Matches package version 1.1.22|
|August 23, 2019||Applied feedback to the documentation|
|July 25, 2019||Documentation updated to include features in version 1.1.0|
|July 11, 2019||Documentation updated. Matches package version 1.0.18|
|May 27, 2019||Documentation created. Matches package version 1.0.14|