webrat 0.3.4 → 0.4.0

data/lib/webrat/selenium.rb

@@ -1,3 +1,94 @@
-require "selenium"
+require "webrat"
+gem "selenium-client", ">=1.2.9"
+require "selenium/client"
 require "webrat/selenium/selenium_session"
+require "webrat/selenium/matchers"
 
+module Webrat
+
+  def self.with_selenium_server #:nodoc:
+    start_selenium_server
+    yield
+    stop_selenium_server
+  end
+
+  def self.start_selenium_server #:nodoc:
+    unless Webrat.configuration.selenium_server_address
+      remote_control = ::Selenium::RemoteControl::RemoteControl.new("0.0.0.0", Webrat.configuration.selenium_server_port, 5)
+      remote_control.jar_file = File.expand_path(__FILE__ + "../../../../vendor/selenium-server.jar")
+      remote_control.start :background => true
+    end
+    TCPSocket.wait_for_service :host => (Webrat.configuration.selenium_server_address || "0.0.0.0"), :port => Webrat.configuration.selenium_server_port
+  end
+
+  def self.stop_selenium_server #:nodoc:
+    ::Selenium::RemoteControl::RemoteControl.new("0.0.0.0", Webrat.configuration.selenium_server_port, 5).stop unless Webrat.configuration.selenium_server_address
+  end
+
+  def self.start_app_server #:nodoc:
+    pid_file = File.expand_path(RAILS_ROOT + "/tmp/pids/mongrel_selenium.pid")
+    system("mongrel_rails start -d --chdir=#{RAILS_ROOT} --port=#{Webrat.configuration.application_port} --environment=#{Webrat.configuration.application_environment} --pid #{pid_file} &")
+    TCPSocket.wait_for_service :host => Webrat.configuration.application_address, :port => Webrat.configuration.application_port.to_i
+  end
+
+  def self.stop_app_server #:nodoc:
+    pid_file = File.expand_path(RAILS_ROOT + "/tmp/pids/mongrel_selenium.pid")
+    system "mongrel_rails stop -c #{RAILS_ROOT} --pid #{pid_file}"
+  end
+
+  # To use Webrat's Selenium support, you'll need the selenium-client gem installed.
+  # Activate it with (for example, in your <tt>env.rb</tt>):
+  #
+  #   require "webrat"
+  #
+  #   Webrat.configure do |config|
+  #     config.mode = :selenium
+  #   end
+  #
+  # == Dropping down to the selenium-client API
+  #
+  # If you ever need to do something with Selenium not provided in the Webrat API,
+  # you can always drop down to the selenium-client API using the <tt>selenium</tt> method.
+  # For example:
+  #
+  #   When "I drag the photo to the left" do
+  #     selenium.dragdrop("id=photo_123", "+350, 0")
+  #   end
+  #
+  # == Auto-starting of the mongrel and java server
+  #
+  # Webrat will automatically start the Selenium Java server process and an instance
+  # of Mongrel when a test is run. The Mongrel will run in the "selenium" environment
+  # instead of "test", so ensure you've got that defined, and will run on port 3001.
+  #
+  # == Waiting
+  #
+  # In order to make writing Selenium tests as easy as possible, Webrat will automatically
+  # wait for the correct elements to exist on the page when trying to manipulate them
+  # with methods like <tt>fill_in</tt>, etc. In general, this means you should be able to write
+  # your Webrat::Selenium tests ignoring the concurrency issues that can plague in-browser
+  # testing, so long as you're using the Webrat API.
+  module Selenium
+    module Methods
+      def response
+        webrat_session.response
+      end
+
+      def wait_for(*args, &block)
+        webrat_session.wait_for(*args, &block)
+      end
+
+      def save_and_open_screengrab
+        webrat_session.save_and_open_screengrab
+      end
+    end
+  end
+end
+
+module ActionController #:nodoc:
+  IntegrationTest.class_eval do
+    include Webrat::Methods
+    include Webrat::Selenium::Methods
+    include Webrat::Selenium::Matchers
+  end
+end

data/lib/webrat/selenium/matchers.rb

