capybara-screenshot 0.3.22 → 1.0.0

data/gemfiles/spinach.0.8.0.gemfile.lock

@@ -0,0 +1,100 @@
+PATH
+  remote: ../
+  specs:
+    capybara-screenshot (1.0.0)
+      capybara (>= 1.0, < 3)
+      colored
+      launchy
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.6)
+    appraisal (1.0.2)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    aruba (0.6.1)
+      childprocess (>= 0.3.6)
+      cucumber (>= 1.1.1)
+      rspec-expectations (>= 2.7.0)
+    builder (3.2.2)
+    capybara (2.4.1)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      xpath (~> 2.0)
+    childprocess (0.5.3)
+      ffi (~> 1.0, >= 1.0.11)
+    colored (1.2)
+    colorize (0.5.8)
+    cucumber (1.3.17)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.12)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.1)
+    diff-lcs (1.2.5)
+    ffi (1.9.3)
+    gherkin (2.12.2)
+      multi_json (~> 1.3)
+    gherkin-ruby (0.2.1)
+    launchy (2.4.2)
+      addressable (~> 2.3)
+    mime-types (2.3)
+    mini_portile (0.6.0)
+    minitest (5.4.1)
+    multi_json (1.10.1)
+    multi_test (0.1.1)
+    nokogiri (1.6.3.1)
+      mini_portile (= 0.6.0)
+    power_assert (0.1.3)
+    rack (1.5.2)
+    rack-protection (1.5.3)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rake (10.3.2)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.0)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.0)
+    sinatra (1.4.5)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
+    spinach (0.8.0)
+      colorize (= 0.5.8)
+      gherkin-ruby (~> 0.2.1)
+    test-unit (3.0.1)
+      power_assert
+    thor (0.19.1)
+    tilt (1.4.1)
+    timecop (0.7.1)
+    xpath (2.0.0)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal
+  aruba
+  capybara-screenshot!
+  cucumber
+  minitest
+  rake
+  rspec
+  sinatra
+  spinach (= 0.8.0)
+  test-unit
+  timecop

data/lib/capybara-screenshot.rb

@@ -6,6 +6,7 @@ module Capybara
       attr_accessor :filename_prefix_formatters
       attr_accessor :append_timestamp
       attr_accessor :webkit_options
+      attr_writer   :final_session_name
     end
 
     self.autosave_on_failure = true
@@ -69,6 +70,10 @@ module Capybara
     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
   end
 end
 

data/lib/capybara-screenshot/capybara.rb

@@ -10,5 +10,17 @@ module Capybara
     def screenshot_and_open_image
       Capybara::Screenshot.screenshot_and_open_image
     end
+
+    def using_session_with_screenshot(name)
+      using_session_without_screenshot(name) do
+        original_session_name = Capybara.session_name
+        Capybara::Screenshot.final_session_name = name
+        yield
+        Capybara::Screenshot.final_session_name = original_session_name
+      end
+    end
+
+    alias_method :using_session_without_screenshot, :using_session
+    alias_method :using_session, :using_session_with_screenshot
   end
 end

data/lib/capybara-screenshot/cucumber.rb

@@ -1,19 +1,25 @@
+Before do |scenario|
+  Capybara::Screenshot.final_session_name = nil
+end
+
 After do |scenario|
   if Capybara::Screenshot.autosave_on_failure && scenario.failed?
-    filename_prefix = Capybara::Screenshot.filename_prefix_for(:cucumber, scenario)
+    Capybara.using_session(Capybara::Screenshot.final_session_name) do
+      filename_prefix = Capybara::Screenshot.filename_prefix_for(:cucumber, scenario)
 
-    saver = Capybara::Screenshot::Saver.new(Capybara, Capybara.page, true, filename_prefix)
-    saver.save
-    saver.output_screenshot_path
+      saver = Capybara::Screenshot::Saver.new(Capybara, Capybara.page, true, filename_prefix)
+      saver.save
+      saver.output_screenshot_path
 
