Writing Software not Code with Cucumber

Writing Software
not code
With

Ben Mabey

Writing Software
not code
With
Behaviour Driven
Development
Ben Mabey

Tweet in the
blanks...
"most software projects are
like _ _ _ _ _ _ _ _"
#rubyhoedown #cucumber

"most software projects are
like _ _ _ _ _ _ _ _"
#rubyhoedown #cucumber

So... why are
software projects
like “The Homer”?

Feature
Devotion
Text
Placing emphasis on
features instead of
overall outcome

Shingeo Shingo of
Toyota says...

"Inspection to ﬁnd
defects is waste."

"Inspection to ﬁnd
defects is waste."

"Inspection to
prevent defects is
essential."

56% of all bugs are introduced in
requirements. (CHAOS Report)

Protect Revenue

Increase Revenue

Manage Cost

* not executed
* documentation value

Feature: title * variant of contextra
* business value up front

In order to [Business Value]
As a [Role]
I want to [Some Action] (feature)

There is no template.
What is important to
have in narrative:

* business value
* stakeholder role
* user role
* action to be taken by
user

“All of these tools are great...
but, in the end, tools are tools.
While RSpec and Cucumber are
optimized for BDD, using them
doesn’t automatically mean
you’re doing BDD"
The RSpec Book

BDD is a
mindset
not a tool set

Scenario: title
Given [Context]
When I do [Action]
Then I should see [Outcome]

Scenario: title
Given [Context]
And [More Context]
When I do [Action]
And [Other Action]
Then I should see [Outcome]
But I should not see [Outcome]

project_root/
|
`-- features
|-- awesomeness.feature
|-- greatest_ever.feature

project_root/
|
`-- features
`-- support
|-- env.rb
`-- other_helpers.rb

Step Deﬁnition

Given /^a widget$/ do
Given a widget #codes go here
end

Step Deﬁnition
Step Mother

Given /^a widget$/ do
Given a widget #codes go here
end

28+
Languages

RSpec, Test::Unit, etc

28+
Languages

Your Code
RSpec, Test::Unit, etc

Write Code Example
(Unit Test)

features/manage_my_wishes.feature
Feature: manage my wishes

In order to get more stuff
As a greedy person
I want to manage my wish list for my family members to view

@proposed
Scenario: add wish

@proposed
Scenario: remove wish

@proposed
Scenario: tweet wish


Work In Progress
As a greedy person

@wip
Scenario: add wish
Given I am logged in
When I make a "New car" wish
Then "New car" should appear on my wish list

@proposed

@proposed

Workﬂow
git branch -b add_wish_tracker#

Workﬂow
Tag Scenario or Feature with @wip

Workﬂow
cucumber --wip --tags @wip

Workﬂow
Develop it Outside-In

Workﬂow
git rebase ---interactive; git merge

Workﬂow
git rebase ---interactive; git merge
Repeat!

@wip on master?
$ rake -T cucumber

@wip on master?
$ rake -T cucumber
rake cucumber:ok OR rake cucumber

@wip on master?
$ rake -T cucumber
cucumber --tags ~@wip --strict

@wip on master?
$ rake -T cucumber
Tag Exclusion
cucumber --tags ~@wip --strict

@wip on master?
$ rake -T cucumber
rake cucumber:wip

@wip on master?
$ rake -T cucumber
rake cucumber:wip
cucumber --tags @wip:2 --wip

@wip on master?
$ rake -T cucumber in ﬂow
Limit tags
rake cucumber:wip

@wip on master?
$ rake -T cucumber in ﬂow
Limit tags
rake cucumber:wip

Expect failure - Success == Failure

@wip on master?
$ rake -T cucumber
rake cucumber:all
Runs both ok and wip -- great for CI


As a greedy person

@wip
Scenario: add wish
Given I am logged in
When I make a "New car" wish
Then "New car" should appear on my wish list

@proposed

@proposed