@@ -0,0 +1,146 @@
+module Webrat
+  module Selenium
+    module Matchers
+
+      class HaveXpath
+        def initialize(expected)
+          @expected = expected
+        end
+        
+        def matches?(response)
+          response.session.wait_for do
+            response.selenium.is_element_present("xpath=#{@expected}")
+          end
+        end
+
+        # ==== Returns
+        # String:: The failure message.
+        def failure_message
+          "expected following text to match xpath #{@expected}:\n#{@document}"
+        end
+
+        # ==== Returns
+        # String:: The failure message to be displayed in negative matches.
+        def negative_failure_message
+          "expected following text to not match xpath #{@expected}:\n#{@document}"
+        end
+      end
+      
+      def have_xpath(xpath)
+        HaveXpath.new(xpath)
+      end
+      
+      def assert_have_xpath(expected)
+        hs = HaveXpath.new(expected)
+        assert hs.matches?(response), hs.failure_message
+      end
+
+      def assert_have_no_xpath(expected)
+        hs = HaveXpath.new(expected)
+        assert !hs.matches?(response), hs.negative_failure_message
+      end
+      
+      class HaveSelector
+        def initialize(expected)
+          @expected = expected
+        end
+        
+        def matches?(response)
+          response.session.wait_for do
+            response.selenium.is_element_present("css=#{@expected}")
+          end
+        end
+
+        # ==== Returns
+        # String:: The failure message.
+        def failure_message
+          "expected following text to match selector #{@expected}:\n#{@document}"
+        end
+
+        # ==== Returns
+        # String:: The failure message to be displayed in negative matches.
+        def negative_failure_message
+          "expected following text to not match selector #{@expected}:\n#{@document}"
+        end
+      end
+      
+      def have_selector(content)
+        HaveSelector.new(content)
+      end
+      
+      # Asserts that the body of the response contains
+      # the supplied selector
+      def assert_have_selector(expected)
+        hs = HaveSelector.new(expected)
+        assert hs.matches?(response), hs.failure_message
+      end
+
+      # Asserts that the body of the response
+      # does not contain the supplied string or regepx
+      def assert_have_no_selector(expected)
+        hs = HaveSelector.new(expected)
+        assert !hs.matches?(response), hs.negative_failure_message
+      end
+      
+      class HasContent #:nodoc:
+        def initialize(content)
+          @content = content
+        end
+        
+        def matches?(response)
+          if @content.is_a?(Regexp)
+            text_finder = "regexp:#{@content.source}"
+          else
+            text_finder = @content
+          end
+          
+          response.session.wait_for do
+            response.selenium.is_text_present(text_finder)
+          end
+        end
+
+        # ==== Returns
+        # String:: The failure message.
+        def failure_message
+          "expected the following element's content to #{content_message}:\n#{@element}"
+        end
+
+        # ==== Returns
+        # String:: The failure message to be displayed in negative matches.
+        def negative_failure_message
+          "expected the following element's content to not #{content_message}:\n#{@element}"
+        end
+
+        def content_message
+          case @content
+          when String
+            "include \"#{@content}\""
+          when Regexp
+            "match #{@content.inspect}"
+          end
+        end
+      end
+
+      # Matches the contents of an HTML document with
+      # whatever string is supplied
+      def contain(content)
+        HasContent.new(content)
+      end
+      
+      # Asserts that the body of the response contain
+      # the supplied string or regexp
+      def assert_contain(content)
+        hc = HasContent.new(content)
+       assert hc.matches?(response), hc.failure_message
+      end
+
+      # Asserts that the body of the response
+      # does not contain the supplied string or regepx
+      def assert_not_contain(content)
+        hc = HasContent.new(content)
+        assert !hc.matches?(response), hc.negative_failure_message
+      end
+      
+    end
+  end
+end

data/lib/webrat/selenium/selenium_session.rb

@@ -1,136 +1,235 @@
+require "webrat/core/save_and_open_page"
+
 module Webrat
+  class TimeoutError < WebratError
+  end
+
+  class SeleniumResponse
+    attr_reader :body
+    attr_reader :session
+
+    def initialize(session, body)
+      @session = session
+      @body = body
+    end
+
+    def selenium
+      session.selenium
+    end
+  end
+
   class SeleniumSession
