Skip to content

Commit

Permalink
Some doco doesn't hurt
Browse files Browse the repository at this point in the history
  • Loading branch information
aslakhellesoy committed Mar 4, 2010
1 parent b3fde0b commit a57a624
Showing 1 changed file with 35 additions and 3 deletions.
38 changes: 35 additions & 3 deletions README.rdoc
@@ -1,6 +1,8 @@
= aruba

Cucumber steps for driving out command line applications.
Cucumber steps for driving out command line applications. The command line application can be anything,
a compiled C program, a Java program, a Perl script - anything. There is also special support for various
Ruby versions (see below).

== Usage

Expand All @@ -10,8 +12,38 @@ Then, just require the library in one of your ruby files under <tt>features/supp

require 'aruba'

You now have a bunch of step definitions that you can use in your features. See aruba.rb
for details.
You now have a bunch of step definitions that you can use in your features. Look at aruba/cucumber.rb
to see all the step definitions. Look at features/*.feature for examples (which are also testing Aruba
itself).

== Ruby/RVM love

Aruba has a couple of step definitions that make it easier to test your ruby command line program
with specific versions of Ruby (regardless of what Ruby version you're using to invoke Cucumber).

This is done with the follwoing step definitions:

/^I am using rvm "([^\"]*)"$/
/^I am using rvm gemset "([^\"]*)"$/

Then, if you use the step definition:

/^I run "(.*)"$/

.. with a command that starts with "ruby", Aruba will actually invoke the Ruby version (and gemset
if you specified) instead of just "ruby"

See features/running_ruby.feature for examples.

== Getting more output with tags.

Aruba has several tags you can use to see what command actually gets run (useful if you're using the RVM steps),
STDOUT or STDERR. You can put these tags on individual scenarios, or on a feature. The tags are:

* <tt>@announce-cmd</tt>
* <tt>@announce-stdout</tt>
* <tt>@announce-stderr</tt>
* <tt>@announce</tt> (does all of the above)

== Note on Patches/Pull Requests

Expand Down

0 comments on commit a57a624

Please sign in to comment.