ohammersmith-webrat 0.4.4.98

data/lib/webrat/selenium/merb_application_server.rb

@@ -0,0 +1,48 @@
+module Webrat
+  module Selenium
+
+    class MerbApplicationServer < ApplicationServer
+
+      def start
+        system start_command
+      end
+
+      def stop
+        silence_stream(STDOUT) do
+          pid = File.read(pid_file)
+          system("kill -9 #{pid}")
+          FileUtils.rm_f pid_file
+        end
+      end
+
+      def fail
+        $stderr.puts
+        $stderr.puts
+        $stderr.puts "==> Failed to boot the Merb application server... exiting!"
+        $stderr.puts
+        $stderr.puts "Verify you can start a Merb server on port #{Webrat.configuration.application_port} with the following command:"
+        $stderr.puts
+        $stderr.puts "    #{start_command}"
+        exit
+      end
+
+      def pid_file
+        "log/merb.#{Webrat.configuration.application_port}.pid"
+      end
+
+      def start_command
+        "#{merb_command} -d -p #{Webrat.configuration.application_port} -e #{Webrat.configuration.application_environment}"
+      end
+
+      def merb_command
+        if File.exist?('bin/merb')
+          merb_cmd = 'bin/merb'
+        else
+          merb_cmd = 'merb'
+        end
+      end
+
+    end
+
+  end
+end

data/lib/webrat/selenium/rails_application_server.rb

@@ -0,0 +1,42 @@
+module Webrat
+  module Selenium
+
+    class RailsApplicationServer < ApplicationServer
+
+      def start
+        system start_command
+      end
+
+      def stop
+        silence_stream(STDOUT) do
+          system stop_command
+        end
+      end
+
+      def fail
+        $stderr.puts
+        $stderr.puts
+        $stderr.puts "==> Failed to boot the Rails application server... exiting!"
+        $stderr.puts
+        $stderr.puts "Verify you can start a Rails server on port #{Webrat.configuration.application_port} with the following command:"
+        $stderr.puts
+        $stderr.puts "    #{start_command}"
+        exit
+      end
+
+      def pid_file
+        prepare_pid_file("#{RAILS_ROOT}/tmp/pids", "mongrel_selenium.pid")
+      end
+
+      def start_command
+        "mongrel_rails start -d --chdir='#{RAILS_ROOT}' --port=#{Webrat.configuration.application_port} --environment=#{Webrat.configuration.application_environment} --pid #{pid_file} &"
+      end
+
+      def stop_command
+        "mongrel_rails stop -c #{RAILS_ROOT} --pid #{pid_file}"
+      end
+
+    end
+
+  end
+end

data/lib/webrat/selenium/selenium_extensions.js

@@ -0,0 +1,6 @@
+PatternMatcher.strategies['evalregex'] = function(regexpString) {
+  this.regexp = eval(regexpString);
+  this.matches = function(actual) {
+    return this.regexp.test(actual);
+  };
+};

data/lib/webrat/selenium/selenium_rc_server.rb

@@ -0,0 +1,80 @@
+module Webrat
+  module Selenium
+
+    class SeleniumRCServer
+
+      def self.boot
+        new.boot
+      end
+
+      def boot
+        return if selenium_grid?
+
+        start
+        wait
+        stop_at_exit
+      end
+
+      def start
+        silence_stream(STDOUT) do
+          remote_control.start :background => true
+        end
+      end
+
+      def stop_at_exit
+        at_exit do
+          stop
+        end
+      end
+
+      def remote_control
+        return @remote_control if @remote_control
+
+        @remote_control = ::Selenium::RemoteControl::RemoteControl.new("0.0.0.0", Webrat.configuration.selenium_server_port, 5)
+        @remote_control.jar_file = jar_path
+
+        return @remote_control
+      end
+
+      def jar_path
+        File.expand_path(__FILE__ + "../../../../../vendor/selenium-server.jar")
+      end
+
+      def selenium_grid?
+        Webrat.configuration.selenium_server_address
+      end
+
+      def wait
+        $stderr.print "==> Waiting for Selenium RC server on port #{Webrat.configuration.selenium_server_port}... "
+        wait_for_socket
+        $stderr.print "Ready!\n"
+      rescue SocketError
+        fail
+      end
+
+      def wait_for_socket
+        silence_stream(STDOUT) do
+          TCPSocket.wait_for_service_with_timeout \
+            :host     => (Webrat.configuration.selenium_server_address || "0.0.0.0"),
+            :port     => Webrat.configuration.selenium_server_port,
+            :timeout  => 15 # seconds
+        end
+      end
+
+      def fail
+        $stderr.puts
+        $stderr.puts
+        $stderr.puts "==> Failed to boot the Selenium RC server... exiting!"
+        exit
+      end
+
+      def stop
+        silence_stream(STDOUT) do
+          ::Selenium::RemoteControl::RemoteControl.new("0.0.0.0", Webrat.configuration.selenium_server_port, 5).stop
+        end
+      end
+
+    end
+
+  end
+end

