capybara-screenshot 1.0.13 → 1.0.26

data/lib/capybara-screenshot/cucumber.rb

@@ -15,13 +15,20 @@ After do |scenario|
 
       # Trying to embed the screenshot into our output."
       if File.exist?(saver.screenshot_path)
-        require "base64"
-        #encode the image into it's base64 representation
         image = open(saver.screenshot_path, 'rb') {|io|io.read}
         saver.display_image
-        #this will embed the image in the HTML report, embed() is defined in cucumber
-        encoded_img = Base64.encode64(image)
-        embed(encoded_img, 'image/png;base64', "Screenshot of the error")
+
+        # cucumber5 deprecates embed in favor of attach
+        if respond_to? :attach
+          #this will embed the image in the HTML report, attach() is defined in cucumber
+          attach(image, 'image/png')
+        else
+          #encode the image into it's base64 representation
+          require "base64"
+          encoded_img = Base64.encode64(image)
+          #this will embed the image in the HTML report, embed() is defined in cucumber
+          embed(encoded_img, 'image/png;base64', "Screenshot of the error")
+        end
       end
     end
   end

data/lib/capybara-screenshot/minitest.rb

@@ -27,7 +27,7 @@ begin
   class Minitest::Test
     include Capybara::Screenshot::MiniTestPlugin
   end
-rescue NameError => e
+rescue NameError
   class MiniTest::Unit::TestCase
     include Capybara::Screenshot::MiniTestPlugin
   end

data/lib/capybara-screenshot/pruner.rb

@@ -13,6 +13,7 @@ module Capybara
           lambda { prune_with_last_run_strategy }
         when Hash
           raise ArgumentError, ":keep key is required" unless strategy[:keep]
+          raise ArgumentError, ":keep must be a Integer" unless strategy[:keep].kind_of?(Integer)
           raise ArgumentError, ":keep value must be number greater than zero" unless strategy[:keep].to_i > 0
           lambda { prune_with_numeric_strategy(strategy[:keep].to_i) }
         else
@@ -25,7 +26,10 @@ module Capybara
       end
 
       private
-      attr_reader :strategy_proc
+      
+      def strategy_proc
+        @strategy_proc
+      end
 
       def wildcard_path
         File.expand_path('*.{html,png}', Screenshot.capybara_root)

data/lib/capybara-screenshot/rspec/base_reporter.rb

@@ -3,7 +3,7 @@ module Capybara
     module RSpec
       module BaseReporter
 
-        # Automatically set up method aliases (very much like ActiveSupport's `alias_method_chain`) 
+        # Automatically set up method aliases (very much like ActiveSupport's `alias_method_chain`)
         # when the module gets included.
         def enhance_with_screenshot(method)
           with_method, without_method = "#{method}_with_screenshot", "#{method}_without_screenshot"
@@ -14,7 +14,6 @@ module Capybara
             end
           end
         end
-
       end
     end
   end

data/lib/capybara-screenshot/rspec/html_embed_reporter.rb

@@ -1,5 +1,6 @@
 require 'capybara-screenshot/rspec/base_reporter'
 require 'base64'
+require 'uri'
 
 module Capybara
   module Screenshot
@@ -13,12 +14,22 @@ module Capybara
           example = @failed_examples.last
           # Ignores saved html file, only saved image will be embedded (if present)
           if (screenshot = example.metadata[:screenshot]) && screenshot[:image]
-            image = File.binread(screenshot[:image])
-            encoded_img = Base64.encode64(image)
-            result += "<img src='data:image/png;base64,#{encoded_img}' style='display: block'>"
+            result += "<img src='#{image_tag_source(screenshot[:image])}' style='display: block'>"
           end
           result
         end
+
+        private
+
+        def image_tag_source(path)
+          if URI.regexp(%w[http https]) =~ path
+            path
+          else
+            image = File.binread(path)
+            encoded_img = Base64.encode64(image)
+            "data:image/png;base64,#{encoded_img}"
+          end
+        end
       end
     end
   end

data/lib/capybara-screenshot/rspec/html_link_reporter.rb

