eyes_core 4.6.2 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d81e1db8334cf38806b35937b27a6934f3515de5086621cc5db07d7d340a416
-  data.tar.gz: 588013b897e6812e3c00ef27de1efae4955dddb49c3b414891611e20262754d3
+  metadata.gz: 427cc6b949eee41b5d27bd6035ab8f45f3e07ab9a223135610abb6686b0dc033
+  data.tar.gz: dbfea6d80382744eb6b11d73c3af6efaae394c548cd5f40ad1d881496dcb2783
 SHA512:
-  metadata.gz: 704e8432ccb8b928b9d1c4993adcb33403064cc83212e4422e7d58a1e749817013fd981091752e7d3c689314e4c2fee926a3e103f090fb98f1d11963ff6b7fc7
-  data.tar.gz: e8f4dd78f0737dda84bab00239dc7c29d8837338bfcffea7c990cd7faf1b307b0fd3cef8515d67ee5b14f3dea8312c0d12782f4fe3f2881fb909a01f4030ddd8
+  metadata.gz: b95422b1a161eac1d25d3d5a6832f7c0adfb5a6c486f677ce846e8b892834f5b6cfbb65343eeaaebb9de6bfb04bd30772a5f5aa3bc058232049defdad1091ed4
+  data.tar.gz: 30f0a30d3828167b092b9139382232be8e75ca27df58a4942da49a2c64f93efe65a6fdd42b3b145c7b081113f432866fe3d73e5031ba9e4a6c3893c058708127

data/lib/applitools/appium/eyes.rb

@@ -120,6 +120,41 @@ class Applitools::Appium::Eyes < Applitools::Selenium::SeleniumEyes
     check(options[:tag], target)
   end
 
+  def set_mobile_capabilities(nmg_caps, nml_api_key, eyes_server_url, proxy_settings)
+    new_caps = {}
+
+    if nml_api_key.nil? || nml_api_key.empty?
+      nml_api_key = ENV['APPLITOOLS_API_KEY']
+      if nml_api_key.nil? || nml_api_key.empty?
+        raise Applitools::EyesError.new('No API key was given, or is an empty string.')
+      end
+    end
+    new_caps[:NML_API_KEY] = nml_api_key
+
+    if eyes_server_url.nil? || eyes_server_url.empty?
+      eyes_server_url = ENV['APPLITOOLS_SERVER_URL']
+    end
+    new_caps[:NML_SERVER_URL] = eyes_server_url if eyes_server_url
+
+    if proxy_settings.nil? || proxy_settings.empty?
+      proxy_settings = ENV['APPLITOOLS_HTTP_PROXY']
+    end
+    new_caps[:NML_PROXY_URL] = proxy_settings if proxy_settings
+
+    nmg_caps[:optionalIntentArguments] = "--es APPLITOOLS '" + new_caps.to_json + "'"
+    nmg_caps[:processArguments] = {
+      args: [],
+      env: new_caps.merge(DYLD_INSERT_LIBRARIES: "@executable_path/Frameworks/UFG_lib.xcframework/ios-arm64/UFG_lib.framework/UFG_lib:@executable_path/Frameworks/UFG_lib.xcframework/ios-arm64_x86_64-simulator/UFG_lib.framework/UFG_lib")
+    }
+  end
+
+  alias set_nmg_capabilities set_mobile_capabilities
+
+  def use_system_screenshot(value = true)
+    self.screenshot_mode = !value ? 'applitools-lib' : 'default'
+    self
+  end
+
   private
 
   def viewport_screenshot

data/lib/applitools/core/classic_runner.rb

@@ -31,9 +31,7 @@ module Applitools
       end
       # return all_test_results unless all_test_results.empty?
       all_universal_results = close_all_eyes
-      test_result_summary = Applitools::TestResultSummary.new(all_universal_results).old_style_results_array
-      return [] if test_result_summary.reject { |tr| tr.aborted? }.empty?
-      test_result_summary
+      Applitools::TestResultSummary.new(all_universal_results)
     end
 
     def rendering_info(connector)