-    # Trying to embed the screenshot into our output."
-    if File.exist?(saver.screenshot_path)
-      require "base64"
-      #encode the image into it's base64 representation
-      image = open(saver.screenshot_path, 'rb') {|io|io.read}
-      encoded_img = Base64.encode64(image)
-      #this will embed the image in the HTML report, embed() is defined in cucumber
-      embed("data:image/png;base64,#{encoded_img}", 'image/png', "Screenshot of the error")
+      # Trying to embed the screenshot into our output."
+      if File.exist?(saver.screenshot_path)
+        require "base64"
+        #encode the image into it's base64 representation
+        image = open(saver.screenshot_path, 'rb') {|io|io.read}
+        encoded_img = Base64.encode64(image)
+        #this will embed the image in the HTML report, embed() is defined in cucumber
+        embed("data:image/png;base64,#{encoded_img}", 'image/png', "Screenshot of the error")
+      end
     end
   end
 end

data/lib/capybara-screenshot/minitest.rb

@@ -1,25 +1,24 @@
-method = if ActionDispatch::IntegrationTest.respond_to? :teardown
-  :teardown
-elsif ActionDispatch::IntegrationTest.respond_to? :add_tear_down_hook
-  :add_tear_down_hook
-end
-
-unless method.nil?
-  begin
-    ActionDispatch::IntegrationTest.send method do |context|
-      # by adding the argument context, MiniTest passes the context of the test
-      # which has an instance variable @passed indicating success / failure
-      failed = !context.passed?
+module Capybara::Screenshot::MiniTestPlugin
+  def before_setup
+    super
+    Capybara::Screenshot.final_session_name = nil
+  end
 
-      if Capybara::Screenshot.autosave_on_failure && failed
-        filename_prefix = Capybara::Screenshot.filename_prefix_for(:minitest, context)
+  def after_teardown
+    super
+    if self.class.ancestors.map(&:to_s).include?('ActionDispatch::IntegrationTest') &&
+      Capybara::Screenshot.autosave_on_failure && !passed?
+      Capybara.using_session(Capybara::Screenshot.final_session_name) do
+        filename_prefix = Capybara::Screenshot.filename_prefix_for(:minitest, self)
 
         saver = Capybara::Screenshot::Saver.new(Capybara, Capybara.page, true, filename_prefix)
         saver.save
         saver.output_screenshot_path
       end
     end
-  rescue NoMethodError
-    # do nothing, teardown for minitest not available
   end
 end
+
+class MiniTest::Unit::TestCase
+  include Capybara::Screenshot::MiniTestPlugin
+end

data/lib/capybara-screenshot/rspec.rb

@@ -34,10 +34,11 @@ module Capybara
       # gets injected into the appropriate formatter.
 
       REPORTERS = {
-        "RSpec::Core::Formatters::ProgressFormatter" => Capybara::Screenshot::RSpec::TextReporter,
-        "RSpec::Core::Formatters::HtmlFormatter"     => Capybara::Screenshot::RSpec::HtmlLinkReporter,
-        "RSpec::Core::Formatters::TextMateFormatter" => Capybara::Screenshot::RSpec::TextMateLinkReporter, # RSpec 2
-        "RSpec::Mate::Formatters::TextMateFormatter" => Capybara::Screenshot::RSpec::TextMateLinkReporter  # RSpec 3
+        "RSpec::Core::Formatters::ProgressFormatter"      => Capybara::Screenshot::RSpec::TextReporter,
+        "RSpec::Core::Formatters::DocumentationFormatter" => Capybara::Screenshot::RSpec::TextReporter,
+        "RSpec::Core::Formatters::HtmlFormatter"          => Capybara::Screenshot::RSpec::HtmlLinkReporter,
+        "RSpec::Core::Formatters::TextMateFormatter"      => Capybara::Screenshot::RSpec::TextMateLinkReporter, # RSpec 2
+        "RSpec::Mate::Formatters::TextMateFormatter"      => Capybara::Screenshot::RSpec::TextMateLinkReporter  # RSpec 3
       }
 
       class << self
