Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
..
Failed to load latest commit information.
lib
spec
.autotest
.document
.gitignore
.rspec
.rvmrc
Gemfile
Gemfile.lock
LICENSE
README.rdoc
Rakefile
jaribio_formatter.gemspec

README.rdoc

jaribio-formatter

This gem contains:

  • Jaribio::RSpecFormatter - An RSpec formatter that when configured appropriately will record test case execution for automated tests in jaribio.

RSpec Configuration

RSpec.configure do |config|
  # Can add the formatter here or on command line of rspec
  config.add_formatter 'Jaribio::RSpecFormatter',
    File.join(File.dirname(__FILE__), 'jaribio.txt')

  # Configure the url to the installation of jaribio
  config.jaribio_url = 'https://localhost/jaribio'

  # Configure a jaribio api key, obtained from a user's profile page
  config.jaribio_api_key = 'asdf1234'

  # Optional, by default all open plans are updated
  # Configure only specific plans to be updated.
  config.jaribio_plans = [1, 2, 3]

  # Optional, by default this is false and the formatter will not create 
  # missing test cases
  config.jaribio_auto_create = true
end

RSpec Output

It is expected that in general you will continue to use whatever standard formatter you know and love and this formatter will be in addition to that. So the output is minimalistic TAP format for the rspec formatter. The goal is to let you know primarily the keys for each test and inform you of errors in communicating with Jaribio, if any.

1..10
ok 1 - (wRq7gMRkRJeHnqZxkqkDng==) Jaribio::Plan#open?
ok 2 - (tccJHXEmFLwXeHzoPzRG+g==) Jaribio::Record#failed?
ok 3 - (I6JDDF4nqkrcAwC3ZGArJw==) Jaribio::Record#eql?
ok 4 - (9AfA585llnqxPxpEXNJcGg==) Jaribio::Record#save
ok 5 - (pBw77Ov/D/ZvKtAqJOMp8g==) Jaribio::RemoteObject#query_string
ok 6 - (QNi21vVeqvCyXIIg2/hlSA==) Jaribio::RemoteObject#configure
ok 7 - (XXpQMW5Ii4t2f6WSeWhxZg==) Jaribio::RSpecFormatter#get_example_key
ok 8 - (1ytapaYfeTdvJQ/dZzKSXg==) Jaribio::RSpecFormatter#results
ok 9 - (XcEQFeZVa+8E6UUmVFGjuw==) Jaribio::RSpecFormatter#close
ok 10 - (Gz4dbtEYCTJAgQrD4iEhGg==) Jaribio::RSpecFormatter can configure
# Saving execution of XXpQMW5Ii4t2f6WSeWhxZg== - Jaribio::RSpecFormatter#get_example_key for plan 5 - jaribio_formatter
# Saving execution of 1ytapaYfeTdvJQ/dZzKSXg== - Jaribio::RSpecFormatter#results for plan 5 - jaribio_formatter
# Saving execution of XcEQFeZVa+8E6UUmVFGjuw== - Jaribio::RSpecFormatter#close for plan 5 - jaribio_formatter
# Saving execution of Gz4dbtEYCTJAgQrD4iEhGg== - Jaribio::RSpecFormatter can configure for plan 5 - jaribio_formatter

TODO

Eventually would like to include support for:

  • test::unit

  • cucumber

Contributing to jaribio-formatter

  • Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.

  • Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.

  • Fork the project.

  • Start a feature/bugfix branch.

  • Commit and push until you are happy with your contribution.

  • Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.

  • Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Copyright

Copyright © 2012 bjones. See LICENSE.txt for further details.