webrat 0.4.3 → 0.4.4

data/History.txt

@@ -1,3 +1,21 @@
+== 0.4.4 / 2009-04-06
+
+* Major enhancements
+
+  * Make selenium process management code more robust and informative
+  
+* Minor enhancements
+  
+  * Add support for Rails javascript post links (Mark Menard)
+  * Upgrade selenium-client dependency to 1.2.14, and update for new waiting
+    API (Balint Erdi)
+  * Change default app environment from "selenium" to "test"
+
+* Bug fixes
+
+  * Don't create a new instance of WWW::Mechanize for each request
+    (Mark Menard)
+  
 == 0.4.3 / 2009-03-17
 
 * Minor enhancements

data/lib/webrat.rb

@@ -7,7 +7,7 @@ module Webrat
   class WebratError < StandardError
   end
 
-  VERSION = '0.4.3'
+  VERSION = '0.4.4'
 
   def self.require_xml
     gem "nokogiri", ">= 1.0.6"

data/lib/webrat/core/configuration.rb

@@ -61,10 +61,10 @@ module Webrat
     def initialize # :nodoc:
       self.open_error_files = true
       self.parse_with_nokogiri = !Webrat.on_java?
-      self.application_environment = :selenium
+      self.application_environment = :test
       self.application_port = 3001
       self.application_address = 'localhost'
-      self.application_framework = 'rails'
+      self.application_framework = :rails
       self.selenium_server_port = 4444
       self.infinite_redirect_limit = 10
       self.selenium_browser_key = '*firefox'

data/lib/webrat/core/elements/link.rb

@@ -81,6 +81,8 @@ module Webrat
         :delete
       elsif onclick.include?("m.setAttribute('value', 'put')")
         :put
+      elsif onclick.include?("m.setAttribute('value', 'post')")
+        :post
       else
         raise Webrat::WebratError.new("No HTTP method for _method param in #{onclick.inspect}")
       end

data/lib/webrat/core_extensions/tcp_socket.rb

@@ -0,0 +1,27 @@
+class TCPSocket
+  
+  def self.wait_for_service_with_timeout(options)
+    start_time = Time.now
+    
+    until listening_service?(options)
+      verbose_wait
+      
+      if options[:timeout] && (Time.now > start_time + options[:timeout])
+        raise SocketError.new("Socket did not open within #{options[:timeout]} seconds")
+      end
+    end
+  end
+  
+  def self.wait_for_service_termination_with_timeout(options)
+    start_time = Time.now
+    
+    while listening_service?(options)
+      verbose_wait
+      
+      if options[:timeout] && (Time.now > start_time + options[:timeout])
+        raise SocketError.new("Socket did not terminate within #{options[:timeout]} seconds")
+      end
+    end
+  end
+  
+end

data/lib/webrat/mechanize.rb

@@ -36,7 +36,7 @@ module Webrat #:nodoc:
     end
     
     def mechanize
-      @mechanize = WWW::Mechanize.new
+      @mechanize ||= WWW::Mechanize.new
     end
 
     def_delegators :mechanize, :basic_auth

data/lib/webrat/selenium.rb

@@ -1,86 +1,11 @@
 require "webrat"
