RubyGems - capybara-screenshot-nocolor - Versions diffs - 1.0.5 - Mend

capybara-screenshot-nocolor 1.0.5

Files changed (57) hide show

checksums.yaml +7 -0
data/.gitignore +7 -0
data/.rspec +2 -0
data/.travis.yml +17 -0
data/Appraisals +31 -0
data/CHANGELOG.md +198 -0
data/Gemfile +7 -0
data/LICENSE +19 -0
data/README.md +240 -0
data/Rakefile +40 -0
data/capybara-screenshot.gemspec +38 -0
data/gemfiles/cucumber.1.2.gemfile +9 -0
data/gemfiles/cucumber.1.3.0.gemfile +9 -0
data/gemfiles/latest.gemfile +8 -0
data/gemfiles/rspec.2.14.gemfile +9 -0
data/gemfiles/rspec.2.99.gemfile +9 -0
data/gemfiles/rspec.3.0.gemfile +9 -0
data/gemfiles/spinach.0.7.gemfile +9 -0
data/gemfiles/spinach.0.8.0.gemfile +9 -0
data/lib/capybara-screenshot.rb +157 -0
data/lib/capybara-screenshot/capybara.rb +28 -0
data/lib/capybara-screenshot/cucumber.rb +27 -0
data/lib/capybara-screenshot/minitest.rb +27 -0
data/lib/capybara-screenshot/pruner.rb +47 -0
data/lib/capybara-screenshot/rspec.rb +92 -0
data/lib/capybara-screenshot/rspec/base_reporter.rb +21 -0
data/lib/capybara-screenshot/rspec/html_embed_reporter.rb +25 -0
data/lib/capybara-screenshot/rspec/html_link_reporter.rb +37 -0
data/lib/capybara-screenshot/rspec/text_reporter.rb +38 -0
data/lib/capybara-screenshot/rspec/textmate_link_reporter.rb +19 -0
data/lib/capybara-screenshot/saver.rb +87 -0
data/lib/capybara-screenshot/spinach.rb +26 -0
data/lib/capybara-screenshot/testunit.rb +39 -0
data/lib/capybara-screenshot/version.rb +5 -0
data/spec/cucumber/cucumber_spec.rb +93 -0
data/spec/cucumber/step_definitions/step_definitions.rb +18 -0
data/spec/cucumber/support/env.rb +17 -0
data/spec/feature/minitest_spec.rb +110 -0
data/spec/feature/testunit_spec.rb +81 -0
data/spec/rspec/rspec_spec.rb +159 -0
data/spec/spec_helper.rb +29 -0
data/spec/spinach/spinach_spec.rb +64 -0
data/spec/spinach/support/spinach_failure.rb +41 -0
data/spec/support/common_setup.rb +59 -0
data/spec/support/html_reporter_context.rb +28 -0
data/spec/support/test_app.rb +13 -0
data/spec/unit/base_reporter_spec.rb +25 -0
data/spec/unit/capybara-screenshot_rspec_spec.rb +48 -0
data/spec/unit/capybara-screenshot_spec.rb +88 -0
data/spec/unit/capybara_spec.rb +50 -0
data/spec/unit/pruner_spec.rb +108 -0
data/spec/unit/rspec_reporters/html_embed_reporter_spec.rb +18 -0
data/spec/unit/rspec_reporters/html_link_reporter_spec.rb +27 -0
data/spec/unit/rspec_reporters/text_reporter_spec.rb +97 -0
data/spec/unit/rspec_reporters/textmate_link_reporter_spec.rb +39 -0
data/spec/unit/saver_spec.rb +282 -0
metadata +247 -0

data/spec/spinach/support/spinach_failure.rb ADDED

@@ -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 ADDED

@@ -0,0 +1,59 @@
+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.save_and_open_page_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
+    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
+      check_file_presence Array(screenshot_for_pruning_path), false
+    end
+    def assert_screenshot_not_pruned
+      check_file_presence Array(screenshot_for_pruning_path), true
+    end
+  end
+end

