selenium-client 1.2 → 1.2.1

data/lib/selenium.rb

@@ -27,8 +27,9 @@ require File.expand_path(File.dirname(__FILE__) + '/tcp_socket_extension')
 require File.expand_path(File.dirname(__FILE__) + '/nautilus/shell')
 require File.expand_path(File.dirname(__FILE__) + '/selenium/command_error')
 require File.expand_path(File.dirname(__FILE__) + '/selenium/protocol_error')
-require File.expand_path(File.dirname(__FILE__) + '/selenium/client/selenese_client')
+require File.expand_path(File.dirname(__FILE__) + '/selenium/client/protocol')
 require File.expand_path(File.dirname(__FILE__) + '/selenium/client/generated_driver')
+require File.expand_path(File.dirname(__FILE__) + '/selenium/client/extensions')
 require File.expand_path(File.dirname(__FILE__) + '/selenium/client/idiomatic')
 require File.expand_path(File.dirname(__FILE__) + '/selenium/client/base')
 require File.expand_path(File.dirname(__FILE__) + '/selenium/client/driver')

data/lib/selenium/client/base.rb

@@ -1,27 +1,14 @@
-# Copyright 2006 ThoughtWorks, Inc
-#
-#  Licensed under the Apache License, Version 2.0 (the "License");
-#  you may not use this file except in compliance with the License.
-#  You may obtain a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-#  Unless required by applicable law or agreed to in writing, software
-#  distributed under the License is distributed on an "AS IS" BASIS,
-#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#  See the License for the specific language governing permissions and
-#  limitations under the License.
-#
-#
-#
-# Original code by Aslak Hellesoy and Darren Hobbs
-#
 module Selenium
   module Client
     
+		# Driver constructor and session management commands
+		#
+		# Original code by Aslak Hellesoy and Darren Hobbs
     module Base
-      include Selenium::Client::SeleneseClient
+      include Selenium::Client::Protocol
       include Selenium::Client::GeneratedDriver
+      include Selenium::Client::Extensions
+      include Selenium::Client::Idiomatic
   
       def initialize(server_host, server_port, browser_string, browser_url, timeout_in_seconds=300)
         @server_host = server_host
@@ -33,39 +20,42 @@ module Selenium
         @session_id = nil
       end
       
-      def set_extension_js(extension_js)
-        @extension_js = extension_js
-      end
-      
-      def start()
-        result = get_string("getNewBrowserSession", [@browser_string, @browser_url, @extension_js])
-        @session_id = result
-      end
-      
-      def stop()
-        do_command("testComplete", [])
-        @session_id = nil
+      def session_started?
+        not @session_id.nil?
       end
 
       def start_new_browser_session
-        start
+        result = string_command "getNewBrowserSession", [@browser_string, @browser_url, @extension_js]
+        @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 
       end
       
       def close_current_browser_session
-        stop
+        remote_control_command "testComplete"
+        @session_id = nil
       end
       
-      def session_started?
-        not @session_id.nil?
+      def start
+        start_new_browser_session
       end
       
-      def default_timeout_in_seconds
-        @timeout
+      def stop
+	      close_current_browser_session
       end
-      
+            
       def chrome_backend?
         ["*chrome", "*firefox", "*firefox2", "*firefox3"].include?(@browser_string)
       end
+
+      def javascript_extension=(new_javascript_extension)
+        @extension_js = new_javascript_extension
+	    end
+	
+      def set_extension_js(new_javascript_extension)
+	      javascript_extension = new_javascript_extension
+      end
       
     end
   

data/lib/selenium/client/driver.rb

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

data/lib/selenium/client/extensions.rb

@@ -0,0 +1,75 @@
+module Selenium
+  module Client
+
+    # Convenience methods not explicitely part of the protocol
+    module Extensions
+	
+	    # These for all Ajax request to finish (Only works if you are using prototype)
+	    #
+	    # See http://davidvollbracht.com/2008/6/4/30-days-of-tech-day-3-waitforajax for
+	    # more background.
+      def wait_for_ajax(timeout=nil)
+	      selenium.wait_for_condition "selenium.browserbot.getCurrentWindow().Ajax.activeRequestCount == 0", 
+	                                  timeout || default_timeout_in_seconds
+	    end
+	
+	    # Wait for all Prototype effects to be processed 
+	    #
+	    # Credits to http://github.com/brynary/webrat/tree/master
+			def wait_for_effects(timeout=nil)
+			  selenium.wait_for_condition "window.Effect.Queue.size() == 0", timeout || default_timeout_in_seconds
+			end
+			
+		  def wait_for_element(field_name, time=60000)
+		    script = <<-EOS
+		    var element;
+		    try {
+		      element = selenium.browserbot.findElement('#{field_name}');
+		    } catch(e) {
+		      element = null;
+		    }
+		    element != null
+		    EOS
+
+		    wait_for_condition script, time
+		  end
+
+		  def wait_for_text(field_name, text, time=60000)
+		    script = "var element;
+		              try {
+		                element = selenium.browserbot.findElement('#{field_name}');
+		              } catch(e) {
+		                element = null;
+		              }
+		              element != null && element.innerHTML == '#{text}'"
+
+		    wait_for_condition script, time
+		  end
+
+		  def wait_for_text_change(field_name, original_text, time=60000)
+		    script = "var element;
+		              try {
+		                element = selenium.browserbot.findElement('#{field_name}');
+		              } catch(e) {
+		                element = null;
+		              }
+		              element != null && element.innerHTML != '#{original_text}'"
+
+		    wait_for_condition script, time
+		  end
+
+		  def wait_for_field_value(field_name, value, time=60000)
+		    script = "var element;
+		              try {
+		                element = selenium.browserbot.findElement('#{field_name}');
+		              } catch(e) {
+		                element = null;
+		              }
+		              element != null && element.value == '#{value}'"
+
+		    wait_for_condition script, time
+		  end
+
+    end
+  end
+end

