capybara-screenshot 1.0.13 → 1.0.26

data/spec/rspec/rspec_spec.rb

@@ -5,8 +5,7 @@ describe Capybara::Screenshot::RSpec, :type => :aruba do
     include CommonSetup
 
     before do
-      setup_aruba
-      Capybara.save_and_open_page_path = expand_path('tmp')
+      Capybara::Screenshot.capybara_tmp_path = expand_path('tmp')
     end
 
     def run_failing_case(code, error_message, format=nil)
@@ -32,7 +31,7 @@ describe Capybara::Screenshot::RSpec, :type => :aruba do
       RUBY
 
       cmd = cmd_with_format(options[:format])
-      run_simple_with_retry cmd, false
+      run_simple_with_retry cmd
 
       expect(last_command_started.output).to match('0 failures') if options[:assert_all_passed]
     end
@@ -41,8 +40,8 @@ describe Capybara::Screenshot::RSpec, :type => :aruba do
       "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"}
+    it 'saves a screenshot when browser action fails' do
+      run_failing_case <<-RUBY, %r{Unable to find (visible )?link or button "you'll never find me"}
         feature 'screenshot with failure' do
           scenario 'click on a missing link' do
             visit '/'
@@ -51,7 +50,19 @@ describe Capybara::Screenshot::RSpec, :type => :aruba do
           end
         end
       RUBY
-      expect(expand_path('tmp/screenshot.html')).to_not have_file_content('This is the root page')
+      expect('tmp/screenshot.html').to have_file_content('This is the root page')
+    end
+
+    it 'saves a screenshot when expectation fails when using :aggregate_failures' do
+      run_failing_case <<-RUBY, %q{expected "This is the root page" to include "you'll never find me"}
+        feature 'screenshot with failure', :aggregate_failures do
+          scenario 'expect a missing link' do
+            visit '/'
+            expect(page.body).to include("you'll never find me")
+          end
+        end
+      RUBY
+      expect('tmp/screenshot.html').to have_file_content('This is the root page')
     end
 
     formatters = {
@@ -92,7 +103,7 @@ describe Capybara::Screenshot::RSpec, :type => :aruba do
     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"}
+      run_failing_case <<-RUBY, %r{Unable to find (visible )?link or button "you'll never find me"}
         feature 'screenshot with failure' do
           scenario 'click on a missing link' do
             visit '/'
@@ -105,7 +116,24 @@ describe Capybara::Screenshot::RSpec, :type => :aruba do
           end
         end
       RUBY
-      expect('tmp/screenshot.html').to have_file_content(/is/)
+      expect('tmp/screenshot.html').to have_file_content(/This is a different page/)
+    end
+
+    it 'saves a screenshot for the correct session for failures Capybara.using_session' do
+      run_failing_case <<-RUBY, %r{Unable to find (visible )?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')
+            Capybara.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(/This is a different page/)
     end
 
     context 'pruning' do

data/spec/spinach/spinach_spec.rb

@@ -3,10 +3,6 @@ require "spec_helper"
 describe "Using Capybara::Screenshot with Spinach" do
   include CommonSetup
 
-  before do
-    setup_aruba
-  end
-
   def run_failing_case(failure_message, code)
     write_file('steps/failure.rb', <<-RUBY)
       #{ensure_load_paths_valid}
@@ -16,12 +12,12 @@ describe "Using Capybara::Screenshot with Spinach" do
 
     write_file('spinach.feature', code)
     cmd = 'bundle exec spinach -f .'
-    run_simple_with_retry cmd, false
+    run_simple_with_retry cmd
     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)
+    run_failing_case(%q{Unable to find (visible )?link or button "you'll never find me"}, <<-GHERKIN)
       Feature: Failure
         Scenario: Failure
           Given I visit "/"
@@ -41,7 +37,7 @@ describe "Using Capybara::Screenshot with Spinach" do
   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)
+    run_failing_case(%q{Unable to find (visible )?link or button "you'll never find me"}, <<-GHERKIN)
       Feature: Failure
         Scenario: Failure in different session
           Given I visit "/"
@@ -53,7 +49,7 @@ describe "Using Capybara::Screenshot with Spinach" do
   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)
