capybara-screenshot-nocolor 1.0.5

data/lib/capybara-screenshot/rspec.rb

@@ -0,0 +1,92 @@
+require "capybara-screenshot"
+
+require "capybara-screenshot/rspec/text_reporter"
+require "capybara-screenshot/rspec/html_link_reporter"
+require "capybara-screenshot/rspec/html_embed_reporter"
+require "capybara-screenshot/rspec/textmate_link_reporter"
+
+module Capybara
+  module Screenshot
+    module RSpec
+
+      # Reporters extend RSpec formatters to display information about screenshots for failed
+      # examples.
+      #
+      # Technically, a reporter is a module that gets injected into a RSpec formatter class.
+      # It uses method aliasing to extend some (usually just one) of the formatter's methods.
+      #
+      # Implementing a custom reporter is as simple as creating a module and setting up the
+      # appropriate aliases. Use `BaseReporter.enhance_with_screenshot` if you don't want
+      # to set up the aliases manually:
+      #
+      #   module MyReporter
+      #     extend Capybara::Screenshot::RSpec::BaseReporter
+      #
+      #     # Will replace the formatter's original `dump_failure_info` method with
+      #     # `dump_failure_info_with_screenshot` from this module:
+      #     enhance_with_screenshot :dump_failure_info
+      #
+      #     def dump_failure_info_with_screenshot(example)
+      #       dump_failure_info_without_screenshot(example) # call original implementation
+      #       ... # your additions here
+      #     end
+      #   end
+      #
+      # Finally customize `Capybara::Screenshot::RSpec::FORMATTERS` to make sure your reporter
+      # gets injected into the appropriate formatter.
+
+      REPORTERS = {
+        "RSpec::Core::Formatters::ProgressFormatter"      => Capybara::Screenshot::RSpec::TextReporter,
+        "RSpec::Core::Formatters::DocumentationFormatter" => Capybara::Screenshot::RSpec::TextReporter,
+        "RSpec::Core::Formatters::HtmlFormatter"          => Capybara::Screenshot::RSpec::HtmlLinkReporter,
+        "RSpec::Core::Formatters::TextMateFormatter"      => Capybara::Screenshot::RSpec::TextMateLinkReporter, # RSpec 2
+        "RSpec::Mate::Formatters::TextMateFormatter"      => Capybara::Screenshot::RSpec::TextMateLinkReporter  # RSpec 3
+      }
+
+      class << self
+        attr_accessor :add_link_to_screenshot_for_failed_examples
+
+        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
+                filename_prefix = Capybara::Screenshot.filename_prefix_for(:rspec, example)
+
+                saver = Capybara::Screenshot::Saver.new(Capybara, Capybara.page, true, filename_prefix)
+                saver.save
+
+                example.metadata[:screenshot] = {}
+                example.metadata[:screenshot][:html]  = saver.html_path if saver.html_saved?
+                example.metadata[:screenshot][:image] = saver.screenshot_path if saver.screenshot_saved?
+              end
+            end
+          end
+        end
+      end
+
+      self.add_link_to_screenshot_for_failed_examples = true
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.before do
+    Capybara::Screenshot.final_session_name = nil
+  end
+
+  config.after 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.before(:suite) do
+    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])
+        formatter.singleton_class.send :include, reporter_module
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+module Capybara
+  module Screenshot
+    module RSpec
+      module BaseReporter
+
+        # 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"
+          define_singleton_method :included do |mod|
+            if mod.method_defined?(method) || mod.private_method_defined?(method)
+              mod.send :alias_method, without_method, method
+              mod.send :alias_method, method, with_method
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+require 'capybara-screenshot/rspec/base_reporter'
+require 'base64'
+
+module Capybara
+  module Screenshot
+    module RSpec
+      module HtmlEmbedReporter
+        extend BaseReporter
+        enhance_with_screenshot :extra_failure_content
+
+        def extra_failure_content_with_screenshot(exception)
+          result  = extra_failure_content_without_screenshot(exception)
+          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'>"
+          end
+          result
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+require 'capybara-screenshot/rspec/base_reporter'
+require 'cgi'
+require 'uri'
+
+module Capybara
+  module Screenshot
+    module RSpec
+      module HtmlLinkReporter
+        extend BaseReporter
+        enhance_with_screenshot :extra_failure_content
+
+        def extra_failure_content_with_screenshot(exception)
+          result  = extra_failure_content_without_screenshot(exception)
+          example = @failed_examples.last
+          if (screenshot = example.metadata[:screenshot])
+            result << "<p>Saved files: "
+            result << link_to_screenshot("HTML page",  screenshot[:html]) if screenshot[:html]
+            result << link_to_screenshot("Screenshot", screenshot[:image]) if screenshot[:image]
+            result << "</p>"
+          end
+          result
+        end
+
+        def link_to_screenshot(title, path)
+          url = URI.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>"
+        end
+
+        def attributes_for_screenshot_link(url)
+          {"href" => url, "style" => "margin-right: 10px; font-weight: bold"}
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+require 'capybara-screenshot/rspec/base_reporter'
+
+module Capybara
+  module Screenshot
+    module RSpec
+      module TextReporter
+        extend BaseReporter
+
+        if ::RSpec::Core::Version::STRING.to_i <= 2
+          enhance_with_screenshot :dump_failure_info
+        else
+          enhance_with_screenshot :example_failed
+        end
+
+        def dump_failure_info_with_screenshot(example)
+          dump_failure_info_without_screenshot example
+          output_screenshot_info(example)
+        end
+
+        def example_failed_with_screenshot(notification)
+          example_failed_without_screenshot notification
+          output_screenshot_info(notification.example)
+        end
+
+        private
+        def output_screenshot_info(example)
+          return unless (screenshot = example.metadata[:screenshot])
+          output.puts(long_padding + "HTML screenshot: #{screenshot[:html]}") if screenshot[:html]
+          output.puts(long_padding + "Image screenshot: #{screenshot[:image]}") if screenshot[:image]
+        end
+
+        def long_padding
+          "  "
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require 'capybara-screenshot/rspec/base_reporter'
+require 'capybara-screenshot/rspec/html_link_reporter'
+require 'shellwords'
+
+module Capybara
+  module Screenshot
+    module RSpec
+      module TextMateLinkReporter
+        extend BaseReporter
+        include HtmlLinkReporter
+        enhance_with_screenshot :extra_failure_content
+
+        def attributes_for_screenshot_link(url)
+          super.merge("onclick" => "TextMate.system('open #{Shellwords.escape(url)}'); return false;")
+        end
+      end
+    end
+  end
+end