data/lib/applitools/core/eyes_base.rb

@@ -213,10 +213,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

data/lib/applitools/core/eyes_base_configuration.rb

@@ -126,6 +126,7 @@ module Applitools
     boolean_field :enable_cross_origin_rendering
     boolean_field :dont_use_cookies
     boolean_field :dont_close_batches
+    string_field :screenshot_mode
 
     methods_to_delegate.delete(:batch_info)
     methods_to_delegate.delete(:batch_info=)
@@ -206,7 +207,9 @@ 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] = value if value === true || value === false
+      config_hash[:layout_breakpoints] = value if value.is_a?(Array) && value.all? {|v| v.is_a?(Numeric)}
+      config_hash[:layout_breakpoints] = value if value.is_a?(Hash)
     end
     def layout_breakpoints
       config_hash[:layout_breakpoints]

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,12 @@ 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 = {})
+      @renderer = Applitools::Utils.deep_stringify_keys(Applitools::Utils.underscore_hash_keys(init_results[:renderer]))
+      @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 +33,10 @@ module Applitools
       @url = results.fetch('url', nil)
     end
 
+    def test_results
+      self
+    end
+
     def passed?
       status == 'Passed'
     end
@@ -51,7 +58,7 @@ module Applitools
     end
 
     def aborted?
-      original_results['isAborted']
+      original_results['isAborted'] || !errors.nil?
     end
 
     def api_session_url
@@ -66,6 +73,10 @@ module Applitools
       original_results['name']
     end
 
+    def errors
+      original_results['error']
+    end
+
     def session_accessibility_status
       @accessibility_status ||= original_results['accessibilityStatus'] && AccessibilityStatus.new(original_results['accessibilityStatus'] || {})
     end

data/lib/applitools/core/universal_eyes_open.rb

@@ -61,6 +61,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 +73,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/universal_sdk/universal_check_settings.rb

@@ -95,6 +95,8 @@ module Applitools
                 # :locationInView,
                 # :fullViewSize
 
+    json_fields :screenshotMode
+
     def initialize(*args)
       options = Applitools::Utils.extract_options! args
       options.keys.select {|k| options[k] && respond_to?("#{k}=") }.each {|k| send("#{k}=", options[k]) }
@@ -119,6 +121,7 @@ module Applitools
 
       self.accessibility_settings = eyes.accessibility_validation
       self.disable_browser_fetching = eyes.dont_fetch_resources
+      self.screenshot_mode = eyes.screenshot_mode
 
       self.accessibility_regions = target.accessibility_regions
       self.content_regions = target.content_regions

data/lib/applitools/universal_sdk/universal_client.rb

@@ -16,7 +16,7 @@ module Applitools::Connectivity
     extend Forwardable
     def_delegators 'Applitools::EyesLogger', :logger
 
-    CORE_MAKE_EC_CLIENT = 'Core.makeECClient'
+    CORE_GET_EC_CLIENT = 'Core.getECClient'
     SESSION_INIT = 'Core.makeCore'
 
     CORE_MAKE_MANAGER = 'Core.makeManager'
@@ -57,7 +57,7 @@ module Applitools::Connectivity
       # ECClientSettings
       #
       # {
-      #   "capabilities": { // default capabilities that will be used if user do not provide `applitools:` caps
+      #   "options": { // default options that will be used if user do not provide `applitools:` caps
       #     "serverUrl": "https://eyesapi.applitools.com/",
       #     "apiKey": "DFH$HJD%77333J355",
       #   },
@@ -71,17 +71,17 @@ module Applitools::Connectivity
       ec_client_capabilities[:serverUrl] = server_url unless server_url.nil?
       ec_client_capabilities[:apiKey] = api_key unless api_key.nil?
       ec_client_settings = {}
-      ec_client_settings[:capabilities] = ec_client_capabilities unless ec_client_capabilities.empty?
+      ec_client_settings[:options] = ec_client_capabilities unless ec_client_capabilities.empty?
       ec_client_settings[:proxy] = proxy unless proxy.nil?
       make_ec_client_request_payload = {settings: ec_client_settings}