@@ -22,7 +22,7 @@ module Capybara
         end
 
         def link_to_screenshot(title, path)
-          url = URI.escape("file://#{path}")
+          url = URI::DEFAULT_PARSER.escape("file://#{path}")
           title = CGI.escape_html(title)
           attributes = attributes_for_screenshot_link(url).map { |name, val| %{#{name}="#{CGI.escape_html(val)}"} }.join(" ")
           "<a #{attributes}>#{title}</a>"

data/lib/capybara-screenshot/rspec/text_reporter.rb

@@ -26,8 +26,8 @@ module Capybara
         private
         def output_screenshot_info(example)
           return unless (screenshot = example.metadata[:screenshot])
-          output.puts(long_padding + CapybaraScreenshot::Helpers.yellow("HTML screenshot: file://#{screenshot[:html]}")) if screenshot[:html]
-          output.puts(long_padding + CapybaraScreenshot::Helpers.yellow("Image screenshot: file://#{screenshot[:image]}")) if screenshot[:image]
+          output.puts(long_padding + CapybaraScreenshot::Helpers.yellow("HTML screenshot: #{screenshot[:html]}")) if screenshot[:html]
+          output.puts(long_padding + CapybaraScreenshot::Helpers.yellow("Image screenshot: #{screenshot[:image]}")) if screenshot[:image]
         end
 
         def long_padding

data/lib/capybara-screenshot/rspec.rb

@@ -43,7 +43,8 @@ module Capybara
         "RSpec::Core::Formatters::JsonFormatter"          => Capybara::Screenshot::RSpec::JsonReporter,
         "RSpec::Core::Formatters::TextMateFormatter"      => Capybara::Screenshot::RSpec::TextMateLinkReporter, # RSpec 2
         "RSpec::Mate::Formatters::TextMateFormatter"      => Capybara::Screenshot::RSpec::TextMateLinkReporter,  # RSpec 3
-        "Fuubar"                                          => Capybara::Screenshot::RSpec::TextReporter
+        "Fuubar"                                          => Capybara::Screenshot::RSpec::TextReporter,
+        "Spec::Runner::Formatter::TeamcityFormatter"      => Capybara::Screenshot::RSpec::TextReporter
       }
 
       class << self
@@ -52,7 +53,7 @@ module Capybara
         def after_failed_example(example)
           if example.example_group.include?(Capybara::DSL) # Capybara DSL method has been included for a feature we can snapshot
             Capybara.using_session(Capybara::Screenshot.final_session_name) do
-              if Capybara.page.current_url != '' && Capybara::Screenshot.autosave_on_failure && example.exception
+              if Capybara::Screenshot.autosave_on_failure && failed?(example) && Capybara.page.current_url != ''
                 filename_prefix = Capybara::Screenshot.filename_prefix_for(:rspec, example)
 
                 saver = Capybara::Screenshot.new_saver(Capybara, Capybara.page, true, filename_prefix)
@@ -65,6 +66,18 @@ module Capybara
             end
           end
         end
+
+        private
+
+        def failed?(example)
+          return true if example.exception
+          return false unless defined?(::RSpec::Expectations::FailureAggregator)
+
+          failure_notifier = ::RSpec::Support.failure_notifier
+          return false unless failure_notifier.is_a?(::RSpec::Expectations::FailureAggregator)
+
+          failure_notifier.failures.any? || failure_notifier.other_errors.any?
+        end
       end
 
       self.add_link_to_screenshot_for_failed_examples = true
@@ -77,7 +90,15 @@ RSpec.configure do |config|
     Capybara::Screenshot.final_session_name = nil
   end
 
-  config.after do |example_from_block_arg|
+  # TODO: DRY refactor into a method?
+  # Add support for Rails system specs (previously only worked with feature specs)
+  config.after(type: :system) do |example_from_block_arg|
+    # RSpec 3 no longer defines `example`, but passes the example as block argument instead
+    example = config.respond_to?(:expose_current_running_example_as) ? example_from_block_arg : self.example
+
+    Capybara::Screenshot::RSpec.after_failed_example(example)
+  end
+  config.after(type: :feature) do |example_from_block_arg|
     # RSpec 3 no longer defines `example`, but passes the example as block argument instead
     example = config.respond_to?(:expose_current_running_example_as) ? example_from_block_arg : self.example
 
@@ -88,6 +109,7 @@ RSpec.configure do |config|
     if Capybara::Screenshot::RSpec.add_link_to_screenshot_for_failed_examples
       RSpec.configuration.formatters.each do |formatter|
         next unless (reporter_module = Capybara::Screenshot::RSpec::REPORTERS[formatter.class.to_s])
+        next if formatter.singleton_class.included_modules.include?(reporter_module)
         formatter.singleton_class.send :include, reporter_module
       end
     end

data/lib/capybara-screenshot/s3_saver.rb

@@ -1,17 +1,22 @@
-require 'aws-sdk'
+require 'aws-sdk-s3'
 
 module Capybara
   module Screenshot
     class S3Saver
       DEFAULT_REGION = 'us-east-1'
 
-      def initialize(saver, s3_client, bucket_name)
+      attr_accessor :html_path, :screenshot_path
+
+      def initialize(saver, s3_client, bucket_name, object_configuration, options={})
         @saver = saver
         @s3_client = s3_client
         @bucket_name = bucket_name
+        @bucket_host = options[:bucket_host]
+        @key_prefix = options[:key_prefix]
+        @object_configuration = object_configuration
       end
 
-      def self.new_with_configuration(saver, configuration)
+      def self.new_with_configuration(saver, configuration, object_configuration)
         default_s3_client_credentials = {
           region: DEFAULT_REGION
         }
@@ -23,19 +28,31 @@ module Capybara
         s3_client = Aws::S3::Client.new(s3_client_credentials)
         bucket_name = configuration.fetch(:bucket_name)
 
-        new(saver, s3_client, bucket_name)
+        new(saver, s3_client, bucket_name, object_configuration, configuration)
       rescue KeyError
         raise "Invalid S3 Configuration #{configuration}. Please refer to the documentation for the necessary configurations."
       end
 
       def save_and_upload_screenshot
-        save_and do |local_file_path|
+        save_and do |type, local_file_path|
           File.open(local_file_path) do |file|
+            s3_upload_path = "#{@key_prefix}#{File.basename(local_file_path)}"
+
+            object_payload = {
+              bucket: bucket_name,
+              key: s3_upload_path,
+              body: file
+            }
+
+            object_payload.merge!(object_configuration) unless object_configuration.empty?
+
             s3_client.put_object(
-                bucket: bucket_name,
-                key: File.basename(local_file_path),
-                body: file
+                object_payload
             )
+
+            host = bucket_host || determine_bucket_host
+
+            send("#{type}_path=", "https://#{host}/#{s3_upload_path}")
           end
         end
       end
@@ -51,13 +68,24 @@ module Capybara
       private
       attr_reader :saver,
                   :s3_client,
-                  :bucket_name
+                  :bucket_name,
+                  :bucket_host,
+                  :object_configuration
+                  :key_prefix
+
+      ##
+      # Reads the bucket location using a S3 get_bucket_location request.
+      # Requires the +s3:GetBucketLocation+ policy.
+      def determine_bucket_host
+        s3_region = s3_client.get_bucket_location(bucket: bucket_name).location_constraint
+        "#{bucket_name}.s3-#{s3_region}.amazonaws.com"
+      end
 
       def save_and
         saver.save
 
-        yield(saver.html_path) if block_given? && saver.html_saved?
-        yield(saver.screenshot_path) if block_given? && saver.screenshot_saved?
+        yield(:html, saver.html_path) if block_given? && saver.html_saved?
+        yield(:screenshot, saver.screenshot_path) if block_given? && saver.screenshot_saved?
       end
     end
   end

data/lib/capybara-screenshot/saver.rb

@@ -1,9 +1,16 @@
 require 'capybara-screenshot/helpers'
+require 'capybara-screenshot/callbacks'
 
 module Capybara
   module Screenshot
     class Saver
+      include Capybara::Screenshot::Callbacks
+
+      define_callback :after_save_html
+      define_callback :after_save_screenshot
+
       attr_reader :capybara, :page, :file_base_name
+
       def initialize(capybara, page, html_save=true, filename_prefix='screenshot')
         @capybara, @page, @html_save = capybara, page, html_save
         time_now = Time.now
@@ -19,34 +26,50 @@ module Capybara
       end
 
       def save
-        # if current_path empty then nothing to screen shot as browser has not loaded any URL
-        return if capybara.current_path.to_s.empty?
-
-        save_html if @html_save
-        save_screenshot
+        current_path do |path|
+          within_offending_window do
+            if path.empty?
+              warn 'WARN: Screenshot could not be saved. `page.current_path` is empty.'
+            else
+              begin
+                save_html if @html_save
+              rescue StandardError => e
+                warn "WARN: HTML source could not be saved. An exception is raised: #{e.inspect}."
+              end
+
+              begin
+                save_screenshot
+              rescue StandardError => e
+                warn "WARN: Screenshot could not be saved. An exception is raised: #{e.inspect}."
+              end
+            end
+          end
+        end
       end
 
       def save_html
         path = html_path
-        clear_save_and_open_page_path do
+        clear_save_path do
           if Capybara::VERSION.match(/^\d+/)[0] == '1'
-            capybara.save_page(page.body, "#{path}")
+            capybara.save_page(page.body, path.to_s)
           else
-            capybara.save_page("#{path}")
+            capybara.save_page(path.to_s)
           end
         end
         @html_saved = true
+        run_callbacks :after_save_html, html_path if html_saved?
       end
 
       def save_screenshot
         path = screenshot_path
-        clear_save_and_open_page_path do
+        clear_save_path do
           result = Capybara::Screenshot.registered_drivers.fetch(capybara.current_driver) { |driver_name|
             warn "capybara-screenshot could not detect a screenshot driver for '#{capybara.current_driver}'. Saving with default with unknown results."
             Capybara::Screenshot.registered_drivers[:default]
           }.call(page.driver, path)
           @screenshot_saved = result != :not_supported
         end
+        run_callbacks :after_save_screenshot, screenshot_path if screenshot_saved?
       end
 
       def html_path
@@ -65,15 +88,15 @@ module Capybara
         @screenshot_saved
       end
 
-      # If Capybara.save_and_open_page_path is set then
+      # If Capybara::Screenshot.capybara_tmp_path is set then
       # the html_path or screenshot_path can be appended to this path in
       # some versions of Capybara instead of using it as an absolute path
-      def clear_save_and_open_page_path
-        old_path = Capybara.save_and_open_page_path
-        Capybara.save_and_open_page_path = nil
+      def clear_save_path
+        old_path = Capybara::Screenshot.capybara_tmp_path
+        Capybara::Screenshot.capybara_tmp_path = nil
         yield
       ensure
-        Capybara.save_and_open_page_path = old_path
+        Capybara::Screenshot.capybara_tmp_path = old_path
       end
 
       def output_screenshot_path
@@ -88,6 +111,16 @@ module Capybara
 
       private
 
+      def current_path
+        # the current_path may raise error in selenium
+        begin
+          path = page.current_path.to_s
+        rescue StandardError => e
+          warn "WARN: Screenshot could not be saved. `page.current_path` raised exception: #{e.inspect}."
+        end
+        yield path if path
+      end
+
       def output(message)
         puts "    #{CapybaraScreenshot::Helpers.yellow(message)}"
       end
@@ -101,13 +134,25 @@ module Capybara
       #   which('ruby') #=> /usr/bin/ruby
       def which(cmd)
         exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+
         ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
           exts.each { |ext|
             exe = File.join(path, "#{cmd}#{ext}")
             return exe if File.executable?(exe) && !File.directory?(exe)
           }
         end
-        return nil
+
+        nil
+      end
+
+      def within_offending_window
+        return yield unless Thread.current[:capybara_screenshot_offending_window]
+
+        page.within_window(Thread.current[:capybara_screenshot_offending_window]) do
+          yield
+        end
+
+        Thread.current[:capybara_screenshot_offending_window] = nil
       end
     end
   end

data/lib/capybara-screenshot/version.rb

@@ -1,5 +1,5 @@
 module Capybara
   module Screenshot
-    VERSION = '1.0.13'
+    VERSION = '1.0.26'
   end
 end

data/lib/capybara-screenshot.rb

@@ -10,6 +10,7 @@ module Capybara
       attr_writer   :final_session_name
       attr_accessor :prune_strategy
       attr_accessor :s3_configuration
+      attr_accessor :s3_object_configuration
     end
 
     self.autosave_on_failure = true
@@ -20,6 +21,7 @@ module Capybara
     self.webkit_options = {}
     self.prune_strategy = :keep_all
     self.s3_configuration = {}
+    self.s3_object_configuration = {}
 
     def self.append_screenshot_path=(value)
       $stderr.puts "WARNING: Capybara::Screenshot.append_screenshot_path is deprecated. " +
@@ -56,7 +58,7 @@ module Capybara
     end
 
     def self.capybara_root
-      @capybara_root ||= if defined?(::Rails) && ::Rails.root.present?
+      @capybara_root ||= if defined?(::Rails) && ::Rails.respond_to?(:root) && ::Rails.root.present?
         ::Rails.root.join capybara_tmp_path
       elsif defined?(Padrino)
         File.expand_path(capybara_tmp_path, Padrino.root)
@@ -97,12 +99,20 @@ module Capybara
 
       unless s3_configuration.empty?
         require 'capybara-screenshot/s3_saver'
-        saver = S3Saver.new_with_configuration(saver, s3_configuration)
+        saver = S3Saver.new_with_configuration(saver, s3_configuration, s3_object_configuration)
       end
 
       return saver
     end
 
+    def self.after_save_html &block
+      Saver.after_save_html(&block)
+    end
+
+    def self.after_save_screenshot &block
+      Saver.after_save_screenshot(&block)
+    end
+
     private
 
     # If the path isn't set, default to the current directory
@@ -115,6 +125,19 @@ module Capybara
         Capybara.save_and_open_page_path
       end || '.'
     end
+
+    # Configure the path unless '.'
+    def self.capybara_tmp_path=(path)
+      return if path == '.'
+
+      # `#save_and_open_page_path` is deprecated
+      # https://github.com/jnicklas/capybara/blob/48ab1ede946dec2250a2d1d8cbb3313f25096456/History.md#L37
+      if Capybara.respond_to?(:save_path)
+        Capybara.save_path = path
+      else
+        Capybara.save_and_open_page_path = path
+      end
+    end
   end
 end
 
@@ -133,10 +156,14 @@ Capybara::Screenshot.class_eval do
     :not_supported
   end
 
-  register_driver(:selenium) do |driver, path|
+  selenium_block = proc do |driver, path|
     driver.browser.save_screenshot(path)
   end
 
+  register_driver :selenium, &selenium_block
+  register_driver :selenium_chrome, &selenium_block
+  register_driver :selenium_chrome_headless, &selenium_block
+
   register_driver(:poltergeist) do |driver, path|
     driver.render(path, :full => true)
   end
@@ -163,6 +190,14 @@ Capybara::Screenshot.class_eval do
       :not_supported
     end
   end
+
+  register_driver(:apparition) do |driver, path|
+    driver.save_screenshot(path)
+  end
+
+  register_driver(:cuprite) do |driver, path|
+    driver.render(path, :full => true)
+  end
 end
 
 # Register filename prefix formatters

data/spec/cucumber/cucumber_spec.rb

@@ -3,10 +3,6 @@ require "spec_helper"
 describe "Using Capybara::Screenshot with Cucumber" do
   include CommonSetup
 
-  before do
-    setup_aruba
-  end
-
   let(:cmd) { 'cucumber' }
 
   def run_failing_case(failure_message, code)
@@ -30,13 +26,13 @@ describe "Using Capybara::Screenshot with Cucumber" do
 
     write_file('features/cucumber.feature', code)
 
-    run_simple_with_retry cmd, false
+    run_simple_with_retry cmd
 
     expect(last_command_started.output).to_not match(/failed|failure/i) if options[:assert_all_passed]
   end
 
   it 'saves a screenshot on failure' do
-    run_failing_case %q{Unable to find link or button "you'll never find me"}, <<-CUCUMBER
+    run_failing_case %q{Unable to find (visible )?link or button "you'll never find me"}, <<-CUCUMBER
       Feature: Failure
         Scenario: Failure
           Given I visit "/"
@@ -56,7 +52,7 @@ describe "Using Capybara::Screenshot with Cucumber" do
   end
 
   it 'saves a screenshot for the correct session for failures using_session' do
-    run_failing_case(%q{Unable to find link or button "you'll never find me"}, <<-CUCUMBER)
+    run_failing_case(%q{Unable to find (visible )?link or button "you'll never find me"}, <<-CUCUMBER)
       Feature: Failure
         Scenario: Failure in different session
           Given I visit "/"
@@ -72,7 +68,7 @@ describe "Using Capybara::Screenshot with Cucumber" do
     end
 
     it 'on failure it prunes previous screenshots when strategy is set' do
-      run_failing_case %q{Unable to find link or button "you'll never find me"}, <<-CUCUMBER
+      run_failing_case %q{Unable to find (visible )?link or button "you'll never find me"}, <<-CUCUMBER
         Feature: Prune
           Scenario: Screenshots are pruned if strategy is set
             Given I visit "/"

data/spec/feature/minitest_spec.rb

@@ -3,10 +3,6 @@ require "spec_helper"
 describe "Using Capybara::Screenshot with MiniTest" do
   include CommonSetup
 
-  before do
-    setup_aruba
-  end
-
   def run_failing_case(code)
     write_file('test_failure.rb', <<-RUBY)
       #{ensure_load_paths_valid}
@@ -26,8 +22,8 @@ describe "Using Capybara::Screenshot with MiniTest" do
     RUBY
 
     cmd = 'bundle exec ruby test_failure.rb'
-    run_simple_with_retry cmd, false
-    expect(last_command_started.output).to include %q{Unable to find link or button "you'll never find me"}
+    run_simple_with_retry cmd
+    expect(last_command_started.output).to match %r{Unable to find (visible )?link or button "you'll never find me"}
   end
 
   it 'saves a screenshot on failure' do

data/spec/feature/testunit_spec.rb

@@ -3,10 +3,6 @@ require "spec_helper"
 describe "Using Capybara::Screenshot with Test::Unit" do
   include CommonSetup
 
-  before do
-    setup_aruba
-  end
-
   def run_failing_case(code, integration_path = '.')
     write_file("#{integration_path}/test_failure.rb", <<-RUBY)
       #{ensure_load_paths_valid}
@@ -18,7 +14,7 @@ describe "Using Capybara::Screenshot with Test::Unit" do
 
       #{setup_test_app}
       Capybara::Screenshot.register_filename_prefix_formatter(:testunit) do | fault |
-        raise "expected fault" unless fault.exception.message.include? %q{Unable to find link or button "you'll never find me"}
+        raise "expected fault" unless fault.exception.message.match %r{Unable to find (visible )?link or button "you'll never find me"}
         'my_screenshot'
       end
 
@@ -32,8 +28,8 @@ describe "Using Capybara::Screenshot with Test::Unit" do
     RUBY
 
     cmd = "bundle exec ruby #{integration_path}/test_failure.rb"
-    run_simple_with_retry cmd, false
-    expect(last_command_started.output).to include %q{Unable to find link or button "you'll never find me"}
+    run_simple_with_retry cmd
+    expect(last_command_started.output).to match %r{Unable to find (visible )?link or button "you'll never find me"}
   end
 
   it "saves a screenshot on failure for any test in path 'test/integration'" do