-gem "selenium-client", ">=1.2.9"
+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
-
-  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.pid_file
-    if File.exists?('config.ru')
-      prepare_pid_file(Dir.pwd, 'rack.pid')
-    else
-      prepare_pid_file("#{RAILS_ROOT}/tmp/pids", "mongrel_selenium.pid")
-    end
-  end
-  # Start the appserver for the underlying framework to test
-  #
-  # Sinatra: requires a config.ru in the root of your sinatra app to use this
-  # Merb: Attempts to use bin/merb and falls back to the system merb
-  # Rails: Calls mongrel_rails to startup the appserver
-  def self.start_app_server
-    case Webrat.configuration.application_framework
-    when :sinatra
-      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
-    when :merb
-      cmd = 'merb'
-      if File.exist?('bin/merb')
-        cmd = 'bin/merb'
-      end
-      system("#{cmd} -d -p #{Webrat.configuration.application_port} -e #{Webrat.configuration.application_environment}")
-    else # rails
-      system("mongrel_rails start -d --chdir='#{RAILS_ROOT}' --port=#{Webrat.configuration.application_port} --environment=#{Webrat.configuration.application_environment} --pid #{pid_file} &")
-    end
-    TCPSocket.wait_for_service :host => Webrat.configuration.application_address, :port => Webrat.configuration.application_port.to_i
-  end
-
-  # Stop the appserver for the underlying framework under test
-  #
-  # Sinatra: Reads and kills the pid from the pid file created on startup
-  # Merb: Reads and kills the pid from the pid file created on startup
-  # Rails: Calls mongrel_rails stop to kill the appserver
-  def self.stop_app_server 
-    case Webrat.configuration.application_framework
-    when :sinatra
-      pid = File.read('rack.pid')
-      system("kill -9 #{pid}")
-      FileUtils.rm_f 'rack.pid'
-    when :merb
-      pid = File.read("log/merb.#{Webrat.configuration.application_port}.pid")
-      system("kill -9 #{pid}")
-      FileUtils.rm_f "log/merb.#{Webrat.configuration.application_port}.pid"
-    else # rails
-      system "mongrel_rails stop -c #{RAILS_ROOT} --pid #{pid_file}"
-    end
-  end
-
-  def self.prepare_pid_file(file_path, pid_file_name)
-    FileUtils.mkdir_p File.expand_path(file_path)
-    File.expand_path("#{file_path}/#{pid_file_name}")
-  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>):
   #
@@ -143,6 +68,7 @@ module Webrat
     end
   end
 end
+
 if defined?(ActionController::IntegrationTest)
   module ActionController #:nodoc:
     IntegrationTest.class_eval do

data/lib/webrat/selenium/application_server.rb

@@ -0,0 +1,71 @@
+module Webrat
+  module Selenium
+    
+    class ApplicationServer
+      
+      def self.boot
+        case Webrat.configuration.application_framework
+        when :sinatra
+          require "webrat/selenium/sinatra_application_server"
+          SinatraApplicationServer.new.boot
+        when :merb
+          require "webrat/selenium/merb_application_server"
+          MerbApplicationServer.new.boot
+        when :rails
+          require "webrat/selenium/rails_application_server"
+          RailsApplicationServer.new.boot
+        else
+          raise WebratError.new(<<-STR)
+Unknown Webrat application_framework: #{Webrat.configuration.application_framework.inspect}
+
+Please ensure you have a Webrat configuration block that specifies an application_framework
+in your test_helper.rb, spec_helper.rb, or env.rb (for Cucumber).
+
+For example:
+
+  Webrat.configure do |config|
+    # ...
+    config.application_framework = :rails
+  end
+      STR
+        end
+      end
+      
+      def boot
+        start
+        wait
+        stop_at_exit
+      end
+      
+      def stop_at_exit
+        at_exit do
+          stop
+        end
+      end
+      
+      def wait
+        $stderr.print "==> Waiting for #{Webrat.configuration.application_framework} application server on port #{Webrat.configuration.application_port}... "
+        wait_for_socket
+        $stderr.print "Ready!\n"
+      end
+      
+      def wait_for_socket
+        silence_stream(STDOUT) do
+          TCPSocket.wait_for_service_with_timeout \
+            :host     => Webrat.configuration.application_address,
+            :port     => Webrat.configuration.application_port.to_i,
+            :timeout  => 30 # seconds
+        end
+      rescue SocketError
+        fail
+      end
+
+      def prepare_pid_file(file_path, pid_file_name)
+        FileUtils.mkdir_p File.expand_path(file_path)
+        File.expand_path("#{file_path}/#{pid_file_name}")
+      end
+      
+    end
+    
+  end
+end

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_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

@@ -1,4 +1,6 @@
 require "webrat/core/save_and_open_page"
+require "webrat/selenium/selenium_rc_server"
+require "webrat/selenium/application_server"
 
 module Webrat
   class TimeoutError < WebratError
@@ -39,7 +41,7 @@ module Webrat
 
     def fill_in(field_identifier, options)
       locator = "webrat=#{Regexp.escape(field_identifier)}"
-      selenium.wait_for_element locator, 5
+      selenium.wait_for_element locator, :timeout_in_seconds => 5
       selenium.type(locator, "#{options[:with]}")
     end
 
@@ -62,7 +64,7 @@ module Webrat
       pattern ||= '*'
       locator = "button=#{pattern}"
 
