eyes_core 4.6.3 → 6.0.0

data/lib/applitools/core/eyes_base.rb

@@ -49,7 +49,7 @@ module Applitools
         begin
           driver_config_json = driver.universal_driver_config
           required_size = Applitools::RectangleSize.from_any_argument viewport_size
-          @universal_client = Applitools::Connectivity::UniversalClient.new
+          @universal_client = Applitools::Connectivity::UniversalClient.new(self)
           @universal_client.core_set_viewport_size(driver_config_json, required_size.to_hash)
         rescue => e
           Applitools::EyesLogger.error e.class
@@ -64,7 +64,7 @@ module Applitools
         server_url = options[:server_url] || default_configs[:server_url]
         api_key = options[:api_key] || default_configs[:api_key]
         proxy = options[:proxy]
-        @universal_client = Applitools::Connectivity::UniversalClient.new
+        @universal_client = Applitools::Connectivity::UniversalClient.new(self)
         core_ec_client = @universal_client.core_make_ec_client(server_url, api_key, proxy)
         core_ec_client[:url]
       end
@@ -150,6 +150,13 @@ module Applitools
       self.universal_driver = nil # eyes.open
     end
 
+    def self.environment_sdk
+      {
+        name: :eyes_core,
+        currentVersion: Applitools::EyesCore::VERSION
+      }
+    end
+
     def ensure_config
       self.config = Applitools::EyesBaseConfiguration.new
     end
@@ -213,10 +220,10 @@ module Applitools
       end
 
 
-      if running_session.nil?
-        logger.info 'Closed'
-        return false
-      end
+      # if running_session.nil?
+      #   logger.info 'Closed'
+      #   return false
+      # end
 
       logger.info 'Aborting server session...'
       universal_sdk_abort
@@ -441,11 +448,6 @@ module Applitools
       logger.info "close(#{throw_exception})"
       raise Applitools::EyesError.new 'Eyes not open' unless open?
 
-      self.open = false
-      self.last_screenshot = nil
-
-      clear_user_inputs
-
       if !running_session && !universal_eyes
         be_silent || logger.info('Server session was not started')
         be_silent || logger.info('--- Empty test ended')
@@ -463,26 +465,112 @@ module Applitools
 
       # U-Notes : universal server returns Array ; keys as sym
       universal_eyes.close # nil
+      results = get_results(throw_exception)
+    #   universal_results = universal_eyes.eyes_get_results # Array even for one test
+    #   # require 'pry'
+    #   # binding.pry
+    #   # error from universal server
+    #   if universal_results.is_a?(Hash) && universal_results[:message] && universal_results[:stack] && universal_results[:reason]
+    #     logger.error "--- Error (#{universal_results[:reason]}) : #{universal_results[:message]}"
+    #     error_message = "Test '#{test_name}' of '#{app_name}' " \
+    #       "is failed! Details : #{universal_results[:message]}"
+    #     raise Applitools::TestFailedError.new error_message, results if throw_exception
+    #     return universal_results
+    #   end
+    #   key_transformed_results = Applitools::Utils.deep_stringify_keys(universal_results)
+    #   results = key_transformed_results.map {|result| Applitools::TestResults.new(result) }
+    #   results = results.first if results.size >= 1
+    #
+    #   session_results_url = results.url
+    #   # results = server_connector.stop_session running_session, false, save
+    #   runner.aggregate_result(results) if runner
+    #
+    #   # results.is_new = is_new_session
+    #   # results.url = session_results_url
+    #   save = results.new? && save_new_tests || !results.new? && failed && save_failed_tests
+    #   logger.info "Automatically save test? #{save}"
+    #
+    #   logger.info results.to_s(verbose_results)
+    #
+    #   if results.unresolved?
+    #     if results.new?
+    #       logger.error "--- New test ended. see details at #{session_results_url}"
+    #       error_message = "New test '#{test_name}' " \
+    #         "of '#{app_name}' " \
+    #         "Please approve the baseline at #{session_results_url} "
+    #       raise Applitools::NewTestError.new error_message, results if throw_exception
+    #     else
+    #       logger.error "--- Differences are found. see details at #{session_results_url}"
+    #       error_message = "Test '#{test_name}' " \
+    #         "of '#{app_name}' " \
+    #         "detected differences! See details at #{session_results_url}"
+    #       raise Applitools::DiffsFoundError.new error_message, results if throw_exception
+    #     end
+    #     return results
+    #   end
+    #
+    #   if results.failed?
+    #     logger.error "--- Failed test ended. see details at #{session_results_url}"
+    #     error_message = "Test '#{test_name}' of '#{app_name}' " \
+    #         "is failed! See details at #{session_results_url}"
+    #     raise Applitools::TestFailedError.new error_message, results if throw_exception
+    #     return results
+    #   end
+
+      logger.info '--- Test passed'
+      self.results.push results
+
+      # match old style one result
+      if results.is_a?(Array) && results.first.is_a?(Applitools::TestResults)
+        return results.first if results.size >= 1
+      end
+      return results
+    ensure
+      self.running_session = nil
+      self.app_name = ''
+    end
+
+    def get_results(throw_exception = true)
+      if disabled?
+        logger.info "#{__method__} Ignored"
+        return false
+      end
+
+      self.open = false
+      self.last_screenshot = nil
+      clear_user_inputs
+
+      logger.info 'Getting results...'
+
       universal_results = universal_eyes.eyes_get_results # Array even for one test
       # require 'pry'
       # binding.pry
