lib/spec/integration/example/integration_example_group.rb spec/application_controller.rb @@ -1,10 +1,12 @@ -require File.expand_path(File.dirname(__FILE__) + '/testing/plugit_descriptor') +$:.unshift(File.join(File.dirname(__FILE__), 'lib')) -require 'rake/rdoctask' -Rake::RDocTask.new(:doc) do |r| - r.title = "Rails Scenarios Plugin" - r.main = "README" - r.options << "--line-numbers" - r.rdoc_files.include("README", "LICENSE", "lib/**/*.rb") - r.rdoc_dir = "doc" +require 'rubygems' +require 'spec/rake/spectask' + +task :default => :spec + +desc "Run all specs" +Spec::Rake::SpecTask.new do |t| + t.spec_files = FileList['spec/**/*_spec.rb'] + t.spec_opts = ['--options', 'spec/spec.opts'] end \ No newline at end of file Rakefile @@ -3,6 +3,7 @@ require 'spec/rails' require 'spec/integration/extensions' require 'spec/integration/matchers' require 'spec/integration/dsl' +require 'spec/integration/example/integration_example_group' module Spec # :nodoc: module Integration # :nodoc: lib/spec/integration.rb @@ -1,7 +1,5 @@ -Dir[File.dirname(__FILE__) + '/dsl/extensions/*.rb'].each { |f| require f } -require File.dirname(__FILE__) + '/dsl/navigation' -require File.dirname(__FILE__) + '/dsl/form' -require File.dirname(__FILE__) + '/dsl/integration_example_group' +require 'spec/integration/dsl/navigation' +require 'spec/integration/dsl/form' module Spec module Integration lib/spec/integration/dsl.rb @@ -2,155 +2,153 @@ module Spec module Integration module DSL - module FormExampleMethods - # Makes assertions about the existance and validity of a form. - # The _selector_ argument may be - # <tt>a Symbol or String that is the form id</tt> - # <tt>a String that is a valid CSS selector</tt> - # - def sees_form(selector, values, options = {}) - options = { - :verify_field_enablment => false, - :verify_field_values => true - }.merge(options) - - selector = selector.to_s - forms, tried_selector = nil, false - forms = css_select "form##{selector}" if selector =~ /^[a-zA-Z_\-0-9]+$/ - if forms.blank? - tried_selector = true - forms = css_select selector - end + # Makes assertions about the existance and validity of a form. + # The _selector_ argument may be + # <tt>a Symbol or String that is the form id</tt> + # <tt>a String that is a valid CSS selector</tt> + # + def sees_form(selector, values, options = {}) + options = { + :verify_field_enablment => false, + :verify_field_values => true + }.merge(options) + + selector = selector.to_s + forms, tried_selector = nil, false + forms = css_select "form##{selector}" if selector =~ /^[a-zA-Z_\-0-9]+$/ + if forms.blank? + tried_selector = true + forms = css_select selector + end - violated "Found no form having id or matching selector '#{selector}'" if forms.blank? - if forms.size > 1 - violated "Found more than one form having id ##{selector}" if !tried_selector - violated "Found more than one form matching selector '#{selector}'" - end + violated "Found no form having id or matching selector '#{selector}'" if forms.blank? + if forms.size > 1 + violated "Found more than one form having id ##{selector}" if !tried_selector + violated "Found more than one form matching selector '#{selector}'" + end - form = forms[0] - values.to_fields.each do |name, value| - form_fields = css_select form, "input, select, textarea" - matching_field = form_fields.detect {|field| field["name"] == name || field["name"] == "#{name}[]"} - violated "Could not find a form field having the name '#{name}'" unless matching_field - if options[:verify_field_values] - matching_field["value"].should == value - end - if options[:verify_field_enablment] && matching_field["disabled"] - violated "Form '#{selector}' has a field named '#{name}', but it is disabled. You may not submit values to it." - end - if matching_field["type"] == "file" && form["enctype"] != "multipart/form-data" - violated "Form '#{selector}' has a file field named '#{name}', but the enctype is not multipart/form-data" - end - if matching_field.name == "select" - should have_tag(matching_field, "option[value=#{value}]") - end + form = forms[0] + values.to_fields.each do |name, value| + form_fields = css_select form, "input, select, textarea" + matching_field = form_fields.detect {|field| field["name"] == name || field["name"] == "#{name}[]"} + violated "Could not find a form field having the name '#{name}'" unless matching_field + if options[:verify_field_values] + matching_field["value"].should == value + end + if options[:verify_field_enablment] && matching_field["disabled"] + violated "Form '#{selector}' has a field named '#{name}', but it is disabled. You may not submit values to it." + end + if matching_field["type"] == "file" && form["enctype"] != "multipart/form-data" + violated "Form '#{selector}' has a file field named '#{name}', but the enctype is not multipart/form-data" + end + if matching_field.name == "select" + should have_tag(matching_field, "option[value=#{value}]") end - form end + form + end - # Submit a form to the application after verifying it exists in the - # current response body. - # - # If you are looking to use an alternate HTTP method, realize that the - # intention is that you would generate your form appropriately to - # include the hidden _method field. This will be handled by adding - # that value to your form fields. - # - # Other hidden fields will also be added - # unless you pass the option <tt>:include_hidden</tt> with the value - # false. You may find this necessary when you have Arrays of Hashes - - # they are sufficiently too complex to handle correctly in the - # conversion to request parameters, merged with hiddens, and converted - # back to the expected data structure. - # - # This method supports a couple of argument sequences: - # - # submit_form(selector = 'form', values = {}, options = {}) - # submit_form(values = {}, options = {}) - # - # The former allows you to specify which form to submit when there are - # multiple forms on a page. _selector_ may be the id of the form or a - # valid CSS selector. - # - # The latter allows you to assume that there is only one form on the - # page. It essentially defaults selector to the CSS selector 'form'. - # Note that to pass options, you will need to use parens, as in: - # - # submit_form({}, :include_hidden => false) - # - # You CAN use ActionController::TestUploadFile's as parameters, thanks - # to some work done by RubyRedRick! - # - # Supported options are: - # - # * <tt>:include_hidden</tt> - defaults to true. Hidden fields will be - # included into your supplied params. - # * <tt>:verify_field_enablment</tt> - will fail submission if a field - # is disabled. Default is true. - # * <tt>:verify_field_values</tt> - will fail submission if a field - # does not have the provided value already. This is really mostly - # useful when calling _sees_form_ directly. Default is false. - # - def submit_form(*args) - selector = 'form' - values = {} - options = { - :verify_field_enablment => true, - :verify_field_values => false, - :include_hidden => true - } - - case args.size - when 1 - if args.first.is_a?(Hash) - values = args.first - else - selector = args.first - end - when 2 - if args.first.is_a?(Hash) - values = args.first - options.update(args.last) - else - selector, values = *args - end - when 3 - selector, values, = *args + # Submit a form to the application after verifying it exists in the + # current response body. + # + # If you are looking to use an alternate HTTP method, realize that the + # intention is that you would generate your form appropriately to + # include the hidden _method field. This will be handled by adding + # that value to your form fields. + # + # Other hidden fields will also be added + # unless you pass the option <tt>:include_hidden</tt> with the value + # false. You may find this necessary when you have Arrays of Hashes - + # they are sufficiently too complex to handle correctly in the + # conversion to request parameters, merged with hiddens, and converted + # back to the expected data structure. + # + # This method supports a couple of argument sequences: + # + # submit_form(selector = 'form', values = {}, options = {}) + # submit_form(values = {}, options = {}) + # + # The former allows you to specify which form to submit when there are + # multiple forms on a page. _selector_ may be the id of the form or a + # valid CSS selector. + # + # The latter allows you to assume that there is only one form on the + # page. It essentially defaults selector to the CSS selector 'form'. + # Note that to pass options, you will need to use parens, as in: + # + # submit_form({}, :include_hidden => false) + # + # You CAN use ActionController::TestUploadFile's as parameters, thanks + # to some work done by RubyRedRick! + # + # Supported options are: + # + # * <tt>:include_hidden</tt> - defaults to true. Hidden fields will be + # included into your supplied params. + # * <tt>:verify_field_enablment</tt> - will fail submission if a field + # is disabled. Default is true. + # * <tt>:verify_field_values</tt> - will fail submission if a field + # does not have the provided value already. This is really mostly + # useful when calling _sees_form_ directly. Default is false. + # + def submit_form(*args) + selector = 'form' + values = {} + options = { + :verify_field_enablment => true, + :verify_field_values => false, + :include_hidden => true + } + + case args.size + when 1 + if args.first.is_a?(Hash) + values = args.first + else + selector = args.first + end + when 2 + if args.first.is_a?(Hash) + values = args.first options.update(args.last) + else + selector, values = *args end - - form = sees_form(selector, values, options) - violated "Form '#{selector}' is missing an 'action' attribute" if form["action"].blank? - submit_to form["action"], load_hidden_fields(values, form, options[:include_hidden]), form["method"], options + when 3 + selector, values, = *args + options.update(args.last) end - private - def load_hidden_fields(values, form, include_hidden = true) - hiddens = css_select(form, "input[type=hidden]") - return values if hiddens.blank? - - hidden_values = hiddens.inject([]) do |memo,h| - memo << [h['name'], h['value']]; memo - end - - given_values = values.to_fields - form_method = hidden_values.assoc("_method") - given_values << form_method if form_method - - if include_hidden - given_values.each do |fieldvalue| - fieldname = fieldvalue.first - hidden_values.delete_if do |hiddenvalue| - fieldname == hiddenvalue.first - end + form = sees_form(selector, values, options) + violated "Form '#{selector}' is missing an 'action' attribute" if form["action"].blank? + submit_to form["action"], load_hidden_fields(values, form, options[:include_hidden]), form["method"], options + end + + private + def load_hidden_fields(values, form, include_hidden = true) + hiddens = css_select(form, "input[type=hidden]") + return values if hiddens.blank? + + hidden_values = hiddens.inject([]) do |memo,h| + memo << [h['name'], h['value']]; memo + end + + given_values = values.to_fields + form_method = hidden_values.assoc("_method") + given_values << form_method if form_method + + if include_hidden + given_values.each do |fieldvalue| + fieldname = fieldvalue.first + hidden_values.delete_if do |hiddenvalue| + fieldname == hiddenvalue.first end - given_values.concat(hidden_values) end - - ActionController::UrlEncodedPairParser.new(given_values).result + given_values.concat(hidden_values) end - end + + ActionController::UrlEncodedPairParser.new(given_values).result + end end end lib/spec/integration/dsl/form.rb @@ -2,99 +2,97 @@ module Spec module Integration module DSL - module NavigationExampleMethods - # Uses css_select to retrieve the anchor having href_or_id. The - # expects may indicate: - # - # Options are: - # - # * <tt>:count</tt> - An expression indicating the expected number of times the link can appear. - # The default is '>= 1'. - def find_anchors(href_or_id, expects = {}) - expects = {:count => ">= 1"}.update(expects) - expects[:count] = "== #{expects[:count]}" if expects[:count].is_a? Integer - if href_or_id =~ /\// # couldn't be an id with a slash in it - links = css_select "a[href=#{href_or_id}]" - violated "Expected #{expects[:count]} links to #{href_or_id}" unless eval("#{links.size} #{expects[:count]}") - else - links = css_select "a##{href_or_id}" - violated "Expected only one link having id #{href_or_id}. Recall that id's must be unique in a DOM." unless links.size == 1 - end - links + # Uses css_select to retrieve the anchor having href_or_id. The + # expects may indicate: + # + # Options are: + # + # * <tt>:count</tt> - An expression indicating the expected number of times the link can appear. + # The default is '>= 1'. + def find_anchors(href_or_id, expects = {}) + expects = {:count => ">= 1"}.update(expects) + expects[:count] = "== #{expects[:count]}" if expects[:count].is_a? Integer + if href_or_id =~ /\// # couldn't be an id with a slash in it + links = css_select "a[href=#{href_or_id}]" + violated "Expected #{expects[:count]} links to #{href_or_id}" unless eval("#{links.size} #{expects[:count]}") + else + links = css_select "a##{href_or_id}" + violated "Expected only one link having id #{href_or_id}. Recall that id's must be unique in a DOM." unless links.size == 1 end + links + end + + # Clicks the link having either href or id equal to value of :link. If + # you don't care whether the link is actually on the page, try using + # _navigate_to_. + # + # Options are: + # + # * <tt>:link</tt> - href value or element id + # * <tt>:expects</tt> - {:count => <expression>}. See _find_anchors_. + # * <tt>:method</tt> - the preferred method to invoke, which assumes + # there is more than one link with the same href but different + # methods to invoke (like a show and delete link, which use the same + # href but have methods of GET and DELETE). Defaults to :get. + # + def click_on(options) + response.should have_navigated_successfully + options = { + :link => nil, + :expects => {:count => ">= 1"}, + :method => :get + }.update(options) - # Clicks the link having either href or id equal to value of :link. If - # you don't care whether the link is actually on the page, try using - # _navigate_to_. - # - # Options are: - # - # * <tt>:link</tt> - href value or element id - # * <tt>:expects</tt> - {:count => <expression>}. See _find_anchors_. - # * <tt>:method</tt> - the preferred method to invoke, which assumes - # there is more than one link with the same href but different - # methods to invoke (like a show and delete link, which use the same - # href but have methods of GET and DELETE). Defaults to :get. - # - def click_on(options) - integration_session.should have_navigated_successfully - options = { - :link => nil, - :expects => {:count => ">= 1"}, - :method => :get - }.update(options) - - href = nil - method = nil - anchors = find_anchors(options[:link], options[:expects]) - if anchors.size == 1 - anchor = anchors.first - if onclick = anchor["onclick"] - if onclick =~ /setAttribute\('name', '_method'\)/ - onclick =~ /setAttribute\('value', '(get|put|delete|post)'\)/ - href = anchor["href"] - method = $1 - else - violated "There is some funky onclick on that link" - end - else + href = nil + method = nil + anchors = find_anchors(options[:link], options[:expects]) + if anchors.size == 1 + anchor = anchors.first + if onclick = anchor["onclick"] + if onclick =~ /setAttribute\('name', '_method'\)/ + onclick =~ /setAttribute\('value', '(get|put|delete|post)'\)/ href = anchor["href"] + method = $1 + else + violated "There is some funky onclick on that link" end else - anchor = nil - anchors.each do |a| - onclick = a["onclick"] - if options[:method] == :get - anchor = a unless onclick - elsif onclick - if onclick =~ /setAttribute\('name', '_method'\)/ - onclick =~ /setAttribute\('value', '(get|put|delete|post)'\)/ - anchor = a if $1.to_s == options[:method].to_s - else - violated "There is some funky onclick on that link: #{a["onclick"]}" - end + href = anchor["href"] + end + else + anchor = nil + anchors.each do |a| + onclick = a["onclick"] + if options[:method] == :get + anchor = a unless onclick + elsif onclick + if onclick =~ /setAttribute\('name', '_method'\)/ + onclick =~ /setAttribute\('value', '(get|put|delete|post)'\)/ + anchor = a if $1.to_s == options[:method].to_s + else + violated "There is some funky onclick on that link: #{a["onclick"]}" end end - violated "No anchor found with method #{option[:method]}" if anchor.nil? - href = anchor["href"] - method = options[:method] end - navigate_to *[CGI.unescapeHTML(href), method].compact - end - - # Performs _method_ on the specified path, ensuring that doing so was - # successful. Will follow redirects. - def navigate_to(path, method = :get, params = nil, options = {}) - self.send method, path, params || {}, options - follow_redirect! while response.redirect? - integration_session.should have_navigated_successfully(path) - end - - # Submits params to path, using the specified method - :post by - # default - def submit_to(path, params = {}, method = :post, options = {}) - navigate_to path, method, params, options + violated "No anchor found with method #{option[:method]}" if anchor.nil? + href = anchor["href"] + method = options[:method] end + navigate_to *[CGI.unescapeHTML(href), method].compact + end + + # Performs _method_ on the specified path, ensuring that doing so was + # successful. Will follow redirects. + def navigate_to(path, method = :get, params = nil, options = {}) + self.send method, path, params || {}, options + follow_redirect! while response.redirect? + response.should have_navigated_successfully(path) + end + + # Submits params to path, using the specified method - :post by + # default + def submit_to(path, params = {}, method = :post, options = {}) + navigate_to path, method, params, options end end lib/spec/integration/dsl/navigation.rb @@ -1,25 +1,42 @@ -# FIXME: this should be in a module that only gets loaded in integration tests -# This monkeypatch currently makes it impossible to create isolated controller specs -# that pass through exceptions (see “Expecting Errors” on -# http://rspec.info/rdoc-rails/classes/Spec/Rails/Example/ControllerExampleGroup.html) -ActionController::Base.class_eval do - def use_rails_error_handling_with_integration_support? - if Spec::Integration::DSL::IntegrationExample::during_integration_example - true - else - use_rails_error_handling_without_integration_support? +module Spec + module Integration + module Extensions + + # The point of all this is to simply capture the exceptions of an action + # during an integration testing request (get, post, put, etc). This + # exception is later used in the navigation matcher to show the failure + # if navigation did not succeed due to an exception. + # + module ActionController + def self.included(base) + base.extend(ClassMethods) + base.metaclass.module_eval do + alias_method_chain :new, :integration_extensions + end + end + + module ClassMethods #:nodoc: + def new_with_integration_extensions(*args) + controller = new_without_integration_extensions(*args) + if Spec::Integration.executing_integration_example + controller.use_rails_error_handling! + controller.metaclass.module_eval do + attr_reader :rescued_exception + def rescue_action(e) + @rescued_exception = e + super + end + end + end + controller + end + end + end + end end - alias_method_chain :use_rails_error_handling?, :integration_support - - attr_reader :rescued_exception - def rescue_action_with_integration_support(e) - if Spec::Integration::DSL::IntegrationExample::during_integration_example - @rescued_exception = e - rescue_action_without_fast_errors e - else - rescue_action_without_integration_support e - end - end - alias_method_chain :rescue_action, :integration_support end + +ActionController::Base.module_eval do + include Spec::Integration::Extensions::ActionController +end \ No newline at end of file lib/spec/integration/extensions/action_controller.rb @@ -3,15 +3,15 @@ module Spec module Matchers class NavigateSuccessfully #:nodoc: - def initialize(where) - @where = where + def initialize(example, where) + @example, @where = example, where end - def matches?(example) - if example.response.error? || example.response.body =~ /Exception caught/ - @failure_message = extract_exception(example) - elsif example.response.missing? - @failure_message = "Missing document #{example.request.method}'ing #{@where}" + def matches?(response) + if response.error? || response.body =~ /Exception caught/ + @failure_message = extract_exception(@example) + elsif response.missing? + @failure_message = "Missing document #{@example.request.method}'ing #{@where}" end @failure_message.nil? end @@ -48,11 +48,10 @@ module Spec end # Specify that a response should be a good one: successful, not missing, - # no server errors, etc. This is used internally by - # Spec::Integration::DSL::NavigationExampleMethods, made available to - # you for good pleasure. + # no server errors, etc. + # def have_navigated_successfully(where = request.request_uri) - NavigateSuccessfully.new(where) + NavigateSuccessfully.new(self, where) end end lib/spec/integration/matchers/navigate_successfully.rb @@ -2,6 +2,7 @@ require File.dirname(__FILE__) + '/../spec_helper' describe "submit_form", :type => :controller do include Spec::Integration::DSL + include Spec::Integration::Matchers controller_name :integration_dsl before do @@ -13,12 +14,12 @@ describe "submit_form", :type => :controller do end it "should find the form having the given id" do - should_receive(:post).with("/cancel", {}) + should_receive(:post).with("/cancel", {}, an_instance_of(Hash)) submit_form "cancel_form" end it 'should find the form matching the given css selector' do - should_receive(:post).with("/repeat", {}) + should_receive(:post).with("/repeat", {}, an_instance_of(Hash)) submit_form '.special' end @@ -26,12 +27,12 @@ describe "submit_form", :type => :controller do response.stub!(:body).and_return %{ <form action="/single" method="get"></form> } - should_receive(:get).with('/single', {}) + should_receive(:get).with('/single', {}, an_instance_of(Hash)) submit_form end it "should use method of the rendered form" do - should_receive(:get).with("/order", {}) + should_receive(:get).with("/order", {}, an_instance_of(Hash)) submit_form "order_form" end @@ -58,7 +59,7 @@ describe "submit_form", :type => :controller do 'overridden' => 'not_from_form' } } - should_receive(:post).with("/hiddens", @expected) + should_receive(:post).with("/hiddens", @expected, an_instance_of(Hash)) end it 'should be overridden when values are supplied' do @@ -99,7 +100,7 @@ describe 'Expectations about parsing query parameters: ' do def parse_as(expected) satisfy do |uri| - actual = ActionController::AbstractRequest.parse_query_parameters(URI.escape(uri)) + actual = ActionController::UrlEncodedPairParser.parse_query_parameters(URI.escape(uri)) actual == expected end end spec/dsl/form_spec.rb @@ -21,11 +21,11 @@ describe "An integration spec", :type => :integration do end it "should have the form dsl" do - should respond_to("submit_form") + lambda { submit_form }.should_not raise_error(NoMethodError, /submit_form/) end it "should have the navigation dsl" do - should respond_to("navigate_to") + lambda { navigate_to }.should_not raise_error(NoMethodError, /navigate_to/) end it "should have the showing matchers" do spec/dsl/integration_spec_spec.rb @@ -2,6 +2,7 @@ require File.dirname(__FILE__) + '/../spec_helper' describe "find_anchors", :type => :controller do include Spec::Integration::DSL + include Spec::Integration::Matchers controller_name :integration_dsl before do @@ -19,17 +20,14 @@ describe "find_anchors", :type => :controller do end end -describe "have_navigated_successfully", :type => :controller do - include Spec::Integration::DSL - controller_name :integration_dsl - +describe "have_navigated_successfully", :type => :integration do it "should report the exception in the failure message" do with_routing do |set|; set.draw do |map| - map.connect ':controller/:action/:id' - get :exploding + map.connect '/exploding', :controller => 'integration_dsl', :action => 'exploding' + get '/exploding' lambda do - should have_navigated_successfully - end.should fail_with(/This will blow up!/) + response.should have_navigated_successfully + end.should raise_error(Spec::Expectations::ExpectationNotMetError, /This will blow up!/) end; end end end \ No newline at end of file spec/dsl/navigation_spec.rb @@ -1,10 +1,17 @@ SPEC_ROOT = File.expand_path(File.dirname(__FILE__)) -$LOAD_PATH << SPEC_ROOT # for application.rb +$LOAD_PATH.unshift(SPEC_ROOT) # for application_controller.rb + +RAILS_ROOT = File.expand_path("#{SPEC_ROOT}/..") +$LOAD_PATH.unshift("#{RAILS_ROOT}/lib") -require "#{SPEC_ROOT}/../plugit/descriptor" +require 'rubygems' +require 'active_support' +require 'active_record' +require 'action_pack' +require 'action_controller' +require 'action_mailer' -RAILS_ROOT = "#{SPEC_ROOT}/.." -$LOAD_PATH << "#{RAILS_ROOT}/lib" +require 'rails/version' require 'spec/integration' require 'integration_dsl_controller' \ No newline at end of file spec/spec_helper.rb lib/spec/integration/dsl/integration_example_group.rb plugit/descriptor.rb spec/application.rb spec/dispatcher.rb 199f9c9382f72c371dd0ec9a1bf44b9e980ace07 Adam Williams adam@thewilliams.ws http://github.com/aiwilliams/spec_integration/commit/1a38f7833ecb8f2e32a0bc4f104db2cfbcf6663f 1a38f7833ecb8f2e32a0bc4f104db2cfbcf6663f 2009-02-27T14:09:05-08:00 2009-02-27T14:09:05-08:00 Running in Rails 2.3 2ff08eab5d25ceac79f14aa9f0f8df81f7f74643 Adam Williams adam@thewilliams.ws