data/lib/capybara-screenshot/saver.rb

@@ -0,0 +1,87 @@
+module Capybara
+  module Screenshot
+    class Saver
+      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
+        timestamp = "#{time_now.strftime('%Y-%m-%d-%H-%M-%S.')}#{'%03d' % (time_now.usec/1000).to_i}"
+
+        filename = [filename_prefix]
+        filename << timestamp if Capybara::Screenshot.append_timestamp
+        filename << SecureRandom.hex if Capybara::Screenshot.append_random
+
+        @file_base_name = filename.join('_')
+
+        Capybara::Screenshot.prune
+      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
+      end
+
+      def save_html
+        path = html_path
+        clear_save_and_open_page_path do
+          if Capybara::VERSION.match(/^\d+/)[0] == '1'
+            capybara.save_page(page.body, "#{path}")
+          else
+            capybara.save_page("#{path}")
+          end
+        end
+        @html_saved = true
+      end
+
+      def save_screenshot
+        path = screenshot_path
+        clear_save_and_open_page_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
+      end
+
+      def html_path
+        File.join(Capybara::Screenshot.capybara_root, "#{file_base_name}.html")
+      end
+
+      def screenshot_path
+        File.join(Capybara::Screenshot.capybara_root, "#{file_base_name}.png")
+      end
+
+      def html_saved?
+        @html_saved
+      end
+
+      def screenshot_saved?
+        @screenshot_saved
+      end
+
+      # If Capybara.save_and_open_page_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
+        yield
+        Capybara.save_and_open_page_path = old_path
+      end
+
+      def output_screenshot_path
+        output "HTML screenshot: #{html_path}" if html_saved?
+        output "Image screenshot: #{screenshot_path}" if screenshot_saved?
+      end
+
+      private
+      def output(message)
+        puts "    #{message}"
+      end
+    end
+  end
+end

data/lib/capybara-screenshot/spinach.rb

@@ -0,0 +1,26 @@
+require "capybara-screenshot"
+
+Spinach.hooks.before_scenario do |scenario|
+  Capybara::Screenshot.final_session_name = nil
+end
+
+module Capybara::Screenshot::Spinach
+  def self.fail_with_screenshot(step_data, exception, location, step_definitions)
+    if Capybara::Screenshot.autosave_on_failure
+      Capybara.using_session(Capybara::Screenshot.final_session_name) do
+        filename_prefix = Capybara::Screenshot.filename_prefix_for(:spinach, step_data)
+        saver = Capybara::Screenshot::Saver.new(Capybara, Capybara.page, true, filename_prefix)
+        saver.save
+        saver.output_screenshot_path
+      end
+    end
+  end
+end
+
+Spinach.hooks.on_failed_step do |*args|
+  Capybara::Screenshot::Spinach.fail_with_screenshot(*args)
+end
+
+Spinach.hooks.on_error_step do |*args|
+  Capybara::Screenshot::Spinach.fail_with_screenshot(*args)
+end