-      # interface MakeECClientRequestPayload {
+      # interface GetECClientRequestPayload {
       #   settings?: ECClientSettings
       # }
       #
-      # interface MakeECClientResponsePayload {
+      # interface GetECClientResponsePayload {
       #   url: string
       # }
-      command_with_result(CORE_MAKE_EC_CLIENT, make_ec_client_request_payload)
+      command_with_result(CORE_GET_EC_CLIENT, make_ec_client_request_payload)
     end
 
     def make_manager(eyes_manager_config)
@@ -95,9 +95,13 @@ module Applitools::Connectivity
     def core_make_manager(eyes_manager_config)
       # interface MakeManagerRequestPayload {
       #   type: 'ufg' | 'classic'
-      #   concurrency?: number
-      #   legacyConcurrency?: number
-      #   agentId?: string
+      #   settings?: EyesManagerSettings
+      # }
+      # ### EyesManagerSettings
+      # {
+      #   "concurrency": 10,
+      #   "legacyConcurrency": 50,
+      #   "agentId": "js/eyes/1.0.0"
       # }
       #
       # type MakeManagerResponsePayload = Ref<EyesManager>

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_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/applitools/universal_sdk/universal_eyes_manager_config.rb

@@ -4,11 +4,11 @@ module Applitools
   class UniversalEyesManagerConfig
 
     def self.classic
-      new(type: CLASSIC)
+      new(type: CLASSIC, runner_agent_id: "eyes.classic.ruby/#{Applitools::VERSION}")
     end
 
     def self.vg(concurrent_open_sessions=1)
-      new(type: VG, concurrency: concurrent_open_sessions, legacy: false)
+      new(type: VG, concurrency: concurrent_open_sessions, legacy: false, runner_agent_id: "eyes.visualgrid.ruby/#{Applitools::VERSION}")
     end
 
     # export type EyesManagerConfig<TType extends 'vg' | 'classic' = 'vg' | 'classic'> = {
@@ -16,7 +16,7 @@ module Applitools
     #   concurrency?: TType extends 'vg' ? number : never
     #   legacy?: TType extends 'vg' ? boolean : never
     # }
-    attr_reader :type, :concurrency, :legacy
+    attr_reader :type, :concurrency, :legacy, :runner_agent_id
 
     VG = 'ufg'.freeze
     CLASSIC = 'classic'.freeze
@@ -29,6 +29,7 @@ module Applitools
       self.type = options[:type].to_s
       self.concurrency = options[:concurrency]
       self.legacy = options[:legacy]
+      @runner_agent_id = options[:runner_agent_id]
     end
 
     # enum_field :type, Applitools::UniversalEyesManagerConfig.type_enum_values
@@ -52,8 +53,10 @@ module Applitools
     def to_hash
       result = {}
       result[:type] = type
-      result[:concurrency] = concurrency if concurrency
-      result[:legacy] = legacy if legacy
+      result[:settings] = {}
+      result[:settings][:concurrency] = concurrency if concurrency
+      result[:settings][:legacyConcurrency] = legacy if legacy
+      result[:settings][:agentId] = runner_agent_id
       result.compact
     end
 

data/lib/applitools/version.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: false
 
 module Applitools
-  VERSION = '4.6.2'.freeze
-  IMAGES_VERSION = '4.2.2'.freeze
-  UNIVERSAL_VERSION = '3.3.2'.freeze
-  UNIVERSAL_CORE_VERSION = '2.5.8'.freeze
+  VERSION = '5.0.0'.freeze
+  IMAGES_VERSION = '5.0.0'.freeze
+  UNIVERSAL_VERSION = '3.6.0'.freeze
+  UNIVERSAL_CORE_VERSION = '3.6.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eyes_core
 version: !ruby/object:Gem::Version
-  version: 4.6.2
+  version: 5.0.0
 platform: ruby
 authors:
 - Applitools Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-10 00:00:00.000000000 Z
+date: 2023-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.2
+        version: 3.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.2
+        version: 3.6.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement