eyes_selenium 1.25.0 → 1.26.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YjUxOTYxOWFiOTBjZGJiNzk1MzA3YzU2YWY5M2ExZWU3MGFiMzczMg==
+    ODUwYjE0ZmI1ODE3ZjNiZTFlODMwOGNlNGRjODJlMmUyOTBmMzQzZg==
   data.tar.gz: !binary |-
-    NTFlOThmMjM1MmM5MzE5M2IyMWJjMzM5ODQ1MWQ2ZDY0MmZjODEyYw==
+    NmI0YjkyYWRhMmQ5NTMxY2NkZWNhZDc1YTc0ZDJiNjBlMDk5NWM1NA==
 SHA512:
   metadata.gz: !binary |-
-    ZGNiOGIyODhiZDM0MjA5ZDZhMDZjY2ZjNzIzYTQwNzdiYWZlYjk0OTZhYWVk
-    NDE2NjM1YmVjMmFmYmU4MjJhZDEyZTY5ZjNkZTUzZTFmMmUwMGI1ZDZkNjgw
-    NmI4MTk4MmM4ODlhNGFiYzNhZmVlYWYyNmYwZTVlMjEzMzIxYmM=
+    OThkYjg4YTZkZDhhMTRhODE2MTk2Y2VlOGM2Zjk3NTk3NDYxOTA1N2MwODZj
+    OWZkN2QwMDIwMzcyYmU5MGQ1YjgwMThjMzg5ZGU4ZDI1MGE2ZGVhY2QxYTFk
+    YjEzMmQ2NDcyZWUzNjIzMzI2ODUxOTNmZjAxOTA4MTg1ZDkwNTk=
   data.tar.gz: !binary |-
-    NjJlYTgxZGU3NTVkYzZmMzQ0MTc2YjY4NDY2MGZmNzhiMzJhODRkYzU4MDE5
-    NjU4YzliOWVmZTAxYTkxZGJkZjkzMGQ5YTA3OTVkMWFhZjkwYmVkNWZkYzI3
-    ODRlOWJlMWYwZGViZGFmMGQ1N2ZjZTBiMjAwMjM5NDZlODkzOTk=
+    YzcwZDA5MzZhOTRkYWUxYmRmNmQ5ZDdjMThiNTU0YmM3ODVkYWQxMGZmZGUz
+    MmVmZTczODhmOTExZTU1YzEyOTQ5NDliOTg4ZWUzZDBkZTM3YzM5YThiNWVk
+    YmFlY2M4OWNjOWQ1ZDY3NzM5MTgxZTA0MTg1MDkwY2Y5ZWUwMzA=

data/lib/eyes_selenium/eyes/agent_connector.rb

@@ -15,7 +15,7 @@ class Applitools::AgentConnector
 
   def match_window(session, data)
     self.class.headers 'Content-Type' => 'application/octet-stream'
-    json_data = data.to_hash.to_json.encode('UTF-8') # Notice that this does not include the screenshot
+    json_data = data.to_hash.to_json.encode('BINARY') # Notice that this does not include the screenshot
     body = [json_data.length].pack('L>') + json_data + data.screenshot
 
     res = self.class.post(uri + "/#{session.id}",basic_auth: auth, body: body)

data/lib/eyes_selenium/eyes/driver.rb

@@ -74,7 +74,7 @@ class  Applitools::Driver
   def user_agent
     execute_script 'return navigator.userAgent'
   rescue => e
-    puts "getUserAgent(): Failed to obtain user-agent string (#{e.message})"
+    EyesLogger.info "getUserAgent(): Failed to obtain user-agent string (#{e.message})"
   end
 
   private

data/lib/eyes_selenium/eyes/eyes.rb

@@ -100,25 +100,16 @@ class Applitools::Eyes
     user_inputs.clear
   end
 
-  def check_window(tag=nil)
-    return if disabled?
-    raise Applitools::EyesError.new('Eyes not open') if !open?
-    unless session
-      start_session
-      self.match_window_task = Applitools::MatchWindowTask.new(self, agent_connector, session, driver, match_timeout)
-    end
+  def check_region(how, what, tag=nil)
+    element_to_check = driver.find_element(how, what)
+    location = element_to_check.location
+    size = element_to_check.size
+    region = Applitools::Region.new(location.x, location.y, size.width, size.height)
+    check_region_(region, tag)
+  end
 
-    as_expected = match_window_task.match_window(tag, should_match_window_run_once_on_timeout)
-    unless as_expected
-      self.should_match_window_run_once_on_timeout = true
-      unless session.new_session?
-        EyesLogger.info %( "mismatch #{ tag ? '' : "(#{tag})" } )
-        if failure_reports.to_i == Applitools::FailureReports::IMMEDIATE
-          raise Applitools::TestFailedError.new("Mismatch found in '#{session_start_info.scenario_id_or_name}'"\
-                                                " of '#{session_start_info.app_id_or_name}'")
-        end
-      end
-    end
+  def check_window(tag=nil)
+    check_region_(Applitools::Region::EMPTY, tag)
   end
 
   def close
@@ -238,4 +229,27 @@ class Applitools::Eyes
         @viewport_size =  Applitools::ViewportSize.new(driver).extract_viewport_from_browser!
       end
     end
+
+  def check_region_(region, tag=nil)
+    return if disabled?
+    raise Applitools::EyesError.new('region cannot be nil!') if region.nil?
+    raise Applitools::EyesError.new('Eyes not open') if !open?
+
+    unless session
+      start_session
+      self.match_window_task = Applitools::MatchWindowTask.new(self, agent_connector, session, driver, match_timeout)
+    end
+
+    as_expected = match_window_task.match_window(region, tag, should_match_window_run_once_on_timeout)
+    unless as_expected
+      self.should_match_window_run_once_on_timeout = true
+      unless session.new_session?
+        EyesLogger.info %( "mismatch #{ tag ? '' : "(#{tag})" } )
+        if failure_reports.to_i == Applitools::FailureReports::IMMEDIATE
+          raise Applitools::TestFailedError.new("Mismatch found in '#{session_start_info.scenario_id_or_name}'"\
+                                                " of '#{session_start_info.app_id_or_name}'")
+        end
+      end
+    end
+  end
 end

data/lib/eyes_selenium/eyes/match_window_task.rb

@@ -7,7 +7,7 @@ class Applitools::MatchWindowTask
   MATCH_INTERVAL = 0.5
   AppOutput = Struct.new(:title, :screenshot64)
 
-  attr_reader :eyes, :agent_connector, :session, :driver, :max_window_load_time
+  attr_reader :eyes, :agent_connector, :session, :driver, :max_window_load_time, :last_checked_window ,:last_screenshot_bounds
 
   public
   ## max_load_time: maximum wait time for check window, in seconds
@@ -18,65 +18,94 @@ class Applitools::MatchWindowTask
     @driver = driver
     @max_window_load_time = max_window_load_time
     @last_checked_window = nil # +ChunkyPNG::Canvas+
+    @last_screenshot_bounds = Applitools::Region::EMPTY # +Applitools::Region+
     @current_screenshot = nil # +ChunkyPNG::Canvas+
   end
 
-  def match_window(tag,run_once_after_wait=false)
+  def match_window(region, tag,run_once_after_wait=false)
     res = if max_window_load_time.zero?
-      run(tag)
-    elsif run_once_after_wait
-      run(tag, max_window_load_time)
-    else
-      run_with_intervals(tag, max_window_load_time)
-    end
+            run(region, tag)
+          elsif run_once_after_wait
+            run(region, tag, max_window_load_time)
+          else
+            run_with_intervals(region, tag, max_window_load_time)
+          end
+    @last_checked_window = @current_screenshot
+    @last_screenshot_bounds = region.empty? ? Applitools::Region.new(0, 0, last_checked_window.width, last_checked_window.height) : region
     #noinspection RubyUnnecessaryReturnStatement
     driver.eyes.clear_user_inputs and return res
   end
 
-  def run(tag, wait_before_run=nil)
+  def run(region, tag, wait_before_run=nil)
     sleep(wait_before_run) if wait_before_run
-    match(tag)
+    match(region, tag)
   end
 
-  def run_with_intervals(tag, total_run_time)
+  def run_with_intervals(region, tag, total_run_time)
     start = Time.now
     match_retry = total_run_time
     while match_retry > 0
       sleep(MATCH_INTERVAL)
-      return true if match(tag, true)
+      return true if match(region, tag, true)
       match_retry -= (Time.now - start)
     end
     ## lets try one more time if we still don't have a match
-    match(tag)
+    match(region, tag)
   end
 
   private
 
-    def prep_match_data(tag, ignore_mismatch)
+    def prep_match_data(region, tag, ignore_mismatch)
       title = eyes.title
+      # 'encoded', as in 'png'.
       current_screenshot_encoded = Base64.decode64(driver.screenshot_as(:base64))
       @current_screenshot = ChunkyPNG::Image.from_blob(current_screenshot_encoded)
+      # If a region was defined, we refer to the sub-image defined by the region.
+      unless region.empty?
+        @current_screenshot.crop!(region.left, region.top, region.width, region.height)
+        current_screenshot_encoded = @current_screenshot.to_blob.force_encoding('BINARY')
+      end
       compressed_screenshot = Applitools::Utils::ImageDeltaCompressor.compress_by_raw_blocks(@current_screenshot,
                                                                                   current_screenshot_encoded,
-                                                                                  @last_checked_window)
+                                                                                  last_checked_window)
       app_output = AppOutput.new(title, nil)
       user_inputs = []
-      if @last_checked_window.nil?
-        user_inputs = driver.eyes.user_inputs
-      else
+      if !last_checked_window.nil?
         driver.eyes.user_inputs.each do |trigger|
-          if trigger.is_a? Applitools::MouseTrigger
+          if trigger.is_a?(Applitools::MouseTrigger)
+            updated_trigger = nil
             trigger_left = trigger.control.left + trigger.location.x
             trigger_top = trigger.control.top + trigger.location.y
-            if trigger_left <= @last_checked_window.width && trigger_top <= @last_checked_window.height
-              user_inputs << trigger
+            if last_screenshot_bounds.contains?(trigger_left, trigger_top)
+              trigger.control.intersect(last_screenshot_bounds)
+              if trigger.control.empty?
+                trigger_left = trigger_left - last_screenshot_bounds.left
+                trigger_top = trigger_top -last_screenshot_bounds.top
+                updated_trigger = Applitools::MouseTrigger.new(trigger.mouse_action, trigger.control, Selenium::WebDriver::Point.new(trigger_left, trigger_top))
+              else
+                trigger_left = trigger_left - trigger.control.left
+                trigger_top = trigger_top - trigger.control.top
+                control_left = trigger.control.left - last_screenshot_bounds.left
+                control_top = trigger.control.top - last_screenshot_bounds.top
+                updated_control = Applitools::Region.new(control_left, control_top, trigger.control.width, trigger.control.height)
+                updated_trigger = Applitools::MouseTrigger.new(trigger.mouse_action, updated_control, Selenium::WebDriver::Point.new(trigger_left, trigger_top))
+              end
+              user_inputs << updated_trigger
             else
               EyesLogger.info "Trigger ignored: #{trigger} (out of bounds)"
             end
-          elsif trigger.is_a? Applitools::TextTrigger
-            last_screenshot_bounds = Applitools::Region.new(0, 0, @last_checked_window.width, @last_checked_window.height)
-            if trigger.control.intersecting?last_screenshot_bounds
-              user_inputs << trigger
+          elsif trigger.is_a?(Applitools::TextTrigger)
+            unless trigger.control.empty? 
+              trigger.control.intersect(last_screenshot_bounds)
+              unless trigger.control.empty?
+                control_left = trigger.control.left - last_screenshot_bounds.left
+                control_top = trigger.control.top - last_screenshot_bounds.top
+                updated_control = Applitools::Region.new(control_left, control_top, trigger.control.width, trigger.control.height)
+                updated_trigger = Applitools::TextTrigger.new(trigger.text, updated_control)
+                user_inputs << updated_trigger
+              else 
+                EyesLogger.info "Trigger ignored: #{trigger} (control out of bounds)"
+              end
             else
               EyesLogger.info "Trigger ignored: #{trigger} (out of bounds)"
             end
@@ -84,17 +113,14 @@ class Applitools::MatchWindowTask
             EyesLogger.info "Trigger ignored: #{trigger} (Unrecognized trigger)"
           end
         end
+      else
+        EyesLogger.info 'Triggers ignored: no previous window checked'
       end
       Applitools::MatchWindowData.new(app_output, user_inputs, tag, ignore_mismatch, compressed_screenshot)
     end
 
-    def match(tag, ignore_mismatch=false)
-      data = prep_match_data(tag, ignore_mismatch)
-      as_expected = agent_connector.match_window(session, data)
-      # If the server stored this image, it will be used as a base for our next screenshot compression
-      unless ignore_mismatch
-        @last_checked_window = @current_screenshot
-      end
-      as_expected
+    def match(region, tag, ignore_mismatch=false)
+      data = prep_match_data(region, tag, ignore_mismatch)
+      agent_connector.match_window(session, data)
     end
 end

data/lib/eyes_selenium/eyes/mouse_trigger.rb

@@ -5,14 +5,14 @@ class Applitools::MouseTrigger
   attr_reader :mouse_action, :control, :location
 
   def initialize(mouse_action, control, location)
-    @mouse_action = MOUSE_ACTION[mouse_action]
+    @mouse_action = mouse_action
     @control = control
     @location = location
   end
 
   def to_hash
     {
-      "$type" => "Applitools.Models.MouseTrigger, Core", mouseAction: mouse_action,
+      "$type" => "Applitools.Models.MouseTrigger, Core", mouseAction: MOUSE_ACTION[mouse_action],
       control: control.to_hash, location: Hash[location.each_pair.to_a]
     }
   end

data/lib/eyes_selenium/eyes/region.rb

@@ -49,6 +49,11 @@ class Applitools::Region
     self.height = i_bottom - i_top
   end
 
+  def contains?(other_left, other_top)
+    other_left >= left && other_left <= right && \
+    other_top >= top && other_top <= bottom
+  end
+
   def middle_offset
     mid_x = width / 2
     mid_y = height / 2

data/lib/eyes_selenium/version.rb

@@ -1,3 +1,3 @@
 module Applitools
-  VERSION = '1.25.0'
+  VERSION = '1.26.0'
 end

data/test_script.rb

@@ -14,6 +14,7 @@ begin
   eyes.test(app_name: 'Ruby SDK', test_name: 'Applitools website test', viewport_size: {width: 1024, height: 768}, driver: my_webdriver) do |driver|
     driver.get "http://www.applitools.com"
     eyes.check_window("initial")
+    eyes.check_region(:css, 'li.pricing', 'Pricing button')
     driver.find_element(:css, "li.pricing a").click
     eyes.check_window("pricing page")
     el = driver.find_elements(:css, ".footer-row a").first

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eyes_selenium
 version: !ruby/object:Gem::Version
-  version: 1.25.0
+  version: 1.26.0
 platform: ruby
 authors:
 - Applitools team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-01 00:00:00.000000000 Z
+date: 2014-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver