appium_lib_core 4.1.0 → 9.0.0

data/lib/appium_lib_core/common/base/driver_settings.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Appium
+  module Core
+    class Base
+      #
+      # @api private
+      #
+      class DriverSettings
+        # @private this class is private
+        def initialize(bridge)
+          @bridge = bridge
+        end
+
+        # Get appium Settings for current test session.
+        #
+        # @example
+        #
+        #   @driver.settings.get
+        #
+        def get
+          @bridge.get_settings
+        end
+
+        # Update Appium Settings for current test session
+        #
+        # @param [Hash] settings Settings to update, keys are settings, values to value to set each setting to
+        #
+        # @example
+        #
+        #   @driver.settings.update({'allowInvisibleElements': true})
+        #
+        def update(settings)
+          @bridge.update_settings(settings)
+        end
+      end
+    end
+  end
+end

data/lib/appium_lib_core/common/base/has_location.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Appium
+  module Core
+    class Base
+      #
+      # @api private
+      #
+      module HasLocation
+        # Get the location of the device.
+        #
+        # @return [::Appium::Location]
+        #
+        # @example
+        #
+        #   driver.location #=> ::Appium::Location.new(10, 10, 10)
+        #
+        def location
+          @bridge.location
+        end
+
+        # Set the location of the device.
+        #
+        # @param [::Appium::Location] location Set the location.
+        #
+        # @example
+        #
+        #   driver.location = ::Appium::Location.new(10, 10, 10)
+        #
+        def location=(location)
+          unless location.is_a?(::Appium::Location)
+            raise TypeError, "expected #{::Appium::Location}, got #{location.inspect}:#{location.class}"
+          end
+
+          @bridge.set_location location.latitude, location.longitude, location.altitude
+        end
+
+        # Set the location of the device.
+        #
+        # @param [String, Number] latitude Set the latitude.
+        # @param [String, Number] longitude Set the longitude.
+        # @param [String, Number] altitude Set the altitude.
+        # @param [String, Number] speed Set the speed to apply the location on Android real devices
+        #                               in meters/second @since Appium 1.21.0 and in knots for emulators @since Appium 1.22.0.
+        # @param [String, Number] satellites Sets the count of geo satellites being tracked in range 1..12 @since Appium 1.22.0.
+        #                                    This number is respected on Emulators.
+        # @param [::Appium::Location]
+        #
+        # @example
+        #
+        #   driver.location = ::Appium::Location.new(10, 10, 10)
+        #
+        def set_location(latitude, longitude, altitude, speed: nil, satellites: nil)
+          if speed.nil? && satellites.nil?
+            self.location = ::Appium::Location.new(Float(latitude), Float(longitude), Float(altitude))
+          else
+            loc = ::Appium::Location.new(Float(latitude), Float(longitude), Float(altitude))
+
+            speed = Float(speed) unless speed.nil?
+            satellites = Integer(satellites) unless satellites.nil?
+
+            @bridge.set_location loc.latitude, loc.longitude, loc.altitude, speed: speed, satellites: satellites
+          end
+        end
+      end
+    end
+  end
+end

data/lib/appium_lib_core/common/base/has_network_connection.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Appium
+  module Core
+    class Base
+      #
+      # @api private
+      #
+      module HasNetworkConnection
+        def network_connection_type
+          connection_value = @bridge.network_connection
+
+          connection_type = values_to_type[connection_value]
+
+          # In case the connection type is not recognized return the
+          # connection value.
+          connection_type || connection_value
+        end
+
+        def network_connection_type=(connection_type)
+          raise ::Appium::Core::Error::ArgumentError, 'Invalid connection type' unless valid_type? connection_type
+
+          connection_value = type_to_values[connection_type]
+
+          @bridge.network_connection = connection_value
+        end
+
+        private
+
+        def type_to_values
+          { airplane_mode: 1, wifi: 2, data: 4, all: 6, none: 0 }
+        end
+
+        def values_to_type
+          type_to_values.invert
+        end
+
+        def valid_type?(type)
+          type_to_values.keys.include? type
+        end
+      end
+    end
+  end
+end

data/lib/appium_lib_core/common/base/http_default.rb

