leifcr-capybara-screenshot 1.0.14

data/spec/rspec/rspec_spec.rb

@@ -0,0 +1,158 @@
+require 'spec_helper'
+
+describe Capybara::Screenshot::RSpec, :type => :aruba do
+  describe "used with RSpec" do
+    include CommonSetup
+
+    before do
+      Capybara::Screenshot.capybara_tmp_path = expand_path('tmp')
+    end
+
+    def run_failing_case(code, error_message, format=nil)
+      run_case code, format: format
+      if error_message.kind_of?(Regexp)
+        expect(last_command_started.output).to match(error_message)
+      else
+        expect(last_command_started.output).to include(error_message)
+      end
+    end
+
+    def run_case(code, options = {})
+      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 = cmd_with_format(options[:format])
+      run_simple_with_retry cmd, false
+
+      expect(last_command_started.output).to match('0 failures') if options[:assert_all_passed]
+    end
+
+    def cmd_with_format(format)
+      "rspec #{"--format #{format} " if format}#{expand_path('spec/test_failure.rb')}"
+    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
+      expect(expand_path('tmp/screenshot.html')).to_not have_file_content('This is the root page')
+    end
+
+    formatters = {
+      progress:      'HTML screenshot:',
+      documentation: 'HTML screenshot:',
+      html:          %r{<a href="file://\./tmp/screenshot\.html"[^>]*>HTML page</a>},
+      json:          '"screenshot":{"'
+    }
+
+    # Textmate formatter is only included in RSpec 2
+    if RSpec::Core::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
+        expect('tmp/screenshot.html').to have_file_content('This is the root page')
+      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
+      expect('tmp/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, %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
+      expect('tmp/screenshot.html').to have_file_content(/is/)
+    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 <<-RUBY, 'HTML screenshot:', :progress
+          feature 'screenshot with failure' do
+            scenario 'click on a missing link' do
+              visit '/'
+              click_on "you'll never find me"
+            end
+          end
+        RUBY
+        assert_screenshot_pruned
+      end
+
+      it 'on success it never prunes' do
+        run_case <<-CUCUMBER, assert_all_passed: true
+          feature 'screenshot without failure' do
+            scenario 'click on a link' do
+              visit '/'
+            end
+          end
+        CUCUMBER
+        assert_screenshot_not_pruned
+      end
+    end
+
+    context 'no pruning by default' do
+      before do
+        create_screenshot_for_pruning
+      end
+
+      it 'on failure it leaves existing screenshots' do
+        run_failing_case <<-RUBY, 'HTML screenshot:', :progress
+          feature 'screenshot with failure' do
+            scenario 'click on a missing link' do
+              visit '/'
+              click_on "you'll never find me"
+            end
+          end
+        RUBY
+        assert_screenshot_not_pruned
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper.rb"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+$: << '../lib'
+require 'rspec'
+require 'capybara-screenshot'
+require 'capybara-screenshot/rspec'
+require 'timecop'
+
+RSpec.configure do |config|
+  if RSpec::Core::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"]] }
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+if RUBY_VERSION < '1.9.3'
+  ::Dir.glob(::File.expand_path('../support/*.rb', __FILE__)).each { |f| require File.join(File.dirname(f), File.basename(f, '.rb')) }
+  ::Dir.glob(::File.expand_path('../support/**/*.rb', __FILE__)).each { |f| require File.join(File.dirname(f), File.basename(f, '.rb')) }
+else
+  ::Dir.glob(::File.expand_path('../support/*.rb', __FILE__)).each { |f| require_relative f }
+  ::Dir.glob(::File.expand_path('../support/**/*.rb', __FILE__)).each { |f| require_relative f }
+end

data/spec/spinach/spinach_spec.rb

@@ -0,0 +1,60 @@
+require "spec_helper"
+
+describe "Using Capybara::Screenshot with Spinach" do
+  include CommonSetup
+
+  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_with_retry cmd, false
+    expect(last_command_started.output).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
+    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}, <<-GHERKIN)
+      Feature: Failure
+        Scenario: Failure
+          Given I visit "/"
+          And I trigger an unhandled exception
+    GHERKIN
+    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"}, <<-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
+    expect('tmp/my_screenshot.html').to have_file_content('This is a different page')
+  end
+
+  it 'on failure it prunes previous screenshots when strategy is set' do
+    create_screenshot_for_pruning
+    configure_prune_strategy :last_run
+    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
+    assert_screenshot_pruned
+  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/aruba.rb

@@ -0,0 +1,2 @@
+require 'aruba/rspec'
+require 'aruba/config/jruby'

data/spec/support/common_setup.rb

