selenium-selenese 1.1.3

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

@@ -0,0 +1,87 @@
+#
+# Explicit requires in this file so that we can invoke RSpec runner with a
+# single:
+#   --require 'lib/selenium/rspec/reporting/selenium_test_report_formatter'
+#
+require "digest/md5"
+require "base64"
+require 'tmpdir'
+require "rubygems"
+gem "rspec", ">=1.2.8"
+require "spec"
+require 'spec/runner/formatter/html_formatter'
+require File.expand_path(File.dirname(__FILE__) + "/file_path_strategy")
+require File.expand_path(File.dirname(__FILE__) + "/system_capture")
+require File.expand_path(File.dirname(__FILE__) + "/html_report")
+
+module Selenium
+  module RSpec    
+      
+    class SeleniumTestReportFormatter < Spec::Runner::Formatter::HtmlFormatter
+
+      def initialize(options, output)
+        super
+        raise "Unexpected output type #{output.inspect}" unless output.kind_of?(String)
+        @@file_path_strategy = Selenium::RSpec::Reporting::FilePathStrategy.new(output)
+      end
+
+      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
+        example_group_started 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)
+        Selenium::RSpec::Reporting::HtmlReport.inject_placeholder(super)
+      end
+  
+      def example_pending(example_proxy, message, deprecated_pending_location=nil)
+        super
+      end
+  
+      def example_failed(example, counter, failure)        
+        old_output = @output
+        @output = StringIO.new
+        super
+        
+        result = @output.string
+        report = Selenium::RSpec::Reporting::HtmlReport.new(@@file_path_strategy)
+        report.replace_placeholder_with_system_state_content(result, example)
+        old_output.puts result
+        old_output.flush
+      ensure
+        @output = old_output
+      end
+  
+      # Should be called from config.after(:each) in spec helper
+      def self.capture_system_state(selenium_driver, example)
+        system_capture = Selenium::RSpec::Reporting::SystemCapture.new(selenium_driver, example, file_path_strategy)
+        system_capture.capture_system_state                      
+      end
+
+      def global_scripts
+        Selenium::RSpec::Reporting::HtmlReport.append_javascript(super)
+      end
+      
+      def global_styles
+        Selenium::RSpec::Reporting::HtmlReport.append_css(super)
+      end
+
+      def self.file_path_strategy
+	      ### HACK ####
+	      # When running with DeepTest the class instance variable could not have been set
+	      # For now you must set the env variable before launching the tests. We need to revisit the way DeepTest
+	      # and RSpec reporting work for a proper fix.
+	      @@file_path_strategy ||= Selenium::RSpec::Reporting::FilePathStrategy.new(ENV["SELENIUM_TEST_REPORT_FILE"])
+	    end
+  
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+module Selenium
+  module RSpec
+    module Reporting
+      
+      class SystemCapture
+        
+        def initialize(selenium_driver, example, file_path_strategy)
+          @selenium_driver = selenium_driver
+          @example = example
+          @file_path_strategy = file_path_strategy 
+        end
+        
+        def capture_system_state
+          # 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
+          begin
+            retrieve_remote_control_logs
+          rescue Exception => e
+            STDERR.puts "WARNING: Could not retrieve remote control logs: #{e}"
+          end
+          begin
+            capture_html_snapshot
+          rescue Exception => e
+            STDERR.puts "WARNING: Could not capture HTML snapshot: #{e}"
+          end
+          begin
+            capture_page_screenshot
+          rescue Exception => e
+            STDERR.puts "WARNING: Could not capture page screenshot: #{e}"
+          end
+          begin
+            capture_system_screenshot
+          rescue Exception => e
+            STDERR.puts "WARNING: Could not capture system screenshot: #{e}"
+          end
+        end
+
+        def capture_html_snapshot
+          # Skipping HTML Snapshot retrieval, if there is no current Selenium session
+          return  unless @selenium_driver.session_started?
+
+          html = @selenium_driver.get_html_source
+          File.open(@file_path_strategy.file_path_for_html_capture(@example), "w") { |f| f.write html }
+        end
+
+        def capture_system_screenshot
+          @selenium_driver.window_maximize if @selenium_driver.session_started?
+          
+          encodedImage = @selenium_driver.capture_screenshot_to_string
+          pngImage = Base64.decode64(encodedImage)
+          File.open(@file_path_strategy.file_path_for_system_screenshot(@example), "wb") { |f| f.write pngImage }
+        end
+
+        def capture_page_screenshot
+          return unless @selenium_driver.chrome_backend? && @selenium_driver.session_started?
+          
+          encodedImage = @selenium_driver.capture_entire_page_screenshot_to_string("")
+          pngImage = Base64.decode64(encodedImage)
+          File.open(@file_path_strategy.file_path_for_page_screenshot(@example), "wb") { |f| f.write pngImage }
+        end
+
+        def retrieve_remote_control_logs
+          logs = @selenium_driver.retrieve_last_remote_control_logs
+          File.open(@file_path_strategy.file_path_for_remote_control_logs(@example), "w") { |f| f.write logs }
+        end
+        
+      end
+      
+    end
+  end
+end

