[ANN] Aruba 0.4.0 - awesome new reporting feature

23 views
Skip to first unread message

aslak hellesoy

unread,
Jun 12, 2011, 3:15:07 PM6/12/11
to Cucumber Users
Hello, any Aruba users out there. The latest release just got a new feature I'm quite excited about - reporting.
Before running your Aruba cukes, try this:

    export ARUBA_REPORT_DIR=doc

When your cukes are done, each scenario that was run gets a HTML file in that directory. It contains:

* A file system hierarchy of files created during the scenario (highlighted with pygments, which you'll need to install)
* The commands that were run as well as their (coloured) output
* The header from the scenario (passed through Markdown)

The plan is to use this feature to document Cucumber itself, whether it's the Ruby, Javascript, Java or some other implementation.

Try it out on Cucumber itself to see it in action:

    bundle update
    ARUBA_REPORT_DIR=doc bin/cucumber

Aslak

aslak hellesoy

unread,
Jun 13, 2011, 2:56:09 AM6/13/11
to Cucumber Users
On Sun, Jun 12, 2011 at 8:15 PM, aslak hellesoy <aslak.h...@gmail.com> wrote:
Hello, any Aruba users out there. The latest release just got a new feature I'm quite excited about - reporting.
Before running your Aruba cukes, try this:

    export ARUBA_REPORT_DIR=doc

When your cukes are done, each scenario that was run gets a HTML file in that directory. It contains:


I have attached the docs that are generated for Cucumber so you can get an idea. Just open one of the HTML files in there, for example doc/features/hooks.feature\:44.html 
cucumber_aruba_docs.tgz

aslak hellesoy

unread,
Jun 13, 2011, 3:06:17 AM6/13/11
to Cucumber Users
On Mon, Jun 13, 2011 at 7:56 AM, aslak hellesoy <aslak.h...@gmail.com> wrote:


On Sun, Jun 12, 2011 at 8:15 PM, aslak hellesoy <aslak.h...@gmail.com> wrote:
Hello, any Aruba users out there. The latest release just got a new feature I'm quite excited about - reporting.
Before running your Aruba cukes, try this:

    export ARUBA_REPORT_DIR=doc

When your cukes are done, each scenario that was run gets a HTML file in that directory. It contains:


I have attached the docs that are generated for Cucumber so you can get an idea. Just open one of the HTML files in there, for example doc/features/hooks.feature\:44.html 



I have put them online so you don't have to muck around. Here is an example:


You can browse them all here:


Note that this is *not* finished documentation - it's just a prototype of what the reporter can do. We'll have to work on the features (cucumber-features project) and general layout to make this nice.

Aslak 

Eumir Gaspar

unread,
Jun 15, 2011, 9:41:41 AM6/15/11
to cu...@googlegroups.com
On Mon, Jun 13, 2011 at 3:15 AM, aslak hellesoy <aslak.h...@gmail.com> wrote:
Hello, any Aruba users out there. The latest release just got a new feature I'm quite excited about - reporting.
Before running your Aruba cukes, try this:

I just wanted to say, when I read this email 3 days ago, I was like "what's aruba? *googles* ohhhh command line cucumber! *goes back to surfing*(since i wasn't into doing any command line stuff at that moment). 

today, we ran into some problems in testing arguments from the command line with shoulda. i was pairing with a colleague and the words "command line" and "testing" suddenly woke me up from my drowsiness and i was like "let's try aruba!". and the rest was magic.

thank you for this great tool! it has definitely helped us a LOT today and it was fun seeing the tests passing(and failing). we'll hopefully get to test more of aruba's features in the next few days(or weeks) so here's to having some fun! thanks again aslak!
 
    export ARUBA_REPORT_DIR=doc

When your cukes are done, each scenario that was run gets a HTML file in that directory. It contains:

* A file system hierarchy of files created during the scenario (highlighted with pygments, which you'll need to install)
* The commands that were run as well as their (coloured) output
* The header from the scenario (passed through Markdown)

The plan is to use this feature to document Cucumber itself, whether it's the Ruby, Javascript, Java or some other implementation.

Try it out on Cucumber itself to see it in action:

    bundle update
    ARUBA_REPORT_DIR=doc bin/cucumber

Aslak

--
You received this message because you are subscribed to the Google Groups "Cukes" group.
To post to this group, send email to cu...@googlegroups.com.
To unsubscribe from this group, send email to cukes+un...@googlegroups.com.
For more options, visit this group at http://groups.google.com/group/cukes?hl=en.



--
Eumir Gaspar
Ruby on Rails Developer/Rails UI Specialist

aslak hellesoy

unread,
Jun 15, 2011, 9:44:31 AM6/15/11
to cu...@googlegroups.com
On Wed, Jun 15, 2011 at 2:41 PM, Eumir Gaspar <imacate...@gmail.com> wrote:


On Mon, Jun 13, 2011 at 3:15 AM, aslak hellesoy <aslak.h...@gmail.com> wrote:
Hello, any Aruba users out there. The latest release just got a new feature I'm quite excited about - reporting.
Before running your Aruba cukes, try this:

I just wanted to say, when I read this email 3 days ago, I was like "what's aruba? *googles* ohhhh command line cucumber! *goes back to surfing*(since i wasn't into doing any command line stuff at that moment). 

today, we ran into some problems in testing arguments from the command line with shoulda. i was pairing with a colleague and the words "command line" and "testing" suddenly woke me up from my drowsiness and i was like "let's try aruba!". and the rest was magic.

thank you for this great tool! it has definitely helped us a LOT today and it was fun seeing the tests passing(and failing). we'll hopefully get to test more of aruba's features in the next few days(or weeks) so here's to having some fun! thanks again aslak!
 

Awesome, glad you like it!

I just realised the new aruba reporting feature relies on some minor unreleased changes in cucumber (getting the title of a scenario). I'll see if I can get that released later today.

Aslak

Eumir Gaspar

unread,
Jun 15, 2011, 9:52:15 AM6/15/11
to cu...@googlegroups.com
On Wed, Jun 15, 2011 at 9:44 PM, aslak hellesoy <aslak.h...@gmail.com> wrote:


On Wed, Jun 15, 2011 at 2:41 PM, Eumir Gaspar <imacate...@gmail.com> wrote:


On Mon, Jun 13, 2011 at 3:15 AM, aslak hellesoy <aslak.h...@gmail.com> wrote:
Hello, any Aruba users out there. The latest release just got a new feature I'm quite excited about - reporting.
Before running your Aruba cukes, try this:

I just wanted to say, when I read this email 3 days ago, I was like "what's aruba? *googles* ohhhh command line cucumber! *goes back to surfing*(since i wasn't into doing any command line stuff at that moment). 

today, we ran into some problems in testing arguments from the command line with shoulda. i was pairing with a colleague and the words "command line" and "testing" suddenly woke me up from my drowsiness and i was like "let's try aruba!". and the rest was magic.

thank you for this great tool! it has definitely helped us a LOT today and it was fun seeing the tests passing(and failing). we'll hopefully get to test more of aruba's features in the next few days(or weeks) so here's to having some fun! thanks again aslak!
 

Awesome, glad you like it!

Yes I did! It was awesome because I didn't even think I'd be touching it anytime soon and there we were this afternoon, getting it to work out of the box and without that much of a learning curve too! 

The only thing I noticed though was that we had to either keep a window open at https://github.com/cucumber/aruba/blob/master/lib/aruba/cucumber.rb or used bundle open aruba to check the built in steps. Is there any other place to check it like cucumber automatically adding "web_steps.rb" in the step_definitions folder? Just a thought, but really, it was epic already today. 
Reply all
Reply to author
Forward
0 new messages