appium_lib 9.15.1 → 9.15.2

data/docs/ios_xcuitest.md

@@ -5,7 +5,7 @@
 - How to migrate XCUITest from UIAutomation
     - [Migrating your iOS tests from UIAutomation](https://github.com/appium/appium/blob/v1.6.2/docs/en/advanced-concepts/migrating-to-xcuitest.md)
 - Mobile gestures for XCUITest
-    - [ios-xctest-mobile-gestures](https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/ios-xctest-mobile-gestures.md)
+    - [ios-xctest-mobile-gestures](https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/ios/ios-xctest-mobile-gestures.md)
     - Required Appium1.6.4+
 
 ## find elements

data/docs/w3c.md

@@ -15,6 +15,27 @@ driver.action
       .move_to_location(500, 500).pointer_down(:left)
       .move_to_location(0, 700)
       .release.perform
+
+# multiple action chains
+f1 = driver.action.add_pointer_input(:touch, 'finger1')
+f1.create_pointer_move(duration: 1, x: 200, y: 500,
+                   origin: ::Selenium::WebDriver::Interactions::PointerMove::VIEWPORT)
+f1.create_pointer_down(:left)
+f1.create_pause(0.5)
+f1.create_pointer_move(duration: 1, x: 200, y: 200,
+                   origin: ::Selenium::WebDriver::Interactions::PointerMove::VIEWPORT)
+f1.create_pointer_up(:left)
+
+f2 = driver.action.add_pointer_input(:touch, 'finger2')
+f2.create_pointer_move(duration: 1, x: 200, y: 500,
+                   origin: ::Selenium::WebDriver::Interactions::PointerMove::VIEWPORT)
+f2.create_pointer_down(:left)
+f2.create_pause(0.5)
+f2.create_pointer_move(duration: 1, x: 200, y: 800,
+                   origin: ::Selenium::WebDriver::Interactions::PointerMove::VIEWPORT)
+f2.create_pointer_up(:left)
+
+driver.perform_actions [f1, f2]
 ```
 
 # Note

data/lib/appium_lib/android/common/helper.rb

@@ -8,7 +8,8 @@ module Appium
       # convert to string to support symbols
       def filter=(value)
         # nil and false disable the filter
-        return @filter = false unless value
+        return @filter = false unless value # rubocop:disable Lint/ReturnInVoidContext
+
         @filter = value.to_s.downcase
       end
 
@@ -136,6 +137,7 @@ module Appium
         index -= 1 if index >= 0
       else
         raise 'Index must be >= 1' unless index >= 1
+
         index -= 1 if index >= 1
       end
 
@@ -218,7 +220,7 @@ module Appium
 
       if class_name == '*'
         return "//*[contains(translate(@text,'#{value.upcase}', '#{value}'), '#{value}')" \
-            " or contains(translate(@content-desc,'#{value.upcase}', '#{value}'), '#{value}')" + r_id + ']'
+          " or contains(translate(@content-desc,'#{value.upcase}', '#{value}'), '#{value}')" + r_id + ']'
       end
 
       "//#{class_name}[contains(translate(@text,'#{value.upcase}', '#{value}'), '#{value}')" \
@@ -237,14 +239,14 @@ module Appium
       value = %("#{value}")
       if class_name == '*'
         return (resource_id(value, "new UiSelector().resourceId(#{value});") +
-            "new UiSelector().descriptionContains(#{value});" \
-            "new UiSelector().textContains(#{value});")
+          "new UiSelector().descriptionContains(#{value});" \
+          "new UiSelector().textContains(#{value});")
       end
 
       class_name = %("#{class_name}")
       resource_id(value, "new UiSelector().className(#{class_name}).resourceId(#{value});") +
-          "new UiSelector().className(#{class_name}).descriptionContains(#{value});" \
-          "new UiSelector().className(#{class_name}).textContains(#{value});"
+        "new UiSelector().className(#{class_name}).descriptionContains(#{value});" \
+        "new UiSelector().className(#{class_name}).textContains(#{value});"
     end
 
     # Find the first element that contains value
@@ -272,9 +274,7 @@ module Appium
     def string_visible_exact_xpath(class_name, value)
       r_id = resource_id(value, " or @resource-id='#{value}'")
 
-      if class_name == '*'
-        return "//*[@text='#{value}' or @content-desc='#{value}'" + r_id + ']'
-      end
+      return "//*[@text='#{value}' or @content-desc='#{value}'" + r_id + ']' if class_name == '*'
 
       "//#{class_name}[@text='#{value}' or @content-desc='#{value}'" + r_id + ']'
     end
@@ -289,14 +289,14 @@ module Appium
 
       if class_name == '*'
         return (resource_id(value, "new UiSelector().resourceId(#{value});") +
-            "new UiSelector().description(#{value});" \
-            "new UiSelector().text(#{value});")
+          "new UiSelector().description(#{value});" \
+          "new UiSelector().text(#{value});")
       end
 
       class_name = %("#{class_name}")
       resource_id(value, "new UiSelector().className(#{class_name}).resourceId(#{value});") +
-          "new UiSelector().className(#{class_name}).description(#{value});" \
-          "new UiSelector().className(#{class_name}).text(#{value});"
+        "new UiSelector().className(#{class_name}).description(#{value});" \
+        "new UiSelector().className(#{class_name}).text(#{value});"
     end
 
     # Find the first element exactly matching value

data/lib/appium_lib/android/element/button.rb

@@ -26,6 +26,7 @@ module Appium
     # @return [Array<Button>]
     def buttons(value = false)
       return find_elements :uiautomator, _button_visible_selectors unless value
+
       find_elements :uiautomator, _button_contains_string(value)
     end
 
@@ -69,6 +70,7 @@ module Appium
     # @private
     def raise_no_such_element_if_empty(elements)
       raise _no_such_element if elements.empty?
+
       elements.first
     end
 

data/lib/appium_lib/android/element/generic.rb

@@ -45,7 +45,7 @@ module Appium
         begin
           elem = find_element :uiautomator, scroll_uiselector(arg, scrollable_index)
           return elem
-        rescue => e
+        rescue StandardError => e
           raise e if index == args.size - 1
         end
       end
@@ -63,7 +63,7 @@ module Appium
         begin
           elem = find_element :uiautomator, scroll_uiselector(arg, scrollable_index)
           return elem
-        rescue => e
+        rescue StandardError => e
           raise e if index == args.size - 1
         end
       end

data/lib/appium_lib/android/element/text.rb

@@ -9,6 +9,7 @@ module Appium
     # @return [TextView]
     def text(value)
       return ele_index TextView, value if value.is_a? Numeric
+
       complex_find_contains TextView, value
     end
 
@@ -18,6 +19,7 @@ module Appium
     # @return [Array<TextView>]
     def texts(value = false)
       return tags TextView unless value
+
       complex_finds_contains TextView, value
     end
 

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

@@ -8,6 +8,7 @@ module Appium
     # @return [EditText]
     def textfield(value)
       return ele_index EditText, value if value.is_a? Numeric
+
       complex_find_contains EditText, value
     end
 
@@ -17,6 +18,7 @@ module Appium
     # @return [Array<EditText>]
     def textfields(value = false)
       return tags EditText unless value
+
       complex_finds_contains EditText, value
     end
 

data/lib/appium_lib/android/uiautomator2/element/button.rb

@@ -15,6 +15,7 @@ module Appium
 
             result = find_elements :uiautomator, _button_visible_selectors(index: index)
             raise _no_such_element if result.empty?
+
             return result[value - 1]
           end
 
@@ -28,6 +29,7 @@ module Appium
         # @return [Array<Button>]
         def buttons(value = false)
           return find_elements :uiautomator, _button_visible_selectors unless value
+
           find_elements :uiautomator, _button_contains_string(value)
         end
 
@@ -74,6 +76,7 @@ module Appium
         # @private
         def raise_no_such_element_if_empty(elements)
           raise _no_such_element if elements.empty?
+
           elements.first
         end
 

data/lib/appium_lib/android/uiautomator2/helper.rb

@@ -14,14 +14,14 @@ module Appium
           value = %("#{value}")
           if class_name == '*'
             return (resource_id(value, "new UiSelector().resourceId(#{value});") +
-                "new UiSelector().descriptionContains(#{value});" \
-                "new UiSelector().textContains(#{value});")
+              "new UiSelector().descriptionContains(#{value});" \
+              "new UiSelector().textContains(#{value});")
           end
 
           class_name = %("#{class_name}")
           resource_id(value, "new UiSelector().className(#{class_name}).resourceId(#{value});") +
-              "new UiSelector().className(#{class_name}).descriptionContains(#{value});" \
-              "new UiSelector().className(#{class_name}).textContains(#{value});"
+            "new UiSelector().className(#{class_name}).descriptionContains(#{value});" \
+            "new UiSelector().className(#{class_name}).textContains(#{value});"
         end
 
         # Find the first element that contains value
@@ -31,6 +31,7 @@ module Appium
         def complex_find_contains(class_name, value)
           elements = find_elements :uiautomator, string_visible_contains(class_name, value)
           raise _no_such_element if elements.empty?
+
           elements.first
         end
 
@@ -52,14 +53,14 @@ module Appium
 
           if class_name == '*'
             return (resource_id(value, "new UiSelector().resourceId(#{value});") +
-                "new UiSelector().description(#{value});" \
-                "new UiSelector().text(#{value});")
+              "new UiSelector().description(#{value});" \
+              "new UiSelector().text(#{value});")
           end
 
           class_name = %("#{class_name}")
           resource_id(value, "new UiSelector().className(#{class_name}).resourceId(#{value});") +
-              "new UiSelector().className(#{class_name}).description(#{value});" \
-              "new UiSelector().className(#{class_name}).text(#{value});"
+            "new UiSelector().className(#{class_name}).description(#{value});" \
+            "new UiSelector().className(#{class_name}).text(#{value});"
         end
 
         # Find the first element exactly matching value
@@ -69,6 +70,7 @@ module Appium
         def complex_find_exact(class_name, value)
           elements = find_elements :uiautomator, string_visible_exact(class_name, value)
           raise _no_such_element if elements.empty?
+
           elements.first
         end
 

data/lib/appium_lib/appium.rb

@@ -49,6 +49,7 @@ module Appium
 
       toml = opts[:file]
       raise 'Must pass a capability file which has [caps] and [appium_lib]' unless toml
+
       verbose = opts.fetch :verbose, false
 
       Appium::Logger.info "appium settings path: #{toml}" if verbose
@@ -57,6 +58,7 @@ module Appium
       Appium::Logger.info "Exists? #{toml_exists}" if verbose
 
       raise "toml doesn't exist #{toml}" unless toml_exists
+
       require 'tomlrb'
       Appium::Logger.info "Loading #{toml}" if verbose
 
@@ -135,6 +137,7 @@ module Appium
         end
       else
         raise 'modules must be a module or an array' unless modules.is_a? Array
+
         target_modules = modules
       end
 
@@ -181,6 +184,7 @@ module Appium
     #
     def promote_appium_methods(class_array, driver = $driver)
       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.

data/lib/appium_lib/common/helper.rb

@@ -194,7 +194,8 @@ module Appium
       # convert to string to support symbols
       def filter=(value)
         # nil and false disable the filter
-        return @filter = false unless value
+        return @filter = false unless value # rubocop:disable Lint/ReturnInVoidContext
+
         @filter = value.to_s.downcase
       end
 
@@ -211,16 +212,13 @@ module Appium
 
       def result
         @elements_in_order.reduce('') do |r, e|
-          name        = e.delete :name
+          name = e.delete :name
           attr_string = e.reduce('') do |string, attr|
-            attr_1 = attr[1]
-            attr_1 = attr_1 ? attr_1.strip : attr_1
-            string + "  #{attr[0]}: #{attr_1}\n"
+            attr1 = attr[1] ? attr[1].strip : attr[1]
+            "#{string}  #{attr[0]}: #{attr1}\n"
           end
 
-          unless attr_string.nil? || attr_string.empty?
-            r += "\n#{name}\n#{attr_string}"
-          end
+          r.concat "\n#{name}\n#{attr_string}" unless attr_string.nil? || attr_string.empty?
           r
         end
       end
@@ -228,6 +226,7 @@ module Appium
       def start_element(name, attrs = [])
         @skip_element = filter && !filter.include?(name.downcase)
         return if @skip_element
+
         element = { name: name }
         attrs.each { |a| element[a[0]] = a[1] }
         @element_stack.push element
@@ -236,12 +235,14 @@ module Appium
 
       def end_element(name)
         return if filter && !filter.include?(name.downcase)
+
         element_index = @element_stack.rindex { |e| e[:name] == name }
         @element_stack.delete_at element_index
       end
 
       def characters(chars)
         return if @skip_element
+
         element        = @element_stack.last
         element[:text] = chars
       end

data/lib/appium_lib/common/multi_touch.rb

@@ -63,6 +63,7 @@ module Appium
         pinch.add top
         pinch.add bottom
         return pinch unless auto_perform
+
         pinch.perform
       end
 
@@ -105,6 +106,7 @@ module Appium
         zoom.add top
         zoom.add bottom
         return zoom unless auto_perform
+
         zoom.perform
       end
 

data/lib/appium_lib/common/touch_actions.rb

@@ -36,9 +36,10 @@ module Appium
       COMPLEX_ACTIONS.each do |action|
         define_method(action) do |opts|
           auto_perform = opts.delete(:auto_perform) { |_k| true }
-          ta           = ::Appium::TouchAction.new($driver)
+          ta = ::Appium::TouchAction.new($driver)
           ta.send(action, opts)
           return ta unless auto_perform
+
           ta.perform
         end
       end
@@ -49,10 +50,10 @@ module Appium
     end
 
     def swipe(opts)
-      start_x  = opts.fetch :start_x, 0
-      start_y  = opts.fetch :start_y, 0
-      end_x    = opts.fetch :end_x, 0
-      end_y    = opts.fetch :end_y, 0
+      start_x = opts.fetch :start_x, 0
+      start_y = opts.fetch :start_y, 0
+      end_x = opts.fetch :end_x, 0
+      end_y = opts.fetch :end_y, 0
       duration = opts.fetch :duration, 200
 
       if opts[:offset_x]

data/lib/appium_lib/driver.rb

@@ -199,7 +199,7 @@ module Appium
       # Save global reference to last created Appium driver for top level methods.
       $driver = self if global_driver
 
-      self # return newly created driver
+      self # rubocop:disable Lint/Void # return newly created driver
     end
 
     private
@@ -254,23 +254,25 @@ module Appium
 
     # Returns a hash of the driver attributes
     def driver_attributes
+      # rubocop:disable Layout/AlignHash
       {
-          caps:                @core.caps,
-          automation_name:     @core.automation_name,
-          custom_url:          @core.custom_url,
-          export_session:      @core.export_session,
-          export_session_path: @core.export_session_path,
-          default_wait:        @core.default_wait,
-          sauce_username:      @sauce.username,
-          sauce_access_key:    @sauce.access_key,
-          sauce_endpoint:      @sauce.endpoint,
-          port:                @core.port,
-          device:              @core.device,
-          debug:               @appium_debug,
-          listener:            @listener,
-          wait_timeout:        @core.wait_timeout,
-          wait_interval:       @core.wait_interval
+        caps:                @core.caps,
+        automation_name:     @core.automation_name,
+        custom_url:          @core.custom_url,
+        export_session:      @core.export_session,
+        export_session_path: @core.export_session_path,
+        default_wait:        @core.default_wait,
+        sauce_username:      @sauce.username,
+        sauce_access_key:    @sauce.access_key,
+        sauce_endpoint:      @sauce.endpoint,
+        port:                @core.port,
+        device:              @core.device,
+        debug:               @appium_debug,
+        listener:            @listener,
+        wait_timeout:        @core.wait_timeout,
+        wait_interval:       @core.wait_interval
       }
+      # rubocop:enable Layout/AlignHash
     end
 
     def device_is_android?
@@ -328,8 +330,9 @@ module Appium
     # @return [Boolean]
     def check_server_version_xcuitest
       if automation_name_is_xcuitest? &&
-          !@appium_server_status.empty? &&
-          (@appium_server_status['build']['version'] < REQUIRED_VERSION_XCUITEST)
+         !@appium_server_status.empty? &&
+         (@appium_server_status['build']['version'] < REQUIRED_VERSION_XCUITEST)
+
         raise(Appium::Core::Error::NotSupportedAppiumServer,
               "XCUITest requires Appium version >= #{REQUIRED_VERSION_XCUITEST}")
       end
@@ -351,6 +354,7 @@ module Appium
       @core.appium_server_version
     rescue Selenium::WebDriver::Error::WebDriverError => ex
       raise ::Appium::Core::Error::ServerError unless ex.message.include?('content-type=""')
+
       # server (TestObject for instance) does not respond to status call
       {}
     end
@@ -385,6 +389,7 @@ module Appium
     # @return [String] APP_PATH as an absolute path
     def self.absolute_app_path(opts)
       raise 'opts must be a hash' unless opts.is_a? Hash
+
       caps            = opts[:caps] || {}
       app_path        = caps[:app]
       raise 'absolute_app_path invoked and app is not set!' if app_path.nil? || app_path.empty?
@@ -403,6 +408,7 @@ module Appium
     def server_url
       return @core.custom_url if @core.custom_url
       return @sauce.server_url if @sauce.sauce_server_url?
+
       "http://127.0.0.1:#{@core.port}/wd/hub"
     end
 
@@ -517,6 +523,7 @@ module Appium
       unless e.message.include?('The operation requested is not yet implemented by Espresso driver')
         raise ::Appium::Core::Error::ServerError
       end
+
       {}
     end
 
@@ -562,7 +569,7 @@ module Appium
 
       begin
         yield # search for element
-      rescue
+      rescue StandardError
         exists = false # error means it's not there
       end
 
@@ -580,6 +587,52 @@ module Appium
       @driver.execute_script script, *args
     end
 
+    ###
+    # Wrap calling selenium webdrier APIs via ruby_core
+    ###
+    # Get the window handles of open browser windows
+    def execute_async_script(script, *args)
+      @driver.execute_async_script script, *args
+    end
+
+    def window_handles
+      @driver.window_handles
+    end
+
+    # Get the current window handle
+    def window_handle
+      @driver.window_handle
+    end
+
+    def navigate
+      @driver.navigate
+    end
+
+    def manage
+      @driver.manage
+    end
+
+    def get(url)
+      @driver.get(url)
+    end
+
+    def current_url
+      @driver.current_url
+    end
+
+    def title
+      @driver.title
+    end
+
+    # @return [TargetLocator]
+    # @see TargetLocator
+    def switch_to
+      @driver.switch_to
+    end
+    ###
+    # End core
+    ###
+
     # Calls @driver.find_elements_with_appium
     #
     # @example