eyes_core 3.14.3 → 3.14.4

data/lib/applitools/capybara/driver.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+if defined? Capybara::Selenium::Driver
+  module Applitools::Selenium::Capybara
+    # @!visibility private
+    class Driver < Capybara::Selenium::Driver
+      def driver_for_eyes(eyes)
+        browser eyes: eyes
+      end
+
+      def browser(options = {})
+        eyes = options.delete(:eyes)
+        @native_browser ||= super()
+        unless eyes.nil?
+          is_mobile_device = @browser.capabilities['platformName'] ? true : false
+          @browser = Applitools::Selenium::Driver.new eyes,
+            options.merge(driver: @browser,  is_mobile_device: is_mobile_device)
+        end
+        @browser
+      end
+
+      def use_native_browser
+        @browser = @native_browser
+      end
+    end
+  end
+end
+
+if defined? ::Capybara::Session
+  ::Capybara::Session.class_eval do
+    def driver_for_eyes(eyes)
+      driver.driver_for_eyes eyes
+    end
+
+    def use_native_browser
+      driver.use_native_browser if driver.respond_to? :use_native_browser
+    end
+  end
+end

data/lib/applitools/chunky_png/resampling.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Applitools
   class Enumerator < ::Enumerator
     if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.0.0')

data/lib/applitools/chunky_png_patch.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'oily_png'
 # require 'chunky_png'
 require_relative 'chunky_png/resampling'

data/lib/applitools/connectivity/proxy.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Applitools::Connectivity
   Proxy = Struct.new(:uri, :user, :password) do
     def to_hash

data/lib/applitools/connectivity/server_connector.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: false
+
 require 'faraday'
 require 'oj'
 Oj.default_options = { :mode => :compat }
@@ -6,6 +8,7 @@ require 'uri'
 
 module Applitools::Connectivity
   class ServerConnector
+    extend Applitools::Helpers
     DEFAULT_SERVER_URL = 'https://eyessdk.applitools.com'.freeze
 
     SSL_CERT = File.join(File.dirname(File.expand_path(__FILE__)), '../../../certs/cacert.pem').to_s.freeze
@@ -21,9 +24,10 @@ module Applitools::Connectivity
       gone: 410
     }.freeze
 
-    attr_accessor :server_url, :api_key
+    attr_accessor :server_url
     attr_reader :endpoint_url
     attr_reader :proxy
+    environment_attribute :api_key, 'APPLITOOLS_API_KEY'
 
     def initialize(url = nil)
       self.server_url = url
@@ -120,6 +124,24 @@ module Applitools::Connectivity
       Applitools::TestResults.new(response)
     end
 