-    
-    def initialize(selenium_driver) #:nodoc:
-      @selenium = selenium_driver
-      extend_selenium
-      define_location_strategies
+    include Webrat::SaveAndOpenPage
+
+    def initialize(*args) # :nodoc:
+    end
+
+    def simulate
     end
-    
+
+    def automate
+      yield
+    end
+
     def visit(url)
-      @selenium.open(url)
+      selenium.open(url)
     end
-    
-    alias_method :visits, :visit
-    
+
+    webrat_deprecate :visits, :visit
+
     def fill_in(field_identifier, options)
       locator = "webrat=#{Regexp.escape(field_identifier)}"
-      @selenium.type(locator, "#{options[:with]}")
+      selenium.wait_for_element locator, 5
+      selenium.type(locator, "#{options[:with]}")
+    end
+
+    webrat_deprecate :fills_in, :fill_in
+
+    def response
+      SeleniumResponse.new(self, response_body)
     end
-    
-    alias_method :fills_in, :fill_in
-    
+
     def response_body #:nodoc:
-      @selenium.get_html_source
+      selenium.get_html_source
     end
-    
+
     def click_button(button_text_or_regexp = nil, options = {})
       if button_text_or_regexp.is_a?(Hash) && options == {}
         pattern, options = nil, button_text_or_regexp
-      else
+      elsif button_text_or_regexp
         pattern = adjust_if_regexp(button_text_or_regexp)
       end
       pattern ||= '*'
-      @selenium.click("button=#{pattern}")
-      wait_for_result(options[:wait])
+      locator = "button=#{pattern}"
+
+      selenium.wait_for_element locator, 5
+      selenium.click locator
     end
-    
-    alias_method :clicks_button, :click_button
+
+    webrat_deprecate :clicks_button, :click_button
 
     def click_link(link_text_or_regexp, options = {})
       pattern = adjust_if_regexp(link_text_or_regexp)
-      @selenium.click("webratlink=#{pattern}")
-      wait_for_result(options[:wait])
-    end
-    
-    alias_method :clicks_link, :click_link
-    
-    def click_link_within(selector, link_text, options = {})
-      @selenium.click("webratlinkwithin=#{selector}|#{link_text}")
-      wait_for_result(options[:wait])
-    end
-    
-    alias_method :clicks_link_within, :click_link_within
-
-    def wait_for_result(wait_type)
-      if wait_type == :ajax
-        wait_for_ajax
-      elsif wait_type == :effects
-        wait_for_effects
-      else
-        wait_for_page_to_load
-      end
+      locator = "webratlink=#{pattern}"
+      selenium.wait_for_element locator, 5
+      selenium.click locator
     end
 
-    def wait_for_page_to_load(timeout = 15000)
-      @selenium.wait_for_page_to_load(timeout)
-    end
+    webrat_deprecate :clicks_link, :click_link
 
-    def wait_for_ajax(timeout = 15000)
-      @selenium.wait_for_condition "Ajax.activeRequestCount == 0", timeout
+    def click_link_within(selector, link_text, options = {})
+      locator = "webratlinkwithin=#{selector}|#{link_text}"
+      selenium.wait_for_element locator, 5
+      selenium.click locator
     end
 
-    def wait_for_effects(timeout = 15000)
-      @selenium.wait_for_condition "window.Effect.Queue.size() == 0", timeout
-    end
+    webrat_deprecate :clicks_link_within, :click_link_within
 
-    def wait_for_ajax_and_effects
-      wait_for_ajax
-      wait_for_effects
-    end    
-    
-    def selects(option_text, options = {})
+    def select(option_text, options = {})
       id_or_name_or_label = options[:from]
-      
+
       if id_or_name_or_label
         select_locator = "webrat=#{id_or_name_or_label}"
       else
         select_locator = "webratselectwithoption=#{option_text}"
       end
-      @selenium.select(select_locator, option_text)
+
+      selenium.wait_for_element select_locator, 5
+      selenium.select(select_locator, option_text)
     end
-    
+
+    webrat_deprecate :selects, :select
+
     def choose(label_text)
-      @selenium.click("webrat=#{label_text}")
+      locator = "webrat=#{label_text}"
+      selenium.wait_for_element locator, 5
+      selenium.click locator
     end
-    
-    alias_method :chooses, :choose
-        
+
+    webrat_deprecate :chooses, :choose
+
     def check(label_text)