data/lib/selenium/rspec/rspec_extensions.rb

@@ -0,0 +1,96 @@
+require "rubygems"
+gem "rspec", ">=1.2.8"
+require 'spec'
+require 'spec/example/example_group'
+
+#
+# Monkey-patch RSpec Example Group so that we can track whether an
+# example already failed or not in an after(:each) block
+#
+# Useful to only capture Selenium screenshots when a test fails  
+#
+# * Changed execution_error to be an instance variable (in lieu of 
+#   a local variable).
+#
+# * Introduced an unique id (example_uid) that is the same for 
+#   a real Example (passed in after(:each) when screenshot is 
+#   taken) as well as the corresponding ExampleProxy 
+#   (passed to the HTML formatter). This unique id gives us
+#   a way to correlate file names between generation and 
+#   reporting time.
+#
+module Spec
+  module Example
+    module ExampleMethods
+
+      attr_reader :execution_error
+
+      remove_method :execute
+      def execute(run_options, instance_variables) # :nodoc:
+        @_proxy.options[:actual_example] = self
+        
+        run_options.reporter.example_started(@_proxy)
+        set_instance_variables_from_hash(instance_variables)
+        
+        @execution_error = nil
+        Timeout.timeout(run_options.timeout) do
+          begin
+            before_each_example
+            instance_eval(&@_implementation)
+          rescue Exception => e
+            @execution_error ||= e
+          end
+          begin
+            after_each_example
+          rescue Exception => e
+            @execution_error ||= e
+          end
+        end
+
+        run_options.reporter.example_finished(@_proxy.update(description), @execution_error)
+        success = @execution_error.nil? || ExamplePendingError === @execution_error
+      end
+
+      def actual_failure?
+        case execution_error
+        when nil
+          false
+        when Spec::Example::ExamplePendingError, 
+             Spec::Example::PendingExampleFixedError,
+             Spec::Example::NoDescriptionError
+          false
+        else
+          true
+        end
+      end
+
+      def reporting_uid
+        # backtrace is not reliable anymore using the implementation proc          
+        Digest::MD5.hexdigest @_implementation.inspect
+      end
+
+      def pending_for_browsers(*browser_regexps, &block)
+        actual_browser = selenium_driver.browser_string
+        match_browser_regexps = browser_regexps.inject(false) do |match, regexp| 
+          match ||= actual_browser =~ Regexp.new(regexp.source, Regexp::IGNORECASE)
+        end
+        if match_browser_regexps
+          pending "#{actual_browser.gsub(/\*/, '').capitalize} does not support this feature yet"
+        else 
+          yield
+        end
+      end
+ 
+    end
+
+    class ExampleProxy
+
+      def reporting_uid
+        options[:actual_example].reporting_uid
+      end
+
+    end
+
+  end
+end
+

data/lib/selenium/rspec/spec_helper.rb

@@ -0,0 +1,34 @@
+require 'rubygems'
+require 'spec'
+require 'base64'
+require 'fileutils'
+require File.expand_path(File.dirname(__FILE__) + "/rspec_extensions")
+require File.expand_path(File.dirname(__FILE__) + "/reporting/selenium_test_report_formatter")
+
+Spec::Runner.configure do |config|
+
+  config.prepend_after(:each) do
+    begin 
+      if actual_failure?
+        Selenium::RSpec::SeleniumTestReportFormatter.capture_system_state(selenium_driver, self)
+      end
+      if selenium_driver.session_started?
+        selenium_driver.set_context "Ending example '#{self.description}'"
+      end
+    rescue Exception => e
+      STDERR.puts "Problem while capturing system state" + e
+    end
+  end
+
+  config.append_before(:each) do
+    begin 
+      if selenium_driver && selenium_driver.session_started?
+        selenium_driver.set_context "Starting example '#{self.description}'"
+      end
+    rescue Exception => e
+      STDERR.puts "Problem while setting context on example start" + e
+    end
+  end
+
+end
+