@@ -13,6 +13,8 @@
 # limitations under the License.
 
 require 'securerandom'
+# to avoid mysterious resolution error 'uninitialized constant Selenium::WebDriver::Remote::Http::Default::Net (NameError)'
+require 'net/http'
 
 require_relative '../../version'
 
@@ -26,21 +28,15 @@ module Appium
           }.freeze
         end
 
-        class Default < Selenium::WebDriver::Remote::Http::Default
-          DEFAULT_HEADERS = {
-            'Accept' => CONTENT_TYPE,
-            'Content-Type' => "#{CONTENT_TYPE}; charset=UTF-8",
-            'User-Agent' =>
-              "appium/ruby_lib_core/#{VERSION} (#{::Selenium::WebDriver::Remote::Http::Common::DEFAULT_HEADERS['User-Agent']})"
-          }.freeze
-
+        class Default < ::Selenium::WebDriver::Remote::Http::Default
           attr_reader :additional_headers
 
           # override
-          def initialize(open_timeout: nil, read_timeout: nil) # rubocop:disable Lint/MissingSuper
+          def initialize(open_timeout: nil, read_timeout: nil)
             @open_timeout = open_timeout
             @read_timeout = read_timeout
             @additional_headers = {}
+            super
           end
 
           # Update <code>server_url</code> provided when ruby_lib _core created a default http client.
@@ -55,49 +51,30 @@ module Appium
           def update_sending_request_to(scheme:, host:, port:, path:)
             return @server_url unless validate_url_param(scheme, host, port, path)
 
-            ::Appium::Logger.debug("[experimental] This feature, #{__method__}, is an experimental")
-
             # Add / if 'path' does not have it
-            path = path.start_with?('/') ? path : "/#{path}"
-            path = path.end_with?('/') ? path : "#{path}/"
+            path = "/#{path}" unless path.start_with?('/')
+            path = "#{path}/" unless path.end_with?('/')
 
             @http = nil
             @server_url = URI.parse "#{scheme}://#{host}:#{port}#{path}"
           end
 
+          def request(verb, url, headers, payload, redirects = 0)
+            headers['User-Agent'] = "appium/ruby_lib_core/#{VERSION} (#{headers['User-Agent']})"
+            headers = headers.merge @additional_headers unless @additional_headers.empty?
+
+            super(verb, url, headers, payload, redirects)
+          end
+
           private
 
           def validate_url_param(scheme, host, port, path)
             return true unless [scheme, host, port, path].include?(nil)
 
             message = "Given parameters are scheme: '#{scheme}', host: '#{host}', port: '#{port}', path: '#{path}'"
-            ::Appium::Logger.warn(message)
+            ::Appium::Logger.debug(message)
             false
           end
-
-          public
-
-          # override to use default header
-          # https://github.com/SeleniumHQ/selenium/blob/master/rb/lib/selenium/webdriver/remote/http/common.rb#L46
-          def call(verb, url, command_hash)
-            url      = server_url.merge(url) unless url.is_a?(URI)
-            headers  = DEFAULT_HEADERS.dup
-            headers  = headers.merge @additional_headers unless @additional_headers.empty?
-            headers['Cache-Control'] = 'no-cache' if verb == :get
-
-            if command_hash
-              payload                   = JSON.generate(command_hash)
-              headers['Content-Length'] = payload.bytesize.to_s if [:post, :put].include?(verb)
-            elsif verb == :post
-              payload = '{}'
-              headers['Content-Length'] = '2'
-            end
-
-            ::Appium::Logger.info("   >>> #{url} | #{payload}")
-            ::Appium::Logger.info("     > #{headers.inspect}")
-
-            request verb, url, headers, payload
-          end
         end
       end
     end

data/lib/appium_lib_core/{ios/uiautomation/bridge.rb → common/base/remote_status.rb}

@@ -14,15 +14,16 @@
 
 module Appium
   module Core
-    module Ios
-      module Uiautomation
-        module Bridge
-          def self.for(target)
-            target.extend Appium::Core::Ios::Device
+    class Base
+      #
+      # @api private
+      #
 