@@ -45,14 +46,17 @@ module Capybara
 
         def after_failed_example(example)
           if Capybara.page.respond_to?(:save_page) # Capybara DSL method has been included for a feature we can snapshot
-            if Capybara.page.current_url != '' && Capybara::Screenshot.autosave_on_failure && example.exception
-              filename_prefix = Capybara::Screenshot.filename_prefix_for(:rspec, example)
-              saver = Capybara::Screenshot::Saver.new(Capybara, Capybara.page, true, filename_prefix)
-              saver.save
+            Capybara.using_session(Capybara::Screenshot.final_session_name) do
+              if Capybara.page.current_url != '' && Capybara::Screenshot.autosave_on_failure && example.exception
+                filename_prefix = Capybara::Screenshot.filename_prefix_for(:rspec, example)
 
-              example.metadata[:screenshot] = {}
-              example.metadata[:screenshot][:html]  = saver.html_path if saver.html_saved?
-              example.metadata[:screenshot][:image] = saver.screenshot_path if saver.screenshot_saved?
+                saver = Capybara::Screenshot::Saver.new(Capybara, Capybara.page, true, filename_prefix)
+                saver.save
+
+                example.metadata[:screenshot] = {}
+                example.metadata[:screenshot][:html]  = saver.html_path if saver.html_saved?
+                example.metadata[:screenshot][:image] = saver.screenshot_path if saver.screenshot_saved?
+              end
             end
           end
         end
@@ -64,6 +68,10 @@ module Capybara
 end
 
 RSpec.configure do |config|
+  config.before do
+    Capybara::Screenshot.final_session_name = nil
+  end
+
   config.after do |example_from_block_arg|
     # RSpec 3 no longer defines `example`, but passes the example as block argument instead
     example = config.respond_to?(:expose_current_running_example_as) ? example_from_block_arg : self.example

data/lib/capybara-screenshot/rspec/text_reporter.rb

@@ -5,15 +5,33 @@ module Capybara
     module RSpec
       module TextReporter
         extend BaseReporter
-        enhance_with_screenshot :dump_failure_info
+
+        if ::RSpec::Version::STRING.to_i <= 2
+          enhance_with_screenshot :dump_failure_info
+        else
+          enhance_with_screenshot :example_failed
+        end
 
         def dump_failure_info_with_screenshot(example)
-          dump_failure_info_without_screenshot(example)
-          return unless (screenshot = example.metadata[:screenshot])
+          dump_failure_info_without_screenshot example
+          output_screenshot_info(example)
+        end
 
+        def example_failed_with_screenshot(notification)
+          example_failed_without_screenshot notification
+          output_screenshot_info(notification.example)
+        end
+
+        private
+        def output_screenshot_info(example)
+          return unless (screenshot = example.metadata[:screenshot])
           output.puts(long_padding + "HTML screenshot: #{screenshot[:html]}".yellow) if screenshot[:html]
           output.puts(long_padding + "Image screenshot: #{screenshot[:image]}".yellow) if screenshot[:image]
         end
+
+        def long_padding
+          "  "
+        end
       end
     end
   end

data/lib/capybara-screenshot/spinach.rb

@@ -1,8 +1,24 @@
-Spinach.hooks.on_failed_step do |step_data, exception, location, step_definitions|
-   if Capybara::Screenshot.autosave_on_failure
-    filename_prefix = Capybara::Screenshot.filename_prefix_for(:spinach, step_data)
-    saver = Capybara::Screenshot::Saver.new(Capybara, Capybara.page, true, filename_prefix)
-    saver.save
-    saver.output_screenshot_path
+Spinach.hooks.before_scenario do |scenario|
+  Capybara::Screenshot.final_session_name = nil
+end
+
+module Capybara::Screenshot::Spinach
+  def self.fail_with_screenshot(step_data, exception, location, step_definitions)
+    if Capybara::Screenshot.autosave_on_failure
+      Capybara.using_session(Capybara::Screenshot.final_session_name) do
+        filename_prefix = Capybara::Screenshot.filename_prefix_for(:spinach, step_data)
+        saver = Capybara::Screenshot::Saver.new(Capybara, Capybara.page, true, filename_prefix)
+        saver.save
+        saver.output_screenshot_path
+      end
+    end
   end
 end
+
+Spinach.hooks.on_failed_step do |*args|
+  Capybara::Screenshot::Spinach.fail_with_screenshot(*args)
+end
+
+Spinach.hooks.on_error_step do |*args|
+  Capybara::Screenshot::Spinach.fail_with_screenshot(*args)
+end

data/lib/capybara-screenshot/testunit.rb

@@ -1,21 +1,39 @@
 require 'test/unit/testresult'
-Test::Unit::TestResult.class_eval do
 
+module Capybara::Screenshot
+  class << self
+    attr_accessor :testunit_paths
+  end
+
+  self.testunit_paths = [%r{test/integration}]
+end
+
+Test::Unit::TestCase.class_eval do
+  setup do
+    Capybara::Screenshot.final_session_name = nil
+  end
+end
+
+Test::Unit::TestResult.class_eval do
   private
 
   def notify_fault_with_screenshot(fault, *args)
     notify_fault_without_screenshot fault, *args
-    if fault.location.first =~ %r{test/integration}
+    is_integration_test = fault.location.any? do |location|
+      Capybara::Screenshot.testunit_paths.any? { |path| location.match(path) }
+    end
+    if is_integration_test
       if Capybara::Screenshot.autosave_on_failure
-        filename_prefix = Capybara::Screenshot.filename_prefix_for(:testunit, fault)
+        Capybara.using_session(Capybara::Screenshot.final_session_name) do
+          filename_prefix = Capybara::Screenshot.filename_prefix_for(:testunit, fault)
 
-        saver = Capybara::Screenshot::Saver.new(Capybara, Capybara.page, true, filename_prefix)
-        saver.save
-        saver.output_screenshot_path
+          saver = Capybara::Screenshot::Saver.new(Capybara, Capybara.page, true, filename_prefix)
+          saver.save
+          saver.output_screenshot_path
+        end
       end
     end
   end
   alias notify_fault_without_screenshot notify_fault
   alias notify_fault notify_fault_with_screenshot
-
 end

data/lib/capybara-screenshot/version.rb

@@ -1,5 +1,5 @@
 module Capybara
   module Screenshot
-    VERSION = "0.3.22"
+    VERSION = "1.0.0"
   end
 end

data/spec/cucumber/cucumber_spec.rb

@@ -0,0 +1,64 @@
+require "spec_helper"
+require "gherkin"
+
+# If Gherkin Parser is not available, then we are using an old Spinach Gemset
+if defined?(Gherkin::Parser::Parser)
+  describe "Using Capybara::Screenshot with Cucumber" do
+    include Aruba::Api
+    include CommonSetup
+
+    before do
+      clean_current_dir
+    end
+
+    def run_failing_case(failure_message, code)
+      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)
+      cmd = 'bundle exec cucumber'
+      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"}, <<-CUCUMBER)
+        Feature: Failure
+          Scenario: Failure
+            Given I visit "/"
+            And I click on a missing link
+      CUCUMBER
+      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}, <<-CUCUMBER)
+        Feature: Failure
+          Scenario: Failure
+            Given I visit "/"
+            And I trigger an unhandled exception
+      CUCUMBER
+      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"}, <<-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
+      check_file_content('tmp/my_screenshot.html', 'This is a different page', true)
+    end
+  end
+end