capybara-screenshot 0.3.22 → 1.0.0

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/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,90 @@
+require "spec_helper"
+
+describe "Using Capybara::Screenshot with MiniTest" do
+  include Aruba::Api
+  include CommonSetup
+
+  before do
+    clean_current_dir
+  end
+
+  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 cmd, false
+    expect(output_from(cmd)).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
+      module ActionDispatch
+        class IntegrationTest < Minitest::Unit::TestCase; end
+      end
+
+      class TestFailure < ActionDispatch::IntegrationTest
+        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
+    check_file_content('tmp/my_screenshot.html', 'This is the root page', true)
+  end
+
+  it "does not save a screenshot for tests that don't inherit from ActionDispatch::IntegrationTest" 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
+    check_file_presence(%w{tmp/my_screenshot.html}, false)
+  end
+
+  it "saves a screenshot for the correct session for failures using_session" do
+    run_failing_case <<-RUBY
+      module ActionDispatch
+        class IntegrationTest < Minitest::Unit::TestCase; end
+      end
+
+      class TestFailure < ActionDispatch::IntegrationTest
+        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
+    check_file_content('tmp/my_screenshot.html', 'This is a different page', true)
+  end
+end

data/spec/feature/testunit_spec.rb

@@ -0,0 +1,71 @@
+require "spec_helper"
+
+describe "Using Capybara::Screenshot with Test::Unit" do
+  include Aruba::Api
+  include CommonSetup
+
+  before do
+    clean_current_dir
+  end
+
+  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 cmd, false
+    expect(output_from(cmd)).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
+    check_file_content('tmp/my_screenshot.html', 'This is the root page', true)
+  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
+
+    check_file_presence(%w{tmp/my_screenshot.html}, false)
+  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
+    check_file_content('tmp/my_screenshot.html', 'This is a different page', true)
+  end
+end

data/spec/rspec/rspec_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+describe Capybara::Screenshot::RSpec do
+  describe "used with RSpec" do
+    include Aruba::Api
+    include CommonSetup
+
+    before do
+      clean_current_dir
+    end
+
+    def run_failing_case(code, error_message, format=nil)
+      write_file('spec/test_failure.rb', <<-RUBY)
+        #{ensure_load_paths_valid}
+        require 'rspec'
+        require 'capybara'
+        require 'capybara/rspec'
+        require 'capybara-screenshot'
+        require 'capybara-screenshot/rspec'
+
+        #{setup_test_app}
+        #{code}
+      RUBY
+
+      cmd = "bundle exec rspec #{"--format #{format} " if format}spec/test_failure.rb"
+      run_simple cmd, false
+
+      if error_message.kind_of?(Regexp)
+        expect(output_from(cmd)).to match(error_message)
+      else
+        expect(output_from(cmd)).to include(error_message)
+      end
+    end
+
+    it "saves a screenshot on failure" do
+      run_failing_case <<-RUBY, %q{Unable to find link or button "you'll never find me"}
+        feature 'screenshot with failure' do
+          scenario 'click on a missing link' do
+            visit '/'
+            expect(page.body).to include('This is the root page')
+            click_on "you'll never find me"
+          end
+        end
+      RUBY
+      check_file_content('tmp/screenshot.html', 'This is the root page', true)
+    end
+
+    formatters = {
+      progress:      "HTML screenshot:",
+      documentation: "HTML screenshot:",
+      html:          %r{<a href="file://\./tmp/screenshot\.html"[^>]*>HTML page</a>}
+    }
+
+    # Textmate formatter is only included in RSpec 2
+    if RSpec::Version::STRING.to_i == 2
+      formatters[:textmate] = %r{TextMate\.system\(.*open file://\./tmp/screenshot.html}
+    end
+
+    formatters.each do |formatter, error_message|
+      it "uses the associated #{formatter} formatter" do
+        run_failing_case <<-RUBY, error_message, formatter
+          feature 'screenshot with failure' do
+            scenario 'click on a missing link' do
+              visit '/'
+              click_on "you'll never find me"
+            end
+          end
+        RUBY
+        check_file_content('tmp/screenshot.html', 'This is the root page', true)
+      end
+    end
+
+    it "does not save a screenshot for tests that don't use Capybara" do
+      run_failing_case <<-RUBY, %q{expected: false}
+        describe 'failing test' do
+          it 'fails intentionally' do
+            expect(true).to eql(false)
+          end
+        end
+      RUBY
+      check_file_presence(%w{tmp/screenshot.html}, false)
+    end
+
+    it "saves a screenshot for the correct session for failures using_session" do
+      run_failing_case <<-RUBY, %q{Unable to find link or button "you'll never find me"}
+        feature 'screenshot with failure' do
+          scenario 'click on a missing link' do
+            visit '/'
+            expect(page.body).to include('This is the root page')
+            using_session :different_session do
+              visit '/different_page'
+              expect(page.body).to include('This is a different page')
+              click_on "you'll never find me"
+            end
+          end
+        end
+      RUBY
+      check_file_content('tmp/screenshot.html', 'This is a different page', true)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -6,16 +6,24 @@
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 
 $: << '../lib'
+require 'rspec'
 require 'capybara-screenshot'
 require 'capybara-screenshot/rspec'
 require 'timecop'
+require 'aruba/api'
+require 'aruba/jruby'
 
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
 
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
+  if RSpec::Version::STRING.to_i == 2
+    config.treat_symbols_as_metadata_keys_with_true_values = true
+  end
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
+  config.before do
+    @aruba_timeout_seconds = 60
+  end if RUBY_PLATFORM == 'java'
 end
 
 Capybara.app = lambda { |env| [200, {}, ["OK"]] }

data/spec/spinach/spinach_spec.rb

@@ -0,0 +1,53 @@
+require "spec_helper"
+
+describe "Using Capybara::Screenshot with Spinach" do
+  include Aruba::Api
+  include CommonSetup
+
+  before do
+    clean_current_dir
+  end
+
+  def run_failing_case(failure_message, code)
+    write_file('steps/failure.rb', <<-RUBY)
+      #{ensure_load_paths_valid}
+      require 'spinach/support/spinach_failure.rb'
+      #{setup_test_app}
+    RUBY
+
+    write_file('spinach.feature', code)
+    cmd = 'bundle exec spinach -f .'
+    run_simple cmd, false
+    expect(output_from(cmd)).to match failure_message
+  end
+
+  it "saves a screenshot on failure" do
+    run_failing_case(%q{Unable to find link or button "you'll never find me"}, <<-GHERKIN)
+      Feature: Failure
+        Scenario: Failure
+          Given I visit "/"
+          And I click on a missing link
+    GHERKIN
+    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}, <<-GHERKIN)
+      Feature: Failure
+        Scenario: Failure
+          Given I visit "/"
+          And I trigger an unhandled exception
+    GHERKIN
+    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"}, <<-GHERKIN)
+      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
+    GHERKIN
+    check_file_content('tmp/my_screenshot.html', 'This is a different page', true)
+  end
+end

