sbt plugin for scoverage
Scala

README.md

sbt-scoverage

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.

Build Status License

How to use

Add the plugin in project/plugins.sbt:

addSbtPlugin("org.scoverage" % "sbt-scoverage" % "1.5.0")

Run the tests with enabled coverage:

$ sbt clean coverage test

or if you have integration tests as well

$ sbt clean coverage it:test

To enable coverage directly in your build, use:

coverageEnabled := true

To generate the coverage reports run

$ sbt coverageReport

Coverage reports will be in target/scoverage-report. There are HTML and XML reports. The XML is useful if you need to programatically use the results, or if you're writing a tool.

If you're running the coverage reports from within an sbt console session (as opposed to one command per sbt launch), then the coverage command is sticky. To turn it back off when you're done running reports, use the coverageOff command or reset coverageEnabled with set coverageEnabled := false.

Sample project with scoverage in both sbt and maven - the scoverage samples project.

Notes on upgrading to version 1.3.0

  • The object containing the keys has changed from nested to top level so you might need to adjust the import. It's also an auto plugin now, so you might not need the import at all.
  • There is an issue syncing the binary with the sbt-plugin-releases repo, so in the meantime add resolvers += Resolver.url("scoverage-bintray", url("https://dl.bintray.com/sksamuel/sbt-plugins/"))(Resolver.ivyStylePatterns) to your build.

Notes on upgrading to version 1.0.0

If you are upgrading from 0.99.x then you must remove the instrumentSettings from your build.sbt or Build.scala, as that is no longer needed.

Next, the keys have been renamed slightly. The new names begin with coverageXXX, eg coverageExcludedPackages and some have had their full name changed. You can see a full list of keys by opening the object ScoverageKeys.

Multi project reports

By default, scoverage will generate reports for each project seperately. You can merge them into an aggregated report by invoking sbt coverageAggregate.

(Note, you must do this after all the coverage data is complete as a separate command, so you cannot do sbt coverage test coverageAggregate (at least until a way around this is found).)

(You must have first run sbt coverageReport for coverageAggregate to work. It aggregates over the sub-projects' report xml rather than over the coverage data directly.)

Exclude classes and packages

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.

Minimum coverage

Based on minimum coverage, you can fail the build with the following keys

coverageMinimum := 80
coverageFailOnMinimum := true

These settings will be enforced when the reports are generated. If you generate an aggregate report using coverageAggregate then these settings will apply to that report.

Highlighting

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 https://github.com/scala/scala/pull/3799). In that case you must disable highlighting by adding the following to your build:

coverageHighlighting := false

Failing tests

Scoverage does a lot of file writing behind the scenes in order to track which statements have been executed. If you are running into a scenario where your tests normally pass, but fail when scoverage is enabled, then the culprit can be one of the following:

  • timing issues on futures and other async operations, try upping the timeouts by an order of magnitude.
  • tests are run in a sandbox mode (such as with java.security.PrivilegedAction<T>), try running the tests outside of the sandbox.

Coveralls

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

Plugin for SonarQube

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.

License

This software is licensed under the Apache 2 license, quoted below.

Copyright 2013-2016 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.