+    def post_dom_json(dom_data)
+      Applitools::EyesLogger.debug 'About to send captured DOM...'
+      request_body = Oj.dump(dom_data)
+      Applitools::EyesLogger.debug request_body
+      processed_request_body = yield(request_body) if block_given?
+      res = post(
+        endpoint_url + 'data',
+        body: processed_request_body.nil? ? request_body : processed_request_body,
+        content_type: 'application/octet-stream'
+      )
+
+      Applitools::EyesLogger.debug 'Done!'
+      raise Applitools::EyesError.new("Request failed: #{res.status} #{res.body}") unless res.success?
+      Applitools::EyesLogger.debug  'Server response headers:'
+      Applitools::EyesLogger.debug  res.headers.inspect
+      res.headers['location']
+    end
+
     private
 
     DEFAULT_HEADERS = {

data/lib/applitools/core/abstract_region.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Applitools
   class AbstractRegion
     class << self

data/lib/applitools/core/app_environment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: false
+
 module Applitools
   class AppEnvironment
     attr_accessor :os, :hosting_app, :display_size, :inferred_environment

data/lib/applitools/core/app_output.rb

@@ -1,17 +1,29 @@
+# frozen_string_literal: true
+
 module Applitools
   class AppOutput
-    attr_reader :title, :screenshot64
+    attr_reader :title, :screenshot64, :location
+    attr_accessor :dom_url
 
     def initialize(title, screenshot64)
       @title = title
       @screenshot64 = screenshot64
+      @location = Applitools::Location::TOP_LEFT
+    end
+
+    def location=(value)
+      Applitools::ArgumentGuard.is_a?(value, 'location', Applitools::Location)
+      @location = value
     end
 
     def to_hash
-      {
-        title: title,
-        screenshot64: nil
+      result = {
+        Title: title,
+        Screenshot64: nil,
+        Location: location.to_hash
       }
+      result[:DomUrl] = dom_url if dom_url
+      result
     end
   end
 end

data/lib/applitools/core/app_output_with_screenshot.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Applitools
   class AppOutputWithScreenshot
     attr_reader :app_output, :screenshot

data/lib/applitools/core/argument_guard.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Applitools
   module ArgumentGuard
     extend self
@@ -29,7 +31,7 @@ module Applitools
     def is_a?(param, param_name, klass)
       return true if param.is_a? klass
       raise Applitools::EyesIllegalArgument.new "Expected #{param_name} to be" \
-        " instance of #{klass} (but got #{param.class.name})"
+        " instance of #{klass}, but got #{param.class.name} instead"
     end
 
     def raise_argument_error(error)

data/lib/applitools/core/batch_info.rb

@@ -1,18 +1,26 @@
+# frozen_string_literal: true
+
 require 'securerandom'
+require_relative 'helpers'
 
 module Applitools
   class BatchInfo
-    attr_accessor :name, :started_at, :id
+    extend Helpers
+    attr_accessor :started_at, :id
+
+    environment_attribute :name, 'APPLITOOLS_BATCH_NAME'
+    environment_attribute :id, 'APPLITOOLS_BATCH_ID'
+
     def initialize(name = nil, started_at = Time.now)
-      @name = name
+      self.name = name if name
       @started_at = started_at
-      @id = SecureRandom.uuid
+      self.id = SecureRandom.uuid unless id
     end
 
     def to_hash
       {
-        'id' => @id,
-        'name' => @name,
+        'id' => id,
+        'name' => name,
         'startedAt' => @started_at.iso8601
       }
     end

data/lib/applitools/core/class_name.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Applitools
   class ClassName < String
     def ===(other)

data/lib/applitools/core/debug_screenshot_provider.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'fileutils'
 
 module Applitools
@@ -12,9 +14,9 @@ module Applitools
       return unless debug
       case image
       when ::ChunkyPNG::Image, Applitools::Screenshot
-        image.save(file_name_to_save(suffix))
+        image.save(file_name_to_save(suffix)) if image.area > 0
       when Applitools::EyesScreenshot
-        image.image.save(file_name_to_save(suffix))
+        image.image.save(file_name_to_save(suffix)) if image.image.area > 0
       when String
         ::ChunkyPNG::Image.from_string(image).save(file_name_to_save(suffix))
       else

data/lib/applitools/core/eyes_base.rb

@@ -1,5 +1,9 @@
+# frozen_string_literal: true
+
 require 'applitools/core/helpers'
 require 'applitools/core/eyes_screenshot'
+require 'zlib'
+
 require_relative 'match_level_setter'
 
 module Applitools
@@ -32,9 +36,9 @@ module Applitools
     #   Default value is false.
     #   @return [boolean] verbose_results flag
 
-    attr_accessor :app_name, :baseline_name, :branch_name, :parent_branch_name, :batch, :agent_id, :full_agent_id,
+    attr_accessor :app_name, :batch, :agent_id, :full_agent_id,
       :match_timeout, :save_new_tests, :save_failed_tests, :failure_reports, :default_match_settings, :cut_provider,
-      :scale_ratio, :host_os, :host_app, :base_line_name, :position_provider, :viewport_size, :verbose_results,
+      :scale_ratio, :host_os, :host_app, :position_provider, :viewport_size, :verbose_results,
       :inferred_environment, :remove_session_if_matching, :server_scale, :server_remainder, :match_level, :exact,
       :compare_with_parent_branch
 
@@ -44,6 +48,10 @@ module Applitools
     abstract_method :set_viewport_size, true
     abstract_method :get_viewport_size, true
 
+    environment_attribute :branch_name, 'APPLITOOLS_BRANCH'
+    environment_attribute :parent_branch_name, 'APPLITOOLS_PARENT_BRANCH'
+    environment_attribute :baseline_env_name, 'APPLITOOLS_BASELINE_BRANCH'
+
     def initialize(server_url = nil)
       self.server_connector = Applitools::Connectivity::ServerConnector.new(server_url)
       self.disabled = false
@@ -331,7 +339,7 @@ module Applitools
 
       session_start_info = SessionStartInfo.new agent_id: base_agent_id, app_id_or_name: app_name,
          scenario_id_or_name: test_name, batch_info: batch,
-         env_name: baseline_name, environment: app_environment,
+         env_name: baseline_env_name, environment: app_environment,
          default_match_settings: default_match_settings,
          branch_name: branch_name, parent_branch_name: parent_branch_name, properties: properties
 
@@ -394,7 +402,7 @@ module Applitools
     # @param [Boolean] throw_exception If set to +true+ eyes will trow [Applitools::TestFailedError] exception,
     # otherwise the test will pass. Default is true
 
-    def close(throw_exception = true)
+    def close(throw_exception = true, be_silent = false)
       if disabled?
         logger.info "#{__method__} Ignored"
         return false
@@ -409,8 +417,8 @@ module Applitools
       clear_user_inputs
 
       unless running_session
-        logger.info 'Server session was not started'
-        logger.info '--- Empty test ended'
+        be_silent || logger.info('Server session was not started')
+        be_silent || logger.info('--- Empty test ended')
         return Applitools::TestResults.new
       end
 
@@ -476,6 +484,10 @@ module Applitools
 
     private :full_agent_id, :full_agent_id=
 
+    def dom_data
+      {}
+    end
+
     def match_level_keys
       %w(match_level exact scale remainder).map(&:to_sym)
     end
@@ -592,8 +604,8 @@ module Applitools
       logger.info "Application environment is #{app_env}"
 
       self.session_start_info = SessionStartInfo.new agent_id: base_agent_id, app_id_or_name: app_name,
-                                                scenario_id_or_name: test_name, batch_info: @batch,
-                                                env_name: baseline_name, environment: app_env,
+                                                scenario_id_or_name: test_name, batch_info: batch,
+                                                env_name: baseline_env_name, environment: app_env,
                                                 default_match_settings: default_match_settings,
                                                 branch_name: branch_name, parent_branch_name: parent_branch_name,
                                                 properties: properties
@@ -613,6 +625,27 @@ module Applitools
     end
 
     def get_app_output_with_screenshot(region_provider, last_screenshot)
+      dom_url = ''
+      captured_dom_data = dom_data
+      unless captured_dom_data.empty?
+        begin
+          logger.info 'Processing DOM..'
+          dom_url = server_connector.post_dom_json(captured_dom_data) do |json|
+            io = StringIO.new
+            gz = Zlib::GzipWriter.new(io)
+            gz.write(json.encode('UTF-8'))
+            gz.close
+            result = io.string
+            io.close
+            result
+          end
+          logger.info 'Done'
+          logger.info dom_url
+        rescue Applitools::EyesError => e
+          logger.warn e.message
+          dom_url = nil
+        end
+      end
       logger.info 'Getting screenshot...'
       screenshot = capture_screenshot
       logger.info 'Done getting screenshot!'
@@ -630,7 +663,10 @@ module Applitools
       a_title = title
       logger.info 'Done!'
       Applitools::AppOutputWithScreenshot.new(
-        Applitools::AppOutput.new(a_title, compress_result),
+        Applitools::AppOutput.new(a_title, compress_result).tap do |o|
+          o.location = region.location unless region.empty?
+          o.dom_url = dom_url unless dom_url && dom_url.empty?
+        end,
         screenshot
       )
     end

data/lib/applitools/core/eyes_screenshot.rb

@@ -1,10 +1,13 @@
+# frozen_string_literal: true
+
 module Applitools
   class EyesScreenshot
     extend Forwardable
     extend Applitools::Helpers
 
     def_delegators 'Applitools::EyesLogger', :logger, :log_handler, :log_handler=
-    attr_accessor :image
+    attr_accessor :image, :top_left_location
+    def_delegators '@image', :width, :height
 
     COORDINATE_TYPES = {
       context_as_is: 'CONTEXT_AS_IS',
@@ -39,5 +42,11 @@ module Applitools
       updated_location = convert_location(region.location, from, to)
       Region.new updated_location.x, updated_location.y, region.width, region.height
     end
+
+    private
+
+    def image_region
+      Applitools::Region.new(0, 0, image.width, image.height)
+    end
   end
 end

data/lib/applitools/core/fixed_cut_provider.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Applitools
   # Provides 'cut' method which is used to cut screen shots
   class FixedCutProvider

data/lib/applitools/core/fixed_scale_provider.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Applitools
   # @!visibility private
   class FixedScaleProvider

data/lib/applitools/core/floating_region.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'region'
 module Applitools
   class FloatingRegion < Region
@@ -81,6 +83,14 @@ module Applitools
       self
     end
 
+    def ==(other)
+      super(other) &&
+        max_left_offset == other.max_left_offset &&
+        max_top_offset == other.max_top_offset &&
+        max_right_offset == other.max_right_offset &&
+        max_bottom_offset == other.max_bottom_offset
+    end
+
     def to_hash
       {
         'Top' => top,

data/lib/applitools/core/fluent_interface.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'match_level_setter'
 module Applitools::FluentInterface
   include Applitools::MatchLevelSetter
@@ -9,7 +11,7 @@ module Applitools::FluentInterface
     end
   end
 
-  def ignore_caret(value = false)
+  def ignore_caret(value = true)
     options[:ignore_caret] = value ? true : false
     self
   end
@@ -42,4 +44,9 @@ module Applitools::FluentInterface
     options[:match_level], options[:exact] = match_level_with_exact(value, exact_options)
     self
   end
+
+  def send_dom(value)
+    options[:send_dom] = value ? true : false
+    self
+  end
 end

data/lib/applitools/core/hash_extension.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Applitools::HashExtension
   if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.0.0')
     def struct_define_to_h_method