data/lib/selenium/client/idiomatic.rb

@@ -1,11 +1,9 @@
-#
-# Provide a more idiomatic API than the generated Ruby driver.
-#
-# Work on progress...
-#
 module Selenium
   module Client
     
+		# Provide a more idiomatic API than the generated Ruby driver.
+		#
+		# Work in progress...
     module Idiomatic
 
       # Return the text content of an HTML element (rendered text shown to
@@ -18,17 +16,17 @@ module Selenium
       #
       # 'locator' is an Selenium element locator
       def text_content(locator)
-        get_string "getText", [locator,]
+        string_command"getText", [locator,]
       end
       
       # Return the title of the current HTML page.
       def title
-        get_string "getTitle"
+        string_command"getTitle"
       end
 
       # Returns the absolute URL of the current page.
       def location
-        get_string "getLocation"
+        string_command"getLocation"
       end
 
       # Waits for a new page to load.
@@ -43,12 +41,12 @@ module Selenium
       # command will return with an error
       def wait_for_page(timeout_in_seconds=nil)
           actual_timeout = timeout_in_seconds || default_timeout_in_seconds
-        do_command "waitForPageToLoad", [actual_timeout * 1000,]
+        remote_control_command "waitForPageToLoad", [actual_timeout * 1000,]
       end
 
       # Gets the entire text of the page.
       def body_text
-        get_string "getBodyText"
+        string_command"getBodyText"
       end
 
       # Clicks on a link, button, checkbox or radio button. If the click action
@@ -57,9 +55,13 @@ module Selenium
       #
       # 'locator' is an element locator      
       def click(locator, options={})
-        do_command("click", [locator,])        
+        remote_control_command("click", [locator,])        
         if options[:wait_for] == :page
           wait_for_page options[:timeout_in_seconds]
+	      elsif options[:wait_for] == :ajax
+	          wait_for_ajax options[:timeout_in_seconds]
+	      elsif options[:wait_for] == :effects
+	          wait_for_effects options[:timeout_in_seconds]
         end
       end
 
@@ -67,14 +69,14 @@ module Selenium
       #
       # 'pattern' is a pattern to match with the text of the page
       def text_present?(pattern)
-        get_boolean "isTextPresent", [pattern,]
+        boolean_command "isTextPresent", [pattern,]
       end
 
       # Verifies that the specified element is somewhere on the page.
       #
       # 'locator' is an element locator
       def element_present?(locator)
-        get_boolean "isElementPresent", [locator,]
+        boolean_command "isElementPresent", [locator,]
       end
 
       # Gets the (whitespace-trimmed) value of an input field 
@@ -83,13 +85,26 @@ module Selenium
       # depending on whether the element is checked or not.
       #
       # 'locator' is an element locator
+      def field(locator)
+        string_command "getValue", [locator,]
+      end
+
+      # Alias for +field+ 
       def value(locator)
-        get_string "getValue", [locator,]
+	      field locator
+      end
+
+      # Returns whether a toggle-button (checkbox/radio) is checked. 
+      # Fails if the specified element doesn't exist or isn't a toggle-button.
+      #
+      # 'locator' is an element locator pointing to a checkbox or radio button
+      def checked?(locator)
+        boolean_command "isChecked", [locator,]
       end
 
       # Whether an alert occurred
       def alert?
-        get_boolean "isAlertPresent"
+        boolean_command "isAlertPresent"
       end
 
       # Retrieves the message of a JavaScript alert generated during the previous action, 
@@ -105,12 +120,12 @@ module Selenium
       # generated and Selenium will hang until someone manually clicks OK.
       # 
       def alert
-        get_string "getAlert"
+        string_command"getAlert"
       end
       
       # Whether a confirmation has been auto-acknoledged (i.e. confirm() been called)
       def confirmation?
-        get_boolean "isConfirmationPresent"
+        boolean_command "isConfirmationPresent"
       end
 
       # Retrieves the message of a JavaScript confirmation dialog generated during
