selenium-client 1.1

data/lib/selenium/client/selenese_client.rb

@@ -0,0 +1,95 @@
+module Selenium
+  module Client
+
+    HTTP_HEADERS = { 'Content-Type' => 'application/x-www-form-urlencoded; charset=utf-8' }
+    
+    module SeleneseClient
+      attr_reader :session_id
+  
+      def do_command(verb, args)
+        timeout(@timeout) do
+          status, response = http_post(http_request_for(verb, args))
+          raise SeleniumCommandError, response unless status == "OK"          
+          response
+        end
+      end
+      
+      def get_string(verb, args)
+        do_command(verb, args)
+      end
+    
+      def get_string_array(verb, args)
+        csv = get_string(verb, args)
+        token = ""
+        tokens = []
+        escape = false
+        csv.split(//).each do |letter|
+          if escape
+            token += letter
+            escape = false
+            next
+          end
+          case letter
+            when '\\'
+              escape = true
+            when ','
+              tokens << token
+              token = ""
+            else
+              token += letter
+          end
+        end
+        tokens << token
+        return tokens
+      end
+
+      def get_number(verb, args)
+        # Is there something I need to do here?
+        return get_string(verb, args)
+      end
+    
+      def get_number_array(verb, args)
+        # Is there something I need to do here?
+        return get_string_array(verb, args)
+      end
+
+      def get_boolean(verb, args)
+        parse_boolean_value get_string(verb, args)
+      end
+    
+      def get_boolean_array(verb, args)
+        get_string_array(verb, args).collect {|value| parse_boolean_value(value)}
+      end
+      
+      protected
+
+      def parse_boolean_value(value)
+        if ("true" == value)
+            return true
+        elsif ("false" == value)
+            return false
+        end
+        raise ProtocolError, "Invalid Selenese boolean value that is neither 'true' nor 'false': got '#{value}'"
+      end
+
+      def http_request_for(verb, args)
+        data = "cmd=#{CGI::escape(verb)}"
+        args.each_with_index do |arg, index|
+          data << "&#{index.succ}=#{CGI::escape(arg.to_s)}"
+        end
+        data << "&sessionId=#{session_id}" unless session_id.nil?
+        data
+      end
+            
+      def http_post(data)
+        #print "Requesting --->" + command_string + "\n"
+        http = Net::HTTP.new(@server_host, @server_port)
+        response = http.post('/selenium-server/driver/', data, HTTP_HEADERS)
+        #print "RESULT: " + response.body + "\n\n"å          
+        [ response.body[0..1], response.body[3..-1] ]
+      end
+      
+    end
+
+  end
+end

data/lib/selenium/client/selenium_helper.rb

@@ -0,0 +1,36 @@
+# Defines a mixin module that you can use to write Selenium tests
+# without typing "@selenium." in front of every command.  Every
+# call to a missing method will be automatically sent to the @selenium
+# object.
+module Selenium
+  module Client
+    
+  module SeleniumHelper
+    
+      # Overrides standard "open" method with @selenium.open
+      def open(addr)
+        @selenium.open(addr)
+      end
+    
+      # Overrides standard "type" method with @selenium.type
+      def type(inputLocator, value)
+        @selenium.type(inputLocator, value)
+      end
+    
+      # Overrides standard "select" method with @selenium.select
+      def select(inputLocator, optionLocator)
+        @selenium.select(inputLocator, optionLocator)
+      end
+
+      # Passes all calls to missing methods to @selenium
+      def method_missing(method_name, *args)
+          if args.empty?
+              @selenium.send(method_name)
+          else
+              @selenium.send(method_name, *args)
+          end
+      end      
+    end
+    
+  end
+end

data/lib/selenium/command_error.rb

@@ -0,0 +1,4 @@
+module Selenium
+  class CommandError < RuntimeError 
+  end
+end

data/lib/selenium/protocol_error.rb

@@ -0,0 +1,4 @@
+module Selenium
+  class ProtocolError < RuntimeError 
+  end
+end

data/lib/selenium/rspec/screenshot_formatter.rb

@@ -0,0 +1,187 @@
+require "digest/md5"
+require "base64"
+require "rubygems"
+require "spec"
+require 'spec/runner/formatter/html_formatter'
+
+module Selenium
+  module RSpec
+    class ScreenshotFormatter < Spec::Runner::Formatter::HtmlFormatter
+      PLACEHOLDER = "<<placeholder>>"
+
+      ################### Hooks? ########
+  
+      def start(example_count)
+        super
+        # ensure there's at least 1 example group header (normally 0 with deep_test)
+        # prevents js and html validity errors
+        example_group = Object.new
+        def example_group.description; ""; end
+        add_example_group(example_group)
+      end  
+  
+      def move_progress
+        # we don't have current_example_number, and we don't really care about the progress bar
+      end  
+  
+      def extra_failure_content(failure)
+        super + PLACEHOLDER
+      end
+  
+      def example_passed(example)
+        include_example_group_description example
+        super
+      end
+  
+      def example_pending(example_group_description, example, message)
+        include_example_group_description example
+        super
+      end
+  
+      def example_failed(example, counter, failure)
+        include_example_group_description example
+        old_output = @output
+        @output = StringIO.new
+        super
+        result = @output.string
+        result.gsub! PLACEHOLDER, html_capture(example)
+        old_output.puts result
+        old_output.flush
+      ensure
+        @output = old_output
+      end
+  
+
+      ###### Called from After each ####
+
+      def self.capture_browser_state(selenium_driver, example)
+        # Selenium RC seems to 'freeze' every so often when calling getHTMLSource, especially when DeepTest timeout is low, I need to investigate...
+        # Set deeptest :timeout_in_seconds => 30 to see it happen
+        capture_html_snapshot selenium_driver, example  
+        capture_screenshot selenium_driver, example
+      end
+  
+      def self.capture_html_snapshot(selenium_driver, example)
+        html = selenium_driver.get_html_source
+        File.open(file_for_html_capture(example), "w") { |f| f.write html }
+      end
+
+      def self.capture_screenshot(selenium_driver, example)
+        selenium_driver.window_maximize
+        encodedImage = selenium_driver.capture_screenshot_to_string
+        pngImage = Base64.decode64(encodedImage)
+        File.open(file_for_screenshot_capture(example), "w") { |f| f.write pngImage }
+      end
+  
+      ################### Instrumentation ########
+  
+      def html_capture(example)
+        dom_id = "example_" + self.class.hash_for_example(example)
+        screenshot_url = self.class.relative_file_for_png_capture(example)
+        snapshot_url = self.class.relative_file_for_html_capture(example)
+        <<-EOS
+          <div>[<a id="#{dom_id}_screenshot_link" href="javascript:toggleVisilibility('#{dom_id}_screenshot', 'Screenshot');">Show screenshot</a>]</div>
+          <br/>      
+          <div id="#{dom_id}_screenshot" style="display: none">
+            <a href="#{screenshot_url}">
+              <img width="80%" src="#{screenshot_url}" />
+            </a>
+          </div>
+          <br/>
+      
+          <div>[<a id="#{dom_id}_snapshot_link" href=\"javascript:toggleVisilibility('#{dom_id}_snapshot', 'Snapshot')\">Show snapshot</a>]</div>
+          <br/><br/>
+          <div id="#{dom_id}_snapshot" class="dyn-source">
+            <a href="#{snapshot_url}">Full screen</a><br/><br/>
+            <iframe src="#{snapshot_url}" width="100%" height="600px" ></iframe>
+          </div>
+        EOS
+      end
+  
+  
+      def self.relative_file_for_html_capture(example)
+        "resources/example_#{hash_for_example(example)}.html"
+      end
+
+      def self.relative_file_for_png_capture(example)
+        "resources/example_#{hash_for_example(example)}.png"
+      end
+  
+      def self.file_for_html_capture(example)
+        file_name = capture_root_dir + "/example_#{hash_for_example(example)}.html"
+        FileUtils.mkdir_p(capture_root_dir) unless File.directory?(capture_root_dir)
+        file_name    
+      end
+
+      def self.file_for_screenshot_capture(example)
+        file_name = capture_root_dir + "/example_#{hash_for_example(example)}.png"
+        FileUtils.mkdir_p(capture_root_dir) unless File.directory?(capture_root_dir)
+        file_name    
+      end
+  
+      def self.hash_for_example(example)
+        Digest::MD5.hexdigest example.implementation_backtrace.first
+      end
+  
+  
+      def self.capture_root_dir
+        root_dir + "/resources"
+      end
+
+      def self.root_dir
+        (ENV['CC_BUILD_ARTIFACTS'] || './tmp/rspec_report')
+      end
+  
+  
+      def include_example_group_description(example)
+        def example.description
+          self.class.description.to_s + " :: " + super
+        end
+      end
+  
+  
+      def report_header
+        super + "\n<script type=\"text/javascript\">moveProgressBar('100.0');</script>"
+      end
+  
+
+
+      def global_scripts
+        super + <<-EOF
+    function toggleVisilibility(id, description) {
+      var section;
+      var link;
+
+      section = document.getElementById(id);
+      link = document.getElementById(id + "_link");
+
+      if (section.style.display == "block") {
+        section.style.display = "none"
+        link.innerHTML = description
+      } else {
+        section.style.display = "block"
+        link.innerHTML = "Hide " + description
+      }
+    }
+    EOF
+      end
+
+      def global_styles
+        super + <<-EOF
+    div.rspec-report textarea {
+      width: 100%;
+    }
+
+    div.rspec-report .dyn-source {
+      background: #FFFFEE none repeat scroll 0%;
+      border:1px dotted black;
+      color: #000000;
+      display: none;
+      margin: 0.5em 2em;
+      padding: 0.5em;
+    }
+    EOF
+      end
+    end
+  end
+end

data/lib/selenium/screenshot_saver.rb

@@ -0,0 +1,25 @@
+module Selenium
+  module ScreenshotSaver
+    
+    def save_screenshot_to(png_path)
+      dir = File.dirname(png_path)
+      FileUtils.mkdir_p(dir) unless File.directory?(dir)
+      if PLATFORM['darwin']
+        sh "screencapture '#{png_path}'"
+      elsif image_magick_support?
+         sh "import -window root '#{png_path}'"        
+      end
+    end
+    
+    def image_magick_support?
+      @image_magick_support ||= `import --version`.grep /"ImageMagick"/
+    end
+    
+    def sh(command)
+      system command
+      STDERR.puts "Warning: Could not capture screenshot with '#{command}'" unless $? == 0
+    end
+    
+  end
+  
+end

data/test/all_unit_tests.rb

@@ -0,0 +1,3 @@
+Dir["#{File.dirname __FILE__}/unit/**/*_test.rb"].each do |test_case|
+  require test_case
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: selenium-client
+version: !ruby/object:Gem::Version 
+  version: "1.1"
+platform: ruby
+authors: 
+- OpenQA
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-07-16 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: selenium-client@rubyforge.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- lib/selenium/client/base.rb
+- lib/selenium/client/driver.rb
+- lib/selenium/client/generated_driver.rb
+- lib/selenium/client/selenese_client.rb
+- lib/selenium/client/selenium_helper.rb
+- lib/selenium/command_error.rb
+- lib/selenium/protocol_error.rb
+- lib/selenium/rspec/screenshot_formatter.rb
+- lib/selenium/screenshot_saver.rb
+- lib/selenium.rb
+- README
+has_rdoc: true
+homepage: http://selenium-client.rubyforge.com
+post_install_message: 
+rdoc_options: 
+- --title
+- Selenium Client
+- --main
+- README
+- --line-numbers
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: selenium-client
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Official Ruby Client for Selenium RC.
+test_files: 
+- test/all_unit_tests.rb