selenium-client 1.2.10 → 1.2.11

data/README.markdown

@@ -42,6 +42,8 @@ Features
   * `click 'the_button_id', :wait_for => :no_text, :text => 'Disappearing Text'`
   * `click 'the_button_id', :wait_for => :no_text, :element => 'notification_box', :text => 'Disappearing Text'`
   * `click 'the_button_id', :wait_for => :effects`
+  * `click 'the_button_id', :wait_for => :value, :element => 'a_locator', :value => 'some value'`
+  * `click 'the_button_id', :wait_for => :no_value, :element => 'a_locator', :value => 'some value' # will wait for the field value of 'a_locator' to not be 'some value'`  
   * `click 'the_button_id', :wait_for => :condition, :javascript => "some arbitrary javascript expression"`
 
   Check out the `click`, `go_back` and `wait_for` methods of the [Idiomatic Module](http://selenium-client.rubyforge.org/classes/Selenium/Client/Idiomatic.html)
@@ -76,19 +78,26 @@ Plain API
     # Sample Ruby script using the Selenium client API
     #
     require "rubygems"
-    gem "selenium-client", ">=1.2.9"
+    gem "selenium-client", ">=1.2.11"
     require "selenium/client"
-
+    
     begin
-      @browser = Selenium::Client::Driver.new("localhost", 4444, "*firefox", "http://www.google.com", 10000);
+      @browser = Selenium::Client::Driver.new \
+          :host => "localhost", 
+          :port => 4444, 
+          :browser => "*firefox", 
+          :url => "http://www.google.com", 
+          :timeout_in_second => 60
+    
       @browser.start_new_browser_session
     	@browser.open "/"
-    	@browser.type "q", "Selenium"
+    	@browser.type "q", "Selenium seleniumhq.org"
     	@browser.click "btnG", :wait_for => :page
-    	puts @browser.text?("selenium.openqa.org")
+    	puts @browser.text?("seleniumhq.org")
     ensure
       @browser.close_current_browser_session    
     end
+
  
 Writing Tests
 =============
@@ -102,70 +111,83 @@ Writing Tests
     #
     require "test/unit"
     require "rubygems"
-    gem "selenium-client", ">=1.2.9"
+    gem "selenium-client", ">=1.2.11"
     require "selenium/client"
-
+    
     class ExampleTest < Test::Unit::TestCase
     	attr_reader :browser
-
+    
       def setup
-        @browser = Selenium::Client::Driver.new "localhost", 4444, "*firefox", "http://www.google.com", 10000
+        @browser = Selenium::Client::Driver.new \
+            :host => "localhost", 
+            :port => 4444, 
+            :browser => "*firefox", 
+            :url => "http://www.google.com", 
+            :timeout_in_second => 60
+    
         browser.start_new_browser_session
       end
-
+    
       def teardown
         browser.close_current_browser_session
       end
-
+    
       def test_page_search
     		browser.open "/"
     		assert_equal "Google", browser.title
-    		browser.type "q", "Selenium"
+    		browser.type "q", "Selenium seleniumhq"
     		browser.click "btnG", :wait_for => :page
-    		assert_equal "Selenium - Google Search", browser.title
-    		assert_equal "Selenium", browser.field("q")
-    		assert browser.text?("selenium.openqa.org")
+    		assert_equal "Selenium seleniumhq - Google Search", browser.title
+    		assert_equal "Selenium seleniumhq", browser.field("q")
+    		assert browser.text?("seleniumhq.org")
     		assert browser.element?("link=Cached")
       end
-
+    
     end
     
  If BDD is more your style, here is how you can achieve the same thing  using RSpec:
 
     require 'rubygems'
-    gem "rspec", "=1.1.11"
-    gem "selenium-client", ">=1.2.9"
+    gem "rspec", "=1.1.12"
+    gem "selenium-client", ">=1.2.11"
     require "selenium/client"
     require "selenium/rspec/spec_helper"
-
+    
     describe "Google Search" do
     	attr_reader :selenium_driver
     	alias :page :selenium_driver
-
-     before(:all) do
-       @selenium_driver = Selenium::Client::Driver.new "localhost", 4444, "*firefox", "http://www.google.com", 10000    
-     end
-
-     before(:each) do
-       selenium_driver.start_new_browser_session
-     end
-
-     # The system capture need to happen BEFORE closing the Selenium session 
-     append_after(:each) do    
-       @selenium_driver.close_current_browser_session
-     end
-
-     it "can find Selenium" do    
-       page.open "/"
-       page.title.should eql("Google")
-       page.type "q", "Selenium"
-       page.click "btnG", :wait_for => :page
-       page.value("q").should eql("Selenium")
-       page.text?("selenium.openqa.org").should be_true
-       page.title.should eql("Selenium - Google Search")
-     end
-
-    end 
+    
+      before(:all) do
+          @selenium_driver = Selenium::Client::Driver.new \
+              :host => "localhost", 
+              :port => 4444, 
+              :browser => "*firefox", 
+              :url => "http://www.google.com", 
+              :timeout_in_second => 60
+      end
+    
+      before(:each) do
+        selenium_driver.start_new_browser_session
+      end
+    
+      # The system capture need to happen BEFORE closing the Selenium session 
+      append_after(:each) do    
+        @selenium_driver.close_current_browser_session
+      end
+    
+      it "can find Selenium" do    
+        page.open "/"
+        page.title.should eql("Google")
+        page.type "q", "Selenium seleniumhq"
+        page.click "btnG", :wait_for => :page
+        page.value("q").should eql("Selenium seleniumhq")
+        page.text?("seleniumhq.org").should be_true
+        page.title.should eql("Selenium seleniumhq - Google Search")
+        page.text?("seleniumhq.org").should be_true
+    		page.element?("link=Cached").should be_true		
+      end
+    
+    end
 
 Start/Stop a Selenium Remote Control Server
 ===========================================

data/examples/rspec/google_spec.rb

@@ -0,0 +1,41 @@
+require 'rubygems'
+gem "rspec", "=1.1.12"
+gem "selenium-client", ">=1.2.11"
+require "selenium/client"
+require "selenium/rspec/spec_helper"
+
+describe "Google Search" do
+	attr_reader :selenium_driver
+	alias :page :selenium_driver
+
+  before(:all) do
+      @selenium_driver = Selenium::Client::Driver.new \
+          :host => "localhost", 
+          :port => 4444, 
+          :browser => "*firefox", 
+          :url => "http://www.google.com", 
+          :timeout_in_second => 60
+  end
+  
+  before(:each) do
+    selenium_driver.start_new_browser_session
+  end
+  
+  # The system capture need to happen BEFORE closing the Selenium session 
+  append_after(:each) do    
+    @selenium_driver.close_current_browser_session
+  end
+
+  it "can find Selenium" do    
+    page.open "/"
+    page.title.should eql("Google")
+    page.type "q", "Selenium seleniumhq"
+    page.click "btnG", :wait_for => :page
+    page.value("q").should eql("Selenium seleniumhq")
+    page.text?("seleniumhq.org").should be_true
+    page.title.should eql("Selenium seleniumhq - Google Search")
+    page.text?("seleniumhq.org").should be_true
+		page.element?("link=Cached").should be_true		
+  end
+    
+end

data/examples/script/google.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+#
+# Sample Ruby script using the Selenium client API
+#
+require "rubygems"
+gem "selenium-client", ">=1.2.11"
+require "selenium/client"
+
+begin
+  @browser = Selenium::Client::Driver.new \
+      :host => "localhost", 
+      :port => 4444, 
+      :browser => "*firefox", 
+      :url => "http://www.google.com", 
+      :timeout_in_second => 60
+
+  @browser.start_new_browser_session
+	@browser.open "/"
+	@browser.type "q", "Selenium seleniumhq.org"
+	@browser.click "btnG", :wait_for => :page
+	puts @browser.text?("seleniumhq.org")
+ensure
+  @browser.close_current_browser_session    
+end
+

data/examples/testunit/google_test.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+#
+# Sample Test:Unit based test case using the selenium-client API
+#
+require "test/unit"
+require "rubygems"
+gem "selenium-client", ">=1.2.11"
+require "selenium/client"
+
+class ExampleTest < Test::Unit::TestCase
+	attr_reader :browser
+   
+  def setup
+    @browser = Selenium::Client::Driver.new \
+        :host => "localhost", 
+        :port => 4444, 
+        :browser => "*firefox", 
+        :url => "http://www.google.com", 
+        :timeout_in_second => 60
+
+    browser.start_new_browser_session
+  end
+    
+  def teardown
+    browser.close_current_browser_session
+  end
+  
+  def test_page_search
+		browser.open "/"
+		assert_equal "Google", browser.title
+		browser.type "q", "Selenium seleniumhq"
+		browser.click "btnG", :wait_for => :page
+		assert_equal "Selenium seleniumhq - Google Search", browser.title
+		assert_equal "Selenium seleniumhq", browser.field("q")
+		assert browser.text?("seleniumhq.org")
+		assert browser.element?("link=Cached")
+  end
+    
+end

data/lib/selenium/client.rb

@@ -13,6 +13,8 @@ require File.expand_path(File.dirname(__FILE__) + '/command_error')
 require File.expand_path(File.dirname(__FILE__) + '/protocol_error')
 require File.expand_path(File.dirname(__FILE__) + '/client/protocol')
 require File.expand_path(File.dirname(__FILE__) + '/client/generated_driver')
+require File.expand_path(File.dirname(__FILE__) + '/client/javascript_frameworks/jquery')
+require File.expand_path(File.dirname(__FILE__) + '/client/javascript_frameworks/prototype')
 require File.expand_path(File.dirname(__FILE__) + '/client/extensions')
 require File.expand_path(File.dirname(__FILE__) + '/client/idiomatic')
 require File.expand_path(File.dirname(__FILE__) + '/client/base')

data/lib/selenium/client/base.rb

@@ -2,26 +2,60 @@ module Selenium
   module Client
     
 		# Driver constructor and session management commands
-		#
-		# Original code by Aslak Hellesoy and Darren Hobbs
     module Base
       include Selenium::Client::Protocol
       include Selenium::Client::GeneratedDriver
       include Selenium::Client::Extensions
       include Selenium::Client::Idiomatic
 
-      attr_reader :browser_string
+      attr_reader :host, :port, :browser_string, :browser_url, 
+                  :default_timeout_in_seconds, :default_javascript_framework
   
-      def initialize(server_host, server_port, browser_string, browser_url, timeout_in_seconds=300)
-        @server_host = server_host
-        @server_port = server_port
-        @browser_string = browser_string
-        @browser_url = browser_url
-        @timeout = timeout_in_seconds
+      #
+      # Create a new client driver
+      #
+      # Example:
+      #
+      # Selenium::Client::Driver.new \
+      #     :host => "localhost",
+      #     :port => 4444,
+      #     :browser => "*firefox",
+      #     :timeout_in_seconds => 10,
+      #     :url => "http://localhost:3000",
+      #
+      # You can also set the default javascript framework used for :wait_for
+      # AJAX and effects semantics (:prototype is the default value):
+      #
+      # Selenium::Client::Driver.new \
+      #     :host => "localhost",
+      #     :port => 4444,
+      #     :browser => "*firefox",
+      #     :timeout_in_seconds => 10,
+      #     :url => "http://localhost:3000",
+      #     :javascript_framework => :jquery
+      #
+      def initialize(*args)
+        if args[0].kind_of?(Hash)
+          options = args[0]
+          @host = options[:host]
+          @port = options[:port].to_i
+          @browser_string = options[:browser]
+          @browser_url = options[:url]
+          @default_timeout_in_seconds = (options[:timeout_in_seconds] || 300).to_i
+          @default_javascript_framework = options[:javascript_framework] || :prototype
+        else
+          @host = args[0]
+          @port = args[1].to_i
+          @browser_string = args[2]
+          @browser_url = args[3]
+          @default_timeout_in_seconds = (args[4] || 300).to_i
+          @default_javascript_framework = :prototype
+        end
+
         @extension_js = ""
         @session_id = nil
       end
-      
+
       def session_started?
         not @session_id.nil?
       end
@@ -31,7 +65,7 @@ module Selenium
         @session_id = result
         # Consistent timeout on the remote control and driver side.
         # Intuitive and this is what you want 90% of the time
-        self.remote_control_timeout_in_seconds = @timeout 
+        self.remote_control_timeout_in_seconds = @default_timeout_in_seconds 
       end
       
       def close_current_browser_session

data/lib/selenium/client/driver.rb

@@ -4,6 +4,7 @@ module Selenium
     # Client driver providing the complete API to drive a Selenium Remote Control
     class Driver
       include Selenium::Client::Base
+      
     end
   
   end

data/lib/selenium/client/extensions.rb

@@ -8,45 +8,30 @@ module Selenium
 	    #
 	    # See http://davidvollbracht.com/2008/6/4/30-days-of-tech-day-3-waitforajax for
 	    # more background.
-      def wait_for_ajax(timeout_in_seconds=nil)
-	      wait_for_condition "selenium.browserbot.getCurrentWindow().Ajax.activeRequestCount == 0", timeout_in_seconds
+      def wait_for_ajax(options={})
+        framework = javascript_framework_for(options[:javascript_framework] || default_javascript_framework)
+	      wait_for_condition window_script("#{framework.ajax_request_tracker} == 0"), 
+	                         options[:timeout_in_seconds]
 	    end
 	
 	    # Wait for all Prototype effects to be processed (the wait in happenning browser side).
 	    #
 	    # Credits to http://github.com/brynary/webrat/tree/master
-			def wait_for_effects(timeout_in_seconds=nil)
-			  wait_for_condition "window.Effect.Queue.size() == 0", timeout_in_seconds
+			def wait_for_effects(options={})
+			  wait_for_condition window_script("Effect.Queue.size() == 0"), 
+			                     options[:timeout_in_seconds]
 			end
 			
 			# Wait for an element to be present (the wait in happenning browser side).
-		  def wait_for_element(locator, timeout_in_seconds=nil)
-		    script = <<-EOS
-		    var element;
-		    try {
-		      element = selenium.browserbot.findElement('#{locator}');
-		    } catch(e) {
-		      element = null;
-		    }
-		    element != null;
-		    EOS
-
-		    wait_for_condition script, timeout_in_seconds
+		  def wait_for_element(locator, options={})
+		    wait_for_condition find_element_script(locator, "element != null"), 
+		                       options[:timeout_in_seconds]
 		  end
 
 			# Wait for an element to NOT be present (the wait in happenning browser side).
-		  def wait_for_no_element(locator, timeout_in_seconds=nil)
-		    script = <<-EOS
-		    var element;
-		    try {
-		      element = selenium.browserbot.findElement('#{locator}');
-		    } catch(e) {
-		      element = null;
-		    }
-		    element == null;
-		    EOS
-
-		    wait_for_condition script, timeout_in_seconds
+		  def wait_for_no_element(locator, options={})
+		    wait_for_condition find_element_script(locator, "element == null"), 
+		                       options[:timeout_in_seconds]
 		  end
 
 			# Wait for some text to be present (the wait in happenning browser side).
@@ -56,31 +41,13 @@ module Selenium
 			#
 			# If a non nil locator is provided, the text will be
 			# detected within the innerHTML of the element identified by the locator.			
-		  def wait_for_text(text, locator=nil, timeout_in_seconds=nil)
-		    script = case locator
-		    when nil:
-  		    <<-EOS
-              var text;
-              try {
-                text = selenium.browserbot.getCurrentWindow().find('#{text}');
-              } catch(e) {
-                text = null;
-              }
-              text != null;
-          EOS
-        else
-  		    <<-EOS
-  		        var element;
-                try {
-                  element = selenium.browserbot.getCurrentWindow().findElement('#{locator}');
-                } catch(e) {
-                  element = null;
-                }
-                element != null && element.innerHTML == '#{text}'";
-          EOS
-        end          
+		  def wait_for_text(text, options={})
+        script = options[:element].nil? ?
+                 find_text_script(text, "text != null && text != false") :
+                 find_element_script(options[:element], 
+                    "element != null && element.innerHTML == '#{quote_escaped(text)}'")
 
-		    wait_for_condition script, timeout_in_seconds
+		    wait_for_condition script, options[:timeout_in_seconds]
 		  end
 
 			# Wait for some text to NOT be present (the wait in happenning browser side).
@@ -90,46 +57,71 @@ module Selenium
 			#
 			# If a non nil locator is provided, the text will be
 			# detected within the innerHTML of the element identified by the locator.			
-		  def wait_for_no_text(original_text, locator=nil, timeout_in_seconds=nil)
-		    script = case locator
-		    when nil:
-		      <<-EOS
-              var text;
-              try {
-                text = selenium.browserbot.getCurrentWindow().find('#{original_text}');
-              } catch(e) {
-                text = false;
-              }
-              text == false;
-		      EOS
-		    else
-          <<-EOS
-              var element;
-              
-              try {
-                element = selenium.browserbot.findElement('#{locator}');
-              } catch(e) {
-                element = null;
-              }
-              alert(element);
-              element != null && element.innerHTML != '#{original_text}'";
-           EOS
-		    end
-        wait_for_condition script, timeout_in_seconds
+		  def wait_for_no_text(original_text, options={})
+        script = options[:element].nil? ?
+                 find_text_script(original_text, "(text == false || text == null)") :
+                 find_element_script(options[:element], 
+                    "(element == null || element.innerHTML != '#{quote_escaped(original_text)}')")
+        wait_for_condition script, options[:timeout_in_seconds]
 		  end
 
 			# Wait for a field to get a specific value (the wait in happenning browser side).
-		  def wait_for_field_value(locator, expected_value, timeout_in_seconds=nil)
-		    script = "var element;
-		              try {
-		                element = selenium.browserbot.findElement('#{locator}');
-		              } catch(e) {
-		                element = null;
-		              }
-		              element != null && element.value == '#{expected_value}'";
+      def wait_for_field_value(locator, expected_value, options={})
+        script = find_element_script(locator, 
+            "(element != null && element.value == '#{quote_escaped(expected_value)}')")
+        wait_for_condition script, options[:timeout_in_seconds]
+      end
 
-		    wait_for_condition script, timeout_in_seconds
-		  end
+      def wait_for_no_field_value(locator, expected_value, options={})
+        script = find_element_script(locator, 
+            "(element == null || element.value != '#{quote_escaped(expected_value)}')")
+        wait_for_condition script, options[:timeout_in_seconds]
+      end
+
+      def javascript_framework_for(framework_name)
+        case framework_name.to_sym
+        when :prototype
+          JavascriptFrameworks::Prototype
+        when :jquery
+          JavascriptFrameworks::JQuery
+        else
+          raise "Unsupported Javascript Framework: #{framework_name}"
+        end
+      end
+
+      def find_element_script(locator, return_value)
+        script = <<-EOS
+          var element;
+
+          try {
+            element = selenium.browserbot.findElement('#{quote_escaped(locator)}');
+          } catch(e) {
+            element = null;
+          }
+          #{return_value};
+        EOS
+      end
+
+      def find_text_script(text, return_value)
+        script = <<-EOS
+          var text;
+
+          try {
+            text = selenium.browserbot.getCurrentWindow().find('#{quote_escaped(text)}');
+          } catch(e) {
+            text = null;
+          }
+          #{return_value};
+        EOS
+      end
+
+      def window_script(expression)
+        "selenium.browserbot.getCurrentWindow().#{expression};"
+      end
+
+      def quote_escaped(a_string)
+        a_string.gsub(/'/, %q<\\\'>)
+      end
 
     end
   end