Look Ma! backtraces!
Given I am logged in #features/manage_my_wishes.feature:8

features/step_deﬁnitions/user_steps.rb
Given /^I am logged in$/ do
@current_user = create_user(:email_confirmed => true)

end


end

Test Data Builder / Object Mother


end

Fixture Replacement, Fixjour, Factory Girl, etc
spec/ﬁxjour_builders.rb
Fixjour do
define_builder(User) do |klass, overrides|
klass.new(
:email => "user#{counter(:user)}@email.com",
:password => 'password',
:password_confirmation => 'password'
)
end
end


visit new_session_path
fill_in "Email", :with => @current_user.email
fill_in "Password", :with => valid_user_attributes["password"]
click_button
end

Webrat / Awesomeness

click_button
end


click_button
end

features/support/env.rb
require 'webrat'

Webrat.configure do |config|
config.mode = :rails
end


click_button
end

features/support/env.rb
require 'webrat'

Webrat.configure do |config|
config.mode = :rails
end
Adapter


click_button
# make sure we have actually logged in- so we fail fast if not
session[:user_id].should == @current_user.id
end


click_button
controller.current_user.should == @current_user
end


Specify outcome, not implementation.
click_button
controller.current_user.should == @current_user
response.should contain("Signed in successfully")
end


click_button
response.should contain("Signed in successfully")
end

No route matches “/sessions/create” with
{:method=>:post} (ActionController::RoutingError)

I’m going to cheat...
$ gem install thoughtbot-clearance
$ ./script generate clearance
$ ./script generate clearance_features

Authlogic?

http://github.com/hectoregm/groundwork

features/step_deﬁnitions/wish_steps.rb
When /^I make a "(.+)" wish$/ do |wish|

end

Then /^(.+) should appear on my wish list$/ do |wish|

end


end


end

Regexp Capture -> Yielded Variable

visit "/wishes"
click_link "Make a wish"
fill_in "Wish", :with => wish
click_button
end


end

visit "/wishes"
click_button
end

response.should contain("Your wish has been added!")
response.should contain(wish)
end

visit "/wishes"
click_button
end
No route matches “/wishes” with
{:method=>:get} appear on my wish list$/ do |wish|
Then /^(.+) should (ActionController::RoutingError)
response.should contain("Your wish has been added!")
response.should contain(wish)
end

conﬁg/routes.rb
ActionController::Routing::Routes.draw do |map|

map.resources :wishes

conﬁg/routes.rb


When I make a “New car” wish
uninitialized constant WishesController (NameError)

conﬁg/routes.rb


$./script generate rspec_controller new create

conﬁg/routes.rb


Could not find link with text or title or
id “Make a wish” (Webrat::NotFoundError)

app/views/wishes/index.html.erb
<%= link_to "Make a wish", new_wish_path %>

<%= link_to "Make a wish", new_wish_path %>

Could not find field: “Wish” (Webrat::NotFoundError)

visit "/wishes"
click_button
end

visit "/wishes"
click_button
end

app/views/wishes/new.html.erb
<% form_for :wish do |f| %>
<%= f.label :name, "Wish" %>
<%= f.text_field :name %>
<%= submit_tag "Make the wish!" %>
<% end %>

visit "/wishes"
click_button
end
Location Strategy FTW!
app/views/wishes/new.html.erb
<% form_for :wish do |f| %>
<%= f.label :name, "Wish" %>
<%= f.text_field :name %>
<%= submit_tag "Make the wish!" %>
<% end %>

spec/controllers/wishes_controller_spec.rb
describe WishesController do
describe "POST / (#create)" do

end
end


it "creates a new wish for the user with the params" do
user = mock_model(User, :wishes => mock("wishes association"))
controller.stub!(:current_user).and_return(user)

user.wishes.should_receive(:create).with(wish_params)

post :create, 'wish' => {'name' => 'Dog'}
end
end
end

app/controllers/wishes_controller.rb
class WishesController < ApplicationController

