simplecov 0.16.1 → 0.18.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/CHANGELOG.md +111 -0
- data/CODE_OF_CONDUCT.md +76 -0
- data/README.md +281 -112
- data/doc/alternate-formatters.md +10 -0
- data/lib/simplecov.rb +248 -63
- data/lib/simplecov/combine.rb +30 -0
- data/lib/simplecov/combine/branches_combiner.rb +32 -0
- data/lib/simplecov/combine/files_combiner.rb +24 -0
- data/lib/simplecov/combine/lines_combiner.rb +43 -0
- data/lib/simplecov/combine/results_combiner.rb +60 -0
- data/lib/simplecov/command_guesser.rb +6 -3
- data/lib/simplecov/configuration.rb +110 -9
- data/lib/simplecov/coverage_statistics.rb +56 -0
- data/lib/simplecov/defaults.rb +6 -2
- data/lib/simplecov/file_list.rb +66 -13
- data/lib/simplecov/filter.rb +2 -1
- data/lib/simplecov/formatter/multi_formatter.rb +2 -2
- data/lib/simplecov/formatter/simple_formatter.rb +4 -4
- data/lib/simplecov/last_run.rb +3 -1
- data/lib/simplecov/lines_classifier.rb +2 -2
- data/lib/simplecov/profiles.rb +9 -7
- data/lib/simplecov/profiles/hidden_filter.rb +5 -0
- data/lib/simplecov/profiles/rails.rb +1 -1
- data/lib/simplecov/result.rb +39 -6
- data/lib/simplecov/result_adapter.rb +30 -0
- data/lib/simplecov/result_merger.rb +18 -11
- data/lib/simplecov/simulate_coverage.rb +29 -0
- data/lib/simplecov/source_file.rb +227 -126
- data/lib/simplecov/source_file/branch.rb +84 -0
- data/lib/simplecov/source_file/line.rb +72 -0
- data/lib/simplecov/useless_results_remover.rb +16 -0
- data/lib/simplecov/version.rb +1 -1
- metadata +31 -53
- data/lib/simplecov/jruby_fix.rb +0 -44
- data/lib/simplecov/railtie.rb +0 -9
- data/lib/simplecov/railties/tasks.rake +0 -13
- data/lib/simplecov/raw_coverage.rb +0 -41
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
|
-
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: 390d8182b24adbf82eaa93b222027107b09efc8f490ab2ea7db5dce03eeaf9b8
|
|
4
|
+
data.tar.gz: 7fad5ea78a2dc6a9a0e84caac8432db30cd475fcf6b08fe135aeee099bee46a7
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: e5e84c5ca4337bba395afb5ccb44923eaee46294c6116eb8ec15890b1f13500f5a56b117999e5aaacb89fcea1fa012133306d8943530c6e3b96976682511ac77
|
|
7
|
+
data.tar.gz: 4af3b7f1df63df9103989cb951efdca6cecf35c99c02176ad0b3b29aa42828b98e031ef683864bc3e00cf6f699da285b4c8eb6f39a68149832abdcd98943506a
|
data/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,114 @@
|
|
|
1
|
+
0.18.2 (2020-02-12)
|
|
2
|
+
===================
|
|
3
|
+
|
|
4
|
+
Small release just to allow you to use the new simplecov-html.
|
|
5
|
+
|
|
6
|
+
## Enhancements
|
|
7
|
+
* Relax simplecov-html requirement so that you're able to use [0.12.0](https://github.com/colszowka/simplecov-html/blob/master/CHANGELOG.md#0120-2020-02-12)
|
|
8
|
+
|
|
9
|
+
0.18.1 (2020-01-31)
|
|
10
|
+
===================
|
|
11
|
+
|
|
12
|
+
Small Bugfix release.
|
|
13
|
+
|
|
14
|
+
## Bugfixes
|
|
15
|
+
* Just putting `# :nocov:` on top of a file or having an uneven number of them in general works again and acts as if ignoring until the end of the file. See [#846](https://github.com/colszowka/simplecov/issues/846) and thanks [@DannyBen](https://github.com/DannyBen) for the report.
|
|
16
|
+
|
|
17
|
+
0.18.0 (2020-01-28)
|
|
18
|
+
===================
|
|
19
|
+
|
|
20
|
+
Huge release! Highlights are support for branch coverage (Ruby 2.5+) and dropping support for EOL'ed Ruby versions (< 2.4).
|
|
21
|
+
Please also read the other beta patch notes.
|
|
22
|
+
|
|
23
|
+
You can run with branch coverage by putting `enable_coverage :branch` into your SimpleCov configuration (like the `SimpleCov.start do .. end` block)
|
|
24
|
+
|
|
25
|
+
## Enhancements
|
|
26
|
+
* You can now define the minimum expected coverage by criterion like `minimum_coverage line: 90, branch: 80`
|
|
27
|
+
* Memoized some internal data structures that didn't change to reduce SimpleCov overhead
|
|
28
|
+
* Both `FileList` and `SourceFile` now have a `coverage` method that returns a hash that points from a coverage criterion to a `CoverageStatistics` object for uniform access to overall coverage statistics for both line and branch coverage
|
|
29
|
+
|
|
30
|
+
## Bugfixes
|
|
31
|
+
* we were losing precision by rounding the covered strength early, that has been removed. **For Formatters** this also means that you may need to round it yourself now.
|
|
32
|
+
* Removed an inconsistency in how we treat skipped vs. irrelevant lines (see [#565](https://github.com/colszowka/simplecov/issues/565)) - SimpleCov's definition of 100% is now "You covered everything that you could" so if coverage is 0/0 that's counted as a 100% no matter if the lines were irrelevant or ignored/skipped
|
|
33
|
+
|
|
34
|
+
## Noteworthy
|
|
35
|
+
* `FileList` stopped inheriting from Array, it includes Enumerable so if you didn't use Array specific methods on it in formatters you should be fine
|
|
36
|
+
* We needed to change an internal file format, which we use for merging across processes, to accommodate branch coverage. Sadly CodeClimate chose to use this file to report test coverage. Until a resolution is found the code climate test reporter won't work with SimpleCov for 0.18+, see [this issue on the test reporter](https://github.com/codeclimate/test-reporter/issues/413).
|
|
37
|
+
|
|
38
|
+
0.18.0.beta3 (2020-01-20)
|
|
39
|
+
========================
|
|
40
|
+
|
|
41
|
+
## Enhancements
|
|
42
|
+
* Instead of ignoring old `.resultset.json`s that are inside the merge timeout, adapt and respect them
|
|
43
|
+
|
|
44
|
+
## Bugfixes
|
|
45
|
+
* Remove the constant warning printing if you still have a `.resultset.json` in pre 0.18 layout that is within your merge timeout
|
|
46
|
+
|
|
47
|
+
0.18.0.beta2 (2020-01-19)
|
|
48
|
+
===================
|
|
49
|
+
|
|
50
|
+
## Enhancements
|
|
51
|
+
* only turn on the requested coverage criteria (when activating branch coverage before SimpleCov would also instruct Ruby to take Method coverage)
|
|
52
|
+
* Change how branch coverage is displayed, now it's `branch_type: hit_count` which should be more self explanatory. See [#830](https://github.com/colszowka/simplecov/pull/830) for an example and feel free to give feedback!
|
|
53
|
+
* Allow early running exit tasks and avoid the `at_exit` hook through the `SimpleCov.run_exit_tasks!` method. (thanks [@macumber](https://github.com/macumber))
|
|
54
|
+
* Allow manual collation of result sets through the `SimpleCov.collate` entrypoint. See the README for more details (thanks [@ticky](https://github.com/ticky))
|
|
55
|
+
* Within `case`, even if there is no `else` branch declared show missing coverage for it (aka no branch of it). See [#825](https://github.com/colszowka/simplecov/pull/825)
|
|
56
|
+
* Stop symbolizing all keys when loading cache (should lead to be faster and consume less memory)
|
|
57
|
+
* Cache whether we can use/are using branch coverage (should be slightly faster)
|
|
58
|
+
|
|
59
|
+
## Bugfixes
|
|
60
|
+
* Fix a crash that happened when an old version of our internal cache file `.resultset.json` was still present
|
|
61
|
+
|
|
62
|
+
0.18.0.beta1 (2020-01-05)
|
|
63
|
+
===================
|
|
64
|
+
|
|
65
|
+
This is a huge release highlighted by changing our support for ruby versions to 2.4+ (so things that aren't EOL'ed) and finally adding branch coverage support!
|
|
66
|
+
|
|
67
|
+
This release is still beta because we'd love for you to test out branch coverage and get your feedback before doing a full release.
|
|
68
|
+
|
|
69
|
+
On a personal note from [@PragTob](https://github.com/PragTob/) thanks to [ruby together](https://rubytogether.org/) for sponsoring this work on SimpleCov making it possible to deliver this and subsequent releases.
|
|
70
|
+
|
|
71
|
+
## Breaking
|
|
72
|
+
* Dropped support for all EOL'ed rubies meaning we only support 2.4+. Simplecov can no longer be installed on older rubies, but older simplecov releases should still work. (thanks [@deivid-rodriguez](https://github.com/deivid-rodriguez))
|
|
73
|
+
* Dropped the `rake simplecov` task that "magically" integreated with rails. It was always undocumented, caused some issues and [had some issues](https://github.com/colszowka/simplecov/issues/689#issuecomment-561572327). Use the integration as described in the README please :)
|
|
74
|
+
|
|
75
|
+
## Enhancements
|
|
76
|
+
|
|
77
|
+
* Branch coverage is here! Please try it out and test it! You can activate it with `enable_coverage :branch`. See the README for more details. This is thanks to a bunch of people most notably [@som4ik](https://github.com/som4ik), [@tycooon](https://github.com/tycooon), [@stepozer](https://github.com/stepozer), [@klyonrad](https://github.com/klyonrad) and your humble maintainers also contributed ;)
|
|
78
|
+
* If the minimum coverage is set to be greater than 100, a warning will be shown. See [#737](https://github.com/colszowka/simplecov/pull/737) (thanks [@belfazt](https://github.com/belfazt))
|
|
79
|
+
* Add a configuration option to disable the printing of non-successful exit statuses. See [#747](https://github.com/colszowka/simplecov/pull/746) (thanks [@JacobEvelyn](https://github.com/JacobEvelyn))
|
|
80
|
+
* Calculating 100% coverage is now stricter, so 100% means 100%. See [#680](https://github.com/colszowka/simplecov/pull/680) thanks [@gleseur](https://github.com/gleseur)
|
|
81
|
+
|
|
82
|
+
## Bugfixes
|
|
83
|
+
|
|
84
|
+
* Add new instance of `Minitest` constant. The `MiniTest` constant (with the capital T) will be removed in the next major release of Minitest. See [#757](https://github.com/colszowka/simplecov/pull/757) (thanks [@adam12](https://github.com/adam12))
|
|
85
|
+
|
|
86
|
+
0.17.1 (2019-09-16)
|
|
87
|
+
===================
|
|
88
|
+
|
|
89
|
+
Bugfix release for problems with ParallelTests.
|
|
90
|
+
|
|
91
|
+
## Bugfixes
|
|
92
|
+
|
|
93
|
+
* Avoid hanging with parallel_tests. See [#746](https://github.com/colszowka/simplecov/pull/746) (thanks [@annaswims](https://github.com/annaswims))
|
|
94
|
+
|
|
95
|
+
0.17.0 (2019-07-02)
|
|
96
|
+
===================
|
|
97
|
+
|
|
98
|
+
Maintenance release with nice convenience features and important bugfixes.
|
|
99
|
+
Notably this **will be the last release to support ruby versions that have reached their end of life**. Moving forward official CRuby support will be 2.4+ and JRuby support will be 9.2+. Older versions might still work but no guarantees.
|
|
100
|
+
|
|
101
|
+
## Enhancements
|
|
102
|
+
|
|
103
|
+
* Per default filter hidden files and folders. See [#721](https://github.com/colszowka/simplecov/pull/721) (thanks [Renuo AG](https://www.renuo.ch))
|
|
104
|
+
* Print the exit status explicitly when it's not a successful build so it's easier figure out SimpleCov failed the build in the output. See [#688](https://github.com/colszowka/simplecov/pull/688) (thanks [@daemonsy](https://github.com/daemonsy))
|
|
105
|
+
|
|
106
|
+
## Bugfixes
|
|
107
|
+
|
|
108
|
+
* Avoid a premature failure exit code when setting `minimum_coverage` in combination with using [parallel_tests](https://github.com/grosser/parallel_tests). See [#706](https://github.com/colszowka/simplecov/pull/706) (thanks [@f1sherman](https://github.com/f1sherman))
|
|
109
|
+
* Project roots with special characters no longer cause crashes. See [#717](https://github.com/colszowka/simplecov/pull/717) (thanks [@deivid-rodriguez](https://github.com/deivid-rodriguez))
|
|
110
|
+
* Avoid continously overriding test results with manual `ResultMergere.store_results` usage. See [#674](https://github.com/colszowka/simplecov/pull/674) (thanks [@tomeon](https://github.com/tomeon))
|
|
111
|
+
|
|
1
112
|
0.16.1 (2018-03-16)
|
|
2
113
|
===================
|
|
3
114
|
|
data/CODE_OF_CONDUCT.md
ADDED
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
# SimpleCov Code of Conduct
|
|
2
|
+
|
|
3
|
+
## Our Pledge
|
|
4
|
+
|
|
5
|
+
In the interest of fostering an open and welcoming environment, we as
|
|
6
|
+
contributors and maintainers pledge to making participation in our project and
|
|
7
|
+
our community a harassment-free experience for everyone, regardless of age, body
|
|
8
|
+
size, disability, ethnicity, sex characteristics, gender identity and expression,
|
|
9
|
+
level of experience, education, socio-economic status, nationality, personal
|
|
10
|
+
appearance, race, religion, or sexual identity and orientation.
|
|
11
|
+
|
|
12
|
+
## Our Standards
|
|
13
|
+
|
|
14
|
+
Examples of behavior that contributes to creating a positive environment
|
|
15
|
+
include:
|
|
16
|
+
|
|
17
|
+
* Using welcoming and inclusive language
|
|
18
|
+
* Being respectful of differing viewpoints and experiences
|
|
19
|
+
* Gracefully accepting constructive criticism
|
|
20
|
+
* Focusing on what is best for the community
|
|
21
|
+
* Showing empathy towards other community members
|
|
22
|
+
|
|
23
|
+
Examples of unacceptable behavior by participants include:
|
|
24
|
+
|
|
25
|
+
* The use of sexualized language or imagery and unwelcome sexual attention or
|
|
26
|
+
advances
|
|
27
|
+
* Trolling, insulting/derogatory comments, and personal or political attacks
|
|
28
|
+
* Public or private harassment
|
|
29
|
+
* Publishing others' private information, such as a physical or electronic
|
|
30
|
+
address, without explicit permission
|
|
31
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
|
32
|
+
professional setting
|
|
33
|
+
|
|
34
|
+
## Our Responsibilities
|
|
35
|
+
|
|
36
|
+
Project maintainers are responsible for clarifying the standards of acceptable
|
|
37
|
+
behavior and are expected to take appropriate and fair corrective action in
|
|
38
|
+
response to any instances of unacceptable behavior.
|
|
39
|
+
|
|
40
|
+
Project maintainers have the right and responsibility to remove, edit, or
|
|
41
|
+
reject comments, commits, code, wiki edits, issues, and other contributions
|
|
42
|
+
that are not aligned to this Code of Conduct, or to ban temporarily or
|
|
43
|
+
permanently any contributor for other behaviors that they deem inappropriate,
|
|
44
|
+
threatening, offensive, or harmful.
|
|
45
|
+
|
|
46
|
+
## Scope
|
|
47
|
+
|
|
48
|
+
This Code of Conduct applies both within project spaces and in public spaces
|
|
49
|
+
when an individual is representing the project or its community. Examples of
|
|
50
|
+
representing a project or community include using an official project e-mail
|
|
51
|
+
address, posting via an official social media account, or acting as an appointed
|
|
52
|
+
representative at an online or offline event. Representation of a project may be
|
|
53
|
+
further defined and clarified by project maintainers.
|
|
54
|
+
|
|
55
|
+
## Enforcement
|
|
56
|
+
|
|
57
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
58
|
+
reported by contacting the project team at simplecov.team@gmail.com. All
|
|
59
|
+
complaints will be reviewed and investigated and will result in a response that
|
|
60
|
+
is deemed necessary and appropriate to the circumstances. The project team is
|
|
61
|
+
obligated to maintain confidentiality with regard to the reporter of an incident.
|
|
62
|
+
Further details of specific enforcement policies may be posted separately.
|
|
63
|
+
|
|
64
|
+
Project maintainers who do not follow or enforce the Code of Conduct in good
|
|
65
|
+
faith may face temporary or permanent repercussions as determined by other
|
|
66
|
+
members of the project's leadership.
|
|
67
|
+
|
|
68
|
+
## Attribution
|
|
69
|
+
|
|
70
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
|
71
|
+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
|
|
72
|
+
|
|
73
|
+
[homepage]: https://www.contributor-covenant.org
|
|
74
|
+
|
|
75
|
+
For answers to common questions about this code of conduct, see
|
|
76
|
+
https://www.contributor-covenant.org/faq
|
data/README.md
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
|
-
SimpleCov [](https://badge.fury.io/rb/simplecov) [][Continuous Integration] [](https://codeclimate.com/github/colszowka/simplecov) [](http://inch-ci.org/github/colszowka/simplecov)
|
|
2
2
|
=========
|
|
3
|
+
|
|
3
4
|
**Code coverage for Ruby**
|
|
4
5
|
|
|
5
6
|
* [Source Code]
|
|
@@ -8,13 +9,13 @@ SimpleCov [][Conti
|
|
|
8
9
|
* [Rubygem]
|
|
9
10
|
* [Continuous Integration]
|
|
10
11
|
|
|
11
|
-
[Coverage]:
|
|
12
|
+
[Coverage]: https://ruby-doc.org/stdlib/libdoc/coverage/rdoc/Coverage.html "API doc for Ruby's Coverage library"
|
|
12
13
|
[Source Code]: https://github.com/colszowka/simplecov "Source Code @ GitHub"
|
|
13
14
|
[API documentation]: http://rubydoc.info/gems/simplecov/frames "RDoc API Documentation at Rubydoc.info"
|
|
14
15
|
[Configuration]: http://rubydoc.info/gems/simplecov/SimpleCov/Configuration "Configuration options API documentation"
|
|
15
16
|
[Changelog]: https://github.com/colszowka/simplecov/blob/master/CHANGELOG.md "Project Changelog"
|
|
16
17
|
[Rubygem]: http://rubygems.org/gems/simplecov "SimpleCov @ rubygems.org"
|
|
17
|
-
[Continuous Integration]:
|
|
18
|
+
[Continuous Integration]: https://github.com/colszowka/simplecov/actions?query=workflow%3Astable "SimpleCov is built around the clock by github.com"
|
|
18
19
|
[Dependencies]: https://gemnasium.com/colszowka/simplecov "SimpleCov dependencies on Gemnasium"
|
|
19
20
|
[simplecov-html]: https://github.com/colszowka/simplecov-html "SimpleCov HTML Formatter Source Code @ GitHub"
|
|
20
21
|
|
|
@@ -22,13 +23,14 @@ SimpleCov is a code coverage analysis tool for Ruby. It uses [Ruby's built-in Co
|
|
|
22
23
|
coverage data, but makes processing its results much easier by providing a clean API to filter, group, merge, format,
|
|
23
24
|
and display those results, giving you a complete code coverage suite that can be set up with just a couple lines of
|
|
24
25
|
code.
|
|
26
|
+
SimpleCov/Coverage track covered ruby code, gathering coverage for common templating solutions like erb, slim and haml is not supported.
|
|
25
27
|
|
|
26
28
|
In most cases, you'll want overall coverage results for your projects, including all types of tests, Cucumber features,
|
|
27
29
|
etc. SimpleCov automatically takes care of this by caching and merging results when generating reports, so your
|
|
28
30
|
report actually includes coverage across your test suites and thereby gives you a better picture of blank spots.
|
|
29
31
|
|
|
30
|
-
The official formatter of SimpleCov is packaged as a separate gem called [simplecov-html], but will be installed and
|
|
31
|
-
automatically when you launch SimpleCov. If you're curious, you can find it [on GitHub, too][simplecov-html].
|
|
32
|
+
The official formatter of SimpleCov is packaged as a separate gem called [simplecov-html], but will be installed and
|
|
33
|
+
configured automatically when you launch SimpleCov. If you're curious, you can find it [on GitHub, too][simplecov-html].
|
|
32
34
|
|
|
33
35
|
|
|
34
36
|
## Contact
|
|
@@ -36,11 +38,13 @@ automatically when you launch SimpleCov. If you're curious, you can find it [on
|
|
|
36
38
|
*Code and Bug Reports*
|
|
37
39
|
|
|
38
40
|
* [Issue Tracker](https://github.com/colszowka/simplecov/issues)
|
|
39
|
-
* See [CONTRIBUTING](https://github.com/colszowka/simplecov/blob/master/CONTRIBUTING.md) for how to contribute along
|
|
41
|
+
* See [CONTRIBUTING](https://github.com/colszowka/simplecov/blob/master/CONTRIBUTING.md) for how to contribute along
|
|
42
|
+
with some common problems to check out before creating an issue.
|
|
40
43
|
|
|
41
44
|
*Questions, Problems, Suggestions, etc.*
|
|
42
45
|
|
|
43
|
-
* [Mailing List](https://groups.google.com/forum/#!forum/simplecov) "Open mailing list for discussion and announcements
|
|
46
|
+
* [Mailing List](https://groups.google.com/forum/#!forum/simplecov) "Open mailing list for discussion and announcements
|
|
47
|
+
on Google Groups"
|
|
44
48
|
|
|
45
49
|
Getting started
|
|
46
50
|
---------------
|
|
@@ -70,8 +74,8 @@ Getting started
|
|
|
70
74
|
endpoint) via a separate test process (e.g. when using Selenium) where you
|
|
71
75
|
want to see all code executed by the `rails server`, and not just code
|
|
72
76
|
executed in your actual test files, you'll want to add something like this
|
|
73
|
-
to the top of `
|
|
74
|
-
|
|
77
|
+
to the top of `bin/rails`, but below the "shebang" line (`#! /usr/bin/env
|
|
78
|
+
ruby`):
|
|
75
79
|
|
|
76
80
|
```ruby
|
|
77
81
|
if ENV['RAILS_ENV'] == 'test'
|
|
@@ -81,23 +85,41 @@ Getting started
|
|
|
81
85
|
end
|
|
82
86
|
```
|
|
83
87
|
|
|
84
|
-
3. Run your
|
|
85
|
-
|
|
86
|
-
|
|
88
|
+
3. Run your full test suite to see the percent coverage that your application has.
|
|
89
|
+
4. After running your tests, open `coverage/index.html` in the browser of your choice. For example, in a Mac Terminal,
|
|
90
|
+
run the following command from your application's root directory:
|
|
91
|
+
|
|
92
|
+
```
|
|
93
|
+
open coverage/index.html
|
|
94
|
+
```
|
|
95
|
+
in a debian/ubuntu Terminal,
|
|
96
|
+
|
|
97
|
+
```
|
|
98
|
+
xdg-open coverage/index.html
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
**Note:** [This guide](https://dwheeler.com/essays/open-files-urls.html) can help if you're unsure which command your particular
|
|
102
|
+
operating system requires.
|
|
103
|
+
|
|
104
|
+
5. Add the following to your `.gitignore` file to ensure that coverage results
|
|
87
105
|
are not tracked by Git (optional):
|
|
88
106
|
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
107
|
+
```
|
|
108
|
+
echo "coverage" >> .gitignore
|
|
109
|
+
```
|
|
110
|
+
Or if you use Windows:
|
|
111
|
+
```
|
|
112
|
+
echo coverage >> .gitignore
|
|
113
|
+
```
|
|
92
114
|
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
115
|
+
If you're making a Rails application, SimpleCov comes with built-in configurations (see below for information on
|
|
116
|
+
profiles) that will get you started with groups for your Controllers, Models and Helpers. To use it, the
|
|
117
|
+
first two lines of your test_helper should be like this:
|
|
96
118
|
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
119
|
+
```ruby
|
|
120
|
+
require 'simplecov'
|
|
121
|
+
SimpleCov.start 'rails'
|
|
122
|
+
```
|
|
101
123
|
|
|
102
124
|
## Example output
|
|
103
125
|
|
|
@@ -123,8 +145,9 @@ require 'simplecov'
|
|
|
123
145
|
SimpleCov.start 'rails'
|
|
124
146
|
```
|
|
125
147
|
|
|
126
|
-
You could even track what kind of code your UI testers are touching if you want to go overboard with things. SimpleCov
|
|
127
|
-
care what kind of framework it is running in; it just looks at what code is being executed and generates a
|
|
148
|
+
You could even track what kind of code your UI testers are touching if you want to go overboard with things. SimpleCov
|
|
149
|
+
does not care what kind of framework it is running in; it just looks at what code is being executed and generates a
|
|
150
|
+
report about it.
|
|
128
151
|
|
|
129
152
|
### Notes on specific frameworks and test utilities
|
|
130
153
|
|
|
@@ -135,28 +158,28 @@ to use SimpleCov with them. Here's an overview of the known ones:
|
|
|
135
158
|
<tr><th>Framework</th><th>Notes</th><th>Issue</th></tr>
|
|
136
159
|
<tr>
|
|
137
160
|
<th>
|
|
138
|
-
|
|
161
|
+
parallel_tests
|
|
139
162
|
</th>
|
|
140
163
|
<td>
|
|
141
|
-
|
|
164
|
+
As of 0.8.0, SimpleCov should correctly recognize parallel_tests and
|
|
165
|
+
supplement your test suite names with their corresponding test env
|
|
166
|
+
numbers. SimpleCov locks the resultset cache while merging, ensuring no
|
|
167
|
+
race conditions occur when results are merged.
|
|
142
168
|
</td>
|
|
143
169
|
<td>
|
|
144
|
-
<a href="https://github.com/
|
|
170
|
+
<a href="https://github.com/colszowka/simplecov/issues/64">#64</a> &
|
|
171
|
+
<a href="https://github.com/colszowka/simplecov/pull/185">#185</a>
|
|
145
172
|
</td>
|
|
146
173
|
</tr>
|
|
147
174
|
<tr>
|
|
148
175
|
<th>
|
|
149
|
-
|
|
176
|
+
knapsack_pro
|
|
150
177
|
</th>
|
|
151
178
|
<td>
|
|
152
|
-
|
|
153
|
-
supplement your test suite names with their corresponding test env
|
|
154
|
-
numbers. SimpleCov locks the resultset cache while merging, ensuring no
|
|
155
|
-
race conditions occur when results are merged.
|
|
179
|
+
To make SimpleCov work with Knapsack Pro Queue Mode to split tests in parallel on CI jobs you need to provide CI node index number to the <code>SimpleCov.command_name</code> in <code>KnapsackPro::Hooks::Queue.before_queue</code> hook.
|
|
156
180
|
</td>
|
|
157
181
|
<td>
|
|
158
|
-
<a href="https://
|
|
159
|
-
<a href="https://github.com/colszowka/simplecov/pull/185">#185</a>
|
|
182
|
+
<a href="https://knapsackpro.com/faq/question/how-to-use-simplecov-in-queue-mode">Tip</a>
|
|
160
183
|
</td>
|
|
161
184
|
</tr>
|
|
162
185
|
<tr>
|
|
@@ -230,7 +253,8 @@ to use SimpleCov with them. Here's an overview of the known ones:
|
|
|
230
253
|
```ruby
|
|
231
254
|
SimpleCov.some_config_option 'foo'
|
|
232
255
|
```
|
|
233
|
-
* If you do not want to start coverage immediately after launch or want to add additional configuration later on in a
|
|
256
|
+
* If you do not want to start coverage immediately after launch or want to add additional configuration later on in a
|
|
257
|
+
concise way, use:
|
|
234
258
|
|
|
235
259
|
```ruby
|
|
236
260
|
SimpleCov.configure do
|
|
@@ -242,11 +266,12 @@ Please check out the [Configuration] API documentation to find out what you can
|
|
|
242
266
|
|
|
243
267
|
## Using .simplecov for centralized config
|
|
244
268
|
|
|
245
|
-
If you use SimpleCov to merge multiple test suite results (e.g. Test/Unit and Cucumber) into a single report, you'd
|
|
246
|
-
set up all your config options twice, once in `test_helper.rb` and once in `env.rb`.
|
|
269
|
+
If you use SimpleCov to merge multiple test suite results (e.g. Test/Unit and Cucumber) into a single report, you'd
|
|
270
|
+
normally have to set up all your config options twice, once in `test_helper.rb` and once in `env.rb`.
|
|
247
271
|
|
|
248
|
-
To avoid this, you can place a file called `.simplecov` in your project root. You can then just leave the
|
|
249
|
-
test setup helper (**at the top**) and move the `SimpleCov.start` code with all your
|
|
272
|
+
To avoid this, you can place a file called `.simplecov` in your project root. You can then just leave the
|
|
273
|
+
`require 'simplecov'` in each test setup helper (**at the top**) and move the `SimpleCov.start` code with all your
|
|
274
|
+
custom config options into `.simplecov`:
|
|
250
275
|
|
|
251
276
|
```ruby
|
|
252
277
|
# test/test_helper.rb
|
|
@@ -261,21 +286,73 @@ SimpleCov.start 'rails' do
|
|
|
261
286
|
end
|
|
262
287
|
```
|
|
263
288
|
|
|
264
|
-
Using `.simplecov` rather than separately requiring SimpleCov multiple times is recommended if you are merging multiple
|
|
289
|
+
Using `.simplecov` rather than separately requiring SimpleCov multiple times is recommended if you are merging multiple
|
|
290
|
+
test frameworks like Cucumber and RSpec that rely on each other, as invoking SimpleCov multiple times can cause coverage
|
|
291
|
+
information to be lost.
|
|
292
|
+
|
|
293
|
+
## Branch coverage (ruby "~> 2.5")
|
|
294
|
+
Add branch coverage measurement statistics to your results. Supported in CRuby versions 2.5+.
|
|
295
|
+
|
|
296
|
+
```ruby
|
|
297
|
+
# or in configure or just SimpleCov.enable_coverage :branch
|
|
298
|
+
SimpleCov.start do
|
|
299
|
+
enable_coverage :branch
|
|
300
|
+
end
|
|
301
|
+
```
|
|
302
|
+
|
|
303
|
+
Branch coverage is a feature introduced in Ruby 2.5 concerning itself with whether a
|
|
304
|
+
particular branch of a condition had been executed. Line coverage on the other hand
|
|
305
|
+
is only interested in whether a line of code has been executed.
|
|
306
|
+
|
|
307
|
+
This comes in handy for instance for one line conditionals:
|
|
308
|
+
|
|
309
|
+
```ruby
|
|
310
|
+
number.odd? ? "odd" : "even"
|
|
311
|
+
```
|
|
312
|
+
|
|
313
|
+
In line coverage this line would always be marked as executed but you'd never know if both
|
|
314
|
+
conditions were met. Guard clauses have a similar story:
|
|
315
|
+
|
|
316
|
+
```ruby
|
|
317
|
+
return if number.odd?
|
|
318
|
+
|
|
319
|
+
# more code
|
|
320
|
+
```
|
|
321
|
+
|
|
322
|
+
If all the code in that method was covered you'd never know if the guard clause was ever
|
|
323
|
+
triggered! With line coverage as just evaluating the condition marks it as covered.
|
|
324
|
+
|
|
325
|
+
In the HTML report the lines of code will be annotated like `branch_type: hit_count`:
|
|
326
|
+
|
|
327
|
+
* `then: 2` - the then branch (of an `if`) was executed twice
|
|
328
|
+
* `else: 0` - the else branch (of an `if` or `case`) was never executed
|
|
329
|
+
|
|
330
|
+
Not that even if you don't declare an `else` branch it will still show up in the coverage
|
|
331
|
+
reports meaning that the condition of the `if` was not hit or that no `when` of `case`
|
|
332
|
+
was hit during the test runs.
|
|
333
|
+
|
|
334
|
+
**Is branch coverage strictly better?** No. Branch coverage really only concerns itself with
|
|
335
|
+
conditionals - meaning coverage of sequential code is of no interest to it. A file without
|
|
336
|
+
conditional logic will have no branch coverage data and SimpleCov will report 0 of 0
|
|
337
|
+
branches covered as 100% (as everything that can be covered was covered).
|
|
338
|
+
|
|
339
|
+
Hence, we recommend looking at both metrics together. Branch coverage might also be a good
|
|
340
|
+
overall metric to look at - while you might be missing only 10% of your lines that might
|
|
341
|
+
account for 50% of your branches for instance.
|
|
265
342
|
|
|
266
343
|
## Filters
|
|
267
344
|
|
|
268
|
-
Filters can be used to remove selected files from your coverage data. By default, a filter is applied that removes all
|
|
269
|
-
OUTSIDE of your project's root directory - otherwise you'd end up with billions of coverage reports for source
|
|
270
|
-
gems you are using.
|
|
345
|
+
Filters can be used to remove selected files from your coverage data. By default, a filter is applied that removes all
|
|
346
|
+
files OUTSIDE of your project's root directory - otherwise you'd end up with billions of coverage reports for source
|
|
347
|
+
files in the gems you are using.
|
|
271
348
|
|
|
272
349
|
You can define your own to remove things like configuration files, tests or whatever you don't need in your coverage
|
|
273
350
|
report.
|
|
274
351
|
|
|
275
352
|
### Defining custom filters
|
|
276
353
|
|
|
277
|
-
You can currently define a filter using either a String or Regexp (that will then be Regexp-matched against each source
|
|
278
|
-
a block or by passing in your own Filter class.
|
|
354
|
+
You can currently define a filter using either a String or Regexp (that will then be Regexp-matched against each source
|
|
355
|
+
file's path), a block or by passing in your own Filter class.
|
|
279
356
|
|
|
280
357
|
#### String filter
|
|
281
358
|
|
|
@@ -307,9 +384,10 @@ SimpleCov.start do
|
|
|
307
384
|
end
|
|
308
385
|
```
|
|
309
386
|
|
|
310
|
-
Block filters receive a SimpleCov::SourceFile instance and expect your block to return either true (if the file is to be
|
|
311
|
-
from the result) or false (if the result should be kept). Please check out the RDoc for SimpleCov::SourceFile to
|
|
312
|
-
methods available to you. In the above example, the filter will remove all files that have less than 5
|
|
387
|
+
Block filters receive a SimpleCov::SourceFile instance and expect your block to return either true (if the file is to be
|
|
388
|
+
removed from the result) or false (if the result should be kept). Please check out the RDoc for SimpleCov::SourceFile to
|
|
389
|
+
learn about the methods available to you. In the above example, the filter will remove all files that have less than 5
|
|
390
|
+
lines of code.
|
|
313
391
|
|
|
314
392
|
#### Custom filter class
|
|
315
393
|
|
|
@@ -323,9 +401,10 @@ end
|
|
|
323
401
|
SimpleCov.add_filter LineFilter.new(5)
|
|
324
402
|
```
|
|
325
403
|
|
|
326
|
-
Defining your own filters is pretty easy: Just inherit from SimpleCov::Filter and define a method
|
|
327
|
-
the filter, a true return value from this method will result in the removal of the
|
|
328
|
-
is being set in the SimpleCov::Filter initialize method and thus is set to
|
|
404
|
+
Defining your own filters is pretty easy: Just inherit from SimpleCov::Filter and define a method
|
|
405
|
+
'matches?(source_file)'. When running the filter, a true return value from this method will result in the removal of the
|
|
406
|
+
given source_file. The filter_argument method is being set in the SimpleCov::Filter initialize method and thus is set to
|
|
407
|
+
5 in this example.
|
|
329
408
|
|
|
330
409
|
#### Array filter
|
|
331
410
|
|
|
@@ -352,7 +431,9 @@ end
|
|
|
352
431
|
|
|
353
432
|
The name of the token can be changed to your liking. [Learn more about the nocov feature.]( https://github.com/colszowka/simplecov/blob/master/features/config_nocov_token.feature)
|
|
354
433
|
|
|
355
|
-
**Note:** You shouldn't have to use the nocov token to skip private methods that are being included in your coverage. If
|
|
434
|
+
**Note:** You shouldn't have to use the nocov token to skip private methods that are being included in your coverage. If
|
|
435
|
+
you appropriately test the public interface of your classes and objects you should automatically get full coverage of
|
|
436
|
+
your private methods.
|
|
356
437
|
|
|
357
438
|
## Default root filter and coverage for things outside of it
|
|
358
439
|
|
|
@@ -375,8 +456,8 @@ end
|
|
|
375
456
|
|
|
376
457
|
You can separate your source files into groups. For example, in a Rails app, you'll want to have separate listings for
|
|
377
458
|
Models, Controllers, Helpers, and Libs. Group definition works similarly to Filters (and also accepts custom
|
|
378
|
-
filter classes), but source files end up in a group when the filter passes (returns true), as opposed to filtering
|
|
379
|
-
which exclude files from results when the filter results in a true value.
|
|
459
|
+
filter classes), but source files end up in a group when the filter passes (returns true), as opposed to filtering
|
|
460
|
+
results, which exclude files from results when the filter results in a true value.
|
|
380
461
|
|
|
381
462
|
Add your groups with:
|
|
382
463
|
|
|
@@ -396,12 +477,11 @@ end
|
|
|
396
477
|
|
|
397
478
|
You normally want to have your coverage analyzed across ALL of your test suites, right?
|
|
398
479
|
|
|
399
|
-
Simplecov automatically caches coverage results in your
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
There are two things to note here though:
|
|
480
|
+
Simplecov automatically caches coverage results in your
|
|
481
|
+
(coverage_path)/.resultset.json, and will merge or override those with
|
|
482
|
+
subsequent runs, depending on whether simplecov considers those subsequent runs
|
|
483
|
+
as different test suites or as the same test suite as the cached results. To
|
|
484
|
+
make this distinction, simplecov has the concept of "test suite names".
|
|
405
485
|
|
|
406
486
|
### Test suite names
|
|
407
487
|
|
|
@@ -455,24 +535,96 @@ SimpleCov.command_name "features" + (ENV['TEST_ENV_NUMBER'] || '')
|
|
|
455
535
|
|
|
456
536
|
[simplecov-html] prints the used test suites in the footer of the generated coverage report.
|
|
457
537
|
|
|
458
|
-
### Timeout for merge
|
|
459
538
|
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
539
|
+
### Merging test runs under the same execution environment
|
|
540
|
+
|
|
541
|
+
Test results are automatically merged with previous runs in the same execution
|
|
542
|
+
environment when generating the result, so when coverage is set up properly for
|
|
543
|
+
Cucumber and your unit / functional / integration tests, all of those test
|
|
544
|
+
suites will be taken into account when building the coverage report.
|
|
545
|
+
|
|
546
|
+
#### Timeout for merge
|
|
547
|
+
|
|
548
|
+
Of course, your cached coverage data is likely to become invalid at some point. Thus, when automatically merging
|
|
549
|
+
subsequent test runs, result sets that are older than `SimpleCov.merge_timeout` will not be used any more. By default,
|
|
550
|
+
the timeout is 600 seconds (10 minutes), and you can raise (or lower) it by specifying `SimpleCov.merge_timeout 3600`
|
|
551
|
+
(1 hour), or, inside a configure/start block, with just `merge_timeout 3600`.
|
|
552
|
+
|
|
553
|
+
You can deactivate this automatic merging altogether with `SimpleCov.use_merging false`.
|
|
554
|
+
|
|
555
|
+
### Merging test runs under different execution environments
|
|
556
|
+
|
|
557
|
+
If your tests are done in parallel across multiple build machines, you can fetch them all and merge them into a single
|
|
558
|
+
result set using the `SimpleCov.collate` method. This can be added to a Rakefile or script file, having downloaded a set of
|
|
559
|
+
`.resultset.json` files from each parallel test run.
|
|
560
|
+
|
|
561
|
+
```ruby
|
|
562
|
+
# lib/tasks/coverage_report.rake
|
|
563
|
+
namespace :coverage do
|
|
564
|
+
desc "Collates all result sets generated by the different test runners"
|
|
565
|
+
task :report do
|
|
566
|
+
require 'simplecov'
|
|
567
|
+
|
|
568
|
+
SimpleCov.collate Dir["simplecov-resultset-*/.resultset.json"]
|
|
569
|
+
end
|
|
570
|
+
end
|
|
571
|
+
```
|
|
572
|
+
|
|
573
|
+
`SimpleCov.collate` also takes an optional simplecov profile and an optional
|
|
574
|
+
block for configuration, just the same as `SimpleCov.start` or
|
|
575
|
+
`SimpleCov.configure`. This means you can configure a separate formatter for
|
|
576
|
+
the collated output. For instance, you can make the formatter in
|
|
577
|
+
`SimpleCov.start` the `SimpleCov::Formatter::SimpleFormatter`, and only use more
|
|
578
|
+
complex formatters in the final `SimpleCov.collate` run.
|
|
464
579
|
|
|
465
|
-
|
|
580
|
+
```ruby
|
|
581
|
+
# spec/spec_helper.rb
|
|
582
|
+
require 'simplecov'
|
|
583
|
+
|
|
584
|
+
SimpleCov.start 'rails' do
|
|
585
|
+
# Disambiguates individual test runs
|
|
586
|
+
command_name "Job #{ENV["TEST_ENV_NUMBER"]}" if ENV["TEST_ENV_NUMBER"]
|
|
587
|
+
|
|
588
|
+
if ENV['CI']
|
|
589
|
+
formatter SimpleCov::Formatter::SimpleFormatter
|
|
590
|
+
else
|
|
591
|
+
formatter SimpleCov::Formatter::MultiFormatter.new([
|
|
592
|
+
SimpleCov::Formatter::SimpleFormatter,
|
|
593
|
+
SimpleCov::Formatter::HTMLFormatter
|
|
594
|
+
])
|
|
595
|
+
end
|
|
596
|
+
|
|
597
|
+
track_files "**/*.rb"
|
|
598
|
+
end
|
|
599
|
+
```
|
|
600
|
+
|
|
601
|
+
```ruby
|
|
602
|
+
# lib/tasks/coverage_report.rake
|
|
603
|
+
namespace :coverage do
|
|
604
|
+
task :report do
|
|
605
|
+
require 'simplecov'
|
|
606
|
+
|
|
607
|
+
SimpleCov.collate Dir["simplecov-resultset-*/.resultset.json"], 'rails' do
|
|
608
|
+
formatter SimpleCov::Formatter::MultiFormatter.new([
|
|
609
|
+
SimpleCov::Formatter::SimpleFormatter,
|
|
610
|
+
SimpleCov::Formatter::HTMLFormatter
|
|
611
|
+
])
|
|
612
|
+
end
|
|
613
|
+
end
|
|
614
|
+
end
|
|
615
|
+
```
|
|
466
616
|
|
|
467
617
|
## Running coverage only on demand
|
|
468
618
|
|
|
469
|
-
The Ruby STDLIB Coverage library that SimpleCov builds upon is *very* fast (on a ~10 min Rails test suite, the speed
|
|
470
|
-
only a couple seconds for me), and therefore it's SimpleCov's policy to just generate coverage every time you
|
|
471
|
-
it doesn't do your test speed any harm and you're always equipped with the latest and greatest
|
|
619
|
+
The Ruby STDLIB Coverage library that SimpleCov builds upon is *very* fast (on a ~10 min Rails test suite, the speed
|
|
620
|
+
drop was only a couple seconds for me), and therefore it's SimpleCov's policy to just generate coverage every time you
|
|
621
|
+
run your tests because it doesn't do your test speed any harm and you're always equipped with the latest and greatest
|
|
622
|
+
coverage results.
|
|
472
623
|
|
|
473
624
|
Because of this, SimpleCov has no explicit built-in mechanism to run coverage only on demand.
|
|
474
625
|
|
|
475
|
-
However, you can still accomplish this very easily by introducing an ENV variable conditional into your SimpleCov setup
|
|
626
|
+
However, you can still accomplish this very easily by introducing an ENV variable conditional into your SimpleCov setup
|
|
627
|
+
block, like this:
|
|
476
628
|
|
|
477
629
|
```ruby
|
|
478
630
|
SimpleCov.start if ENV["COVERAGE"]
|
|
@@ -484,6 +636,21 @@ Then, SimpleCov will only run if you execute your tests like this:
|
|
|
484
636
|
COVERAGE=true rake test
|
|
485
637
|
```
|
|
486
638
|
|
|
639
|
+
## Errors and exit statuses
|
|
640
|
+
|
|
641
|
+
To aid in debugging issues, if an error is raised, SimpleCov will print a message to `STDERR`
|
|
642
|
+
with the exit status of the error, like:
|
|
643
|
+
|
|
644
|
+
```
|
|
645
|
+
SimpleCov failed with exit 1
|
|
646
|
+
```
|
|
647
|
+
|
|
648
|
+
This `STDERR` message can be disabled with:
|
|
649
|
+
|
|
650
|
+
```
|
|
651
|
+
SimpleCov.print_error_status = false
|
|
652
|
+
```
|
|
653
|
+
|
|
487
654
|
## Profiles
|
|
488
655
|
|
|
489
656
|
By default, SimpleCov's only config assumption is that you only want coverage reports for files inside your project
|
|
@@ -521,8 +688,8 @@ end
|
|
|
521
688
|
|
|
522
689
|
### Custom profiles
|
|
523
690
|
|
|
524
|
-
You can load additional profiles with the SimpleCov.load_profile('xyz') method. This allows you to build upon an
|
|
525
|
-
profile and customize it so you can reuse it in unit tests and Cucumber features. For example:
|
|
691
|
+
You can load additional profiles with the SimpleCov.load_profile('xyz') method. This allows you to build upon an
|
|
692
|
+
existing profile and customize it so you can reuse it in unit tests and Cucumber features. For example:
|
|
526
693
|
|
|
527
694
|
```ruby
|
|
528
695
|
# lib/simplecov_custom_profile.rb
|
|
@@ -559,16 +726,23 @@ You can define the minimum coverage percentage expected. SimpleCov will return n
|
|
|
559
726
|
|
|
560
727
|
```ruby
|
|
561
728
|
SimpleCov.minimum_coverage 90
|
|
729
|
+
# same as above (the default is to check line coverage)
|
|
730
|
+
SimpleCov.minimum_coverage line: 90
|
|
731
|
+
# check for a minimum line coverage of 90% and minimum 80% branch coverage
|
|
732
|
+
SimpleCov.minimum_coverage line: 90, branch: 80
|
|
562
733
|
```
|
|
563
734
|
|
|
564
735
|
### Minimum coverage by file
|
|
565
736
|
|
|
566
|
-
You can define the minimum coverage by file percentage expected. SimpleCov will return non-zero if unmet. This is useful
|
|
737
|
+
You can define the minimum coverage by file percentage expected. SimpleCov will return non-zero if unmet. This is useful
|
|
738
|
+
to help ensure coverage is relatively consistent, rather than being skewed by particularly good or bad areas of the code.
|
|
567
739
|
|
|
568
740
|
```ruby
|
|
569
741
|
SimpleCov.minimum_coverage_by_file 80
|
|
570
742
|
```
|
|
571
743
|
|
|
744
|
+
(not yet supported for branch coverage)
|
|
745
|
+
|
|
572
746
|
### Maximum coverage drop
|
|
573
747
|
|
|
574
748
|
You can define the maximum coverage drop percentage at once. SimpleCov will return non-zero if exceeded.
|
|
@@ -577,6 +751,8 @@ You can define the maximum coverage drop percentage at once. SimpleCov will retu
|
|
|
577
751
|
SimpleCov.maximum_coverage_drop 5
|
|
578
752
|
```
|
|
579
753
|
|
|
754
|
+
(not yet supported for branch coverage)
|
|
755
|
+
|
|
580
756
|
### Refuse dropping coverage
|
|
581
757
|
|
|
582
758
|
You can also entirely refuse dropping coverage between test runs:
|
|
@@ -585,6 +761,8 @@ You can also entirely refuse dropping coverage between test runs:
|
|
|
585
761
|
SimpleCov.refuse_coverage_drop
|
|
586
762
|
```
|
|
587
763
|
|
|
764
|
+
(not yet supported for branch coverage)
|
|
765
|
+
|
|
588
766
|
## Using your own formatter
|
|
589
767
|
|
|
590
768
|
You can use your own formatter with:
|
|
@@ -593,8 +771,8 @@ You can use your own formatter with:
|
|
|
593
771
|
SimpleCov.formatter = SimpleCov::Formatter::HTMLFormatter
|
|
594
772
|
```
|
|
595
773
|
|
|
596
|
-
When calling SimpleCov.result.format!, it will be invoked with SimpleCov::Formatter::YourFormatter.new.format(result),
|
|
597
|
-
being an instance of SimpleCov::Result. Do whatever your wish with that!
|
|
774
|
+
When calling SimpleCov.result.format!, it will be invoked with SimpleCov::Formatter::YourFormatter.new.format(result),
|
|
775
|
+
"result" being an instance of SimpleCov::Result. Do whatever your wish with that!
|
|
598
776
|
|
|
599
777
|
|
|
600
778
|
## Using multiple formatters
|
|
@@ -616,11 +794,9 @@ SimpleCov.formatters = SimpleCov::Formatter::MultiFormatter.new([
|
|
|
616
794
|
|
|
617
795
|
## Ruby version compatibility
|
|
618
796
|
|
|
619
|
-
|
|
620
|
-
SimpleCov is also built against Ruby 1.8 in [Continuous Integration], but this happens only to ensure that SimpleCov
|
|
621
|
-
does not make your test suite crash right now.
|
|
797
|
+
SimpleCov is built in [Continuous Integration] on Ruby 2.4+ as well as JRuby 9.2+.
|
|
622
798
|
|
|
623
|
-
|
|
799
|
+
Note for JRuby => You need to pass JRUBY_OPTS="--debug" or create .jrubyrc and add debug.fullTrace=true
|
|
624
800
|
|
|
625
801
|
## Want to find dead code in production?
|
|
626
802
|
|
|
@@ -628,48 +804,36 @@ Try [Coverband](https://github.com/danmayer/coverband).
|
|
|
628
804
|
|
|
629
805
|
## Want to use Spring with SimpleCov?
|
|
630
806
|
|
|
631
|
-
If you're using [Spring](https://github.com/rails/spring) to speed up test suite runs and want to run SimpleCov along
|
|
807
|
+
If you're using [Spring](https://github.com/rails/spring) to speed up test suite runs and want to run SimpleCov along
|
|
808
|
+
with them, you'll find that it often misreports coverage with the default config due to some sort of eager loading
|
|
809
|
+
issue. Don't despair!
|
|
632
810
|
|
|
633
|
-
|
|
811
|
+
One solution is to [explicitly call eager
|
|
812
|
+
load](https://github.com/colszowka/simplecov/issues/381#issuecomment-347651728)
|
|
813
|
+
in your `test_helper.rb` / `spec_helper.rb` after calling `SimpleCov.start`.
|
|
634
814
|
|
|
635
|
-
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
2. Add your SimpleCov config, as you normally would, to your `spec_helper.rb`
|
|
641
|
-
(or `rails_helper.rb` for RSpec 3). If you have a `config/spring.rb` file
|
|
642
|
-
(or anything similar), add it to the start of such file. Here's a simple
|
|
643
|
-
version of what the config should look like:
|
|
644
|
-
|
|
645
|
-
```ruby
|
|
646
|
-
if ENV['RAILS_ENV'] == 'test'
|
|
647
|
-
require 'simplecov'
|
|
648
|
-
SimpleCov.start
|
|
649
|
-
end
|
|
650
|
-
```
|
|
651
|
-
3. Run `spring rspec <path>` as normal. Remember to run `spring stop` after
|
|
652
|
-
making important changes to your app or its specs!
|
|
653
|
-
|
|
654
|
-
## Want to use bootsnap with SimpleCov?
|
|
815
|
+
```ruby
|
|
816
|
+
require 'simplecov'
|
|
817
|
+
SimpleCov.start 'rails'
|
|
818
|
+
Rails.application.eager_load!
|
|
819
|
+
```
|
|
655
820
|
|
|
656
|
-
|
|
657
|
-
loading/dumping doesn't work with coverage. Hence you need to deactivate it when
|
|
658
|
-
you run coverage so for instance when you use the environment `COVERAGE=true` to
|
|
659
|
-
decide that you want to gather coverage you can do:
|
|
821
|
+
Alternatively, you could disable Spring while running SimpleCov:
|
|
660
822
|
|
|
661
|
-
```
|
|
662
|
-
|
|
663
|
-
compile_cache_iseq: !ENV["COVERAGE"], # Compile Ruby code into ISeq cache, breaks coverage reporting.
|
|
664
|
-
# all those other options
|
|
665
|
-
)
|
|
823
|
+
```
|
|
824
|
+
DISABLE_SPRING=1 rake test
|
|
666
825
|
```
|
|
667
826
|
|
|
827
|
+
Or you could remove `gem 'spring'` from your `Gemfile`.
|
|
828
|
+
|
|
668
829
|
## Troubleshooting
|
|
669
830
|
|
|
670
|
-
The **most common problem is that simplecov isn't required and started before everything else**. In order to track
|
|
831
|
+
The **most common problem is that simplecov isn't required and started before everything else**. In order to track
|
|
832
|
+
coverage for your whole application **simplecov needs to be the first one** so that it (and the underlying coverage
|
|
833
|
+
library) can subsequently track loaded files and their usage.
|
|
671
834
|
|
|
672
|
-
If you are missing coverage for some code a simple trick is to put a puts statement in there and right after
|
|
835
|
+
If you are missing coverage for some code a simple trick is to put a puts statement in there and right after
|
|
836
|
+
`SimpleCov.start` so you can see if the file really was loaded after simplecov was started.
|
|
673
837
|
|
|
674
838
|
```ruby
|
|
675
839
|
# my_code.rb
|
|
@@ -697,6 +861,11 @@ MyCode is being loaded!
|
|
|
697
861
|
|
|
698
862
|
then it's good otherwise you likely have a problem :)
|
|
699
863
|
|
|
864
|
+
## Code of Conduct
|
|
865
|
+
|
|
866
|
+
Everyone participating in this project's development, issue trackers and other channels is expected to follow our
|
|
867
|
+
[Code of Conduct](./CODE_OF_CONDUCT.md)
|
|
868
|
+
|
|
700
869
|
## Contributing
|
|
701
870
|
|
|
702
871
|
See the [contributing guide](https://github.com/colszowka/simplecov/blob/master/CONTRIBUTING.md).
|