data/lib/webrat/selenium/selenium_session.rb

@@ -0,0 +1,241 @@
+require "webrat/core/save_and_open_page"
+require "webrat/selenium/selenium_rc_server"
+require "webrat/selenium/application_server"
+
+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
+    include Webrat::SaveAndOpenPage
+
+    def initialize(*args) # :nodoc:
+    end
+
+    def simulate
+    end
+
+    def automate
+      yield
+    end
+
+    def visit(url)
+      selenium.open(url)
+    end
+
+    webrat_deprecate :visits, :visit
+
+    def fill_in(field_identifier, options)
+      locator = "webrat=#{Regexp.escape(field_identifier)}"
+      selenium.wait_for_element locator, :timeout_in_seconds => 5
+      selenium.type(locator, "#{options[:with]}")
+    end
+
+    webrat_deprecate :fills_in, :fill_in
+
+    def response
+      SeleniumResponse.new(self, response_body)
+    end
+
+    def response_body #:nodoc:
+      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
+      elsif button_text_or_regexp
+        pattern = adjust_if_regexp(button_text_or_regexp)
+      end
+      pattern ||= '*'
+      locator = "button=#{pattern}"
+
+      selenium.wait_for_element locator, :timeout_in_seconds => 5
+      selenium.click locator
+    end
+
+    webrat_deprecate :clicks_button, :click_button
+
+    def click_link(link_text_or_regexp, options = {})
+      pattern = adjust_if_regexp(link_text_or_regexp)
+      locator = "webratlink=#{pattern}"
+      selenium.wait_for_element locator, :timeout_in_seconds => 5
+      selenium.click locator
+    end
+
+    webrat_deprecate :clicks_link, :click_link
+
+    def click_link_within(selector, link_text, options = {})
+      locator = "webratlinkwithin=#{selector}|#{link_text}"
+      selenium.wait_for_element locator, :timeout_in_seconds => 5
+      selenium.click locator
+    end
+
+    webrat_deprecate :clicks_link_within, :click_link_within
+
+    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.wait_for_element select_locator, :timeout_in_seconds => 5
+      selenium.select(select_locator, option_text)
+    end
+
+    webrat_deprecate :selects, :select
+
+    def choose(label_text)
+      locator = "webrat=#{label_text}"
+      selenium.wait_for_element locator, :timeout_in_seconds => 5
+      selenium.click locator
+    end
+
+    webrat_deprecate :chooses, :choose
+
+    def check(label_text)
+      locator = "webrat=#{label_text}"
+      selenium.wait_for_element locator, :timeout_in_seconds => 5
+      selenium.click locator
+    end
+    alias_method :uncheck, :check
+
+    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 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 silence_stream(stream)
+      old_stream = stream.dup
+      stream.reopen(RUBY_PLATFORM =~ /mswin/ ? 'NUL:' : '/dev/null')
+      stream.sync = true
+      yield
+    ensure
+      stream.reopen(old_stream)
+    end
+
+    def setup #:nodoc:
+      Webrat::Selenium::SeleniumRCServer.boot
+      Webrat::Selenium::ApplicationServer.boot
+
+      create_browser
+      $browser.start
+
+      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
+
+      at_exit do
+        silence_stream(STDOUT) do
+          $browser.stop
+        end
+      end
+    end
+
+    def adjust_if_regexp(text_or_regexp) #:nodoc:
+      if text_or_regexp.is_a?(Regexp)
+        "evalregex:#{text_or_regexp.inspect}"
+      else
+        "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)
+    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)
+      end
+    end
+  end
+end

