Version: 2020.2
LanguageEnglish
  • C#

Coverage

class in UnityEngine.TestTools

/

Implemented in:UnityEngine.CoreModule

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

Describes the interface for the code coverage data exposed by mono.

Use one of the following methods to enable coverage:
1) Enable Code Coverage in General Preferences
2) Use the Coverage.enabled api
3) Use the Command line argument -enableCodeCoverage in batchmode

Code Coverage is a measure of how much of your code is executed when you run automated tests. It is typically presented as a report that shows the percentage of your code that is covered by tests.

It is much easier to accidentally introduce bugs into code that is not covered by tests, because those bugs are not detected straight away by the tests and can instead cause problems later — such as after you have published your game or app.

The report does not measure the quality of tests, only whether your code is executed at all by PlayMode and EditMode tests. It is especially useful to check that critical or high risk areas of your code are covered, because they should receive the most rigorous testing.

To generate a code coverage report you can install the Code Coverage package, which is a client of the Coverage api.

Static Properties

enabledEnables or disables code coverage collection. Note that Code Coverage lowers Editor performance.

Static Methods

GetSequencePointsForReturns the coverage sequence points for the method you specify. See CoveredSequencePoint for more information about the coverage data this method returns.
GetStatsForReturns the coverage summary for the specified method. See CoveredMethodStats for more information about the coverage statistics returned by this method.
GetStatsForAllCoveredMethodsReturns the coverage summary for all methods that have been called since either the Unity process was started or Coverage.ResetAll() has been called.
ResetAllResets all coverage data.
ResetForResets the coverage data for the specified method.