data/lib/selenium/selenese.rb

@@ -0,0 +1,24 @@
+require 'net/http'
+require 'uri'
+require 'cgi'
+require "digest/md5"
+require 'fileutils'
+require 'tmpdir'
+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__) + '/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/legacy_driver')
+require File.expand_path(File.dirname(__FILE__) + '/client/javascript_expression_builder')
+require File.expand_path(File.dirname(__FILE__) + '/client/javascript_frameworks/prototype')
+require File.expand_path(File.dirname(__FILE__) + '/client/javascript_frameworks/jquery')
+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')
+require File.expand_path(File.dirname(__FILE__) + '/client/driver')
+require File.expand_path(File.dirname(__FILE__) + '/client/selenium_helper')
+require File.expand_path(File.dirname(__FILE__) + '/remote_control/remote_control')
+require File.expand_path(File.dirname(__FILE__) + '/rake/remote_control_start_task')
+require File.expand_path(File.dirname(__FILE__) + '/rake/remote_control_stop_task')
+

data/lib/tcp_socket_extension.rb

@@ -0,0 +1,32 @@
+require 'timeout'
+require 'socket'
+
+class TCPSocket
+  
+  def self.wait_for_service(options)
+    verbose_wait until listening_service?(options)
+  end
+  
+  def self.wait_for_service_termination(options)
+    verbose_wait while listening_service?(options)
+  end
+
+  def self.listening_service?(options)
+    Timeout::timeout(options[:timeout] || 20) do
+      begin
+        socket = TCPSocket.new(options[:host], options[:port])
+        socket.close unless socket.nil?
+        true
+      rescue Errno::ECONNREFUSED, 
+             Errno::EBADF           # Windows
+        false
+      end
+    end
+  end
+
+  def self.verbose_wait
+    puts ".\n"
+    sleep 2
+  end
+
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: selenium-selenese
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: false
+  segments: 
+  - 1
+  - 1
+  - 3
+  version: 1.1.3
+platform: ruby
+authors: 
+- Technologies
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-01 00:00:00 +05:30
+default_executable: selenium-rc
+dependencies: []
+
+description: The Selenium Server and Selenium client are merged into single gem. This gem gives you the option to convert the selenium commands into selense script.
+email: dharsininitt@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+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/javascript_expression_builder.rb
+- lib/selenium/client/javascript_frameworks/jquery.rb
+- lib/selenium/client/javascript_frameworks/prototype.rb
+- lib/selenium/client/legacy_driver.rb
+- lib/selenium/client/protocol.rb
+- lib/selenium/client/selenium_helper.rb
+- lib/selenium/selenese.rb
+- lib/selenium/command_error.rb
+- lib/selenium/protocol_error.rb
+- lib/selenium/rake/default_tasks.rb
+- lib/selenium/rake/remote_control_start_task.rb
+- lib/selenium/rake/remote_control_stop_task.rb
+- lib/selenium/rake/tasks.rb
+- lib/selenium/remote_control/remote_control.rb
+- lib/selenium/rspec/reporting/file_path_strategy.rb
+- lib/selenium/rspec/reporting/html_report.rb
+- lib/selenium/rspec/reporting/selenium_test_report_formatter.rb
+- lib/selenium/rspec/reporting/system_capture.rb
+- lib/selenium/rspec/rspec_extensions.rb
+- lib/selenium/rspec/spec_helper.rb
+- lib/selenium.rb
+- lib/tcp_socket_extension.rb
+- examples/script/google.rb
+- vendor/selenium-server.jar
+- README.markdown
+has_rdoc: true
+homepage: http://github.com/pivotal/selenium-rc
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+- --title
+- Selenium Selenese
+- --main
+- README
+- --line-numbers
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: The Selenium Server and Selenium client are merged into single gem. This gem gives you the option to convert the selenium commands into selense script.
+test_files: []
+