@@ -131,12 +146,12 @@ module Selenium
       # dialog WILL be generated and Selenium will hang until you manually click
       # OK.
       def confirmation
-        get_string "getConfirmation"
+        string_command"getConfirmation"
       end
 
       # Whether a prompt occurred
       def prompt?
-        get_boolean "isPromptPresent"
+        boolean_command "isPromptPresent"
       end
 
       # Retrieves the message of a JavaScript question prompt dialog generated during
@@ -153,7 +168,7 @@ module Selenium
       # page's onload() event handler. In this case a visible dialog WILL be
       # generated and Selenium will hang until someone manually clicks OK.
       def prompt
-        get_string "getPrompt"
+        string_command"getPrompt"
       end
 
       # Returns the result of evaluating the specified JavaScript snippet whithin the browser.
@@ -168,9 +183,27 @@ module Selenium
       # 
       # 'script' is the JavaScript snippet to run
       def js_eval(script)
-        get_string "getEval", [script,]
+        string_command"getEval", [script,]
       end
 
+      # Set the Remote Control timeout (as opposed to the client side driver timeout).
+      # This timout specifies the amount of time that Selenium Core will wait for actions to complete.
+      # 
+      # The default timeout is 30 seconds.
+      # 'timeout' is a timeout in seconds, after which the action will return with an error
+      #
+      # Actions that require waiting include "open" and the "waitFor*" actions.
+      def remote_control_timeout_in_seconds=(timeout_in_seconds)
+          remote_control_command "setTimeout", [timeout_in_seconds * 1000,]
+      end
+
+      # Returns the text from a cell of a table. The cellAddress syntax
+      # tableLocator.row.column, where row and column start at 0.
+      #
+      # 'tableCellAddress' is a cell address, e.g. "foo.1.4"
+      def table_cell_text(tableCellAddress)
+        string_command "getTable", [tableCellAddress,]
+      end
 
       # set speed
     end

data/lib/selenium/client/{selenese_client.rb → protocol.rb}

@@ -3,10 +3,11 @@ module Selenium
 
     HTTP_HEADERS = { 'Content-Type' => 'application/x-www-form-urlencoded; charset=utf-8' }
     
-    module SeleneseClient
+    # Module in charge of handling Selenium over-the-wire HTTP protocol
+    module Protocol
       attr_reader :session_id
   
-      def do_command(verb, args)
+      def remote_control_command(verb, args=[])
         timeout(default_timeout_in_seconds) do
           status, response = http_post(http_request_for(verb, args))
           raise SeleniumCommandError, response unless status == "OK"          
@@ -14,12 +15,12 @@ module Selenium
         end
       end
       
-      def get_string(verb, args=[])
-        do_command(verb, args)
+      def string_command(verb, args=[])
+        remote_control_command(verb, args)
       end
     
-      def get_string_array(verb, args)
-        csv = get_string(verb, args)
+      def string_array_command(verb, args)
+        csv = string_command(verb, args)
         token = ""
         tokens = []
         escape = false
@@ -43,24 +44,26 @@ module Selenium
         return tokens
       end
 
-      def get_number(verb, args)
-        # Is there something I need to do here?
-        return get_string(verb, args)
+      def number_command(verb, args)
+        string_command verb, args
       end
     
-      def get_number_array(verb, args)
-        # Is there something I need to do here?
-        return get_string_array(verb, args)
+      def number_array_command(verb, args)
+        string_array_command verb, args
       end
 
-      def get_boolean(verb, args=[])
-        parse_boolean_value get_string(verb, args)
+      def boolean_command(verb, args=[])
+        parse_boolean_value string_command(verb, args)
       end
     
-      def get_boolean_array(verb, args)
-        get_string_array(verb, args).collect {|value| parse_boolean_value(value)}
+      def boolean_array_command(verb, args)
+        string_array_command(verb, args).collect {|value| parse_boolean_value(value)}
       end
-      
+
+      def default_timeout_in_seconds
+        @timeout
+      end
+            
       protected
 
       def parse_boolean_value(value)
@@ -88,7 +91,7 @@ module Selenium
         # puts "RESULT: #{response.inspect}\n"       
         [ response.body[0..1], response.body[3..-1] ]
       end
-      
+     
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: selenium-client
 version: !ruby/object:Gem::Version 
-  version: "1.2"
+  version: 1.2.1
 platform: ruby
 authors: 
 - OpenQA
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-28 00:00:00 -07:00
+date: 2008-09-29 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -25,8 +25,9 @@ files:
 - lib/nautilus/shell.rb
 - lib/selenium/client/base.rb
 - lib/selenium/client/driver.rb
+- lib/selenium/client/extensions.rb
 - lib/selenium/client/idiomatic.rb
-- lib/selenium/client/selenese_client.rb
+- lib/selenium/client/protocol.rb
 - lib/selenium/client/selenium_helper.rb
 - lib/selenium/command_error.rb
 - lib/selenium/protocol_error.rb