+    run_failing_case(%q{Unable to find (visible )?link or button "you'll never find me"}, <<-GHERKIN)
       Feature: Failure
         Scenario: Failure
           Given I visit "/"

data/spec/support/aruba.rb

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

data/spec/support/common_setup.rb

@@ -20,7 +20,7 @@ module CommonSetup
     target.let(:setup_test_app) do
       <<-RUBY
         require 'support/test_app'
-        Capybara.save_and_open_page_path = '#{screenshot_path}'
+        Capybara::Screenshot.capybara_tmp_path = '#{screenshot_path}'
         Capybara.app = TestApp
         Capybara::Screenshot.append_timestamp = false
         #{@additional_setup_steps}
@@ -33,11 +33,19 @@ module CommonSetup
       end
     end
 
-    def run_simple_with_retry(*args)
-      run_simple(*args)
+    target.after(:each) do |example|
+      if example.exception
+        puts "Output from failed Aruba test:"
+        puts all_commands.map { |c| c.output }.map { |line| "   #{line}"}
+        puts ""
+      end
+    end
+
+    def run_simple_with_retry(cmd, fail_on_error: false)
+      run_command_and_stop(cmd, fail_on_error: fail_on_error)
     rescue ChildProcess::TimeoutError => e
-      puts "run_simple(#{args.join(', ')}) failed. Will retry once. `#{e.message}`"
-      run_simple(*args)
+      puts "run_command_and_stop(#{cmd}, fail_on_error: #{fail_on_error}) failed. Will retry once. `#{e.message}`"
+      run_command_and_stop(cmd, fail_on_error: fail_on_error)
     end
 
     def configure_prune_strategy(strategy)

data/spec/unit/capybara-screenshot_spec.rb

@@ -81,11 +81,12 @@ describe Capybara::Screenshot do
       args = double('args')
       s3_saver_double = double('s3_saver')
       s3_configuration = { hello: 'world' }
+      s3_object_configuration = {}
 
       Capybara::Screenshot.s3_configuration = s3_configuration
 
       expect(Capybara::Screenshot::Saver).to receive(:new).with(args).and_return(saver_double)
-      expect(Capybara::Screenshot::S3Saver).to receive(:new_with_configuration).with(saver_double, s3_configuration).and_return(s3_saver_double)
+      expect(Capybara::Screenshot::S3Saver).to receive(:new_with_configuration).with(saver_double, s3_configuration, s3_object_configuration).and_return(s3_saver_double)
 
       expect(Capybara::Screenshot.new_saver(args)).to eq(s3_saver_double)
     end

data/spec/unit/capybara_spec.rb

@@ -26,6 +26,19 @@ describe Capybara do
       }.to raise_exception ::RSpec::Expectations::ExpectationNotMetError
     end
   end
+
+  describe 'Capybara.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 {
+        Capybara.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

data/spec/unit/pruner_spec.rb

@@ -27,7 +27,7 @@ describe Capybara::Screenshot::Pruner do
         let(:strategy) { :invalid_strategy }
 
         it 'raises an error' do
-          expect { pruner }.to raise_error
+          expect { pruner }.to raise_error(/Invalid prune strategy/)
         end
       end
 
@@ -35,7 +35,7 @@ describe Capybara::Screenshot::Pruner do
         let(:strategy) { { keep: :symbol } }
 
         it 'raises an error' do
-          expect { pruner }.to raise_error
+          expect { pruner }.to raise_error(/must be a Integer/)
         end
       end
     end

data/spec/unit/rspec_reporters/html_embed_reporter_spec.rb

@@ -15,4 +15,17 @@ describe Capybara::Screenshot::RSpec::HtmlEmbedReporter do
       expect(content_without_styles).to eql("original content<img src='data:image/png;base64,#{encoded_image_data}'>")
     end
   end
+
+  context 'when an image was saved to s3' do
+    let(:s3_image_url) { "http://s3.amazon.com/path/to/image" }
+
+    before do
+      set_example double("example", metadata: {screenshot: {image: s3_image_url}})
+    end
+
+    it 'embeds the image URL into the content' do
+      content_without_styles = @reporter.extra_failure_content(nil).gsub(/ ?style='.*?' ?/, "")
+      expect(content_without_styles).to eql("original content<img src='#{s3_image_url}'>")
+    end
+  end
 end