-      selenium.wait_for_element locator, 5
+      selenium.wait_for_element locator, :timeout_in_seconds => 5
       selenium.click locator
     end
 
@@ -71,7 +73,7 @@ module Webrat
     def click_link(link_text_or_regexp, options = {})
       pattern = adjust_if_regexp(link_text_or_regexp)
       locator = "webratlink=#{pattern}"
-      selenium.wait_for_element locator, 5
+      selenium.wait_for_element locator, :timeout_in_seconds => 5
       selenium.click locator
     end
 
@@ -79,7 +81,7 @@ module Webrat
 
     def click_link_within(selector, link_text, options = {})
       locator = "webratlinkwithin=#{selector}|#{link_text}"
-      selenium.wait_for_element locator, 5
+      selenium.wait_for_element locator, :timeout_in_seconds => 5
       selenium.click locator
     end
 
@@ -94,7 +96,7 @@ module Webrat
         select_locator = "webratselectwithoption=#{option_text}"
       end
 
-      selenium.wait_for_element select_locator, 5
+      selenium.wait_for_element select_locator, :timeout_in_seconds => 5
       selenium.select(select_locator, option_text)
     end
 
@@ -102,7 +104,7 @@ module Webrat
 
     def choose(label_text)
       locator = "webrat=#{label_text}"
-      selenium.wait_for_element locator, 5
+      selenium.wait_for_element locator, :timeout_in_seconds => 5
       selenium.click locator
     end
 
@@ -110,7 +112,7 @@ module Webrat
 
     def check(label_text)
       locator = "webrat=#{label_text}"
-      selenium.wait_for_element locator, 5
+      selenium.wait_for_element locator, :timeout_in_seconds => 5
       selenium.click locator
     end
     alias_method :uncheck, :check
@@ -179,6 +181,7 @@ module Webrat
     end
 
   protected
+  
     def silence_stream(stream)
       old_stream = stream.dup
       stream.reopen(RUBY_PLATFORM =~ /mswin/ ? 'NUL:' : '/dev/null')
@@ -189,16 +192,11 @@ module Webrat
     end
 
     def setup #:nodoc:
-      silence_stream(STDOUT) do
-        silence_stream(STDERR) do
-          Webrat.start_selenium_server
-          Webrat.start_app_server
-        end
-      end
+      Webrat::Selenium::SeleniumRCServer.boot
+      Webrat::Selenium::ApplicationServer.boot
 
       create_browser
       $browser.start
-      teardown_at_exit
 
       extend_selenium
       define_location_strategies
@@ -210,14 +208,10 @@ module Webrat
       $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

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: webrat
 version: !ruby/object:Gem::Version 
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors: 
 - Bryan Helmkamp
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-17 00:00:00 -04:00
+date: 2009-04-06 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -85,6 +85,7 @@ files:
 - lib/webrat/core_extensions/detect_mapped.rb
 - lib/webrat/core_extensions/meta_class.rb
 - lib/webrat/core_extensions/nil_to_param.rb
+- lib/webrat/core_extensions/tcp_socket.rb
 - lib/webrat/mechanize.rb
 - lib/webrat/merb.rb
 - lib/webrat/merb_session.rb
@@ -92,6 +93,7 @@ files:
 - lib/webrat/rails.rb
 - lib/webrat/rspec-rails.rb
 - lib/webrat/selenium
+- lib/webrat/selenium/application_server.rb
 - lib/webrat/selenium/location_strategy_javascript
 - lib/webrat/selenium/location_strategy_javascript/button.js
 - lib/webrat/selenium/location_strategy_javascript/label.js
@@ -105,8 +107,12 @@ files:
 - lib/webrat/selenium/matchers/have_tag.rb
 - lib/webrat/selenium/matchers/have_xpath.rb
 - lib/webrat/selenium/matchers.rb
+- lib/webrat/selenium/merb_application_server.rb
+- lib/webrat/selenium/rails_application_server.rb
 - lib/webrat/selenium/selenium_extensions.js
+- lib/webrat/selenium/selenium_rc_server.rb
 - lib/webrat/selenium/selenium_session.rb
+- lib/webrat/selenium/sinatra_application_server.rb
 - lib/webrat/selenium.rb
 - lib/webrat/sinatra.rb
 - lib/webrat.rb