eyes_core 3.14.0 → 3.14.1

data/lib/applitools/calabash/os_versions.rb

@@ -0,0 +1,23 @@
+module Applitools
+  module Calabash
+    module OsVersions
+      module Android
+        extend self
+        API_TO_NAME = {
+          4 => 'Android 1',
+          10 => 'Android 2',
+          13 => 'Android 3',
+          20 => 'Android 4',
+          22 => 'Android 5',
+          23 => 'Android 6',
+          25 => 'Android 7',
+          27 => 'Android 8'
+        }.freeze
+
+        def os_version(api_level)
+          API_TO_NAME[API_TO_NAME.keys.select { |v| api_level.to_i >= v }.last] || 'Android'
+        end
+      end
+    end
+  end
+end

data/lib/applitools/calabash/rspec_matchers.rb

@@ -0,0 +1,22 @@
+require 'rspec/expectations'
+
+RSpec::Matchers.define :match_baseline do |expected|
+  match do |actual|
+    result = Applitools::Calabash::EyesSettings.instance.eyes.check(expected, actual)
+    result.as_expected?
+  end
+
+  failure_message do |_actual|
+    "expected #{expected} to match a baseline"
+  end
+end
+
+RSpec::Matchers.define :be_success do
+  match do |actual|
+    actual.as_expected? == true
+  end
+
+  failure_message do |actual|
+    "Expected eyes session to be successful, but mismatches occur. \n#{actual}"
+  end
+end

data/lib/applitools/calabash/steps/android_eyes_session.rb

@@ -0,0 +1,35 @@
+Then(/^set OS$/) do
+  sdk_version = begin
+                  perform_action('android_sdk_version')
+                rescue HTTPClient::KeepAliveDisconnected
+                  reinstall_apps
+                  start_test_server_in_background
+                  perform_action('android_sdk_version')
+                end
+  if sdk_version['success']
+    Applitools::Calabash::EyesSettings.instance.eyes.host_os = Applitools::Calabash::OsVersions::Android.os_version(
+      sdk_version['message']
+    )
+  end
+end
+
+Then(/^set device pixel ratio$/) do
+  display_info = `#{default_device.adb_command} shell dumpsys display`
+  # size_match = /deviceWidth=(?<width>\d+), deviceHeight=(?<height>\d+)/.match(display_info)
+  density_match = /DisplayDeviceInfo.*density (?<density>\d+)/.match(display_info)
+  Applitools::Calabash::EyesSettings.instance.eyes.device_pixel_ratio = density_match[:density].to_i
+end
+
+Then(/^set device physical size$/) do
+  result = /mDefaultViewport=.*deviceWidth=(?<width>\d+).*deviceHeight=(?<height>\d+).*\n/.match(
+    `#{default_device.adb_command} shell dumpsys display |grep mDefaultViewport`
+  )
+  step %(eyes viewport size is "#{result[:width].to_i}x#{result[:height].to_i}")
+end
+
+Then(/^set device size$/) do
+  result = /^.*app=(?<width>\d+)x(?<height>\d+)/.match(
+    `#{default_device.adb_command} shell dumpsys window displays |grep cur | tr -d ' '`
+  )
+  step %(eyes viewport size is "#{result[:width].to_i}x#{result[:height].to_i}")
+end

data/lib/applitools/calabash/steps/android_matchers.rb

@@ -0,0 +1,34 @@
+Then(/^ignore status bar$/) do
+  raise Applitools::EyesError, '@target is not set' unless @target
+  step %(query element "view id:'statusBarBackground'")
+  @target.ignore @current_element if @current_element
+end
+
+Then(/^remove status bar$/) do
+  raise Applitools::EyesError, '@target is not set' unless @target
+  step %(query element "view id:'statusBarBackground'")
+  if @current_element
+    viewport_size = Applitools::RectangleSize.from_any_argument(
+      Applitools::Calabash::EyesSettings.instance.viewport_size
+    )
+    region_location = Applitools::Location.new(0, @current_element.size.height)
+    @target.region(Applitools::Region.from_location_size(region_location, viewport_size))
+  end
+end
+
+Then(/^the whole screen should match a baseline/) do
+  step %(create target)
+  step %(remove status bar)
+  step %(target should match a baseline)
+end
+
+Then(/^query element "([^"]*)" and take (\d+)$/) do |query, index|
+  @current_element = nil
+  @current_element = Applitools::Calabash::Utils.get_android_element(self, query, index)
+end
+
+Then(/^check for scrollable$/) do
+  unless query('ScrollView').empty?
+    @present_scrollable = Applitools::Calabash::Utils.get_android_element(self, 'ScrollView', 0)
+  end
+end