+      # error from universal server
+      if universal_results.is_a?(Hash) && universal_results[:message] && universal_results[:stack] && universal_results[:reason]
+        logger.error "--- Error (#{universal_results[:reason]}) : #{universal_results[:message]}"
+        error_message = "Test '#{test_name}' of '#{app_name}' " \
+          "is failed! Details : #{universal_results[:message]}"
+        raise Applitools::TestFailedError.new error_message, results if throw_exception
+        return universal_results
+      end
       key_transformed_results = Applitools::Utils.deep_stringify_keys(universal_results)
       results = key_transformed_results.map {|result| Applitools::TestResults.new(result) }
-      results = results.first if results.size >= 1
+      # results = results.first if results.size >= 1
 
-      session_results_url = results.url
+      session_results_url = results.first.url
       # results = server_connector.stop_session running_session, false, save
-      runner.aggregate_result(results) if runner
+
+      results.each { |result| runner.aggregate_result(result) } if runner
 
       # results.is_new = is_new_session
       # results.url = session_results_url
-      save = results.new? && save_new_tests || !results.new? && failed && save_failed_tests
+      save = (results.any?(&:new?) && save_new_tests) || (!results.any?(&:new?) && failed && save_failed_tests)
       logger.info "Automatically save test? #{save}"
 
-      logger.info results.to_s(verbose_results)
+      logger.info results.first.to_s(verbose_results)
 
-      if results.unresolved?
-        if results.new?
+      if results.any?(&:unresolved?)
+        if results.any?(&:new?)
           logger.error "--- New test ended. see details at #{session_results_url}"
           error_message = "New test '#{test_name}' " \
             "of '#{app_name}' " \
@@ -498,16 +586,16 @@ module Applitools
         return results
       end
 
-      if results.failed?
+      if results.any?(&:failed?)
         logger.error "--- Failed test ended. see details at #{session_results_url}"
         error_message = "Test '#{test_name}' of '#{app_name}' " \
-            "is failed! See details at #{session_results_url}"
+          "is failed! See details at #{session_results_url}"
         raise Applitools::TestFailedError.new error_message, results if throw_exception
         return results
       end
 
-      logger.info '--- Test passed'
-      self.results.push results
+      # logger.info '--- Test passed'
+      # self.results.push results
       return results
     ensure
       self.running_session = nil

data/lib/applitools/core/eyes_base_configuration.rb

@@ -207,7 +207,15 @@ module Applitools
 
     # layoutBreakpoints?: boolean | number[]
     def layout_breakpoints=(value)