data/spec/support/html_reporter_context.rb ADDED

@@ -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 ADDED

@@ -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 ADDED

@@ -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 ADDED

@@ -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.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

data/spec/unit/capybara-screenshot_spec.rb ADDED

@@ -0,0 +1,88 @@
+require 'spec_helper'
+describe Capybara::Screenshot do
+  describe '.register_driver' do
+    before(:all) do
+      @original_drivers = Capybara::Screenshot.registered_drivers.dup
+    end
+    after(:all) do
+      Capybara::Screenshot.registered_drivers = @original_drivers
+    end
+    it 'stores driver with block' do
+      block = lambda {}
+      Capybara::Screenshot.register_driver :foo, &block
+      expect(Capybara::Screenshot.registered_drivers[:foo]).to eql(block)
+    end
+  end
+  describe '.register_filename_prefix_formatter' do
+    before(:all) do
+      @original_formatters = Capybara::Screenshot.filename_prefix_formatters.dup
+    end
+    after(:all) do
+      Capybara::Screenshot.filename_prefix_formatters = @original_formatters
+    end
+    it 'stores test type with block' do
+      block = lambda { |arg| }
+      Capybara::Screenshot.register_filename_prefix_formatter :foo, &block
+      expect(Capybara::Screenshot.filename_prefix_formatters[:foo]).to eql(block)
+    end
+  end
+  describe '.filename_prefix_for' do
+    it 'returns "screenshot" for undefined formatter' do
+      expect(Capybara::Screenshot.filename_prefix_for(:foo, double('test'))).to eql('screenshot')
+    end
+  end
+  describe '.append_screenshot_path' do
+    it 'prints a deprecation message and delegates to RSpec.add_link_to_screenshot_for_failed_examples' do
+      begin
+        original_stderr = $stderr
+        $stderr = StringIO.new
+        expect {
+          Capybara::Screenshot.append_screenshot_path = false
+        }.to change {
+          Capybara::Screenshot::RSpec.add_link_to_screenshot_for_failed_examples
+        }.from(true).to(false)
+        expect($stderr.string).to include("append_screenshot_path is deprecated")
+      ensure
+        $stderr = original_stderr
+      end
+    end
+  end
+  describe '#prune' do
+    before do
+      Capybara::Screenshot.reset_prune_history
+    end
+    it 'prunes once by default' do
+      expect(Capybara::Screenshot::Pruner).to receive(:new).and_call_original.once
+      3.times { Capybara::Screenshot.prune }
+    end
+    it 'prunes every time if option force: true' do
+      expect(Capybara::Screenshot::Pruner).to receive(:new).and_call_original.exactly(3).times
+      3.times { Capybara::Screenshot.prune(force: true) }
+    end
+    context 'prune strategy' do
+      let(:prune_strategy) { { keep: 100 } }
+      before do
+        Capybara::Screenshot.prune_strategy = prune_strategy
+      end
+      it 'is passed to initializer' do
+        expect(Capybara::Screenshot::Pruner).to receive(:new).with(prune_strategy).and_call_original
+        Capybara::Screenshot.prune
+      end
+    end
+  end
+end

data/spec/unit/capybara_spec.rb ADDED

@@ -0,0 +1,50 @@
+require 'capybara-screenshot'
+require 'capybara/dsl'
+describe Capybara do
+  it 'adds screen shot methods to the Capybara module' do
+    expect(::Capybara).to respond_to(:screenshot_and_save_page)
+    expect(::Capybara).to respond_to(:screenshot_and_open_image)
+  end
+  context 'request type example', :type => :request do
+    it 'has access to screen shot instance methods' do
+      expect(subject).to respond_to(:screenshot_and_save_page)
+      expect(subject).to respond_to(:screenshot_and_open_image)
+    end
+  end
+  describe 'using_session' do
+    include Capybara::DSL
+    it 'saves the name of the final session' do
+      expect(Capybara::Screenshot).to receive(:final_session_name=).with(:different_session)
+      expect {
+        using_session :different_session do
+          expect(0).to eq 1
+        end
+      }.to raise_exception ::RSpec::Expectations::ExpectationNotMetError
+    end
+  end
+end
+describe 'final_session_name' do
+  subject { Capybara::Screenshot.clone }
+  describe 'when the final session name has been set' do
+    before do
+      subject.final_session_name = 'my-failing-session'
+    end
+    it 'returns the name' do
+      expect(subject.final_session_name).to eq 'my-failing-session'
+    end
+  end
+  describe 'when the final session name has not been set' do
+    it 'returns the current session name' do
+      allow(Capybara).to receive(:session_name).and_return('my-current-session')
+      expect(subject.final_session_name).to eq 'my-current-session'
+    end
+  end
+end