data/lib/applitools/calabash/steps/eyes_session.rb

@@ -0,0 +1,40 @@
+Then(/^create eyes$/) do
+  eyes_settings = Applitools::Calabash::EyesSettings.instance
+  eyes_settings.eyes ||= Applitools::Calabash::Eyes.new.tap do |eyes|
+    eyes.api_key = eyes_settings.applitools_api_key
+    log_file_path = File.join(eyes_settings.log_prefix, eyes_settings.log_file)
+    eyes.log_handler = Logger.new(File.new(log_file_path, 'w+'))
+  end
+
+  unless eyes_settings.eyes.open?
+    step %(set batch "#{@before_hook_scenario.feature.name}")
+    step %(set OS)
+    step %(set device pixel ratio)
+    step %(set device size)
+  end
+end
+
+Then(/^open eyes$/) do
+  eyes_settings = Applitools::Calabash::EyesSettings.instance
+  eyes_settings.eyes.open eyes_settings.options_for_open unless eyes_settings.eyes.open?
+end
+
+When(/^I close eyes session$/) do
+  @test_result = Applitools::Calabash::EyesSettings.instance.eyes.close(false)
+end
+
+Then(/^test result should be positive$/) do
+  raise Applitools::EyesError, 'Test result are not present!' unless @test_result
+  expect(@test_result).to be_success
+end
+
+Then(/^applitools link should be reported$/) do
+  puts @test_result
+end
+
+Then(/^terminate eyes session$/) do
+  step %(I close eyes session)
+  step %(test result should be positive)
+  step %(applitools link should be reported)
+  @test_results = nil
+end

data/lib/applitools/calabash/steps/eyes_settings.rb

@@ -0,0 +1,57 @@
+Given(/^eyes application name is "([^"]*)"$/) do |name|
+  Applitools::Calabash::EyesSettings.instance.app_name = name
+end
+
+Given(/^eyes test name is "([^"]*)"$/) do |name|
+  Applitools::Calabash::EyesSettings.instance.test_name = name
+end
+
+Given(/^eyes viewport size is "([^"]*)"$/) do |size|
+  Applitools::Calabash::EyesSettings.instance.viewport_size = Applitools::RectangleSize.from_any_argument(size).to_h
+end
+
+Given(/^eyes API key "([^"]*)"$/) do |key|
+  Applitools::Calabash::EyesSettings.instance.applitools_api_key = key
+end
+
+Given(/^eyes tag is "([^"]*)"$/) do |tag|
+  @tag = tag
+end
+
+Given(/^set batch "([^"]*)"/) do |name|
+  @current_batch ||= Applitools::Calabash::EyesSettings.instance.eyes.batch.tap do |batch|
+    batch.name = name
+  end
+
+  Applitools::Calabash::EyesSettings.instance.eyes.batch = @current_batch
+end
+
+Given(/^calabash screenshot dir is "([^"]*)"$/) do |path|
+  Applitools::Calabash::EyesSettings.instance.screenshot_dir = path
+end
+
+Given(/^calabash temp dir is "([^"]*)"$/) do |path|
+  Applitools::Calabash::EyesSettings.instance.tmp_dir = path
+end
+
+Given(/^calabash log path is "([^"]*)"$/) do |path|
+  Applitools::Calabash::EyesSettings.instance.log_dir = path
+end
+
+Given(/^eyes logfile is "([^"]*)"$/) do |logfile_path|
+  Applitools::Calabash::EyesSettings.instance.log_file = logfile_path
+end
+
+Given(/^clear directories$/) do
+  Applitools::Calabash::Utils.clear_directories(Applitools::Calabash::EyesSettings.instance)
+end
+
+Given(/^create directories$/) do
+  Applitools::Calabash::Utils.create_directories(Applitools::Calabash::EyesSettings.instance)
+end
+
+Given(/^set it up$/) do
+  step %(clear directories)
+  step %(create directories)
+  Applitools::Calabash::EyesSettings.instance.needs_setting_up = false
+end

data/lib/applitools/calabash/steps/ios_eyes_session.rb

@@ -0,0 +1,13 @@
+Then(/^set OS$/) do
+  Applitools::Calabash::EyesSettings.instance.eyes.host_os = "iOS #{default_device.ios_major_version}"
+end
+
+Then(/^set device pixel ratio$/) do
+  dimensions = default_device.screen_dimensions
+  Applitools::Calabash::EyesSettings.instance.eyes.device_pixel_ratio = dimensions[:scale] #:native_scale?
+end
+
+Then(/^set device size$/) do
+  dimensions = default_device.screen_dimensions
+  step %(eyes viewport size is "#{dimensions[:width].to_i}x#{dimensions[:height].to_i}")
+end

data/lib/applitools/calabash/steps/ios_matchers.rb

@@ -0,0 +1,15 @@
+Then(/^the whole screen should match a baseline/) do
+  step %(create target)
+  step %(target should match a baseline)
+end
+
+Then(/^query element "([^"]*)" and take (\d+)$/) do |query, index|
+  @current_element = nil
+  @current_element = Applitools::Calabash::Utils.get_ios_element(self, query, index)
+end
+
+Then(/^check for scrollable$/) do
+  unless query('UIScrollView').empty?
+    @present_scrollable = Applitools::Calabash::Utils.get_ios_element(self, 'UIScrollView', 0)
+  end
+end

data/lib/applitools/calabash/steps/matchers.rb

@@ -0,0 +1,69 @@
+Then(/^create target$/) do
+  @target = nil
+  @target = Applitools::Calabash::Target.new
+end
+
+Then(/^target should match a baseline$/) do
+  raise Applitools::EyesError, '@target is not set' unless @target
+  @tag ||= ''
+  expect(@target).to match_baseline(@tag)
+end
+
+Then(/^the element "([^"]*)" should match a baseline$/) do |query|
+  step %(create target)
+  step %(query element "#{query}")
+  @target.region(@current_element) if @current_element
+  step %(target should match a baseline)
+end
+
+Then(/^the entire element "([^"]*)" should match a baseline$/) do |query|
+  step %(create target)
+  step %(query element "#{query}")
+  @target.region(@current_element).fully if @current_element
+  step %(target should match a baseline)
+end
+
+Then(/^query element "([^"]*)"$/) do |query|
+  step %(query element "#{query}" and take 0)
+end
+
+Then(/^I check viewport window$/) do
+  step %(the whole screen should match a baseline)
+end
+
+Then(/^I check viewport window with description "([^"]*)"$/) do |description|
+  step %(eyes tag is "#{description}")
+  step %(I check viewport window)
+end
+
+Then(/^I check window$/) do
+  step %(check for scrollable)
+  if @present_scrollable
+    step %(the entire element "#{@present_scrollable.element_query}" should match a baseline)
+  else
+    step %(I check viewport window)
+  end
+end
+
+Then(/^I check window with description "([^"]*)"$/) do |description|
+  step %(eyes tag is "#{description}")
+  step %(I check window)
+end
+
+Then(/^I check viewport element "([^"]*)"$/) do |selector|
+  step %(the element "#{selector}" should match a baseline)
+end
+
+Then(/^I check viewport element "([^"]*)" with description "([^"]*)"$/) do |selector, description|
+  step %(eyes tag is "#{description}")
+  step %(I check viewport element "#{selector}")
+end
+
+Then(/^I check element "([^"]*)"$/) do |selector|
+  step %(the entire element "#{selector}" should match a baseline)
+end
+
+Then(/^I check element "([^"]*)" with description "([^"]*)"$/) do |selector, description|
+  step %(eyes tag is "#{description}")
+  step %(I check element "#{selector}")
+end

data/lib/applitools/calabash/target.rb

@@ -0,0 +1,67 @@
+module Applitools
+  module Calabash
+    class Target
+      include Applitools::FluentInterface
+
+      attr_accessor :options, :ignored_regions, :region_to_check, :floating_regions
+
+      def initialize
+        self.ignored_regions = []
+        self.floating_regions = []
+        self.options = {
+          trim: false
+        }
+      end
+
+      def fully
+        options[:stitch_content] = true
+        self
+      end
+
+      def ignore(region = nil)
+        if region
+          Applitools::ArgumentGuard.is_a? region, 'region', Applitools::Calabash::CalabashElement
+          ignored_regions << region.region
+        else
+          self.ignored_regions = []
+        end
+        self
+      end
+
+      def region(region = nil)
+        if region
+          case region
+          when Applitools::Calabash::CalabashElement, Applitools::Region
+            self.region_to_check = region
+          else
+            self.region_to_check = nil
+            raise(
+              Applitools::EyesIllegalArgument,
+              'Expected region to be instance of Applitools::Calabash::CalabashElement or Applitools::Region'
+            )
+          end
+        else
+          self.region_to_check = nil
+        end
+        self
+      end
+
+      # def floating(*args)
+      #   value = case args.first
+      #             when Applitools::FloatingRegion
+      #               proc { args.first.scale_it!(scale_factor) }
+      #             when Applitools::Region
+      #               proc do
+      #                 region = args.shift
+      #                 region.scale_it!(scale_factor)
+      #                 Applitools::FloatingRegion.new region.left, region.top, region.width, region.height, *args
+      #               end
+      #             else
+      #               self.floating_regions = []
+      #           end
+      #   floating_regions << value
+      #   self
+      # end
+    end
+  end
+end

data/lib/applitools/calabash/utils.rb

@@ -0,0 +1,72 @@
+module Applitools
+  module Calabash
+    module Utils
+      extend self
+
+      def create_directories(eyes_settings)
+        FileUtils.mkpath(
+          File.join(Dir.getwd, eyes_settings.tmp_dir, eyes_settings.screenshot_dir)
+        )
+        FileUtils.mkpath(
+          File.join(Dir.getwd, eyes_settings.log_dir)
+        )
+      end
+
+      def clear_directories(eyes_settings)
+        tmp_dir = File.join Dir.getwd, eyes_settings.tmp_dir
+        log_dir = File.join Dir.getwd, eyes_settings.log_dir
+
+        FileUtils.remove_dir(tmp_dir) if File.exist?(tmp_dir)
+        FileUtils.remove_dir(log_dir) if File.exist?(log_dir)
+      end
+
+      def using_screenshot(context)
+        return unless block_given?
+        screenshot_options = Applitools::Calabash::EyesSettings.instance.screenshot_names.next
+        yield context.screenshot(screenshot_options)
+      end
+
+      def region_from_element(element)
+        region = Applitools::Region.new(
+          element['rect']['x'],
+          element['rect']['y'],
+          element['rect']['width'],
+          element['rect']['height']
+        )
+        return region if Applitools::Calabash::EnvironmentDetector.android?
+        region.scale_it!(Applitools::Calabash::EyesSettings.instance.eyes.density)
+      end
+
+      def request_element(context, element, method)
+        Applitools::ArgumentGuard.is_a?(element, 'element', Applitools::Calabash::CalabashElement)
+        context.query(element.element_query, method)
+      end
+
+      def grub_android_class_name(context, element)
+        request_element(context, element, :class)
+      end
+
+      def grub_ios_class_name(context, element)
+        request_element(context, element, :className)
+      end
+
+      def get_android_element(context, query, index)
+        element_query = if (id = context.query(query, :getId)[index.to_i]) && id > 0
+                          "* id:#{id}"
+                        else
+                          query + " index:#{index.to_i}"
+                        end
+        element = context.query(element_query).first
+        Applitools::Calabash::CalabashElement.new(element, element_query)
+      end
+
+      def get_ios_element(context, query, index)
+        hash = context.query(query, :hash)[index.to_i]
+        return unless hash
+        element_query = "* hash:#{hash}"
+        element = context.query(element_query).first
+        Applitools::Calabash::CalabashElement.new(element, element_query)
+      end
+    end
+  end
+end