Don't call SimpleCov.result before checking SimpleCov.result? #674
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ess_result in order to avoid instantiating SimpleCov.result prior to performing the .result? check, as doing so guarantees that .result? will always return 'true'
…data isn't clobbered by SimpleCov.run_exit_tasks\!/.process_results
|
Re the failing test -- looks like the same error has happened in at least one prior Travis build. I have not been able reproduce the issue in the local |
PragTob
reviewed
Apr 24, 2018
|
Awesome -- thanks, @PragTob! FWIW, I ran |
|
Ping @PragTob :) |
|
So the error is intermittent but not order dependent. Fun |
|
Hey sorry, I took a bit of a break from simplecov. Looks good rereading it all. Thanks a ton for your contribution 💚 |
netbsd-srcmastr
pushed a commit
to NetBSD/pkgsrc
that referenced
this pull request
Nov 2, 2019
Update ruby-simplecov to 0.17.1. 0.17.1 (2019-09-16) =================== Bugfix release for problems with ParallelTests. ## Bugfixes * Avoid hanging with parallel_tests. See [#746](simplecov-ruby/simplecov#746) (thanks [@annaswims](https://github.com/annaswims)) 0.17.0 (2019-07-02) =================== Maintenance release with nice convenience features and important bugfixes. 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.1+. Older versions might still work but no guarantees. ## Enhancements * Per default filter hidden files and folders. See [#721](simplecov-ruby/simplecov#721) (thanks [Renuo AG](https://www.renuo.ch)) * 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](simplecov-ruby/simplecov#688) (thanks [@daemonsy](https://github.com/daemonsy)) ## Bugfixes * Avoid a premature failure exit code when setting `minimum_coverage` in combination with using [parallel_tests](https://github.com/grosser/parallel_tests). See [#706](simplecov-ruby/simplecov#706) (thanks [@f1sherman](https://github.com/f1sherman)) * Project roots with special characters no longer cause crashes. See [#717](simplecov-ruby/simplecov#717) (thanks [@deivid-rodriguez](https://github.com/deivid-rodriguez)) * Avoid continously overriding test results with manual `ResultMergere.store_results` usage. See [#674](simplecov-ruby/simplecov#674) (thanks [@tomeon](https://github.com/tomeon))
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Encountered in infertux/bashcov#36.
In the following snippet,
SimpleCov.process_resultis called withSimpleCov.resultas the first parameter. Because of this, theSimpleCov.result?check at the very beginning ofSimpleCov.process_resultwill always returntrue, as@resultwas initialized by the precedingSimpleCov.resultcall:https://github.com/colszowka/simplecov/blob/03a9f7fde44a9388580977e4002b4f6823c2b4cc/lib/simplecov.rb#L197-L224
Due to the misordering of the
.resultand.result?calls, any code that (likebashcov) stores results manually withResultMerger.store_resultwill have its coverage data clobbered whenSimpleCov.resultcallsSimpleCov::ResultMerger.store_result(as long asSimpleCov.command_namehasn't changed between the two.store_resultcalls). See this Travis build, which contains the test case from this PR but not the code fix, for an illustration of the problem.This PR makes the call to
SimpleCov.process_resultconditional onSimpleCov.result?returningtrue, ensuring that existing data is overwritten only ifSimpleCov.resulthas already been instantiated elsewhere.Thanks in advance for your consideration!