test_methods.rb in capybara-screenshot-diff-1.4.0

- old
+ new

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
-require 'English'
-require 'capybara'
-require 'action_controller'
-require 'action_dispatch'
-require 'active_support/core_ext/string/strip'
-require_relative 'image_compare'
-require_relative 'stabilization'
-require_relative 'vcs'
+require "English"
+require "capybara"
+require "action_controller"
+require "action_dispatch"
+require "active_support/core_ext/string/strip"
+require_relative "image_compare"
+require_relative "stabilization"
+require_relative "vcs"
 
 # Add the `screenshot` method to ActionDispatch::IntegrationTest
 module Capybara
   module Screenshot
     module Diff
@@ -40,23 +40,17 @@
         def screenshot_dir
           File.join [Screenshot.screenshot_area] + group_parts
         end
 
         def current_capybara_driver_class
-          Capybara.drivers[Capybara.current_driver].call({}).class
+          Capybara.current_session.driver.class
         end
 
         def selenium?
           current_capybara_driver_class <= Capybara::Selenium::Driver
         end
 
-        def poltergeist?
-          return false unless defined?(Capybara::Poltergeist::Driver)
-
-          current_capybara_driver_class <= Capybara::Poltergeist::Driver
-        end
-
         def screenshot_section(name)
           @screenshot_section = name.to_s
         end
 
         def screenshot_group(name)
@@ -66,73 +60,70 @@
 
           FileUtils.rm_rf screenshot_dir
         end
 
         # @return [Boolean] wether a screenshot was taken
-        def screenshot(name, area_size_limit: Diff.area_size_limit,
+        def screenshot(
+          name,
+          stability_time_limit: Screenshot.stability_time_limit,
+          wait: Capybara.default_max_wait_time,
+          **driver_options
+        )
+          return false unless Screenshot.active?
+          return false if window_size_is_wrong?
+
+          driver_options = {
+            area_size_limit: Diff.area_size_limit,
             color_distance_limit: Diff.color_distance_limit,
-            shift_distance_limit: Diff.shift_distance_limit, skip_area: Diff.skip_area,
-            stability_time_limit: Screenshot.stability_time_limit,
-            wait: Capybara.default_max_wait_time)
-          return unless Screenshot.active?
-          return if window_size_is_wrong?
+            driver: Diff.driver,
+            shift_distance_limit: Diff.shift_distance_limit,
+            skip_area: Diff.skip_area,
+            tolerance: Diff.tolerance
+          }.merge(driver_options)
 
-          skip_area = skip_area&.flatten&.each_cons(4)&.to_a # Allow nil or single or multiple areas
+          # Allow nil or single or multiple areas
+          if driver_options[:skip_area]
+            driver_options[:skip_area] = driver_options[:skip_area].compact.flatten&.each_cons(4)&.to_a
+          end
 
           if @screenshot_counter
-            name = "#{format('%02i', @screenshot_counter)}_#{name}"
+            name = "#{format("%02i", @screenshot_counter)}_#{name}"
             @screenshot_counter += 1
           end
           name = full_name(name)
           file_name = "#{Screenshot.screenshot_area_abs}/#{name}.png"
 
           FileUtils.mkdir_p File.dirname(file_name)
-          comparison = ImageCompare.new(file_name,
-              dimensions: Screenshot.window_size, color_distance_limit: color_distance_limit,
-              area_size_limit: area_size_limit, shift_distance_limit: shift_distance_limit,
-              skip_area: skip_area)
+          comparison = ImageCompare.new(file_name, **driver_options)
           checkout_vcs(name, comparison)
-          take_stable_screenshot(comparison, color_distance_limit: color_distance_limit,
-                                             shift_distance_limit: shift_distance_limit,
-                                             area_size_limit: area_size_limit,
-                                             skip_area: skip_area,
-                                             stability_time_limit: stability_time_limit,
-                                             wait: wait)
-          return unless comparison.old_file_exists?
+          begin
+            blurred_input = prepare_page_for_screenshot(timeout: wait)
+            if stability_time_limit
+              take_stable_screenshot(comparison, stability_time_limit: stability_time_limit, wait: wait)
+            else
+              take_right_size_screenshot(comparison)
+            end
+          ensure
+            blurred_input&.click
+          end
 
+          return false unless comparison.old_file_exists?
+
           (@test_screenshots ||= []) << [caller(1..1).first, name, comparison]
+
           true
         end
 
         def window_size_is_wrong?
           selenium? && Screenshot.window_size &&
-
-            # FIXME(uwe): This happens with headless chrome.  Why?!
-            page.driver.browser.manage.window.size.width &&
-            # EMXIF
-
             page.driver.browser.manage.window.size !=
               ::Selenium::WebDriver::Dimension.new(*Screenshot.window_size)
         end
 
         def assert_image_not_changed(caller, name, comparison)
           return unless comparison.different?
 
-          # TODO(uwe): Remove check when we stop supporting Ruby 2.3 and older
-          max_color_distance = if RUBY_VERSION >= '2.4'
-                                 comparison.max_color_distance.ceil(1)
-                               else
-                                 comparison.max_color_distance.ceil
-                               end
-          # ODOT
-
-          max_shift_distance = comparison.max_shift_distance
-          "Screenshot does not match for '#{name}' (area: #{comparison.size}px #{comparison.dimensions}" \
-            ", max_color_distance: #{max_color_distance}" \
-            "#{", max_shift_distance: #{max_shift_distance}" if max_shift_distance})\n" \
-            "#{comparison.new_file_name}\n#{comparison.annotated_old_file_name}\n" \
-            "#{comparison.annotated_new_file_name}\n" \
-            "at #{caller}"
+          "Screenshot does not match for '#{name}' #{comparison.error_message}\nat #{caller}"
         end
       end
     end
   end
 end