You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
sbt-scoverage is a plugin for SBT that integrates the scoverage code coverage library. Find out more about [scoverage](https://github.com/scoverage/scalac-scoverage-plugin).
5
-
6
-
Join the [scoverage](http://groups.google.com/group/scala-code-coverage-tool)
7
-
google group for help, bug reports, feature requests, and general
@@ -46,54 +38,40 @@ To generate the coverage reports run
46
38
$ sbt coverageReport
47
39
```
48
40
49
-
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.
50
-
51
-
If you're running the coverage reports from within an sbt console session (as
52
-
opposed to one command per sbt launch), then the `coverage` command is sticky. To
53
-
turn it back off when you're done running reports, use the `coverageOff` command or reset `coverageEnabled` with `set coverageEnabled := false`.
54
-
55
-
Sample project with scoverage in both sbt and maven - [the scoverage samples project](https://github.com/scoverage/sbt-scoverage-samples).
56
-
57
-
## Notes on upgrading to version 1.6.0
58
-
59
-
*`coverageAggregate` aggregates raw coverage data, not coverage xml reports for modules.
60
-
There is no requirement to generate individual coverage reports for modules (`coverageReport`)
61
-
before generating aggregated report (`coverageAggregate`).
62
-
63
-
If only aggregated report is required, not executing `coverageReport` can reduce the build time significantly.
64
-
65
-
## Notes on upgrading to version 1.3.0
66
-
67
-
* 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.
68
-
* 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.
41
+
Coverage reports will be in your `target/scala-<scala-version>/scoverage-report`
42
+
directory. There are HTML and XML reports. The XML is useful if you need to
43
+
programatically use the results, or if you're writing a tool.
69
44
70
-
## Notes on upgrading to version 1.0.0
45
+
**NOTE**: If you're running the coverage reports from within an sbt console
46
+
session (as opposed to one command per sbt launch), then the `coverage` command
47
+
is sticky. To turn it back off when you're done running reports, use the
48
+
`coverageOff` command or reset `coverageEnabled` with `set coverageEnabled :=
49
+
false`.
71
50
72
-
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.
51
+
### Multi project reports
73
52
74
-
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.
53
+
By default, scoverage will generate reports for each project separately. You can
54
+
merge them into an aggregated report by using the following:
75
55
76
-
## Multi project reports
77
-
78
-
By default, scoverage will generate reports for each project separately. You can merge them into an aggregated report by invoking `sbt coverageAggregate`.
79
-
80
-
(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).)
56
+
```
57
+
$ sbt coverageAggregate
58
+
```
81
59
82
-
(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.)
60
+
**NOTE**: You do not need to run `coverageReport` before `coverageAggregate`; it
61
+
aggregates over the sub-projects' coverage data directly, not the report xml.
83
62
84
-
## Exclude classes and packages
63
+
###Exclude classes and packages
85
64
86
-
You can exclude classes from being considered for coverage measurement by providing semicolon-separated list of
87
-
regular expressions.
65
+
You can exclude classes from being considered for coverage measurement by
66
+
providing semicolon-separated list of regular expressions.
The regular expressions are matched against the fully qualified class name, and must match the entire string to take effect.
95
-
96
-
Any matched classes will not be instrumented or included in the coverage report.
72
+
The regular expressions are matched against the fully qualified class name, and
73
+
must match the entire string to take effect. Any matched classes will not be
74
+
instrumented or included in the coverage report.
97
75
98
76
You can also mark sections of code with comments like:
99
77
@@ -103,67 +81,72 @@ You can also mark sections of code with comments like:
103
81
// $COVERAGE-ON$
104
82
```
105
83
106
-
Any code between two such comments will not be instrumented or included in the coverage report.
84
+
Any code between two such comments will not be instrumented or included in the
85
+
coverage report.
107
86
108
-
## Minimum coverage
87
+
###Minimum coverage
109
88
110
-
Based on minimum coverage, you can fail the build with the following keys
89
+
Based on minimum coverage, you can fail the build with the following keys:
111
90
112
91
```scala
113
-
coverageMinimum :=80
114
92
coverageFailOnMinimum :=true
93
+
coverageMinimumStmtTotal :=90
94
+
coverageMinimumBranchTotal :=90
95
+
coverageMinimumStmtPerPackage :=90
96
+
coverageMinimumBranchPerPackage :=85
97
+
coverageMinimumStmtPerFile :=85
98
+
coverageMinimumBranchPerFile :=80
115
99
```
116
100
117
-
These settings will be enforced when the reports are generated.
118
-
If you generate an aggregate report using `coverageAggregate` then these settings will apply to that report.
119
-
120
-
## Highlighting
101
+
These settings will be enforced when the reports are generated. If you generate
102
+
an aggregate report using `coverageAggregate` then these settings will apply to
103
+
that report.
121
104
122
-
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:
123
-
124
-
```scala
125
-
coverageHighlighting :=false
126
-
```
105
+
## Trouble-shooting failing tests
127
106
128
-
## Failing tests
129
-
Scoverage does a lot of file writing behind the scenes in order to track which statements have been executed.
130
-
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:
107
+
scoverage does a lot of file writing behind the scenes in order to track which
108
+
statements have been executed. If you are running into a scenario where your
109
+
tests normally pass, but fail when scoverage is enabled, then the culprit can be
110
+
one of the following:
131
111
132
112
* timing issues on futures and other async operations, try upping the timeouts by an order of magnitude.
133
113
* tests are run in a sandbox mode (such as with `java.security.PrivilegedAction<T>`), try running the tests outside of the sandbox.
[Codacy](https://www.codacy.com) integrates with your favorite coverage tool to provide an in-depth overlook of your project status. Scoverage information can be integrated into Codacy through the [sbt-codacy-coverage plugin](https://github.com/codacy/sbt-codacy-coverage).
123
+
[Codacy](https://www.codacy.com) integrates with your favorite coverage tool to
124
+
provide an in-depth overlook of your project status. scoverage information can
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](https://github.com/scoverage/sbt-coveralls) plugin.
144
-
145
-
### Plugin for SonarQube
130
+
If you have an open source project then you can add code coverage metrics with
131
+
the [Coveralls](https://coveralls.io/). scoverage will integrate with coveralls
132
+
using the [sbt-coveralls](https://github.com/scoverage/sbt-coveralls) plugin.
146
133
147
-
If you want to visually browse statement coverage reports then use this [plugin for SonarQube](https://github.com/RadoBuransky/sonar-scoverage-plugin).
148
-
It allows you to review overall project statement coverage as well as dig deeper into sub-modules, directories and
149
-
source code files to see uncovered statements. Statement coverage measurement can become an integral part of your
150
-
team's continuous integration process and a required quality standard.
134
+
### Codecov
151
135
152
-
## License
153
-
```
154
-
This software is licensed under the Apache 2 license, quoted below.
136
+
You can integrate with [Codecov](https://about.codecov.io/) easily sending your
137
+
reports there via your CI. You can see an example of this here in
0 commit comments