leifcr-capybara-screenshot 1.0.14

data/lib/capybara-screenshot.rb

@@ -0,0 +1,217 @@
+module Capybara
+  module Screenshot
+    class << self
+      attr_accessor :autosave_on_failure
+      attr_accessor :registered_drivers
+      attr_accessor :filename_prefix_formatters
+      attr_accessor :append_timestamp
+      attr_accessor :append_random
+      attr_accessor :webkit_options
+      attr_writer   :final_session_name
+      attr_accessor :prune_strategy
+      attr_accessor :s3_configuration
+      attr_accessor :alternative_root
+    end
+
+    self.autosave_on_failure = true
+    self.registered_drivers = {}
+    self.filename_prefix_formatters = {}
+    self.append_timestamp = true
+    self.append_random = false
+    self.webkit_options = {}
+    self.prune_strategy = :keep_all
+    self.s3_configuration = {}
+    self.alternative_root = ''
+
+    def self.append_screenshot_path=(value)
+      $stderr.puts "WARNING: Capybara::Screenshot.append_screenshot_path is deprecated. " +
+        "Please use Capybara::Screenshot::RSpec.add_link_to_screenshot_for_failed_examples instead."
+      RSpec.add_link_to_screenshot_for_failed_examples = value
+    end
+
+    def self.screenshot_and_save_page
+      saver = new_saver(Capybara, Capybara.page)
+      if saver.save
+        {:html => saver.html_path, :image => saver.screenshot_path}
+      end
+    end
+
+    def self.screenshot_and_open_image
+      require "launchy"
+
+      saver = new_saver(Capybara, Capybara.page, false)
+      if saver.save
+        Launchy.open saver.screenshot_path
+        {:html => nil, :image => saver.screenshot_path}
+      end
+    end
+
+    class << self
+      alias screen_shot_and_save_page screenshot_and_save_page
+      alias screen_shot_and_open_image screenshot_and_open_image
+    end
+
+    def self.filename_prefix_for(test_type, test)
+      filename_prefix_formatters.fetch(test_type) { |key|
+        filename_prefix_formatters[:default]
+      }.call(test)
+    end
+
+    def self.capybara_alt_root
+      @capybara_root ||= if !alternative_root.blank?
+        alternative_root
+      elsif defined?(::Rails) && ::Rails.root.present?
+        ::Rails.root.join capybara_tmp_path
+      elsif defined?(Padrino)
+        File.expand_path(capybara_tmp_path, Padrino.root)
+      elsif defined?(Sinatra)
+        File.join(Sinatra::Application.root, capybara_tmp_path)
+      else
+        capybara_tmp_path
+      end.to_s
+    end
+
+    def self.capybara_root
+      @capybara_root ||= if defined?(::Rails) && ::Rails.root.present?
+        ::Rails.root.join capybara_tmp_path
+      elsif defined?(Padrino)
+        File.expand_path(capybara_tmp_path, Padrino.root)
+      elsif defined?(Sinatra)
+        File.join(Sinatra::Application.root, capybara_tmp_path)
+      else
+        capybara_tmp_path
+      end.to_s
+    end
+
+    def self.register_driver(driver, &block)
+      self.registered_drivers[driver] = block
+    end
+
+    def self.register_filename_prefix_formatter(test_type, &block)
+      self.filename_prefix_formatters[test_type] = block
+    end
+
+    def self.final_session_name
+      @final_session_name || Capybara.session_name || :default
+    end
+
+    # Prune screenshots based on prune_strategy
+    # Will run only once unless force:true
+    def self.prune(options = {})
+      reset_prune_history if options[:force]
+      Capybara::Screenshot::Pruner.new(Capybara::Screenshot.prune_strategy).prune_old_screenshots unless @pruned_previous_screenshots
+      @pruned_previous_screenshots = true
+    end
+
+    # Reset prune history allowing further prunining on next failure
+    def self.reset_prune_history
+      @pruned_previous_screenshots = nil
+    end
+
+    def self.new_saver(*args)
+      saver = Saver.new(*args)
+
+      unless s3_configuration.empty?
+        require 'capybara-screenshot/s3_saver'
+        saver = S3Saver.new_with_configuration(saver, s3_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
+    def self.capybara_tmp_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
+      else
+        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
+
+# Register driver renderers.
+# The block should return `:not_supported` if a screenshot could not be saved.
+Capybara::Screenshot.class_eval do
+  register_driver(:default) do |driver, path|
+    driver.render(path)
+  end
+
+  register_driver(:rack_test) do |driver, path|
+    :not_supported
+  end
+
+  register_driver(:mechanize) do |driver, path|
+    :not_supported
+  end
+
+  register_driver(:selenium) do |driver, path|
+    driver.browser.save_screenshot(path)
+  end
+
+  register_driver(:poltergeist) do |driver, path|
+    driver.render(path, :full => true)
+  end
+
+  register_driver(:poltergeist_billy) do |driver, path|
+    driver.render(path, :full => true)
+  end
+
+  webkit_block = proc do |driver, path|
+    if driver.respond_to?(:save_screenshot)
+      driver.save_screenshot(path, webkit_options)
+    else
+      driver.render(path)
+    end
+  end
+
+  register_driver :webkit,       &webkit_block
+  register_driver :webkit_debug, &webkit_block
+
+  register_driver(:terminus) do |driver, path|
+    if driver.respond_to?(:save_screenshot)
+      driver.save_screenshot(path)
+    else
+      :not_supported
+    end
+  end
+end
+
+# Register filename prefix formatters
+Capybara::Screenshot.class_eval do
+  register_filename_prefix_formatter(:default) do |test|
+    'screenshot'
+  end
+end
+
+require 'capybara/dsl'
+require 'capybara/util/save_and_open_page' if Capybara::VERSION.match(/^\d+/)[0] == '1' # no longer needed in Capybara version 2
+
+require 'capybara-screenshot/saver'
+require 'capybara-screenshot/capybara'
+require 'capybara-screenshot/pruner'

data/spec/cucumber/cucumber_spec.rb

@@ -0,0 +1,89 @@
+require "spec_helper"
+
+describe "Using Capybara::Screenshot with Cucumber" do
+  include CommonSetup
+
+  let(:cmd) { 'cucumber' }
+
+  def run_failing_case(failure_message, code)
+    run_case code
+    expect(last_command_started.output).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(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
+      Feature: Failure
+        Scenario: Failure
+          Given I visit "/"
+          And I click on a missing link
+    CUCUMBER
+    expect('tmp/my_screenshot.html').to have_file_content('This is the root page')
+  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
+    expect('tmp/my_screenshot.html').to have_file_content('This is the root page')
+  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
+    expect('tmp/my_screenshot.html').to have_file_content('This is a different page')
+  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

data/spec/cucumber/step_definitions/step_definitions.rb

@@ -0,0 +1,18 @@
+When(/^I click on a missing link$/) do
+  click_on "you'll never find me"
+end
+
+When(/^I click on a missing link on a different page in a different session$/) do
+  using_session :different_session do
+    visit '/different_page'
+    click_on "you'll never find me"
+  end
+end
+
+When(/^I visit "([^"]*)"$/) do |path|
+  visit path
+end
+
+Then(/^I trigger an unhandled exception/) do
+  raise "you can't handle me"
+end

data/spec/cucumber/support/env.rb

@@ -0,0 +1,17 @@
+require 'capybara/cucumber'
+require 'capybara-screenshot'
+require 'capybara-screenshot/cucumber'
+require 'aruba/cucumber'
+require 'aruba/config/jruby'
+
+Capybara::Screenshot.register_filename_prefix_formatter(:cucumber) do |fault|
+  'my_screenshot'
+end
+
+Before do
+  @aruba_timeout_seconds = 60
+end if RUBY_PLATFORM == 'java'
+
+After('@restore-capybara-default-session') do
+  Capybara.session_name = nil
+end

data/spec/feature/minitest_spec.rb

@@ -0,0 +1,79 @@
+require "spec_helper"
+
+describe "Using Capybara::Screenshot with MiniTest" do
+  include CommonSetup
+
+  def run_failing_case(code)
+    write_file('test_failure.rb', <<-RUBY)
+      #{ensure_load_paths_valid}
+      require 'minitest/autorun'
+      require 'capybara'
+      require 'capybara-screenshot'
+      require 'capybara-screenshot/minitest'
+
+      #{setup_test_app}
+      Capybara::Screenshot.register_filename_prefix_formatter(:minitest) do |test_case|
+        test_name = test_case.respond_to?(:name) ? test_case.name : test_case.__name__
+        raise "expected fault" unless test_name.include? 'test_failure'
+        'my_screenshot'
+      end
+
+      #{code}
+    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"}
+  end
+
+  it 'saves a screenshot on failure' do
+    run_failing_case <<-RUBY
+      class TestFailure < MiniTest::Unit::TestCase
+        include Capybara::DSL
+
+        def test_failure
+          visit '/'
+          assert(page.body.include?('This is the root page'))
+          click_on "you'll never find me"
+        end
+      end
+    RUBY
+    expect('tmp/my_screenshot.html').to have_file_content('This is the root page')
+  end
+
+  it 'saves a screenshot for the correct session for failures using_session' do
+    run_failing_case <<-RUBY
+      class TestFailure < Minitest::Unit::TestCase
+        include Capybara::DSL
+
+        def test_failure
+          visit '/'
+          assert(page.body.include?('This is the root page'))
+          using_session :different_session do
+            visit '/different_page'
+            assert(page.body.include?('This is a different page'))
+            click_on "you'll never find me"
+          end
+        end
+      end
+    RUBY
+    expect('tmp/my_screenshot.html').to have_file_content('This is a different page')
+  end
+
+  it 'prunes screenshots on failure' do
+    create_screenshot_for_pruning
+    configure_prune_strategy :last_run
+    run_failing_case <<-RUBY
+      class TestFailure < Minitest::Unit::TestCase
+        include Capybara::DSL
+
+        def test_failure
+          visit '/'
+          assert(page.body.include?('This is the root page'))
+          click_on "you'll never find me"
+        end
+      end
+    RUBY
+    assert_screenshot_pruned
+  end
+end

data/spec/feature/testunit_spec.rb

@@ -0,0 +1,77 @@
+require "spec_helper"
+
+describe "Using Capybara::Screenshot with Test::Unit" do
+  include CommonSetup
+
+  def run_failing_case(code, integration_path = '.')
+    write_file("#{integration_path}/test_failure.rb", <<-RUBY)
+      #{ensure_load_paths_valid}
+      require 'test/unit'
+      require 'capybara'
+      require 'capybara/rspec'
+      require 'capybara-screenshot'
+      require 'capybara-screenshot/testunit'
+
+      #{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"}
+        'my_screenshot'
+      end
+
+      class TestFailure < Test::Unit::TestCase
+        include Capybara::DSL
+
+        def test_failure
+          #{code}
+        end
+      end
+    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"}
+  end
+
+  it "saves a screenshot on failure for any test in path 'test/integration'" do
+    run_failing_case <<-RUBY, 'test/integration'
+      visit '/'
+      assert(page.body.include?('This is the root page'))
+      click_on "you'll never find me"
+    RUBY
+    expect('tmp/my_screenshot.html').to have_file_content('This is the root page')
+  end
+
+  it "does not generate a screenshot for tests that are not in 'test/integration'" do
+    run_failing_case <<-RUBY, 'test/something-else'
+      visit '/'
+      assert(page.body.include?('This is the root page'))
+      click_on "you'll never find me"
+    RUBY
+
+    expect('tmp/my_screenshot.html').to_not be_an_existing_file
+  end
+
+  it 'saves a screenshot for the correct session for failures using_session' do
+    run_failing_case <<-RUBY, 'test/integration'
+      visit '/'
+      assert(page.body.include?('This is the root page'))
+      using_session :different_session do
+        visit '/different_page'
+        assert(page.body.include?('This is a different page'))
+        click_on "you'll never find me"
+      end
+    RUBY
+    expect('tmp/my_screenshot.html').to have_file_content('This is a different page')
+  end
+
+  it 'prunes screenshots on failure' do
+    create_screenshot_for_pruning
+    configure_prune_strategy :last_run
+    run_failing_case <<-RUBY, 'test/integration'
+      visit '/'
+      assert(page.body.include?('This is the root page'))
+      click_on "you'll never find me"
+    RUBY
+    assert_screenshot_pruned
+  end
+end