def create
current_user.wishes.create(params['wish'])
end

end

before(:each) do
.....

it "redirects the user to their wish list" do
do_post
response.should redirect_to(wishes_path)
end

end
end

def create
redirect_to :action => :index
end

def create
end

undefined method `wishes` for #<User:0x268e898>
(NoMethodError)

def create
end

$./script generate rspec_model wish
name:string user_id:integer

app/models/wish.rb
class Wish < ActiveRecord::Base
belongs_to :user
end

app/models/user.rb
class User < ActiveRecord::Base
include Clearance::App::Models::User
has_many :wishes
end

app/models/wish.rb
class Wish < ActiveRecord::Base
belongs_to :user
end

app/models/user.rb
Then “New <car” should appear on my wish
class User ActiveRecord::Base
include Clearance::App::Models::User
has_many the following element’s content to include
expected:wishes
“Your wish has been added!”
end

it "notifies the user of creation via the flash" do
do_post
flash[:success].should == "Your wish has been added!"
end

it "notifies the user of creation via the flash" do
do_post
end

def create
flash[:success] = "Your wish has been added!"
end

it "should notifies the user of creation via the flash" do
do_post
end

Then “New car” should appear on my wish
expected the following element’s content to include
def create
“New car”
flash[:success] = "Your wish has been added!"
end

describe "GET / (#index)" do
def do_get
get :index
end

it "assigns the user's wishes to the view" do
do_get
assigns[:wishes].should == @current_user.wishes
end

end

def index
@wishes = current_user.wishes
end

How do I
test JS and
AJAX?

FAQ

Slow Integrated

Fast Isolated

Slow Painful

Fast Joyful

Slow Painful

Celerity

Fast Joyful

require "rubygems"
require "celerity"

browser = Celerity::Browser.new

browser.goto('http://www.google.com')
browser.text_field(:name, 'q').value = 'Celerity'
browser.button(:name, 'btnG').click

puts "yay" if browser.text.include? 'celerity.rubyforge.org'

Culerity

http://github.com/langalex/culerity

require "rubygems"
require "culerity"

culerity_server = Culerity::run_server

browser = Culerity::RemoteBrowserProxy.new(culerity_server)
browser.goto('http://www.google.com')
browser.text_field(:name, 'q').value = 'Celerity'
browser.button(:name, 'btnG').click

puts "yay" if browser.text.include? 'celerity.rubyforge.org'

Celerity

+
http://github.com/dstrelau/webrat

HtmlUnit
+
http://github.com/johnnyt/webrat

CodeNote
http://github.com/bmabey/codenote

Feature: CLI Server
For example of how to
In order to save me time and headaches test CLI tools take a look
As a presenter of code at CodeNote on github.

I create a presentation in plaintext RSpec and Cucumber also
have good examples of
a'la Slidedown (from Pat Nakajima) how to do this.
and have CodeNote serve it up for me

Scenario: basic presentation loading and viewing
Given that the codenote server is not running
And a file named "presentation.md" with:
"""
!TITLE My Presentation
!PRESENTER Ben Mabey
# This is the title slide
!SLIDE
# This is second slide...
"""
When I run "codenote_load presentation.md"
And I run "codenote"
And I visit the servers address

Feature: Twitter Quiz
In order to encourage audience participation where
90% of the audience is hacking on laptops
As a presenter I want audience members
To answer certain questions via twitter


@proposed
Scenario: waiting for an answer

@proposed
Scenario: winner is displayed

@proposed
Scenario: fail whale

@proposed
Scenario: network timeout


@wip

@wip
Given the following presentation
"""
!TITLE American History
!PRESENTER David McCullough
# Wanna win a prize?
### You'll have to answer a question...
### in a tweet! First correct tweet wins!
!SLIDE
# Who shot Alexander Hamilton?
## You must use #free_stuff in your tweet.
!DYNAMIC-SLIDE TwitterQuiz '#free_stuff "aaron burr"'
!SLIDE
Okay, that was fun.
Lets actually start now.
"""

