Unity Test Framework manual

This is the manual for the Unity Test Framework (UTF):

Introduction

• Unity Test Framework overview
• Edit Mode vs. Play Mode tests

Getting started

• Getting started with UTF
  • Workflows:
  • How to create a new test assembly
  • How to create a test
  • How to run a test
  • How to create a Play Mode test
  • How to run a Play Mode test in player
• Resources

Extending UTF

• Extending UTF
  • Workflows:
  • How to split the build and run process for standalone Play Mode tests
  • How to run tests programmatically
  • How to get test results
  • How to retrieve the list of tests

Reference

• Running tests from the command-line
• UnityTest attribute
• Setup and cleanup at build time
  • IPrebuildSetup
  • IPostBuildCleanup
• Actions outside of tests
  • Action execution order
  • UnitySetUp and UnityTearDown
  • OuterUnityTestAction
  • Domain Reloads
• Custom attributes
  • ConditionalIgnore attribute
  • PostBuildCleanup attribute
  • PrebuildSetup attribute
  • TestMustExpectAllLogs attribute
  • TestPlayerBuildModifier attribute
  • TestRunCallback attribute
  • UnityPlatform attribute
  • UnitySetUp attribute
  • UnityTearDown attribute
  • UnityTest attribute
• Custom equality comparers
  • ColorEqualityComparer
  • FloatEqualityComparer
  • QuaternionEqualityComparer
  • Vector2EqualityComparer
  • Vector3EqualityComparer
  • Vector4EqualityComparer
  • Custom equality comparers with equals operator
  • Test Utils
• Custom yield instructions
  • IEditModeTestYieldInstruction
  • EnterPlayMode
  • ExitPlayMode
• Custom assertion
  • LogAssert
• Custom constraints
  • Is
• Parameterized tests

• MonoBehaviour tests

  • MonoBehaviourTest
  • IMonoBehaviourTest

• TestRunnerApi

  • ExecutionSettings
  • Filter
  • ITestRunSettings
  • ICallbacks
  • IErrorCallbacks