-
Notifications
You must be signed in to change notification settings - Fork 552
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Make ResultMerger safe in parallel environment #223
Conversation
To prevent two processes writes at the same time.
@@ -66,6 +70,7 @@ def store_result(result) | |||
command_name, data = result.to_hash.first | |||
new_set[command_name] = data | |||
File.open(resultset_path, "w+") do |f| | |||
f.flock(File::LOCK_EX) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Don't you have to release the lock after the puts statement in the following line?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
File close releases the lock.
It appears the lockfile-gem based implementation brought in with #185 breaks on Windows, see #258, while this approach has been reported to work. I also researched JRuby support, and File::LOCK_EX should work there as well. Also, the lockfile gem appears to be unmaintained and generates a lot of Ruby warnings on higher warning levels. Therefore, I'm merging this and replacing #185 with it. Thanks for your contribution! |
Make ResultMerger safe in parallel environment
@colszowka, these changes are causing problems for me when running on a non-Windows env (Mac OSX). I'm running two test suites, one minitest and one rspec, both in parallel but this issue can occur when either one is running so it's not limited to having two test suites. I have a wrapper rake task set up like this: task :parallel_tests => ['parallel:test', 'parallel:spec'] And I have command_name specified for each test suite like this: SimpleCov.command_name "RSpec:#{Process.pid}#{ENV['TEST_ENV_NUMBER']}" The minitest suite builds up the list of reports just fine (with 8 cores) until: When the rspec suite is running in parallel, it always resets itself after the 3rd or 4th rspec process completes:
Note both the non-merging half way through the rspec suite and also how the last one shows 0/0 LOC. I have |
v0.8.2, 2013-11-20 ([changes](simplecov-ruby/simplecov@v0.8.1...v0.8.2)) ===================== ## Bugfixes * Replaced the locking behaviour [via lockfile gem](simplecov-ruby/simplecov#185) with plain Ruby explicit file locking when merging results. This should make simplecov merging to behave well on Windows again. See [#258](simplecov-ruby/simplecov#258) and [#223](simplecov-ruby/simplecov#223) (thanks to @tomykaira) v0.8.1, 2013-11-10 ([changes](simplecov-ruby/simplecov@v0.8.0...v0.8.1)) ===================== ## Bugfixes * Fixed a regression introduced in 0.8.0 - the Forwardable STDLIB module is now required explicitly. See [#256](simplecov-ruby/simplecov#256) (thanks to @kylev) v0.8.0, 2013-11-10 ([changes](simplecov-ruby/simplecov@v0.7.1...v0.8.0)) ===================== **Note: Yanked the same day because of the regression that 0.8.1 fixes, see above** ## TL;DR It's been way too long since the last official release 0.7.1, but this was partly due to it proving itself quite stable in most circumstances. This release brings various further stability improvements to result set merging (especially when working with parallel_tests), the configuration, source file encodings, and command name guessing. The 0.8 line is the last one to cooperate with Ruby < 1.9. Starting with 0.9, SimpleCov will assume to be running in Ruby 1.9+, and will not try to detect or bail silently on older Ruby versions. An appropriate deprecation warning has been added. ## Features * Configuration blocks now have access to variables and methods outside of the block's scope. See [#238](simplecov-ruby/simplecov#238) (thanks to @ms-tg) * You can now have a global `~/.simplecov` configuration file. See [#195](simplecov-ruby/simplecov#195) (thanks to @spagalloco) * simplecov-html now uses the MIT-licensed colorbox plugin. Some adjustments when viewing source files, including retaining the currently open file on refresh have been added. See [simplecov-html #15](simplecov-ruby/simplecov-html#15) (thanks to @chetan) * Adds support for Rails 4 command guessing, removes default group `vendor/plugins`. See [#181](simplecov-ruby/simplecov#181) and [#203](simplecov-ruby/simplecov#203) (thanks to @semanticart and @phallstrom) * You can now load simplecov without the default settings by doing `require 'simplecov/no_defaults'` or setting `ENV['SIMPLECOV_NO_DEFAULTS']`. Check `simplecov/defaults` to see what preconfigurations are getting dropped by using this. See [#209](simplecov-ruby/simplecov#209) (thanks to @ileitch) * The result set merging now uses the `lockfile` gem to avoid race conditions. See [#185](simplecov-ruby/simplecov#185) (thanks to @jshraibman-mdsol). * Automatically detect the usage of parallel_tests and adjust the command name with the test env number accordingly, See [#64](simplecov-ruby/simplecov#64) and [#185](simplecov-ruby/simplecov#185) (thanks to @jshraibman-mdsol). ## Enhancements * Rename adapters to "profiles" given that they are bundles of settings. The old adapter methods are deprecated, but remain available for now. See [#207](simplecov-ruby/simplecov#207) (thanks to @mikerobe) * Tweaks to the automatic test suite naming. In particular, `rspec/features` should now be correctly attributed to RSpec, not Cucumber. See [#212](simplecov-ruby/simplecov#212) (thanks to @ersatzryan and @betelgeuse) * MiniTest should now be identified correctly by the command name guesser. See [#244](simplecov-ruby/simplecov#244) (thanks to @envygeeks) * Makes SimpleCov resilient to inclusion of mathn library. See [#175](simplecov-ruby/simplecov#175) and [#140](simplecov-ruby/simplecov#140) (thanks to @scotje) * Allow coverage_dir to be an absolute path. * See [#190](simplecov-ruby/simplecov#190) (thanks to @jshraibman-mdsol) * The internal cucumber test suite now uses Capybara 2. See [#206](simplecov-ruby/simplecov#206) (thanks to @infertux) * Work-arounds for the Coverage library shipped in JRuby 1.6 to behave in line with MRI. See [#174](simplecov-ruby/simplecov#174) (thanks to @grddev) * Fix warning: instance variable @exit_status not initialized. See [#242](simplecov-ruby/simplecov#242) and [#213](simplecov-ruby/simplecov#213) (thanks to @sferik and @infertux) ## Bugfixes * Correct result calculations for people using :nocov: tags. See [#215](simplecov-ruby/simplecov#215) (thanks to @aokolish) * Average hits per line for groups of files is now computed correctly. See [#192](http://github.com/colszowka/simplecov/pull/192) and [#179](http://github.com/colszowka/simplecov/issues/179) (thanks to @Graysonwright) * Compatability with BINARY internal encoding. See [#194](simplecov-ruby/simplecov#194) and [#127](simplecov-ruby/simplecov#127) (thanks to @justfalter) * Special characters in `SimpleCov.root` are now correctly escaped before being used as a RegExp. See [#204](simplecov-ruby/simplecov#204) and [#237](simplecov-ruby/simplecov#237) (thanks to @rli9)
v0.8.2, 2013-11-20 ([changes](simplecov-ruby/simplecov@v0.8.1...v0.8.2)) ===================== ## Bugfixes * Replaced the locking behaviour [via lockfile gem](simplecov-ruby/simplecov#185) with plain Ruby explicit file locking when merging results. This should make simplecov merging to behave well on Windows again. See [#258](simplecov-ruby/simplecov#258) and [#223](simplecov-ruby/simplecov#223) (thanks to @tomykaira) v0.8.1, 2013-11-10 ([changes](simplecov-ruby/simplecov@v0.8.0...v0.8.1)) ===================== ## Bugfixes * Fixed a regression introduced in 0.8.0 - the Forwardable STDLIB module is now required explicitly. See [#256](simplecov-ruby/simplecov#256) (thanks to @kylev) v0.8.0, 2013-11-10 ([changes](simplecov-ruby/simplecov@v0.7.1...v0.8.0)) ===================== **Note: Yanked the same day because of the regression that 0.8.1 fixes, see above** ## TL;DR It's been way too long since the last official release 0.7.1, but this was partly due to it proving itself quite stable in most circumstances. This release brings various further stability improvements to result set merging (especially when working with parallel_tests), the configuration, source file encodings, and command name guessing. The 0.8 line is the last one to cooperate with Ruby < 1.9. Starting with 0.9, SimpleCov will assume to be running in Ruby 1.9+, and will not try to detect or bail silently on older Ruby versions. An appropriate deprecation warning has been added. ## Features * Configuration blocks now have access to variables and methods outside of the block's scope. See [#238](simplecov-ruby/simplecov#238) (thanks to @ms-tg) * You can now have a global `~/.simplecov` configuration file. See [#195](simplecov-ruby/simplecov#195) (thanks to @spagalloco) * simplecov-html now uses the MIT-licensed colorbox plugin. Some adjustments when viewing source files, including retaining the currently open file on refresh have been added. See [simplecov-html #15](simplecov-ruby/simplecov-html#15) (thanks to @chetan) * Adds support for Rails 4 command guessing, removes default group `vendor/plugins`. See [#181](simplecov-ruby/simplecov#181) and [#203](simplecov-ruby/simplecov#203) (thanks to @semanticart and @phallstrom) * You can now load simplecov without the default settings by doing `require 'simplecov/no_defaults'` or setting `ENV['SIMPLECOV_NO_DEFAULTS']`. Check `simplecov/defaults` to see what preconfigurations are getting dropped by using this. See [#209](simplecov-ruby/simplecov#209) (thanks to @ileitch) * The result set merging now uses the `lockfile` gem to avoid race conditions. See [#185](simplecov-ruby/simplecov#185) (thanks to @jshraibman-mdsol). * Automatically detect the usage of parallel_tests and adjust the command name with the test env number accordingly, See [#64](simplecov-ruby/simplecov#64) and [#185](simplecov-ruby/simplecov#185) (thanks to @jshraibman-mdsol). ## Enhancements * Rename adapters to "profiles" given that they are bundles of settings. The old adapter methods are deprecated, but remain available for now. See [#207](simplecov-ruby/simplecov#207) (thanks to @mikerobe) * Tweaks to the automatic test suite naming. In particular, `rspec/features` should now be correctly attributed to RSpec, not Cucumber. See [#212](simplecov-ruby/simplecov#212) (thanks to @ersatzryan and @betelgeuse) * MiniTest should now be identified correctly by the command name guesser. See [#244](simplecov-ruby/simplecov#244) (thanks to @envygeeks) * Makes SimpleCov resilient to inclusion of mathn library. See [#175](simplecov-ruby/simplecov#175) and [#140](simplecov-ruby/simplecov#140) (thanks to @scotje) * Allow coverage_dir to be an absolute path. * See [#190](simplecov-ruby/simplecov#190) (thanks to @jshraibman-mdsol) * The internal cucumber test suite now uses Capybara 2. See [#206](simplecov-ruby/simplecov#206) (thanks to @infertux) * Work-arounds for the Coverage library shipped in JRuby 1.6 to behave in line with MRI. See [#174](simplecov-ruby/simplecov#174) (thanks to @grddev) * Fix warning: instance variable @exit_status not initialized. See [#242](simplecov-ruby/simplecov#242) and [#213](simplecov-ruby/simplecov#213) (thanks to @sferik and @infertux) ## Bugfixes * Correct result calculations for people using :nocov: tags. See [#215](simplecov-ruby/simplecov#215) (thanks to @aokolish) * Average hits per line for groups of files is now computed correctly. See [#192](http://github.com/colszowka/simplecov/pull/192) and [#179](http://github.com/colszowka/simplecov/issues/179) (thanks to @Graysonwright) * Compatability with BINARY internal encoding. See [#194](simplecov-ruby/simplecov#194) and [#127](simplecov-ruby/simplecov#127) (thanks to @justfalter) * Special characters in `SimpleCov.root` are now correctly escaped before being used as a RegExp. See [#204](simplecov-ruby/simplecov#204) and [#237](simplecov-ruby/simplecov#237) (thanks to @rli9)
v0.8.2, 2013-11-20 ([changes](simplecov-ruby/simplecov@v0.8.1...v0.8.2)) ===================== ## Bugfixes * Replaced the locking behaviour [via lockfile gem](simplecov-ruby/simplecov#185) with plain Ruby explicit file locking when merging results. This should make simplecov merging to behave well on Windows again. See [#258](simplecov-ruby/simplecov#258) and [#223](simplecov-ruby/simplecov#223) (thanks to @tomykaira) v0.8.1, 2013-11-10 ([changes](simplecov-ruby/simplecov@v0.8.0...v0.8.1)) ===================== ## Bugfixes * Fixed a regression introduced in 0.8.0 - the Forwardable STDLIB module is now required explicitly. See [#256](simplecov-ruby/simplecov#256) (thanks to @kylev) v0.8.0, 2013-11-10 ([changes](simplecov-ruby/simplecov@v0.7.1...v0.8.0)) ===================== **Note: Yanked the same day because of the regression that 0.8.1 fixes, see above** ## TL;DR It's been way too long since the last official release 0.7.1, but this was partly due to it proving itself quite stable in most circumstances. This release brings various further stability improvements to result set merging (especially when working with parallel_tests), the configuration, source file encodings, and command name guessing. The 0.8 line is the last one to cooperate with Ruby < 1.9. Starting with 0.9, SimpleCov will assume to be running in Ruby 1.9+, and will not try to detect or bail silently on older Ruby versions. An appropriate deprecation warning has been added. ## Features * Configuration blocks now have access to variables and methods outside of the block's scope. See [#238](simplecov-ruby/simplecov#238) (thanks to @ms-tg) * You can now have a global `~/.simplecov` configuration file. See [#195](simplecov-ruby/simplecov#195) (thanks to @spagalloco) * simplecov-html now uses the MIT-licensed colorbox plugin. Some adjustments when viewing source files, including retaining the currently open file on refresh have been added. See [simplecov-html #15](simplecov-ruby/simplecov-html#15) (thanks to @chetan) * Adds support for Rails 4 command guessing, removes default group `vendor/plugins`. See [#181](simplecov-ruby/simplecov#181) and [#203](simplecov-ruby/simplecov#203) (thanks to @semanticart and @phallstrom) * You can now load simplecov without the default settings by doing `require 'simplecov/no_defaults'` or setting `ENV['SIMPLECOV_NO_DEFAULTS']`. Check `simplecov/defaults` to see what preconfigurations are getting dropped by using this. See [#209](simplecov-ruby/simplecov#209) (thanks to @ileitch) * The result set merging now uses the `lockfile` gem to avoid race conditions. See [#185](simplecov-ruby/simplecov#185) (thanks to @jshraibman-mdsol). * Automatically detect the usage of parallel_tests and adjust the command name with the test env number accordingly, See [#64](simplecov-ruby/simplecov#64) and [#185](simplecov-ruby/simplecov#185) (thanks to @jshraibman-mdsol). ## Enhancements * Rename adapters to "profiles" given that they are bundles of settings. The old adapter methods are deprecated, but remain available for now. See [#207](simplecov-ruby/simplecov#207) (thanks to @mikerobe) * Tweaks to the automatic test suite naming. In particular, `rspec/features` should now be correctly attributed to RSpec, not Cucumber. See [#212](simplecov-ruby/simplecov#212) (thanks to @ersatzryan and @betelgeuse) * MiniTest should now be identified correctly by the command name guesser. See [#244](simplecov-ruby/simplecov#244) (thanks to @envygeeks) * Makes SimpleCov resilient to inclusion of mathn library. See [#175](simplecov-ruby/simplecov#175) and [#140](simplecov-ruby/simplecov#140) (thanks to @scotje) * Allow coverage_dir to be an absolute path. * See [#190](simplecov-ruby/simplecov#190) (thanks to @jshraibman-mdsol) * The internal cucumber test suite now uses Capybara 2. See [#206](simplecov-ruby/simplecov#206) (thanks to @infertux) * Work-arounds for the Coverage library shipped in JRuby 1.6 to behave in line with MRI. See [#174](simplecov-ruby/simplecov#174) (thanks to @grddev) * Fix warning: instance variable @exit_status not initialized. See [#242](simplecov-ruby/simplecov#242) and [#213](simplecov-ruby/simplecov#213) (thanks to @sferik and @infertux) ## Bugfixes * Correct result calculations for people using :nocov: tags. See [#215](simplecov-ruby/simplecov#215) (thanks to @aokolish) * Average hits per line for groups of files is now computed correctly. See [#192](http://github.com/colszowka/simplecov/pull/192) and [#179](http://github.com/colszowka/simplecov/issues/179) (thanks to @Graysonwright) * Compatability with BINARY internal encoding. See [#194](simplecov-ruby/simplecov#194) and [#127](simplecov-ruby/simplecov#127) (thanks to @justfalter) * Special characters in `SimpleCov.root` are now correctly escaped before being used as a RegExp. See [#204](simplecov-ruby/simplecov#204) and [#237](simplecov-ruby/simplecov#237) (thanks to @rli9)
With current implementation, sometimes two processes write to the same JSON file, and collapse it.
My fix avoids this problem, and loads JSON with error check.