Skip to content

Latest commit

 

History

History
68 lines (51 loc) · 1.86 KB

README.md

File metadata and controls

68 lines (51 loc) · 1.86 KB
Raw

Build Status

gradle-scoverage

A plugin to enable the use of Scoverage in a gradle Scala project.

This has now been deployed to maven central.

Getting started

buildscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath 'org.scoverage:gradle-scoverage:1.0.8'
    }
}

apply plugin: 'scoverage'

dependencies {
    scoverage 'org.scoverage:scalac-scoverage-plugin_2.11:1.0.4', 'org.scoverage:scalac-scoverage-runtime_2.11:1.0.4'
}

This creates an additional task testCoverage which will run tests against instrumented code

  • instrumenting main scala code
  • running JUnit tests against instrumented scala code
  • failing the build on lack of coverage

Then launch command : gradle testScoverage or gradle checkScoverage

Aggregating Reports

There is now experimental support for aggregating coverage statistics across subprojects.

The project hosting the aggregation task must be configured as the sub-projects are; i.e. with the scoverage plugin applied and the scoverage dependencies configured.

task aggregateScoverage(type: org.scoverage.ScoverageAggregate)

This will produce a report into build / scoverage-aggregate

Available tasks

  • testScoverage - Executes all tests and creates Scoverage XML report with information about code coverage
  • reportScoverage - Generates HTML report.
  • checkScoverage - See below.
  • compileScoverageScala - Instruments code without running tests.

CheckScoverage

By default, when you launch gradle checkScoverage build fail if only 75% of project is covered by tests.

To configure it as you want, add this configuration :

checkScoverage {
    minimumLineRate = 0.5
}