-            Core::Ios::Uiautomation.patch_webdriver_element
-            Core::Ios::Uiautomation::Device.add_methods
-          end
+      module HasRemoteStatus
+        # Selenium binding has this ability only in Remote Binding,
+        # so this library has this method by own for safe.
+        def remote_status
+          bridge.status
         end
       end
     end

data/lib/appium_lib_core/common/base/rotable.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Appium
+  module Core
+    class Base
+      #
+      # @api private
+      #
+
+      module Rotatable
+        ORIENTATIONS = %i[
+          landscape
+          portrait
+          uia_device_orientation_landscaperight
+          uia_device_orientation_portrait_upsidedown
+        ].freeze
+
+        #
+        # Change the screen orientation
+        #
+        # @param [:landscape, :portrait,
+        #         :uia_device_orientation_landscaperight, :uia_device_orientation_portrait_upsidedown] orientation
+        #
+        #
+        def rotation=(orientation)
+          unless ORIENTATIONS.include?(orientation)
+            raise ::Appium::Core::Error::ArgumentError, "expected #{ORIENTATIONS.inspect}, got #{orientation.inspect}"
+          end
+
+          bridge.screen_orientation = orientation.to_s.upcase
+        end
+        alias rotate rotation=
+        alias orientation= rotation=
+
+        #
+        # Get the current screen orientation
+        #
+        # @return [:landscape, :portrait,
+        #          :uia_device_orientation_landscaperight, :uia_device_orientation_portrait_upsidedown] orientation
+        #
+        # @api public
+        #
+
+        def orientation
+          bridge.screen_orientation.to_sym.downcase
+        end
+      end
+    end
+  end
+end

data/lib/appium_lib_core/common/base/screenshot.rb

@@ -15,7 +15,7 @@
 module Appium
   module Core
     class Base
-      module TakeScreenshot
+      module TakesScreenshot
         #
         # Save a PNG screenshot to the given path
         #
@@ -24,7 +24,7 @@ module Appium
         def save_screenshot(png_path)
           extension = File.extname(png_path).downcase
           if extension != '.png'
-            ::Appium::Logger.warn 'name used for saved screenshot does not match file type. '\
+            ::Appium::Logger.warn 'name used for saved screenshot does not match file type. ' \
                                   'It should end with .png extension'
           end
           File.open(png_path, 'wb') { |f| f << screenshot_as(:png) }
@@ -63,8 +63,8 @@ module Appium
         def save_element_screenshot(element, png_path)
           extension = File.extname(png_path).downcase
           if extension != '.png'
-            ::Appium::Logger.warn 'name used for saved screenshot does not match file type. '\
-                                'It should end with .png extension'
+            ::Appium::Logger.warn 'name used for saved screenshot does not match file type. ' \
+                                  'It should end with .png extension'
           end
           File.open(png_path, 'wb') { |f| f << element_screenshot_as(element, :png) }
         end
@@ -84,9 +84,9 @@ module Appium
         def element_screenshot_as(element, format)
           case format
           when :base64
-            bridge.take_element_screenshot(element)
+            bridge.element_screenshot element.id
           when :png
-            bridge.take_element_screenshot(element).unpack('m')[0]
+            bridge.element_screenshot(element.id).unpack('m')[0]
           else
             raise Core::Error::UnsupportedOperationError, "unsupported format: #{format.inspect}"
           end
@@ -103,10 +103,10 @@ module Appium
         def save_viewport_screenshot(png_path)
           extension = File.extname(png_path).downcase
           if extension != '.png'
-            ::Appium::Logger.warn 'name used for saved screenshot does not match file type. '\
+            ::Appium::Logger.warn 'name used for saved screenshot does not match file type. ' \
                                   'It should end with .png extension'
           end
-          viewport_screenshot_encode64 = bridge.take_viewport_screenshot
+          viewport_screenshot_encode64 = bridge.viewport_screenshot
           File.open(png_path, 'wb') { |f| f << viewport_screenshot_encode64.unpack('m')[0] }
         end
       end

data/lib/appium_lib_core/common/base/search_context.rb

@@ -28,13 +28,8 @@ module Appium
           data_matcher:         '-android datamatcher', # Available in Espresso
           view_matcher:         '-android viewmatcher', # Available in Espresso
           # iOS
-          uiautomation:         '-ios uiautomation',
           predicate:            '-ios predicate string',
