selenium-rspec-dsl 1.0.2

data/vendor/selenium-client-1.2.17/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/vendor/selenium-client-1.2.17/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_" + 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)
+          
+          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/vendor/selenium-client-1.2.17/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"
+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/vendor/selenium-client-1.2.17/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/vendor/selenium-client-1.2.17/lib/selenium/rspec/rspec_extensions.rb

@@ -0,0 +1,96 @@
+require "rubygems"
+gem "rspec"
+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
+