Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Cucumber formatter that saves a screenshot of your app after each step.
Ruby
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
spec
.gitignore
README.rdoc
Rakefile
visible-cukes.gemspec

README.rdoc

NOTE: You probably don't want to be using this.

I haven't done much with it since I started playing with it. On the other hand, there's another Cucumber screenshot extension that's much more actively maintained, so you're probably better off trying that before this.

Visible Cukes

Visible what now?

It's an alternative formatter for Cucumber, your favorite functional testing and specification tool. It makes an HTML document of all your features. You could already do that with the built in HTML formatter, though.

Here's the cool part: If you're using Webrat in your testing, it will save a copy of the current page after each step. In the HTML for the features, it links all the steps to their corresponding screenshots. So you can always get a quick picture of what the description in the feature is actually talking about.

How do I use it?

To install: gem install visible-cukes. It's hosted on Gemcutter, so you'll need to set that up first, if you haven't already: gem install gemcutter and then gem tumble.

To use:

  • mkdir visible-cukes (This is where your html will live.)

  • cucumber -f VisibleCukes -out visible-cukes/index.html

Is it finished?

Well… not really. You can totally use it, but there are a few weaknesses it's worth knowing about:

  • The core of it isn't really tested. It was a burst of an hour or two of furious hacking, so I still need to go back and clean it up.

  • When filling out forms, not all changes will be reflected in the captured screenshots. Filling in text fields and selecting items from dropdown lists work, because those are what I've needed so far, but no other form elements do.

  • You can't control where the generated docs go, which is a pity.

  • The captured screenshot pages won't link to your stylesheets correctly.

  • I'd love it if the HTML looked better than it does.

That's the stuff I'm planning to change over the <strike>next couple weeks</strike> year or so, but I wanted to get something out early and see if other people would find it useful.

Is there anyone you totally ripped off this idea from?

I would never have started doing this if I hadn't seen a demo of Ward Cunningham's ridiculously awesome testing and exploration system for the Eclipse MyFoundation portal. That, in turn, is inspired by Brian Marick's idea of Visible Workings. I hope that Visible Cukes may someday be good enough to live up to this lineage.

Also, some of the testing code for custom Webrat extensions is basically lifted from Webrat's own rspec suite. Hope that's okay.

License

Free, some more specific open source license to be posted later. If it breaks, you can keep both pieces.

Who are you, and how can I contact you?

Something went wrong with that request. Please try again.