data/lib/capybara-screenshot/testunit.rb

@@ -0,0 +1,39 @@
+require 'test/unit/testresult'
+
+module Capybara::Screenshot
+  class << self
+    attr_accessor :testunit_paths
+  end
+
+  self.testunit_paths = [%r{test/integration}]
+end
+
+Test::Unit::TestCase.class_eval do
+  setup do
+    Capybara::Screenshot.final_session_name = nil
+  end
+end
+
+Test::Unit::TestResult.class_eval do
+  private
+
+  def notify_fault_with_screenshot(fault, *args)
+    notify_fault_without_screenshot fault, *args
+    is_integration_test = fault.location.any? do |location|
+      Capybara::Screenshot.testunit_paths.any? { |path| location.match(path) }
+    end
+    if is_integration_test
+      if Capybara::Screenshot.autosave_on_failure
+        Capybara.using_session(Capybara::Screenshot.final_session_name) do
+          filename_prefix = Capybara::Screenshot.filename_prefix_for(:testunit, fault)
+
+          saver = Capybara::Screenshot::Saver.new(Capybara, Capybara.page, true, filename_prefix)
+          saver.save
+          saver.output_screenshot_path
+        end
+      end
+    end
+  end
+  alias notify_fault_without_screenshot notify_fault
+  alias notify_fault notify_fault_with_screenshot
+end

data/lib/capybara-screenshot/version.rb

@@ -0,0 +1,5 @@
+module Capybara
+  module Screenshot
+    VERSION = '1.0.5'
+  end
+end

data/spec/cucumber/cucumber_spec.rb

@@ -0,0 +1,93 @@
+require "spec_helper"
+
+describe "Using Capybara::Screenshot with Cucumber" do
+  include CommonSetup
+
+  before do
+    clean_current_dir
+  end
+
+  let(:cmd) { 'bundle exec cucumber' }
+
+  def run_failing_case(failure_message, code)
+    run_case code
+    expect(output_from(cmd)).to match(failure_message)
+  end
+
+  def run_case(code, options = {})
+    write_file('features/support/env.rb', <<-RUBY)
+      #{ensure_load_paths_valid}
+      require 'cucumber/support/env.rb'
+      #{setup_test_app}
+    RUBY
+
+    write_file('features/step_definitions/step_definitions.rb', <<-RUBY)
+      %w(lib spec).each do |include_folder|
+        $LOAD_PATH.unshift(File.join('#{gem_root}', include_folder))
+      end
+      require 'cucumber/step_definitions/step_definitions.rb'
+    RUBY
+
+    write_file('features/cucumber.feature', code)
+
+    run_simple_with_retry cmd, false
+
+    expect(output_from(cmd)).to_not include('failed)') 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
+      Feature: Failure
+        Scenario: Failure
+          Given I visit "/"
+          And I click on a missing link
+    CUCUMBER
+    check_file_content 'tmp/my_screenshot.html', 'This is the root page', true
+  end
+
+  it 'saves a screenshot on an error' do
+    run_failing_case %q{you can't handle me}, <<-CUCUMBER
+      Feature: Failure
+        Scenario: Failure
+          Given I visit "/"
+          And I trigger an unhandled exception
+    CUCUMBER
+    check_file_content 'tmp/my_screenshot.html', 'This is the root page', true
+  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)
+      Feature: Failure
+        Scenario: Failure in different session
+          Given I visit "/"
+          And I click on a missing link on a different page in a different session
+    CUCUMBER
+    check_file_content 'tmp/my_screenshot.html', 'This is a different page', true
+  end
+
+  context 'pruning' do
+    before do
+      create_screenshot_for_pruning
+      configure_prune_strategy :last_run
+    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
+        Feature: Prune
+          Scenario: Screenshots are pruned if strategy is set
+            Given I visit "/"
+            And I click on a missing link
+      CUCUMBER
+      assert_screenshot_pruned
+    end
+
+    it 'on success it never prunes' do
+      run_case <<-CUCUMBER, assert_all_passed: true
+        Feature: Prune
+          Scenario: Screenshots are pruned if strategy is set
+            Given I visit "/"
+      CUCUMBER
+      assert_screenshot_not_pruned
+    end
+  end
+end