eyes_core 3.18.4 → 4.0.0

data/lib/applitools/universal_sdk/universal_eyes_manager.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# require_relative 'universal_eyes'
+
+module Applitools
+  class UniversalEyesManager
+
+    extend Forwardable
+    def_delegators 'Applitools::EyesLogger', :logger
+
+    def initialize(manager, universal_client)
+      @manager = manager
+      @universal_client = universal_client
+    end
+
+    def open_eyes(driver_config_json, config)
+      # Applitools::EyesLogger.logger.debug "Driver: #{driver_config_json}"
+      # Applitools::EyesLogger.logger.debug "open config: #{config}"
+
+      @eyes = @universal_client.eyes_manager_make_eyes(@manager, driver_config_json, config)
+
+      if @eyes[:message] && @eyes[:stack]
+        Applitools::EyesLogger.logger.debug "Eyes not opened: #{@eyes[:message]}"
+        Applitools::EyesLogger.logger.debug "Stack for #{Applitools::Connectivity::UniversalClient::EYES_MANAGER_MAKE_EYES} : #{@eyes[:stack]}"
+        return nil
+      end
+
+      Applitools::EyesLogger.logger.debug "Eyes applitools-ref-id: #{@eyes[:"applitools-ref-id"]}"
+      # U-Notes : !!! Eyes.new
+      Applitools::UniversalEyes.new(@eyes, @universal_client)
+    end
+
+    def close_all_eyes
+      @universal_client.eyes_manager_close_all_eyes(@manager)
+    end
+
+  end
+
+end
+# U-Notes : Added internal Applitools::UniversalEyesManager

data/lib/applitools/universal_sdk/universal_eyes_manager_config.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Applitools
+  class UniversalEyesManagerConfig
+
+    def self.classic
+      new(type: CLASSIC)
+    end
+
+    def self.vg(concurrent_open_sessions=1)
+      new(type: VG, concurrency: concurrent_open_sessions, legacy: false)
+    end
+
+    # export type EyesManagerConfig<TType extends 'vg' | 'classic' = 'vg' | 'classic'> = {
+    #   type: TType
+    #   concurrency?: TType extends 'vg' ? number : never
+    #   legacy?: TType extends 'vg' ? boolean : never
+    # }
+    attr_reader :type, :concurrency, :legacy
+
+    VG = 'vg'.freeze
+    CLASSIC = 'classic'.freeze
+    def type_enum_values
+      [VG, CLASSIC]
+    end
+
+    def initialize(*args)
+      options = Applitools::Utils.extract_options!(args)
+      self.type = options[:type].to_s
+      self.concurrency = options[:concurrency]
+      self.legacy = options[:legacy]
+    end
+
+    # enum_field :type, Applitools::UniversalEyesManagerConfig.type_enum_values
+    def type=(value)
+      available_values_array = type_enum_values
+      unless available_values_array.include? value
+        msg = "Unknown type #{value}. Allowed type values: #{available_values_array.join(', ')}"
+        raise(Applitools::EyesIllegalArgument, msg)
+      end
+      @type = value
+    end
+
+    def concurrency=(value)
+      @concurrency = value.to_i if type == VG
+    end
+
+    def legacy=(value)
+      @legacy = !!value if type == VG
+    end
+
+    def to_hash
+      result = {}
+      result[:type] = type
+      result[:concurrency] = concurrency if concurrency
+      result[:legacy] = legacy if legacy
+      result.compact
+    end
+
+  end
+end
+# U-Notes : Added internal Applitools::UniversalEyesManagerConfig