data/spec/spinach/support/spinach_failure.rb

@@ -0,0 +1,41 @@
+require 'capybara'
+require 'capybara/rspec'
+require 'capybara-screenshot'
+require 'capybara-screenshot/spinach'
+require 'spinach/capybara'
+require 'support/test_app'
+
+Spinach.config.failure_exceptions = [Capybara::ElementNotFound]
+
+class Spinach::Features::Failure < Spinach::FeatureSteps
+  include ::Capybara::DSL
+
+  before do
+    ::Capybara::Screenshot.register_filename_prefix_formatter(:spinach) do |failed_step|
+      raise 'expected failing step' if !@expected_failed_step.nil? && !failed_step.name.include?(@expected_failed_step)
+      'my_screenshot'
+    end
+  end
+
+  step 'I visit "/"' do
+    visit '/'
+  end
+
+  step 'I click on a missing link' do
+    @expected_failed_step = 'I click on a missing link'
+    click_on "you'll never find me"
+  end
+
+  step 'I trigger an unhandled exception' do
+    @expected_failed_step = "I trigger an unhandled exception"
+    raise "you can't handle me"
+  end
+
+  step 'I click on a missing link on a different page in a different session' do
+    using_session :different_session do
+      visit '/different_page'
+      @expected_failed_step = 'I click on a missing link on a different page in a different session'
+      click_on "you'll never find me"
+    end
+  end
+end

data/spec/support/common_setup.rb

@@ -0,0 +1,28 @@
+module CommonSetup
+  def self.included(target)
+    target.let(:gem_root) { File.expand_path('../..', File.dirname(__FILE__)) }
+
+    target.let(:ensure_load_paths_valid) do
+      <<-RUBY
+        %w(lib spec).each do |include_folder|
+          $LOAD_PATH.unshift(File.join('#{gem_root}', include_folder))
+        end
+      RUBY
+    end
+
+    target.let(:setup_test_app) do
+      <<-RUBY
+        require 'support/test_app'
+        Capybara.save_and_open_page_path = 'tmp'
+        Capybara.app = TestApp
+        Capybara::Screenshot.append_timestamp = false
+      RUBY
+    end
+
+    target.before do
+      if ENV['BUNDLE_GEMFILE'] && ENV['BUNDLE_GEMFILE'].match(/^\./)
+        ENV['BUNDLE_GEMFILE'] = File.expand_path(ENV['BUNDLE_GEMFILE'].gsub(/^\./, gem_root))
+      end
+    end
+  end
+end