sbt-scoverage is a plugin for SBT that integrates the scoverage code coverage library. Find out more about scoverage.

Join the scoverage google group for help, bug reports, feature requests, and general discussion on scoverage.

Sbt-scoverage is an SBT auto plugin. This means it will only work with 0.13.5 and higher.

Add the plugin to your build with the following in project/build.sbt:

resolvers += Classpaths.sbtPluginReleases addSbtPlugin("org.scoverage" %% "sbt-scoverage" % "1.0.0.BETA3")

Then run the your tests with coverage enabled by entering:

$ sbt clean coverage test 

or

$ sbt clean coverage it:test 

After the tests have finished you should find the coverage reports inside target/scoverage-report.

If you want to see a project that is already setup to use scoverage in both sbt and maven, then clone the scoverage samples project.

You can exclude classes from being considered for coverage measurement by providing semicolon-separated list of regular expressions.

Example:

coverageExcludedPackages := "<empty>;Reverse.*;.*AuthService.*;models\.data\..*"

The regular expressions are matched against the fully qualified class name, and must match the entire string to take effect.

Any matched classes will not be instrumented or included in the coverage report.

You can also mark sections of code with comments like:

 // $COVERAGE-OFF$Disabling highlighting by default until a workaround for https://issues.scala-lang.org/browse/SI-8596 is found ... // $COVERAGE-ON$

Any code between two such comments will not be instrumented or included in the coverage report.

You can use the following two keys to set the minimum coverage, and if you want to fail the build if the coverage is less than the minimum.

coverageMinimumCoverage := 80 coverageFailOnMinimumCoverage := true

If you are using Scala 2.11.1 or less, then highlighting will not work (due to this bug which was fixed in 2.11.2 scala/scala#3799). In that case you must disable highlighting by adding the following to your build:

coverageHighlighting := false

If you are running into a scenario where your tests normally pass, but fail when scoverage is enabled, then the most common culprit is timing issues on futures and other async operations. Scoverage does a lot of file writing behind the scenes in order to track which statements have been executed, and this slows down tests, so try upping the timeouts by an order of magnitude.

It is possible to disable the parallel execution for tests:

parallelExecution in Test := false,

If you have an open source project then you can add code coverage metrics with the excellent website http://coveralls.io. Scoverage will integrate with coveralls using the sbt-coveralls plugin.

If you want to visually browse statement coverage reports then use this plugin for SonarQube. It allows you to review overall project statement coverage as well as dig deeper into sub-modules, directories and source code files to see uncovered statements. Statement coverage measurement can become an integral part of your team's continuous integration process and a required quality standard.

This software is licensed under the Apache 2 license, quoted below. Copyright 2013-2014 Stephen Samuel and contributors Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.