@@ -0,0 +1,67 @@
+module CommonSetup
+  def self.included(target)
+    target.class_eval do
+      include Aruba::Api
+    end
+
+    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(:screenshot_path) { 'tmp' }
+    target.let(:screenshot_for_pruning_path) { "#{screenshot_path}/old_screenshot.html" }
+
+    target.let(:setup_test_app) do
+      <<-RUBY
+        require 'support/test_app'
+        Capybara::Screenshot.capybara_tmp_path = '#{screenshot_path}'
+        Capybara.app = TestApp
+        Capybara::Screenshot.append_timestamp = false
+        #{@additional_setup_steps}
+      RUBY
+    end
+
+    target.before do
+      if ENV['BUNDLE_GEMFILE'] && ENV['BUNDLE_GEMFILE'].match(/^\.|^[^\/\.]/)
+        ENV['BUNDLE_GEMFILE'] = File.join(gem_root, ENV['BUNDLE_GEMFILE'])
+      end
+    end
+
+    target.after(:each) do |example|
+      if example.exception
+        puts "Output from failed Aruba test:"
+        puts all_output.split(/\n/).map { |line| "   #{line}"}
+        puts ""
+      end
+    end
+
+    def run_simple_with_retry(*args)
+      run_simple(*args)
+    rescue ChildProcess::TimeoutError => e
+      puts "run_simple(#{args.join(', ')}) failed. Will retry once. `#{e.message}`"
+      run_simple(*args)
+    end
+
+    def configure_prune_strategy(strategy)
+       @additional_setup_steps = "Capybara::Screenshot.prune_strategy = :keep_last_run"
+    end
+
+    def create_screenshot_for_pruning
+      write_file screenshot_for_pruning_path, '<html></html>'
+    end
+
+    def assert_screenshot_pruned
+      expect(screenshot_for_pruning_path).to_not be_an_existing_file
+    end
+
+    def assert_screenshot_not_pruned
+      expect(screenshot_for_pruning_path).to be_an_existing_file
+    end
+  end
+end

data/spec/support/html_reporter_context.rb

@@ -0,0 +1,28 @@
+shared_context 'html reporter' do
+  def set_example(example)
+    @reporter.instance_variable_set :@failed_examples, [example]
+  end
+
+  before do
+    # Mocking `RSpec::Core::Formatters::HtmlFormatter`, but only implementing the things that
+    # are actually used in `HtmlLinkReporter#extra_failure_content_with_screenshot`.
+    @reporter_class = Class.new do
+      def extra_failure_content(exception)
+        "original content"
+      end
+    end
+
+    @reporter = @reporter_class.new
+    @reporter.singleton_class.send :include, described_class
+  end
+
+  context 'when there is no screenshot' do
+    before do
+      set_example double("example", metadata: {})
+    end
+
+    it 'doesnt change the original content of the reporter' do
+      expect(@reporter.extra_failure_content(nil)).to eql("original content")
+    end
+  end
+end

data/spec/support/test_app.rb

@@ -0,0 +1,13 @@
+require 'sinatra/base'
+
+Sinatra::Application.root = '.'
+
+class TestApp < Sinatra::Base
+  get '/' do
+    'This is the root page'
+  end
+
+  get '/different_page' do
+    'This is a different page'
+  end
+end

data/spec/unit/base_reporter_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Capybara::Screenshot::RSpec::BaseReporter do
+  describe '#enhance_with_screenshot' do
+    it 'makes the original method available under an alias and replaces it with the enhanced method' do
+      reporter_module = Module.new do
+        extend Capybara::Screenshot::RSpec::BaseReporter
+        enhance_with_screenshot :foo
+        def foo_with_screenshot
+          [foo_without_screenshot, :enhanced]
+        end
+      end
+
+      klass = Class.new do
+        def foo
+          :original
+        end
+      end
+
+      expect(klass.new.foo).to eql(:original)
+      klass.send :include, reporter_module
+      expect(klass.new.foo).to eql([:original, :enhanced])
+    end
+  end
+end

data/spec/unit/capybara-screenshot_rspec_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe Capybara::Screenshot::RSpec do
+  describe '.after_failed_example' do
+    context 'for a failed example in a feature that can be snapshotted' do
+      before do
+        allow(Capybara.page).to receive(:current_url).and_return("http://test.local")
+        allow(Capybara::Screenshot::Saver).to receive(:new).and_return(mock_saver)
+      end
+      let(:example_group) { Module.new.send(:include, Capybara::DSL) }
+      let(:example) { double("example", exception: Exception.new, example_group: example_group, metadata: {}) }
+      let(:mock_saver) do
+        Capybara::Screenshot::Saver.new(Capybara, Capybara.page).tap do |saver|
+          allow(saver).to receive(:save)
+        end
+      end
+
+      it 'instantiates a saver and calls `save` on it' do
+        expect(mock_saver).to receive(:save)
+        described_class.after_failed_example(example)
+      end
+
+      it 'extends the metadata with an empty hash for screenshot metadata' do
+        described_class.after_failed_example(example)
+        expect(example.metadata).to have_key(:screenshot)
+        expect(example.metadata[:screenshot]).to eql({})
+      end
+
+      context 'when a html file gets saved' do
+        before { allow(mock_saver).to receive(:html_saved?).and_return(true) }
+
+        it 'adds the html file path to the screenshot metadata' do
+          described_class.after_failed_example(example)
+          expect(example.metadata[:screenshot][:html]).to match("./screenshot")
+        end
+      end
+
+      context 'when an image gets saved' do
+        before { allow(mock_saver).to receive(:screenshot_saved?).and_return(true) }
+
+        it 'adds the image path to the screenshot metadata' do
+          described_class.after_failed_example(example)
+          expect(example.metadata[:screenshot][:image]).to match("./screenshot")
+        end
+      end
+    end
+  end
+end