data/spec/unit/pruner_spec.rb ADDED

@@ -0,0 +1,108 @@
+require 'spec_helper'
+describe Capybara::Screenshot::Pruner do
+  describe '#initialize' do
+    let(:pruner) { Capybara::Screenshot::Pruner.new(strategy) }
+    context 'accepts generic strategies:' do
+      [:keep_all, :keep_last_run].each do |strategy_sym|
+        let(:strategy) { strategy_sym }
+        it ":#{strategy_sym}" do
+          expect(pruner.strategy).to eq(strategy)
+        end
+      end
+    end
+    context 'keep:int' do
+      let(:strategy) { { keep: 50 } }
+      it 'is a suitable strategy' do
+        expect(pruner.strategy).to eq(strategy)
+      end
+    end
+    context 'invalid strategy' do
+      context 'symbol' do
+        let(:strategy) { :invalid_strategy }
+        it 'raises an error' do
+          expect { pruner }.to raise_error
+        end
+      end
+      context 'keep:sym' do
+        let(:strategy) { { keep: :symbol } }
+        it 'raises an error' do
+          expect { pruner }.to raise_error
+        end
+      end
+    end
+  end
+  describe '#prune_old_screenshots' do
+    let(:capybara_root)   { Capybara::Screenshot.capybara_root }
+    let(:remaining_files) { Dir.glob(File.expand_path('*', capybara_root)).sort }
+    let(:files_created)   { [] }
+    let(:files_count)     { 8 }
+    let(:pruner)         { Capybara::Screenshot::Pruner.new(strategy) }
+    before do
+      allow(Capybara::Screenshot).to receive(:capybara_root).and_return(Dir.mktmpdir.to_s)
+      files_count.times do |i|
+        files_created << FileUtils.touch("#{capybara_root}/#{i}").first.tap do |file_name|
+          File.utime(Time.now, Time.now - files_count + i, file_name)
+        end
+      end
+      pruner.prune_old_screenshots
+    end
+    after do
+      FileUtils.rm_rf capybara_root
+    end
+    context 'with :keep_all strategy' do
+      let(:strategy) { :keep_all }
+      it 'should not remove screens' do
+        expect(remaining_files).to eq(files_created)
+      end
+    end
+    context 'with :keep_last_run strategy' do
+      let(:strategy) { :keep_last_run }
+      it 'should remove all screens' do
+        expect(remaining_files).to be_empty
+      end
+      context 'when dir is missing' do
+        before { FileUtils.rm_rf(Capybara::Screenshot.capybara_root) }
+        it 'should not raise error' do
+          expect { pruner.prune_old_screenshots }.to_not raise_error
+        end
+      end
+    end
+    context 'with :keep strategy' do
+      let(:keep_count) { 3 }
+      let(:strategy) { { keep: keep_count } }
+      it 'should keep specified number of screens' do
+        expect(remaining_files).to eq(files_created.last(keep_count))
+      end
+      context 'when dir is missing' do
+        before { FileUtils.rm_rf(Capybara::Screenshot.capybara_root) }
+        it 'should not raise error when dir is missing' do
+          expect { pruner.prune_old_screenshots }.to_not raise_error
+        end
+      end
+    end
+  end
+end