data/lib/webrat/selenium/sinatra_application_server.rb

@@ -0,0 +1,35 @@
+module Webrat
+  module Selenium
+
+    class SinatraApplicationServer < ApplicationServer
+
+      def start
+        fork do
+          File.open('rack.pid', 'w') { |fp| fp.write Process.pid }
+          exec 'rackup', File.expand_path(Dir.pwd + '/config.ru'), '-p', Webrat.configuration.application_port.to_s
+        end
+      end
+
+      def stop
+        silence_stream(STDOUT) do
+          pid = File.read(pid_file)
+          system("kill -9 #{pid}")
+          FileUtils.rm_f pid_file
+        end
+      end
+
+      def fail
+        $stderr.puts
+        $stderr.puts
+        $stderr.puts "==> Failed to boot the Sinatra application server... exiting!"
+        exit
+      end
+
+      def pid_file
+        prepare_pid_file(Dir.pwd, 'rack.pid')
+      end
+
+    end
+
+  end
+end

data/lib/webrat/selenium.rb

@@ -0,0 +1,80 @@
+require "webrat"
+gem "selenium-client", ">=1.2.14"
+require "selenium/client"
+require "webrat/selenium/selenium_session"
+require "webrat/selenium/matchers"
+require "webrat/core_extensions/tcp_socket"
+
+module Webrat
+  # 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
+  #
+  # == Choosing the underlying framework to test
+  #
+  # Webrat assumes you're using rails by default but it can also work with sinatra
+  # and merb.  To take advantage of this you can use the configuration block to
+  # set the application_framework variable.
+  #   require "webrat"
+  #
+  #   Webrat.configure do |config|
+  #     config.mode = :selenium
+  #     config.application_port = 4567
+  #     config.application_framework = :sinatra  # could also be :merb
+  #   end
+  #
+  # == Auto-starting of the appserver 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
+  # Webrat.configuration.application_port.
+  #
+  # == 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
+
+if defined?(ActionController::IntegrationTest)
+  module ActionController #:nodoc:
+    IntegrationTest.class_eval do
+      include Webrat::Methods
+      include Webrat::Selenium::Methods
+      include Webrat::Selenium::Matchers
+    end
+  end
+end

data/lib/webrat/sinatra.rb

@@ -0,0 +1,44 @@
+require "webrat/rack"
+require "sinatra/test"
+
+module Webrat
+  class SinatraSession < RackSession
+    include Sinatra::Test
+
+    attr_reader :request, :response
+
+    def initialize(context = nil)
+      super(context)
+
+      app = context.respond_to?(:app) ? context.app : Sinatra::Application
+      @browser = Sinatra::TestHarness.new(app)
+    end
+
+    %w(get head post put delete).each do |verb|
+      class_eval <<-RUBY
+        def #{verb}(path, data, headers = {})
+          params = data.inject({}) do |data, (key,value)|
+            data[key] = Rack::Utils.unescape(value)
+            data
+          end
+          headers["HTTP_HOST"] = "www.example.com"
+          @browser.#{verb}(path, params, headers)
+        end
+      RUBY
+    end
+
+    def response_body
+      @browser.body
+    end
+
+    def response_code
+      @browser.status
+    end
+
+    private
+
+      def response
+        @browser.response
+      end
+  end
+end

data/lib/webrat.rb

@@ -0,0 +1,34 @@
+require "rubygems"
+
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__))) unless $LOAD_PATH.include?(File.expand_path(File.dirname(__FILE__)))
+
+module Webrat
+  # The common base class for all exceptions raised by Webrat.
+  class WebratError < StandardError
+  end
+
+  VERSION = '0.4.4'
+
+  def self.require_xml
+    gem "nokogiri", ">= 1.0.6"
+
+    if on_java?
+      # We need Nokogiri's CSS to XPath support, even if using REXML and Hpricot for parsing and searching
+      require "nokogiri/css"
+      require "hpricot"
+      require "rexml/document"
+    else
+      require "nokogiri"
+      require "webrat/core/xml/nokogiri"
+    end
+  end
+
+  def self.on_java?
+    RUBY_PLATFORM =~ /java/
+  end
+
+end
+
+Webrat.require_xml
+
+require "webrat/core"