shindo

Simple depth first ruby testing, watch and learn.

Writing tests

Tests group similar assertions, but their return value is ignored.

After that you just test based on the two things a ruby thing should do, raise or return.

Returns takes what you expect and checks a block to see if the return value matches:

Shindo.tests do
  returns(true) { true }
  returns(false) { false }
end

Raises takes what error you expect and checks to see if the block will raise it:

Shindo.tests do
  raises(StandardError) { StandardError.new }
end

You can also override the default descriptions:

Shindo.tests('foo/bar') do
  returns('foo', 'returns foo when bar') { 'foo' }
  returns('bar', 'returns bar when qux') { 'bar' }
end

Then, if you want to get real fancy you can also tag your tests, to help narrow down which ones to run

Shindo.tests('tests for foo', 'foo') do
    test('foo') { true }
end

Shindo.tests('tests for bar', 'bar') do
    test('bar') { true }
  end
end

Note: you’ll have to supply a non-default description first, and then follow up with tags.

Running tests

Run tests with the shindo command, the easiest is to specify a file name:

shindo something_tests.rb

You can also give directories and it will run all files ending in _tests.rb and include all files ending in _helper.rb (recurses through subdirectories)

shindo some_test_directory

That leaves tags, which use +/-. So run just tests with the ‘foo’ tag:

shindo some_test_directory +foo

Or those without the ‘bar’ tag:

shindo some_test_directory -bar

Or combine to run everything with a foo tag, but no bar tag

shindo some_test_directory +foo -bar

Command line tools

When tests fail you’ll get lots of options to help you debug the problem, just enter ‘?’ at the prompt to see your options.

Copyright

(The MIT License)

Copyright © 2009 geemus (Wesley Beary)

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.