appium_lib 9.0.0 → 9.1.0

data/lib/appium_lib/device/multi_touch.rb

@@ -26,7 +26,7 @@ module Appium
       # action.perform    #=> to 25% of its size.
       # ```
       def pinch(percentage = 25, auto_perform = true)
-        fail ArgumentError("Can't pinch to greater than screen size.") if percentage > 100
+        raise ArgumentError("Can't pinch to greater than screen size.") if percentage > 100
 
         p = Float(percentage) / 100
 
@@ -62,7 +62,7 @@ module Appium
       # action.perform
       # ```
       def zoom(percentage = 200, auto_perform = true)
-        fail ArgumentError("Can't zoom to smaller then screen size.") if percentage < 100
+        raise ArgumentError("Can't zoom to smaller then screen size.") if percentage < 100
 
         p = 100 / Float(percentage)
         i = 1 - p

data/lib/appium_lib/device/touch_actions.rb

@@ -8,8 +8,8 @@ module Appium
   # action = TouchAction.new.press(x: 45, y: 100).wait(5).release
   # action.perform
   class TouchAction
-    ACTIONS         = [:move_to, :long_press, :double_tap, :two_finger_tap, :press, :release, :tap, :wait, :perform]
-    COMPLEX_ACTIONS = [:swipe]
+    ACTIONS         = [:move_to, :long_press, :double_tap, :two_finger_tap, :press, :release, :tap, :wait, :perform].freeze
+    COMPLEX_ACTIONS = [:swipe].freeze
 
     class << self
       COMPLEX_ACTIONS.each do |action|
@@ -174,11 +174,8 @@ module Appium
     private
 
     def chain_method(method, args = nil)
-      if args
-        @actions << { action: method, options: args }
-      else
-        @actions << { action: method }
-      end
+      action = args ? { action: method, options: args } : { action: method }
+      @actions << action
       self
     end
 

data/lib/appium_lib/driver.rb

@@ -1,7 +1,6 @@
 require 'rubygems'
 require 'ap'
 require 'selenium-webdriver'
-require 'selenium/client/errors' # used in helper.rb for CommandError
 require 'nokogiri'
 
 # common
@@ -10,11 +9,14 @@ require_relative 'common/wait'
 require_relative 'common/patch'
 require_relative 'common/version'
 require_relative 'common/error'
+require_relative 'common/search_context'
+require_relative 'common/command'
 require_relative 'common/element/window'
 
 # ios
 require_relative 'ios/helper'
 require_relative 'ios/patch'
+require_relative 'ios/errors'
 
 require_relative 'ios/element/alert'
 require_relative 'ios/element/button'
@@ -70,11 +72,11 @@ module Appium
   # @param opts [Hash] file: '/path/to/appium.txt', verbose: true
   # @return [hash] the symbolized hash with updated :app and :require keys
   def self.load_settings(opts = {})
-    fail 'opts must be a hash' unless opts.is_a? Hash
-    fail 'opts must not be empty' if opts.empty?
+    raise 'opts must be a hash' unless opts.is_a? Hash
+    raise 'opts must not be empty' if opts.empty?
 
     toml = opts[:file]
-    fail 'Must pass file' unless toml
+    raise 'Must pass file' unless toml
     verbose = opts.fetch :verbose, false
 
     Appium::Logger.info "appium settings path: #{toml}" if verbose
@@ -82,12 +84,14 @@ module Appium
     toml_exists = File.exist? toml
     Appium::Logger.info "Exists? #{toml_exists}" if verbose
 
-    fail "toml doesn't exist #{toml}" unless toml_exists
+    raise "toml doesn't exist #{toml}" unless toml_exists
     require 'tomlrb'
     Appium::Logger.info "Loading #{toml}" if verbose
 
     data = Tomlrb.load_file(toml, symbolize_keys: true)
-    Appium::Logger.ap_info data unless data.empty? if verbose
+    if verbose
+      Appium::Logger.ap_info data unless data.empty?
+    end
 
     if data && data[:caps] && data[:caps][:app] && !data[:caps][:app].empty?
       data[:caps][:app] = Appium::Driver.absolute_app_path data
@@ -102,6 +106,7 @@ module Appium
   end
 
   class << self
+    # rubocop:disable Style/Alias
     alias_method :load_appium_txt, :load_settings
   end
 
@@ -141,7 +146,7 @@ module Appium
   # based on deep_symbolize_keys & deep_transform_keys from rails
   # https://github.com/rails/docrails/blob/a3b1105ada3da64acfa3843b164b14b734456a50/activesupport/lib/active_support/core_ext/hash/keys.rb#L84
   def self.symbolize_keys(hash)
-    fail 'symbolize_keys requires a hash' unless hash.is_a? Hash
+    raise 'symbolize_keys requires a hash' unless hash.is_a? Hash
     result = {}
     hash.each do |key, value|
       key = key.to_sym rescue key # rubocop:disable Style/RescueModifier
@@ -162,7 +167,7 @@ module Appium
   # that module are promoted on.
   # otherwise, the array of modules will be used as the promotion target.
   def self.promote_singleton_appium_methods(modules)
-    fail 'Driver is nil' if $driver.nil?
+    raise 'Driver is nil' if $driver.nil?
 
     target_modules = []
 
@@ -171,12 +176,13 @@ module Appium
         target_modules << modules.const_get(sub_module)
       end
     else
-      fail 'modules must be a module or an array' unless modules.is_a? Array
+      raise 'modules must be a module or an array' unless modules.is_a? Array
       target_modules = modules
     end
 
     target_modules.each do |const|
       # noinspection RubyResolve
+      # rubocop:disable Style/MultilineIfModifier
       $driver.public_methods(false).each do |m|
         const.send(:define_singleton_method, m) do |*args, &block|
           begin
@@ -187,6 +193,7 @@ module Appium
           # override unless there's an existing method with matching arity
         end unless const.respond_to?(m) && const.method(m).arity == $driver.method(m).arity
       end
+      # rubocop:enable Style/MultilineIfModifier
     end
   end
 
@@ -213,7 +220,7 @@ module Appium
   # Appium.promote_appium_methods Minitest::Spec
   # ```
   def self.promote_appium_methods(class_array)
-    fail 'Driver is nil' if $driver.nil?
+    raise 'Driver is nil' if $driver.nil?
     # Wrap single class into an array
     class_array = [class_array] unless class_array.class == Array
     # Promote Appium driver methods to class instance methods.
@@ -239,6 +246,22 @@ module Appium
     nil # return nil
   end
 
+  class Driver
+    module Capabilities
+      # except for browser_name, default capability is equal to ::Selenium::WebDriver::Remote::Capabilities.firefox
+      # Because Selenium::WebDriver::Remote::Bridge uses Capabilities.firefox by default
+      # https://github.com/SeleniumHQ/selenium/blob/selenium-3.0.1/rb/lib/selenium/webdriver/remote/bridge.rb#L67
+      def self.init_caps_for_appium(opts_caps = {})
+        default_caps_opts_firefox = {
+          javascript_enabled: true,
+          takes_screenshot: true,
+          css_selectors_enabled: true
+        }.merge(opts_caps)
+        ::Selenium::WebDriver::Remote::Capabilities.new(default_caps_opts_firefox)
+      end
+    end
+  end
+
   class Driver
     # attr readers are promoted to global scope. To avoid clobbering, they're
     # made available via the driver_attributes method
@@ -302,12 +325,12 @@ module Appium
     def initialize(opts = {})
       # quit last driver
       $driver.driver_quit if $driver
-      fail 'opts must be a hash' unless opts.is_a? Hash
+      raise 'opts must be a hash' unless opts.is_a? Hash
 
       opts              = Appium.symbolize_keys opts
 
-      # default to {} to prevent nil.fetch and other nil errors
-      @caps             = opts[:caps] || {}
+      @caps             = Capabilities.init_caps_for_appium(opts[:caps] || {})
+
       appium_lib_opts   = opts[:appium_lib] || {}
 
       # appium_lib specific values
@@ -327,7 +350,7 @@ module Appium
 
       # Path to the .apk, .app or .app.zip.
       # The path can be local or remote for Sauce.
-      if @caps && @caps[:app] && ! @caps[:app].empty?
+      if @caps && @caps[:app] && !@caps[:app].empty?
         @caps[:app] = self.class.absolute_app_path opts
       end
 
@@ -351,6 +374,9 @@ module Appium
       # apply os specific patches
       patch_webdriver_element
 
+      # for command
+      patch_remote_driver_commands
+
       # enable debug patch
       # !!'constant' == true
       @appium_debug = appium_lib_opts.fetch :debug, !!defined?(Pry)
@@ -370,17 +396,18 @@ module Appium
 
     # Returns a hash of the driver attributes
     def driver_attributes
-      attributes = { caps:             @caps,
-                     custom_url:       @custom_url,
-                     export_session:   @export_session,
-                     default_wait:     @default_wait,
-                     last_waits:       @last_waits,
-                     sauce_username:   @sauce_username,
-                     sauce_access_key: @sauce_access_key,
-                     port:             @appium_port,
-                     device:           @appium_device,
-                     debug:            @appium_debug,
-                     listener:         @listener
+      attributes = {
+          caps:             @caps,
+          custom_url:       @custom_url,
+          export_session:   @export_session,
+          default_wait:     @default_wait,
+          last_waits:       @last_waits,
+          sauce_username:   @sauce_username,
+          sauce_access_key: @sauce_access_key,
+          port:             @appium_port,
+          device:           @appium_device,
+          debug:            @appium_debug,
+          listener:         @listener
       }
 
       # Return duplicates so attributes are immutable
@@ -397,7 +424,7 @@ module Appium
     # Return true if automationName is 'XCUITest'
     # @return [Boolean]
     def automation_name_is_xcuitest?
-      !@automation_name.nil? && @automation_name.downcase == 'xcuitest'
+      !@automation_name.nil? && 'xcuitest'.casecmp(@automation_name).zero?
     end
 
     # Return true if the target Appium server is over REQUIRED_VERSION_XCUITEST.
@@ -405,7 +432,7 @@ module Appium
     # @return [Boolean]
     def check_server_version_xcuitest
       if automation_name_is_xcuitest? && (@appium_server_version['build']['version'] <= REQUIRED_VERSION_XCUITEST)
-        fail Appium::Error::NotSupportedAppiumServer, "XCUITest requires over Appium #{REQUIRED_VERSION_XCUITEST}"
+        raise Appium::Error::NotSupportedAppiumServer, "XCUITest requires over Appium #{REQUIRED_VERSION_XCUITEST}"
       end
       true
     end
@@ -435,33 +462,33 @@ module Appium
     #
     # @return [String] APP_PATH as an absolute path
     def self.absolute_app_path(opts)
-      fail 'opts must be a hash' unless opts.is_a? Hash
+      raise 'opts must be a hash' unless opts.is_a? Hash
       caps            = opts[:caps] || {}
       appium_lib_opts = opts[:appium_lib] || {}
       server_url      = appium_lib_opts.fetch :server_url, false
 
       app_path        = caps[:app]
-      fail 'absolute_app_path invoked and app is not set!' if app_path.nil? || app_path.empty?
+      raise 'absolute_app_path invoked and app is not set!' if app_path.nil? || app_path.empty?
       # may be absolute path to file on remote server.
       # if the file is on the remote server then we can't check if it exists
       return app_path if server_url
       # Sauce storage API. http://saucelabs.com/docs/rest#storage
       return app_path if app_path.start_with? 'sauce-storage:'
-      return app_path if app_path.match(/^http/) # public URL for Sauce
-      if app_path.match(/^(\/|[a-zA-Z]:)/) # absolute file path
+      return app_path if app_path =~ /^http/ # public URL for Sauce
+      if app_path =~ /^(\/|[a-zA-Z]:)/ # absolute file path
         app_path = File.expand_path app_path unless File.exist? app_path
-        fail "App doesn't exist. #{app_path}" unless File.exist? app_path
+        raise "App doesn't exist. #{app_path}" unless File.exist? app_path
         return app_path
       end
 
       # if it doesn't contain a slash then it's a bundle id
-      return app_path unless app_path.match(/[\/\\]/)
+      return app_path unless app_path =~ /[\/\\]/
 
       # relative path that must be expanded.
       # absolute_app_path is called from load_settings
       # and the txt file path is the base of the app path in that case.
       app_path = File.expand_path app_path
-      fail "App doesn't exist #{app_path}" unless File.exist? app_path
+      raise "App doesn't exist #{app_path}" unless File.exist? app_path
       app_path
     end
 
@@ -498,8 +525,9 @@ module Appium
     # @return [void]
     def driver_quit
       # rescue NoSuchDriverError or nil driver
-      # rubocop:disable Style/RescueModifier
-      @driver.quit rescue nil
+      @driver.quit
+    rescue
+      nil
     end
 
     # Creates a new global driver and quits the old one if it exists.
@@ -621,7 +649,7 @@ module Appium
     # @param args [*args] the args to use
     # @return [Array<Element>] Array is empty when no elements are found.
     def find_elements(*args)
-      @driver.find_elements(*args)
+      @driver.find_elements_with_appium(*args)
     end
 
     # Calls @driver.find_elements
@@ -629,7 +657,7 @@ module Appium
     # @param args [*args] the args to use
     # @return [Element]
     def find_element(*args)
-      @driver.find_element(*args)
+      @driver.find_element_with_appium(*args)
     end
 
     # Calls @driver.set_location

data/lib/appium_lib/ios/element/alert.rb

@@ -4,16 +4,16 @@ module Appium
     # @return [void]
     def alert_accept
       # @driver.switch_to.alert.accept
-      # ".switch_to.alert" calls getAlertText so use bridge directly
-      driver.send(:bridge).acceptAlert
+      # ".switch_to.alert" calls alert_text so use bridge directly
+      driver.send(:bridge).accept_alert
     end
 
     # Dismiss the alert.
     # @return [void]
     def alert_dismiss
       # @driver.switch_to.alert.dismiss
-      # ".switch_to.alert" calls getAlertText so use bridge directly
-      driver.send(:bridge).dismissAlert
+      # ".switch_to.alert" calls alert_text so use bridge directly
+      driver.send(:bridge).dismiss_alert
     end
   end # module Ios
 end # module Appium

data/lib/appium_lib/ios/element/textfield.rb

@@ -65,14 +65,14 @@ module Appium
     def textfield(value)
       if value.is_a? Numeric
         index = value
-        fail "#{index} is not a valid index. Must be >= 1" if index <= 0
+        raise "#{index} is not a valid index. Must be >= 1" if index <= 0
         index -= 1 # eles_by_json and _textfields_with_xpath is 0 indexed.
         result = if automation_name_is_xcuitest?
                    _textfields_with_xpath[index]
                  else
                    eles_by_json(_textfield_visible)[index]
                  end
-        fail _no_such_element if result.nil?
+        raise _no_such_element if result.nil?
         return result
 
       end
@@ -116,7 +116,7 @@ module Appium
                else
                  eles_by_json(_textfield_visible).last
                end
-      fail _no_such_element if result.nil?
+      raise _no_such_element if result.nil?
       result
     end
 

data/lib/appium_lib/ios/errors.rb

@@ -0,0 +1,6 @@
+module Appium
+  module Ios
+    class CommandError < RuntimeError
+    end
+  end
+end

data/lib/appium_lib/ios/helper.rb

@@ -14,21 +14,21 @@ module Appium
 
       def _print_attr(type, name, label, value, hint)
         if name == label && name == value
-          puts "#{type}" if name || label || value || hint
+          puts type.to_s if name || label || value || hint
           puts "   name, label, value: #{name}" if name
           puts "   hint: #{hint}" if hint
         elsif name == label
-          puts "#{type}" if name || label || value || hint
+          puts type.to_s if name || label || value || hint
           puts "   name, label: #{name}" if name
           puts "   value: #{value}" if value
           puts "   hint: #{hint}" if hint
         elsif name == value
-          puts "#{type}" if name || label || value || hint
+          puts type.to_s if name || label || value || hint
           puts "   name, value: #{name}" if name
           puts "  label: #{label}" if label
           puts "   hint: #{hint}" if hint
         else
-          puts "#{type}" if name || label || value || hint
+          puts type.to_s if name || label || value || hint
           puts "   name: #{name}" if name
           puts "  label: #{label}" if label
           puts "  value: #{value}" if value
@@ -91,24 +91,24 @@ module Appium
         # rubocop:disable Metrics/BlockNesting
 
         # if class_name is set, mark non-matches as invisible
-        visible = (type.downcase.include?(class_name)).to_s if class_name
+        visible = (type.downcase.include? class_namet).to_s if class_name
         if visible && visible == 'true'
           if name == label && name == value
-            puts "#{type}" if name || label || value || hint
+            puts type.to_s if name || label || value || hint
             puts "   name, label, value: #{name}" if name
             puts "   hint: #{hint}" if hint
           elsif name == label
-            puts "#{type}" if name || label || value || hint
+            puts type.to_s if name || label || value || hint
             puts "   name, label: #{name}" if name
             puts "   value: #{value}" if value
             puts "   hint: #{hint}" if hint
           elsif name == value
-            puts "#{type}" if name || label || value || hint
+            puts type.to_s if name || label || value || hint
             puts "   name, value: #{name}" if name
             puts "  label: #{label}" if label
             puts "   hint: #{hint}" if hint
           else
-            puts "#{type}" if name || label || value || hint
+            puts type.to_s if name || label || value || hint
             puts "   name: #{name}" if name
             puts "  label: #{label}" if label
             puts "  value: #{value}" if value
@@ -236,7 +236,7 @@ module Appium
     # @param index [Integer] the index
     # @return [Element]
     def ele_index(class_name, index)
-      fail 'Index must be >= 1' unless index == 'last()' || (index.is_a?(Integer) && index >= 1)
+      raise 'Index must be >= 1' unless index == 'last()' || (index.is_a?(Integer) && index >= 1)
       elements = tags(class_name)
 
       if index == 'last()'
@@ -247,7 +247,7 @@ module Appium
         result = elements[index]
       end
 
-      fail _no_such_element if result.nil?
+      raise _no_such_element if result.nil?
       result
     end
 
@@ -334,7 +334,7 @@ module Appium
     def last_ele(class_name)
       if automation_name_is_xcuitest?
         result = @driver.find_elements :xpath, "(//#{class_name})"
-        fail _no_such_element if result.empty?
+        raise _no_such_element if result.empty?
         result.last
       else
         ele_index class_name, 'last()'
@@ -469,7 +469,7 @@ module Appium
       #
       # Don't use window.tap. See https://github.com/appium/appium-uiauto/issues/28
       #
-      dismiss_keyboard = (<<-JS).strip
+      dismiss_keyboard = <<-JS.strip
       if (!au.mainApp().keyboard().isNil()) {
         var key = au.mainApp().keyboard().buttons()['#{close_key}']
         if (key.isNil()) {
@@ -509,7 +509,7 @@ module Appium
     #
     def _all_pred(opts)
       predicate = opts[:predicate]
-      fail 'predicate must be provided' unless predicate
+      raise 'predicate must be provided' unless predicate
       visible = opts.fetch :visible, true
       %($.mainApp().getAllWithPredicate("#{predicate}", #{visible});)
     end
@@ -542,22 +542,22 @@ module Appium
     end
 
     def _validate_object(*objects)
-      fail 'objects must be an array' unless objects.is_a? Array
+      raise 'objects must be an array' unless objects.is_a? Array
       objects.each do |obj|
         next unless obj # obj may be nil. if so, ignore.
 
         valid_keys   = [:target, :substring, :insensitive]
         unknown_keys = obj.keys - valid_keys
-        fail "Unknown keys: #{unknown_keys}" unless unknown_keys.empty?
+        raise "Unknown keys: #{unknown_keys}" unless unknown_keys.empty?
 
         target = obj[:target]
-        fail 'target must be a string' unless target.is_a? String
+        raise 'target must be a string' unless target.is_a? String
 
         substring = obj[:substring]
-        fail 'substring must be a boolean' unless [true, false].include? substring
+        raise 'substring must be a boolean' unless [true, false].include? substring
 
         insensitive = obj[:insensitive]
-        fail 'insensitive must be a boolean' unless [true, false].include? insensitive
+        raise 'insensitive must be a boolean' unless [true, false].include? insensitive
       end
     end
 
@@ -593,16 +593,16 @@ module Appium
     def _by_json(opts)
       valid_keys   = [:typeArray, :onlyFirst, :onlyVisible, :name, :label, :value]
       unknown_keys = opts.keys - valid_keys
-      fail "Unknown keys: #{unknown_keys}" unless unknown_keys.empty?
+      raise "Unknown keys: #{unknown_keys}" unless unknown_keys.empty?
 
       type_array = opts[:typeArray]
-      fail 'typeArray must be an array' unless type_array.is_a? Array
+      raise 'typeArray must be an array' unless type_array.is_a? Array
 
       only_first = opts[:onlyFirst]
-      fail 'onlyFirst must be a boolean' unless [true, false].include? only_first
+      raise 'onlyFirst must be a boolean' unless [true, false].include? only_first
 
       only_visible = opts[:onlyVisible]
-      fail 'onlyVisible must be a boolean' unless [true, false].include? only_visible
+      raise 'onlyVisible must be a boolean' unless [true, false].include? only_visible
 
       # name/label/value are optional. when searching for class only, then none
       # will be present.
@@ -625,7 +625,7 @@ module Appium
       JS
 
       res = execute_script element_or_elements_by_type
-      res ? res : fail(Selenium::Client::CommandError, 'mainWindow is nil')
+      res ? res : raise(Appium::Ios::CommandError, 'mainWindow is nil')
     end
 
     # For Appium(automation name), not XCUITest
@@ -649,7 +649,7 @@ module Appium
     def ele_by_json(opts)
       opts[:onlyFirst] = true
       result           = _by_json(opts).first
-      fail _no_such_element if result.nil?
+      raise _no_such_element if result.nil?
       result
     end