-      config_hash[:layout_breakpoints] = (value.is_a?(Array) && value.all? {|v| v.is_a?(Numeric)}) ? value : !!value
+      config_hash[:layout_breakpoints] = { breakpoints: value } if value === true || value === false
+      config_hash[:layout_breakpoints] = { breakpoints: value } if value.is_a?(Array) && value.all? {|v| v.is_a?(Numeric)}
+      if value.is_a?(Hash)
+        if value.has_key?(:breakpoints) || value.has_key?('breakpoints')
+          config_hash[:layout_breakpoints] = value
+        else
+          config_hash[:layout_breakpoints] = { breakpoints: value }
+        end
+      end
     end
     def layout_breakpoints
       config_hash[:layout_breakpoints]

data/lib/applitools/core/eyes_runner.rb

@@ -8,7 +8,7 @@ module Applitools
 
     def initialize
       self.batches_server_connectors_map = {}
-      self.universal_client = Applitools::Connectivity::UniversalClient.new
+      self.universal_client = nil # eyes.open
       self.universal_eyes_manager = nil # eyes.open
     end
 
@@ -20,8 +20,9 @@ module Applitools
       batches_server_connectors_map.each_value { |v| v.call if v.respond_to? :call }
     end
 
-    def get_universal_eyes_manager
+    def get_universal_eyes_manager(eyes=nil)
       return universal_eyes_manager if universal_eyes_manager
+      self.universal_client = Applitools::Connectivity::UniversalClient.new(eyes) if universal_client.nil?
       self.universal_eyes_manager = universal_client.make_manager(universal_eyes_manager_config.to_hash)
     end
 

data/lib/applitools/core/test_result_summary.rb

@@ -2,11 +2,14 @@
 
 module Applitools
   class TestResultSummary
+    extend Forwardable
     attr_accessor :results, :passed, :unresolved, :failed, :exceptions, :mismatches, :missing, :matches
     attr_accessor :original_test_results
+    def_delegators :results, :[], :length
+
     def initialize(all_test_results)
       @original_test_results = all_test_results
-      @results = all_test_results[:results]
+      @results = all_test_results[:results].map {|r| Applitools::TestResults.new(r) }
       @passed = all_test_results[:passed]
       @unresolved = all_test_results[:unresolved]
       @failed = all_test_results[:failed]
@@ -16,12 +19,9 @@ module Applitools
       @matches = all_test_results[:matches]
     end
 
-    def old_style_results_array
-      Applitools::Utils.deep_stringify_keys(results).map do |e|
-        r = e['result'] ? e['result'] : {}
-        r['isAborted'] = true unless e['error'].nil? # fix for get_all_test_results
-        Applitools::TestResults.new(r)
-      end
+    def to_a
+      @results
     end
+
   end
 end

data/lib/applitools/core/test_results.rb

@@ -17,9 +17,13 @@ module Applitools
       end
     end
     attr_accessor :is_new, :url, :screenshot
-    attr_reader :status, :steps, :matches, :mismatches, :missing, :original_results
+    attr_reader :status, :steps, :matches, :mismatches, :missing, :original_results, :browser_info, :renderer
 
-    def initialize(results = {})
+    def initialize(init_results = {})
+      environment = init_results[:environment] || {}
+      @renderer = Applitools::Utils.deep_stringify_keys(Applitools::Utils.underscore_hash_keys(environment[:requested]))
+      @browser_info = JSON.parse(@renderer.to_json, object_class: OpenStruct)
+      results = Applitools::Utils.deep_stringify_keys(init_results[:result] ? init_results[:result] : init_results)
       @original_results = results
       @steps = results.fetch('steps', 0)
       @matches = results.fetch('matches', 0)
@@ -30,6 +34,10 @@ module Applitools
       @url = results.fetch('url', nil)
     end
 
+    def test_results
+      self
+    end
+
     def passed?
       status == 'Passed'
     end
@@ -51,7 +59,7 @@ module Applitools
     end
 
     def aborted?
-      original_results['isAborted']
+      original_results['isAborted'] || !errors.nil?
     end
 
     def api_session_url
@@ -66,6 +74,14 @@ module Applitools
       original_results['name']
     end
 
+    def errors
+      original_results['error']
+    end
+
+    def app_name
+      original_results['appName']
+    end
+
     def session_accessibility_status
       @accessibility_status ||= original_results['accessibilityStatus'] && AccessibilityStatus.new(original_results['accessibilityStatus'] || {})
     end

data/lib/applitools/core/universal_eyes_checks.rb

