selenium-client 1.1 → 1.2

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

@@ -0,0 +1,70 @@
+module Selenium
+  module RSpec
+    module Reporting
+      
+      class FilePathStrategy
+      
+        def initialize(final_report_file_path)
+          @final_report_file_path = final_report_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_hash(example)}.html"
+        end
+
+        def relative_file_path_for_system_screenshot(example)
+          "#{relative_dir}/example_#{example_hash(example)}_system_screenshot.png"
+        end
+
+        def relative_file_path_for_page_screenshot(example)
+          "#{relative_dir}/example_#{example_hash(example)}_page_screenshot.png"
+        end
+
+        def relative_file_path_for_remote_control_logs(example)
+          "#{relative_dir}/example_#{example_hash(example)}_remote_control.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(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
+
+        def example_hash(example)
+          Digest::MD5.hexdigest example.implementation_backtrace.first
+        end
+      
+      end
+      
+    end      
+  end
+end

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

@@ -0,0 +1,123 @@
+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_" + @file_path_strategy.example_hash(example)
+          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)
+          
+          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? @file_path_strategy.file_path_for_remote_control_logs(example)          
+            html << toggable_section(dom_id, :id => "rc_logs", :url=> remote_control_logs_url, :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_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
+    
+  end
+end

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

@@ -0,0 +1,88 @@
+#
+# 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 "rubygems"
+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 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)
+        @@file_path_strategy = Selenium::RSpec::Reporting::FilePathStrategy.new(@where)
+      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_passed(example)
+        include_example_group_description example
+        super
+      end
+  
+      def example_pending(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
+        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
+
+      protected
+        
+      def include_example_group_description(example)
+        def example.description
+          self.class.description.to_s + " :: " + super
+        end
+      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), "w") { |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), "w") { |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,43 @@
+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  
+#
+# Only changed execution_error to be an instance variable (in lieu of 
+# a local variable).
+#
+module Spec
+  module Example
+    
+    class ExampleGroup
+      attr_reader :execution_error
+
+      def execute(options, instance_variables)
+        options.reporter.example_started(self)
+        set_instance_variables_from_hash(instance_variables)
+        
+        @execution_error = nil
+        Timeout.timeout(options.timeout) do
+          begin
+            before_example
+            run_with_description_capturing
+          rescue Exception => e
+            @execution_error ||= e
+          end
+          begin
+            after_example
+          rescue Exception => e
+            @execution_error ||= e
+          end
+        end
+
+        options.reporter.example_finished(self, @execution_error)
+        success = @execution_error.nil? || ExamplePendingError === @execution_error
+      end
+      
+    end
+  end
+end

data/lib/selenium/rspec/spec_helper.rb

@@ -0,0 +1,22 @@
+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.after(:each) do
+    begin 
+      Selenium::RSpec::SeleniumTestReportFormatter.capture_system_state(selenium_driver, self) if execution_error
+      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
+
+end
+

data/lib/tcp_socket_extension.rb

@@ -0,0 +1,23 @@
+require 'timeout'
+require 'socket'
+
+class TCPSocket
+  
+  def self.wait_for_service(options)
+    socket = nil
+    Timeout::timeout(options[:timeout] || 20) do
+      loop do
+        begin
+          socket = TCPSocket.new(options[:host], options[:port])
+          return
+        rescue Errno::ECONNREFUSED
+          puts ".\n"
+          sleep 2
+        end
+      end
+    end
+  ensure
+    socket.close unless socket.nil?
+  end
+  
+end