probatio

Test tools for floraison and flor. Somewhere between Minitest and Rspec, but not as excellent.

Goals

• bundle exec proba test/there/
• bundle exec proba test/there/that.rb
• bundle exec proba test/there/that.rb:123
• bundle exec proba test/there/that.rb:123:210
• bundle exec proba test/there/that.rb:123-210
• bundle exec proba test/there/ -n /_for_rm\$/
• bundle exec proba test/there/ -n "that test"
• bundle exec proba first
• bundle exec proba last -2
• bundle exec proba 0 1
• bundle exec proba -1 -2
• dots
• colors
• times monow

Usage

Usage: bundle exec proba [OPTIONS] [FILES] [DIRS]

  A test runner for Ruby.

  Options:
    -h, --help             Show this help message and quit
    --version              Show proba's version and exit
    -m, --monochrome       Disable colour output
    -c, --color            Enable colour output anyway
    -y, --dry              Don't run the test, just flag them as successes
    -n, --name PATTERN     include tests matching /regexp/ or string in run
    -e, --exclude PATTERN  Exclude /regexp/ or string from run
    -p, --print            Dumps the test tree
    -s, --seed             Sets random seed
    -d, --debug            Sets $DEBUG to true
    -x, --example          Outputs an example test file
    -X, --plugin-example   Outputs an example plugin file

  Files:
    TODO

  Dirs:
    TODO

  Examples:
    # Run all tests in a dir
    bundle exec proba test/

    # Run all the tests in a file
    bundle exec proba test/this_test.rb

Test files

By default probatio looks into test/ for test files ending in _test.rb or _tests.rb but first look at helpers ending in _helper.rb or _helpers.rb.

A typical test hierarchy:

test/
|-- helpers/
|   |-- some_helpers.rb
|   `-- some_other_helpers.rb
|-- this_test.rb
|-- that_test.rb
`-- more_tests.rb

group 'core' do

  setup do
    # occurs once before tests and sub-groups in group 'core'
  end
  teadowm do
    # occurs once after tests and sub-groups in group 'core'
  end

  group 'alpha' do

    before do
      # is run in the separate test context before _each_ test
    end
    after do
      # is run in the separate test context after _each_ test
    end

    test 'one' do

      MyLib.do_this_or_that()

      assert_equal 'one', 'o' + 'ne'
        # checks that all its arguments are equal

      assert_match 'one', /^one$/
        # checks that it receives a regex and one or more strings
        # and that all those strings match the regex

      assert_include 1, [ 1, 'two' ]
        # checks that the first array argument includes all other arguments

      assert 1, 1
        # behaves like assert_equal
      assert 'one', /one/i
        # behaves like assert_match
      assert 'one', [ 'one', 'two' ]
        # behaves like assert_include
      assert 'one' => 'on' + 'e', 'two' => :two.to_s
        # assert equality between keys and values
    end
  end

  group 'bravo' do
  end
end

group 'core' do
  #
  # it's OK to re-open a group to add sub-groups, tests,
  # and setups, teardowns, befores, or afters
  #
  # it's OK to re-open a group in another file, as long
  # as it's the same name at the same point in the name hierarchy

  _test 'not yet' do
    #
    # prefix a test, a group, or other element with _
    # marks it as _pending
  end
end

.test-point

TODO

.proba-output.rb

By default, probatio summarizes a run in a .proba-output.rb file.

Here is an example of such a file:

{
argv: ["-d"],
failures:
  [
  { n: "test_fail", p: "test/bravo_test.rb", l: 12, t: "0s000_607" },
  { n: "test_fail", p: "test/alpha_test.rb", l: 29, t: "0s000_055" },
  { n: "test_fail", p: "test/bravo_test.rb", l: 20, t: "0s000_047" },
  ],
duration: "0s004_949",
}

Probatio uses it when servicing bundle exec proba 0 or bundle exe proba -1.

Warnings

$ RUBYOPT="-w $RUBYOPT" bundle exec proba

Plugins

#
# examples of probatio plugins

class MyProbatioPlugin

  def on_test_succeed(ev)

    puts "GREAT SUCCESS! " + ev.to_s
  end
end

Probatio.plug(MyProbatioPlugin.new)

LICENSE

MIT, see LICENSE.txt