@@ -12,6 +12,7 @@ module Applitools
       return disabled_result if respond_to?(:disabled?) && disabled?
 
       raise Applitools::EyesNotOpenException.new('Eyes not open!') if @universal_eyes.nil?
+      raise Applitools::EyesNotOpenException.new('Eyes not open') unless open?
       Applitools::EyesLogger.logger.info "#{test_name} : check(#{name}) started  ..."
       settings = get_universal_check_settings(name, target)
       image_target = settings[:image].nil? ? {} : { image: settings.delete(:image) }
@@ -24,7 +25,7 @@ module Applitools
         raise Applitools::EyesError.new("Request failed: #{check_result[:message]}")
       end
 
-      if check_result != {}
+      if check_result != {} && !check_result.nil?
         result = Applitools::MatchResult.new(Applitools::Utils.deep_stringify_keys(check_result[0]))
 
         check_fail_result_processing(name) unless result.as_expected?

data/lib/applitools/core/universal_eyes_open.rb

@@ -31,7 +31,7 @@ module Applitools
 
       update_config_from_options(options)
       universal_driver_config = driver.universal_driver_config if self.class.name != 'Applitools::Images::Eyes'
-      universal_eyes_manager = runner.get_universal_eyes_manager
+      universal_eyes_manager = runner.get_universal_eyes_manager(self)
 
       universal_eyes_config = Applitools::UniversalEyesConfig.new
       universal_eyes_config.from_original_sdk(self)
@@ -43,6 +43,7 @@ module Applitools
       raise Applitools::EyesNotOpenException.new('Eyes not open!') if @universal_eyes.nil?
 
       self.open = true if respond_to?(:open=, true)
+      self.opened = true if respond_to?(:opened=, true)
       self.running_session = true if respond_to?(:running_session=, true)
       if self.class.name != 'Applitools::Images::Eyes'
         driver
@@ -61,6 +62,7 @@ module Applitools
       end
       # raise Applitools::EyesNotOpenException.new('Eyes not open!') if @eyes.nil?
       return if @universal_eyes.nil?
+      closed_or_aborted = @universal_eyes.closed_or_aborted
       @universal_eyes.abort
       result = @universal_eyes.eyes_get_results
       result = result[0] if result.is_a?(Array)
@@ -72,6 +74,8 @@ module Applitools
         # require('pry')
         # binding.pry
       end
+      return nil if closed_or_aborted
+      Applitools::Utils.deep_stringify_keys(result)
     end
 
     private

data/lib/applitools/eyes_core/version.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: false
+
+module Applitools
+  module EyesCore
+    VERSION = '6.0.0'.freeze
+    UNIVERSAL_VERSION = '4.3.0'.freeze
+  end
+
+  VERSION = Applitools::EyesCore::VERSION
+end

data/lib/applitools/universal_sdk/universal_client.rb

@@ -8,6 +8,7 @@ require 'securerandom'
 require 'colorize'
 require 'websocket'
 require 'uri'
+require 'eyes_universal'
 
 
 module Applitools::Connectivity
@@ -40,9 +41,9 @@ module Applitools::Connectivity
 
     attr_accessor :commands_config
 
-    def initialize
+    def initialize(eyes=nil)
       # @socket = Applitools::Connectivity::UniversalClientSocket.new
