Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Minimalist acceptance testing on top of RSpec

This branch is 0 commits ahead and 0 commits behind master

Fetching latest commit…

Cannot retrieve the latest commit at this time

README.rdoc

Steak

Minimalist acceptance testing on top of RSpec

What is Steak?

Steak is like Cucumber but in plain Ruby. This is how an acceptance spec looks like in Steak:

feature "Main page" do

  background do
    create_user :login => "jdoe"
    login_as "jdoe"
  end

  scenario "should show existing quotes" do
    create_quote :text => "The language of friendship is not words, but meanings",
                 :author => "Henry David Thoreau"

    visit "/"

    page.should have_css(".quote", :count => 1)
    within(:css, ".quote") do
      page.should have_css(".text", :text => "The language of friendship is not words, but meanings")
      page.should have_css(".author", :text => "Henry David Thoreau")
    end
  end

end

No explicit givens, whens or thens. No steps, no english, just Ruby: RSpec, Steak and, in this example, some factories and Capybara. That's all.

If you are not in Rails but use RSpec, then Steak is just some aliases providing you with the language of acceptance testing (feature, scenario, background). If you are in Rails, you also have a couple of generators, a rake task and full Rails integration testing (meaning Webrat support, for instance)

Getting started

Not in Rails

Just install and require the damned gem!

$ gem install steak

(Add the --pre modifier to be on top of RSpec 2 instead of RSpec 1.x)

Then in your spec or spec helper:

require 'steak'

That's all. You don't really need to require RSpec.

In Rails 2.x (stable branch)

Assuming you have already setup rspec-rails, add this to your project's config/environments/test.rb:

config.gem "steak"

Install the gem from the command line:

$ RAILS_ENV=test rake gems:install

Run the generator:

$ script/generate steak

That will create some basic helper files and directory structure under the spec/acceptance directory, already configured for Capybara. If you want to use Webrat, just pass it to the generator:

$ script/generate steak --webrat

Spend one minute on getting familiar with the structure and files you've got.

Now you may want to create your first acceptance spec:

$ script/generate acceptance_spec this_is_my_first_feature

You run your acceptance specs just like your regular specs. Individually…

$ rspec spec/acceptance/this_is_my_first_feature_spec.rb

…or all together:

$ rspec spec/acceptance

…you can also do:

$ rake spec:acceptance

In Rails 3 (master branch)

Add this to your project's Gemfile:

group :test do
  gem 'rspec-rails', '>= 2.0.0.beta.13'
  gem 'steak', :git => 'git://github.com/cavalle/steak.git'
  gem 'capybara'

  # Other usual suspects:
  # gem 'delorean'
  # gem 'database_cleaner'
  # gem 'spork'
end

And install:

$ bundle install

Run the generators:

$ rails g rspec:install
$ rails g steak:install

That will create some basic helper files and directory structure under the spec/acceptance directory, already configured for Capybara.

Spend one minute on getting familiar with the structure and files you've got.

Now you may want to create your first acceptance spec:

$ rails generate steak:spec this_is_my_first_feature

You run your acceptance specs just like your regular specs. Individually…

$ rspec spec/acceptance/this_is_my_first_feature_spec.rb

…or all together:

$ rspec spec/acceptance

…you can also do:

$ rake spec:acceptance

RSpec & Metadata

Steak scenarios are just regular RSpec examples with their metadata attribute :type set to :acceptance. That's useful if you want to make sure you include helpers or set hooks only for your acceptance specs and not for the rest of the specs in your suite.

You'd do it this way:

RSpec.configure do |config|
  # include MyHelpers module in every acceptance spec
  config.include MyHelpers, :type => :acceptance 

  config.before(:each, :type => :acceptance) do
    # Some code to run before any acceptance spec
  end
end

Resources

Credits

Steak was created by Luismi Cavallé and improved thanks to the love from:

  • Álvaro Bautista

  • Felipe Talavera

  • Paco Guzmán

  • Jeff Kreeftmeijer

  • Jaime Iniesta

  • Emili Parreño

  • Andreas Wolff

  • Wincent Colaiuta

  • Falk Pauser

  • Francesc Esplugas

  • Raúl Murciano

Copyright © 2009, 2010 Luismi Cavallé, released under the MIT license

Something went wrong with that request. Please try again.