data/spec/unit/rspec_reporters/text_reporter_spec.rb

@@ -64,20 +64,20 @@ describe Capybara::Screenshot::RSpec::TextReporter do
   end
 
   context 'when a html file was saved' do
-    let(:example) { example_failed_method_argument_double(screenshot: { html: "path/to/html" }) }
+    let(:example) { example_failed_method_argument_double(screenshot: { html: "/path/to/html" }) }
 
     it 'appends the html file path to the original output' do
       @reporter.send(example_failed_method, example)
-      expect(@reporter.output.string).to eql("original failure info\n  #{CapybaraScreenshot::Helpers.yellow("HTML screenshot: file://path/to/html")}\n")
+      expect(@reporter.output.string).to eql("original failure info\n  #{CapybaraScreenshot::Helpers.yellow("HTML screenshot: /path/to/html")}\n")
     end
   end
 
   context 'when a html file and an image were saved' do
-    let(:example) { example_failed_method_argument_double(screenshot: { html: "path/to/html", image: "path/to/image" }) }
+    let(:example) { example_failed_method_argument_double(screenshot: { html: "/path/to/html", image: "/path/to/image" }) }
 
     it 'appends the image path to the original output' do
       @reporter.send(example_failed_method, example)
-      expect(@reporter.output.string).to eql("original failure info\n  #{CapybaraScreenshot::Helpers.yellow("HTML screenshot: file://path/to/html")}\n  #{CapybaraScreenshot::Helpers.yellow("Image screenshot: file://path/to/image")}\n")
+      expect(@reporter.output.string).to eql("original failure info\n  #{CapybaraScreenshot::Helpers.yellow("HTML screenshot: /path/to/html")}\n  #{CapybaraScreenshot::Helpers.yellow("Image screenshot: /path/to/image")}\n")
     end
   end
 
@@ -91,8 +91,8 @@ describe Capybara::Screenshot::RSpec::TextReporter do
     end
     old_reporter = old_reporter_class.new
     old_reporter.singleton_class.send :include, described_class
-    example = example_failed_method_argument_double(screenshot: { html: "path/to/html" })
+    example = example_failed_method_argument_double(screenshot: { html: "/path/to/html" })
     old_reporter.send(example_failed_method, example)
-    expect(old_reporter.output.string).to eql("original failure info\n  #{CapybaraScreenshot::Helpers.yellow("HTML screenshot: file://path/to/html")}\n")
+    expect(old_reporter.output.string).to eql("original failure info\n  #{CapybaraScreenshot::Helpers.yellow("HTML screenshot: /path/to/html")}\n")
   end
 end

data/spec/unit/s3_saver_spec.rb

@@ -4,9 +4,19 @@ require 'capybara-screenshot/s3_saver'
 describe Capybara::Screenshot::S3Saver do
   let(:saver) { double('saver') }
   let(:bucket_name) { double('bucket_name') }
+  let(:s3_object_configuration) { {} }
+  let(:options) { {} }
   let(:s3_client) { double('s3_client') }
+  let(:key_prefix){ "some/path/" }
 
-  let(:s3_saver) { Capybara::Screenshot::S3Saver.new(saver, s3_client, bucket_name) }
+  let(:s3_saver) { described_class.new(saver, s3_client, bucket_name, s3_object_configuration, options) }
+  let(:s3_saver_with_key_prefix) { described_class.new(saver, s3_client, bucket_name, s3_object_configuration, key_prefix: key_prefix) }
+
+  let(:region) { double('region') }
+
+  before do
+    allow(s3_client).to receive(:get_bucket_location).and_return(double(:bucket_location_response, location_constraint: region))
+  end
 
   describe '.new_with_configuration' do
     let(:access_key_id) { double('access_key_id') }
@@ -18,40 +28,73 @@ describe Capybara::Screenshot::S3Saver do
       }
     }
 
-    let(:region) { double('region') }
     let(:s3_client_credentials) {
       s3_client_credentials_using_defaults.merge(region: region)
     }
 
-    it 'destructures the configuration into its components' do
+    before do
       allow(Aws::S3::Client).to receive(:new).and_return(s3_client)
-      allow(Capybara::Screenshot::S3Saver).to receive(:new)
+      allow(described_class).to receive(:new)
+    end
 
-      Capybara::Screenshot::S3Saver.new_with_configuration(saver, {
+    it 'destructures the configuration into its components' do
+      described_class.new_with_configuration(saver, {
         s3_client_credentials: s3_client_credentials,
         bucket_name: bucket_name
-      })
+      }, s3_object_configuration)
 
       expect(Aws::S3::Client).to have_received(:new).with(s3_client_credentials)
-      expect(Capybara::Screenshot::S3Saver).to have_received(:new).with(saver, s3_client, bucket_name)
+      expect(described_class).to have_received(:new).with(saver, s3_client, bucket_name, s3_object_configuration, hash_including({}))
+    end
+
+    it 'passes key_prefix option if specified' do
+      described_class.new_with_configuration(saver, {
+        s3_client_credentials: s3_client_credentials,
+        bucket_name: bucket_name,
+        key_prefix: key_prefix,
+      }, s3_object_configuration)
+
+      expect(Aws::S3::Client).to have_received(:new).with(s3_client_credentials)
+      expect(described_class).to have_received(:new).with(saver, s3_client, bucket_name, s3_object_configuration, hash_including(key_prefix: key_prefix))
     end
 
     it 'defaults the region to us-east-1' do
       default_region = 'us-east-1'
 
-      allow(Aws::S3::Client).to receive(:new).and_return(s3_client)
-      allow(Capybara::Screenshot::S3Saver).to receive(:new)
-
-      Capybara::Screenshot::S3Saver.new_with_configuration(saver, {
+      described_class.new_with_configuration(saver, {
           s3_client_credentials: s3_client_credentials_using_defaults,
           bucket_name: bucket_name
-      })
+      }, s3_object_configuration)
 
       expect(Aws::S3::Client).to have_received(:new).with(
         s3_client_credentials.merge(region: default_region)
       )
 
-      expect(Capybara::Screenshot::S3Saver).to have_received(:new).with(saver, s3_client, bucket_name)
+      expect(described_class).to have_received(:new).with(saver, s3_client, bucket_name, s3_object_configuration, hash_including({}))
+    end
+
+    it 'stores the object configuration when passed' do
+      s3_object_configuration = { acl: 'public-read' }
+      Capybara::Screenshot.s3_object_configuration = { acl: 'public-read' }
+
+      described_class.new_with_configuration(saver, {
+        s3_client_credentials: s3_client_credentials,
+        bucket_name: bucket_name
+      }, s3_object_configuration)
+
+      expect(Aws::S3::Client).to have_received(:new).with(s3_client_credentials)
+      expect(described_class).to have_received(:new).with(saver, s3_client, bucket_name, s3_object_configuration, hash_including({}))
+    end
+
+    it 'passes key_prefix option if specified' do
+      described_class.new_with_configuration(saver, {
+        s3_client_credentials: s3_client_credentials,
+        bucket_name: bucket_name,
+        key_prefix: key_prefix,
+      }, s3_object_configuration)
+
+      expect(Aws::S3::Client).to have_received(:new).with(s3_client_credentials)
+      expect(described_class).to have_received(:new).with(saver, s3_client, bucket_name, s3_object_configuration, hash_including(key_prefix: key_prefix))
     end
   end
 
@@ -62,6 +105,20 @@ describe Capybara::Screenshot::S3Saver do
       allow(saver).to receive(:save)
     end
 
+    context 'providing a bucket_host' do
+      let(:options) { { bucket_host: 'some other location' } }
+  
+      it 'does not request the bucket location' do
+        screenshot_path = '/baz/bim.jpg'
+
+        screenshot_file = double('screenshot_file')
+
+        expect(s3_saver).not_to receive(:determine_bucket_host)
+
+        s3_saver.save
+      end
+    end
+
     it 'calls save on the underlying saver' do
       expect(saver).to receive(:save)
 
@@ -83,6 +140,8 @@ describe Capybara::Screenshot::S3Saver do
         body: html_file
       )
 