-          class_chain:          '-ios class chain',
-          # Windows with windows prefix
-          windows_uiautomation: '-windows uiautomation',
-          # Tizen with Tizen prefix
-          tizen_uiautomation:   '-tizen uiautomation'
+          class_chain:          '-ios class chain'
         )
 
         # rubocop:disable Layout/LineLength
@@ -47,7 +42,7 @@ module Appium
         #
         # == Find with image
         # Return an element if current view has a partial image. The logic depends on template matching by OpenCV.
-        # {https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/image-comparison.md image-comparison}
+        # {https://github.com/appium/appium/blob/1.x/docs/en/writing-running-appium/image-comparison.md image-comparison}
         #
         # You can handle settings for the comparision following {https://github.com/appium/appium-base-driver/blob/master/lib/basedriver/device-settings.js#L6 here}
         #
@@ -121,12 +116,6 @@ module Appium
         #     e = find_element :class_chain, "**/XCUIElementTypeStaticText[$name == 'Buttons'$]"
         #     e.tag_name #=> "XCUIElementTypeStaticText"
         #
-        #     # For Windows
-        #     @driver.find_elements :windows_uiautomation, '....'
-        #
-        #     # For Tizen
-        #     @driver.find_elements :tizen_uiautomation, '....'
-        #
         # rubocop:enable Layout/LineLength
         def find_element(*args)
           how, what = extract_args(args)
@@ -141,6 +130,8 @@ module Appium
         #
         # Find all elements matching the given arguments
         #
+        # @return [Array<Selenium::WebDriver::Element>]
+        #
         # @see SearchContext#find_elements
         #
         def find_elements(*args)
@@ -157,7 +148,10 @@ module Appium
 
         def _set_by_from_finders(how)
           by = FINDERS[how.to_sym]
-          raise ArgumentError, "cannot find element by #{how.inspect}. Available finders are #{FINDERS.keys}." unless by
+          unless by
+            raise ::Appium::Core::Error::ArgumentError,
+                  "cannot find element by #{how.inspect}. Available finders are #{FINDERS.keys}."
+          end
 
           by
         end
@@ -169,16 +163,18 @@ module Appium
           when 1
             arg = args.first
 
-            raise ArgumentError, "expected #{arg.inspect}:#{arg.class} to respond to #shift" unless arg.respond_to?(:shift)
+            unless arg.respond_to?(:shift)
+              raise ::Appium::Core::Error::ArgumentError, "expected #{arg.inspect}:#{arg.class} to respond to #shift"
+            end
 
             # this will be a single-entry hash, so use #shift over #first or #[]
             arr = arg.dup.shift
 
-            raise ArgumentError, "expected #{arr.inspect} to have 2 elements" unless arr.size == 2
+            raise ::Appium::Core::Error::ArgumentError, "expected #{arr.inspect} to have 2 elements" unless arr.size == 2
 
             arr
           else
-            raise ArgumentError, "wrong number of arguments (#{args.size} for 2)"
+            raise ::Appium::Core::Error::ArgumentError, "wrong number of arguments (#{args.size} for 2)"
           end
         end
       end # module SearchContext

data/lib/appium_lib_core/common/base.rb

@@ -17,7 +17,6 @@ require_relative 'device/keyboard'
 require_relative 'device/ime_actions'
 require_relative 'device/setting'
 require_relative 'device/context'
-require_relative 'device/value'
 require_relative 'device/file_management'
 require_relative 'device/keyevent'
 require_relative 'device/image_comparison'
@@ -27,16 +26,13 @@ require_relative 'device/screen_record'
 require_relative 'device/battery_status'
 require_relative 'device/clipboard_content_type'
 require_relative 'device/device'
-require_relative 'device/touch_actions'
 require_relative 'device/execute_driver'
+require_relative 'device/orientation'
 
 # The following files have selenium-webdriver related stuff.
 require_relative 'base/driver'
 require_relative 'base/bridge'
-require_relative 'base/bridge/mjsonwp'
-require_relative 'base/bridge/w3c'
 require_relative 'base/capabilities'
 require_relative 'base/http_default'
 require_relative 'base/search_context'
-require_relative 'base/command'
 require_relative 'base/platform'