-      @selenium.check("webrat=#{label_text}")
+      locator = "webrat=#{label_text}"
+      selenium.wait_for_element locator, 5
+      selenium.check locator
     end
-    
-    alias_method :checks, :check
-    
-    def is_ordered(*args) #:nodoc:
-      @selenium.is_ordered(*args)
+
+    webrat_deprecate :checks, :check
+
+    def fire_event(field_identifier, event)
+      locator = "webrat=#{Regexp.escape(field_identifier)}"
+      selenium.fire_event(locator, "#{event}")
+    end
+
+    def key_down(field_identifier, key_code)
+      locator = "webrat=#{Regexp.escape(field_identifier)}"
+      selenium.key_down(locator, key_code)
+    end
+
+    def key_up(field_identifier, key_code)
+      locator = "webrat=#{Regexp.escape(field_identifier)}"
+      selenium.key_up(locator, key_code)
+    end
+
+    def wait_for(params={})
+      timeout = params[:timeout] || 5
+      message = params[:message] || "Timeout exceeded"
+
+      begin_time = Time.now
+
+      while (Time.now - begin_time) < timeout
+        value = nil
+
+        begin
+          value = yield
+        rescue ::Spec::Expectations::ExpectationNotMetError, ::Selenium::CommandError, Webrat::WebratError
+          value = nil
+        end
+
+        return value if value
+
+        sleep 0.25
+      end
+
+      raise Webrat::TimeoutError.new(message + " (after #{timeout} sec)")
+      true
     end
-    
-    def dragdrop(*args) #:nodoc:
-      @selenium.dragdrop(*args)
+
+    def selenium
+      return $browser if $browser
+      setup
+      $browser
     end
-        
+
+    webrat_deprecate :browser, :selenium
+
+
+    def save_and_open_screengrab
+      return unless File.exist?(saved_page_dir)
+
+      filename = "#{saved_page_dir}/webrat-#{Time.now.to_i}.png"
+
+      if $browser.chrome_backend?
+        $browser.capture_entire_page_screenshot(filename, '')
+      else
+        $browser.capture_screenshot(filename)
+      end
+        open_in_browser(filename)
+    end
+
   protected
-    
+
+    def setup #:nodoc:
+      silence_stream(STDOUT) do
+        Webrat.start_selenium_server
+        Webrat.start_app_server
+      end
+
+      create_browser
+      $browser.start
+      teardown_at_exit
+
+      extend_selenium
+      define_location_strategies
+      $browser.window_maximize
+    end
+
+
+    def create_browser
+      $browser = ::Selenium::Client::Driver.new(Webrat.configuration.selenium_server_address || "localhost",
+          Webrat.configuration.selenium_server_port, Webrat.configuration.selenium_browser_key, "http://#{Webrat.configuration.application_address}:#{Webrat.configuration.application_port}")
+      $browser.set_speed(0) unless Webrat.configuration.selenium_server_address
+    end
+
+    def teardown_at_exit #:nodoc:
+      at_exit do
+        silence_stream(STDOUT) do
+          $browser.stop
+          Webrat.stop_app_server
+          Webrat.stop_selenium_server
+        end
+      end
+    end
+
     def adjust_if_regexp(text_or_regexp) #:nodoc:
       if text_or_regexp.is_a?(Regexp)
         "evalregex:#{text_or_regexp.inspect}"
       else
-        text_or_regexp
-      end 
+        "evalregex:/#{text_or_regexp}/"
+      end
     end
-    
+
     def extend_selenium #:nodoc:
       extensions_file = File.join(File.dirname(__FILE__), "selenium_extensions.js")
       extenions_js = File.read(extensions_file)
-      @selenium.get_eval(extenions_js)
+      selenium.get_eval(extenions_js)
     end
-    
+
     def define_location_strategies #:nodoc:
       Dir[File.join(File.dirname(__FILE__), "location_strategy_javascript", "*.js")].sort.each do |file|
         strategy_js = File.read(file)
         strategy_name = File.basename(file, '.js')
-        @selenium.add_location_strategy(strategy_name, strategy_js)
+        selenium.add_location_strategy(strategy_name, strategy_js)
       end
     end
   end