warnold-selenium-client 1.2.19

data/lib/selenium/client/protocol.rb

@@ -0,0 +1,104 @@
+module Selenium
+  module Client
+
+    HTTP_HEADERS = { 'Content-Type' => 'application/x-www-form-urlencoded; charset=utf-8' }
+    
+    # Module in charge of handling Selenium over-the-wire HTTP protocol
+    module Protocol
+      attr_reader :session_id
+  
+      def remote_control_command(verb, args=[])
+        timeout(@default_timeout_in_seconds) do
+          status, response = http_post(http_request_for(verb, args))
+          raise Selenium::CommandError, response unless status == "OK"          
+          response[3..-1] # strip "OK," from response
+        end
+      end
+      
+      def string_command(verb, args=[])
+        remote_control_command(verb, args)
+      end
+    
+      def string_array_command(verb, args=[])
+        csv = string_command(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 number_command(verb, args)
+        string_command verb, args
+      end
+    
+      def number_array_command(verb, args)
+        string_array_command verb, args
+      end
+
+      def boolean_command(verb, args=[])
+        parse_boolean_value string_command(verb, args)
+      end
+    
+      def boolean_array_command(verb, args)
+        string_array_command(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)
+        start = Time.now
+        called_from = caller.detect{|line| line !~ /(selenium-client|vendor|usr\/lib\/ruby|\(eval\))/i}
+        http = Net::HTTP.new(@host, @port)
+        http.open_timeout = default_timeout_in_seconds
+        http.read_timeout = default_timeout_in_seconds
+        response = http.post('/selenium-server/driver/', data, HTTP_HEADERS)
+        if response.body !~ /^OK/
+          puts "#{start} selenium-client received failure from selenium server:"
+          puts "requested:"
+          puts "\t" + CGI::unescape(data.split('&').join("\n\t"))
+          puts "received:"
+          puts "\t#{response.body.inspect}"
+          puts "\tcalled from #{called_from}"
+        end
+        [ response.body[0..1], response.body ]
+      end
+     
+    end
+
+  end
+end

data/lib/selenium/client/selenium_helper.rb

@@ -0,0 +1,34 @@
+# 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 default open method to actually delegates to @selenium
+      def open(url)
+        @selenium.open url
+      end
+    
+      # Overrides default type method to actually delegates to @selenium
+      def type(locator, value)
+        @selenium.type locator, value
+      end
+    
+      # Overrides default select method to actually delegates to @selenium
+      def select(input_locator, option_locator)
+        @selenium.select input_locator, option_locator
+      end
+
+      # Delegates to @selenium on method missing 
+      def method_missing(method_name, *args)
+        return super unless @selenium.respond_to?(method_name)
+        
+        @selenium.send(method_name, *args)
+      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/rake/default_tasks.rb

@@ -0,0 +1,17 @@
+require 'selenium/rake/tasks'
+
+Selenium::Rake::RemoteControlStartTask.new do |rc|
+  rc.timeout_in_seconds = 3 * 60
+  rc.background = true
+  rc.nohup = false
+  rc.wait_until_up_and_running = true
+  rc.additional_args << "-singleWindow"
+end
+
+Selenium::Rake::RemoteControlStopTask.new
+
+desc "Restart Selenium Remote Control"
+task :'selenium:rc:restart' do
+  Rake::Task[:'selenium:rc:stop'].execute [] rescue nil
+  Rake::Task[:'selenium:rc:start'].execute []
+end

data/lib/selenium/rake/remote_control_start_task.rb

@@ -0,0 +1,71 @@
+module Selenium
+  module Rake
+  
+    # Rake tasks to start a Remote Control server.
+    # 
+    # require 'selenium/rake/tasks' 
+    # 
+    # Selenium::Rake::RemoteControlStartTask.new do |rc|
+    #   rc.port = 4444
+    #   rc.timeout_in_seconds = 3 * 60
+    #   rc.background = true
+    #   rc.wait_until_up_and_running = true
+    #   rc.jar_file = "/path/to/where/selenium-rc-standalone-jar-is-installed"
+    #   rc.additional_args << "-singleWindow"
+    # end
+    # 
+    # If you do not explicitly specify the path to selenium remote control jar
+    # it will be "auto-discovered" in `vendor` directory using the following
+    # path : `vendor/selenium-remote-control/selenium-server*-standalone.jar`
+    # 
+    # To leverage the latest selenium-client capabilities, you may need to download 
+    # a recent nightly build of a standalone packaging of Selenium Remote 
+    # Control. You will find the nightly build at 
+    # http://nexus.openqa.org/content/repositories/snapshots/org/seleniumhq/selenium/server/selenium-server/
+    class RemoteControlStartTask
+      attr_accessor :port, :timeout_in_seconds, :background, 
+                    :wait_until_up_and_running, :additional_args,
+                    :log_to, :nohup
+      attr_reader :jar_file
+
+      JAR_FILE_PATTERN = "vendor/selenium-remote-control/selenium-server-*.jar"
+
+      def initialize(name = :'selenium:rc:start')
+        @name = name
+        @port = 4444
+        @timeout_in_seconds = 5
+        project_specific_jar = Dir[JAR_FILE_PATTERN].first
+        @jar_file = project_specific_jar
+        @additional_args = []
+        @background = false
+        @nohup = false
+        @wait_until_up_and_running = false
+        yield self if block_given?
+        define
+      end
+    
+      def jar_file=(new_jar_file)
+        @jar_file = File.expand_path(new_jar_file)
+      end
+      
+      def define
+        desc "Launch Selenium Remote Control"
+        task @name do
+          puts "Starting Selenium Remote Control at 0.0.0.0:#{@port}..."
+          raise "Could not find jar file '#{@jar_file}'. Expected it under #{JAR_FILE_PATTERN}" unless @jar_file && File.exists?(@jar_file)
+          remote_control = Selenium::RemoteControl::RemoteControl.new("0.0.0.0", @port, :timeout => @timeout_in_seconds)
+          remote_control.jar_file = @jar_file
+          remote_control.additional_args = @additional_args
+          remote_control.log_to = @log_to
+          remote_control.start :background => @background, :nohup => @nohup
+          if @background && @wait_until_up_and_running
+            puts "Waiting for Remote Control to be up and running..."
+            TCPSocket.wait_for_service :host => @host, :port => @port
+          end
+          puts "Selenium Remote Control at 0.0.0.0:#{@port} ready"
+        end
+      end
+
+    end
+  end
+end

data/lib/selenium/rake/remote_control_stop_task.rb

@@ -0,0 +1,44 @@
+module Selenium
+  module Rake
+
+    # Rake task to stop a Selenium Remote Control Server
+    #
+    # Selenium::Rake::RemoteControlStopTask.new do |rc|
+    #   rc.host = "localhost"
+    #   rc.port = 4444
+    #   rc.timeout_in_seconds = 3 * 60
+    # end
+    #    
+    class RemoteControlStopTask
+      attr_accessor :host, :port, :timeout_in_seconds, :wait_until_stopped,
+                    :shutdown_command
+
+      def initialize(name = :'selenium:rc:stop')
+        @host = "localhost"
+        @name = name
+        @port = 4444
+        @timeout_in_seconds = nil
+        @shutdown_command = nil
+        @wait_until_stopped = true
+        yield self if block_given?
+        define
+      end
+    
+      def define
+        desc "Stop Selenium Remote Control running"
+        task @name do
+          puts "Stopping Selenium Remote Control running at #{host}:#{port}..."
+          remote_control = Selenium::RemoteControl::RemoteControl.new(
+              host, port, :timeout => timeout_in_seconds,
+              :shutdown_command => shutdown_command)
+          remote_control.stop
+          if @wait_until_stopped
+            TCPSocket.wait_for_service_termination :host => host, :port => port
+          end
+          puts "Stopped Selenium Remote Control running at #{host}:#{port}"
+        end
+      end
+
+    end
+  end
+end

data/lib/selenium/rake/tasks.rb

@@ -0,0 +1,6 @@
+require "net/http"
+require File.expand_path(File.dirname(__FILE__) + '/../../nautilus/shell')
+require File.expand_path(File.dirname(__FILE__) + '/../../tcp_socket_extension')
+require File.expand_path(File.dirname(__FILE__) + '/../remote_control/remote_control')
+require File.expand_path(File.dirname(__FILE__) + '/remote_control_start_task')
+require File.expand_path(File.dirname(__FILE__) + '/remote_control_stop_task')

data/lib/selenium/remote_control/remote_control.rb

@@ -0,0 +1,35 @@
+module Selenium
+  module RemoteControl
+    
+    class RemoteControl
+      attr_reader :host, :port, :timeout_in_seconds, :firefox_profile, :shutdown_command
+      attr_accessor :additional_args, :jar_file, :log_to
+      
+      def initialize(host, port, options={})
+        @host, @port = host, port
+        @timeout_in_seconds = options[:timeout] || (2 * 60)
+        @shutdown_command = options[:shutdown_command] || "shutDownSeleniumServer"
+        @firefox_profile = options[:firefox_profile]
+        @additional_args = options[:additional_args] || []
+        @shell = Nautilus::Shell.new
+      end
+      
+      def start(options = {})
+        command = "java -jar \"#{jar_file}\""
+        command << " -port #{@port}"
+        command << " -timeout #{@timeout_in_seconds}"
+        command << " -firefoxProfileTemplate '#{@firefox_profile}'" if @firefox_profile
+        command << " #{additional_args.join(' ')}" unless additional_args.empty?
+        command << " > #{log_to}" if log_to
+        
+        @shell.run command, {:background => options[:background], :nohup => options[:nohup]}
+      end
+      
+      def stop
+        Net::HTTP.get(@host, "/selenium-server/driver/?cmd=#{shutdown_command}", @port)
+      end
+      
+    end
+    
+  end
+end

data/lib/selenium/rspec/reporting/file_path_strategy.rb

@@ -0,0 +1,78 @@
+module Selenium
+  module RSpec
+    module Reporting
+      
+      class FilePathStrategy
+        attr_reader :final_report_file_path
+
+        REPORT_DEFAULT_FILE_PATH = File.join(Dir::tmpdir, "selenium_test_report", "index.html")
+
+        def initialize(final_report_file_path)
+          @final_report_file_path = final_report_file_path || REPORT_DEFAULT_FILE_PATH
+          @relative_dir = nil
+        end
+
+        def base_report_dir
+          @base_report_dir ||= File.dirname(File.expand_path(@final_report_file_path))
+        end
+
+        def relative_dir
+          return @relative_dir if @relative_dir
+          
+          file_name_without_extension = File.basename(@final_report_file_path).sub(/\.[^\.]*$/, "")
+          @relative_dir ||=  "resources/" + file_name_without_extension
+        end
+
+        def relative_file_path_for_html_capture(example)
+          "#{relative_dir}/example_#{example.reporting_uid}.html"
+        end
+
+        def relative_file_path_for_system_screenshot(example)
+          "#{relative_dir}/example_#{example.reporting_uid}_system_screenshot.png"
+        end
+
+        def relative_file_path_for_page_screenshot(example)
+          "#{relative_dir}/example_#{example.reporting_uid}_page_screenshot.png"
+        end
+
+        def relative_file_path_for_remote_control_logs(example)
+          "#{relative_dir}/example_#{example.reporting_uid}_remote_control.log"
+        end
+
+        def relative_file_path_for_browser_network_traffic(example)
+          "#{relative_dir}/example_#{example.reporting_uid}_browser_network_traffic.log"
+        end
+
+        def file_path_for_html_capture(example)
+          file_path relative_file_path_for_html_capture(example)
+        end
+
+        def file_path_for_system_screenshot(example)
+          file_path relative_file_path_for_system_screenshot(example)
+        end
+
+        def file_path_for_page_screenshot(example)
+          file_path relative_file_path_for_page_screenshot(example)
+        end
+
+        def file_path_for_remote_control_logs(example)
+          file_path relative_file_path_for_remote_control_logs(example)
+        end
+
+        def file_path_for_browser_network_traffic(example)
+          file_path relative_file_path_for_browser_network_traffic(example)
+        end
+
+        def file_path(relative_file_path)
+          the_file_path = base_report_dir + "/" + relative_file_path
+          parent_dir = File.dirname(the_file_path)
+          FileUtils.mkdir_p(parent_dir) unless File.directory?(parent_dir)
+          the_file_path
+        end
+
+       
+      end
+      
+    end      
+  end
+end

data/lib/selenium/rspec/reporting/html_report.rb

@@ -0,0 +1,155 @@
+module Selenium
+  module RSpec
+    module Reporting
+
+      class HtmlReport
+
+        PLACEHOLDER = "<<placeholder>>"
+
+        def initialize(file_path_strategy)
+          @file_path_strategy = file_path_strategy
+        end
+
+        def self.inject_placeholder(content)
+          content + Selenium::RSpec::Reporting::HtmlReport::PLACEHOLDER
+        end
+
+        def replace_placeholder_with_system_state_content(result, example)
+          result.gsub! PLACEHOLDER, logs_and_screenshot_sections(example)
+        end
+
+        def logs_and_screenshot_sections(example)
+          dom_id = "example_" + example.reporting_uid
+          system_screenshot_url = @file_path_strategy.relative_file_path_for_system_screenshot(example)
+          page_screenshot_url = @file_path_strategy.relative_file_path_for_page_screenshot(example)
+          snapshot_url = @file_path_strategy.relative_file_path_for_html_capture(example)
+          remote_control_logs_url = @file_path_strategy.relative_file_path_for_remote_control_logs(example)
+          remote_control_logs_path = @file_path_strategy.file_path_for_remote_control_logs(example)
+
+          html = ""
+          if File.exists? @file_path_strategy.file_path_for_html_capture(example)
+            html << toggable_section(dom_id, :id => "snapshot", :url=> snapshot_url, :name => "Dynamic HTML Snapshot")
+          end
+          if File.exists? remote_control_logs_path
+            html << toggable_inline_section(dom_id, :id => "rc_logs", :url => remote_control_logs_url, :path=> remote_control_logs_path, :name => "Remote Control Logs")
+          end
+          if File.exists? @file_path_strategy.file_path_for_page_screenshot(example)
+            html << toggable_image_section(dom_id, :id => "page_screenshot", :name => "Page Screenshot", :url => page_screenshot_url)
+          end
+          if File.exists? @file_path_strategy.file_path_for_system_screenshot(example)
+            html << toggable_image_section(dom_id, :id => "system_screenshot", :name => "System Screenshot", :url => system_screenshot_url)
+          end
+
+          return html
+        end
+
+        def self.append_javascript(global_scripts)
+          global_scripts + <<-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 = "Show " + description
+          } else {
+            section.style.display = "block"
+            link.innerHTML = "Hide " + description
+          }
+        }
+        EOF
+        end
+
+        def self.append_css(global_styles)
+            global_styles + <<-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
+
+        def toggable_section(dom_id, options)
+          <<-EOS
+
+          <div>[
+            <a id="#{dom_id}_#{options[:id]}_link"
+               href=\"javascript:toggleVisilibility('#{dom_id}_#{options[:id]}', '#{options[:name]}')\">Show #{options[:name]}</a>
+          ]</div>
+          <br/><br/>
+          <div id="#{dom_id}_#{options[:id]}" class="dyn-source">
+            <a href="#{options[:url]}">Full screen</a><br/><br/>
+            <iframe src="#{options[:url]}" width="100%" height="600px" ></iframe>
+          </div>
+
+          EOS
+        end
+
+        def toggable_inline_section(dom_id, options)
+          <<-EOS
+
+          <div>[
+            <a id="#{dom_id}_#{options[:id]}_link"
+               href=\"javascript:toggleVisilibility('#{dom_id}_#{options[:id]}', '#{options[:name]}')\">Show #{options[:name]}</a>
+          ]</div>
+          <br/><br/>
+          <div id="#{dom_id}_#{options[:id]}" class="dyn-source">
+            <a href="#{options[:url]}">Full screen</a><br/><br/>
+            <pre>#{File.open(options[:path]).read}</pre>
+          </div>
+
+          EOS
+        end
+
+        def toggable_image_section(dom_id, options)
+          <<-EOS
+
+          <div>[<a id="#{dom_id}_#{options[:id]}_link" href="javascript:toggleVisilibility('#{dom_id}_#{options[:id]}', '#{options[:name]}');">Show #{options[:name]}</a>]</div>
+          <br/>
+          <div id="#{dom_id}_#{options[:id]}" style="display: none">
+            <a href="#{options[:url]}">
+              <img width="80%" src="#{options[:url]}" />
+            </a>
+          </div>
+          <br/>
+
+          EOS
+        end
+
+        def report_header
+          super + "\n<script type=\"text/javascript\">moveProgressBar('100.0');</script>"
+        end
+
+      end
+    end
+
+
+    # Tweaks raised Exceptions to mask noisy (unneeded) parts of the backtrace
+    class SeleniumQuietBacktraceTweaker < Spec::Runner::QuietBacktraceTweaker
+      unless defined?(SELENIUM_IGNORE_PATTERNS)
+        SELENIUM_IGNORE_PATTERNS = [
+          /selenium-client/,
+          /selenium\/client/,
+        ]
+      end
+
+      def ignored_patterns
+        super + SELENIUM_IGNORE_PATTERNS
+      end
+    end
+
+  end
+end