@wip
Given the following presentation ...
And no tweets have been tweeted that match
the '#free_stuff "aaron burr"' search
When the presenter goes to the 3rd slide
And I go to the 3rd slide
Then I should see "And the winner is..."
And I should see an ajax spinner

"""
blah, blah
"""

Given /the following presentation$/ do |presentation|

end

"""
blah, blah
"""


end

Yields the multi-line string

"""
blah, blah
"""

CodeNote::PresentationLoader.setup(presentation)
end

How do I
test web
services?

FAQ

http://github.com/chrisk/fakeweb

http://github.com/chrisk/fakeweb

page = `curl -is http://www.google.com/`
FakeWeb.register_uri(:get, "http://www.google.com/",
:response => page)

Net::HTTP.get(URI.parse("http://www.google.com/"))
# => Full response, including headers


Given %r{no tweets have been tweeted that match
the '([']*)' search$} do |query|

end


FakeWeb.register_uri(:get, search_url_for(query),
:body => canned_response_for(query))
end

end

end
Helpers

end
Helpers
def search_url_for(query)
"http://search.twitter.com/search.json?q=#{CGI.escape(query)}"
end

def canned_response_for(query)
....
return file_path
end

end

end

....
return file_path
end

end

“Every time you monkeypatch
Object, a kitten dies.”
end

....
return file_path
end

end

module TwitterHelpers
end

....
return file_path
end

end

end

module TwitterHelpers
end

....
return file_path
end

end

World(TwitterHelpers)


When /I go to the (d+)(?:st|nd|rd|th) slide$/ do |slide_number|
browser.goto path("/slides/#{slide_number}")
end


When /I go to the (d+)(?:st|nd|rd|th) slide$/ do |slide_number|
browser.goto path("/slides/#{slide_number}")
end

Then /I should see "(["]*)"$/ do |text|
browser.should contain(text)
end


Then /I should see an ajax spinner$/ do
browser.image(:id, 'spinner').exists?.should be_true
end


.....
@wip

@wip

@wip

Duplication of context!

...
Background: A presentation with a Twitter Quiz

"""
blah, blah
"""

Extract to ‘Background’

@wip

When the following tweets are tweeted that match


When %r{the following tweets are tweeted that match
the '([']*)' search$} do |query, tweet_table|

end



Cucumber::AST::Table

end




end




Umm... that won’t work.
end




What I would really like is a
test data builder/factory for
end
twitter searches...

http://github.com/bmabey/faketwitter
require 'faketwitter'

FakeTwitter.register_search("#cheese",
{:results => [{:text => "#cheese is good"}]})

require 'twitter_search'
TwitterSearch::Client.new('').query('#cheese')
=> [#<TwitterSearch::Tweet:0x196cef8 @id=1, @text="#cheese is
good", @created_at="Fri, 21 Aug 2009 09:31:27 +0000",
@to_user_id=nil, @from_user_id=1, @to_user=nil, @source="<a
href="http://twitter.com/">web</a>", @iso_language_code="en",
@from_user="jojo", @language="en", @profile_image_url="http://
s3.amazonaws.com/twitter_production/profile_images/1/
photo.jpg">]


FakeTwitter.register_search(query, {
:results => tweet_table.hashes})

end



Our headers and columns
aren’t compatible with API.
end


tweet_table.map_headers! do |header|
header.downcase.gsub(' ','_')
end


end


tweet_table.map_headers! do |header|
header.downcase.gsub(' ','_')
end

tweet_table.map_column!('created_at') do |relative_time|
interpret_time(relative_time)
end

end

Then %r{I should see @([']+)'s tweet along with
(?:his|her) avatar$} do |user|
tweet = FakeTwitter.tweets_from(user).first
browser.should contain(tweet['text'], :wait => 10)
browser.should have_image(:src, tweet['profile_image_url'])
end

Timeout

end

Spec::Matchers.define :contain do |text, options|
match do |browser|
options[:wait] ||= 0
browser.wait_until(options[:wait]) do
browser.text.include?(text)
end
end
end

end

Spec::Matchers.define :contain do |text, options|
match do |browser|
options[:wait] ||= 0
browser.wait_until(options[:wait]) do
browser.text.include?(text)
end
end
end

Keep trying after sleeping
until it times out

When the following tweets are tweeted that match the '#free_stuff "aaron burr"' search
And the presenter goes to the 3rd slide

Then I should see @jefferson's tweet along with his avatar

| Laptop | Thomas |

Given /^the following wishes exist$/ do |table|
table.hashes.each do |row|
member = User.find_by_name(row["Family Member"]) ||
create_user(:name => row["Family Member"])

member.wishes.create!(:name => row["Wish"])
end
end

Table Difﬁng
http://wiki.github.com/aslakhellesoy/cucumber/multiline-step-arguments

Feature: Addition
In order to avoid silly mistakes
As a math idiot
I want to be told the sum of two numbers

Scenario Outline: Add two numbers
Given I have entered <input_1> into the calculator
And I have entered <input_2> into the calculator
When I press <button>
Then the result should be <output> on the screen

Scenarios:
| input_1 | input_2 | button | output |
| 20 | 30 | add | 50 |
| 2 | 5 | add | 7 |
| 0 | 40 | add | 40 |

Feature: Addition
In order to avoid silly mistakes
As a math idiot
I want to be told the sum of two numbers

Scenario Outline: Add two numbers
Given I have entered <input_1> into the calculator
And I have entered <input_2> into the calculator
When I press <button>
Then the result should be <output> on the screen

Scenarios: addition
| input_1 | input_2 | button | output |
| 20 | 30 | add | 50 |
| 2 | 5 | add | 7 |
Scenarios: subtraction
| 0 | 40 | minus | -40 |

Steps Within Steps
When /^I view the wish list for "(.+)"$/ do |user_name|
Given "I am logged in"
visit "/wishes/#{user_name}"
end

Hooks
Before do
end

After do |scenario|
end

World do
end

World(MyModule)
World(HerModule)

Tagged Hooks
Before('@im_special', '@me_too') do
@icecream = true
end

@me_too Feature: Sit
Feature: Lorem @im_special
Scenario: Ipsum Scenario: Amet
Scenario: Dolor Scenario: Consec

Spork

Sick of slow loading times? Spork
will load your main environment
once. It then runs a DRB server so
cucumber (or RSpec) can run
against it with the --drb ﬂag. For
each test run Spork forks a child
process to run them in a clean
memory state. So.. it is a DRb
ser ver that forks.. hence Spork. :)

http://github.com/timcharper/spork

Drinking the
Cucumber
Kool-Aid?

Integration tests
are a scam
J. B. Rainsberger
http://www.jbrains.ca/permalink/239
Obviously, I don’t agree with this
100%. But he has some valid points.
Integrations tests are not a
replacement for good unit tests. Use
cucumber for happy paths. Use lower
level tests for design and to isolate
object behavior.

Cucumber is a
good hammer
Not everything
is a nail

Acceptance Tests Unit Tests

Application Level Object Level- Isolated!
For Customers For developers
Slow FAST! (should be at least)
Good conﬁdence - Tighter Feedback Loop
Prevent against More about design!!!!!!!!!!!!
regression

Will need both gears!
Some things are easier to
test at the application
level and vice-versa.

SRSLY?
Model specs,
Controller Specs,
and view specs!?

More tests ==
More Maintenance

Test Value =
Design +
Documentation +
Defence
(regression)

if test.value > test.cost
Suite.add(test)
end

KTHXBYE!
BenMabey.com
github.com/bmabey
Twitter: bmabey
IRC: mabes

Writing Software not Code with Cucumber

More Related Content

Writing Software not Code with Cucumber