data/lib/applitools/universal_sdk/universal_server.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require 'open-uri'
+require 'digest'
+require 'fileutils'
+
+module Applitools::Connectivity
+  module UniversalServer
+    extend self
+
+    DEFAULT_SERVER_IP = '127.0.0.1'
+    DEFAULT_SERVER_PORT = 21077
+
+    def run
+      raise 'Universal server unrecognized' unless find_server_file?
+      pid = spawn(filepath, '--singleton --lazy', [:out, :err] => ["log", 'w'])
+      Process.detach(pid)
+    end
+
+    def confirm_is_up(ip, port, attempt = 1)
+      raise 'Universal server unavailable' if (attempt === 16)
+      begin
+        TCPSocket.new(ip, port)
+      rescue Errno::ECONNREFUSED
+        sleep 1
+        confirm_is_up(ip, port, attempt + 1)
+      end
+    end
+
+    def check_or_run(ip = DEFAULT_SERVER_IP, port = DEFAULT_SERVER_PORT)
+      server_uri = "#{ip}:#{port}"
+      socket_uri = "ws://#{server_uri}/eyes"
+      begin
+        TCPSocket.new(ip, port)
+        msg = "Connect to #{server_uri}"
+      rescue Errno::ECONNREFUSED
+        run
+        confirm_is_up(ip, port)
+        msg = "Connect to #{server_libname} : #{filename}"
+      end
+
+      Applitools::EyesLogger.logger.debug(msg) if ENV['APPLITOOLS_SHOW_LOGS']
+      socket_uri
+    end
+
+    private
+
+    def filename
+      case RUBY_PLATFORM
+        when /mswin|windows/i
+          'eyes-universal-win.exe'
+        when /linux|arch/i
+          'eyes-universal-linux'
+        when /darwin/i
+          'eyes-universal-macos'
+        else
+          raise 'Unsupported platform'
+      end
+    end
+
+    def server_libname
+      'eyes_universal'
+    end
+
+    def server_lib
+      Gem::Specification.find_by_name(server_libname)
+    rescue Gem::MissingSpecError
+      nil
+    end
+
+    def filepath
+      server_lib ? File.join(server_lib.gem_dir, 'ext', 'eyes-universal', filename) : ''
+    end
+
+    def find_server_file?
+      File.exist?(filepath) && File.executable?(filepath)
+    end
+
+  end
+end
+# U-Notes : Added internal Applitools::Connectivity::UniversalServer

data/lib/applitools/utils/utils.rb

@@ -84,6 +84,19 @@ module Applitools::Utils
     end
   end
 
+  def deep_stringify_keys(value)
+    case value
+      when Hash
+        value.each_with_object({}) do |(key, val), result|
+          result[key.to_s] = deep_stringify_keys(val)
+        end
+      when Array
+        value.map { |e| deep_stringify_keys(e) }
+      else
+        value
+    end
+  end
+
   private
 
   def convert_hash_keys(value, method)

data/lib/applitools/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: false
 
 module Applitools
-  VERSION = '3.18.4'.freeze
+  VERSION = '4.0.0'.freeze
+  UNIVERSAL_VERSION = '1.0.6'.freeze
 end

data/lib/eyes_core.rb

@@ -31,6 +31,8 @@ module Applitools
   # @!visibility private
   class UnknownNetworkStackError < EyesError; end
 
+  class NotUniversalServerRequestError < EyesError; end
+
   # @!visibility private
   class AbstractMethodCalled < EyesError
     attr_accessor :method_name, :object
@@ -68,5 +70,6 @@ require_relative 'applitools/chunky_png_patch'
 Applitools.require_dir 'utils'
 Applitools.require_dir 'core'
 Applitools.require_dir 'connectivity'
+Applitools.require_dir 'universal_sdk'
 
 require_relative 'applitools/eyes_logger'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eyes_core
 version: !ruby/object:Gem::Version
-  version: 3.18.4
+  version: 4.0.0
 platform: ruby
 authors:
 - Applitools Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-31 00:00:00.000000000 Z
+date: 2022-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oily_png
@@ -94,6 +94,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faye-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: eyes_universal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.6
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -352,11 +408,22 @@ files:
 - lib/applitools/core/test_results.rb
 - lib/applitools/core/text_trigger.rb
 - lib/applitools/core/trigger.rb
+- lib/applitools/core/universal_eyes_checks.rb
+- lib/applitools/core/universal_eyes_open.rb
+- lib/applitools/core/universal_new_api.rb
 - lib/applitools/extensions.rb
 - lib/applitools/eyes_logger.rb
 - lib/applitools/method_tracer.rb
 - lib/applitools/rspec/target_matcher.rb
 - lib/applitools/sauce.rb
+- lib/applitools/universal_sdk/universal_check_settings.rb
+- lib/applitools/universal_sdk/universal_client.rb
+- lib/applitools/universal_sdk/universal_client_socket.rb
+- lib/applitools/universal_sdk/universal_eyes.rb
+- lib/applitools/universal_sdk/universal_eyes_config.rb
+- lib/applitools/universal_sdk/universal_eyes_manager.rb
+- lib/applitools/universal_sdk/universal_eyes_manager_config.rb
+- lib/applitools/universal_sdk/universal_server.rb
 - lib/applitools/utils/eyes_selenium_utils.rb
 - lib/applitools/utils/image_delta_compressor.rb
 - lib/applitools/utils/image_utils.rb