eyes_selenium 1.36.0 → 1.37.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MTVkZmRmNjA5MWI2NWVjNzliNTI1NDY5NDJmMmQxYmMyOGNjZWIxNA==
+    ZjM5ZGYyZTdlNDc2YjY4OTgzMDJjZTU4NDQyNGYwYTkwYmNhZDkwMA==
   data.tar.gz: !binary |-
-    ZTdlMmEyNDFjYTllNzk3YjVkMGM2YjE0OGQ3YzliODU4MDk2N2UyNw==
+    MjZmNjJmMDVlYjQ1YTY4NWZkMjNjZWRlYjc1YjViNmE0ZGNiMDhiNw==
 SHA512:
   metadata.gz: !binary |-
-    YTM0MzYyZmMzYzk0MzU1MzBmYTMyZjVhMmIzNmQyMzc0YmY4NDVkZGEyZGFm
-    ZjUwNjhjYzUwMTFlM2ViYzY3YjM3N2M5MjQ0NWIxMGY5ZjBiODZiYjc2NDNl
-    YTcwZDJhNzdlYmJjZGZkMWRmZmEzNjVhZWI4YWRmYTEzMTRkMTQ=
+    MGM5MjBkMWI3YTgwNzRjNjNkOGZjNGIzMTczNTMyNDYxZmEwZDk0MjEyZjZk
+    NDI3NWI5NTJiN2NkOGY0NjA4NjA5MjA4MThmZDA4ODZjN2Y1YWRjNzkyM2M3
+    ODhhOGMxMjgzYTQ4NzYzNjYxNDYyMDg2N2I2NGFjYTg5ZTIxNTk=
   data.tar.gz: !binary |-
-    ZWU2Yjk4YzNlOTZlZDVjNWNjNzA0Njc1ZGI1MjBhODU1MzhmMzI5ODNiNzhj
-    NTUyYWRlNWRiMzQyMmE0MWEzZjRlZWU5NGZiM2NkZTgwYWQxMGE1MzAwZTUx
-    ZjBjN2MzZWIwZWEzMWQ5NGNjODg5ZmFkMzllMDQ0ZDY4NTE1Y2I=
+    ZmMyNzUwZmVmYmMzNzk2YTIzZjc0Yjg3NGMzY2Y0NWJjYTk4ZmM4MGFkMjRk
+    MTgxZDc2MGE3NzMzYzFkY2MzMWUzMTQ3ZjAyMmVmOTI5NWZjMjk2NDA0MzY0
+    NzllZmQyMTg4MGYyNzg1NWM0NGNhYzA5ZGY1ZjBhMGY4NDZmNWI=

data/appium_eyes_example.rb

@@ -1,6 +1,6 @@
 require 'eyes_selenium'
 
-Applitools::Eyes.config[:apikey] = 'YOUR_API_KEY' 
+Applitools::Eyes.api_key = 'YOUR_API_KEY'
 
 ## 
 # Based on Appium example: https://github.com/appium/appium/blob/master/sample-code/examples/ruby/

data/lib/eyes_selenium/eyes/eyes.rb

@@ -5,7 +5,7 @@ class Applitools::Eyes
   DEFAULT_EYES_SERVER = 'https://eyes.applitools.com'
 
   class << self
-    attr_accessor :config, :api_key
+    attr_accessor :api_key
 
     def log_handler=(handler)
       EyesLogger.log_handler = handler
@@ -13,7 +13,6 @@ class Applitools::Eyes
   end
 
   # Class instance variables (static variables)
-  @config = {}
   @api_key = nil
 
   private
@@ -26,10 +25,6 @@ class Applitools::Eyes
   attr_accessor :match_timeout, :batch, :host_os, :host_app, :branch_name, :parent_branch_name, :user_inputs,
                 :save_new_tests, :save_failed_tests
 
-  def config
-    self.class.config
-  end
-
   def api_key
     self.class.api_key
   end
@@ -51,11 +46,6 @@ class Applitools::Eyes
 
     return if disabled?
 
-    # TODO Remove this when possible. Allows setting API key using "config" for backwards compatibility.
-    self.class.api_key ||= config[:apikey]
-
-    raise 'Please supply an apikey: Eyes.config[:apikey] = ...' unless api_key
-
     @user_inputs = []
     server_url = params.fetch(:server_url, DEFAULT_EYES_SERVER)
     @agent_connector = Applitools::AgentConnector.new(server_url, AGENT_ID, api_key)
@@ -70,12 +60,20 @@ class Applitools::Eyes
     @driver = get_driver(params)
     return driver if disabled?
 
-    if driver.nil? || !driver.is_a?(Selenium::WebDriver::Driver)
-      raise Applitools::EyesError.new('driver/browser must be a valid Selenium webdriver')
+    if api_key.nil?
+      #noinspection RubyQuotedStringsInspection
+      raise Applitools::EyesError.new("API key not set! Log in to https://applitools.com to obtain your" +
+                                          " API Key and use 'api_key' to set it.")
+    end
+
+    if driver.is_a?(Selenium::WebDriver::Driver)
+      @driver = Applitools::Driver.new(self, {driver: driver})
+    else
+      unless driver.is_a?(Applitools::Driver)
+        raise Applitools::EyesError.new("Driver is not a Selenium::WebDriver::Driver (#{driver.class.name})")
+      end
     end
 
-    @driver = Applitools::Driver.new(self, {driver: driver})
- 
     if open?
       abort_if_not_closed
       msg = 'a test is already running'
@@ -122,41 +120,53 @@ class Applitools::Eyes
     check_region_(Applitools::Region::EMPTY, tag)
   end
 
-  def close
+  def close(raise_ex=true)
     return if disabled?
     @is_open = false
 
     # if there's no running session, the test was never started (never reached checkWindow)
-    return Applitools::TestResults.new if !session
+    if !session
+      EyesLogger.debug 'close(): Server session was not started'
+      EyesLogger.info 'close(): --- Empty test ended.'
+      return Applitools::TestResults.new
+    end
 
     session_results_url = session.url
     new_session = session.new_session?
+    EyesLogger.debug "close(): Ending server session..."
     save = (new_session && save_new_tests) || (!new_session && save_failed_tests)
     results = agent_connector.stop_session(session, false, save)
+    results.is_new = new_session
+    results.url = session_results_url
+    EyesLogger.debug "close(): #{results}"
+
     self.session = nil
+
     if new_session
-      if save
-        instructions = "Test was automatically accepted. You can review it at #{session_results_url}"
-      else
-        instructions = "Please approve the new baseline at #{session_results_url}"
-      end
+      instructions = "Please approve the new baseline at #{session_results_url}"
       EyesLogger.info "--- New test ended.  #{instructions}"
-      message = "' #{session_start_info.scenario_id_or_name} of"\
+      if raise_ex
+        message = "' #{session_start_info.scenario_id_or_name} of"\
                 " #{session_start_info.app_id_or_name}. #{instructions}"
-      raise Applitools::NewTestError.new(message, results)
-    elsif 0 < results.mismatches || 0 < results.missing
-      if save
-        instructions = "Test was automatically accepted. You can review it at #{session_results_url}"
-      else
-        instructions = "Test failed. You can review it at #{session_results_url}"
+        raise Applitools::NewTestError.new(message, results)
+      end
+      return results
+    end
+
+    if !results.is_passed
+      # Test failed
+      EyesLogger.info "--- Failed test ended. See details at #{session_results_url}"
+      if raise_ex
+        message = "'#{session_start_info.scenario_id_or_name}' of"\
+                "#{session_start_info.app_id_or_name}''. see details at #{session_results_url}"
+        raise Applitools::TestFailedError.new(message, results)
       end
-      EyesLogger.info "--- Failed test ended. #{instructions}"
-      message = "' #{session_start_info.scenario_id_or_name} of"\
-                " #{session_start_info.app_id_or_name}'. #{instructions}"
-      raise Applitools::TestFailedError.new(message, results)
+      return results
     end
 
+    # Test passed
     EyesLogger.info "--- Test passed. See details at #{session_results_url}"
+    results
   end
 
   ## Use this method to perform seamless testing with selenium through eyes driver.

data/lib/eyes_selenium/eyes/test_results.rb

@@ -1,6 +1,7 @@
 class Applitools::TestResults
+  attr_accessor :is_new, :url
   attr_reader :steps, :matches, :mismatches, :missing, :exact_matches, :strict_matches,
-              :content_matches, :layout_matches, :none_matches
+              :content_matches, :layout_matches, :none_matches, :is_passed
   def initialize(steps=0, matches=0, mismatches=0, missing=0,
                  exact_matches=0, strict_matches=0, content_matches=0, 
                  layout_matches=0, none_matches=0)
@@ -13,9 +14,19 @@ class Applitools::TestResults
     @content_matches =  content_matches
     @layout_matches =  layout_matches
     @none_matches =  none_matches
+    @is_new = nil
+    @url = nil
+  end
+
+  def is_passed
+    !is_new && mismatches == 0 && missing ==0
   end
 
   def to_s
-    "[ steps: #{steps}, matches: #{matches}, mismatches: #{mismatches}, missing: #{missing} ]"
+    is_new_str = ""
+    unless is_new.nil?
+      is_new_str = is_new ? "New test" : "Existing test"
+    end
+    "#{is_new_str} [ steps: #{steps}, matches: #{matches}, mismatches: #{mismatches}, missing: #{missing} ], URL: #{url}"
   end
 end

data/lib/eyes_selenium/eyes_logger.rb

@@ -32,4 +32,16 @@ module EyesLogger
     @@log_handler.debug(msg)
   end
 
+  def self.open
+    if @@log_handler.respond_to?(:open)
+      @@log_handler.open
+    end
+  end
+
+  def self.close
+    if @@log_handler.respond_to?(:close)
+      @@log_handler.close
+    end
+  end
+
 end

data/lib/eyes_selenium/version.rb

@@ -1,3 +1,3 @@
 module Applitools
-  VERSION = '1.36.0'
+  VERSION = '1.37.0'
 end

data/test_script.rb

@@ -5,7 +5,7 @@
 require 'eyes_selenium'
 require 'logger'
 
-Applitools::Eyes.config[:apikey] = 'YOUR_API_KEY'
+Applitools::Eyes.api_key = 'YOUR_API_KEY'
 Applitools::Eyes.log_handler = Logger.new(STDOUT)
 
 eyes = Applitools::Eyes.new

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eyes_selenium
 version: !ruby/object:Gem::Version
-  version: 1.36.0
+  version: 1.37.0
 platform: ruby
 authors:
 - Applitools team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-03 00:00:00.000000000 Z
+date: 2014-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver