add capability to be able to set default timeout/interval for wait/wait_true (#468)

* add capability to be able to set default timeout/interval for wait/wait_true

* update docs

Author: KazuCocoa

android_tests/lib/android/specs/driver.rb

@@ -54,7 +54,9 @@ def sauce?
                               port:             4723,
                               device:           :android,
                               debug:            true,
-                              listener:         nil }
+                              listener:         nil,
+                              wait_timeout:     30,    # default
+                              wait_interval:    0.5 }  # default
 
       if actual != expected
         diff    = HashDiff.diff expected, actual

ios_tests/appium.txt

@@ -9,3 +9,5 @@ app = "./UICatalog.app"
 sauce_username = ""
 sauce_access_key = ""
 wait = 30
+wait_timeout = 20
+wait_interval = 1

ios_tests/lib/ios/specs/driver.rb

@@ -50,7 +50,9 @@ def sauce?
                               port:             4723,
                               device:           :ios,
                               debug:            true,
-                              listener:         nil }
+                              listener:         nil,
+                              wait_timeout:     20,  # defined in appium.txt
+                              wait_interval:    1 }  # defined in appium.txt
 
       if actual != expected
         diff    = HashDiff.diff expected, actual

lib/appium_lib/common/wait.rb

@@ -13,8 +13,8 @@ def _generic_wait(opts = {})
       # [:one, :two] => :one, :two
       raise "Invalid keys #{invalid_keys.to_s[1..-2]}. Valid keys are #{valid_keys.to_s[1..-2]}" unless invalid_keys.empty?
 
-      timeout        = opts.fetch(:timeout, 30)
-      interval       = opts.fetch(:interval, 0.5)
+      timeout        = opts.fetch(:timeout, @appium_wait_timeout)
+      interval       = opts.fetch(:interval, @appium_wait_interval)
       message        = opts[:message]
       ignored        = Array(opts[:ignore] || ::Exception)
       return_if_true = opts[:return_if_true]
@@ -62,8 +62,8 @@ def _process_wait_opts(opts)
     # If only a number is provided then it's treated as the timeout value.
     #
     # @param [Hash] opts Options
-    # @option opts [Numeric] :timeout (30) Seconds to wait before timing out.
-    # @option opts [Numeric] :interval (0.5) Seconds to sleep between polls.
+    # @option opts [Numeric] :timeout Seconds to wait before timing out. Set default by `appium_wait_timeout` (30).
+    # @option opts [Numeric] :interval Seconds to sleep between polls. Set default by `appium_wait_interval` (0.5).
     # @option opts [String] :message Exception message if timed out.
     # @option opts [Array, Exception] :ignore Exceptions to ignore while polling (default: Exception)
     def wait_true(opts = {}, &block)
@@ -80,8 +80,8 @@ def wait_true(opts = {}, &block)
     # If only a number is provided then it's treated as the timeout value.
     #
     # @param [Hash] opts Options
-    # @option opts [Numeric] :timeout (30) Seconds to wait before timing out.
-    # @option opts [Numeric] :interval (0.5) Seconds to sleep between polls.
+    # @option opts [Numeric] :timeout Seconds to wait before timing out. Set default by `appium_wait_timeout` (30).
+    # @option opts [Numeric] :interval Seconds to sleep between polls. Set default by `appium_wait_interval` (0.5).
     # @option opts [String] :message Exception message if timed out.
     # @option opts [Array, Exception] :ignore Exceptions to ignore while polling (default: Exception)
     def wait(opts = {}, &block)

lib/appium_lib/driver.rb

@@ -304,23 +304,52 @@ class Driver
     # Return http client called in start_driver()
     # @return [Selenium::WebDriver::Remote::Http::Default] the http client
     attr_reader :http_client
+    # Return a time wait timeout
+    # Wait time for ::Appium::Common.wait or ::Appium::Common.wait_true.
+    # Provide Appium::Drive like { appium_lib: { wait_timeout: 20 } }
+    # @return [Integer]
+    attr_reader :appium_wait_timeout
+    # Return a time wait timeout
+    # Wait interval time for ::Appium::Common.wait or ::Appium::Common.wait_true.
+    # Provide Appium::Drive like { appium_lib: { wait_interval: 20 } }
+    # @return [Integer]
+    attr_reader :appium_wait_interval
 
     # Creates a new driver
     #
-    # ```ruby
-    # require 'rubygems'
-    # require 'appium_lib'
+    # @example
     #
-    # # platformName takes a string or a symbol.
+    #     ```ruby
+    #     require 'rubygems'
+    #     require 'appium_lib'
     #
-    # # Start iOS driver
-    # opts = { caps: { platformName: :ios, app: '/path/to/MyiOS.app' } }
-    # Appium::Driver.new(opts).start_driver
+    #     # platformName takes a string or a symbol.
     #
-    # # Start Android driver
-    # opts = { caps: { platformName: :android, app: '/path/to/my.apk' } }
-    # Appium::Driver.new(opts).start_driver
-    # ```
+    #     # Start iOS driver
+    #     opts = {
+    #              caps: {
+    #                platformName: :ios,
+    #                app: '/path/to/MyiOS.app'
+    #              },
+    #              appium_lib: {
+    #                wait_timeout: 30
+    #              }
+    #            }
+    #     Appium::Driver.new(opts).start_driver
+    #
+    #     # Start Android driver
+    #     opts = {
+    #              caps: {
+    #                platformName: :android,
+    #                app: '/path/to/my.apk'
+    #              },
+    #              appium_lib: {
+    #                wait_timeout: 30,
+    #                wait_interval: 1
+    #              }
+    #            }
+    #     Appium::Driver.new(opts).start_driver
+    #     ```
     #
     # @param opts [Object] A hash containing various options.
     # @return [Driver]
@@ -344,6 +373,9 @@ def initialize(opts = {})
       @sauce_access_key = appium_lib_opts.fetch :sauce_access_key, ENV['SAUCE_ACCESS_KEY']
       @sauce_access_key = nil if !@sauce_access_key || (@sauce_access_key.is_a?(String) && @sauce_access_key.empty?)
       @appium_port      = appium_lib_opts.fetch :port, 4723
+      # timeout and interval used in ::Appium::Comm.wait/wait_true
+      @appium_wait_timeout  = appium_lib_opts.fetch :wait_timeout, 30
+      @appium_wait_interval = appium_lib_opts.fetch :wait_interval, 0.5
 
       # to pass it in Selenium.new.
       # `listener = opts.delete(:listener)` is called in Selenium::Driver.new
@@ -408,7 +440,9 @@ def driver_attributes
           port:             @appium_port,
           device:           @appium_device,
           debug:            @appium_debug,
-          listener:         @listener
+          listener:         @listener,
+          wait_timeout:     @appium_wait_timeout,
+          wait_interval:    @appium_wait_interval
       }
 
       # Return duplicates so attributes are immutable