examples/rails_root/app/controllers/application_controller.rb examples/rails_root/features/support/paths.rb @@ -3,3 +3,5 @@ *.log *.sqlite3 pkg +examples/rails_root/features/step_definitions/email_steps.rb +examples/rails_root/vendor/plugins/email_spec \ No newline at end of file .gitignore @@ -44,6 +44,7 @@ module Rails def load_initializer require "#{RAILS_ROOT}/vendor/rails/railties/lib/initializer" Rails::Initializer.run(:install_gem_spec_stubs) + Rails::GemDependency.add_frozen_gem_path end end examples/rails_root/config/boot.rb @@ -5,7 +5,7 @@ # ENV['RAILS_ENV'] ||= 'production' # Specifies gem version of Rails to use when vendor/rails is not present -RAILS_GEM_VERSION = '2.2.2' unless defined? RAILS_GEM_VERSION +RAILS_GEM_VERSION = '2.3.3' unless defined? RAILS_GEM_VERSION # Bootstrap the Rails environment, frameworks, and default configuration require File.join(File.dirname(__FILE__), 'boot') @@ -13,7 +13,7 @@ require File.join(File.dirname(__FILE__), 'boot') Rails::Initializer.run do |config| config.time_zone = 'UTC' - + config.action_controller.session = { :session_key => '_es_session', :secret => 'b9327c7967925fb36f8901e43f47e0a3e8fc7856ae1b4533ddeda776381548f9ac051721446fdbc4ccc88c7353124708e73d8b0950a30487571d8f8eb5b24732' examples/rails_root/config/environment.rb @@ -21,13 +21,9 @@ config.action_controller.allow_forgery_protection = false # ActionMailer::Base.deliveries array. config.action_mailer.delivery_method = :test - # I HATE config.gem.. it doesn't work as advertised... -config.gem 'webrat', :source => "http://gems.github.com" -#config.gem 'rspec', :lib => 'spec' -#config.gem 'rspec-rails', :lib => 'spec/rails' -config.gem 'cucumber', :source => "http://gems.github.com" # aslakhellesoy-cucumber +config.gem 'cucumber', :lib => false +config.gem 'webrat', :lib => false +config.gem 'rspec', :lib => false +config.gem 'rspec-rails', :lib => 'spec/rails' config.gem 'nakajima-fixjour', :lib => 'fixjour', :source => "http://gems.github.com" # nakajima-fixjour - - - examples/rails_root/config/environments/test.rb @@ -1,42 +1,32 @@ Feature: Email-spec errors example - -In order to help alleviate email testing in apps -As a email-spec contributor I a newcomer -Should be able to easily determine where I have gone wrong -These scenarios should fail with helpful messages - - Scenario: I fail to receive an email - Given I am at "/" - And no emails have been sent - When I fill in "Email" with "example@example.com" - And I press "Sign up" - And I should receive an email - When "example@example.com" opens the email with subject "no email" - - Scenario: I fail to receive an email with the expected link - Given I am at "/" - And no emails have been sent - When I fill in "Email" with "example@example.com" - And I press "Sign up" - And I should receive an email - When I open the email - When I follow "link that doesn't exist" in the email - - Scenario: I attempt to operate on an email that is not opened - Given I am at "/" - And no emails have been sent - When I fill in "Email" with "example@example.com" - And I press "Sign up" - And I should receive an email - When I follow "confirm" in the email - - Scenario: I attempt to check out an unopened email - Given I am at "/" - And no emails have been sent - When I fill in "Email" with "example@example.com" - And I press "Sign up" - Then I should see "confirm" in the email - And I should see "Account confirmation" in the subject - - - + In order to help alleviate email testing in apps + As a email-spec contributor I a newcomer + Should be able to easily determine where I have gone wrong + These scenarios should fail with helpful messages + + Background: + Given I am on the homepage + And no emails have been sent + When I fill in "Email" with "example@example.com" + And I press "Sign up" + + Scenario: I fail to open an email with incorrect subject + Then I should receive an email + When "example@example.com" opens the email with subject "no email" + + Scenario: I fail to open an email with incorrect text + Then I should receive an email + When "example@example.com" opens the email with text "no email" + + Scenario: I fail to receive an email with the expected link + Then I should receive an email + When I open the email + When I follow "link that doesn't exist" in the email + + Scenario: I attempt to operate on an email that is not opened + Then I should receive an email + When I follow "confirm" in the email + + Scenario: I attempt to check out an unopened email + Then I should see "confirm" in the email body + And I should see "Account confirmation" in the email subject examples/rails_root/features/errors.feature @@ -1,59 +1,61 @@ Feature: EmailSpec Example -- Prevent Bots from creating accounts -In order to help alleviate email testing in apps -As an email-spec contributor I want new users of the library -to easily adopt email-spec in their app by following this example + In order to help alleviate email testing in apps + As an email-spec contributor I want new users of the library + to easily adopt email-spec in their app by following this example -In order to prevent bots from setting up new accounts -As a site manager I want new users -to verify their email address with a confirmation link + In order to prevent bots from setting up new accounts + As a site manager I want new users + to verify their email address with a confirmation link -Scenario: A new person signs up imperatively - Given I am a real person wanting to sign up for an account - And I am at "/" + Background: + Given no emails have been sent + And I am a real person wanting to sign up for an account + And I am on the homepage + And I submit my registration information - When I fill in "Email" with "example@example.com" - And I fill in "Name" with "example Jones" - And I press "Sign up" - - Then "example@example.com" should receive 1 email - And "example@example.com" should have 1 email - And "foo@bar.com" should not receive an email + Scenario: First person signup (as myself) with two ways of opening email + Then I should receive an email + And I should have 1 email + And "foo@bar.com" should have no emails - When "example@example.com" opens the email with subject "Account confirmation" + # Opening email #1 + When I open the email + Then I should see "Account confirmation" in the email subject + And I should see "Joe Someone" in the email body + And I should see "confirm" in the email body - Then I should see "confirm" in the email - And I should see "example Jones" in the email - And I should see "Account confirmation" in the subject + # Opening email #2 + When I open the email with subject "Account confirmation" + Then I should see "Account confirmation" in the email subject + And I should see "Joe Someone" in the email body + And I should see "confirm" in the email body When I follow "Click here to confirm your account!" in the email Then I should see "Confirm your new account" + Scenario: Third person signup (emails sent to others) with two ways of opening email + Then "example@example.com" should receive an email + And "example@example.com" should have 1 email + And "foo@bar.com" should have no emails -Scenario: slightly more declarative, but still mostly imperative - Given I am a real person wanting to sign up for an account - And I'm on the signup page - - When I fill in "Email" with "example@example.com" - And I fill in "Name" with "example Jones" - And I press "Sign up" - - Then I should receive an email - - When I open the email - Then I should see "Account confirmation" in the subject - - When I follow "http:///confirm" in the email - Then I should see "Confirm your new account" + # Opening email #1 + When they open the email + Then they should see "Account confirmation" in the email subject + And they should see "Joe Someone" in the email body + And they should see "confirm" in the email body + # Opening email #2 + When "example@example.com" opens the email with subject "Account confirmation" + Then they should see "Account confirmation" in the email subject + And they should see "Joe Someone" in the email body + And they should see "confirm" in the email body - Scenario: declarative - Given I am a real person wanting to sign up for an account - And I'm on the signup page + When they follow "Click here to confirm your account!" in the email + Then they should see "Confirm your new account" - When I submit my registration information + Scenario: Declarative First Person signup Then I should receive an email with a link to a confirmation page - - - + Scenario: Declarative First Person signup + Then they should receive an email with a link to a confirmation page examples/rails_root/features/example.feature @@ -3,21 +3,24 @@ Given "I am a real person wanting to sign up for an account" do end When /^I submit my registration information$/ do - fill_in "Name", :with => valid_user_attributes[:name] - fill_in "Email", :with => valid_user_attributes[:email] + fill_in "Name", :with => 'Joe Someone' + fill_in "Email", :with => 'example@example.com' click_button end -Then /^I should receive an email with a link to a confirmation page$/ do - unread_emails_for(valid_user_attributes[:email]).size.should == 1 - +Then /^(?:I|they) should receive an email with a link to a confirmation page$/ do + unread_emails_for(current_email_address).size.should == 1 + # this call will store the email and you can access it with current_email - open_last_email_for(valid_user_attributes[:email]) + open_last_email_for(last_email_address) current_email.should have_subject(/Account confirmation/) - current_email.should have_body_text(valid_user_attributes[:name]) + current_email.should have_body_text('Joe Someone') click_email_link_matching /confirm/ response.should include_text("Confirm your new account") - end +# Basically aliases "I should see [text]", but for third person +Then /^they should see "([^\"]*)"$/ do |text| + Then "I should see \"#{text}\"" +end examples/rails_root/features/step_definitions/user_steps.rb @@ -1,104 +1,137 @@ +require File.expand_path(File.join(File.dirname(__FILE__), "..", "support", "paths")) + # Commonly used webrat steps # http://github.com/brynary/webrat -Given /^I am at "(.+)"$/ do |path| - visit path +Given /^I am on (.+)$/ do |page_name| + visit path_to(page_name) end -Given /^I'm on the (.+) page$/ do |page| - locations = {"signup" => "/"} - visit locations[page] +When /^I go to (.+)$/ do |page_name| + visit path_to(page_name) end -When /^I press "(.*)"$/ do |button| +When /^I press "([^\"]*)"$/ do |button| click_button(button) end -When /^I follow "(.*)"$/ do |link| +When /^I follow "([^\"]*)"$/ do |link| click_link(link) end -When /^I fill in "(.*)" with "(.*)"$/ do |field, value| - fill_in(field, :with => value) +When /^I follow "([^\"]*)" within "([^\"]*)"$/ do |link, parent| + click_link_within(parent, link) +end + +When /^I fill in "([^\"]*)" with "([^\"]*)"$/ do |field, value| + fill_in(field, :with => value) end -When /^I select "(.*)" from "(.*)"$/ do |value, field| - select(value, :from => field) +When /^I select "([^\"]*)" from "([^\"]*)"$/ do |value, field| + select(value, :from => field) end # Use this step in conjunction with Rail's datetime_select helper. For example: -# When I select "December 25, 2008 10:00" as the date and time -When /^I select "(.*)" as the date and time$/ do |time| +# When I select "December 25, 2008 10:00" as the date and time +When /^I select "([^\"]*)" as the date and time$/ do |time| select_datetime(time) end -# Use this step when using multiple datetime_select helpers on a page or +# Use this step when using multiple datetime_select helpers on a page or # you want to specify which datetime to select. Given the following view: -# <%= f.label :preferred %><br /> -# <%= f.datetime_select :preferred %> -# <%= f.label :alternative %><br /> -# <%= f.datetime_select :alternative %> +# <%%= f.label :preferred %><br /> +# <%%= f.datetime_select :preferred %> +# <%%= f.label :alternative %><br /> +# <%%= f.datetime_select :alternative %> # The following steps would fill out the form: -# When I select "November 23, 2004 11:20" as the "Preferred" data and time -# And I select "November 25, 2004 10:30" as the "Alternative" data and time -When /^I select "(.*)" as the "(.*)" date and time$/ do |datetime, datetime_label| +# When I select "November 23, 2004 11:20" as the "Preferred" date and time +# And I select "November 25, 2004 10:30" as the "Alternative" date and time +When /^I select "([^\"]*)" as the "([^\"]*)" date and time$/ do |datetime, datetime_label| select_datetime(datetime, :from => datetime_label) end -# Use this step in conjuction with Rail's time_select helper. For example: +# Use this step in conjunction with Rail's time_select helper. For example: # When I select "2:20PM" as the time # Note: Rail's default time helper provides 24-hour time-- not 12 hour time. Webrat -# will convert the 2:20PM to 14:20 and then select it. -When /^I select "(.*)" as the time$/ do |time| +# will convert the 2:20PM to 14:20 and then select it. +When /^I select "([^\"]*)" as the time$/ do |time| select_time(time) end # Use this step when using multiple time_select helpers on a page or you want to # specify the name of the time on the form. For example: # When I select "7:30AM" as the "Gym" time -When /^I select "(.*)" as the "(.*)" time$/ do |time, time_label| +When /^I select "([^\"]*)" as the "([^\"]*)" time$/ do |time, time_label| select_time(time, :from => time_label) end -# Use this step in conjuction with Rail's date_select helper. For example: +# Use this step in conjunction with Rail's date_select helper. For example: # When I select "February 20, 1981" as the date -When /^I select "(.*)" as the date$/ do |date| +When /^I select "([^\"]*)" as the date$/ do |date| select_date(date) end # Use this step when using multiple date_select helpers on one page or # you want to specify the name of the date on the form. For example: # When I select "April 26, 1982" as the "Date of Birth" date -When /^I select "(.*)" as the "(.*)" date$/ do |date, date_label| +When /^I select "([^\"]*)" as the "([^\"]*)" date$/ do |date, date_label| select_date(date, :from => date_label) end -When /^I check "(.*)"$/ do |field| - check(field) +When /^I check "([^\"]*)"$/ do |field| + check(field) end -When /^I uncheck "(.*)"$/ do |field| - uncheck(field) +When /^I uncheck "([^\"]*)"$/ do |field| + uncheck(field) end -When /^I choose "(.*)"$/ do |field| +When /^I choose "([^\"]*)"$/ do |field| choose(field) end -When /^I attach the file at "(.*)" to "(.*)" $/ do |path, field| +When /^I attach the file at "([^\"]*)" to "([^\"]*)"$/ do |path, field| attach_file(field, path) end -Then /^I should see "(.*)"$/ do |text| - response.body.should =~ /#{text}/m +Then /^I should see "([^\"]*)"$/ do |text| + response.should contain(text) +end + +Then /^I should see \/([^\/]*)\/$/ do |regexp| + regexp = Regexp.new(regexp) + response.should contain(regexp) +end + +Then /^I should not see "([^\"]*)"$/ do |text| + response.should_not contain(text) end -Then /^I should not see "(.*)"$/ do |text| - response.body.should_not =~ /#{text}/m +Then /^I should not see \/([^\/]*)\/$/ do |regexp| + regexp = Regexp.new(regexp) + response.should_not contain(regexp) end -Then /^the "(.*)" checkbox should be checked$/ do |label| +Then /^the "([^\"]*)" field should contain "([^\"]*)"$/ do |field, value| + field_labeled(field).value.should =~ /#{value}/ +end + +Then /^the "([^\"]*)" field should not contain "([^\"]*)"$/ do |field, value| + field_labeled(field).value.should_not =~ /#{value}/ +end + +Then /^the "([^\"]*)" checkbox should be checked$/ do |label| field_labeled(label).should be_checked end +Then /^the "([^\"]*)" checkbox should not be checked$/ do |label| + field_labeled(label).should_not be_checked +end + +Then /^I should be on (.+)$/ do |page_name| + URI.parse(current_url).path.should == path_to(page_name) +end +Then /^show me the page$/ do + save_and_open_page +end \ No newline at end of file examples/rails_root/features/step_definitions/webrat_steps.rb @@ -1,19 +1,30 @@ # Sets up the Rails environment for Cucumber -ENV["RAILS_ENV"] = "test" +ENV["RAILS_ENV"] ||= "test" require File.expand_path(File.dirname(__FILE__) + '/../../config/environment') require 'cucumber/rails/world' + +# Comment out the next line if you don't want Cucumber Unicode support +require 'cucumber/formatter/unicode' + +# Comment out the next line if you don't want transactions to +# open/roll back around each scenario Cucumber::Rails.use_transactional_fixtures +# Comment out the next line if you want Rails' own error handling +# (e.g. rescue_action_in_public / rescue_responses / rescue_from) +Cucumber::Rails.bypass_rescue + require 'webrat' -require 'cucumber/rails/rspec' -require 'webrat/core/matchers' +require 'cucumber/webrat/table_locator' # Lets you do table.diff!(table_at('#my_table').to_a) Webrat.configure do |config| config.mode = :rails end +require 'cucumber/rails/rspec' +require 'webrat/core/matchers' - +# email testing in cucumber require File.expand_path(File.dirname(__FILE__) + '../../../../../lib/email_spec') require 'email_spec/cucumber' examples/rails_root/features/support/env.rb @@ -10,7 +10,6 @@ I want to verify that the example rails app runs all of it's features as expecte And I run "cucumber features -q --no-color" Then I should see the following summary report: """ - 7 scenarios (4 failed, 3 passed) - 53 steps (4 failed, 1 skipped, 48 passed) + 9 scenarios (5 failed, 4 passed) + 75 steps (5 failed, 1 skipped, 69 passed) """ - features/rails_app.feature @@ -3,7 +3,8 @@ require 'fileutils' Given /^the example rails app is setup with the latest generators$/ do root_dir = File.join(File.expand_path(File.dirname(__FILE__)), "..") - FileUtils.rm("#{root_dir}/examples/rails_root/features/step_definitions/email_steps.rb") + email_specs_path = "#{root_dir}/examples/rails_root/features/step_definitions/email_steps.rb" + FileUtils.rm(email_specs_path) if File.exists?(email_specs_path) FileUtils.mkdir_p("#{root_dir}/examples/rails_root/vendor/plugins/email_spec") FileUtils.cp_r("#{root_dir}/rails_generators", "#{root_dir}/examples/rails_root/vendor/plugins/email_spec/") features/rails_app_steps.rb @@ -1,9 +1,10 @@ -#Commonly used email steps +# Commonly used email steps # # To add your own steps make a custom_email_steps.rb # The provided methods are: # -# reset_mailer +# last_email_address +# reset_mailer # open_last_email # visit_in_email # unread_emails_for @@ -12,6 +13,16 @@ # open_email # read_emails_for # find_email +# +# General form for emails tests is: +# - clear the email queue +# - execute steps that sends an email +# - check the user received an/no/[0-9] emails +# - open the email +# - inspect the email contents +# - interact with the email (e.g. click links) +# +# The Cucumber steps below are setup in this order. module EmailHelpers def current_email_address @@ -23,64 +34,105 @@ module EmailHelpers end World(EmailHelpers) -# Use this step to reset the e-mail queue within a scenario. +# +# Reset the e-mail queue within a scenario. # This is done automatically before each scenario. +# + Given /^(?:a clear email queue|no emails have been sent)$/ do reset_mailer end -# Use this step to open the most recently sent e-mail. -When /^(?:I|they) open the email$/ do - open_email(current_email_address) -end +# +# Check how many emails have been sent/received +# -When %r{^(?:I|they) follow "([^"]*?)" in the email$} do |link| - visit_in_email(link) +Then /^(?:I|they|"([^"]*?)") should receive (an|no|\d+) emails?$/ do |address, amount| + unread_emails_for(parse_current_email(address)).size.should == parse_email_count(amount) end -Then /^(?:I|they) should receive (an|\d+) emails?$/ do |amount| - amount = 1 if amount == "an" - unread_emails_for(current_email_address).size.should == amount.to_i +Then /^(?:I|they|"([^"]*?)") should have (an|no|\d+) emails?$/ do |address, amount| + mailbox_for(parse_current_email(address)).size.should == parse_email_count(amount) end -Then /^(?:I|they) should not receive any emails?$/ do - unread_emails_for(current_email_address).size.should == 0 +# DEPRECATED +# The following methods are left in for backwards compatibility and +# should be removed by version 0.3.5. +Then /^(?:I|they|"([^"]*?)") should not receive an email$/ do |address| + deprecation_notice "The step 'I/they/[email] should not receive an email' is no longer supported. + Please use 'I/they/[email] should receive no emails' instead." + unread_emails_for(parse_current_email(address)).size.should == 0 end -Then %r{^"([^"]*?)" should receive (an|\d+) emails?$} do |address, amount| - amount = 1 if amount == "an" - unread_emails_for(address).size.should == amount.to_i +# +# Accessing emails +# + +# Opens the most recently received email +When /^(?:I|they|"([^"]*?)") opens? the email$/ do |address| + open_email(parse_current_email(address)) end -Then %r{^"([^"]*?)" should have (\d+) emails?$} do |address, n| - mailbox_for(address).size.should == n.to_i +When /^(?:I|they|"([^"]*?)") opens? the email with subject "([^"]*?)"$/ do |address, subject| + open_email(parse_current_email(address), :with_subject => subject) end -Then %r{^"([^"]*?)" should not receive an email$} do |address| - find_email(address).should be_nil +When /^(?:I|they|"([^"]*?)") opens? the email with text "([^"]*?)"$/ do |address, text| + open_email(parse_current_email(address), :with_text => text) end -Then %r{^(?:I|they) should see "([^"]*?)" in the subject$} do |text| +# +# Inspect the Email Contents +# + +Then /^(?:I|they) should see "([^"]*?)" in the email subject$/ do |text| current_email.should have_subject(Regexp.new(text)) end -Then %r{^(?:I|they) should see "([^"]*?)" in the email$} do |text| +Then /^(?:I|they) should see "([^"]*?)" in the email body$/ do |text| current_email.body.should =~ Regexp.new(text) end -When %r{^"([^"]*?)" opens? the email$} do |address| - open_email(address) +# DEPRECATED +# The following methods are left in for backwards compatibility and +# should be removed by version 0.3.5. +Then /^(?:I|they) should see "([^"]*?)" in the subject$/ do |text| + deprecation_notice "The step 'I/they should see [text] in the subject' is no longer supported. + Please use 'I/they should see [text] in the email subject' instead." + current_email.should have_subject(Regexp.new(text)) end - -When %r{^"([^"]*?)" opens? the email with subject "([^"]*?)"$} do |address, subject| - open_email(address, :with_subject => subject) +Then /^(?:I|they) should see "([^"]*?)" in the email$/ do |text| + deprecation_notice "The step 'I/they should see [text] in the email' is no longer supported. + Please use 'I/they should see [text] in the email body' instead." + current_email.body.should =~ Regexp.new(text) end -When %r{^"([^"]*?)" opens? the email with text "([^"]*?)"$} do |address, text| - open_email(address, :with_text => text) +# +# Interact with Email Contents +# + +When /^(?:I|they) follow "([^"]*?)" in the email$/ do |link| + visit_in_email(link) end When /^(?:I|they) click the first link in the email$/ do click_first_link_in_email end +private + +def deprecation_notice(text) + puts "" + puts "DEPRECATION: #{text.split.join(' ')}" + puts "" +end + +def parse_current_email(address) + address.nil? ? current_email_address : address +end + +def parse_email_count(amount) + amount = 0 if amount == "no" + amount = 1 if amount == "an" + amount.to_i +end rails_generators/email_spec/templates/email_steps.rb examples/rails_root/app/controllers/application.rb examples/rails_root/cucumber.yml examples/rails_root/features/step_definitions/email_steps.rb examples/rails_root/vendor/plugins/email_spec/rails_generators/email_spec/email_spec_generator.rb examples/rails_root/vendor/plugins/email_spec/rails_generators/email_spec/templates/email_steps.rb ec0c9bea0d702a6433aae9a10984a8d3c6ecc86f Kieran Pilkington kieran@katipo.co.nz http://github.com/bmabey/email-spec/commit/1cbfde8b3a2a0ca9770e75d95f7f8be8e6598653 1cbfde8b3a2a0ca9770e75d95f7f8be8e6598653 2009-08-13T17:23:44-07:00 2009-08-13T17:23:44-07:00 Refactored email_steps.rb (cleaner, more documented). Refactored test suite (tests more things, and a bit more cleanly). Made necessary changes to get tests working on latest Rails, Cucumber, and Webrat versions. Git no longer tracks examples/rails_root/features/step_definitions/email_steps.rb or examples/rails_root/vendor/plugins/email_spec because they're identical copies we only use in testing. e7d8a65d21891712dce9305953db98095358e06c Kieran Pilkington kieran@katipo.co.nz