+      expect(s3_saver).to receive(:determine_bucket_host).and_call_original
+
       s3_saver.save
     end
 
@@ -103,6 +162,129 @@ describe Capybara::Screenshot::S3Saver do
 
       s3_saver.save
     end
+
+    context 'with object configuration' do
+      let(:s3_object_configuration) { { acl: 'public-read' } }
+      let(:s3_saver) { described_class.new(saver, s3_client, bucket_name, s3_object_configuration) }
+
+      it 'uploads the html' do
+        html_path = '/foo/bar.html'
+        expect(saver).to receive(:html_path).and_return(html_path)
+        expect(saver).to receive(:html_saved?).and_return(true)
+
+        html_file = double('html_file')
+
+        expect(File).to receive(:open).with(html_path).and_yield(html_file)
+
+        expect(s3_client).to receive(:put_object).with(
+          bucket: bucket_name,
+          key: 'bar.html',
+          body: html_file,
+          acl: 'public-read'
+        )
+
+        s3_saver.save
+      end
+
+      it 'uploads the screenshot' do
+        screenshot_path = '/baz/bim.jpg'
+        expect(saver).to receive(:screenshot_path).and_return(screenshot_path)
+        expect(saver).to receive(:screenshot_saved?).and_return(true)
+
+        screenshot_file = double('screenshot_file')
+
+        expect(File).to receive(:open).with(screenshot_path).and_yield(screenshot_file)
+
+        expect(s3_client).to receive(:put_object).with(
+          bucket: bucket_name,
+          key: 'bim.jpg',
+          body: screenshot_file,
+          acl: 'public-read'
+        )
+
+        s3_saver.save
+      end
+    end
+
+    context 'with key_prefix specified' do
+      it 'uploads the html with key prefix' do
+        html_path = '/foo/bar.html'
+        expect(saver).to receive(:html_path).and_return(html_path)
+        expect(saver).to receive(:html_saved?).and_return(true)
+
+        html_file = double('html_file')
+
+        expect(File).to receive(:open).with(html_path).and_yield(html_file)
+
+        expect(s3_client).to receive(:put_object).with(
+          bucket: bucket_name,
+          key: 'some/path/bar.html',
+          body: html_file
+        )
+
+        s3_saver_with_key_prefix.save
+      end
+
+      it 'uploads the screenshot with key prefix' do
+        screenshot_path = '/baz/bim.jpg'
+        expect(saver).to receive(:screenshot_path).and_return(screenshot_path)
+        expect(saver).to receive(:screenshot_saved?).and_return(true)
+
+        screenshot_file = double('screenshot_file')
+
+        expect(File).to receive(:open).with(screenshot_path).and_yield(screenshot_file)
+
+        expect(s3_client).to receive(:put_object).with(
+          bucket: bucket_name,
+          key: 'some/path/bim.jpg',
+          body: screenshot_file
+        )
+
+        s3_saver_with_key_prefix.save
+      end
+
+      context 'with object configuration' do
+        let(:s3_object_configuration) { { acl: 'public-read' } }
+
+        it 'uploads the html' do
+          html_path = '/foo/bar.html'
+          expect(saver).to receive(:html_path).and_return(html_path)
+          expect(saver).to receive(:html_saved?).and_return(true)
+
+          html_file = double('html_file')
+
+          expect(File).to receive(:open).with(html_path).and_yield(html_file)
+
+          expect(s3_client).to receive(:put_object).with(
+            bucket: bucket_name,
+            key: 'some/path/bar.html',
+            body: html_file,
+            acl: 'public-read'
+          )
+
+          s3_saver_with_key_prefix.save
+        end
+
+        it 'uploads the screenshot' do
+          screenshot_path = '/baz/bim.jpg'
+          expect(saver).to receive(:screenshot_path).and_return(screenshot_path)
+          expect(saver).to receive(:screenshot_saved?).and_return(true)
+
+          screenshot_file = double('screenshot_file')
+
+          expect(File).to receive(:open).with(screenshot_path).and_yield(screenshot_file)
+
+          expect(s3_client).to receive(:put_object).with(
+            bucket: bucket_name,
+            key: 'some/path/bim.jpg',
+            body: screenshot_file,
+            acl: 'public-read'
+          )
+
+          s3_saver_with_key_prefix.save
+        end
+      end
+    end
   end
 
   # Needed because we cannot depend on Verifying Doubles
@@ -129,4 +311,4 @@ describe Capybara::Screenshot::S3Saver do
       expect(saver).to have_received(:foo_bar).with(*args)
     end
   end
-end
+end