-      prepare_socket
+      prepare_socket(eyes)
       # store on open for next check calls
       @open_config = nil
       @commands_config = {
@@ -68,7 +69,7 @@ module Applitools::Connectivity
       #   },
       # }
       ec_client_capabilities = {}
-      ec_client_capabilities[:serverUrl] = server_url unless server_url.nil?
+      ec_client_capabilities[:ecServerUrl] = server_url unless server_url.nil?
       ec_client_capabilities[:apiKey] = api_key unless api_key.nil?
       ec_client_settings = {}
       ec_client_settings[:options] = ec_client_capabilities unless ec_client_capabilities.empty?
@@ -115,7 +116,7 @@ module Applitools::Connectivity
 
     def map_open_eyes_config_to_commands_config(config)
       [
-        :serverUrl, :apiKey, :proxy, :connectionTimeout, :removeSession, :agentId, :appName, :testName, :displayName,
+        :eyesServerUrl, :apiKey, :proxy, :connectionTimeout, :removeSession, :agentId, :appName, :testName, :displayName,
         :userTestId, :sessionType, :properties, :batch, :keepBatchOpen, :environmentName, :environment, :branchName,
         :parentBranchName, :baselineEnvName, :baselineBranchName, :compareWithParentBranch, :ignoreBaseline,
         :ignoreGitBranching, :saveDiffs, :abortIdleTestTimeout
@@ -130,7 +131,7 @@ module Applitools::Connectivity
         config_mapping(config, commands_config[:check], k)
       end
 
-      commands_config[:check][:renderers] = config.delete(:browsersInfo) unless config[:browsersInfo].nil?
+      commands_config[:check][:environments] = config.delete(:browsersInfo) unless config[:browsersInfo].nil?
 
       unless config[:defaultMatchSettings].nil?
         if config[:defaultMatchSettings][:accessibilitySettings]
@@ -326,6 +327,7 @@ module Applitools::Connectivity
         batch_ids = [close_batch_settings] if close_batch_settings.is_a?(String)
         batch_ids = close_batch_settings if close_batch_settings.is_a?(Array)
         optional = [:serverUrl, :apiKey, :proxy].map {|k| [k, @open_config[k]] }.to_h
+        optional[:eyesServerUrl] = optional.delete(:serverUrl) if optional[:serverUrl] # v4
         close_batch_settings = { settings: ({ batchIds: batch_ids }.merge(optional).compact) }
       end
       command_with_result(CORE_CLOSE_BATCHES, close_batch_settings)
@@ -342,11 +344,11 @@ module Applitools::Connectivity
     private
 
 
-    def prepare_socket
-      @universal_server_control = Applitools::Connectivity::UniversalServerControl.instance
+    def prepare_socket(eyes=nil)
+      @universal_server_control = Applitools::EyesUniversal::UniversalServerControl.instance
       @web_socket = @universal_server_control.new_server_socket_connection
       socket_handshake
-      session_init
+      session_init(eyes)
       # connect_and_configure_socket(socket_uri)
     end
 
@@ -385,12 +387,26 @@ module Applitools::Connectivity
       @handshake_version = handshake.version if handshake.finished? && handshake.valid?
     end
 
-    def session_init
+    def session_init(eyes=nil)
+      sdk_name = Applitools::EyesBase.environment_sdk[:name]
+      sdk_version = Applitools::EyesBase.environment_sdk[:currentVersion]
+      if eyes
+        if eyes.respond_to?(:environment_sdk)
+          sdk_name = eyes.environment_sdk[:name]
+          sdk_version = eyes.environment_sdk[:currentVersion]
+        elsif eyes.class.respond_to?(:environment_sdk)
+          sdk_name = eyes.class.environment_sdk[:name]
+          sdk_version = eyes.class.environment_sdk[:currentVersion]
+        end
+      end
       init_agent_id = "eyes.ruby-sdk/#{Applitools::VERSION}".freeze
       make_core_payload = {
         agentId: init_agent_id,
         cwd: Dir.pwd,
-        spec: :webdriver
+        spec: :webdriver,
+        environment: {
+          sdk: {lang: :ruby, name: sdk_name, currentVersion: sdk_version}
+        }
       }
       # interface MakeCorePayload {
       #   agentId: string

data/lib/applitools/universal_sdk/universal_eyes.rb

@@ -6,9 +6,12 @@ module Applitools
     extend Forwardable
     def_delegators 'Applitools::EyesLogger', :logger
 
+    attr_accessor :closed_or_aborted
+
     def initialize(eyes, universal_client)
       @eyes = eyes
       @universal_client = universal_client
+      @closed_or_aborted = false
     end
 
     def check(settings, image_target = {})
@@ -21,10 +24,12 @@ module Applitools
     end
 
     def close
+      @closed_or_aborted = true
       @universal_client.eyes_close(@eyes)
     end
 
     def abort
+      @closed_or_aborted = true
       @universal_client.eyes_abort(@eyes)
     end
 

data/lib/applitools/universal_sdk/universal_eyes_config.rb

@@ -20,7 +20,7 @@ module Applitools
       :debugScreenshots,
       :agentId,
       :apiKey,
-      :serverUrl,
+      :eyesServerUrl,
       :proxy,
       :isDisabled,
       :connectionTimeout,
@@ -133,7 +133,7 @@ module Applitools
     # 23 + 3 + 2 + 11 = 39
     FROM_ORIGINAL_EYES = [:api_key, :app_name, :batch, :browsers_info, :concurrent_sessions, :debug_screenshots,
       :force_full_page_screenshot, :hide_caret, :hide_scrollbars, :host_app, :host_os, :match_timeout, :proxy,
-      :save_failed_tests, :save_new_tests, :scale_ratio, :send_dom, :server_url, :stitch_mode, :test_name,
+      :save_failed_tests, :save_new_tests, :scale_ratio, :send_dom, :stitch_mode, :test_name,
       :viewport_size, :visual_grid_options, :wait_before_screenshots, :wait_before_capture] + [
       :disabled?, # disabled? => is_disabled
       :stitching_overlap, # SeleniumEyes.stitching_overlap => stitch_overlap
@@ -192,6 +192,7 @@ module Applitools
       # self.display_name = original_eyes.app_name
       self.dont_close_batches = original_eyes.dont_close_batches unless original_eyes.dont_close_batches.nil?
       prepare_for_json!
+      self.eyes_server_url = original_eyes.server_url unless original_eyes.server_url.nil? # v4api_change
     end
 
     def copy_from(what, from)
@@ -208,20 +209,20 @@ module Applitools
       self.default_match_settings = default_match_settings.to_hash if default_match_settings.is_a?(Applitools::ImageMatchSettings)
       self.proxy = proxy.to_hash if proxy.is_a?(Applitools::Connectivity::Proxy)
       self.viewport_size = viewport_size.to_h if viewport_size.is_a?(Applitools::RectangleSize)
-      v3api_change
+      api_change
       # require 'pry'
       # binding.pry
     end
 
-    def v3api_change
+    def api_change
       # self.updateBaselineIfDifferent = saveFailedTests unless saveFailedTests.nil?
       # self.updateBaselineIfNew = saveNewTests unless saveNewTests.nil?
       environment = {}
-      environment[:hostApp] = hostApp unless hostApp.nil?
-      environment[:hostAppInfo] = hostAppInfo unless hostAppInfo.nil?
-      environment[:hostOS] = hostOS unless hostOS.nil?
-      environment[:hostOSInfo] = hostOSInfo unless hostOSInfo.nil?
-      environment[:deviceInfo] = deviceInfo unless deviceInfo.nil?
+      environment[:hostingApp] = hostApp unless hostApp.nil?
+      environment[:displayHostingApp] = hostAppInfo unless hostAppInfo.nil?
+      environment[:os] = hostOS unless hostOS.nil?
+      environment[:displayOs] = hostOSInfo unless hostOSInfo.nil?
+      environment[:deviceName] = deviceInfo unless deviceInfo.nil?
       unless viewportSize.nil?
         environment[:viewportSize] = viewportSize
         self.viewportSize = nil

data/lib/applitools/universal_sdk/universal_eyes_manager.rb

@@ -38,7 +38,7 @@ module Applitools
     end
 
     def close_all_eyes(remove_duplicate_tests)
-      @opened_eyes.each {|universal_eye| universal_eye.close }
+      @opened_eyes.each {|universal_eye| universal_eye.closed_or_aborted = true }
       @universal_client.eyes_manager_close_all_eyes(@manager, remove_duplicate_tests)
     end
 

data/lib/eyes_core.rb

@@ -4,7 +4,6 @@ require 'forwardable'
 require 'delegate'
 require 'time'
 require_relative 'require_utils'
-require_relative 'eyes_consts'
 
 module Applitools
   extend Applitools::RequireUtils
@@ -64,8 +63,7 @@ end
 
 require_relative 'applitools/method_tracer'
 require_relative 'applitools/extensions'
-require_relative 'applitools/version'
-# require_relative 'applitools/chunky_png_patch'
+require_relative 'applitools/eyes_core/version'
 
 Applitools.require_dir 'utils'
 Applitools.require_dir 'core'