Ruby Gem to unit-test a piece of code in multiple concurrent threads
Switch branches/tags
Nothing to show
Clone or download
Latest commit 03dffab Nov 7, 2018
Permalink
Failed to load latest commit information.
lib #3 fixed Oct 26, 2018
test #3 fixed Oct 26, 2018
.0pdd.yml #1 first version Oct 25, 2018
.gitignore #1 first version Oct 25, 2018
.pdd #1 first version Oct 25, 2018
.rubocop.yml #1 first version Oct 25, 2018
.rultor.yml doc badge Nov 7, 2018
.travis.yml #1 first version Oct 25, 2018
Gemfile #1 first version Oct 25, 2018
README.md eo badge Nov 7, 2018
Rakefile #1 first version Oct 25, 2018
threads.gemspec #1 first version Oct 25, 2018

README.md

EO principles respected here DevOps By Rultor.com We recommend RubyMine

Build Status Gem Version Maintainability Yard Docs

Read this blog post first: Do You Test Ruby Code for Thread Safety?

When you need to test your code for thread safety, what do you do? That's right, you just don't test it. That's wrong! This simple gem helps you test your code with just two additional lines of code.

First, install it:

$ gem install threads

Then, use it like this, to test your code from multiple concurrently running threads:

require 'threads'
Threads.new(5).assert do |i|
  puts "Hello from the thread no.#{i}"
end

You can put whatever you want into the block. The code will be executed from five threads, concurrently. You can also make sure the code block runs only a specific number of times specifying the argument in the assert method (it can't be smaller than the amount of threads):

Threads.new(5).assert(20) do |i, r|
  puts "Hello from the thread no.#{i}, repetition no.#{r}"
end

You can also provide a logger, which will print exception backtraces. It has to implement either method error(msg) or puts(msg):

Threads.new(5, log: STDOUT).assert do
  this_code_fails_for_sure
end

That's it.

How to contribute

Read these guidelines. Make sure you build is green before you contribute your pull request. You will need to have Ruby 2.3+ and Bundler installed. Then:

$ bundle update
$ rake

If it's clean and you don't see any error messages, submit your pull request.

License

(The MIT License)

Copyright (c) 2018 Yegor Bugayenko

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.